Copyright: Converted by SFS Software http:


HTMheLp Demo

This demo version of HTMheLp will convert only up to 5 HTML files. The full version has no such limit.

See the online help for HTMheLp ordering information.


  Index of all Fields and Methods

All Packages  Class Hierarchy
______________________________________________________________________________
A B C D E F G H I J  K L M N O P Q R S  T U V W X Y Z
______________________________________________________________________________

  Index of all Fields and Methods

  A

action(JarInfo, BeanInfo, String). Method in interface sun.beanbox.DoOnBean

 activate(). Method in class sun.beanbox.Wrapper

 add(String, String). Method in class sun.beanbox. MessageHeader

 Adds a key value pair to the end of the header.

add(Timer). Method in class sun.beanbox.Timer

 addEntry(MessageHeader). Method in class sun.beanbox. Manifest

 addFile(File). Method in class sun.beanbox.Manifest

 addFiles(File, String[]). Method in class sun.beanbox.Manifest

 addPropertyChangeListener(PropertyChangeListener). Method in interface java.beans.Customizer

 Register a listener for the PropertyChange event.

addPropertyChangeListener(PropertyChangeListener). Method in class java.beans. PropertyChangeSupport

 Add a PropertyChangeListener to the listener list.

addPropertyChangeListener(PropertyChangeListener). Method in interface java.beans.PropertyEditor

 Register a listener for the PropertyChange event.

addPropertyChangeListener(PropertyChangeListener). Method in class java.beans. PropertyEditorSupport

 Register a listener for the PropertyChange event.

addVetoableChangeListener(VetoableChangeListener). Method in class java.beans. VetoableChangeSupport

 Add a VetoableListener to the listener list.

applyDefinitions(Vector). Method in class sun.beanbox.SimpleClassLoader

 May want to add some support for reporting classes replicated across  different JAR files.

attributeNames(). Method in class java.beans.FeatureDescriptor

 avoidingGui(). Method in interface java.beans. Visibility

______________________________________________________________________________

  B

BeanBox(). Constructor for class sun.beanbox.BeanBox

 Initialize a new BeanBox.

BeanDescriptor(Class). Constructor for class java.beans.BeanDescriptor

 Create a BeanDescriptor for a bean that doesn't have a customizer.

BeanDescriptor(Class, Class). Constructor for class java.beans.BeanDescriptor

 Create a BeanDescriptor for a bean that has a customizer.

Beans(). Constructor for class java.beans.Beans

______________________________________________________________________________

  C

canonicalID(String). Static method in class sun.beanbox.MessageHeader

 Convert a message-id string to canonical form (strips off leading and trailing >s)

close(). Method in class sun.beanbox.BeanBox

 This implements the "close" menu item.

createLoader(String, String). Static method in class sun.beanbox. SimpleClassLoader

 Returns an InputStream on the resource

CustomizerDialog(Frame, Customizer, Object). Constructor for class sun.beanbox. CustomizerDialog

______________________________________________________________________________

  D

deactivate(). Method in class sun.beanbox.Wrapper

 decapitalize(String). Static method in class java.beans.Introspector

 Utility method to take a string and convert it to normal Java variable  name capitalization.

doInsert(Object). Method in class sun.beanbox.BeanBox

 Insert a given Component instance into the current BeanBox.

dontUseGui(). Method in interface java.beans.Visibility

 This method instructs the bean that it should not use the Gui.

______________________________________________________________________________

  E

elapsed(). Method in class sun.beanbox.Timer

 entries(). Method in class sun.beanbox.Manifest

 entryAt(int). Method in class sun.beanbox.Manifest

 error(String). Method in interface sun.beanbox.DoOnBean

 error(String, Exception). Method in interface sun.beanbox.DoOnBean

 ErrorDialog(Frame, String). Constructor for class sun.beanbox.ErrorDialog

 EventSetDescriptor(Class, String, Class, String). Constructor for class java.beans.EventSetDescriptor

 This constructor creates an EventSetDescriptor assuming that you are  following the most simple standard design pattern where a named  event "fred" is (1) delivered as a call on the single method of  interface FredListener, (2) has a single argument of type FredEvent,  and (3) where the FredListener may be registered with a call on an  addFredListener method of the source component and removed with a  call on a removeFredListener method.

EventSetDescriptor(Class, String, Class, String[], String, String). Constructor for class java.beans.EventSetDescriptor

 This constructor creates an EventSetDescriptor from scratch using  string names.

EventSetDescriptor(String, Class, Method[], Method, Method). Constructor for class java.beans.EventSetDescriptor

 This constructor creates an EventSetDescriptor from scratch using  java.lang.reflect.Method and java.lang.Class objects.

EventSetDescriptor(String, Class, MethodDescriptor[], Method, Method). Constructor for class java.beans.EventSetDescriptor

 This constructor creates an EventSetDescriptor from scratch using  java.lang.reflect.MethodDescriptor and java.lang.Class objects.

______________________________________________________________________________

  F

FeatureDescriptor(). Constructor for class java.beans.FeatureDescriptor

 findClass(String). Method in class sun.beanbox. SimpleClassLoader

 Public version of findLoadedClass() to expose it across

findEditor(Class). Static method in class java.beans.PropertyEditorManager

 Locate a value editor for a given target type.

findNextValue(String, String). Method in class sun.beanbox.MessageHeader

 Find the next value that corresponds to this key.

findValue(String). Method in class sun.beanbox.MessageHeader

 Find the value that corresponds to this key.

findWrapper(Component). Static method in class sun.beanbox.Wrapper

 Static method to map from an AWT component to the associated Wrapper.

firePropertyChange(). Method in class java.beans.PropertyEditorSupport

 Report that we have been modified to any interested listeners.

firePropertyChange(String, Object, Object). Method in class java.beans. PropertyChangeSupport

 Report a bound property update to any registered listeners.

fireVetoableChange(String, Object, Object). Method in class java.beans. VetoableChangeSupport

 Report a vetoable property update to any registered listeners.

______________________________________________________________________________

  G

getAdditionalBeanInfo(). Method in interface java.beans.BeanInfo

 This method allows a BeanInfo object to return an arbitrary collection  of other BeanInfo objects that provide additional information on the  current bean.

getAdditionalBeanInfo(). Method in class java.beans.SimpleBeanInfo

 Claim there are no other relevant BeanInfo objects.

getAddListenerMethod(). Method in class java.beans.EventSetDescriptor

 getAsText(). Method in interface java.beans. PropertyEditor

 getAsText(). Method in class java.beans. PropertyEditorSupport

 getBean(). Method in class sun.beanbox.Wrapper

 get the wrapped bean.

getBeanClass(). Method in class java.beans.BeanDescriptor

 getBeanDescriptor(). Method in interface java.beans. BeanInfo

 getBeanDescriptor(). Method in class java.beans. SimpleBeanInfo

 Deny knowledge about the class and customizer of the bean.

getBeanInfo(Class). Static method in class java.beans.Introspector

 Introspect on a Java bean and learn about all its properties, exposed  methods, and events.

getBeanInfo(Class, Class). Static method in class java.beans.Introspector

 Introspect on a Java bean and learn all about its properties, exposed  methods, below a given "stop" point.

getBeanInfo(int). Method in class sun.beanbox.JarInfo

 Get the BeanInfo for the ith bean in this jar file

getBeanInfoSearchPath(). Static method in class java.beans.Introspector

 getChild(). Method in class sun.beanbox.Wrapper

 get the AWT component used to represent the wrapped bean.

getClassLoader(). Method in class sun.beanbox.ObjectInputStreamWithLoader

 getCount(). Method in class sun.beanbox.JarInfo

 Get the number of beans in this Jar file

getCustomEditor(). Method in interface java.beans.PropertyEditor

 A PropertyEditor may choose to make available a full custom Component  that edits its property value.

getCustomEditor(). Method in class java.beans.PropertyEditorSupport

 A PropertyEditor may chose to make available a full custom Component  that edits its property value.

getCustomizerClass(). Method in class java.beans.BeanDescriptor

 getDefaultEventIndex(). Method in interface java.beans.BeanInfo

 A bean may have a "default" event that is the event that will  mostly commonly be used by human's when using the bean.

getDefaultEventIndex(). Method in class java.beans.SimpleBeanInfo

 Deny knowledge of a default event.

getDefaultPropertyIndex(). Method in interface java.beans.BeanInfo

 A bean may have a "default" property that is the property that will  mostly commonly be initially chosen for update by human's who are  customizing the bean.

getDefaultPropertyIndex(). Method in class java.beans.SimpleBeanInfo

 Deny knowledge of a default property.

getDisplayName(). Method in class java.beans.FeatureDescriptor

 getEditorSearchPath(). Static method in class java.beans.PropertyEditorManager

 getEntry(String). Method in class sun.beanbox.Manifest

 getEventSetDescriptors(). Method in interface java.beans.BeanInfo

 getEventSetDescriptors(). Method in class java.beans. SimpleBeanInfo

 Deny knowledge of event sets.

getIcon(int). Method in interface java.beans.BeanInfo

 This method returns an image object that can be used to  represent the bean in toolboxes, toolbars, etc.

getIcon(int). Method in class java.beans.SimpleBeanInfo

 Claim there are no icons available.

getIndexedPropertyType(). Method in class java.beans.IndexedPropertyDescriptor

 getIndexedReadMethod(). Method in class java.beans. IndexedPropertyDescriptor

 getIndexedWriteMethod(). Method in class java.beans. IndexedPropertyDescriptor

 getInputStream (). Method in interface sun.beanbox.InputStreamProducer

 getInstance(String). Method in class sun.beanbox. JarInfo

 Get a new Bean instance given its name

getInstanceOf(Object, Class). Static method in class java.beans.Beans

 From a given bean, obtain an object representing a specified  type view of that source object.

getJarName(). Method in class sun.beanbox.JarInfo

 Get the name of the file containing this JAR

getJavaInitializationString(). Method in interface java.beans.PropertyEditor

 This method is intended for use when generating Java code to set  the value of the property.

getJavaInitializationString(). Method in class java.beans.PropertyEditorSupport

 This method is intended for use when generating Java code to set  the value of the property.

getKey(int). Method in class sun.beanbox.MessageHeader

 getListenerMethodDescriptors(). Method in class java.beans.EventSetDescriptor

 getListenerMethods(). Method in class java.beans. EventSetDescriptor

 getListenerType(). Method in class java.beans. EventSetDescriptor

 getLoader(). Method in class sun.beanbox.JarLoader

 get the loader we are using

getLocalResource(String, String). Static method in class sun.beanbox. SimpleClassLoader

 getLocalResourceAsStream(String, String). Static method in class sun.beanbox.SimpleClassLoader

 getManifestData(String). Method in class sun.beanbox. JarInfo

 Get to Manifest Headers for this bean

getMethod(). Method in class java.beans.MethodDescriptor

 getMethodDescriptors(). Method in interface java.beans.BeanInfo

 getMethodDescriptors(). Method in class java.beans. SimpleBeanInfo

 Deny knowledge of methods.

getName(). Method in class java.beans.FeatureDescriptor

 getName(int). Method in class sun.beanbox.JarInfo

 The bean name of this bean  REMIND - should this be an attribute of the BeanDescriptor of its BeanInfo?

getNewValue(). Method in class java.beans.PropertyChangeEvent

 getOldValue(). Method in class java.beans. PropertyChangeEvent

 getParameterDescriptors(). Method in class java.beans. MethodDescriptor

 getPropagationId(). Method in class java.beans. PropertyChangeEvent

 The "propagationId" field is reserved for future use.

getPropertyChangeEvent(). Method in class java.beans.PropertyVetoException

 getPropertyDescriptors(). Method in interface java.beans.BeanInfo

 getPropertyDescriptors(). Method in class java.beans. SimpleBeanInfo

 Deny knowledge of properties.

getPropertyEditorClass(). Method in class java.beans.PropertyDescriptor

 getPropertyName(). Method in class java.beans. PropertyChangeEvent

 getPropertyType(). Method in class java.beans. PropertyDescriptor

 getReadMethod(). Method in class java.beans. PropertyDescriptor

 getRemoveListenerMethod(). Method in class java.beans. EventSetDescriptor

 getResource(String). Method in class sun.beanbox. SimpleClassLoader

 getResourceAsStream(String). Method in class sun.beanbox.SimpleClassLoader

 getResult(). Method in class sun.beanbox. PropertyNameDialog

 getShortDescription(). Method in class java.beans. FeatureDescriptor

 getTags(). Method in interface java.beans. PropertyEditor

 If the property value must be one of a set of known tagged values,  then this method should return an array of the tags.

getTags(). Method in class java.beans.PropertyEditorSupport

 If the property value must be one of a set of known tagged values,  then this method should return an array of the tag values.

getValue(). Method in interface java.beans.PropertyEditor

 getValue(). Method in class java.beans. PropertyEditorSupport

 getValue(int). Method in class sun.beanbox. MessageHeader

 getValue(String). Method in class java.beans. FeatureDescriptor

 Retrieve a named attribute with this feature.

getWriteMethod(). Method in class java.beans.PropertyDescriptor

______________________________________________________________________________

  H

handleEvent(Event). Method in class sun.beanbox.BeanBox

 Process an old-style AWT event.

handleEvent(Event). Method in class sun.beanbox.CustomizerDialog

 handleEvent(Event). Method in class sun.beanbox. ErrorDialog

 handleEvent(Event). Method in class sun.beanbox. EventTargetDialog

 handleEvent(Event). Method in class sun.beanbox. PropertyNameDialog

 handleEvent(Event). Method in class sun.beanbox. PropertySheet

 handleEvent(Event). Method in class sun.beanbox.Wrapper

 HookupManager(). Constructor for class sun.beanbox. HookupManager

______________________________________________________________________________

  I

ICON_COLOR_16x16. Static variable in interface java.beans.BeanInfo

 Constant to indicate a 16 x 16 color icon.

ICON_COLOR_32x32. Static variable in interface java.beans.BeanInfo

 Constant to indicate a 32 x 32 color icon.

ICON_MONO_16x16. Static variable in interface java.beans.BeanInfo

 Constant to indicate a 16 x 16 monochrome icon.

ICON_MONO_32x32. Static variable in interface java.beans.BeanInfo

 Constant to indicate a 32 x 32 monochrome icon.

IndexedPropertyDescriptor(String, Class). Constructor for class java.beans. IndexedPropertyDescriptor

 This constructor constructs an IndexedPropertyDescriptor for a property  that follows the standard Java conventions by having getFoo and setFoo  accessor methods, for both indexed access and array access.

IndexedPropertyDescriptor(String, Class, String, String, String, String). Constructor for class java.beans.IndexedPropertyDescriptor

 This constructor takes the name of a simple property, and method  names for reading and writing the property, both indexed  and non-indexed.

IndexedPropertyDescriptor(String, Method, Method, Method, Method). Constructor for class java.beans.IndexedPropertyDescriptor

 This constructor takes the name of a simple property, and Method  objects for reading and writing the property.

instantiate(ClassLoader, String). Static method in class java.beans.Beans

 Instantiate a bean.

IntrospectionException(String). Constructor for class java.beans. IntrospectionException

 isBound(). Method in class java.beans. PropertyDescriptor

 Updates to "bound" properties will cause a "PropertyChange" event to  get fired when the property is changed.

isConstrained(). Method in class java.beans.PropertyDescriptor

 Attempted updates to "Constrained" properties will cause a "VetoableChange"  event to get fired when the property is changed.

isDesignTime(). Static method in class java.beans.Beans

 Test if we are in design-mode.

isExpert(). Method in class java.beans.FeatureDescriptor

 The "expert" flag is used to distinguish between those features that are  intended for expert users from those that are intended for normal users.

isFromPrototype(String). Method in class sun.beanbox.JarInfo

 Was this bean from a serialized prototype? -- unused so far?

isGuiAvailable(). Static method in class java.beans.Beans

 isHidden(). Method in class java.beans. FeatureDescriptor

 The "hidden" flag is used to identify features that are intended only  for tool use, and which should not be exposed to humans.

isInDefaultEventSet(). Method in class java.beans.EventSetDescriptor

 Report if an event set is in the "default set".

isInstanceOf(Object, Class). Static method in class java.beans.Beans

 Check if a bean can be viewed as a given target type.

isManifestName(String). Static method in class sun.beanbox.Manifest

 isPaintable(). Method in interface java.beans. PropertyEditor

 isPaintable(). Method in class java.beans. PropertyEditorSupport

 isUnicast(). Method in class java.beans. EventSetDescriptor

 Normally event sources are multicast.

______________________________________________________________________________

  J

JarInfo(String, SimpleClassLoader, String[], boolean[], MessageHeader[]). Constructor for class sun.beanbox.JarInfo

 Create a JarInfo.

JarLoader(String). Constructor for class sun.beanbox.JarLoader

 Create a JarLoader to read a JAR and to process its contents.

______________________________________________________________________________

  L

layout(). Method in class sun.beanbox.CustomizerDialog

 layout(). Method in class sun.beanbox.PropertySheet

 layout(). Method in class sun.beanbox.Wrapper

 loadClass(String, boolean). Method in class sun.beanbox.SimpleClassLoader

 This is the main method for ClassLoaders, that is being redefined

loadFromFile(String). Method in class sun.beanbox.SimpleClassLoader

 Helper function; load a class from a file

loadImage(String). Method in class java.beans.SimpleBeanInfo

 This is a utility method to help in loading icon images.

loadJar(). Method in class sun.beanbox.JarLoader

 Load the classes, resources, etc.

loadJarDoOnBean(String, DoOnBean). Static method in class sun.beanbox.JarLoader

 Load the JAR file, then apply an action to each bean found

______________________________________________________________________________

  M

main(String[]). Static method in class sun.beanbox.Report

 Manifest(). Constructor for class sun.beanbox.Manifest

 Manifest(byte[]). Constructor for class sun.beanbox. Manifest

 Manifest(InputStream). Constructor for class sun.beanbox.Manifest

 Parse a manifest from a stream

Manifest(String[]). Constructor for class sun.beanbox.Manifest

 MessageHeader(). Constructor for class sun.beanbox. MessageHeader

 MessageHeader(InputStream). Constructor for class sun.beanbox.MessageHeader

 MethodDescriptor(Method). Constructor for class java.beans.MethodDescriptor

 MethodDescriptor(Method, ParameterDescriptor[]). Constructor for class java.beans.MethodDescriptor

______________________________________________________________________________

  N

needsGui(). Method in interface java.beans.Visibility

______________________________________________________________________________

  O

ObjectInputStreamWithLoader(InputStream, ClassLoader). Constructor for class sun.beanbox.ObjectInputStreamWithLoader

 Loader must be non-null;

okToUseGui(). Method in interface java.beans.Visibility

 This method instructs the bean that it is OK to use the Gui.

OurLabel(String). Constructor for class sun.beanbox.OurLabel

 ourLoader. Static variable in class sun.beanbox. SimpleClassLoader

______________________________________________________________________________

  P

paint(Graphics). Method in class sun.beanbox.BeanBox

 Repaint the current beanbox.

paint(Graphics). Method in class sun.beanbox.OurLabel

 paint(Graphics). Method in class sun.beanbox.Wrapper

 paintValue(Graphics, Rectangle). Method in interface java.beans.PropertyEditor

 Paint a representation of the value into a given area of screen  real estate.

paintValue(Graphics, Rectangle). Method in class java.beans. PropertyEditorSupport

 Paint a representation of the value into a given area of screen  real estate.

ParameterDescriptor(). Constructor for class java.beans.ParameterDescriptor

 parseHeader(InputStream). Method in class sun.beanbox. MessageHeader

 Parse a MIME header from an input stream.

preferredSize(). Method in class sun.beanbox.Wrapper

 prepend(String, String). Method in class sun.beanbox. MessageHeader

 Prepends a key value pair to the beginning of the header.

print(PrintWriter). Method in class sun.beanbox.MessageHeader

 Prints the key-value pairs represented by this header.

propertyChange(PropertyChangeEvent). Method in interface java.beans. PropertyChangeListener

 This method gets called when a bound property is changed.

PropertyChangeEvent(Object, String, Object, Object). Constructor for class java.beans.PropertyChangeEvent

 PropertyChangeSupport(Object). Constructor for class java.beans.PropertyChangeSupport

 PropertyDescriptor(String, Class). Constructor for class java.beans.PropertyDescriptor

 Constructs a PropertyDescriptor for a property that follows  the standard Java convention by having getFoo and setFoo  accessor methods.

PropertyDescriptor(String, Class, String, String). Constructor for class java.beans.PropertyDescriptor

 This constructor takes the name of a simple property, and method  names for reading and writing the property.

PropertyDescriptor(String, Method, Method). Constructor for class java.beans. PropertyDescriptor

 This constructor takes the name of a simple property, and Method  objects for reading and writing the property.

PropertyEditorManager(). Constructor for class java.beans.PropertyEditorManager

 PropertyEditorSupport(). Constructor for class java.beans.PropertyEditorSupport

 Constructor for use by derived PropertyEditor classes.

PropertyEditorSupport(Object). Constructor for class java.beans. PropertyEditorSupport

 Constructor for use when a PropertyEditor is delegating to us.

PropertyVetoException(String, PropertyChangeEvent). Constructor for class java.beans.PropertyVetoException

______________________________________________________________________________

  R

registerEditor(Class, Class). Static method in class java.beans. PropertyEditorManager

 Register an editor class to be used to editor values of  a given target class.

removePropertyChangeListener(PropertyChangeListener). Method in interface java.beans.Customizer

 Remove a listener for the PropertyChange event.

removePropertyChangeListener(PropertyChangeListener). Method in class java.beans. PropertyChangeSupport

 Remove a PropertyChangeListener from the listener list.

removePropertyChangeListener(PropertyChangeListener). Method in interface java.beans.PropertyEditor

 Remove a listener for the PropertyChange event.

removePropertyChangeListener(PropertyChangeListener). Method in class java.beans.PropertyEditorSupport

 Remove a listener for the PropertyChange event.

removeVetoableChangeListener(VetoableChangeListener). Method in class java.beans.VetoableChangeSupport

 Remove a VetoableChangeListener from the listener list.

Report(). Constructor for class sun.beanbox.Report

 report(Class). Static method in class sun.beanbox. Report

 reset(). Method in class sun.beanbox.Timer

 reshape(int, int, int, int). Method in class sun.beanbox.Wrapper

 resolveClass(ObjectStreamClass). Method in class sun.beanbox.ObjectInputStreamWithLoader

 Use the given ClassLoader rather than using the system class

run(). Method in class sun.beanbox.BeanBox

 run(). Method in class sun.beanbox.EventTargetDialog

______________________________________________________________________________

  S

save(). Method in class sun.beanbox.BeanBox

 This implements the "save" menu item.

set(int, String, String). Method in class sun.beanbox.MessageHeader

 Overwrite the previous key/val pair at location 'i'  with the new k/v.

set(String, String). Method in class sun.beanbox.MessageHeader

 Sets the value of a key.

setActive(boolean). Method in class sun.beanbox.Wrapper

 setAsText(String). Method in interface java.beans. PropertyEditor

 Set the property value by parsing a given String.

setAsText(String). Method in class java.beans.PropertyEditorSupport

 Set the property value by parsing a given String.

setBeanInfoSearchPath(String[]). Static method in class java.beans. Introspector

 Change the list of package names that will be used for 	finding BeanInfo classes.

setBound(boolean). Method in class java.beans.PropertyDescriptor

 Updates to "bound" properties will cause a "PropertyChange" event to  get fired when the property is changed.

setConstrained(boolean). Method in class java.beans.PropertyDescriptor

 Attempted updates to "Constrained" properties will cause a "VetoableChange"  event to get fired when the property is changed.

setDefinition(String, byte[]). Method in class sun.beanbox.SimpleClassLoader

 Set some bytecodes as a definition for a class.

setDesignTime(boolean). Static method in class java.beans.Beans

 Used to indicate whether of not we are running in an application  builder environment.

setDisplayName(String). Method in class java.beans.FeatureDescriptor

 setEditorSearchPath(String[]). Static method in class java.beans.PropertyEditorManager

 Change the list of package names that will be used for 	finding property editors.

setExpert(boolean). Method in class java.beans.FeatureDescriptor

 The "expert" flag is used to distinguish between features that are  intended for expert users from those that are intended for normal users.

setGuiAvailable(boolean). Static method in class java.beans.Beans

 Used to indicate whether of not we are running in an environment  where GUI interaction is available.

setHidden(boolean). Method in class java.beans.FeatureDescriptor

 The "hidden" flag is used to identify features that are intended only  for tool use, and which should not be exposed to humans.

setInDefaultEventSet(boolean). Method in class java.beans.EventSetDescriptor

 Mark an event set as being in the "default" set (or not).

setLocalResourceSource(String, InputStreamProducer). Method in class sun.beanbox.SimpleClassLoader

 Assign an InputStream as the source for a given property name  This value comes first after the system resources

setName(String). Method in class java.beans.FeatureDescriptor

 setObject(Object). Method in interface java.beans. Customizer

 Set the object to be customized.

setPropagationId(Object). Method in class java.beans.PropertyChangeEvent

 setPropertyEditorClass(Class). Method in class java.beans.PropertyDescriptor

 Normally PropertyEditors will be found using the PropertyEditorManager.

setShortDescription(String). Method in class java.beans.FeatureDescriptor

 You can associate a short descriptive string with a feature.

setUnicast(boolean). Method in class java.beans.EventSetDescriptor

 Mark an event set as unicast (or not).

setValue(Object). Method in interface java.beans.PropertyEditor

 Set (or change) the object that is to be edited.

setValue(Object). Method in class java.beans.PropertyEditorSupport

 Set (or change) the object that is to be edited.

setValue(String, Object). Method in class java.beans.FeatureDescriptor

 Associate a named attribute with this feature.

SimpleBeanInfo(). Constructor for class java.beans.SimpleBeanInfo

 stop(). Method in class sun.beanbox.Timer

 stream(OutputStream, Vector). Method in class sun.beanbox.Manifest

 supportsCustomEditor(). Method in interface java.beans.PropertyEditor

 supportsCustomEditor(). Method in class java.beans. PropertyEditorSupport

______________________________________________________________________________

  T

Timer(). Constructor for class sun.beanbox.Timer

 Timer(boolean). Constructor for class sun.beanbox.Timer

 toString(). Method in class sun.beanbox.MessageHeader

______________________________________________________________________________

  U

updateMenuBar(MenuBar). Method in class sun.beanbox.BeanBox

 Update the MenuBar for the current beanBox and focus bean.

urlPrefix. Static variable in class sun.beanbox.SimpleClassLoader

______________________________________________________________________________

  V

vetoableChange(PropertyChangeEvent). Method in interface java.beans. VetoableChangeListener

 This method gets called when a constrained property is changed.

VetoableChangeSupport(Object). Constructor for class java.beans. VetoableChangeSupport

______________________________________________________________________________

  W

Wrapper(Object). Constructor for class sun.beanbox.Wrapper

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.BeanDescriptor

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class java.beans.BeanDescriptor

java.lang.Object
   |
   +----java.beans.FeatureDescriptor
           |
           +----java.beans.BeanDescriptor

______________________________________________________________________________

 public class BeanDescriptor

 extends FeatureDescriptor

A BeanDescriptor provides global information about a "bean",  including its Java class, its displayName, etc.

 This is one of the kinds of descriptor returned by a BeanInfo object,  which also returns descriptors for properties, method, and events.

______________________________________________________________________________

 	BeanDescriptor(Class)

 Create a BeanDescriptor for a bean that doesn't have a customizer.

 	BeanDescriptor(Class, Class)

 Create a BeanDescriptor for a bean that has a customizer.

 	getBeanClass()

  	getCustomizerClass()

 BeanDescriptor

  public BeanDescriptor(Class beanClass)

 Create a BeanDescriptor for a bean that doesn't have a customizer.

Parameters:

 beanClass - The Class object of the Java class that implements 	the bean. For example sun.beans.OurButton.class.

 BeanDescriptor

  public BeanDescriptor(Class beanClass,
                        Class customizerClass)

 Create a BeanDescriptor for a bean that has a customizer.

Parameters:

 beanClass - The Class object of the Java class that implements 	the bean. For example sun.beans.OurButton.class.

 customizerClass - The Class object of the Java class that implements 	the bean's Customizer. For example sun.beans.OurButtonCustomizer.class.

 getBeanClass

  public Class getBeanClass()

Returns:

 The Class object for the bean.

 getCustomizerClass

  public Class getCustomizerClass()

Returns:

 The Class object for the bean's customizer. This may  be null if the bean doesn't have a customizer.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.beans.BeanInfo

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Interface java.beans.BeanInfo

 public interface BeanInfo

A bean implementor who wishes to provide explicit information about  their bean may provide a BeanInfo class that implements this BeanInfo  interface and provides explicit information about the methods,  properties, events, etc, of their bean.

 A bean implementor doesn't need to provide a complete set of  explicit information. You can pick and choose which information  you want to provide and the rest will be obtained by automatic  analysis using low-level reflection of the bean classes' methods  and applying standard design patterns.

 You get the opportunity to provide lots and lots of different  information as part of the various XyZDescriptor classes. But  don't panic, you only really need to provide the minimal core  information required by the various constructors.

 See also the SimpleBeanInfo class which provides a convenient  "noop" base class for BeanInfo classes, which you can override  for those specific places where you want to return explicit info.

 To learn about all the behaviour of a bean see the Introspector class.

______________________________________________________________________________

 	ICON_COLOR_16x16

 Constant to indicate a 16 x 16 color icon.

 	ICON_COLOR_32x32

 Constant to indicate a 32 x 32 color icon.

 	ICON_MONO_16x16

 Constant to indicate a 16 x 16 monochrome icon.

 	ICON_MONO_32x32

 Constant to indicate a 32 x 32 monochrome icon.

 	getAdditionalBeanInfo()

 This method allows a BeanInfo object to return an arbitrary collection  of other BeanInfo objects that provide additional information on the  current bean.

 	getBeanDescriptor()

  	getDefaultEventIndex()

 A bean may have a "default" event that is the event that will  mostly commonly be used by human's when using the bean.

 	getDefaultPropertyIndex()

 A bean may have a "default" property that is the property that will  mostly commonly be initially chosen for update by human's who are  customizing the bean.

 	getEventSetDescriptors()

  	getIcon(int)

 This method returns an image object that can be used to  represent the bean in toolboxes, toolbars, etc.

 	getMethodDescriptors()

  	getPropertyDescriptors()

 ICON_COLOR_16x16

  public final static int ICON_COLOR_16x16

 Constant to indicate a 16 x 16 color icon.

 ICON_COLOR_32x32

  public final static int ICON_COLOR_32x32

 Constant to indicate a 32 x 32 color icon.

 ICON_MONO_16x16

  public final static int ICON_MONO_16x16

 Constant to indicate a 16 x 16 monochrome icon.

 ICON_MONO_32x32

  public final static int ICON_MONO_32x32

 Constant to indicate a 32 x 32 monochrome icon.

 getBeanDescriptor

  public abstract BeanDescriptor getBeanDescriptor()

Returns:

 A BeanDescriptor providing overall information about  the bean, such as its displayName, its customizer, etc. May  return null if the information should be obtained by automatic  analysis.

 getEventSetDescriptors

  public abstract EventSetDescriptor[] getEventSetDescriptors()

Returns:

 An array of EventSetDescriptors describing the kinds of  events fired by this bean. May return null if the information  should be obtained by automatic analysis.

 getDefaultEventIndex

  public abstract int getDefaultEventIndex()

 A bean may have a "default" event that is the event that will  mostly commonly be used by human's when using the bean.

Returns:

 Index of default event in the EventSetDescriptor array 	returned by getEventSetDescriptors.

Returns -1 if there is no default event.

 getPropertyDescriptors

  public abstract PropertyDescriptor[] getPropertyDescriptors()

Returns:

 An array of PropertyDescriptors describing the editable  properties supported by this bean. May return null if the  information should be obtained by automatic analysis.

 If a property is indexed, then its entry in the result array will  belong to the IndexedPropertyDescriptor subclass of PropertyDescriptor.  A client of getPropertyDescriptors can use "instanceof" to check  if a given PropertyDescriptor is an IndexedPropertyDescriptor.

 getDefaultPropertyIndex

  public abstract int getDefaultPropertyIndex()

 A bean may have a "default" property that is the property that will  mostly commonly be initially chosen for update by human's who are  customizing the bean.

Returns:

 Index of default property in the PropertyDescriptor array  returned by getPropertyDescriptors.

Returns -1 if there is no default property.

 getMethodDescriptors

  public abstract MethodDescriptor[] getMethodDescriptors()

Returns:

 An array of MethodDescriptors describing the externally  visible methods supported by this bean. May return null if  the information should be obtained by automatic analysis.

 getAdditionalBeanInfo

  public abstract BeanInfo[] getAdditionalBeanInfo()

 This method allows a BeanInfo object to return an arbitrary collection  of other BeanInfo objects that provide additional information on the  current bean.

 If there are conflicts or overlaps between the information provided  by different BeanInfo objects, then the current BeanInfo takes precedence  over the getAdditionalBeanInfo objects, and later elements in the array  take precedence over earlier ones.

Returns:

 an array of BeanInfo objects. May return null.

 getIcon

  public abstract Image getIcon(int iconKind)

 This method returns an image object that can be used to  represent the bean in toolboxes, toolbars, etc. Icon images  will typically be GIFs, but may in future include other formats.

 Beans aren't required to provide icons and may return null from  this method.

 There are four possible flavors of icons (16x16 color,  32x32 color, 16x16 mono, 32x32 mono). If a bean choses to only  support a single icon we recommend supporting 16x16 color.

 We recommend that icons have a "transparent" background  so they can be rendered onto an existing background.

Parameters:

 iconKind - The kind of icon requested. This should be  one of the constant values ICON_COLOR_16x16, ICON_COLOR_32x32,  ICON_MONO_16x16, or ICON_MONO_32x32.

Returns:

 An image object representing the requested icon. May  return null if no suitable icon is available.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.Beans

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class java.beans.Beans

java.lang.Object
   |
   +----java.beans.Beans

______________________________________________________________________________

 public class Beans

 extends Object

This class provides some general purpose beans control methods.

______________________________________________________________________________

 	Beans()

 	getInstanceOf(Object, Class)

 From a given bean, obtain an object representing a specified  type view of that source object.

 	instantiate(ClassLoader, String)

 Instantiate a bean.

 	isDesignTime()

 Test if we are in design-mode.

 	isGuiAvailable()

  	isInstanceOf(Object, Class)

 Check if a bean can be viewed as a given target type.

 	setDesignTime(boolean)

 Used to indicate whether of not we are running in an application  builder environment.

 	setGuiAvailable(boolean)

 Used to indicate whether of not we are running in an environment  where GUI interaction is available.

 Beans

  public Beans()

 instantiate

  public static Object instantiate(ClassLoader cls,
                                   String beanName) throws IOException, ClassNotFoundException

 Instantiate a bean.

 The bean is created based on a name relative to a class-loader.  This name should be a dot-separated name such as "a.b.c".

 In Beans 1.0 the given name can indicate either a serialized object  or a class. Other mechanisms may be added in the future. In  beans 1.0 we first try to treat the beanName as a serialized object  name then as a class name.

 When using the beanName as a serialized object name we convert the  given beanName to a resource pathname and add a trailing ".ser" suffix.  We then try to load a serialized object from that resource.

 For example, given a beanName of "x.y", Beans.instantiate would first  try to read a serialized object from the resource "x/y.ser" and if  that failed it would try to load the class "x.y" and create an  instance of that class.

 If the bean is a subtype of java.applet.Applet, then it is given  some special initialization. First, it is supplied with a default  AppletStub and AppletContext. Second, if it was instantiated from  a classname the applet's "init" method is called. (If the bean was  deserialized this step is skipped.)

 Note that for beans which are applets, it is the caller's responsiblity  to call "start" on the applet. For correct behaviour, this should be done  after the applet has been added into a visible AWT container.

 Note that applets created via beans.instantiate run in a slightly  different environment than applets running inside browsers. In  particular, bean applets have no access to "parameters", so they may  wish to provide property get/set methods to set parameter values. We  advise bean-applet developers to test their bean-applets against both  the JDK appletviewer (for a reference browser environment) and the  BDK BeanBox (for a reference bean container).

Parameters:

 classLoader - The class-loader from which we should create  the bean. If this is null then the system class-loader  is used.

 beanName - This names the bean within the class-loader.  For example "sun.beanbox.foobah"

 getInstanceOf

  public static Object getInstanceOf(Object bean,
                                     Class targetType)

 From a given bean, obtain an object representing a specified  type view of that source object.

 The result may be the same object or a different object. If  the requested target view isn't available then the given  bean is returned.

 This method is provided in Beans 1.0 as a hook to allow the  addition of more flexible bean behaviour in the future.

Parameters:

 obj - Object from which we want to obtain a view.

 targetType - The type of view we'd like to get.

 isInstanceOf

  public static boolean isInstanceOf(Object bean,
                                     Class targetType)

 Check if a bean can be viewed as a given target type.  The result will be true if the Beans.getInstanceof method  can be used on the given bean to obtain an object that  represents the specified targetType type view.

Parameters:

 bean - Bean from which we want to obtain a view.

 targetType - The type of view we'd like to get.

Returns:

 "true" if the given bean supports the given targetType.

 isDesignTime

  public static boolean isDesignTime()

 Test if we are in design-mode.

Returns:

 True if we are running in an application construction 	environment.

 isGuiAvailable

  public static boolean isGuiAvailable()

Returns:

 True if we are running in an environment where beans 	can assume that an interactive GUI is available, so they 	can pop up dialog boxes, etc. This will normally return 	true in a windowing environment, and will normally return 	false in a server environment or if an application is 	running as part of a batch job.

 setDesignTime

  public static void setDesignTime(boolean isDesignTime) throws SecurityException

 Used to indicate whether of not we are running in an application  builder environment. Note that this method is security checked  and is not available to (for example) untrusted applets.

Parameters:

 isDesignTime - True if we're in an application builder tool.

 setGuiAvailable

  public static void setGuiAvailable(boolean isGuiAvailable) throws SecurityException

 Used to indicate whether of not we are running in an environment  where GUI interaction is available. Note that this method is  security checked and is not available to (for example) untrusted  applets.

Parameters:

 isGuiAvailable - True if GUI interaction is available.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.beans.Customizer

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Interface java.beans.Customizer

 public interface Customizer

A customizer class provides a complete custom GUI for customizing  a target Java Bean.

 Each customizer should inherit from the java.awt.Component class so  it can be instantiated inside an AWT dialog or panel.

 Each customizer should have a null constructor.

______________________________________________________________________________

 	addPropertyChangeListener(PropertyChangeListener)

 Register a listener for the PropertyChange event.

 	removePropertyChangeListener(PropertyChangeListener)

 Remove a listener for the PropertyChange event.

 	setObject(Object)

 Set the object to be customized.

 setObject

  public abstract void setObject(Object bean)

 Set the object to be customized. This method should be called only  once, before the Customizer has been added to any parent AWT container.

Parameters:

 bean - The object to be customized.

 addPropertyChangeListener

  public abstract void addPropertyChangeListener(PropertyChangeListener listener)

 Register a listener for the PropertyChange event. The customizer  should fire a PropertyChange event whenever it changes the target  bean in a way that might require the displayed properties to be  refreshed.

Parameters:

 listener - An object to be invoked when a PropertyChange 	event is fired.

 removePropertyChangeListener

  public abstract void removePropertyChangeListener(PropertyChangeListener listener)

 Remove a listener for the PropertyChange event.

Parameters:

 listener - The PropertyChange listener to be removed.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.EventSetDescriptor

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class java.beans.EventSetDescriptor

java.lang.Object
   |
   +----java.beans.FeatureDescriptor
           |
           +----java.beans.EventSetDescriptor

______________________________________________________________________________

 public class EventSetDescriptor

 extends FeatureDescriptor

An EventSetDescriptor describes a group of events that a given Java  bean fires.

 The given group of events are all delivered as method calls on a single  event listener interface, and an event listener object can be registered  via a call on a registration method supplied by the event source.

______________________________________________________________________________

 	EventSetDescriptor(Class, String, Class, String)

 This constructor creates an EventSetDescriptor assuming that you are  following the most simple standard design pattern where a named  event "fred" is (1) delivered as a call on the single method of  interface FredListener, (2) has a single argument of type FredEvent,  and (3) where the FredListener may be registered with a call on an  addFredListener method of the source component and removed with a  call on a removeFredListener method.

 	EventSetDescriptor (Class, String, Class, String[], String, String)

 This constructor creates an EventSetDescriptor from scratch using  string names.

 	EventSetDescriptor (String, Class, Method[], Method, Method)

 This constructor creates an EventSetDescriptor from scratch using  java.lang.reflect.Method and java.lang.Class objects.

 	EventSetDescriptor (String, Class, MethodDescriptor[], Method, Method)

 This constructor creates an EventSetDescriptor from scratch using  java.lang.reflect.MethodDescriptor and java.lang.Class objects.

 	getAddListenerMethod()

  	getListenerMethodDescriptors()

  	getListenerMethods()

  	getListenerType()

  	getRemoveListenerMethod()

  	isInDefaultEventSet()

 Report if an event set is in the "default set".

 	isUnicast()

 Normally event sources are multicast.

 	setInDefaultEventSet(boolean)

 Mark an event set as being in the "default" set (or not).

 	setUnicast(boolean)

 Mark an event set as unicast (or not).

 EventSetDescriptor

  public EventSetDescriptor(Class sourceClass,
                            String eventSetName,
                            Class listenerType,
                            String listenerMethodName) throws IntrospectionException

 This constructor creates an EventSetDescriptor assuming that you are  following the most simple standard design pattern where a named  event "fred" is (1) delivered as a call on the single method of  interface FredListener, (2) has a single argument of type FredEvent,  and (3) where the FredListener may be registered with a call on an  addFredListener method of the source component and removed with a  call on a removeFredListener method.

Parameters:

 sourceClass - The class firing the event.

 eventSetName - The programmatic name of the event. E.g. "fred". 	Note that this should normally start with a lower-case character.

 listenerType - The target interface that events 	will get delivered to.

 listenerMethodName - The method that will get called when the event gets 	delivered to its target listener interface.

 EventSetDescriptor

  public EventSetDescriptor(Class sourceClass,
                            String eventSetName,
                            Class listenerType,
                            String listenerMethodNames[],
                            String addListenerMethodName,
                            String removeListenerMethodName) throws IntrospectionException

 This constructor creates an EventSetDescriptor from scratch using  string names.

Parameters:

 sourceClass - The class firing the event.

 eventSetName - The programmatic name of the event set. 	Note that this should normally start with a lower-case character.

 listenerType - The Class of the target interface that events 	will get delivered to.

 listenerMethodNames - The names of the methods that will get called 	when the event gets delivered to its target listener interface.

 addListenerMethodName - The name of the method on the event source 	that can be used to register an event listener object.

 removeListenerMethodName - The name of the method on the event source 	that can be used to de-register an event listener object.

 EventSetDescriptor

  public EventSetDescriptor(String eventSetName,
                            Class listenerType,
                            Method listenerMethods[],
                            Method addListenerMethod,
                            Method removeListenerMethod) throws IntrospectionException

 This constructor creates an EventSetDescriptor from scratch using  java.lang.reflect.Method and java.lang.Class objects.

Parameters:

 eventSetName - The programmatic name of the event set.

 listenerType - The Class for the listener interface.

 listenerMethods - An array of Method objects describing each 	of the event handling methods in the target listener.

 addListenerMethod - The method on the event source 	that can be used to register an event listener object.

 removeListenerMethod - The method on the event source 	that can be used to de-register an event listener object.

 EventSetDescriptor

  public EventSetDescriptor(String eventSetName,
                            Class listenerType,
                            MethodDescriptor listenerMethodDescriptors[],
                            Method addListenerMethod,
                            Method removeListenerMethod) throws IntrospectionException

 This constructor creates an EventSetDescriptor from scratch using  java.lang.reflect.MethodDescriptor and java.lang.Class objects.

Parameters:

 eventSetName - The programmatic name of the event set.

 listenerType - The Class for the listener interface.

 listenerMethodDescriptors - An array of MethodDescriptor objects 	describing each of the event handling methods in the  target listener.

 addListenerMethod - The method on the event source 	that can be used to register an event listener object.

 removeListenerMethod - The method on the event source 	that can be used to de-register an event listener object.

 getListenerType

  public Class getListenerType()

Returns:

 The Class object for the target interface that will  get invoked when the event is fired.

 getListenerMethods

  public Method[] getListenerMethods()

Returns:

 An array of Method objects for the target methods  within the target listener interface that will get called when  events are fired.

 getListenerMethodDescriptors

  public MethodDescriptor[] getListenerMethodDescriptors()

Returns:

 An array of MethodDescriptor objects for the target methods  within the target listener interface that will get called when  events are fired.

 getAddListenerMethod

  public Method getAddListenerMethod()

Returns:

 The method used to register a listener at the event source.

 getRemoveListenerMethod

  public Method getRemoveListenerMethod()

Returns:

 The method used to register a listener at the event source.

 setUnicast

  public void setUnicast(boolean unicast)

 Mark an event set as unicast (or not).

Parameters:

 unicast - True if the event set is unicast.

 isUnicast

  public boolean isUnicast()

 Normally event sources are multicast. However there are some  exceptions that are strictly unicast.

Returns:

 True if the event set is unicast. Defaults to "false".

 setInDefaultEventSet

  public void setInDefaultEventSet(boolean inDefaultEventSet)

 Mark an event set as being in the "default" set (or not).  By default this is true.

Parameters:

 unicast - True if the event set is unicast.

 isInDefaultEventSet

  public boolean isInDefaultEventSet()

 Report if an event set is in the "default set".

Returns:

 True if the event set is in the "default set". Defaults to "true".

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.FeatureDescriptor

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class java.beans.FeatureDescriptor

java.lang.Object
   |
   +----java.beans.FeatureDescriptor

______________________________________________________________________________

 public class FeatureDescriptor

 extends Object

The FeatureDescriptor class is the common baseclass for PropertyDescriptor,  EventSetDescriptor, and MethodDescriptor, etc.

 It supports some common information that can be set and retrieved for  any of the introspection descriptors.

 In addition it provides an extension mechanism so that arbitrary  attribute/value pairs can be associated with a design feature.

______________________________________________________________________________

 	FeatureDescriptor()

 	attributeNames()

  	getDisplayName()

  	getName()

  	getShortDescription()

  	getValue(String)

 Retrieve a named attribute with this feature.

 	isExpert()

 The "expert" flag is used to distinguish between those features that are  intended for expert users from those that are intended for normal users.

 	isHidden()

 The "hidden" flag is used to identify features that are intended only  for tool use, and which should not be exposed to humans.

 	setDisplayName(String)

  	setExpert(boolean)

 The "expert" flag is used to distinguish between features that are  intended for expert users from those that are intended for normal users.

 	setHidden(boolean)

 The "hidden" flag is used to identify features that are intended only  for tool use, and which should not be exposed to humans.

 	setName(String)

  	setShortDescription(String)

 You can associate a short descriptive string with a feature.

 	setValue(String, Object)

 Associate a named attribute with this feature.

 FeatureDescriptor

  public FeatureDescriptor()

 getName

  public String getName()

Returns:

 The programmatic name of the property/method/event

 setName

  public void setName(String name)

Parameters:

 name - The programmatic name of the property/method/event

 getDisplayName

  public String getDisplayName()

Returns:

 The localized display name for the property/method/event. 	This defaults to the same as its programmatic name from getName.

 setDisplayName

  public void setDisplayName(String displayName)

Parameters:

 displayName - The localized display name for the 	property/method/event.

 isExpert

  public boolean isExpert()

 The "expert" flag is used to distinguish between those features that are  intended for expert users from those that are intended for normal users.

Returns:

 True if this feature is intended for use by experts only.

 setExpert

  public void setExpert(boolean expert)

 The "expert" flag is used to distinguish between features that are  intended for expert users from those that are intended for normal users.

Parameters:

 expert - True if this feature is intended for use by experts only.

 isHidden

  public boolean isHidden()

 The "hidden" flag is used to identify features that are intended only  for tool use, and which should not be exposed to humans.

Returns:

 True if this feature should be hidden from human users.

 setHidden

  public void setHidden(boolean hidden)

 The "hidden" flag is used to identify features that are intended only  for tool use, and which should not be exposed to humans.

Parameters:

 hidden - True if this feature should be hidden from human users.

 getShortDescription

  public String getShortDescription()

Returns:

 A localized short description associated with this  property/method/event. This defaults to be the display name.

 setShortDescription

  public void setShortDescription(String text)

 You can associate a short descriptive string with a feature. Normally  these descriptive strings should be less than about 40 characters.

Parameters:

 text - A (localized) short description to be associated with  this property/method/event.

 setValue

  public void setValue(String attributeName,
                       Object value)

 Associate a named attribute with this feature.

Parameters:

 attributeName - The locale-independent name of the attribute

 value - The value.

 getValue

  public Object getValue(String attributeName)

 Retrieve a named attribute with this feature.

Parameters:

 attributeName - The locale-independent name of the attribute

Returns:

 The value of the attribute. May be null if 	the attribute is unknown.

 attributeNames

  public Enumeration attributeNames()

Returns:

 An enumeration of the locale-independent names of any  attributes that have been registered with setValue.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.IndexedPropertyDescriptor

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class java.beans.IndexedPropertyDescriptor

java.lang.Object
   |
   +----java.beans.FeatureDescriptor
           |
           +----java.beans.PropertyDescriptor
                   |
                   +----java.beans.IndexedPropertyDescriptor

______________________________________________________________________________

 public class IndexedPropertyDescriptor

 extends PropertyDescriptor

An IndexedPropertyDescriptor describes a property that acts like an  array and has an indexed read and/or indexed write method to access  specific elements of the array.

 An indexed property may also provide simple non-indexed read and write  methods. If these are present, they read and write arrays of the type  returned by the indexed read method.

______________________________________________________________________________

 	IndexedPropertyDescriptor(String, Class)

 This constructor constructs an IndexedPropertyDescriptor for a property  that follows the standard Java conventions by having getFoo and setFoo  accessor methods, for both indexed access and array access.

 	IndexedPropertyDescriptor (String, Class, String, String, String, String)

 This constructor takes the name of a simple property, and method  names for reading and writing the property, both indexed  and non-indexed.

 	IndexedPropertyDescriptor (String, Method, Method, Method, Method)

 This constructor takes the name of a simple property, and Method  objects for reading and writing the property.

 	getIndexedPropertyType()

  	getIndexedReadMethod()

  	getIndexedWriteMethod()

 IndexedPropertyDescriptor

  public IndexedPropertyDescriptor(String propertyName,
                                   Class beanClass) throws IntrospectionException

 This constructor constructs an IndexedPropertyDescriptor for a property   that follows the standard Java conventions by having getFoo and setFoo  accessor methods, for both indexed access and array access.

 Thus if the argument name is "fred", it will assume that there  is an indexed reader method "getFred", a non-indexed (array) reader  method also called "getFred", an indexed writer method "setFred",  and finally a non-indexed writer method "setFred".

Parameters:

 propertyName - The programmatic name of the property.

 beanClass - The Class object for the target bean.

 IndexedPropertyDescriptor

  public IndexedPropertyDescriptor(String propertyName,
                                   Class beanClass,
                                   String getterName,
                                   String setterName,
                                   String indexedGetterName,
                                   String indexedSetterName) throws IntrospectionException

 This constructor takes the name of a simple property, and method  names for reading and writing the property, both indexed  and non-indexed.

Parameters:

 propertyName - The programmatic name of the property.

 beanClass - The Class object for the target bean.

 getterName - The name of the method used for reading the property 	values as an array. May be null if the property is write-only 	or must be indexed.

 setterName - The name of the method used for writing the property 	values as an array. May be null if the property is read-only 	or must be indexed.

 indexedGetterName - The name of the method used for reading 	an indexed property value. 	May be null if the property is write-only.

 indexedSetterName - The name of the method used for writing 	an indexed property value. 	May be null if the property is read-only.

 IndexedPropertyDescriptor

  public IndexedPropertyDescriptor(String propertyName,
                                   Method getter,
                                   Method setter,
                                   Method indexedGetter,
                                   Method indexedSetter) throws IntrospectionException

 This constructor takes the name of a simple property, and Method  objects for reading and writing the property.

Parameters:

 propertyName - The programmatic name of the property.

 getter - The method used for reading the property values as an array. 	May be null if the property is write-only or must be indexed.

 setter - The method used for writing the property values as an array. 	May be null if the property is read-only or must be indexed.

 indexedGetter - The method used for reading an indexed property value. 	May be null if the property is write-only.

 indexedSetter - The method used for writing an indexed property value. 	May be null if the property is read-only.

 getIndexedReadMethod

  public Method getIndexedReadMethod()

Returns:

 The method that should be used to read an indexed  property value.  May return null if the property isn't indexed or is write-only.

 getIndexedWriteMethod

  public Method getIndexedWriteMethod()

Returns:

 The method that should be used to write an indexed  property value.  May return null if the property isn't indexed or is read-only.

 getIndexedPropertyType

  public Class getIndexedPropertyType()

Returns:

 The Java Class for the indexed properties type. Note that  the Class may describe a primitive Java type such as "int".

 This is the type that will be returned by the indexedReadMethod.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.IntrospectionException

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class java.beans.IntrospectionException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.beans.IntrospectionException

______________________________________________________________________________

 public class IntrospectionException

 extends Exception

Thrown when an exception happens during Introspection.

 Typical causes include not being able to map a string class name  to a Class object, not being able to resolve a string method name,  or specifying a method name that has the wrong type signature for  its intended use.

______________________________________________________________________________

 	IntrospectionException(String)

 IntrospectionException

  public IntrospectionException(String mess)

Parameters:

 mess - Descriptive message

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.Introspector

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class java.beans.Introspector

java.lang.Object
   |
   +----java.beans.Introspector

______________________________________________________________________________

 public class Introspector

 extends Object

The Introspector class provides a standard way for tools to learn about  the properties, events, and methods supported by a target Java Bean.

 For each of those three kinds of information, the Introspector will  separately analyze the bean's class and superclasses looking for  either explicit or implicit information and use that information to  build a BeanInfo object that comprehensively describes the target bean.

 For each class "Foo", explicit information may be available if there exists  a corresponding "FooBeanInfo" class that provides a non-null value when  queried for the information. We first look for the BeanInfo class by  taking the full package-qualified name of the target bean class and  appending "BeanInfo" to form a new class name. If this fails, then  we take the final classname component of this name, and look for that  class in each of the packages specified in the BeanInfo package search  path.

 Thus for a class such as "sun.xyz.OurButton" we would first look for a  BeanInfo class called "sun.xyz.OurButtonBeanInfo" and if that failed we'd  look in each package in the BeanInfo search path for an OurButtonBeanInfo  class. With the default search path, this would mean looking for  "sun.beans.infos.OurButtonBeanInfo".

 If a class provides explicit BeanInfo about itself then we add that to  the BeanInfo information we obtained from analyzing any derived classes,  but we regard the explicit information as being definitive for the current  class and its base classes, and do not proceed any further up the superclass  chain.

 If we don't find explicit BeanInfo on a class, we use low-level  reflection to study the methods of the class and apply standard design  patterns to identify property accessors, event sources, or public  methods. We then proceed to analyze the class's superclass and add  in the information from it (and possibly on up the superclass chain).

______________________________________________________________________________

 	decapitalize(String)

 Utility method to take a string and convert it to normal Java variable  name capitalization.

 	getBeanInfo(Class)

 Introspect on a Java bean and learn about all its properties, exposed  methods, and events.

 	getBeanInfo(Class, Class)

 Introspect on a Java bean and learn all about its properties, exposed  methods, below a given "stop" point.

 	getBeanInfoSearchPath()

  	setBeanInfoSearchPath (String[])

 Change the list of package names that will be used for 	finding BeanInfo classes.

 getBeanInfo

  public static BeanInfo getBeanInfo(Class beanClass) throws IntrospectionException

 Introspect on a Java bean and learn about all its properties, exposed  methods, and events.

Parameters:

 beanClass - The bean class to be analyzed.

Returns:

 A BeanInfo object describing the target bean.

 getBeanInfo

  public static BeanInfo getBeanInfo(Class beanClass,
                                     Class stopClass) throws IntrospectionException

 Introspect on a Java bean and learn all about its properties, exposed  methods, below a given "stop" point.

Parameters:

 bean - The bean class to be analyzed.

 stopClass - The baseclass at which to stop the analysis. Any  methods/properties/events in the stopClass or in its baseclasses  will be ignored in the analysis.

 decapitalize

  public static String decapitalize(String name)

 Utility method to take a string and convert it to normal Java variable  name capitalization. This normally means converting the first  character from upper case to lower case, but in the (unusual) special  case when there is more than one character and both the first and  second characters are upper case, we leave it alone.

 Thus "FooBah" becomes "fooBah" and "X" becomes "x", but "URL" stays  as "URL".

Parameters:

 name - The string to be decapitalized.

Returns:

 The decapitalized version of the string.

 getBeanInfoSearchPath

  public static String[] getBeanInfoSearchPath()

Returns:

 The array of package names that will be searched in 	order to find BeanInfo classes.

 This is initially set to {"sun.beans.infos"}.

 setBeanInfoSearchPath

  public static void setBeanInfoSearchPath(String path[])

 Change the list of package names that will be used for 	finding BeanInfo classes.

Parameters:

 path - Array of package names.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.MethodDescriptor

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class java.beans.MethodDescriptor

java.lang.Object
   |
   +----java.beans.FeatureDescriptor
           |
           +----java.beans.MethodDescriptor

______________________________________________________________________________

 public class MethodDescriptor

 extends FeatureDescriptor

A MethodDescriptor describes a particular method that a Java Bean  supports for external access from other components.

______________________________________________________________________________

 	MethodDescriptor(Method)

  	MethodDescriptor (Method, ParameterDescriptor[])

 	getMethod()

  	getParameterDescriptors()

 MethodDescriptor

  public MethodDescriptor(Method method)

Parameters:

 method - The low-level method information.

 MethodDescriptor

  public MethodDescriptor(Method method,
                          ParameterDescriptor parameterDescriptors[])

Parameters:

 method - The low-level method information.

 parameterDescriptors - Descriptive information for each of the 	method's parameters.

 getMethod

  public Method getMethod()

Returns:

 The low-level description of the method

 getParameterDescriptors

  public ParameterDescriptor[] getParameterDescriptors()

Returns:

 The locale-independent names of the parameters. May return 	a null array if the parameter names aren't known.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.ParameterDescriptor

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class java.beans.ParameterDescriptor

java.lang.Object
   |
   +----java.beans.FeatureDescriptor
           |
           +----java.beans.ParameterDescriptor

______________________________________________________________________________

 public class ParameterDescriptor

 extends FeatureDescriptor

The ParameterDescriptor class allows bean implementors to provide  additional information on each of their parameters, beyond the  low level type information provided by the java.lang.reflect.Method  class.

 Currently all our state comes from the FeatureDescriptor base class.

______________________________________________________________________________

 	ParameterDescriptor()

 ParameterDescriptor

  public ParameterDescriptor()

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.PropertyChangeEvent

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class java.beans.PropertyChangeEvent

java.lang.Object
   |
   +----java.util.EventObject
           |
           +----java.beans.PropertyChangeEvent

______________________________________________________________________________

 public class PropertyChangeEvent

 extends EventObject

A "PropertyChange" event gets delivered whenever a bean changes a "bound"  or "constrained" property. A PropertyChangeEvent object is sent as an  argument to the PropertyChangeListener and VetoableChangeListener methods.

 Normally PropertyChangeEvents are accompanied by the name and the old  and new value of the changed property. If the new value is a builtin  type (such as int or boolean) it must be wrapped as the  corresponding java.lang.* Object type (such as Integer or Boolean).

 Null values may be provided for the old and the new values if their  true values are not known.

 An event source may send a null object as the name to indicate that an  arbitrary set of if its properties have changed. In this case the  old and new values should also be null.

______________________________________________________________________________

 	PropertyChangeEvent(Object, String, Object, Object)

 	getNewValue()

  	getOldValue()

  	getPropagationId()

 The "propagationId" field is reserved for future use.

 	getPropertyName()

  	setPropagationId(Object)

 PropertyChangeEvent

  public PropertyChangeEvent(Object source,
                             String propertyName,
                             Object oldValue,
                             Object newValue)

Parameters:

 source - The bean that fired the event.

 propertyName - The programmatic name of the property 	that was changed.

 oldValue - The old value of the property.

 newValue - The new value of the property.

 getPropertyName

  public String getPropertyName()

Returns:

 The programmatic name of the property that was changed. 	May be null if multiple properties have changed.

 getNewValue

  public Object getNewValue()

Returns:

 The new value for the property, expressed as an Object. 	May be null if multiple properties have changed.

 getOldValue

  public Object getOldValue()

Returns:

 The old value for the property, expressed as an Object. 	May be null if multiple properties have changed.

 setPropagationId

  public void setPropagationId(Object propagationId)

Parameters:

 propagationId - The propagationId object for the event.

 getPropagationId

  public Object getPropagationId()

 The "propagationId" field is reserved for future use. In Beans 1.0  the sole requirement is that if a listener catches a PropertyChangeEvent  and then fires a PropertyChangeEvent of its own, then it should  make sure that it propagates the propagationId field from its  incoming event to its outgoing event.

Returns:

 the propagationId object associated with a bound/constrained 	property update.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.beans.PropertyChangeListener

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Interface java.beans.PropertyChangeListener

 public interface PropertyChangeListener

 extends EventListener

A "PropertyChange" event gets fired whenever a bean changes a "bound"  property. You can register a PropertyChangeListener with a source  bean so as to be notified of any bound property updates.

______________________________________________________________________________

 	propertyChange(PropertyChangeEvent)

 This method gets called when a bound property is changed.

 propertyChange

  public abstract void propertyChange(PropertyChangeEvent evt)

 This method gets called when a bound property is changed.

Parameters:

 evt - A PropertyChangeEvent object describing the event source  and the property that has changed.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.PropertyChangeSupport

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class java.beans.PropertyChangeSupport

java.lang.Object
   |
   +----java.beans.PropertyChangeSupport

______________________________________________________________________________

 public class PropertyChangeSupport

 extends Object

 implements Serializable

This is a utility class that can be used by beans that support bound  properties. You can either inherit from this class or you can use  an instance of this class as a member field of your bean and delegate  various work to it.

______________________________________________________________________________

 	PropertyChangeSupport(Object)

 	addPropertyChangeListener(PropertyChangeListener)

 Add a PropertyChangeListener to the listener list.

 	firePropertyChange(String, Object, Object)

 Report a bound property update to any registered listeners.

 	removePropertyChangeListener(PropertyChangeListener)

 Remove a PropertyChangeListener from the listener list.

 PropertyChangeSupport

  public PropertyChangeSupport(Object sourceBean)

 addPropertyChangeListener

  public synchronized void addPropertyChangeListener(PropertyChangeListener listener)

 Add a PropertyChangeListener to the listener list.

Parameters:

 listener - The PropertyChangeListener to be added

 removePropertyChangeListener

  public synchronized void removePropertyChangeListener(PropertyChangeListener listener)

 Remove a PropertyChangeListener from the listener list.

Parameters:

 listener - The PropertyChangeListener to be removed

 firePropertyChange

  public void firePropertyChange(String propertyName,
                                 Object oldValue,
                                 Object newValue)

 Report a bound property update to any registered listeners.  No event is fired if old and new are equal and non-null.

Parameters:

 propertyName - The programmatic name of the property 	that was changed.

 oldValue - The old value of the property.

 newValue - The new value of the property.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.PropertyDescriptor

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class java.beans.PropertyDescriptor

java.lang.Object
   |
   +----java.beans.FeatureDescriptor
           |
           +----java.beans.PropertyDescriptor

______________________________________________________________________________

 public class PropertyDescriptor

 extends FeatureDescriptor

A PropertyDescriptor describes one property that a Java Bean  exports via a pair of accessor methods.

______________________________________________________________________________

 	PropertyDescriptor(String, Class)

 Constructs a PropertyDescriptor for a property that follows  the standard Java convention by having getFoo and setFoo  accessor methods.

 	PropertyDescriptor(String, Class, String, String)

 This constructor takes the name of a simple property, and method  names for reading and writing the property.

 	PropertyDescriptor(String, Method, Method)

 This constructor takes the name of a simple property, and Method  objects for reading and writing the property.

 	getPropertyEditorClass()

  	getPropertyType()

  	getReadMethod()

  	getWriteMethod()

  	isBound()

 Updates to "bound" properties will cause a "PropertyChange" event to  get fired when the property is changed.

 	isConstrained()

 Attempted updates to "Constrained" properties will cause a "VetoableChange"  event to get fired when the property is changed.

 	setBound(boolean)

 Updates to "bound" properties will cause a "PropertyChange" event to  get fired when the property is changed.

 	setConstrained(boolean)

 Attempted updates to "Constrained" properties will cause a "VetoableChange"  event to get fired when the property is changed.

 	setPropertyEditorClass(Class)

 Normally PropertyEditors will be found using the PropertyEditorManager.

 PropertyDescriptor

  public PropertyDescriptor(String propertyName,
                            Class beanClass) throws IntrospectionException

 Constructs a PropertyDescriptor for a property that follows  the standard Java convention by having getFoo and setFoo  accessor methods. Thus if the argument name is "fred", it will  assume that the reader method is "getFred" and the writer method  is "setFred". Note that the property name should start with a lower  case character, which will be capitalized in the method names.

Parameters:

 propertyName - The programmatic name of the property.

 beanClass - The Class object for the target bean. For 	example sun.beans.OurButton.class.

 PropertyDescriptor

  public PropertyDescriptor(String propertyName,
                            Class beanClass,
                            String getterName,
                            String setterName) throws IntrospectionException

 This constructor takes the name of a simple property, and method  names for reading and writing the property.

Parameters:

 propertyName - The programmatic name of the property.

 beanClass - The Class object for the target bean. For 	example sun.beans.OurButton.class.

 getterName - The name of the method used for reading the property 	value. May be null if the property is write-only.

 setterName - The name of the method used for writing the property 	value. May be null if the property is read-only.

 PropertyDescriptor

  public PropertyDescriptor(String propertyName,
                            Method getter,
                            Method setter) throws IntrospectionException

 This constructor takes the name of a simple property, and Method  objects for reading and writing the property.

Parameters:

 propertyName - The programmatic name of the property.

 getter - The method used for reading the property value. 	May be null if the property is write-only.

 setter - The method used for writing the property value. 	May be null if the property is read-only.

 getPropertyType

  public Class getPropertyType()

Returns:

 The Java type info for the property. Note that  the "Class" object may describe a built-in Java type such as "int".  The result may be "null" if this is an indexed property that  does not support non-indexed access.

 This is the type that will be returned by the ReadMethod.

 getReadMethod

  public Method getReadMethod()

Returns:

 The method that should be used to read the property value.  May return null if the property can't be read.

 getWriteMethod

  public Method getWriteMethod()

Returns:

 The method that should be used to write the property value.  May return null if the property can't be written.

 isBound

  public boolean isBound()

 Updates to "bound" properties will cause a "PropertyChange" event to  get fired when the property is changed.

Returns:

 True if this is a bound property.

 setBound

  public void setBound(boolean bound)

 Updates to "bound" properties will cause a "PropertyChange" event to  get fired when the property is changed.

Parameters:

 bound - True if this is a bound property.

 isConstrained

  public boolean isConstrained()

 Attempted updates to "Constrained" properties will cause a "VetoableChange"  event to get fired when the property is changed.

Returns:

 True if this is a constrained property.

 setConstrained

  public void setConstrained(boolean constrained)

 Attempted updates to "Constrained" properties will cause a "VetoableChange"  event to get fired when the property is changed.

Parameters:

 constrained - True if this is a constrained property.

 setPropertyEditorClass

  public void setPropertyEditorClass(Class propertyEditorClass)

 Normally PropertyEditors will be found using the PropertyEditorManager.   However if for some reason you want to associate a particular  PropertyEditor with a given property, then you can do it with  this method.

Parameters:

 propertyEditorClass - The Class for the desired PropertyEditor.

 getPropertyEditorClass

  public Class getPropertyEditorClass()

Returns:

 Any explicit PropertyEditor Class that has been registered 	for this property. Normally this will return "null", 	indicating that no special editor has been registered, 	so the PropertyEditorManager should be used to locate 	a suitable PropertyEditor.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.beans.PropertyEditor

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Interface java.beans.PropertyEditor

 public interface PropertyEditor

A PropertyEditor class provides support for GUIs that want to  allow users to edit a property value of a given type.

 PropertyEditor supports a variety of different kinds of ways of  displaying and updating property values. Most PropertyEditors will  only need to support a subset of the different options available in  this API.

 Simple PropertyEditors may only support the getAsText and setAsText  methods and need not support (say) paintValue or getCustomEditor. More  complex types may be unable to support getAsText and setAsText but will  instead support paintValue and getCustomEditor.

 Every propertyEditor must support one or more of the three simple  display styles. Thus it can either (1) support isPaintable or (2)  both return a non-null String[] from getTags() and return a non-null  value from getAsText or (3) simply return a non-null String from  getAsText().

 Every property editor must support a call on setValue when the argument  object is of the type for which this is the corresponding propertyEditor.  In addition, each property editor must either support a custom editor,  or support setAsText.

 Each PropertyEditor should have a null constructor.

______________________________________________________________________________

 	addPropertyChangeListener(PropertyChangeListener)

 Register a listener for the PropertyChange event.

 	getAsText()

  	getCustomEditor()

 A PropertyEditor may choose to make available a full custom Component  that edits its property value.

 	getJavaInitializationString()

 This method is intended for use when generating Java code to set  the value of the property.

 	getTags()

 If the property value must be one of a set of known tagged values,  then this method should return an array of the tags.

 	getValue()

  	isPaintable()

  	paintValue (Graphics, Rectangle)

 Paint a representation of the value into a given area of screen  real estate.

 	removePropertyChangeListener(PropertyChangeListener)

 Remove a listener for the PropertyChange event.

 	setAsText(String)

 Set the property value by parsing a given String.

 	setValue(Object)

 Set (or change) the object that is to be edited.

 	supportsCustomEditor()

 setValue

  public abstract void setValue(Object value)

 Set (or change) the object that is to be edited. Builtin types such  as "int" must be wrapped as the corresponding object type such as  "java.lang.Integer".

Parameters:

 value - The new target object to be edited. Note that this  object should not be modified by the PropertyEditor, rather  the PropertyEditor should create a new object to hold any  modified value.

 getValue

  public abstract Object getValue()

Returns:

 The value of the property. Builtin types such as "int" will  be wrapped as the corresponding object type such as "java.lang.Integer".

 isPaintable

  public abstract boolean isPaintable()

Returns:

 True if the class will honor the paintValue method.

 paintValue

  public abstract void paintValue(Graphics gfx,
                                  Rectangle box)

 Paint a representation of the value into a given area of screen  real estate. Note that the propertyEditor is responsible for doing  its own clipping so that it fits into the given rectangle.

 If the PropertyEditor doesn't honor paint requests (see isPaintable)  this method should be a silent noop.

Parameters:

 gfx - Graphics object to paint into.

 box - Rectangle within graphics object into which we should paint.

 getJavaInitializationString

  public abstract String getJavaInitializationString()

 This method is intended for use when generating Java code to set  the value of the property. It should return a fragment of Java code  that can be used to initialize a variable with the current property  value.

 Example results are "2", "new Color(127,127,34)", "Color.orange", etc.

Returns:

 A fragment of Java code representing an initializer for the  current value.

 getAsText

  public abstract String getAsText()

Returns:

 The property value as a human editable string.

 Returns null if the value can't be expressed as an editable string.

 If a non-null value is returned, then the PropertyEditor should 	be prepared to parse that string back in setAsText().

 setAsText

  public abstract void setAsText(String text) throws IllegalArgumentException

 Set the property value by parsing a given String. May raise  java.lang.IllegalArgumentException if either the String is  badly formatted or if this kind of property can't be expressed  as text.

Parameters:

 text - The string to be parsed.

 getTags

  public abstract String[] getTags()

 If the property value must be one of a set of known tagged values,  then this method should return an array of the tags. This can  be used to represent (for example) enum values. If a PropertyEditor  supports tags, then it should support the use of setAsText with  a tag value as a way of setting the value and the use of getAsText  to identify the current value.

Returns:

 The tag values for this property. May be null if this  property cannot be represented as a tagged value.

 getCustomEditor

  public abstract Component getCustomEditor()

 A PropertyEditor may choose to make available a full custom Component  that edits its property value. It is the responsibility of the  PropertyEditor to hook itself up to its editor Component itself and  to report property value changes by firing a PropertyChange event.

 The higher-level code that calls getCustomEditor may either embed  the Component in some larger property sheet, or it may put it in  its own individual dialog, or ...

Returns:

 A java.awt.Component that will allow a human to directly  edit the current property value. May be null if this is 	not supported.

 supportsCustomEditor

  public abstract boolean supportsCustomEditor()

Returns:

 True if the propertyEditor can provide a custom editor.

 addPropertyChangeListener

  public abstract void addPropertyChangeListener(PropertyChangeListener listener)

 Register a listener for the PropertyChange event. When a  PropertyEditor changes its value it should fire a PropertyChange  event on all registered PropertyChangeListeners, specifying the  null value for the property name and itself as the source.

Parameters:

 listener - An object to be invoked when a PropertyChange 	event is fired.

 removePropertyChangeListener

  public abstract void removePropertyChangeListener(PropertyChangeListener listener)

 Remove a listener for the PropertyChange event.

Parameters:

 listener - The PropertyChange listener to be removed.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.PropertyEditorManager

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class java.beans.PropertyEditorManager

java.lang.Object
   |
   +----java.beans.PropertyEditorManager

______________________________________________________________________________

 public class PropertyEditorManager

 extends Object

The PropertyEditorManager can be used to locate a property editor for  any given type name. This property editor must support the  java.beans.PropertyEditor interface for editing a given object.

 The PropertyEditorManager uses three techniques for locating an editor  for a given type. First, it provides a registerEditor method to allow  an editor to be specifically registered for a given type. Second it  tries to locate a suitable class by adding "Editor" to the full  qualified classname of the given type (e.g. "foo.bah.FozEditor").  Finally it takes the simple classname (without the package name) adds  "Editor" to it and looks in a search-path of packages for a matching  class.

 So for an input class foo.bah.Fred, the PropertyEditorManager would  first look in its tables to see if an editor had been registered for  foo.bah.Fred and if so use that. Then it will look for a  foo.bah.FredEditor class. Then it will look for (say)  standardEditorsPackage.FredEditor class.

 Default PropertyEditors will be provided for the Java builtin types  "boolean", "byte", "short", "int", "long", "float", and "double"; and  for the classes java.lang.String. java.awt.Color, and java.awt.Font.

______________________________________________________________________________

 	PropertyEditorManager()

 	findEditor(Class)

 Locate a value editor for a given target type.

 	getEditorSearchPath()

  	registerEditor(Class, Class)

 Register an editor class to be used to editor values of  a given target class.

 	setEditorSearchPath(String[])

 Change the list of package names that will be used for 	finding property editors.

 PropertyEditorManager

  public PropertyEditorManager()

 registerEditor

  public static void registerEditor(Class targetType,
                                    Class editorClass)

 Register an editor class to be used to editor values of  a given target class.

Parameters:

 targetType - the Class object of the type to be edited

 editorClass - the Class object of the editor class. If 	this is null, then any existing definition will be removed.

 findEditor

  public static PropertyEditor findEditor(Class targetType)

 Locate a value editor for a given target type.

Parameters:

 targetType - The Class object for the type to be edited

Returns:

 An editor object for the given target class.  The result is null if no suitable editor can be found.

 getEditorSearchPath

  public static String[] getEditorSearchPath()

Returns:

 The array of package names that will be searched in 	order to find property editors.

 This is initially set to {"sun.beans.editors"}.

 setEditorSearchPath

  public static void setEditorSearchPath(String path[])

 Change the list of package names that will be used for 	finding property editors.

Parameters:

 path - Array of package names.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.PropertyEditorSupport

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class java.beans.PropertyEditorSupport

java.lang.Object
   |
   +----java.beans.PropertyEditorSupport

______________________________________________________________________________

 public class PropertyEditorSupport

 extends Object

 implements PropertyEditor

______________________________________________________________________________

 	PropertyEditorSupport()

 Constructor for use by derived PropertyEditor classes.

 	PropertyEditorSupport(Object)

 Constructor for use when a PropertyEditor is delegating to us.

 	addPropertyChangeListener(PropertyChangeListener)

 Register a listener for the PropertyChange event.

 	firePropertyChange()

 Report that we have been modified to any interested listeners.

 	getAsText()

  	getCustomEditor()

 A PropertyEditor may chose to make available a full custom Component  that edits its property value.

 	getJavaInitializationString()

 This method is intended for use when generating Java code to set  the value of the property.

 	getTags()

 If the property value must be one of a set of known tagged values,  then this method should return an array of the tag values.

 	getValue()

  	isPaintable()

  	paintValue (Graphics, Rectangle)

 Paint a representation of the value into a given area of screen  real estate.

 	removePropertyChangeListener(PropertyChangeListener)

 Remove a listener for the PropertyChange event.

 	setAsText(String)

 Set the property value by parsing a given String.

 	setValue(Object)

 Set (or change) the object that is to be edited.

 	supportsCustomEditor()

 PropertyEditorSupport

  protected PropertyEditorSupport()

 Constructor for use by derived PropertyEditor classes.

 PropertyEditorSupport

  protected PropertyEditorSupport(Object source)

 Constructor for use when a PropertyEditor is delegating to us.

Parameters:

 source - The source to use for any events we fire.

 setValue

  public void setValue(Object value)

 Set (or change) the object that is to be edited.

Parameters:

 value - The new target object to be edited. Note that this  object should not be modified by the PropertyEditor, rather  the PropertyEditor should create a new object to hold any  modified value.

 getValue

  public Object getValue()

Returns:

 The value of the property.

 isPaintable

  public boolean isPaintable()

Returns:

 True if the class will honor the paintValue method.

 paintValue

  public void paintValue(Graphics gfx,
                         Rectangle box)

 Paint a representation of the value into a given area of screen  real estate. Note that the propertyEditor is responsible for doing  its own clipping so that it fits into the given rectangle.

 If the PropertyEditor doesn't honor paint requests (see isPaintable)  this method should be a silent noop.

Parameters:

 gfx - Graphics object to paint into.

 box - Rectangle within graphics object into which we should paint.

 getJavaInitializationString

  public String getJavaInitializationString()

 This method is intended for use when generating Java code to set  the value of the property. It should return a fragment of Java code  that can be used to initialize a variable with the current property  value.

 Example results are "2", "new Color(127,127,34)", "Color.orange", etc.

Returns:

 A fragment of Java code representing an initializer for the  current value.

 getAsText

  public String getAsText()

Returns:

 The property value as a string suitable for presentation  to a human to edit.

 Returns "null" is the value can't be expressed as a string.

 If a non-null value is returned, then the PropertyEditor should 	be prepared to parse that string back in setAsText().

 setAsText

  public void setAsText(String text) throws IllegalArgumentException

 Set the property value by parsing a given String. May raise  java.lang.IllegalArgumentException if either the String is  badly formatted or if this kind of property can't be expressed  as text.

Parameters:

 text - The string to be parsed.

 getTags

  public String[] getTags()

 If the property value must be one of a set of known tagged values,  then this method should return an array of the tag values. This can  be used to represent (for example) enum values. If a PropertyEditor  supports tags, then it should support the use of setAsText with  a tag value as a way of setting the value.

Returns:

 The tag values for this property. May be null if this  property cannot be represented as a tagged value.

 getCustomEditor

  public Component getCustomEditor()

 A PropertyEditor may chose to make available a full custom Component  that edits its property value. It is the responsibility of the  PropertyEditor to hook itself up to its editor Component itself and  to report property value changes by firing a PropertyChange event.

 The higher-level code that calls getCustomEditor may either embed  the Component in some larger property sheet, or it may put it in  its own individual dialog, or ...

Returns:

 A java.awt.Component that will allow a human to directly  edit the current property value. May be null if this is 	not supported.

 supportsCustomEditor

  public boolean supportsCustomEditor()

Returns:

 True if the propertyEditor can provide a custom editor.

 addPropertyChangeListener

  public synchronized void addPropertyChangeListener(PropertyChangeListener listener)

 Register a listener for the PropertyChange event. The class will  fire a PropertyChange value whenever the value is updated.

Parameters:

 listener - An object to be invoked when a PropertyChange 	event is fired.

 removePropertyChangeListener

  public synchronized void removePropertyChangeListener(PropertyChangeListener listener)

 Remove a listener for the PropertyChange event.

Parameters:

 listener - The PropertyChange listener to be removed.

 firePropertyChange

  public void firePropertyChange()

 Report that we have been modified to any interested listeners.

Parameters:

 source - The PropertyEditor that caused the event.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.PropertyVetoException

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class java.beans.PropertyVetoException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.beans.PropertyVetoException

______________________________________________________________________________

 public class PropertyVetoException

 extends Exception

A PropertyVetoException is thrown when a proposed change to a  property represents an unacceptable value.

______________________________________________________________________________

 	PropertyVetoException(String, PropertyChangeEvent)

 	getPropertyChangeEvent()

 PropertyVetoException

  public PropertyVetoException(String mess,
                               PropertyChangeEvent evt)

Parameters:

 mess - Descriptive message

 evt - A PropertyChangeEvent describing the vetoed change.

 getPropertyChangeEvent

  public PropertyChangeEvent getPropertyChangeEvent()

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.SimpleBeanInfo

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class java.beans.SimpleBeanInfo

java.lang.Object
   |
   +----java.beans.SimpleBeanInfo

______________________________________________________________________________

 public class SimpleBeanInfo

 extends Object

 implements BeanInfo

This is a support class to make it easier for people to provide  BeanInfo classes.

 It defaults to providing "noop" information, and can be selectively  overriden to provide more explicit information on chosen topics.  When the introspector sees the "noop" values, it will apply low  level introspection and design patterns to automatically analyze  the target bean.

______________________________________________________________________________

 	SimpleBeanInfo()

 	getAdditionalBeanInfo()

 Claim there are no other relevant BeanInfo objects.

 	getBeanDescriptor()

 Deny knowledge about the class and customizer of the bean.

 	getDefaultEventIndex()

 Deny knowledge of a default event.

 	getDefaultPropertyIndex()

 Deny knowledge of a default property.

 	getEventSetDescriptors()

 Deny knowledge of event sets.

 	getIcon(int)

 Claim there are no icons available.

 	getMethodDescriptors()

 Deny knowledge of methods.

 	getPropertyDescriptors()

 Deny knowledge of properties.

 	loadImage(String)

 This is a utility method to help in loading icon images.

 SimpleBeanInfo

  public SimpleBeanInfo()

 getBeanDescriptor

  public BeanDescriptor getBeanDescriptor()

 Deny knowledge about the class and customizer of the bean.  You can override this if you wish to provide explicit info.

 getPropertyDescriptors

  public PropertyDescriptor[] getPropertyDescriptors()

 Deny knowledge of properties. You can override this  if you wish to provide explicit property info.

 getDefaultPropertyIndex

  public int getDefaultPropertyIndex()

 Deny knowledge of a default property. You can override this  if you wish to define a default property for the bean.

 getEventSetDescriptors

  public EventSetDescriptor[] getEventSetDescriptors()

 Deny knowledge of event sets. You can override this  if you wish to provide explicit event set info.

 getDefaultEventIndex

  public int getDefaultEventIndex()

 Deny knowledge of a default event. You can override this  if you wish to define a default event for the bean.

 getMethodDescriptors

  public MethodDescriptor[] getMethodDescriptors()

 Deny knowledge of methods. You can override this  if you wish to provide explicit method info.

 getAdditionalBeanInfo

  public BeanInfo[] getAdditionalBeanInfo()

 Claim there are no other relevant BeanInfo objects. You  may override this if you want to (for example) return a  BeanInfo for a base class.

 getIcon

  public Image getIcon(int iconKind)

 Claim there are no icons available. You can override  this if you want to provide icons for your bean.

 loadImage

  public Image loadImage(String resourceName)

 This is a utility method to help in loading icon images.  It takes the name of a resource file associated with the  current object's class file and loads an image object  from that file. Typically images will be GIFs.

Parameters:

 resourceName - A pathname relative to the directory 	holding the class file of the current class. For example, 	"wombat.gif".

Returns:

 an image object. May be null if the load failed.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.beans.VetoableChangeListener

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Interface java.beans.VetoableChangeListener

 public interface VetoableChangeListener

 extends EventListener

A VetoableChange event gets fired whenever a bean changes a "constrained"  property. You can register a VetoableChangeListener with a source bean  so as to be notified of any constrained property updates.

______________________________________________________________________________

 	vetoableChange(PropertyChangeEvent)

 This method gets called when a constrained property is changed.

 vetoableChange

  public abstract void vetoableChange(PropertyChangeEvent evt) throws PropertyVetoException

 This method gets called when a constrained property is changed.  The recipient may throw a PropertyVetoException if it wishes the  property change to be rolled-back.

Parameters:

 evt - A PropertyChangeEvent object describing the event source  and the property that has changed.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.VetoableChangeSupport

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class java.beans.VetoableChangeSupport

java.lang.Object
   |
   +----java.beans.VetoableChangeSupport

______________________________________________________________________________

 public class VetoableChangeSupport

 extends Object

 implements Serializable

This is a utility class that can be used by beans that support constrained  properties. Your can either inherit from this class or you can use  an instance of this class as a member field of your bean and delegate  various work to it.

______________________________________________________________________________

 	VetoableChangeSupport(Object)

 	addVetoableChangeListener(VetoableChangeListener)

 Add a VetoableListener to the listener list.

 	fireVetoableChange(String, Object, Object)

 Report a vetoable property update to any registered listeners.

 	removeVetoableChangeListener(VetoableChangeListener)

 Remove a VetoableChangeListener from the listener list.

 VetoableChangeSupport

  public VetoableChangeSupport(Object sourceBean)

 addVetoableChangeListener

  public synchronized void addVetoableChangeListener(VetoableChangeListener listener)

 Add a VetoableListener to the listener list.

Parameters:

 listener - The VetoableChangeListener to be added

 removeVetoableChangeListener

  public synchronized void removeVetoableChangeListener(VetoableChangeListener listener)

 Remove a VetoableChangeListener from the listener list.

Parameters:

 listener - The VetoableChangeListener to be removed

 fireVetoableChange

  public void fireVetoableChange(String propertyName,
                                 Object oldValue,
                                 Object newValue) throws PropertyVetoException

 Report a vetoable property update to any registered listeners. If  anyone vetos the change, then fire a new event reverting everyone to  the old value and then rethrow the PropertyVetoException.

 No event is fired if old and new are equal and non-null.

Parameters:

 propertyName - The programmatic name of the property 	that was changed.

 oldValue - The old value of the property.

 newValue - The new value of the property.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.beans.Visibility

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Interface java.beans.Visibility

 public interface Visibility

Under some circumstances a bean may be run on servers where a GUI  is not available. This interface can be used to query a bean to  determine whether it absolutely needs a gui, and to advise the  bean whether a GUI is available.

 This interface is for expert developers, and is not needed  for normal simple beans. To avoid confusing end-users we  avoid using getXXX setXXX design patterns for these methods.

______________________________________________________________________________

 	avoidingGui()

  	dontUseGui()

 This method instructs the bean that it should not use the Gui.

 	needsGui()

  	okToUseGui()

 This method instructs the bean that it is OK to use the Gui.

 needsGui

  public abstract boolean needsGui()

Returns:

 True if the bean absolutely needs a GUI available in 	order to get its work done.

 dontUseGui

  public abstract void dontUseGui()

 This method instructs the bean that it should not use the Gui.

 okToUseGui

  public abstract void okToUseGui()

 This method instructs the bean that it is OK to use the Gui.

 avoidingGui

  public abstract boolean avoidingGui()

Returns:

 true if the bean is currently avoiding use of the Gui.  e.g. due to a call on dontUseGui().

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.util.EventListener

All Packages  Class Hierarchy  This Package   Previous  Next   Index
______________________________________________________________________________

  Interface java.util.EventListener

 public interface EventListener

 The EventListener interface is the prototypical interface from which all  event listener interfaces shall be derived. EventListener defines no  methods and exists merely as a way of identifying sub-types as event  listeners.

 By convention all derived EventListener interfaces shall specify their  event notification methods according to a recognisable design pattern  with a method signature of:

  public void eventNotificationMethodName(EventType e);

______________________________________________________________________________
______________________________________________________________________________

All Packages  Class Hierarchy  This Package   Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.EventObject

All Packages  Class Hierarchy  This Package   Previous  Next   Index
______________________________________________________________________________

  Class java.util.EventObject

java.lang.Object
   |
   +----java.util.EventObject

______________________________________________________________________________

 public class EventObject

 extends Object

 The Event class is the abstract root class from which all event state  objects shall be derived.

 All Event's are constructed with a reference to the object, the "source",  that is logically deemed to be the object upon which the Event in question  initially occurred upon.

______________________________________________________________________________

 	EventObject(Object)

 Constructs a prototypical Event

 	getSource()

 EventObject

  public EventObject(Object source)

 Constructs a prototypical Event

Parameters:

 source - The object that the Event occurred upon.

 getSource

  public Object getSource()

Returns:

 The object that the Event initially occurred upon.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package   Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.TooManyListenersException

All Packages  Class Hierarchy  This Package   Previous  Next   Index
______________________________________________________________________________

  Class java.util.TooManyListenersException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.util.TooManyListenersException

______________________________________________________________________________

 public class TooManyListenersException

 extends Exception

 The  TooManyListenersException  Exception is used as part of  the Java Event model to annotate and implement a unicast special case of  a multicast Event Source.

 The presence of a  throws TooManyListenersException  clause  on any given concrete implementation of the normally multicast semantic   void add < EventListenerType > ()  event listener  registration pattern is used to annotate that interface as implementing  a unicast Listener special case, that is, that one and only one Listener  may be registered on the particular event listener source concurrently.

See Also:

EventObject, EventListener

______________________________________________________________________________

 	TooManyListenersException()

 Constructs a TooManyListenersException with no detail message.

 	TooManyListenersException(String)

 Constructs a TooManyListenersException with the specified detail message.

 TooManyListenersException

  public TooManyListenersException()

 Constructs a TooManyListenersException with no detail message.  A detail message is a String that describes this particular exception.

 TooManyListenersException

  public TooManyListenersException(String s)

 Constructs a TooManyListenersException with the specified detail message.  A detail message is a String that describes this particular exception.

Parameters:

 s - the detail message

______________________________________________________________________________

All Packages  Class Hierarchy  This Package   Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Package java.beans

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package java.beans

•  BeanInfo

•  Customizer

•  PropertyChangeListener

•  PropertyEditor

•  VetoableChangeListener

•  Visibility

•  BeanDescriptor

•  Beans

•  EventSetDescriptor

•  FeatureDescriptor

•  IndexedPropertyDescriptor

•  Introspector

•  MethodDescriptor

•  ParameterDescriptor

•  PropertyChangeEvent

•  PropertyChangeSupport

•  PropertyDescriptor

•  PropertyEditorManager

•  PropertyEditorSupport

•  SimpleBeanInfo

•  VetoableChangeSupport

•  IntrospectionException

•  PropertyVetoException

Generated using an evaluation version of HyperAct HTMheLp


  Package Index

API User's Guide   Class Hierarchy  Index
______________________________________________________________________________

 Java API Packages

•  package java.beans

 Other Packages

•  package sun.beanbox

•  package sun.demo.*

Generated using an evaluation version of HyperAct HTMheLp


  Package sun.beanbox

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package sun.beanbox

•  DoOnBean

•  InputStreamProducer

•  BeanBox

•  CustomizerDialog

•  ErrorDialog

•  EventTargetDialog

•  HookupManager

•  JarInfo

•  JarLoader

•  Manifest

•  MessageHeader

•  ObjectInputStreamWithLoader

•  OurLabel

•  PropertyNameDialog

•  PropertySheet

•  Report

•  SimpleClassLoader

•  Timer

•  Wrapper

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.beanbox.BeanBox

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class sun.beanbox.BeanBox

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Panel
                           |
                           +----sun.beanbox.BeanBox

______________________________________________________________________________

 public class BeanBox

 extends Panel

 implements Serializable, Runnable

______________________________________________________________________________

 	BeanBox()

 Initialize a new BeanBox.

 	close()

 This implements the "close" menu item.

 	doInsert(Object)

 Insert a given Component instance into the current BeanBox.

 	handleEvent(Event)

 Process an old-style AWT event.

 	paint(Graphics)

 Repaint the current beanbox.

 	run()

  	save()

 This implements the "save" menu item.

 	updateMenuBar(MenuBar)

 Update the MenuBar for the current beanBox and focus bean.

 BeanBox

  public BeanBox()

 Initialize a new BeanBox.

 updateMenuBar

  public synchronized void updateMenuBar(MenuBar bar)

 Update the MenuBar for the current beanBox and focus bean.

 close

  public void close()

 This implements the "close" menu item. If we are the top-level BeanBox  then we also shut down our parent BeanBoxFrame.

 save

  public void save()

 This implements the "save" menu item. This stores away the  current state of the BeanBox to a named file.  DISCLAIMER: We do not claim that this is the "proper way" to  save a collection of inter-dependent beans. Future BDKs will  expand in this area.

 paint

  public void paint(Graphics g)

 Repaint the current beanbox. Actaully all we need to do  is take note that any rubber-band lines or boxes have  been removed.

Overrides:

paint  in class Container

 handleEvent

  public boolean handleEvent(Event evt)

 Process an old-style AWT event.

 At this level we mostly just do rubber-banding and simple  move/resize handling. We fork separate threads to handle any  menu processing to avoid deadlocks.  Note that handleEvent must NOT be "synchronized" or else we hit  serious deadlock problems around modal dialogs.

Overrides:

handleEvent  in class Component

 doInsert

  public void doInsert(Object bean)

 Insert a given Component instance into the current BeanBox.

 run

  public void run()

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.beanbox.CustomizerDialog

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class sun.beanbox.CustomizerDialog

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Window
                           |
                           +----java.awt.Dialog
                                   |
                                   +----sun.beanbox.CustomizerDialog

______________________________________________________________________________

 public class CustomizerDialog

 extends Dialog

______________________________________________________________________________

 	CustomizerDialog(Frame, Customizer, Object)

 	handleEvent(Event)

  	layout()

 CustomizerDialog

  public CustomizerDialog(Frame frame,
                          Customizer customizer,
                          Object target)

 layout

  public void layout()

Overrides:

layout  in class Container

 handleEvent

  public boolean handleEvent(Event evt)

Overrides:

handleEvent  in class Component

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface sun.beanbox.DoOnBean

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface sun.beanbox.DoOnBean

 public interface DoOnBean

______________________________________________________________________________

 	action(JarInfo, BeanInfo, String)

  	error(String)

  	error(String, Exception)

 action

  public abstract void action(JarInfo ji,
                              BeanInfo bi,
                              String beanName)

 error

  public abstract void error(String msg)

 error

  public abstract void error(String msg,
                             Exception ex)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.beanbox.ErrorDialog

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class sun.beanbox.ErrorDialog

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Window
                           |
                           +----java.awt.Dialog
                                   |
                                   +----sun.beanbox.ErrorDialog

______________________________________________________________________________

 public class ErrorDialog

 extends Dialog

______________________________________________________________________________

 	ErrorDialog(Frame, String)

 	handleEvent(Event)

 ErrorDialog

  public ErrorDialog(Frame frame,
                     String message)

 handleEvent

  public boolean handleEvent(Event evt)

Overrides:

handleEvent  in class Component

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.beanbox.EventTargetDialog

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class sun.beanbox.EventTargetDialog

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Window
                           |
                           +----java.awt.Dialog
                                   |
                                   +----sun.beanbox.EventTargetDialog

______________________________________________________________________________

 public class EventTargetDialog

 extends Dialog

 implements Runnable

______________________________________________________________________________

 	handleEvent(Event)

  	run()

 run

  public void run()

 handleEvent

  public boolean handleEvent(Event evt)

Overrides:

handleEvent  in class Component

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.beanbox.HookupManager

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class sun.beanbox.HookupManager

java.lang.Object
   |
   +----sun.beanbox.HookupManager

______________________________________________________________________________

 public class HookupManager

 extends Object

______________________________________________________________________________

 	HookupManager()

 HookupManager

  public HookupManager()

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.beanbox.JarInfo

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class sun.beanbox.JarInfo

java.lang.Object
   |
   +----sun.beanbox.JarInfo

______________________________________________________________________________

 public class JarInfo

 extends Object

Represents a loaded Jar file

______________________________________________________________________________

 	JarInfo (String, SimpleClassLoader, String[], boolean[], MessageHeader[])

 Create a JarInfo.

 	getBeanInfo(int)

 Get the BeanInfo for the ith bean in this jar file

 	getCount()

 Get the number of beans in this Jar file

 	getInstance(String)

 Get a new Bean instance given its name

 	getJarName()

 Get the name of the file containing this JAR

 	getManifestData(String)

 Get to Manifest Headers for this bean

 	getName(int)

 The bean name of this bean  REMIND - should this be an attribute of the BeanDescriptor of its BeanInfo?

 	isFromPrototype(String)

 Was this bean from a serialized prototype? -- unused so far?

 JarInfo

  public JarInfo(String jarName,
                 SimpleClassLoader cl,
                 String beanNames[],
                 boolean fromPrototype[],
                 MessageHeader manifestData[])

 Create a JarInfo.

Parameters:

 jarName - The name of the file containing the Jar

 cl - The ClassLoader instance

 beanName - The names for all the beans

 fromPrototype - Whether this bean is from a serialized prototype

 getJarName

  public String getJarName()

 Get the name of the file containing this JAR

 getCount

  public int getCount()

 Get the number of beans in this Jar file

 getBeanInfo

  public BeanInfo getBeanInfo(int i)

 Get the BeanInfo for the ith bean in this jar file

 getName

  public String getName(int i)

 The bean name of this bean  REMIND - should this be an attribute of the BeanDescriptor of its BeanInfo?

 isFromPrototype

  public boolean isFromPrototype(String name)

 Was this bean from a serialized prototype? -- unused so far?

 getManifestData

  public MessageHeader getManifestData(String name)

 Get to Manifest Headers for this bean

 getInstance

  public Object getInstance(String name)

 Get a new Bean instance given its name

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.beanbox.JarLoader

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class sun.beanbox.JarLoader

java.lang.Object
   |
   +----sun.beanbox.JarLoader

______________________________________________________________________________

 public class JarLoader

 extends Object

______________________________________________________________________________

 	JarLoader(String)

 Create a JarLoader to read a JAR and to process its contents.

 	getLoader()

 get the loader we are using

 	loadJar()

 Load the classes, resources, etc.

 	loadJarDoOnBean(String, DoOnBean)

 Load the JAR file, then apply an action to each bean found

 JarLoader

  public JarLoader(String jarName) throws FileNotFoundException

 Create a JarLoader to read a JAR and to process its contents.  Classes and resources are loaded against a single common class  loader instance so that things like "adaptor class instantiaton"  can work.  Loading is started with loadIt()

 getLoader

  public ClassLoader getLoader()

 get the loader we are using

 loadJar

  public JarInfo loadJar()

 Load the classes, resources, etc.

 loadJarDoOnBean

  public static void loadJarDoOnBean(String jarFile,
                                     DoOnBean action)

 Load the JAR file, then apply an action to each bean found

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.beanbox.Manifest

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class sun.beanbox.Manifest

java.lang.Object
   |
   +----sun.beanbox.Manifest

______________________________________________________________________________

 public class Manifest

 extends Object

______________________________________________________________________________

 	Manifest()

  	Manifest(byte[])

  	Manifest(InputStream)

 Parse a manifest from a stream

 	Manifest(String[])

 	addEntry(MessageHeader)

  	addFile(File)

  	addFiles(File, String[])

  	entries()

  	entryAt(int)

  	getEntry(String)

  	isManifestName(String)

  	stream(OutputStream, Vector)

 Manifest

  public Manifest()

 Manifest

  public Manifest(byte bytes[]) throws IOException

 Manifest

  public Manifest(InputStream is) throws IOException

 Parse a manifest from a stream

 Manifest

  public Manifest(String files[]) throws IOException

 addEntry

  public void addEntry(MessageHeader entry)

 getEntry

  public MessageHeader getEntry(String name)

 entryAt

  public MessageHeader entryAt(int i)

 entries

  public Enumeration entries()

 addFiles

  public void addFiles(File dir,
                       String files[]) throws IOException

 addFile

  public void addFile(File f) throws IOException

 stream

  public void stream(OutputStream os,
                     Vector extraFiles) throws IOException

 isManifestName

  public static boolean isManifestName(String name)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.beanbox.MessageHeader

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class sun.beanbox.MessageHeader

java.lang.Object
   |
   +----sun.beanbox.MessageHeader

______________________________________________________________________________

 public class MessageHeader

 extends Object

An RFC 844 or MIME message header. Includes methods for parsing headers from incoming streams, fetching values, setting values, and printing headers. Key values of null are legal: they indicate lines in the header that don't have a valid key, but do have a value (this isn't legal according to the standard, but lines like this are everywhere).

______________________________________________________________________________

 	MessageHeader()

  	MessageHeader(InputStream)

 	add(String, String)

 Adds a key value pair to the end of the header.

 	canonicalID(String)

 Convert a message-id string to canonical form (strips off leading and trailing >s)

 	findNextValue(String, String)

 Find the next value that corresponds to this key.

 	findValue(String)

 Find the value that corresponds to this key.

 	getKey(int)

  	getValue(int)

  	parseHeader(InputStream)

 Parse a MIME header from an input stream.

 	prepend(String, String)

 Prepends a key value pair to the beginning of the header.

 	print(PrintWriter)

 Prints the key-value pairs represented by this header.

 	set(int, String, String)

 Overwrite the previous key/val pair at location 'i'  with the new k/v.

 	set(String, String)

 Sets the value of a key.

 	toString()

 MessageHeader

  public MessageHeader()

 MessageHeader

  public MessageHeader(InputStream is) throws IOException

 findValue

  public String findValue(String k)

 Find the value that corresponds to this key.  It finds only the first occurrence of the key.

Parameters:

 k - the key to find.

Returns:

 null if not found.

 getKey

  public String getKey(int n)

 getValue

  public String getValue(int n)

 findNextValue

  public String findNextValue(String k,
                              String v)

 Find the next value that corresponds to this key. 	It finds the first value that follows v. To iterate 	over all the values of a key use:

                for(String v=h.findValue(k); v!=null; v=h.findNextValue(k, v)) {
                    ...
                }

 print

  public void print(PrintWriter p)

 Prints the key-value pairs represented by this header. Also prints the RFC required blank line at the end. Omits pairs with a null key.

 add

  public void add(String k,
                  String v)

 Adds a key value pair to the end of the header. Duplicates are allowed

 prepend

  public void prepend(String k,
                      String v)

 Prepends a key value pair to the beginning of the header. Duplicates are allowed

 set

  public void set(int i,
                  String k,
                  String v)

 Overwrite the previous key/val pair at location 'i'  with the new k/v. If the index didn't exist before  the key/val is simply tacked onto the end.

 set

  public void set(String k,
                  String v)

 Sets the value of a key. If the key already exists in the header, it's value will be changed. Otherwise a new key/value pair will be added to the end of the header.

 canonicalID

  public static String canonicalID(String id)

 Convert a message-id string to canonical form (strips off leading and trailing >s)

 parseHeader

  public void parseHeader(InputStream is) throws IOException

 Parse a MIME header from an input stream.

 toString

  public String toString()

Overrides:

toString  in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.beanbox.ObjectInputStreamWithLoader

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class sun.beanbox.ObjectInputStreamWithLoader

java.lang.Object
   |
   +----java.io.InputStream
           |
           +----java.io.ObjectInputStream
                   |
                   +----sun.beanbox.ObjectInputStreamWithLoader

______________________________________________________________________________

 public class ObjectInputStreamWithLoader

 extends ObjectInputStream

This subclass of ObjectInputStream delegates loading of classes to  an existing ClassLoader.

______________________________________________________________________________

 	ObjectInputStreamWithLoader(InputStream, ClassLoader)

 Loader must be non-null;

 	getClassLoader()

  	resolveClass (ObjectStreamClass)

 Use the given ClassLoader rather than using the system class

 ObjectInputStreamWithLoader

  public ObjectInputStreamWithLoader(InputStream in,
                                      ClassLoader loader) throws IOException, StreamCorruptedException

 Loader must be non-null;

 resolveClass

   protected Class resolveClass(ObjectStreamClass classDesc) throws IOException, ClassNotFoundException

 Use the given ClassLoader rather than using the system class

Overrides:

resolveClass  in class ObjectInputStream

 getClassLoader

  public ClassLoader getClassLoader()

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.beanbox.OurLabel

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class sun.beanbox.OurLabel

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Canvas
                   |
                   +----sun.beanbox.OurLabel

______________________________________________________________________________

 public class OurLabel

 extends Canvas

______________________________________________________________________________

 	OurLabel(String)

 	paint(Graphics)

 OurLabel

  public OurLabel(String label)

 paint

  public void paint(Graphics g)

Overrides:

paint  in class Canvas

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.beanbox.PropertyNameDialog

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class sun.beanbox.PropertyNameDialog

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Window
                           |
                           +----java.awt.Dialog
                                   |
                                   +----sun.beanbox.PropertyNameDialog

______________________________________________________________________________

 public class PropertyNameDialog

 extends Dialog

______________________________________________________________________________

 	getResult()

  	handleEvent(Event)

 getResult

  public PropertyDescriptor getResult()

 handleEvent

  public boolean handleEvent(Event evt)

Overrides:

handleEvent  in class Component

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.beanbox.PropertySheet

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class sun.beanbox.PropertySheet

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Window
                           |
                           +----java.awt.Frame
                                   |
                                   +----sun.beanbox.PropertySheet

______________________________________________________________________________

 public class PropertySheet

 extends Frame

______________________________________________________________________________

 	handleEvent(Event)

  	layout()

 layout

  public void layout()

Overrides:

layout  in class Container

 handleEvent

  public boolean handleEvent(Event evt)

Overrides:

handleEvent  in class Component

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.beanbox.Report

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class sun.beanbox.Report

java.lang.Object
   |
   +----sun.beanbox.Report

______________________________________________________________________________

 public class Report

 extends Object

______________________________________________________________________________

 	Report()

 	main(String[])

  	report(Class)

 Report

  public Report()

 main

  public static void main(String argv[])

 report

  public static void report(Class beanClass)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.beanbox.SimpleClassLoader

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class sun.beanbox.SimpleClassLoader

java.lang.Object
   |
   +----java.lang.ClassLoader
           |
           +----sun.beanbox.SimpleClassLoader

______________________________________________________________________________

 public class SimpleClassLoader

 extends ClassLoader

______________________________________________________________________________

 	ourLoader

  	urlPrefix

 	applyDefinitions(Vector)

 May want to add some support for reporting classes replicated across  different JAR files.

 	createLoader(String, String)

 Returns an InputStream on the resource

 	findClass(String)

 Public version of findLoadedClass() to expose it across

 	getLocalResource(String, String)

  	getLocalResourceAsStream (String, String)

  	getResource(String)

  	getResourceAsStream(String)

  	loadClass(String, boolean)

 This is the main method for ClassLoaders, that is being redefined

 	loadFromFile(String)

 Helper function; load a class from a file

 	setDefinition(String, byte[])

 Set some bytecodes as a definition for a class.

 	setLocalResourceSource(String, InputStreamProducer)

 Assign an InputStream as the source for a given property name  This value comes first after the system resources

 urlPrefix

  public final static String urlPrefix

 ourLoader

  public static SimpleClassLoader ourLoader

 setDefinition

  public void setDefinition(String name,
                            byte buf[])

 Set some bytecodes as a definition for a class.  Do not actually define the class until later

 applyDefinitions

  public synchronized void applyDefinitions(Vector classList)

 May want to add some support for reporting classes replicated across  different JAR files.

 loadFromFile

  public Class loadFromFile(String fileName)

 Helper function; load a class from a file

 findClass

  public Class findClass(String name)

 Public version of findLoadedClass() to expose it across

 loadClass

  protected Class loadClass(String name,
                            boolean resolve) throws ClassNotFoundException

 This is the main method for ClassLoaders, that is being redefined

Overrides:

loadClass  in class ClassLoader

 setLocalResourceSource

  public void setLocalResourceSource(String name,
                                     InputStreamProducer  isp)

 Assign an InputStream as the source for a given property name  This value comes first after the system resources

 getResource

  public URL getResource(String name)

Overrides:

getResource  in class ClassLoader

 getResourceAsStream

  public InputStream getResourceAsStream(String name)

Overrides:

getResourceAsStream  in class ClassLoader

 createLoader

  public static SimpleClassLoader createLoader(String cookie,
                                               String dir)

 Returns an InputStream on the resource

 getLocalResource

  public static Object getLocalResource(String cookie,
                                        String name)

 getLocalResourceAsStream

  public static InputStream getLocalResourceAsStream(String cookie,
                                                     String name)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.beanbox.Timer

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class sun.beanbox.Timer

java.lang.Object
   |
   +----sun.beanbox.Timer

______________________________________________________________________________

 public class Timer

 extends Object

______________________________________________________________________________

 	Timer()

  	Timer(boolean)

 	add(Timer)

  	elapsed()

  	reset()

  	stop()

 Timer

  public Timer()

 Timer

  public Timer(boolean running)

 reset

  public void reset()

 stop

  public void stop()

 elapsed

  public String elapsed()

 add

  public void add(Timer tim)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.beanbox.Wrapper

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class sun.beanbox.Wrapper

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Panel
                           |
                           +----sun.beanbox.Wrapper

______________________________________________________________________________

 public class Wrapper

 extends Panel

 implements Serializable

______________________________________________________________________________

 	Wrapper(Object)

 	activate()

  	deactivate()

  	findWrapper(Component)

 Static method to map from an AWT component to the associated Wrapper.

 	getBean()

 get the wrapped bean.

 	getChild()

 get the AWT component used to represent the wrapped bean.

 	handleEvent(Event)

  	layout()

  	paint(Graphics)

  	preferredSize()

  	reshape(int, int, int, int)

  	setActive(boolean)

 Wrapper

  public Wrapper(Object bean)

 getBean

  public Object getBean()

 get the wrapped bean.

 getChild

  public Component getChild()

 get the AWT component used to represent the wrapped bean.

 findWrapper

  public static Wrapper findWrapper(Component comp)

 Static method to map from an AWT component to the associated Wrapper.

 layout

  public void layout()

Overrides:

layout  in class Container

 setActive

  public void setActive(boolean isActive)

 preferredSize

  public Dimension preferredSize()

Overrides:

preferredSize  in class Container

 reshape

  public void reshape(int x,
                      int y,
                      int width,
                      int height)

Overrides:

reshape  in class Component

 paint

  public void paint(Graphics g)

Overrides:

paint  in class Container

 activate

  public synchronized void activate()

 deactivate

  public synchronized void deactivate()

 handleEvent

  public synchronized boolean handleEvent(Event evt)

Overrides:

handleEvent  in class Component

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class Hierarchy

All Packages  Index
______________________________________________________________________________

  Class Hierarchy

•  class java.lang.Object

•  interface java.beans.BeanInfo

•  class java.beans.Beans

•  class java.lang.ClassLoader

•  class sun.beanbox.SimpleClassLoader

•  class java.awt.Component (implements java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable)

•  class java.awt.Canvas

•  class sun.beanbox.OurLabel

•  class java.awt.Container

•  class java.awt.Panel

•  class sun.beanbox.BeanBox  (implements java.io.Serializable, java.lang.Runnable)

•  class sun.beanbox.Wrapper (implements java.io.Serializable)

•  class java.awt.Window

•  class java.awt.Dialog

•  class sun.beanbox.CustomizerDialog

•  class sun.beanbox.ErrorDialog

•  class sun.beanbox.EventTargetDialog (implements java.lang.Runnable)

•  class sun.beanbox.PropertyNameDialog

•  class java.awt.Frame (implements java.awt.MenuContainer)

•  class sun.beanbox.PropertySheet

•  interface java.beans.Customizer

•  interface sun.beanbox.DoOnBean

•  class java.util.EventObject (implements java.io.Serializable)

•  class java.beans.PropertyChangeEvent

•  class java.beans.FeatureDescriptor

•  class java.beans.BeanDescriptor

•  class java.beans.EventSetDescriptor

•  class java.beans.MethodDescriptor

•  class java.beans.ParameterDescriptor

•  class java.beans.PropertyDescriptor

•  class java.beans.IndexedPropertyDescriptor

•  class sun.beanbox.HookupManager

•  class java.io.InputStream

•  class java.io.ObjectInputStream (implements java.io.ObjectInput, java.io.ObjectStreamConstants)

•  class sun.beanbox.ObjectInputStreamWithLoader

•  interface sun.beanbox.InputStreamProducer

•  class java.beans.Introspector

•  class sun.beanbox.JarInfo

•  class sun.beanbox.JarLoader

•  class sun.beanbox.Manifest

•  class sun.beanbox.MessageHeader

•  interface java.beans.PropertyChangeListener (extends java.util.EventListener)

•  class java.beans.PropertyChangeSupport (implements java.io.Serializable)

•  interface java.beans.PropertyEditor

•  class java.beans.PropertyEditorManager

•  class java.beans.PropertyEditorSupport (implements java.beans.PropertyEditor )

•  class sun.beanbox.Report

•  class java.beans.SimpleBeanInfo (implements java.beans.BeanInfo)

•  class java.lang.Throwable (implements java.io.Serializable)

•  class java.lang.Exception

•  class java.beans.IntrospectionException

•  class java.beans.PropertyVetoException

•  class sun.beanbox.Timer

•  interface java.beans.VetoableChangeListener (extends java.util.EventListener)

•  class java.beans.VetoableChangeSupport (implements java.io.Serializable)

•  interface java.beans.Visibility

Generated using an evaluation version of HyperAct HTMheLp


  Index of all Fields and Methods

All Packages  Class Hierarchy
______________________________________________________________________________
A B C D E F G H I J K L M N O P Q R  S T U V W X Y Z
______________________________________________________________________________

  Index of all Fields and Methods

  A

a. Variable in class java.awt.AWTEventMulticaster

 ABORT. Static variable in interface java.awt.image. ImageObserver

 An image which was being tracked asynchronously was aborted before  production was complete.

ABORTED. Static variable in class java.awt.MediaTracker

 Flag indicating the download of some media was aborted.

abortGrabbing(). Method in class java.awt.image.PixelGrabber

 Request the PixelGrabber to abort the image fetch.

abs(). Method in class java.math.BigDecimal

 Returns a BigDecimal whose value is the absolute value of this  number, and whose scale is this.scale().

abs(). Method in class java.math.BigInteger

 Returns a BigInteger whose value is the absolute value of this  number.

abs(double). Static method in class java.lang.Math

 Returns the absolute value of a double value.

abs(float). Static method in class java.lang.Math

 Returns the absolute value of a float value.

abs(int). Static method in class java.lang.Math

 Returns the absolute value of an int value.

abs(long). Static method in class java.lang.Math

 Returns the absolute value of a long value.

ABSTRACT. Static variable in class java.lang.reflect.Modifier

 AbstractMethodError(). Constructor for class java.lang.AbstractMethodError

 Constructs an AbstractMethodError with no detail message.

AbstractMethodError(String). Constructor for class java.lang.AbstractMethodError

 Constructs an AbstractMethodError with the specified  detail message.

accept(). Method in class java.net.ServerSocket

 Listens for a connection to be made to this socket and accepts  it.

accept(File, String). Method in interface java.io.FilenameFilter

 Tests if a specified file should be included in a file list.

accept(SocketImpl). Method in class java.net.SocketImpl

 Accepts a connection.

acceptsURL(String). Method in interface java.sql.Driver

 Returns true if the driver thinks that it can open a connection  to the given URL.

AccessException(String). Constructor for class java.rmi.AccessException

 Create a new AccessException with a description.

AccessException(String, Exception). Constructor for class java.rmi. AccessException

 Create a new AccessException with a description and detail exception.

AclNotFoundException(). Constructor for class java.security.acl. AclNotFoundException

 Constructs an AclNotFoundException.

acos(double). Static method in class java.lang.Math

 Returns the arc cosine of an angle, in the range of 0.0 through  pi.

action(Event, Object). Method in class java.awt.Component

 ACTION_EVENT. Static variable in class java.awt.Event

 An action event.

ACTION_EVENT_MASK. Static variable in class java.awt.AWTEvent

 The event mask for selecting action events.

ACTION_FIRST. Static variable in class java.awt.event.ActionEvent

 Marks the first integer id for the range of action event ids.

ACTION_LAST. Static variable in class java.awt.event.ActionEvent

 Marks the last integer id for the range of action event ids.

ACTION_PERFORMED. Static variable in class java.awt.event.ActionEvent

 An action performed event type.

ActionEvent(Object, int, String). Constructor for class java.awt.event. ActionEvent

 Constructs an ActionEvent object with the specified source object.

ActionEvent(Object, int, String, int). Constructor for class java.awt.event. ActionEvent

 Constructs an ActionEvent object with the specified source object.

actionPerformed(ActionEvent). Method in interface java.awt.event.ActionListener

 Invoked when an action occurs.

actionPerformed(ActionEvent). Method in class java.awt.AWTEventMulticaster

 Handles the actionPerformed event by invoking the  actionPerformed methods on listener-a and listener-b.

ACTIVE_CAPTION. Static variable in class java.awt.SystemColor

 The array index for the active caption background color.

ACTIVE_CAPTION_BORDER. Static variable in class java.awt.SystemColor

 The array index for the active caption border color.

ACTIVE_CAPTION_TEXT. Static variable in class java.awt.SystemColor

 The array index for the action caption text color.

activeCaption. Static variable in class java.awt.SystemColor

 The background color for captions in window borders.

activeCaptionBorder. Static variable in class java.awt.SystemColor

 The border color for captions in window borders.

activeCaptionText. Static variable in class java.awt.SystemColor

 The text color for captions in window borders.

activeCount(). Static method in class java.lang.Thread

 Returns the current number of active threads in this thread group.

activeCount(). Method in class java.lang.ThreadGroup

 Returns an estimate of the number of active threads in this  thread group.

activeGroupCount(). Method in class java.lang.ThreadGroup

 Returns an estimate of the number of active groups in this  thread group.

AD. Static variable in class java.util.GregorianCalendar

 Useful constant for GregorianCalendar.

add(ActionListener, ActionListener). Static method in class java.awt. AWTEventMulticaster

 Adds action-listener-a with action-listener-b and  returns the resulting multicast listener.

add(AdjustmentListener, AdjustmentListener). Static method in class java.awt. AWTEventMulticaster

 Adds adjustment-listener-a with adjustment-listener-b and  returns the resulting multicast listener.

add(BigDecimal). Method in class java.math.BigDecimal

 Returns a BigDecimal whose value is (this + val), and whose scale is  MAX(this.scale(), val.scale).

add(BigInteger). Method in class java.math.BigInteger

 Returns a BigInteger whose value is (this + val).

add(Component). Method in class java.awt.Container

 Adds the specified component to this container.

add(Component, int). Method in class java.awt.Container

 Adds the specified component to this container at the given  position in the container's component list.

add(Component, Object). Method in class java.awt.Container

 Adds the specified component to this container at the specified  index.

add(Component, Object, int). Method in class java.awt.Container

 Adds the specified component to this container with the specified  constraints at the specified index.

add(ComponentListener, ComponentListener). Static method in class java.awt. AWTEventMulticaster

 Adds component-listener-a with component-listener-b and  returns the resulting multicast listener.

add(ContainerListener, ContainerListener). Static method in class java.awt. AWTEventMulticaster

 Adds container-listener-a with container-listener-b and  returns the resulting multicast listener.

add(FocusListener, FocusListener). Static method in class java.awt. AWTEventMulticaster

 Adds focus-listener-a with focus-listener-b and  returns the resulting multicast listener.

add(int, int). Method in class java.util.Calendar

 Date Arithmetic function.

add(int, int). Method in class java.util.GregorianCalendar

 Overrides Calendar  Date Arithmetic function.

add(int, int). Method in class java.awt.Rectangle

 Adds a point to a rectangle.

add(ItemListener, ItemListener). Static method in class java.awt. AWTEventMulticaster

 Adds item-listener-a with item-listener-b and  returns the resulting multicast listener.

add(KeyListener, KeyListener). Static method in class java.awt. AWTEventMulticaster

 Adds key-listener-a with key-listener-b and  returns the resulting multicast listener.

add(Menu). Method in class java.awt.MenuBar

 Adds the specified menu to the menu bar.

add(MenuItem). Method in class java.awt.Menu

 Adds the specified item to this menu.

add(MouseListener, MouseListener). Static method in class java.awt. AWTEventMulticaster

 Adds mouse-listener-a with mouse-listener-b and  returns the resulting multicast listener.

add(MouseMotionListener, MouseMotionListener). Static method in class java.awt. AWTEventMulticaster

 Adds mouse-motion-listener-a with mouse-motion-listener-b and  returns the resulting multicast listener.

add(Point). Method in class java.awt.Rectangle

 Adds a point to a rectangle.

add(PopupMenu). Method in class java.awt.Component

 Adds the specified popup menu to the component.

add(Rectangle). Method in class java.awt.Rectangle

 Adds a rectangle to a rectangle.

add(String). Method in class java.awt.Choice

 Adds an item to this Choice.

add(String). Method in class java.awt.List

 Adds the specified item to the end of scrolling list.

add(String). Method in class java.awt.Menu

 Adds an item with with the specified label to this menu.

add(String, Component). Method in class java.awt.Container

 Adds the specified component to this container.

add(String, int). Method in interface java.awt.peer.ChoicePeer

 add(String, int). Method in class java.awt.List

 Adds the specified item to the scrolling list at the specified  position.

add(String, int). Method in interface java.awt.peer.ListPeer

 add(TextListener, TextListener). Static method in class java.awt.AWTEventMulticaster

 add(WindowListener, WindowListener). Static method in class java.awt.AWTEventMulticaster

 Adds window-listener-a with window-listener-b and  returns the resulting multicast listener.

addActionListener(ActionListener). Method in class java.awt.Button

 Adds the specified action listener to receive action events  from this button.

addActionListener(ActionListener). Method in class java.awt.List

 Adds the specified action listener to receive action events  from this list.

addActionListener(ActionListener). Method in class java.awt.MenuItem

 Adds the specified action listener to receive action events  from this menu item.

addActionListener(ActionListener). Method in class java.awt.TextField

 Adds the specified action listener to recieve  action events from this textfield.

addAdjustmentListener(AdjustmentListener). Method in interface java.awt. Adjustable

 Add a listener to recieve adjustment events when the value of  the adjustable object changes.

addAdjustmentListener(AdjustmentListener). Method in class java.awt.Scrollbar

 Adds the specified adjustment listener to recieve adjustment events  from this scrollbar.

addCertificate(Certificate). Method in class java.security.Identity

 Adds a certificate for this identity.

addComponentListener(ComponentListener). Method in class java.awt.Component

 Adds the specified component listener to receive component events  from this component.

addConsumer(ImageConsumer). Method in class java.awt.image.FilteredImageSource

 Adds an ImageConsumer to the list of consumers interested in  data for this image.

addConsumer(ImageConsumer). Method in interface java.awt.image.ImageProducer

 This method is used to register an ImageConsumer with the  ImageProducer for access to the image data during a later  reconstruction of the Image.

addConsumer(ImageConsumer). Method in class java.awt.image.MemoryImageSource

 Adds an ImageConsumer to the list of consumers interested in  data for this image.

addContainerListener(ContainerListener). Method in class java.awt.Container

 Adds the specified container listener to receive container events  from this container.

addElement(Object). Method in class java.util.Vector

 Adds the specified component to the end of this vector,  increasing its size by one.

addEntry(Principal, AclEntry). Method in interface java.security.acl.Acl

 Adds an ACL entry to this ACL.

addFocusListener(FocusListener). Method in class java.awt.Component

 Adds the specified focus listener to receive focus events  from this component.

addHelpMenu(Menu). Method in interface java.awt.peer.MenuBarPeer

 addIdentity(Identity). Method in class java.security. IdentityScope

 Adds an identity to this identity scope.

addImage(Image, int). Method in class java.awt.MediaTracker

 Adds an image to the list of images being tracked.

addImage(Image, int, int, int). Method in class java.awt.MediaTracker

 Adds a scaled image to the list of images being tracked.

addImpl(Component, Object, int). Method in class java.awt.Container

 Adds the specified component to this container at the specified  index.

addImpl(Component, Object, int). Method in class java.awt.ScrollPane

 Adds the specified component to this scroll pane container.

addInternal(EventListener, EventListener). Static method in class java.awt. AWTEventMulticaster

 Returns the resulting multicast listener from adding listener-a  and listener-b together.

addItem(MenuItem). Method in interface java.awt.peer.MenuPeer

 addItem(String). Method in class java.awt.Choice

 Adds an item to this Choice.

addItem(String). Method in class java.awt.List

 Adds the specified item to the end of scrolling list.

addItem(String, int). Method in interface java.awt.peer.ChoicePeer

 addItem(String, int). Method in class java.awt.List

 Adds the specified item to the scrolling list at the specified  position.

addItem(String, int). Method in interface java.awt.peer.ListPeer

 DEPRECATED: Replaced by add(String, int).

addItemListener(ItemListener). Method in class java.awt.Checkbox

 Adds the specified item listener to recieve item events from  this checkbox.

addItemListener(ItemListener). Method in class java.awt.CheckboxMenuItem

 Adds the specified item listener to recieve item events from  this checkbox menu item.

addItemListener(ItemListener). Method in class java.awt.Choice

 Adds the specified item listener to recieve item events from  this choice.

addItemListener(ItemListener). Method in interface java.awt.ItemSelectable

 Add a listener to recieve item events when the state of  an item changes.

addItemListener(ItemListener). Method in class java.awt.List

 Adds the specified item listener to recieve item events from  this list.

addKeyListener(KeyListener). Method in class java.awt.Component

 Adds the specified key listener to receive key events  from this component.

addLayoutComponent(Component, Object). Method in class java.awt.BorderLayout

 Adds the specified component to the layout, using the specified  constraint object.

addLayoutComponent(Component, Object). Method in class java.awt.CardLayout

 Adds the specified component to the layout, using the specified  constraint object.

addLayoutComponent(Component, Object). Method in class java.awt.GridBagLayout

 Adds the specified component to the layout, using the specified  constraint object.

addLayoutComponent(Component, Object). Method in interface java.awt. LayoutManager2

 Adds the specified component to the layout, using the specified  constraint object.

addLayoutComponent(String, Component). Method in class java.awt.BorderLayout

 Replaced by addLayoutComponent(Component, Object).

addLayoutComponent(String, Component). Method in class java.awt.CardLayout

 Replaced by addLayoutComponent(Component, Object).

addLayoutComponent(String, Component). Method in class java.awt.FlowLayout

 Adds the specified component to the layout.

addLayoutComponent(String, Component). Method in class java.awt.GridBagLayout

 Adds the specified component with the specified name to the layout.

addLayoutComponent(String, Component). Method in class java.awt.GridLayout

 Adds the specified component with the specified name to the layout.

addLayoutComponent(String, Component). Method in interface java.awt. LayoutManager

 Adds the specified component with the specified name to  the layout.

addMember(Principal). Method in interface java.security.acl.Group

 Adds the specified member to the group.

addMenu(Menu). Method in interface java.awt.peer.MenuBarPeer

 addMouseListener(MouseListener). Method in class java.awt.Component

 Adds the specified mouse listener to receive mouse events  from this component.

addMouseMotionListener(MouseMotionListener). Method in class java.awt.Component

 Adds the specified mouse motion listener to receive mouse motion events  from this component.

addNotify(). Method in class java.awt.Button

 Creates the peer of the button.

addNotify(). Method in class java.awt.Canvas

 Creates the peer of the canvas.

addNotify(). Method in class java.awt.Checkbox

 Creates the peer of the Checkbox.

addNotify(). Method in class java.awt.CheckboxMenuItem

 Creates the peer of the checkbox item.

addNotify(). Method in class java.awt.Choice

 Creates the Choice's peer.

addNotify(). Method in class java.awt.Component

 Notifies the Component that it has been added to a container  and if a peer is required, it should be created.

addNotify(). Method in class java.awt.Container

 Notifies the container to create a peer.

addNotify(). Method in class java.awt.Dialog

 Creates the frame's peer.

addNotify(). Method in class java.awt.FileDialog

 Creates the file dialog's peer.

addNotify(). Method in class java.awt.Frame

 Creates the Frame's peer.

addNotify(). Method in class java.awt.Label

 Creates the peer for this label.

addNotify(). Method in class java.awt.List

 Creates the peer for the list.

addNotify(). Method in class java.awt.Menu

 Creates the menu's peer.

addNotify(). Method in class java.awt.MenuBar

 Creates the menu bar's peer.

addNotify(). Method in class java.awt.MenuItem

 Creates the menu item's peer.

addNotify(). Method in class java.awt.Panel

 Creates the Panel's peer.

addNotify(). Method in class java.awt.PopupMenu

 Creates the popup menu's peer.

addNotify(). Method in class java.awt.Scrollbar

 Creates the Scrollbar's peer.

addNotify(). Method in class java.awt.ScrollPane

 Creates the scroll pane's peer.

addNotify(). Method in class java.awt.TextArea

 Creates the TextArea's peer.

addNotify(). Method in class java.awt.TextField

 Creates the TextField's peer.

addNotify(). Method in class java.awt.Window

 Creates the Window's peer.

addObserver(Observer). Method in class java.util.Observable

 Adds an observer to the set of observers for this object.

addOwner(Principal, Principal). Method in interface java.security.acl.Owner

 Adds an owner.

addPermission(Permission). Method in interface java.security.acl.AclEntry

 Adds the specified permission to this ACL entry.

addPoint(int, int). Method in class java.awt.Polygon

 Appends a point to a polygon.

addPropertyChangeListener(PropertyChangeListener). Method in interface java.beans.Customizer

 Register a listener for the PropertyChange event.

addPropertyChangeListener(PropertyChangeListener). Method in class java.beans. PropertyChangeSupport

 Add a PropertyChangeListener to the listener list.

addPropertyChangeListener(PropertyChangeListener). Method in interface java.beans.PropertyEditor

 Register a listener for the PropertyChange event.

addPropertyChangeListener(PropertyChangeListener). Method in class java.beans. PropertyEditorSupport

 Register a listener for the PropertyChange event.

addProvider(Provider). Static method in class java.security.Security

 Adds a provider to the next position available.

address. Variable in class java.net.SocketImpl

 The IP address of the remote end of this socket.

addSeparator(). Method in class java.awt.Menu

 Adds a separator line, or a hypen, to the menu at the current position.

addSeparator(). Method in interface java.awt.peer.MenuPeer

 addSystemThread(). Method in class sun.tools.debug. RemoteDebugger

 Add the calling thread to the list of threads which aren't  suspended by the RemoteDebugger.

addSystemThread(Thread). Method in class sun.tools.debug.RemoteDebugger

 Add the specified thread to the list of threads which aren't  suspended by the RemoteDebugger.

addTextListener(TextListener). Method in class java.awt.TextComponent

 Adds the specified text event listener to recieve text events  from this textcomponent.

addVetoableChangeListener(VetoableChangeListener). Method in class java.beans. VetoableChangeSupport

 Add a VetoableListener to the listener list.

addWindowListener(WindowListener). Method in class java.awt.Window

 Adds the specified window listener to receive window events from  this window.

AdjustForGravity(GridBagConstraints, Rectangle). Method in class java.awt. GridBagLayout

 ADJUSTMENT_EVENT_MASK. Static variable in class java.awt.AWTEvent

 The event mask for selecting adjustment events.

ADJUSTMENT_FIRST. Static variable in class java.awt.event.AdjustmentEvent

 Marks the first integer id for the range of adjustment event ids.

ADJUSTMENT_LAST. Static variable in class java.awt.event.AdjustmentEvent

 Marks the last integer id for the range of adjustment event ids.

ADJUSTMENT_VALUE_CHANGED. Static variable in class java.awt.event. AdjustmentEvent

 The adjustment value changed event.

AdjustmentEvent(Adjustable, int, int, int). Constructor for class java.awt.event.AdjustmentEvent

 Constructs a AdjustmentEvent object with the specified Adjustable source,  type, and value.

adjustmentValueChanged(AdjustmentEvent). Method in interface java.awt.event. AdjustmentListener

 Invoked when the value of the adjustable has changed.

adjustmentValueChanged(AdjustmentEvent). Method in class java.awt. AWTEventMulticaster

 Handles the adjustmentValueChanged event by invoking the  adjustmentValueChanged methods on listener-a and listener-b.

Adler32(). Constructor for class java.util.zip.Adler32

 after(Date). Method in class java.util.Date

 Tests if this date is after the specified date.

after(Object). Method in class java.util.Calendar

 Compares the time field records.

after(Object). Method in class java.util.GregorianCalendar

 Overrides Calendar  Compares the time field records.

after(Timestamp). Method in class java.sql.Timestamp

 Is this timestamp later than the timestamp argument?

ALLBITS. Static variable in interface java.awt.image.ImageObserver

 A static image which was previously drawn is now complete and can  be drawn again in its final form.

allowsMultipleSelections(). Method in class java.awt.List

 allowThreadSuspension(boolean). Method in class java.lang.ThreadGroup

 Used by VM to control lowmem implicit suspension.

allowUserInteraction. Variable in class java.net.URLConnection

 If true, this URL is being examined in  a context in which it makes sense to allow user interactions such  as popping up an authentication dialog.

allProceduresAreCallable(). Method in interface java.sql.DatabaseMetaData

 Can all the procedures returned by getProcedures be called by the  current user?

allTablesAreSelectable(). Method in interface java.sql.DatabaseMetaData

 Can all the tables returned by getTable be SELECTed by the  current user?

AlreadyBoundException(). Constructor for class java.rmi.AlreadyBoundException

 AlreadyBoundException(String). Constructor for class java.rmi.AlreadyBoundException

 ALT_MASK. Static variable in class java.awt.event. ActionEvent

 The alt modifier constant.

ALT_MASK. Static variable in class java.awt.Event

 The alt modifier constant.

ALT_MASK. Static variable in class java.awt.event.InputEvent

 The alt key modifier constant.

AM. Static variable in class java.util.Calendar

 Useful constant for hour in 12-hour clock.

AM_PM. Static variable in class java.util.Calendar

 Useful constant for date and time.

AM_PM_FIELD. Static variable in class java.text.DateFormat

 Useful constant for AM_PM field alignment.

anchor. Variable in class java.awt.GridBagConstraints

 and(BigInteger). Method in class java.math.BigInteger

 Returns a BigInteger whose value is (this & val).

and(BitSet). Method in class java.util.BitSet

 Performs a logical AND of this target bit set with the  argument bit set.

andNot(BigInteger). Method in class java.math.BigInteger

 Returns a BigInteger whose value is (this & ~val).

annotateClass(Class). Method in class java.io.ObjectOutputStream

 Subclasses may implement this method to allow class data to be stored  in the stream.

append(boolean). Method in class java.lang.StringBuffer

 Appends the string representation of the boolean  argument to the string buffer.

append(char). Method in class java.lang.StringBuffer

 Appends the string representation of the char  argument to this string buffer.

append(char[]). Method in class java.lang.StringBuffer

 Appends the string representation of the char array  argument to this string buffer.

append(char[], int, int). Method in class java.lang.StringBuffer

 Appends the string representation of a subarray of the  char  array argument to this string buffer.

append(double). Method in class java.lang.StringBuffer

 Appends the string representation of the double  argument to this string buffer.

append(float). Method in class java.lang.StringBuffer

 Appends the string representation of the float  argument to this string buffer.

append(int). Method in class java.lang.StringBuffer

 Appends the string representation of the int  argument to this string buffer.

append(long). Method in class java.lang.StringBuffer

 Appends the string representation of the long  argument to this string buffer.

append(Object). Method in class java.lang.StringBuffer

 Appends the string representation of the Object  argument to this string buffer.

append(String). Method in class java.lang.StringBuffer

 Appends the string to this string buffer.

append(String). Method in class java.awt.TextArea

 Appends the given text to the end.

appendText(String). Method in class java.awt.TextArea

 Applet(). Constructor for class java.applet.Applet

 appletResize(int, int). Method in interface java.applet.AppletStub

 Called when the applet wants to be resized.

applyLocalizedPattern(String). Method in class java.text.DecimalFormat

 Apply the given pattern to this Format object.

applyLocalizedPattern(String). Method in class java.text.SimpleDateFormat

 Apply the given localized pattern string to this date format.

applyPattern(String). Method in class java.text.ChoiceFormat

 Sets the pattern.

applyPattern(String). Method in class java.text.DecimalFormat

 Apply the given pattern to this Format object.

applyPattern(String). Method in class java.text.MessageFormat

 Sets the pattern.

applyPattern(String). Method in class java.text.SimpleDateFormat

 Apply the given unlocalized pattern string to this date format.

APRIL. Static variable in class java.util.Calendar

 Useful constant for month.

AreaAveragingScaleFilter(int, int). Constructor for class java.awt.image. AreaAveragingScaleFilter

 Constructs an AreaAveragingScaleFilter that scales the pixels from  its source Image as specified by the width and height parameters.

areFieldsSet. Variable in class java.util.Calendar

 The flag which tells if the time fields are set for the calendar.

arg. Variable in class java.awt.Event

 An arbitrary argument.

ArithmeticException(). Constructor for class java.lang.ArithmeticException

 Constructs an ArithmeticException with no detail  message.

ArithmeticException(String). Constructor for class java.lang. ArithmeticException

 Constructs an ArithmeticException with the specified  detail message.

ArrangeGrid(Container). Method in class java.awt.GridBagLayout

 arraycopy(Object, int, Object, int, int). Static method in class java.lang.System

 Copies an array from the specified source array, beginning at the  specified position, to the specified position of the destination array.

ArrayIndexOutOfBoundsException(). Constructor for class java.lang. ArrayIndexOutOfBoundsException

 Constructs an ArrayIndexOutOfBoundsException with no  detail message.

ArrayIndexOutOfBoundsException(int). Constructor for class java.lang. ArrayIndexOutOfBoundsException

 Constructs a new ArrayIndexOutOfBoundsException  class with an argument indicating the illegal index.

ArrayIndexOutOfBoundsException(String). Constructor for class java.lang. ArrayIndexOutOfBoundsException

 Constructs an ArrayIndexOutOfBoundsException class  with the specified detail message.

ArrayStoreException(). Constructor for class java.lang.ArrayStoreException

 Constructs an ArrayStoreException with no detail message.

ArrayStoreException(String). Constructor for class java.lang. ArrayStoreException

 Constructs an ArrayStoreException with the specified  detail message.

arrayTypeName(int). Method in class sun.tools.debug.RemoteArray

 Return the element type as a string.

asin(double). Static method in class java.lang.Math

 Returns the arc sine of an angle, in the range of -pi/2 through  pi/2.

atan(double). Static method in class java.lang.Math

 Returns the arc tangent of an angle, in the range of -pi/2  through pi/2.

atan2(double, double). Static method in class java.lang.Math

 Converts rectangular coordinates (b, a)  to polar (r, theta).

attributeNames(). Method in class java.beans.FeatureDescriptor

 AUGUST. Static variable in class java.util.Calendar

 Useful constant for month.

available(). Method in class java.io.BufferedInputStream

 Returns the number of bytes that can be read from this input  stream without blocking.

available(). Method in class java.io.ByteArrayInputStream

 Returns the number of bytes that can be read from this input  stream without blocking.

available(). Method in class java.io.FileInputStream

 Returns the number of bytes that can be read from this file input  stream without blocking.

available(). Method in class java.io.FilterInputStream

 Returns the number of bytes that can be read from this input  stream without blocking.

available(). Method in class java.io.InputStream

 Returns the number of bytes that can be read from this input  stream without blocking.

available(). Method in class java.io.LineNumberInputStream

 Returns the number of bytes that can be read from this input  stream without blocking.

available(). Method in interface java.io.ObjectInput

 Returns the number of bytes that can be read  without blocking.

available(). Method in class java.io.ObjectInputStream

 Returns the number of bytes that can be read without blocking.

available(). Method in class java.io.PipedInputStream

 Returns the number of bytes that can be read from this input  stream without blocking.

available(). Method in class java.io.PushbackInputStream

 Returns the number of bytes that can be read from this input  stream without blocking.

available(). Method in class java.io.SequenceInputStream

 Returns the number of bytes available on the current stream.

available(). Method in class java.net.SocketImpl

 Returns the number of bytes that can be read from this socket  without blocking.

available(). Method in class java.io.StringBufferInputStream

 Returns the number of bytes that can be read from the input  stream without blocking.

avoidingGui(). Method in interface java.beans.Visibility

 AWTError(String). Constructor for class java.awt. AWTError

 AWTEvent(Event). Constructor for class java.awt. AWTEvent

 Constructs an AWTEvent object from the parameters of a 1.0-style event.

AWTEvent(Object, int). Constructor for class java.awt.AWTEvent

 Constructs an AWTEvent object with the specified source object and type.

AWTEventMulticaster(EventListener, EventListener). Constructor for class java.awt.AWTEventMulticaster

 Creates an event multicaster instance which chains listener-a  with listener-b.

AWTException(String). Constructor for class java.awt.AWTException

 Constructs an AWTException with the specified detail message.

______________________________________________________________________________

  B

b. Variable in class java.awt.AWTEventMulticaster

 BACK_SPACE. Static variable in class java.awt.Event

 The BackSpace key.

BC. Static variable in class java.util.GregorianCalendar

 Useful constant for GregorianCalendar.

BeanDescriptor(Class). Constructor for class java.beans.BeanDescriptor

 Create a BeanDescriptor for a bean that doesn't have a customizer.

BeanDescriptor(Class, Class). Constructor for class java.beans.BeanDescriptor

 Create a BeanDescriptor for a bean that has a customizer.

Beans(). Constructor for class java.beans.Beans

 beep(). Method in class java.awt.Toolkit

 Emits an audio beep.

before(Date). Method in class java.util.Date

 Tests if this date is before the specified date.

before(Object). Method in class java.util.Calendar

 Compares the time field records.

before(Object). Method in class java.util.GregorianCalendar

 Overrides Calendar  Compares the time field records.

before(Timestamp). Method in class java.sql.Timestamp

 Is this timestamp earlier than the timestamp argument?

beginValidate(). Method in interface java.awt.peer.ContainerPeer

 BEST_COMPRESSION. Static variable in class java.util.zip.Deflater

 Compression level for best compression.

BEST_SPEED. Static variable in class java.util.zip.Deflater

 Compression level for fastest compression.

bestRowNotPseudo. Static variable in interface java.sql.DatabaseMetaData

 BEST ROW PSEUDO_COLUMN - is NOT a pseudo column.

bestRowPseudo. Static variable in interface java.sql.DatabaseMetaData

 BEST ROW PSEUDO_COLUMN - is a pseudo column.

bestRowSession. Static variable in interface java.sql.DatabaseMetaData

 BEST ROW SCOPE - valid for remainder of current session.

bestRowTemporary. Static variable in interface java.sql.DatabaseMetaData

 BEST ROW SCOPE - very temporary, while using row.

bestRowTransaction. Static variable in interface java.sql.DatabaseMetaData

 BEST ROW SCOPE - valid for remainder of current transaction.

bestRowUnknown. Static variable in interface java.sql.DatabaseMetaData

 BEST ROW PSEUDO_COLUMN - may or may not be pseudo column.

BigDecimal(BigInteger). Constructor for class java.math.BigDecimal

 Translates a BigInteger into a BigDecimal.

BigDecimal(BigInteger, int). Constructor for class java.math.BigDecimal

 Translates a BigInteger and a scale into a BigDecimal.

BigDecimal(double). Constructor for class java.math.BigDecimal

 Translates a double into a BigDecimal.

BigDecimal(String). Constructor for class java.math.BigDecimal

 Constructs a BigDecimal from a string containing an optional minus  sign followed by a sequence of zero or more decimal digits, optionally  followed by a fraction, which consists of a decimal point followed by  zero or more decimal digits.

BIGINT. Static variable in class java.sql.Types

 BigInteger(byte[]). Constructor for class java.math. BigInteger

 Translates a byte array containing the two's-complement representation  of a (signed) integer into a BigInteger.

BigInteger(int, byte[]). Constructor for class java.math.BigInteger

 Translates the sign-magnitude representation of an integer into a  BigInteger.

BigInteger(int, int, Random). Constructor for class java.math.BigInteger

 Returns a randomly selected BigInteger with the specified bitLength  that is probably prime.

BigInteger(int, Random). Constructor for class java.math.BigInteger

 Returns a random number uniformly distributed on [0, 2**numBits - 1]  (assuming a fair source of random bits is provided in rndSrc).

BigInteger(String). Constructor for class java.math.BigInteger

 Translates a string containing an optional minus sign followed by a  sequence of one or more decimal digits into a BigInteger.

BigInteger(String, int). Constructor for class java.math.BigInteger

 Translates a string containing an optional minus sign followed by a  sequence of one or more digits in the specified radix into a BigInteger.

BINARY. Static variable in class java.sql.Types

 bind(InetAddress, int). Method in class java.net. SocketImpl

 Binds this socket to the specified port number on the specified host.

bind(int, InetAddress). Method in class java.net.DatagramSocketImpl

 Binds a datagram socket to a local port and address.

bind(String, Remote). Static method in class java.rmi.Naming

 Binds the name to the specified remote object.

bind(String, Remote). Method in interface java.rmi.registry.Registry

 Binds the name to the specified remote object.

BindException(). Constructor for class java.net.BindException

 Construct a new BindException with no detailed message.

BindException(String). Constructor for class java.net.BindException

 Constructs a new BindException with the specified detail  message as to why the bind error occurred.

BIT. Static variable in class java.sql.Types

 bitCount(). Method in class java.math.BigInteger

 Returns the number of bits in the two's complement representation  of this number that differ from its sign bit.

bitLength(). Method in class java.math.BigInteger

 Returns the number of bits in the minimal two's-complement  representation of this number, *excluding* a sign bit, i.e.,  (ceil(log2(this  BitSet (). Constructor for class java.util.BitSet

 Creates a new bit set.

BitSet(int). Constructor for class java.util.BitSet

 Creates a bit set whose initial size is the specified number of  bits.

black. Static variable in class java.awt.Color

 The color black.

BLOCK_DECREMENT. Static variable in class java.awt.event.AdjustmentEvent

 The block decrement adjustment type.

BLOCK_INCREMENT. Static variable in class java.awt.event.AdjustmentEvent

 The block increment adjustment type.

blue. Static variable in class java.awt.Color

 The color blue.

BOLD. Static variable in class java.awt.Font

 The bold style constant.

Boolean(boolean). Constructor for class java.lang.Boolean

 Allocates a Boolean object representing the  value argument.

Boolean(String). Constructor for class java.lang.Boolean

 Allocates a Boolean object representing the value  true  if the string argument is not null  and is equal, ignoring case, to the string "true".

booleanValue(). Method in class java.lang.Boolean

 Returns the value of this Boolean object as a boolean.

BorderLayout(). Constructor for class java.awt.BorderLayout

 Constructs a new BorderLayout with no gaps between components.

BorderLayout(int, int). Constructor for class java.awt.BorderLayout

 Constructs a BorderLayout with the specified gaps.

BOTH. Static variable in class java.awt.GridBagConstraints

 bottom. Variable in class java.awt.Insets

 The inset from the bottom.

BOTTOM_ALIGNMENT. Static variable in class java.awt.Component

 Ease of use constant for getAlignmentY().

bounds. Variable in class java.awt.Polygon

 bounds(). Method in class java.awt.Component

 BreakIterator(). Constructor for class java.text. BreakIterator

 Constructor.

breakpointEvent(RemoteThread). Method in interface sun.tools.debug. DebuggerCallback

 A breakpoint has been hit in the specified thread.

BRIEF. Static variable in class java.rmi.server.LogStream

 brighter(). Method in class java.awt.Color

 Returns a brighter version of this color.

buf. Variable in class java.io.BufferedInputStream

 The buffer where data is stored.

buf. Variable in class java.io.BufferedOutputStream

 The buffer where data is stored.

buf. Variable in class java.io.ByteArrayInputStream

 The byte array containing the data.

buf. Variable in class java.io.ByteArrayOutputStream

 The buffer where data is stored.

buf. Variable in class java.io.CharArrayReader

 Character buffer

buf. Variable in class java.io.CharArrayWriter

 The buffer where data is stored.

buf. Variable in class java.util.zip.DeflaterOutputStream

 Output buffer for writing compressed data.

buf. Variable in class java.util.zip.InflaterInputStream

 Input buffer for decompression.

buf. Variable in class java.io.PushbackInputStream

 The push back buffer.

buffer. Variable in class java.io.PipedInputStream

 The circular buffer into which incoming data is placed.

buffer. Variable in class java.io.StringBufferInputStream

 The string from which bytes are read.

BufferedInputStream(InputStream). Constructor for class java.io. BufferedInputStream

 Creates a new buffered input stream to read data from the  specified input stream with a default 512-byte buffer size.

BufferedInputStream(InputStream, int). Constructor for class java.io. BufferedInputStream

 Creates a new buffered input stream to read data from the  specified input stream with the specified buffer size.

BufferedOutputStream(OutputStream). Constructor for class java.io. BufferedOutputStream

 Creates a new buffered output stream to write data to the  specified underlying output stream with a default 512-byte buffer size.

BufferedOutputStream(OutputStream, int). Constructor for class java.io. BufferedOutputStream

 Creates a new buffered output stream to write data to the  specified underlying output stream with the specified buffer size.

BufferedReader(Reader). Constructor for class java.io.BufferedReader

 Create a buffering character-input stream that uses a default-sized  input buffer.

BufferedReader(Reader, int). Constructor for class java.io.BufferedReader

 Create a buffering character-input stream that uses an input buffer of  the specified size.

BufferedWriter(Writer). Constructor for class java.io.BufferedWriter

 Create a buffered character-output stream that uses a default-sized  output buffer.

BufferedWriter(Writer, int). Constructor for class java.io.BufferedWriter

 Create a new buffered character-output stream that uses an output  buffer of the given size.

Button(). Constructor for class java.awt.Button

 Constructs a Button with no label.

Button(String). Constructor for class java.awt.Button

 Constructs a Button with the specified label.

BUTTON1_MASK. Static variable in class java.awt.event.InputEvent

 The mouse button1 modifier constant.

BUTTON2_MASK. Static variable in class java.awt.event.InputEvent

 The mouse button2 modifier constant.

BUTTON3_MASK. Static variable in class java.awt.event.InputEvent

 The mouse button3 modifier constant.

Byte(byte). Constructor for class java.lang.Byte

 Constructs a Byte object initialized to the specified byte value.

Byte(String). Constructor for class java.lang.Byte

 Constructs a Byte object initialized to the value specified by the  String parameter.

ByteArrayInputStream(byte[]). Constructor for class java.io. ByteArrayInputStream

 Creates a new byte array input stream that reads data from the  specified byte array.

ByteArrayInputStream(byte[], int, int). Constructor for class java.io. ByteArrayInputStream

 Creates a new byte array input stream that reads data from the  specified byte array.

ByteArrayOutputStream(). Constructor for class java.io.ByteArrayOutputStream

 Creates a new byte array output stream.

ByteArrayOutputStream(int). Constructor for class java.io.ByteArrayOutputStream

 Creates a new byte array output stream, with a buffer capacity of  the specified size, in bytes.

bytesTransferred. Variable in class java.io.InterruptedIOException

 Reports how many bytes had been transferred as part of the I/O  operation before it was interrupted.

bytesWidth(byte[], int, int). Method in class java.awt.FontMetrics

 Returns the total advance width for showing the specified array  of bytes in this Font.

byteValue(). Method in class java.lang.Byte

 Returns the value of this Byte as a byte.

byteValue(). Method in class java.lang.Double

 Returns the value of this Double as a byte (by casting to a byte).

byteValue(). Method in class java.lang.Float

 Returns the value of this Float as a byte (by casting to a byte).

byteValue(). Method in class java.lang.Integer

 Returns the value of this Integer as a byte.

byteValue(). Method in class java.lang.Long

 Returns the value of this Long as a byte.

byteValue(). Method in class java.lang.Number

 Returns the value of the specified number as a byte.

byteValue(). Method in class java.lang.Short

 Returns the value of this Short as a byte.

______________________________________________________________________________

  C

calendar. Variable in class java.text.DateFormat

 The calendar that DateFormat uses to produce the time field values  needed to implement date/time formatting.

Calendar(). Constructor for class java.util.Calendar

 Constructs a Calendar with the default time zone as returned  by TimeZone.getDefault(), and the default locale.

Calendar(TimeZone, Locale). Constructor for class java.util.Calendar

 Constructs a Calendar with the given time zone and locale.

CANADA. Static variable in class java.util.Locale

 Useful constant for country.

CANADA_FRENCH. Static variable in class java.util.Locale

 Useful constant for country.

cancel(). Method in interface java.sql.Statement

 Cancel can be used by one thread to cancel a statement that  is being executed by another thread.

canFilterIndexColorModel. Variable in class java.awt.image.RGBImageFilter

 This boolean indicates whether or not it is acceptable to apply  the color filtering of the filterRGB method to the color table  entries of an IndexColorModel object in lieu of pixel by pixel  filtering.

CANONICAL_DECOMPOSITION. Static variable in class java.text.Collator

 Decomposition mode value.

canRead(). Method in class java.io.File

 Tests if the application can read from the specified file.

Canvas(). Constructor for class java.awt.Canvas

 Constructs a new Canvas.

canWrite(). Method in class java.io.File

 Tests if the application can write to this file.

capacity(). Method in class java.lang.StringBuffer

 Returns the current capacity of the String buffer.

capacity(). Method in class java.util.Vector

 Returns the current capacity of this vector.

capacityIncrement. Variable in class java.util.Vector

 The amount by which the capacity of the vector is automatically  incremented when its size becomes greater than its capacity.

CAPS_LOCK. Static variable in class java.awt.Event

 The CapsLock action-key.

CardLayout(). Constructor for class java.awt.CardLayout

 Creates a new card layout with gaps of size zero.

CardLayout(int, int). Constructor for class java.awt.CardLayout

 Creates a card layout with the specified gaps.

catchExceptions(). Method in class sun.tools.debug.RemoteClass

 Enter the debugger when an instance of this class is thrown.

ceil(double). Static method in class java.lang.Math

 Returns the smallest (closest to negative infinity)  double  value that is not less than the argument and is  equal to a mathematical integer.

CENTER. Static variable in class java.awt.BorderLayout

 The center layout constraint.

CENTER. Static variable in class java.awt.FlowLayout

 The right alignment variable.

CENTER. Static variable in class java.awt.GridBagConstraints

 CENTER. Static variable in class java.awt.Label

 The center alignment.

CENTER_ALIGNMENT. Static variable in class java.awt.Component

 Ease of use constant for getAlignmentY() and getAlignmentX().

certificates(). Method in class java.security.Identity

 Returns a copy of all the certificates for this identity.

CHAR. Static variable in class java.sql.Types

 CHAR_UNDEFINED. Static variable in class java.awt.event.KeyEvent

 KEY_PRESSED and KEY_RELEASED events which do not map to a  valid Unicode character do not have a defined keyChar.

Character(char). Constructor for class java.lang.Character

 Constructs a Character object and initializes it so  that it represents the primitive value argument.

CharArrayReader(char[]). Constructor for class java.io.CharArrayReader

 Create an CharArrayReader from the specified array of chars.

CharArrayReader(char[], int, int). Constructor for class java.io. CharArrayReader

 Create an CharArrayReader from the specified array of chars.

CharArrayWriter(). Constructor for class java.io.CharArrayWriter

 Creates a new CharArrayWriter.

CharArrayWriter(int). Constructor for class java.io.CharArrayWriter

 Creates a new CharArrayWriter with the specified initial size.

charAt(int). Method in class java.lang.String

 Returns the character at the specified index.

charAt(int). Method in class java.lang.StringBuffer

 Returns the character at a specific index in this string buffer.

CharConversionException(). Constructor for class java.io. CharConversionException

 provides no detailed message

CharConversionException(String). Constructor for class java.io. CharConversionException

 provides a detailed message

charsWidth(char[], int, int). Method in class java.awt.FontMetrics

 Returns the total advance width for showing the specified array  of characters in this Font.

charValue(). Method in class java.lang.Character

 Returns the value of this Character object.

charWidth(char). Method in class java.awt.FontMetrics

 Returns the advance width of the specified character in this Font.

charWidth(int). Method in class java.awt.FontMetrics

 Returns the advance width of the specified character in this Font.

checkAccept(String, int). Method in class java.rmi.RMISecurityManager

 For now stubs can't accept connections on any port.

checkAccept(String, int). Method in class java.lang.SecurityManager

 Throws a SecurityException if the  calling thread is not permitted to accept a socket connection from  the specified host and port number.

checkAccess(). Method in class java.lang.Thread

 Determines if the currently running thread has permission to  modify this thread.

checkAccess(). Method in class java.lang.ThreadGroup

 Determines if the currently running thread has permission to  modify this thread group.

checkAccess(Thread). Method in class java.rmi.RMISecurityManager

 Stubs are not allowed to manipulate threads.

checkAccess(Thread). Method in class java.lang.SecurityManager

 Throws a SecurityException if the  calling thread is not allowed to modify the thread argument.

checkAccess(ThreadGroup). Method in class java.rmi.RMISecurityManager

 Stubs are not allowed to manipulate thread groups.

checkAccess(ThreadGroup). Method in class java.lang.SecurityManager

 Throws a SecurityException if the  calling thread is not allowed to modify the thread group argument.

checkAll(). Method in class java.awt.MediaTracker

 Checks to see if all images have finished loading but does not start  loading the images if they are not already loading.

checkAll(boolean). Method in class java.awt.MediaTracker

 Checks to see if all images have finished loading.

checkAwtEventQueueAccess(). Method in class java.rmi.RMISecurityManager

 Checks to see if an client can get access to the AWT event queue  (disallowed from stubs).

checkAwtEventQueueAccess(). Method in class java.lang.SecurityManager

 Tests if a client can get access to the AWT event queue.

Checkbox(). Constructor for class java.awt.Checkbox

 Constructs a Checkbox with an empty label.

Checkbox(String). Constructor for class java.awt.Checkbox

 Constructs a Checkbox with the specified label.

Checkbox(String, boolean). Constructor for class java.awt.Checkbox

 Constructs a Checkbox with the specified label.

Checkbox(String, boolean, CheckboxGroup). Constructor for class java.awt. Checkbox

 Constructs a Checkbox with the specified label, set to the  specified state, and in the specified check box group.

Checkbox(String, CheckboxGroup, boolean). Constructor for class java.awt. Checkbox

 Constructs a Checkbox with the specified label, set to the  specified state, and in the specified check box group.

CheckboxGroup(). Constructor for class java.awt.CheckboxGroup

 Creates a new CheckboxGroup.

CheckboxMenuItem(). Constructor for class java.awt.CheckboxMenuItem

 Creates a checkbox menu item with an empty label, initially set  to off (false state).

CheckboxMenuItem(String). Constructor for class java.awt.CheckboxMenuItem

 Creates the checkbox item with the specified label, initially  set to off (false state).

CheckboxMenuItem(String, boolean). Constructor for class java.awt. CheckboxMenuItem

 Creates a checkbox menu item with the specified label and state.

checkConnect(String, int). Method in class java.rmi.RMISecurityManager

 Stubs can make connections if called through the RMI transport.

checkConnect(String, int). Method in class java.lang.SecurityManager

 Throws a SecurityException if the  calling thread is not allowed to open a socket connection to the  specified host and port number.

checkConnect(String, int, Object). Method in class java.rmi.RMISecurityManager

 Downloaded classes (including stubs) can make connections if  called through the RMI transport.

checkConnect(String, int, Object). Method in class java.lang.SecurityManager

 Throws a SecurityException if the  specified security context is not allowed to open a socket  connection to the specified host and port number.

checkCreateClassLoader(). Method in class java.rmi.RMISecurityManager

 Stubs are not allowed to create class loaders, or even execute any  of ClassLoader's methods.

checkCreateClassLoader(). Method in class java.lang.SecurityManager

 Throws a SecurityException if the  calling thread is not allowed to create a new class loader.

checkDelete(String). Method in class java.rmi.RMISecurityManager

 Check if a file with the specified system dependent  file name can be deleted.

checkDelete(String). Method in class java.lang.SecurityManager

 Throws a SecurityException if the  calling thread is not allowed to delete the specified file.

CheckedInputStream(InputStream, Checksum). Constructor for class java.util.zip. CheckedInputStream

 Creates an input stream using the specified Checksum.

CheckedOutputStream(OutputStream, Checksum). Constructor for class java.util.zip.CheckedOutputStream

 Creates an output stream with the specified Checksum.

checkError(). Method in class java.io.PrintStream

 Flushes this print stream's underlying output stream, and tests  if there has been an error on the underlying output stream.

checkError(). Method in class java.io.PrintWriter

 Flush the stream and check its error state.

checkExec(String). Method in class java.rmi.RMISecurityManager

 Stubs are not allowed to fork processes.

checkExec(String). Method in class java.lang.SecurityManager

 Throws a SecurityException if the  calling thread is not allowed to create a subprocss.

checkExit(int). Method in class java.rmi.RMISecurityManager

 Stubs are not allowed to exit the VM.

checkExit(int). Method in class java.lang.SecurityManager

 Throws a SecurityException if the  calling thread is not allowed to cause the Java Virtual Machine to  halt with the specified status code.

checkID(int). Method in class java.awt.MediaTracker

 Checks to see if all images tagged with the indicated ID have  finished loading, but does not start loading the images if they  are not already loading.

checkID(int, boolean). Method in class java.awt.MediaTracker

 Checks to see if all images tagged with the indicated ID have  finished loading.

checkImage(Image, ImageObserver). Method in class java.awt.Component

 Returns the status of the construction of a screen representation  of the specified image.

checkImage(Image, int, int, ImageObserver). Method in class java.awt.Component

 Returns the status of the construction of a scaled screen  representation of the specified image.

checkImage(Image, int, int, ImageObserver). Method in interface java.awt.peer. ComponentPeer

 checkImage(Image, int, int, ImageObserver). Method in class java.awt.Toolkit

 Returns the status of the construction of the indicated method  at the indicated width and height for the default screen.

checkLink(String). Method in class java.rmi.RMISecurityManager

 Stubs are not allowed to link dynamic libraries.

checkLink(String). Method in class java.lang.SecurityManager

 Throws a SecurityException if the  calling thread is not allowed to dynamic link the library code  specified by the string argument file.

checkListen(int). Method in class java.rmi.RMISecurityManager

 For now stubs can't listen on any port.

checkListen(int). Method in class java.lang.SecurityManager

 Throws a SecurityException if the  calling thread is not allowed to wait for a connection request on  the specified local port number.

checkMemberAccess(Class, int). Method in class java.rmi.RMISecurityManager

 Checks to see if client code can access class members.

checkMemberAccess(Class, int). Method in class java.lang.SecurityManager

 Tests if a client is allowed to access members.

checkMulticast(InetAddress). Method in class java.rmi.RMISecurityManager

 Checks to see if current execution context is allowed to use  (join/leave/send/receive) IP multicast (disallowed from stubs).

checkMulticast(InetAddress). Method in class java.lang.SecurityManager

 Tests if current execution context is allowed to use  (join/leave/send/receive) IP multicast.

checkMulticast(InetAddress, byte). Method in class java.rmi.RMISecurityManager

 Checks to see if current execution context is allowed to use  (join/leave/send/receive) IP multicast (disallowed from stubs).

checkMulticast(InetAddress, byte). Method in class java.lang.SecurityManager

 Tests to see if current execution context is allowed to use  (join/leave/send/receive) IP multicast.

checkPackageAccess(String). Method in class java.rmi.RMISecurityManager

 Check if a stub can access a package.

checkPackageAccess(String). Method in class java.lang.SecurityManager

 Throws a SecurityException if the  calling thread is not allowed to access the package specified by  the argument.

checkPackageDefinition(String). Method in class java.rmi.RMISecurityManager

 Check if a stub can define classes in a package.

checkPackageDefinition(String). Method in class java.lang.SecurityManager

 Throws a SecurityException if the  calling thread is not allowed to define classes in the package  specified by the argument.

checkPermission(Permission). Method in interface java.security.acl.AclEntry

 Checks if the specified permission is part of the  permission set in this entry.

checkPermission(Principal, Permission). Method in interface java.security.acl. Acl

 Checks whether or not the specified principal has the specified  permission.

checkPrintJobAccess(). Method in class java.rmi.RMISecurityManager

 Disallow printing from stubs.

checkPrintJobAccess(). Method in class java.lang.SecurityManager

 Tests if a client can initiate a print job request.

checkPropertiesAccess(). Method in class java.rmi.RMISecurityManager

 Stubs are not allowed to access the entire system properties  list, only properties explicitly labeled as accessible to stubs.

checkPropertiesAccess(). Method in class java.lang.SecurityManager

 Throws a SecurityException if the  calling thread is not allowed to access or modify the system  properties.

checkPropertyAccess(String). Method in class java.rmi.RMISecurityManager

 Stubs can access the system property named by key  only if its twin key.stub property is set to true.

checkPropertyAccess(String). Method in class java.lang.SecurityManager

 Throws a SecurityException if the  calling thread is not allowed to access the system property with  the specified key  name.

checkRead(FileDescriptor). Method in class java.rmi.RMISecurityManager

 Stubs are not allowed to open file descriptors for reading unless  it is done through a socket, in which case other access  restrictions still apply.

checkRead(FileDescriptor). Method in class java.lang.SecurityManager

 Throws a SecurityException if the  calling thread is not allowed to read from the specified file  descriptor.

checkRead(String). Method in class java.rmi.RMISecurityManager

 Check if a stub can read a particular file.

checkRead(String). Method in class java.lang.SecurityManager

 Throws a SecurityException if the  calling thread is not allowed to read the file specified by the  string argument.

checkRead(String, Object). Method in class java.rmi.RMISecurityManager

 No file reads are valid from a stub.

checkRead(String, Object). Method in class java.lang.SecurityManager

 Throws a SecurityException if the  specified security context is not allowed to read the file  specified by the string argument.

checkSecurityAccess(String). Method in class java.rmi.RMISecurityManager

 Stubs cannot perform security provider operations.

checkSecurityAccess(String). Method in class java.lang.SecurityManager

 Tests access to certain operations for a security API  action.

checkSetFactory(). Method in class java.rmi.RMISecurityManager

 Check if a stub can set a networking-related object factory.

checkSetFactory(). Method in class java.lang.SecurityManager

 Throws a SecurityException if the  calling thread is not allowed to set the socket factory used by  ServerSocket or Socket, or the stream  handler factory used by URL.

checkSystemClipboardAccess(). Method in class java.rmi.RMISecurityManager

 Checks to see if an client can get access to the System Clipboard  (disallowed from stubs).

checkSystemClipboardAccess(). Method in class java.lang.SecurityManager

 Tests if a client can get access to the system clipboard.

checkTopLevelWindow(Object). Method in class java.rmi.RMISecurityManager

 Allow caller to create top-level windows.

checkTopLevelWindow(Object). Method in class java.lang.SecurityManager

 Returns false if the calling  thread is not trusted to bring up the top-level window indicated  by the window  argument.

checkWrite(FileDescriptor). Method in class java.rmi.RMISecurityManager

 Stubs are not allowed to open file descriptors for writing unless  it is done through a socket, in which case other access  restrictions still apply.

checkWrite(FileDescriptor). Method in class java.lang.SecurityManager

 Throws a SecurityException if the  calling thread is not allowed to write to the specified file  descriptor.

checkWrite(String). Method in class java.rmi.RMISecurityManager

 Check if a Stub can write a particular file.

checkWrite(String). Method in class java.lang.SecurityManager

 Throws a SecurityException if the  calling thread is not allowed to write to the file specified by  the string argument.

childResized(int, int). Method in interface java.awt.peer.ScrollPanePeer

 CHINA. Static variable in class java.util.Locale

 Useful constant for country.

CHINESE. Static variable in class java.util.Locale

 Useful constant for language.

Choice(). Constructor for class java.awt.Choice

 Constructs a new Choice.

ChoiceFormat(double[], String[]). Constructor for class java.text. ChoiceFormat

 Constructs with the limits and the corresponding formats.

ChoiceFormat(String). Constructor for class java.text.ChoiceFormat

 Constructs with limits and corresponding formats based on the pattern.

choices. Variable in class java.sql.DriverPropertyInfo

 If the value may be selected from a particular set of values,  then this is an array of the possible values.

ClassCastException(). Constructor for class java.lang.ClassCastException

 Constructs a ClassCastException with no detail message.

ClassCastException(String). Constructor for class java.lang.ClassCastException

 Constructs a ClassCastException with the specified  detail message.

ClassCircularityError(). Constructor for class java.lang.ClassCircularityError

 Constructs a ClassCircularityError with no detail message.

ClassCircularityError(String). Constructor for class java.lang. ClassCircularityError

 Constructs a ClassCircularityError with the  specified detail message.

classDepth(String). Method in class java.lang.SecurityManager

 Returns the stack depth of the specified class.

ClassFormatError(). Constructor for class java.lang.ClassFormatError

 Constructs a ClassFormatError with no detail message.

ClassFormatError(String). Constructor for class java.lang.ClassFormatError

 Constructs a ClassFormatError with the specified  detail message.

ClassLoader(). Constructor for class java.lang.ClassLoader

 Constructs a new class loader and initializes it.

classLoaderDepth(). Method in class java.lang.SecurityManager

 Returns the stack depth of the most recently executing method  from a class defined using a class loader.

classname. Variable in class java.io.InvalidClassException

 ClassNotFoundException(). Constructor for class java.lang.ClassNotFoundException

 Constructs a ClassNotFoundException with no detail message.

ClassNotFoundException(String). Constructor for class java.lang. ClassNotFoundException

 Constructs a ClassNotFoundException with the  specified detail message.

clean(ObjID[], long, VMID, boolean). Method in interface java.rmi.dgc.DGC

 The clean call removes the 'vmid' from the reference list of  each remote object indicated in 'id's.

clear(). Method in class java.util.Calendar

 Clears the values of all the time fields.

clear(). Method in class java.util.Hashtable

 Clears this hashtable so that it contains no keys.

clear(). Method in class java.awt.List

 clear(). Method in interface java.awt.peer.ListPeer

 DEPRECATED: Replaced by removeAll().

clear(int). Method in class java.util.BitSet

 Sets the bit specified by the index to false.

clear(int). Method in class java.util.Calendar

 Clears the value in the given time field.

clearBit(int). Method in class java.math.BigInteger

 Returns a BigInteger whose value is equivalent to this number  with the designated bit cleared.

clearBreakpoint(int). Method in class sun.tools.debug.RemoteClass

 Clear a breakpoint at a specific address in a class.

clearBreakpointLine(int). Method in class sun.tools.debug.RemoteClass

 Clear a breakpoint at a specified line.

clearBreakpointMethod(RemoteField). Method in class sun.tools.debug.RemoteClass

 Clear a breakpoint at the start of a specified method.

clearChanged(). Method in class java.util.Observable

 Indicates that this object has no longer changed, or that it has  already notified all of its observers of its most recent change.

clearParameters(). Method in interface java.sql.PreparedStatement

In general, parameter values remain in force for repeated use of a  Statement.

clearRect(int, int, int, int). Method in class java.awt.Graphics

 Clears the specified rectangle by filling it with the background  color of the current drawing surface.

clearWarnings(). Method in interface java.sql.Connection

 After this call, getWarnings returns null until a new warning is  reported for this Connection.

clearWarnings(). Method in interface java.sql.ResultSet

 After this call getWarnings returns null until a new warning is  reported for this ResultSet.

clearWarnings(). Method in interface java.sql.Statement

 After this call, getWarnings returns null until a new warning is  reported for this Statement.

clickCount. Variable in class java.awt.Event

 The number of consecutive clicks.

Clipboard(String). Constructor for class java.awt.datatransfer.Clipboard

 Creates a clipboard object.

clipRect(int, int, int, int). Method in class java.awt.Graphics

 Intersects the current clip with the specified rectangle.

clone(). Method in interface java.security.acl.AclEntry

 Clones this ACL entry.

clone(). Method in class java.util.BitSet

 Clones this BitSet.

clone(). Method in class java.text.BreakIterator

 Create a copy of this boundary

clone(). Method in class java.util.Calendar

 Overrides Cloneable

clone(). Method in interface java.text.CharacterIterator

 Create a copy of this iterator

clone(). Method in class java.text.ChoiceFormat

 Overrides Cloneable

clone(). Method in class java.text.Collator

 Overrides Cloneable

clone(). Method in class java.text.DateFormat

 Overrides Cloneable

clone(). Method in class java.text.DateFormatSymbols

 Overrides Cloneable

clone(). Method in class java.text.DecimalFormat

 Standard override; no change in semantics.

clone(). Method in class java.text.DecimalFormatSymbols

 Standard override.

clone(). Method in class java.text.Format

 Creates a new object of the same class as this object.

clone(). Method in class java.util.GregorianCalendar

 Overrides Cloneable

clone(). Method in class java.awt.GridBagConstraints

 Creates a new object of the same class as this object.

clone(). Method in class java.util.Hashtable

 Creates a shallow copy of this hashtable.

clone(). Method in class java.awt.image.ImageFilter

 Clones this object.

clone(). Method in class java.awt.Insets

 Creates a new object of the same class as this object.

clone(). Method in class java.util.Locale

 Overrides Cloneable

clone(). Method in class java.security.MessageDigest

 Returns a clone if the implementation is cloneable.

clone(). Method in class java.text.MessageFormat

 Overrides Cloneable

clone(). Method in class java.text.NumberFormat

 Overrides Cloneable

clone(). Method in class java.lang.Object

 Creates a new object of the same class as this object.

clone(). Method in class java.text.RuleBasedCollator

 Standard override; no change in semantics.

clone(). Method in class java.security.Signature

 Returns a clone if the implementation is cloneable.

clone(). Method in class java.text.SimpleDateFormat

 Overrides Cloneable

clone(). Method in class java.util.SimpleTimeZone

 Overrides Cloneable

clone(). Method in class java.text.StringCharacterIterator

 Create a copy of this boundary

clone(). Method in class java.util.TimeZone

 Overrides Cloneable

clone(). Method in class java.rmi.server.UnicastRemoteObject

 Returns a clone of the remote object that is distinct from  the original.

clone(). Method in class java.util.Vector

 Returns a clone of this vector.

CloneNotSupportedException(). Constructor for class java.lang. CloneNotSupportedException

 Constructs a CloneNotSupportedException with no  detail message.

CloneNotSupportedException(String). Constructor for class java.lang. CloneNotSupportedException

 Constructs a CloneNotSupportedException with the  specified detail message.

close(). Method in class java.io.BufferedReader

 Close the stream.

close(). Method in class java.io.BufferedWriter

 Close the stream.

close(). Method in class java.io.CharArrayReader

 Close the stream.

close(). Method in class java.io.CharArrayWriter

 Close the stream.

close(). Method in interface java.sql.Connection

 In some cases, it is desirable to immediately release a  Connection's database and JDBC resources instead of waiting for  them to be automatically released; the close method provides this  immediate release.

close(). Method in class java.net.DatagramSocket

 Closes this datagram socket.

close(). Method in class java.net.DatagramSocketImpl

 Close the socket.

close(). Method in class java.util.zip.DeflaterOutputStream

 Writes remaining compressed data to the output stream and closes the  underlying stream.

close(). Method in class java.io.FileInputStream

 Closes this file input stream and releases any system resources  associated with the stream.

close(). Method in class java.io.FileOutputStream

 Closes this file output stream and releases any system resources  associated with this stream.

close(). Method in class java.io.FilterInputStream

 Closes this input stream and releases any system resources  associated with the stream.

close(). Method in class java.io.FilterOutputStream

 Closes this output stream and releases any system resources  associated with the stream.

close(). Method in class java.io.FilterReader

 Close the stream.

close(). Method in class java.io.FilterWriter

 Close the stream.

close(). Method in class java.util.zip.GZIPInputStream

 Closes the input stream.

close(). Method in class java.util.zip.GZIPOutputStream

 Writes remaining compressed data to the output stream and closes the  underlying stream.

close(). Method in class java.io.InputStream

 Closes this input stream and releases any system resources  associated with the stream.

close(). Method in class java.io.InputStreamReader

 Close the stream.

close(). Method in interface java.io.ObjectInput

 Closes the input stream.

close(). Method in class java.io.ObjectInputStream

 Closes the input stream.

close(). Method in interface java.io.ObjectOutput

 Closes the stream.

close(). Method in class java.io.ObjectOutputStream

 Closes the stream.

close(). Method in class java.io.OutputStream

 Closes this output stream and releases any system resources  associated with this stream.

close(). Method in class java.io.OutputStreamWriter

 Close the stream.

close(). Method in class java.io.PipedInputStream

 Closes this piped input stream and releases any system resources  associated with the stream.

close(). Method in class java.io.PipedOutputStream

 Closes this piped output stream and releases any system resources  associated with this stream.

close(). Method in class java.io.PipedReader

 Close the stream.

close(). Method in class java.io.PipedWriter

 Close the stream.

close(). Method in class java.io.PrintStream

 Closes this print stream and releases any resources associated  with the underlying output stream.

close(). Method in class java.io.PrintWriter

 Close the stream.

close(). Method in class java.io.PushbackReader

 Close the stream.

close(). Method in class java.io.RandomAccessFile

 Closes this random access file stream and releases any system  resources associated with the stream.

close(). Method in class java.io.Reader

 Close the stream.

close(). Method in class sun.tools.debug.RemoteDebugger

 Close the connection to the remote debugging agent.

close(). Method in interface java.sql.ResultSet

 In some cases, it is desirable to immediately release a  ResultSet's database and JDBC resources instead of waiting for  this to happen when it is automatically closed; the close  method provides this immediate release.

close(). Method in class java.io.SequenceInputStream

 Closes this input stream and releases any system resources  associated with the stream.

close(). Method in class java.net.ServerSocket

 Closes this socket.

close(). Method in class java.net.Socket

 Closes this socket.

close(). Method in class java.net.SocketImpl

 Closes this socket.

close(). Method in interface java.sql.Statement

 In many cases, it is desirable to immediately release a  Statements's database and JDBC resources instead of waiting for  this to happen when it is automatically closed; the close  method provides this immediate release.

close(). Method in class java.io.StringReader

 Close the stream.

close(). Method in class java.io.StringWriter

 Close the stream.

close(). Method in class java.io.Writer

 Close the stream, flushing it first.

close(). Method in class java.util.zip.ZipFile

 Closes the ZIP file.

close(). Method in class java.util.zip.ZipInputStream

 Closes the ZIP input stream.

close(). Method in class java.util.zip.ZipOutputStream

 Closes the ZIP output stream as well as the stream being filtered.

closeEntry(). Method in class java.util.zip.ZipInputStream

 Closes the current ZIP entry and positions the stream for reading the  next entry.

closeEntry(). Method in class java.util.zip.ZipOutputStream

 Closes the current ZIP entry and positions the stream for writing  the next entry.

Collator(). Constructor for class java.text.Collator

 Default constructor.

Color(float, float, float). Constructor for class java.awt.Color

 Creates a color with the specified red, green, and blue values in the  range (0.0 - 1.0).

Color(int). Constructor for class java.awt.Color

 Creates a color with the specified combined RGB value consisting of  the red component in bits 16-23, the green component in bits 8-15,  and the blue component in bits 0-7.

Color(int, int, int). Constructor for class java.awt.Color

 Creates a color with the specified red, green, and blue values in  the range (0 - 255).

ColorModel(int). Constructor for class java.awt.image.ColorModel

 Constructs a ColorModel which describes a pixel of the specified  number of bits.

columnNoNulls. Static variable in interface java.sql.DatabaseMetaData

 COLUMN NULLABLE - might not allow NULL values.

columnNoNulls. Static variable in interface java.sql.ResultSetMetaData

 Does not allow NULL values.

columnNullable. Static variable in interface java.sql.DatabaseMetaData

 COLUMN NULLABLE - definitely allows NULL values.

columnNullable. Static variable in interface java.sql.ResultSetMetaData

 Allows NULL values.

columnNullableUnknown. Static variable in interface java.sql.DatabaseMetaData

 COLUMN NULLABLE - nullability unknown.

columnNullableUnknown. Static variable in interface java.sql.ResultSetMetaData

 Nullability unknown.

columnWeights. Variable in class java.awt.GridBagLayout

 columnWidths. Variable in class java.awt. GridBagLayout

 COMBINING_SPACING_MARK. Static variable in class java.lang.Character

 command(Object). Static method in class java.lang. Compiler

 Examines the argument type and its fields and perform some documented  operation.

commentChar(int). Method in class java.io.StreamTokenizer

 Specified that the character argument starts a single-line  comment.

commit(). Method in interface java.sql.Connection

 Commit makes all changes made since the previous  commit/rollback permanent and releases any database locks  currently held by the Connection.

compare(String, String). Method in class java.text.Collator

 Compares the source string to the target string according to the  collation rules for this Collator.

compare(String, String). Method in class java.text.RuleBasedCollator

 Compares the character data stored in two different strings based on the  collation rules.

compareTo(BigDecimal). Method in class java.math.BigDecimal

 Returns -1, 0 or 1 as this number is less than, equal to, or greater  than val.

compareTo(BigInteger). Method in class java.math.BigInteger

 Returns -1, 0 or 1 as this number is less than, equal to, or  greater than val.

compareTo(CollationKey). Method in class java.text.CollationKey

 Compare this CollationKey to the target CollationKey.

compareTo(String). Method in class java.lang.String

 Compares two strings lexicographically.

compileClass(Class). Static method in class java.lang.Compiler

 Compiles the specified class.

compileClasses(String). Static method in class java.lang.Compiler

 Compiles all classes whose name matches the specified string.

COMPLETE. Static variable in class java.awt.MediaTracker

 Flag indicating the download of media completed successfully.

complete(). Method in class java.util.Calendar

 Fills in any unset fields in the time field list.

COMPLETESCANLINES. Static variable in interface java.awt.image.ImageConsumer

 The pixels will be delivered in (multiples of) complete scanlines  at a time.

Component(). Constructor for class java.awt.Component

 Constructs a new Component.

COMPONENT_ADDED. Static variable in class java.awt.event.ContainerEvent

 The component moved event type.

COMPONENT_EVENT_MASK. Static variable in class java.awt.AWTEvent

 The event mask for selecting component events.

COMPONENT_FIRST. Static variable in class java.awt.event.ComponentEvent

 Marks the first integer id for the range of component event ids.

COMPONENT_HIDDEN. Static variable in class java.awt.event.ComponentEvent

 The component hidden event type.

COMPONENT_LAST. Static variable in class java.awt.event.ComponentEvent

 Marks the last integer id for the range of component event ids.

COMPONENT_MOVED. Static variable in class java.awt.event.ComponentEvent

 The component moved event type.

COMPONENT_REMOVED. Static variable in class java.awt.event.ContainerEvent

 The component resized event type.

COMPONENT_RESIZED. Static variable in class java.awt.event.ComponentEvent

 The component resized event type.

COMPONENT_SHOWN. Static variable in class java.awt.event.ComponentEvent

 The component shown event type.

ComponentAdapter(). Constructor for class java.awt.event.ComponentAdapter

 componentAdded(ContainerEvent). Method in class java.awt.AWTEventMulticaster

 Handles the componentAdded container event by invoking the  componentAdded methods on listener-a and listener-b.

componentAdded(ContainerEvent). Method in class java.awt.event.ContainerAdapter

 componentAdded(ContainerEvent). Method in interface java.awt.event.ContainerListener

 Invoked when a component has been added to the container.

ComponentEvent(Component, int). Constructor for class java.awt.event. ComponentEvent

 Constructs a ComponentEvent object with the specified source component  and type.

componentHidden(ComponentEvent). Method in class java.awt.AWTEventMulticaster

 Handles the componentHidden event by invoking the  componentHidden methods on listener-a and listener-b.

componentHidden(ComponentEvent). Method in class java.awt.event. ComponentAdapter

 componentHidden(ComponentEvent). Method in interface java.awt.event.ComponentListener

 Invoked when component has been hidden.

componentMoved(ComponentEvent). Method in class java.awt.AWTEventMulticaster

 Handles the componentMoved event by invoking the  componentMoved methods on listener-a and listener-b.

componentMoved(ComponentEvent). Method in class java.awt.event.ComponentAdapter

 componentMoved(ComponentEvent). Method in interface java.awt.event.ComponentListener

 Invoked when component has been moved.

componentRemoved(ContainerEvent). Method in class java.awt.AWTEventMulticaster

 Handles the componentRemoved container event by invoking the  componentRemoved methods on listener-a and listener-b.

componentRemoved(ContainerEvent). Method in class java.awt.event. ContainerAdapter

 componentRemoved(ContainerEvent). Method in interface java.awt.event.ContainerListener

 Invoked when a component has been removed from the container.

componentResized(ComponentEvent). Method in class java.awt.AWTEventMulticaster

 Handles the componentResized event by invoking the  componentResized methods on listener-a and listener-b.

componentResized(ComponentEvent). Method in class java.awt.event. ComponentAdapter

 componentResized(ComponentEvent). Method in interface java.awt.event.ComponentListener

 Invoked when component has been resized.

componentShown(ComponentEvent). Method in class java.awt.AWTEventMulticaster

 Handles the componentShown event by invoking the  componentShown methods on listener-a and listener-b.

componentShown(ComponentEvent). Method in class java.awt.event.ComponentAdapter

 componentShown(ComponentEvent). Method in interface java.awt.event.ComponentListener

 Invoked when component has been shown.

comptable. Variable in class java.awt.GridBagLayout

 computeFields(). Method in class java.util.Calendar

 Converts UTC as milliseconds to time field values.

computeFields(). Method in class java.util.GregorianCalendar

 Overrides Calendar  Converts UTC as milliseconds to time field values.

computeTime(). Method in class java.util.Calendar

 Converts Calendar's time field values to UTC as milliseconds.

computeTime(). Method in class java.util.GregorianCalendar

 Overrides Calendar  Converts time field values to UTC as milliseconds.

concat(String). Method in class java.lang.String

 Concatenates the specified string to the end of this string.

connect(). Method in class java.net.URLConnection

 Opens a communications link to the resource referenced by this  URL, if such a connection has not already been established.

connect(InetAddress, int). Method in class java.net.SocketImpl

 Connects this socket to the specified port number on the specified host.

connect(PipedInputStream). Method in class java.io.PipedOutputStream

 Connects this piped output stream to a receiver.

connect(PipedOutputStream). Method in class java.io.PipedInputStream

 Connects this piped input stream to a sender.

connect(PipedReader). Method in class java.io.PipedWriter

 Connect the specified piped reader to this writer.

connect(PipedWriter). Method in class java.io.PipedReader

 Connect the specified piped writer to this reader.

connect(String, int). Method in class java.net.SocketImpl

 Connects this socket to the specified port on the named host.

connect(String, Properties). Method in interface java.sql.Driver

 Try to make a database connection to the given URL.

connected. Variable in class java.net.URLConnection

 If false, this connection object has not created a  communications link to the specified URL.

ConnectException(). Constructor for class java.net.ConnectException

 Construct a new ConnectException with no detailed message.

ConnectException(String). Constructor for class java.net.ConnectException

 Constructs a new ConnectException with the specified detail  message as to why the connect error occurred.

ConnectException(String). Constructor for class java.rmi.ConnectException

 Create A remote exception with the specified string

ConnectException(String, Exception). Constructor for class java.rmi. ConnectException

 Create A remote exception with the specified string, and the  exception specified.

ConnectIOException(String). Constructor for class java.rmi.ConnectIOException

 Create A remote exception with the specified string

ConnectIOException(String, Exception). Constructor for class java.rmi. ConnectIOException

 Create A remote exception with the specified string, and the  exception specified.

CONNECTOR_PUNCTUATION. Static variable in class java.lang.Character

 consume(). Method in class java.awt.AWTEvent

 consume(). Method in class java.awt.event.InputEvent

 Consumes this event so that it will not be processed  in the default manner by the source which originated it.

consumed. Variable in class java.awt.AWTEvent

 consumer. Variable in class java.awt.image. ImageFilter

 The consumer of the particular image data stream for which this  instance of the ImageFilter is filtering data.

cont(). Method in class sun.tools.debug.RemoteThread

 Resume this thread from a breakpoint, unless it previously suspended.

Container(). Constructor for class java.awt.Container

 Constructs a new Container.

CONTAINER_EVENT_MASK. Static variable in class java.awt.AWTEvent

 The event mask for selecting container events.

CONTAINER_FIRST. Static variable in class java.awt.event.ContainerEvent

 Marks the first integer id for the range of container event ids.

CONTAINER_LAST. Static variable in class java.awt.event.ContainerEvent

 Marks the last integer id for the range of container event ids.

ContainerAdapter(). Constructor for class java.awt.event.ContainerAdapter

 ContainerEvent(Component, int, Component). Constructor for class java.awt.event.ContainerEvent

 Constructs a ContainerEvent object with the specified source  container, type, and child which is being added or removed.

contains(int, int). Method in class java.awt.Component

 Checks whether this component "contains" the specified (x, y)  location, where x and y are defined to be relative to the  coordinate system of this component.

contains(int, int). Method in class java.awt.Polygon

 Determines whether the point (x,y) is inside the Polygon.

contains(int, int). Method in class java.awt.Rectangle

 Checks whether this rectangle contains the specified point.

contains(Object). Method in class java.util.Hashtable

 Tests if some key maps into the specified value in this hashtable.

contains(Object). Method in class java.util.Vector

 Tests if the specified object is a component in this vector.

contains(Point). Method in class java.awt.Component

 Checks whether this component "contains" the specified point,  where x and y in the point are defined to be relative to the  coordinate system of this component.

contains(Point). Method in class java.awt.Polygon

 Determines whether the specified point is inside the Polygon.

contains(Point). Method in class java.awt.Rectangle

 Checks whether this rectangle contains the specified point.

containsKey(Object). Method in class java.util.Hashtable

 Tests if the specified object is a key in this hashtable.

ContentHandler(). Constructor for class java.net.ContentHandler

 contents. Variable in class java.awt.datatransfer. Clipboard

 CONTROL. Static variable in class java.lang.Character

 control. Static variable in class java.awt. SystemColor

 The background color for control objects.

CONTROL. Static variable in class java.awt.SystemColor

 The array index for the control background color.

CONTROL_DK_SHADOW. Static variable in class java.awt.SystemColor

 The array index for the control dark shadow color.

CONTROL_HIGHLIGHT. Static variable in class java.awt.SystemColor

 The array index for the control highlight color.

CONTROL_LT_HIGHLIGHT. Static variable in class java.awt.SystemColor

 The array index for the control light highlight color.

CONTROL_SHADOW. Static variable in class java.awt.SystemColor

 The array index for the control shadow color.

CONTROL_TEXT. Static variable in class java.awt.SystemColor

 The array index for the control text color.

controlDkShadow. Static variable in class java.awt.SystemColor

 The dark shadow color for control objects.

controlDown(). Method in class java.awt.Event

 Checks if the control key is down.

controlHighlight. Static variable in class java.awt.SystemColor

 The light highlight color for control objects.

controlLtHighlight. Static variable in class java.awt.SystemColor

 The regular highlight color for control objects.

controlShadow. Static variable in class java.awt.SystemColor

 The regular shadow color for control objects.

controlText. Static variable in class java.awt.SystemColor

 The text color for control objects.

copyArea(int, int, int, int, int, int). Method in class java.awt.Graphics

 Copies an area of the Component by a distance specified by dx  and dy to the right and down.

copyInto(Object[]). Method in class java.util.Vector

 Copies the components of this vector into the specified array.

copyValueOf(char[]). Static method in class java.lang.String

 Returns a String that is equivalent to the specified character array.

copyValueOf(char[], int, int). Static method in class java.lang.String

 Returns a String that is equivalent to the specified character array.

cos(double). Static method in class java.lang.Math

 Returns the trigonometric cosine of an angle.

count. Variable in class java.io.BufferedInputStream

 The index one greater than the index of the last valid byte in  the buffer.

count. Variable in class java.io.BufferedOutputStream

 The number of valid bytes in the buffer.

count. Variable in class java.io.ByteArrayInputStream

 The index one greater than the last valid character in the input  stream buffer.

count. Variable in class java.io.ByteArrayOutputStream

 The number of valid bytes in the buffer.

count. Variable in class java.io.CharArrayReader

 Number of valid characters in buffer

count. Variable in class java.io.CharArrayWriter

 The number of chars in the buffer.

count. Variable in class java.io.StringBufferInputStream

 The number of valid characters in the input stream buffer.

countComponents(). Method in class java.awt.Container

 countItems(). Method in class java.awt.Choice

 countItems(). Method in class java.awt.List

 countItems(). Method in class java.awt.Menu

 countMenus(). Method in class java.awt.MenuBar

 countObservers(). Method in class java.util. Observable

 Returns the number of observers of this object.

countStackFrames(). Method in class java.lang.Thread

 Counts the number of stack frames in this thread.

countTokens(). Method in class java.util.StringTokenizer

 Calculates the number of times that this tokenizer's  nextToken  method can be called before it generates an  exception.

crc. Variable in class java.util.zip.GZIPInputStream

 CRC-32 for uncompressed data.

crc. Variable in class java.util.zip.GZIPOutputStream

 CRC-32 of uncompressed data.

CRC32(). Constructor for class java.util.zip.CRC32

 create(). Method in class java.net.DatagramSocketImpl

 Creates a datagram socket

create(). Method in class java.awt.Graphics

 Creates a new Graphics object that is a copy of this Graphics object.

create(boolean). Method in class java.net.SocketImpl

 Creates either a stream or a datagram socket.

create(int, int, int, int). Method in class java.awt.Graphics

 Creates a new Graphics object based on this Graphics object,  but with a new translation and clip area.

createButton(Button). Method in class java.awt.Toolkit

 Uses the specified Peer interface to create a new Button.

createCanvas(Canvas). Method in class java.awt.Toolkit

 Uses the specified Peer interface to create a new Canvas.

createCheckbox(Checkbox). Method in class java.awt.Toolkit

 Uses the specified Peer interface to create a new Checkbox.

createCheckboxMenuItem(CheckboxMenuItem). Method in class java.awt.Toolkit

 Uses the specified Peer interface to create a new CheckboxMenuItem.

createChoice(Choice). Method in class java.awt.Toolkit

 Uses the specified Peer interface to create a new Choice.

createComponent(Component). Method in class java.awt.Toolkit

 Creates a peer for a component or container.

createContentHandler(String). Method in interface java.net. ContentHandlerFactory

 Creates a new ContentHandler to read an object from  a URLStreamHandler.

createDialog(Dialog). Method in class java.awt.Toolkit

 Uses the specified Peer interface to create a new Dialog.

createFileDialog(FileDialog). Method in class java.awt.Toolkit

 Uses the specified Peer interface to create a new FileDialog.

createFrame(Frame). Method in class java.awt.Toolkit

 Uses the specified Peer interface to create a new Frame.

createImage(byte[]). Method in class java.awt.Toolkit

 Creates an image which decodes the image stored in the specified  byte array.

createImage(byte[], int, int). Method in class java.awt.Toolkit

 Creates an image which decodes the image stored in the specified  byte array at the specified offset and length.

createImage(ImageProducer). Method in class java.awt.Component

 Creates an image from the specified image producer.

createImage(ImageProducer). Method in interface java.awt.peer.ComponentPeer

 createImage(ImageProducer). Method in class java.awt.Toolkit

 Creates an image with the specified image producer.

createImage(int, int). Method in class java.awt.Component

 Creates an off-screen drawable Image to be used for double buffering.

createImage(int, int). Method in interface java.awt.peer.ComponentPeer

 createLabel(Label). Method in class java.awt.Toolkit

 Uses the specified Peer interface to create a new Label.

createList(List). Method in class java.awt.Toolkit

 Uses the specified Peer interface to create a new List.

createMenu(Menu). Method in class java.awt.Toolkit

 Uses the specified Peer interface to create a new Menu.

createMenuBar(MenuBar). Method in class java.awt.Toolkit

 Uses the specified Peer interface to create a new MenuBar.

createMenuItem(MenuItem). Method in class java.awt.Toolkit

 Uses the specified Peer interface to create a new MenuItem.

createPanel(Panel). Method in class java.awt.Toolkit

 Uses the specified Peer interface to create a new Panel.

createPopupMenu(PopupMenu). Method in class java.awt.Toolkit

 Uses the specified Peer interface to create a new PopupMenu.

createRegistry(int). Static method in class java.rmi.registry.LocateRegistry

 Create and export a registry on the local host.

createScrollbar(Scrollbar). Method in class java.awt.Toolkit

 Uses the specified Peer interface to create a new Scrollbar.

createScrollPane(ScrollPane). Method in class java.awt.Toolkit

 Uses the specified Peer interface to create a new scrolling container.

createServerSocket(int). Method in class java.rmi.server.RMISocketFactory

 Create a server socket on the specified port (port 0 represents  an anonymous port).

createSocket(String, int). Method in class java.rmi.server.RMISocketFactory

 Create a client socket connected to the specified host and port.

createSocketImpl(). Method in interface java.net.SocketImplFactory

 Creates a new SocketImpl instance.

createStatement(). Method in interface java.sql.Connection

 SQL statements without parameters are normally  executed using Statement objects.

createTextArea(TextArea). Method in class java.awt.Toolkit

 Uses the specified Peer interface to create a new TextArea.

createTextField(TextField). Method in class java.awt.Toolkit

 Uses the specified Peer interface to create a new TextField.

createURLStreamHandler(String). Method in interface java.net. URLStreamHandlerFactory

 Creates a new URLStreamHandler instance with the specified  protocol.

createWindow(Window). Method in class java.awt.Toolkit

 Uses the specified Peer interface to create a new Window.

CropImageFilter(int, int, int, int). Constructor for class java.awt.image. CropImageFilter

 Constructs a CropImageFilter that extracts the absolute rectangular  region of pixels from its source Image as specified by the x, y,  w, and h parameters.

CROSSHAIR_CURSOR. Static variable in class java.awt.Cursor

 The crosshair cursor type.

CROSSHAIR_CURSOR. Static variable in class java.awt.Frame

 CTRL_MASK. Static variable in class java.awt.event. ActionEvent

 The control modifier constant.

CTRL_MASK. Static variable in class java.awt.Event

 The control modifier constant.

CTRL_MASK. Static variable in class java.awt.event.InputEvent

 The control key modifier constant.

CURRENCY_SYMBOL. Static variable in class java.lang.Character

 current(). Method in class java.text.BreakIterator

 Return character index of the text boundary that was most recently  returned by next(), previous(), first(), or last()

current(). Method in interface java.text.CharacterIterator

 Get the character at the current position (as returned by getIndex()).

current(). Method in class java.text.StringCharacterIterator

 Get the character at the current position (as returned by getIndex()).

currentClassLoader(). Method in class java.lang.SecurityManager

 Returns an object describing the most recent class loader executing  on the stack.

currentLoadedClass(). Method in class java.lang.SecurityManager

 Returns the current Class with a ClassLoader on the execution stack.

currentThread(). Static method in class java.lang.Thread

 Returns a reference to the currently executing thread object.

currentTimeMillis(). Static method in class java.lang.System

 Returns the current time in milliseconds.

Cursor(int). Constructor for class java.awt.Cursor

 Creates a new cursor object with the specified type.

cyan. Static variable in class java.awt.Color

 The color cyan.

______________________________________________________________________________

  D

darker(). Method in class java.awt.Color

 Returns a darker version of this color.

darkGray. Static variable in class java.awt.Color

 The color dark gray.

DASH_PUNCTUATION. Static variable in class java.lang.Character

 dataDefinitionCausesTransactionCommit(). Method in interface java.sql.DatabaseMetaData

 Does a data definition statement within a transaction force the  transaction to commit?

dataDefinitionIgnoredInTransactions(). Method in interface java.sql. DatabaseMetaData

 Is a data definition statement within a transaction ignored?

DataFlavor(Class, String). Constructor for class java.awt.datatransfer. DataFlavor

 Construct a DataFlavor that represents a Java class

 The returned DataFlavor will have the following characteristics

 representationClass = representationClass
 mimeType = application/x-javaserializedobject

 DataFlavor(String, String). Constructor for class java.awt.datatransfer.DataFlavor

 Construct a DataFlavor that represents a MimeType

 The returned DataFlavor will have the following characteristics:

 If the mimeType is  "application/x-javaserializedobject; class=",  the result is the same as calling  new DataFlavor(Class:forName() as above

 otherwise:

 representationClass = InputStream
 mimeType = mimeType

 DataFormatException(). Constructor for class java.util.zip.DataFormatException

 Constructs a DataFormatException with no detail message.

DataFormatException(String). Constructor for class java.util.zip. DataFormatException

 Constructs a DataFormatException with the specified detail message.

DatagramPacket(byte[], int). Constructor for class java.net.DatagramPacket

 Constructs a DatagramPacket for receiving packets of  length ilength.

DatagramPacket(byte[], int, InetAddress, int). Constructor for class java.net.DatagramPacket

 Constructs a datagram packet for sending packets of length  ilength  to the specified port number on the specified  host.

DatagramSocket(). Constructor for class java.net.DatagramSocket

 Constructs a datagram socket and binds it to any available port  on the local host machine.

DatagramSocket(int). Constructor for class java.net.DatagramSocket

 Constructs a datagram socket and binds it to the specified port  on the local host machine.

DatagramSocket(int, InetAddress). Constructor for class java.net.DatagramSocket

 Creates a datagram socket, bound to the specified local  address.

DatagramSocketImpl(). Constructor for class java.net.DatagramSocketImpl

 DataInputStream(InputStream). Constructor for class java.io.DataInputStream

 Creates a new data input stream to read data from the specified  input stream.

DataOutputStream(OutputStream). Constructor for class java.io.DataOutputStream

 Creates a new data output stream to write data to the specified  underlying output stream.

DataTruncation(int, boolean, boolean, int, int). Constructor for class java.sql.DataTruncation

Create a DataTruncation object.

DATE. Static variable in class java.util.Calendar

 Useful constant for date and time.

DATE. Static variable in class java.sql.Types

 Date(). Constructor for class java.util.Date

 Allocates a Date object and initializes it so that  it represents the time at which it was allocated measured to the  nearest millisecond.

Date(int, int, int). Constructor for class java.sql.Date

 Construct a Date

Date(int, int, int). Constructor for class java.util.Date

 Allocates a Date object and initializes it so that  it represents midnight, local time, at the beginning of the day  specified by the year , month, and  date arguments.

Date(int, int, int, int, int). Constructor for class java.util.Date

 Allocates a Date object and initializes it so that  it represents the specified hour and minute, local time, of the  date specified by the year, month,  date, hrs, and min arguments.

Date(int, int, int, int, int, int). Constructor for class java.util.Date

 Allocates a Date object and initializes it so that  it represents the specified hour, minute, and second, local time  of the date specified by the year, month,  date, hrs, min, and  sec arguments.

Date(long). Constructor for class java.sql.Date

 Construct a Date using a milliseconds time value

Date(long). Constructor for class java.util.Date

 Allocates a Date object and initializes it to  represent the specified number of milliseconds since January 1,  1970, 00:00:00 GMT.

Date(String). Constructor for class java.util.Date

 Allocates a Date object and initializes it so that  it represents the date and time indicated by the string  s , which is interpreted as if by the  parse method.

DATE_FIELD. Static variable in class java.text.DateFormat

 Useful constant for DATE field alignment.

DateFormat(). Constructor for class java.text.DateFormat

 DateFormatSymbols(). Constructor for class java.text. DateFormatSymbols

 Construct a DateFormatSymbols object by loading format data from  resources for the default locale.

DateFormatSymbols(Locale). Constructor for class java.text.DateFormatSymbols

 Construct a DateFormatSymbols object by loading format data from  resources for the given locale.

DAY_OF_MONTH. Static variable in class java.util.Calendar

 Useful constant for date and time.

DAY_OF_WEEK. Static variable in class java.util.Calendar

 Useful constant for date and time.

DAY_OF_WEEK_FIELD. Static variable in class java.text.DateFormat

 Useful constant for DAY_OF_WEEK field alignment.

DAY_OF_WEEK_IN_MONTH. Static variable in class java.util.Calendar

 Useful constant for date and time.

DAY_OF_WEEK_IN_MONTH_FIELD. Static variable in class java.text.DateFormat

 Useful constant for DAY_OF_WEEK_IN_MONTH field alignment.

DAY_OF_YEAR. Static variable in class java.util.Calendar

 Useful constant for date and time.

DAY_OF_YEAR_FIELD. Static variable in class java.text.DateFormat

 Useful constant for DAY_OF_YEAR field alignment.

decapitalize(String). Static method in class java.beans.Introspector

 Utility method to take a string and convert it to normal Java variable  name capitalization.

DECEMBER. Static variable in class java.util.Calendar

 Useful constant for month.

DECIMAL. Static variable in class java.sql.Types

 DECIMAL_DIGIT_NUMBER. Static variable in class java.lang.Character

 DecimalFormat(). Constructor for class java.text. DecimalFormat

 Create a DecimalFormat using the default pattern and symbols  for the default locale.

DecimalFormat(String). Constructor for class java.text.DecimalFormat

 Create a DecimalFormat from the given pattern and the symbols  for the default locale.

DecimalFormat(String, DecimalFormatSymbols). Constructor for class java.text. DecimalFormat

 Create a DecimalFormat from the given pattern and symbols.

DecimalFormatSymbols(). Constructor for class java.text.DecimalFormatSymbols

 Create a DecimalFormatSymbols object for the default locale.

DecimalFormatSymbols(Locale). Constructor for class java.text. DecimalFormatSymbols

 Create a DecimalFormatSymbols object for the given locale.

DECLARED. Static variable in interface java.lang.reflect.Member

 Identifies the set of declared members of a class or interface.

decode(InputStream). Method in interface java.security.Certificate

 Decodes a certificate from an input stream.

decode(String). Static method in class java.lang.Byte

 Decodes a String into a Byte.

decode(String). Static method in class java.awt.Color

 Gets the specified Color.

decode(String). Static method in class java.awt.Font

 Gets the specified font using the name passed in.

decode(String). Static method in class java.lang.Integer

 Decodes a string into an Integer.

decode(String). Static method in class java.lang.Short

 Decodes a String into a Short.

def. Variable in class java.util.zip.DeflaterOutputStream

 Compressor for this stream.

DEFAULT. Static variable in class java.text.DateFormat

 Constant for default style pattern.

DEFAULT_COMPRESSION. Static variable in class java.util.zip.Deflater

 Default compression level.

DEFAULT_CURSOR. Static variable in class java.awt.Cursor

 The default cursor type (gets set if no cursor is defined).

DEFAULT_CURSOR. Static variable in class java.awt.Frame

 DEFAULT_STRATEGY. Static variable in class java.util.zip.Deflater

 Default compression strategy.

defaultConstraints. Variable in class java.awt.GridBagLayout

 defaultReadObject(). Method in class java.io. ObjectInputStream

 Read the non-static and non-transient fields of the current class  from this stream.

defaults. Variable in class java.util.Properties

 A property list that contains default values for any keys not  found in this property list.

defaultWriteObject(). Method in class java.io.ObjectOutputStream

 Write the non-static and non-transient fields of the current class  to this stream.

defineClass(byte[], int, int). Method in class java.lang.ClassLoader

 Converts an array of bytes into an instance of class  Class.

defineClass(String, byte[], int, int). Method in class java.lang.ClassLoader

 Converts an array of bytes to an instance of class  Class.

deflate(). Method in class java.util.zip.DeflaterOutputStream

 Writes next block of compressed data to the output stream.

deflate(byte[]). Method in class java.util.zip.Deflater

 Fills specified buffer with compressed data.

deflate(byte[], int, int). Method in class java.util.zip.Deflater

 Fills specified buffer with compressed data.

DEFLATED. Static variable in class java.util.zip.Deflater

 Compression method for the deflate algorithm (the only one currently  supported).

DEFLATED. Static variable in class java.util.zip.ZipEntry

 Compression method for compressed (deflated) entries.

DEFLATED. Static variable in class java.util.zip.ZipOutputStream

 Compression method for compressed (DEFLATED) entries.

Deflater(). Constructor for class java.util.zip.Deflater

 Creates a new compressor with the default compression level.

Deflater(int). Constructor for class java.util.zip.Deflater

 Creates a new compressor using the specified compression level.

Deflater(int, boolean). Constructor for class java.util.zip.Deflater

 Creates a new compressor using the specified compression level.

DeflaterOutputStream(OutputStream). Constructor for class java.util.zip. DeflaterOutputStream

 Creates a new output stream with a defaul compressor and buffer size.

DeflaterOutputStream(OutputStream, Deflater). Constructor for class java.util.zip.DeflaterOutputStream

 Creates a new output stream with the specified compressor and  a default buffer size.

DeflaterOutputStream(OutputStream, Deflater, int). Constructor for class java.util.zip.DeflaterOutputStream

 Creates a new output stream with the specified compressor and  buffer size.

DELETE. Static variable in class java.awt.Event

 The Delete key.

delete(). Method in class java.io.File

 Deletes the file specified by this object.

deleteObserver(Observer). Method in class java.util.Observable

 Deletes an observer from the set of observers of this object.

deleteObservers(). Method in class java.util.Observable

 Clears the observer list so that this object no longer has any observers.

deleteOwner(Principal, Principal). Method in interface java.security.acl.Owner

 Deletes an owner.

deleteShortcut(). Method in class java.awt.MenuItem

 Delete any MenuShortcut associated with this MenuItem.

deleteShortcut(MenuShortcut). Method in class java.awt.MenuBar

 Delete the specified MenuShortcut.

delItem(int). Method in class java.awt.List

 Removes an item from the list.

delItem(int). Method in interface java.awt.peer.MenuPeer

 delItems(int, int). Method in class java.awt.List

 delItems(int, int). Method in interface java.awt.peer.ListPeer

 deliverEvent(Event). Method in class java.awt. Component

 deliverEvent(Event). Method in class java.awt. Container

 delMenu(int). Method in interface java.awt.peer. MenuBarPeer

 deregisterDriver(Driver). Static method in class java.sql.DriverManager

 Drop a Driver from the DriverManager's list.

description. Variable in class java.sql.DriverPropertyInfo

 A brief description of the property.

description(). Method in class sun.tools.debug.RemoteArray

 Return a description of the array.

description(). Method in class sun.tools.debug.RemoteClass

 Return a (somewhat verbose) description.

description(). Method in class sun.tools.debug.RemoteObject

 Return a description of the object.

description(). Method in class sun.tools.debug.RemoteString

 Return the string value, or "null"

description(). Method in class sun.tools.debug.RemoteValue

 Return a description of the RemoteValue.

deselect(int). Method in class java.awt.List

 Deselects the item at the specified index.

deselect(int). Method in interface java.awt.peer.ListPeer

 DESELECTED. Static variable in class java.awt.event. ItemEvent

 The item de-selected state change type.

DESKTOP. Static variable in class java.awt.SystemColor

 The array index for the desktop background color.

desktop. Static variable in class java.awt.SystemColor

 The color of the desktop background.

destHeight. Variable in class java.awt.image.ReplicateScaleFilter

 destroy(). Method in class java.applet.Applet

 Called by the browser or applet viewer to inform  this applet that it is being reclaimed and that it should destroy  any resources that it has allocated.

destroy(). Method in class java.lang.Process

 Kills the subprocess.

destroy(). Method in class java.lang.Thread

 Destroys this thread, without any cleanup.

destroy(). Method in class java.lang.ThreadGroup

 Destroys this thread group and all of its subgroups.

destWidth. Variable in class java.awt.image.ReplicateScaleFilter

 detail. Variable in class java.rmi.RemoteException

 detail. Variable in class java.rmi.server. ServerCloneException

 detail. Variable in class java.io. WriteAbortedException

 DGC_ID. Static variable in class java.rmi.server. ObjID

 well-known id for the distributed garbage collector

Dialog(Frame). Constructor for class java.awt.Dialog

 Constructs an initially invisible Dialog with an empty title.

Dialog(Frame, boolean). Constructor for class java.awt.Dialog

 Constructs an initially invisible Dialog with an empty title.

Dialog(Frame, String). Constructor for class java.awt.Dialog

 Constructs an initially invisible Dialog with a title.

Dialog(Frame, String, boolean). Constructor for class java.awt.Dialog

 Constructs an initially invisible Dialog with a title.

Dictionary(). Constructor for class java.util.Dictionary

 digest. Variable in class java.security. DigestInputStream

 The message digest associated with this stream.

digest. Variable in class java.security.DigestOutputStream

 The message digest associated with this stream.

digest(). Method in class java.security.MessageDigest

 Completes the hash computation by performing final operations  such as padding.

digest(byte[]). Method in class java.security.MessageDigest

 Performs a final update on the digest using the specified array  of bytes, then completes the digest computation.

DigestException(). Constructor for class java.security.DigestException

 Constructs a DigestException with no detail message.

DigestException(String). Constructor for class java.security.DigestException

 Constructs a DigestException with the specified detail  message.

DigestInputStream(InputStream, MessageDigest). Constructor for class java.security.DigestInputStream

 Creates a digest input stream, using the specified input stream  and message digest.

DigestOutputStream(OutputStream, MessageDigest). Constructor for class java.security.DigestOutputStream

 Creates a digest output stream, using the specified output stream  and message digest.

digit(char, int). Static method in class java.lang.Character

 Returns the numeric value of the character ch in the  specified radix.

Dimension(). Constructor for class java.awt.Dimension

 Constructs a Dimension object with 0 width and 0 height.

Dimension(Dimension). Constructor for class java.awt.Dimension

 Constructs a Dimension and initializes it to the specified value.

Dimension(int, int). Constructor for class java.awt.Dimension

 Constructs a Dimension and initializes it to the specified width and  specified height.

DirectColorModel(int, int, int, int). Constructor for class java.awt.image. DirectColorModel

 Constructs a DirectColorModel from the given masks specifying  which bits in the pixel contain the red, green and blue color  components.

DirectColorModel(int, int, int, int, int). Constructor for class java.awt.image.DirectColorModel

 Constructs a DirectColorModel from the given masks specifying  which bits in the pixel contain the alhpa, red, green and blue  color components.

dirty(ObjID[], long, Lease). Method in interface java.rmi.dgc.DGC

 The dirty call requests leases for the remote object references  associated with the object identifiers contained in the array  'ids'.

disable(). Static method in class java.lang.Compiler

 Cause the Compiler to cease operation.

disable(). Method in class java.awt.Component

 disable(). Method in interface java.awt.peer. ComponentPeer

 DEPRECATED: Replaced by setEnabled(boolean).

disable(). Method in class java.awt.MenuItem

 disable(). Method in interface java.awt.peer. MenuItemPeer

 DEPRECATED: Replaced by setEnabled(boolean).

disableEvents(long). Method in class java.awt.Component

 Disables the events defined by the specified event mask parameter  from being delivered to this component.

disableEvents(long). Method in class java.awt.MenuItem

 Disables the events defined by the specified event mask parameter  from being delivered to this menu item.

disconnect(). Method in class java.net.HttpURLConnection

 Close the connection to the server.

dispatch(Remote, RemoteCall, int, long). Method in interface java.rmi.server. Skeleton

 Unmarshals arguments, calls the actual remote object implementation,  and marshals the return value or any exception.

dispatchEvent(AWTEvent). Method in class java.awt.Component

 Dispatches an event to this component or one of its sub components.

dispatchEvent(AWTEvent). Method in class java.awt.MenuComponent

 dispose(). Method in interface java.awt.peer. ComponentPeer

 dispose(). Method in class java.awt.Frame

 Disposes of the Frame.

dispose(). Method in class java.awt.Graphics

 Dispose of the system resources used by this graphics context.

dispose(). Method in interface java.awt.peer.MenuComponentPeer

 dispose(). Method in class java.awt.Window

 Disposes of the Window.

divide(BigDecimal, int). Method in class java.math.BigDecimal

 Returns a BigDecimal whose value is (this / val), and whose scale  is this.scale().

divide(BigDecimal, int, int). Method in class java.math.BigDecimal

 Returns a BigDecimal whose value is (this / val), and whose scale  is as specified.

divide(BigInteger). Method in class java.math.BigInteger

 Returns a BigInteger whose value is (this / val).

divideAndRemainder(BigInteger). Method in class java.math.BigInteger

 Returns an array of two BigIntegers.

doesMaxRowSizeIncludeBlobs(). Method in interface java.sql.DatabaseMetaData

 Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY  blobs?

doInput. Variable in class java.net.URLConnection

 This variable is set by the setDoInput method.

doLayout(). Method in class java.awt.Component

 Lays out the component.

doLayout(). Method in class java.awt.Container

 Does a layout on this Container.

doLayout(). Method in class java.awt.ScrollPane

 Lays out this container by resizing its child to its preferred size.

DONE. Static variable in class java.text.BreakIterator

 DONE is returned by previous() and next() after all valid  boundaries have been returned.

DONE. Static variable in interface java.text.CharacterIterator

 Constant that is returned when the iterator has reached either the end  or the beginning of the text.

done(). Method in interface java.rmi.server.RemoteCall

 Allow cleanup after the remote call has completed.

done(RemoteCall). Method in interface java.rmi.server.RemoteRef

 Allows the remote reference to clean up (or reuse) the connection.

dontUseGui(). Method in interface java.beans.Visibility

 This method instructs the bean that it should not use the Gui.

doOutput. Variable in class java.net.URLConnection

 This variable is set by the setDoOutput method.

DOUBLE. Static variable in class java.sql.Types

 Double(double). Constructor for class java.lang. Double

 Constructs a newly allocated Double object that  represents the primitive double argument.

Double(String). Constructor for class java.lang.Double

 Constructs a newly allocated Double object that  represents the floating- point value of type double  represented by the string.

doubleToLongBits(double). Static method in class java.lang.Double

 Returns a representation of the specified floating-point value  according to the IEEE 754 floating-point "double  format" bit layout.

doubleValue(). Method in class java.math.BigDecimal

 Converts the number to a double.

doubleValue(). Method in class java.math.BigInteger

 Converts the number to a double.

doubleValue(). Method in class java.lang.Byte

 Returns the value of this Byte as a double.

doubleValue(). Method in class java.lang.Double

 Returns the double value of this Double.

doubleValue(). Method in class java.lang.Float

 Returns the double value of this Float.

doubleValue(). Method in class java.lang.Integer

 Returns the value of this Integer as a double.

doubleValue(). Method in class java.lang.Long

 Returns the value of this Long as a double.

doubleValue(). Method in class java.lang.Number

 Returns the value of the specified number as a double.

doubleValue(). Method in class java.lang.Short

 Returns the value of this Short as a double.

DOWN. Static variable in class java.awt.Event

 The down arrow action-key.

down(int). Method in class sun.tools.debug.RemoteThread

 Change the current stackframe to be one or more frames lower  (as in, toward the current program counter).

drain(). Method in class java.io.ObjectOutputStream

 Drain any buffered data in ObjectOutputStream.

draw3DRect(int, int, int, int, boolean). Method in class java.awt.Graphics

 Draws a 3-D highlighted outline of the specified rectangle.

drawArc(int, int, int, int, int, int). Method in class java.awt.Graphics

 Draws the outline of an arc covering the specified rectangle,  starting at startAngle and extending for arcAngle degrees,  using the current color.

drawBytes(byte[], int, int, int, int). Method in class java.awt.Graphics

 Draws the specified bytes using the current font and color.

drawChars(char[], int, int, int, int). Method in class java.awt.Graphics

 Draws the specified characters using the current font and color.

drawImage(Image, int, int, Color, ImageObserver). Method in class java.awt. Graphics

 Draws as much of the specified image as is currently available at  the specified coordinate (x, y) with the given solid background color.

drawImage(Image, int, int, ImageObserver). Method in class java.awt.Graphics

 Draws as much of the specified image as is currently available at  the specified coordinate (x, y).

drawImage(Image, int, int, int, int, Color, ImageObserver). Method in class java.awt.Graphics

 Draws as much of the specified image as has already been scaled  to fit inside the specified rectangle with the given solid  background color.

drawImage(Image, int, int, int, int, ImageObserver). Method in class java.awt. Graphics

 Draws as much of the specified image as has already been scaled  to fit inside the specified rectangle.

drawImage (Image, int, int, int, int, int, int, int, int, Color, ImageObserver). Method in class java.awt. Graphics

 Draws as much of the specified area of the specified image as is  currently available, scaling it on the fly to fit inside the  specified area of the destination drawable surface with the  given solid background color.

drawImage(Image, int, int, int, int, int, int, int, int, ImageObserver). Method in class java.awt.Graphics

 Draws as much of the specified area of the specified image as is  currently available, scaling it on the fly to fit inside the  specified area of the destination drawable surface.

drawLine(int, int, int, int). Method in class java.awt.Graphics

 Draws a line between the coordinates (x1,y1) and (x2,y2) using  the current color.

drawOval(int, int, int, int). Method in class java.awt.Graphics

 Draws the outline of an oval covering the specified rectangle  using the current color.

drawPolygon(int[], int[], int). Method in class java.awt.Graphics

 Draws the outline of a polygon defined by arrays of x coordinates  and y coordinates using the current color.

drawPolygon(Polygon). Method in class java.awt.Graphics

 Draws the outline of a polygon defined by the specified Polygon  object using the current color.

drawPolyline(int[], int[], int). Method in class java.awt.Graphics

 Draws a sequence of connected lines defined by arrays of x coordinates  and y coordinates using the current color.

drawRect(int, int, int, int). Method in class java.awt.Graphics

 Draws the outline of the specified rectangle using the current  color.

drawRoundRect(int, int, int, int, int, int). Method in class java.awt.Graphics

 Draws the outline of the specified rounded corner rectangle  using the current color.

drawString(String, int, int). Method in class java.awt.Graphics

 Draws the specified String using the current font and color.

DriverPropertyInfo(String, String). Constructor for class java.sql. DriverPropertyInfo

 Constructor a DriverPropertyInfo with a name and value; other  members default to their initial values.

DST_OFFSET. Static variable in class java.util.Calendar

 Useful constant for date and time.

dumpStack(). Method in class sun.tools.debug.RemoteThread

 Dump the stack.

dumpStack(). Static method in class java.lang.Thread

 Prints a stack trace of the current thread.

______________________________________________________________________________

  E

E. Static variable in class java.lang.Math

 The double value that is closer than any other to  e , the base of the natural logarithms.

E_RESIZE_CURSOR. Static variable in class java.awt.Cursor

 The east-resize cursor type.

E_RESIZE_CURSOR. Static variable in class java.awt.Frame

 EAST. Static variable in class java.awt.BorderLayout

 The east layout constraint.

EAST. Static variable in class java.awt.GridBagConstraints

 echoCharIsSet(). Method in class java.awt.TextField

 Returns true if this TextField has a character set for  echoing.

elementAt(int). Method in class java.util.Vector

 Returns the component at the specified index.

elementCount. Variable in class java.util.Vector

 The number of valid components in the vector.

elementData. Variable in class java.util.Vector

 The array buffer into which the components of the vector are  stored.

elements(). Method in class java.util.Dictionary

 Returns an enumeration of the values in this dictionary.

elements(). Method in class java.util.Hashtable

 Returns an enumeration of the values in this hashtable.

elements(). Method in class java.util.Vector

 Returns an enumeration of the components of this vector.

empty(). Method in class java.util.Stack

 Tests if this stack is empty.

EmptyStackException(). Constructor for class java.util.EmptyStackException

 Constructs a new EmptyStackException with no detail message.

enable(). Static method in class java.lang.Compiler

 Cause the Compiler to resume operation.

enable(). Method in class java.awt.Component

 enable(). Method in interface java.awt.peer. ComponentPeer

 DEPRECATED: Replaced by setEnabled(boolean).

enable(). Method in class java.awt.MenuItem

 enable(). Method in interface java.awt.peer. MenuItemPeer

 DEPRECATED: Replaced by setEnabled(boolean).

enable(boolean). Method in class java.awt.Component

 enable(boolean). Method in class java.awt.MenuItem

 enableEvents(long). Method in class java.awt. Component

 Enables the events defined by the specified event mask parameter  to be delivered to this component.

enableEvents(long). Method in class java.awt.MenuItem

 Enables the events defined by the specified event mask parameter  to be delivered to this menu item.

enableReplaceObject(boolean). Method in class java.io.ObjectOutputStream

 Enable the stream to do replacement of objects in the stream.

enableResolveObject(boolean). Method in class java.io.ObjectInputStream

 Enable the stream to allow objects read from the stream to be replaced.

ENCLOSING_MARK. Static variable in class java.lang.Character

 encode(OutputStream). Method in interface java.security.Certificate

 Encodes the certificate to an output stream in a format that can  be decoded by the decode method.

encode(String). Static method in class java.net.URLEncoder

 Translates a string into x-www-form-urlencoded format.

END. Static variable in class java.awt.Event

 The end action-key.

end(). Method in class java.util.zip.Deflater

 Discards unprocessed input and frees internal data.

end(). Method in class java.util.zip.Inflater

 Discards unprocessed input and frees internal data.

end(). Method in class java.awt.PrintJob

 Ends the print job and does any necessary cleanup.

END_PUNCTUATION. Static variable in class java.lang.Character

 endsWith(String). Method in class java.lang.String

 Tests if this string ends with the specified suffix.

endValidate(). Method in interface java.awt.peer.ContainerPeer

 engineDigest(). Method in class java.security. MessageDigest

SPI: Completes the hash computation by performing final  operations such as padding.

engineGetParameter(String). Method in class java.security.Signature

SPI: Gets the value of the specified algorithm parameter.

engineInitSign(PrivateKey). Method in class java.security.Signature

SPI: Initializes this signature object with the specified  private key for signing operations.

engineInitVerify(PublicKey). Method in class java.security.Signature

SPI: Initializes this signature object with the specified  public key for verification operations.

engineReset(). Method in class java.security.MessageDigest

SPI: Resets the digest for further use.

engineSetParameter(String, Object). Method in class java.security.Signature

SPI: Sets the specified algorithm parameter to the specified  value.

engineSign(). Method in class java.security.Signature

SPI: Returns the signature bytes of all the data  updated so far.

engineUpdate(byte). Method in class java.security.MessageDigest

SPI: Updates the digest using the specified byte.

engineUpdate(byte). Method in class java.security.Signature

SPI: Updates the data to be signed or verified  using the specified byte.

engineUpdate(byte[], int, int). Method in class java.security.MessageDigest

SPI: Updates the digest using the specified array of bytes,  starting at the specified offset.

engineUpdate(byte[], int, int). Method in class java.security.Signature

SPI: Updates the data to be signed or verified, using the  specified array of bytes, starting at the specified offset.

engineVerify(byte[]). Method in class java.security.Signature

SPI: Verifies the passed-in signature.

ENGLISH. Static variable in class java.util.Locale

 Useful constant for language.

ensureCapacity(int). Method in class java.lang.StringBuffer

 Ensures that the capacity of the buffer is at least equal to the  specified minimum.

ensureCapacity(int). Method in class java.util.Vector

 Increases the capacity of this vector, if necessary, to ensure  that it can hold at least the number of components specified by  the minimum capacity argument.

ENTER. Static variable in class java.awt.Event

 The Enter key.

entries(). Method in interface java.security.acl.Acl

 Returns an enumeration of the entries in this ACL.

entries(). Method in class java.util.zip.ZipFile

 Returns an enumeration of the ZIP file entries.

enumerate(Thread[]). Static method in class java.lang.Thread

 Copies into the specified array every active thread in this  thread group and its subgroups.

enumerate(Thread[]). Method in class java.lang.ThreadGroup

 Copies into the specified array every active thread in this  thread group and its subgroups.

enumerate(Thread[], boolean). Method in class java.lang.ThreadGroup

 Copies into the specified array every active thread in this  thread group.

enumerate(ThreadGroup[]). Method in class java.lang.ThreadGroup

 Copies into the specified array references to every active  subgroup in this thread group.

enumerate(ThreadGroup[], boolean). Method in class java.lang.ThreadGroup

 Copies into the specified array references to every active  subgroup in this thread group.

eof. Variable in class java.io.OptionalDataException

 True if there is not more data in the buffered part of the stream.

EOFException(). Constructor for class java.io.EOFException

 Constructs an EOFException with no detail message.

EOFException(String). Constructor for class java.io.EOFException

 Constructs an EOFException with the specified detail  message.

eolIsSignificant(boolean). Method in class java.io.StreamTokenizer

 Determines whether or not ends of line are treated as tokens.

eos. Variable in class java.util.zip.GZIPInputStream

 Indicates end of input stream.

equals(DataFlavor). Method in class java.awt.datatransfer.DataFlavor

 equals(MenuShortcut). Method in class java.awt. MenuShortcut

 Returns whether this MenuShortcut is the same as another:  equality is defined to mean that both MenuShortcuts use the same key  and both either use or don't use the SHIFT key.

equals(Object). Method in class java.math.BigDecimal

 Returns true iff x is a BigDecimal whose value is equal to this number.

equals(Object). Method in class java.math.BigInteger

 Returns true iff x is a BigInteger whose value is equal to this number.

equals(Object). Method in class java.util.BitSet

 Compares this object against the specified object.

equals(Object). Method in class java.lang.Boolean

 Returns true if and only if the argument is not  null and is a Boolean object that  contains the same boolean value as this object.

equals(Object). Method in class java.lang.Byte

 Compares this object to the specified object.

equals(Object). Method in class java.util.Calendar

 Compares the time field records.

equals(Object). Method in class java.lang.Character

 Compares this object against the specified object.

equals(Object). Method in class java.text.ChoiceFormat

 Equality comparision between two

equals(Object). Method in class java.text.CollationKey

 Compare this CollationKey and the target CollationKey for equality.

equals(Object). Method in class java.text.Collator

 Compares the equality of two Collators.

equals(Object). Method in class java.awt.Color

 Compares this object against the specified object.

equals(Object). Method in class java.lang.reflect.Constructor

 Compares this Constructor against the specified object.

equals(Object). Method in class java.util.Date

 Compares two dates.

equals(Object). Method in class java.text.DateFormat

 Overrides equals

equals(Object). Method in class java.text.DateFormatSymbols

 Override equals

equals(Object). Method in class java.text.DecimalFormat

 Overrides equals

equals(Object). Method in class java.text.DecimalFormatSymbols

 Override equals

equals(Object). Method in class java.awt.Dimension

 Checks whether two dimension objects have equal values.

equals(Object). Method in class java.lang.Double

 Compares this object against the specified object.

equals(Object). Method in class java.lang.reflect.Field

 Compares this Field against the specified object.

equals(Object). Method in class java.io.File

 Compares this object against the specified object.

equals(Object). Method in class java.lang.Float

 Compares this object against some other object.

equals(Object). Method in class java.awt.Font

 Compares this object to the specifed object.

equals(Object). Method in class java.util.GregorianCalendar

 Overrides Calendar  Compares the time field records.

equals(Object). Method in class java.security.Identity

 Tests for equality between the specified object and this identity.

equals(Object). Method in class java.net.InetAddress

 Compares this object against the specified object.

equals(Object). Method in class java.awt.Insets

 Checks whether two insets objects are equal.

equals(Object). Method in class java.lang.Integer

 Compares this object to the specified object.

equals(Object). Method in class java.util.Locale

 Compares two Objects for equality.

equals(Object). Method in class java.lang.Long

 Compares this object against the specified object.

equals(Object). Method in class java.text.MessageFormat

 Equality comparision between two message format objects

equals(Object). Method in class java.lang.reflect.Method

 Compares this Method against the specified object.

equals(Object). Method in class java.text.NumberFormat

 Overrides equals

equals(Object). Method in class java.lang.Object

 Compares two Objects for equality.

equals(Object). Method in class java.rmi.server.ObjID

 Two object identifiers are considered equal if they have the  same contents.

equals(Object). Method in interface java.security.acl.Permission

 Returns true if the object passed matches the permission represented  in this interface.

equals(Object). Method in class java.awt.Point

 Checks whether two pointers are equal.

equals(Object). Method in interface java.security.Principal

 Compares this principal to the specified object.

equals(Object). Method in class java.awt.Rectangle

 Checks whether two rectangles are equal.

equals(Object). Method in class java.rmi.server.RemoteObject

 Compares two remote objects for equality.

equals(Object). Method in class java.text.RuleBasedCollator

 Compares the equality of two collation objects.

equals(Object). Method in class java.lang.Short

 Compares this object to the specified object.

equals(Object). Method in class java.text.SimpleDateFormat

 Override equals.

equals(Object). Method in class java.util.SimpleTimeZone

 Compares the equality of two SimpleTimeZone objects.

equals(Object). Method in class java.lang.String

 Compares this string to the specified object.

equals(Object). Method in class java.text.StringCharacterIterator

 Compares the equality of two StringCharacterIterator objects.

equals(Object). Method in class java.rmi.server.UID

 Compares two Objects for equality.

equals(Object). Method in class java.net.URL

 Compares two URLs.

equals(Object). Method in class java.rmi.dgc.VMID

 Compare this VMID to another, and return true if they are the  same identifier.

equals(String, String). Method in class java.text.Collator

 Convenience method for comparing the equality of two strings based on  this Collator's collation rules.

equals(Timestamp). Method in class java.sql.Timestamp

 Test Timestamp values for equality

equalsIgnoreCase(String). Method in class java.lang.String

 Compares this String to another object.

ERA. Static variable in class java.util.Calendar

 Useful constant for date and time.

ERA_FIELD. Static variable in class java.text.DateFormat

 Useful constant for ERA field alignment.

err. Static variable in class java.io.FileDescriptor

 A handle to the standard error stream.

err. Static variable in class java.lang.System

 The "standard" error output stream.

ERROR. Static variable in interface java.awt.image.ImageObserver

 An image which was being tracked asynchronously has encountered  an error.

Error(). Constructor for class java.lang.Error

 Constructs an Error with no specified detail message.

Error(String). Constructor for class java.lang.Error

 Constructs an Error with the specified detail message.

ERRORED. Static variable in class java.awt.MediaTracker

 Flag indicating the download of some media encountered an error.

ESCAPE. Static variable in class java.awt.Event

 The Escape key.

Event(Object, int, Object). Constructor for class java.awt.Event

 Constructs an event with the specified target component,  event type, and argument.

Event(Object, long, int, int, int, int, int). Constructor for class java.awt. Event

 Constructs an event with the specified target component, time stamp,  event type, x and y coordinates, keyboard key, state of the modifier  keys and an argument set to null.

Event(Object, long, int, int, int, int, int, Object). Constructor for class java.awt.Event

 Constructs an event with the specified target component, time stamp,  event type, x and y coordinates, keyboard key, state of the modifier  keys and argument.

EventObject(Object). Constructor for class java.util.EventObject

 EventObject(Object). Constructor for class sunw.util. EventObject

 EventQueue(). Constructor for class java.awt. EventQueue

 EventSetDescriptor(Class, String, Class, String). Constructor for class java.beans.EventSetDescriptor

 This constructor creates an EventSetDescriptor assuming that you are  following the most simple standard design pattern where a named  event "fred" is (1) delivered as a call on the single method of  interface FredListener, (2) has a single argument of type FredEvent,  and (3) where the FredListener may be registered with a call on an  addFredListener method of the source component and removed with a  call on a removeFredListener method.

EventSetDescriptor(Class, String, Class, String[], String, String). Constructor for class java.beans.EventSetDescriptor

 This constructor creates an EventSetDescriptor from scratch using  string names.

EventSetDescriptor(String, Class, Method[], Method, Method). Constructor for class java.beans.EventSetDescriptor

 This constructor creates an EventSetDescriptor from scratch using  java.lang.reflect.Method and java.lang.Class objects.

EventSetDescriptor(String, Class, MethodDescriptor[], Method, Method). Constructor for class java.beans.EventSetDescriptor

 This constructor creates an EventSetDescriptor from scratch using  java.lang.reflect.MethodDescriptor and java.lang.Class objects.

evt. Variable in class java.awt.Event

 The next event.

Exception(). Constructor for class java.lang.Exception

 Constructs an Exception with no specified detail message.

Exception(String). Constructor for class java.lang.Exception

 Constructs an Exception with the specified detail message.

exceptionEvent(RemoteThread, String). Method in interface sun.tools.debug. DebuggerCallback

 An exception has occurred.

ExceptionInInitializerError(). Constructor for class java.lang. ExceptionInInitializerError

 Constructs an ExceptionInInitializerError with no detail message.

ExceptionInInitializerError(String). Constructor for class java.lang. ExceptionInInitializerError

 Constructs a ExceptionInInitializerError with the specified detail message.

ExceptionInInitializerError(Throwable). Constructor for class java.lang. ExceptionInInitializerError

 Constructs a new ExceptionInInitializerError class initialized to  the specific throwable

exec(String). Method in class java.lang.Runtime

 Executes the specified string command in a separate process.

exec(String, String[]). Method in class java.lang.Runtime

 Executes the specified string command in a separate process with the  specified environment.

exec(String[]). Method in class java.lang.Runtime

 Executes the specified command and arguments in a separate process.

exec(String[], String[]). Method in class java.lang.Runtime

 Executes the specified command and arguments in a separate process  with the specified environment.

execute(). Method in interface java.sql.PreparedStatement

 Some prepared statements return multiple results; the execute  method handles these complex statements as well as the simpler  form of statements handled by executeQuery and executeUpdate.

execute(String). Method in interface java.sql.Statement

 Execute a SQL statement that may return multiple results.

executeCall(). Method in interface java.rmi.server.RemoteCall

 Do whatever it takes to execute the call.

executeQuery(). Method in interface java.sql.PreparedStatement

 A prepared SQL query is executed and its ResultSet is returned.

executeQuery(String). Method in interface java.sql.Statement

 Execute a SQL statement that returns a single ResultSet.

executeUpdate(). Method in interface java.sql.PreparedStatement

 Execute a SQL INSERT, UPDATE or DELETE statement.

executeUpdate(String). Method in interface java.sql.Statement

 Execute a SQL INSERT, UPDATE or DELETE statement.

exists(). Method in class java.io.File

 Tests if this File exists.

exit(int). Method in class java.lang.Runtime

 Terminates the currently running Java Virtual Machine.

exit(int). Static method in class java.lang.System

 Terminates the currently running Java Virtual Machine.

exitValue(). Method in class java.lang.Process

 Returns the exit value for the subprocess.

exp(double). Static method in class java.lang.Math

 Returns the exponential number e (i.e., 2.718...) raised to  the power of a double value.

ExportException(String). Constructor for class java.rmi.server.ExportException

 Create A remote exception with the specified string

ExportException(String, Exception). Constructor for class java.rmi.server. ExportException

 Create A remote exception with the specified string, and the  exception specified.

exportObject(Remote). Static method in class java.rmi.server. UnicastRemoteObject

 Export the remote object to make it available to receive incoming calls.

exportObject(Remote, Object). Method in interface java.rmi.server.ServerRef

 Find or create a client stub object for the supplied Remote.

______________________________________________________________________________

  F

F1. Static variable in class java.awt.Event

 The F1 function action-key.

F10. Static variable in class java.awt.Event

 The F10 function action-key.

F11. Static variable in class java.awt.Event

 The F11 function action-key.

F12. Static variable in class java.awt.Event

 The F12 function action-key.

F2. Static variable in class java.awt.Event

 The F2 function action-key.

F3. Static variable in class java.awt.Event

 The F3 function action-key.

F4. Static variable in class java.awt.Event

 The F4 function action-key.

F5. Static variable in class java.awt.Event

 The F5 function action-key.

F6. Static variable in class java.awt.Event

 The F6 function action-key.

F7. Static variable in class java.awt.Event

 The F7 function action-key.

F8. Static variable in class java.awt.Event

 The F8 function action-key.

F9. Static variable in class java.awt.Event

 The F9 function action-key.

failure(Exception). Method in interface java.rmi.server.RMIFailureHandler

 The "failure" callback is invoked when the RMI runtime is  unable to create a Socket or ServerSocket via the  RMISocketFactory.

FALSE. Static variable in class java.lang.Boolean

 The Boolean object corresponding to the primitive  value false.

fd. Variable in class java.net.DatagramSocketImpl

 The file descriptor object

fd. Variable in class java.net.SocketImpl

 The file descriptor object for this socket.

FeatureDescriptor(). Constructor for class java.beans.FeatureDescriptor

 FEBRUARY. Static variable in class java.util. Calendar

 Useful constant for month.

FIELD_COUNT. Static variable in class java.util.Calendar

 Useful constant for date and time.

FieldPosition(int). Constructor for class java.text.FieldPosition

 Creates a FieldPosition object for the given field.

fields. Variable in class java.util.Calendar

 The time fields containing values into which the millis is computed.

File(File, String). Constructor for class java.io.File

 Creates a File instance that represents the file  with the specified name in the specified directory.

File(String). Constructor for class java.io.File

 Creates a File instance that represents the file  whose pathname is the given path argument.

File(String, String). Constructor for class java.io.File

 Creates a File instance whose pathname is the  pathname of the specified directory, followed by the separator  character, followed by the name argument.

FileDescriptor(). Constructor for class java.io.FileDescriptor

 FileDialog(Frame). Constructor for class java.awt. FileDialog

 Creates a file dialog for loading a file.

FileDialog(Frame, String). Constructor for class java.awt.FileDialog

 Creates a file dialog for loading a file.

FileDialog(Frame, String, int). Constructor for class java.awt.FileDialog

 Creates a file dialog with the specified title and mode.

FileInputStream(File). Constructor for class java.io.FileInputStream

 Creates an input file stream to read from the specified  File object.

FileInputStream(FileDescriptor). Constructor for class java.io.FileInputStream

 Creates an input file stream to read from the specified file descriptor.

FileInputStream(String). Constructor for class java.io.FileInputStream

 Creates an input file stream to read from a file with the  specified name.

fileNameMap. Static variable in class java.net.URLConnection

 FileNotFoundException(). Constructor for class java.io.FileNotFoundException

 Constructs a FileNotFoundException with no detail message.

FileNotFoundException(String). Constructor for class java.io. FileNotFoundException

 Constructs a FileNotFoundException with the  specified detail message.

FileOutputStream(File). Constructor for class java.io.FileOutputStream

 Creates a file output stream to write to the specified  File object.

FileOutputStream(FileDescriptor). Constructor for class java.io. FileOutputStream

 Creates an output file stream to write to the specified file descriptor.

FileOutputStream(String). Constructor for class java.io.FileOutputStream

 Creates an output file stream to write to the file with the  specified name.

FileOutputStream(String, boolean). Constructor for class java.io. FileOutputStream

 Creates an output file with the specified system dependent  file name.

FileReader(File). Constructor for class java.io.FileReader

 FileReader(FileDescriptor). Constructor for class java.io.FileReader

 FileReader(String). Constructor for class java.io. FileReader

 FileWriter(File). Constructor for class java.io. FileWriter

 FileWriter(FileDescriptor). Constructor for class java.io.FileWriter

 FileWriter(String). Constructor for class java.io. FileWriter

 FileWriter(String, boolean). Constructor for class java.io.FileWriter

 fill. Variable in class java.awt.GridBagConstraints

 fill(). Method in class java.util.zip. InflaterInputStream

 Fills input buffer with more data to decompress.

fill3DRect(int, int, int, int, boolean). Method in class java.awt.Graphics

 Paints a 3-D highlighted rectangle filled with the current color.

fillArc(int, int, int, int, int, int). Method in class java.awt.Graphics

 Fills an arc bounded by the specified rectangle, starting at  startAngle and extending for arcAngle degrees, with the  current color.

fillInStackTrace(). Method in class java.lang.Throwable

 Fills in the execution stack trace.

fillOval(int, int, int, int). Method in class java.awt.Graphics

 Fills an oval bounded by the specified rectangle with the  current color.

fillPolygon(int[], int[], int). Method in class java.awt.Graphics

 Fills a polygon defined by arrays of x coordinates and y  coordinates with the current color using an even-odd fill  rule (otherwise known as an alternating rule).

fillPolygon(Polygon). Method in class java.awt.Graphics

 Fills the polygon defined by the specified Polygon object with  the current color using an even-odd fill rule (otherwise known  as an alternating rule).

fillRect(int, int, int, int). Method in class java.awt.Graphics

 Fills the specified rectangle with the current color.

fillRoundRect(int, int, int, int, int, int). Method in class java.awt.Graphics

 Fills the specified rounded corner rectangle with the current color.

FILTERED. Static variable in class java.util.zip.Deflater

 Compression strategy best used for data consisting mostly of small  values with a somewhat random distribution.

FilteredImageSource(ImageProducer, ImageFilter). Constructor for class java.awt.image.FilteredImageSource

 Constructs an ImageProducer object from an existing ImageProducer  and a filter object.

filterIndexColorModel(IndexColorModel). Method in class java.awt.image. RGBImageFilter

 Filters an IndexColorModel object by running each entry in its  color tables through the filterRGB function that RGBImageFilter  subclasses must provide.

FilterInputStream(InputStream). Constructor for class java.io.FilterInputStream

 Creates an input stream filter built on top of the specified  input stream.

FilterOutputStream(OutputStream). Constructor for class java.io. FilterOutputStream

 Creates an output stream filter built on top of the specified  underlying output stream.

FilterReader(Reader). Constructor for class java.io.FilterReader

 Create a new filtered reader.

filterRGB(int, int, int). Method in class java.awt.image.RGBImageFilter

 Subclasses must specify a method to convert a single input pixel  in the default RGB ColorModel to a single output pixel.

filterRGBPixels(int, int, int, int, int[], int, int). Method in class java.awt.image.RGBImageFilter

 Filters a buffer of pixels in the default RGB ColorModel by passing  them one by one through the filterRGB method.

FilterWriter(Writer). Constructor for class java.io.FilterWriter

 Create a new filtered writer.

FINAL. Static variable in class java.lang.reflect.Modifier

 finalize(). Method in class java.awt.image.ColorModel

 Called by the garbage collector on an object when garbage collection  determines that there are no more references to the object.

finalize(). Method in class java.util.zip.Deflater

 Frees the compressor when garbage is collected.

finalize(). Method in class java.io.FileInputStream

 Ensures that the close method of this file input stream is  called when there are no more references to it.

finalize(). Method in class java.io.FileOutputStream

 Ensures that the close method of this file output stream is  called when there are no more references to this stream.

finalize(). Method in class java.awt.Graphics

 Disposes of this graphics context once it is no longer referenced.

finalize(). Method in class java.util.zip.Inflater

 Frees the decompressor when garbage is collected.

finalize(). Method in class java.lang.Object

 Called by the garbage collector on an object when garbage collection  determines that there are no more references to the object.

finalize(). Method in class java.awt.PrintJob

 Ends this print job once it is no longer referenced.

finalize(). Method in class sun.tools.debug.RemoteObject

 findClass(String). Method in class sun.tools.debug. RemoteDebugger

 Find a specified class.

findColumn(String). Method in interface java.sql.ResultSet

 Map a Resultset column name to a ResultSet column index.

findEditor(Class). Static method in class java.beans.PropertyEditorManager

 Locate a value editor for a given target type.

findLoadedClass(String). Method in class java.lang.ClassLoader

 findSystemClass(String). Method in class java.lang. ClassLoader

 Finds the system class with the specified name, loading it in if  necessary.

finish(). Method in class java.util.zip.Deflater

 When called, indicates that compression should end with the current  contents of the input buffer.

finish(). Method in class java.util.zip.DeflaterOutputStream

 Finishes writing compressed data to the output stream without closing  the underlying stream.

finish(). Method in class java.util.zip.GZIPOutputStream

 Finishes writing compressed data to the output stream without closing  the underlying stream.

finish(). Method in class java.util.zip.ZipOutputStream

 Finishes writing the contents of the ZIP output stream without closing  the underlying stream.

finished(). Method in class java.util.zip.Deflater

 Returns true if the end of the compressed data output stream has  been reached.

finished(). Method in class java.util.zip.Inflater

 Return true if the end of the compressed data stream has been  reached.

firePropertyChange(). Method in class java.beans.PropertyEditorSupport

 Report that we have been modified to any interested listeners.

firePropertyChange(String, Object, Object). Method in class java.beans. PropertyChangeSupport

 Report a bound property update to any registered listeners.

fireVetoableChange(String, Object, Object). Method in class java.beans. VetoableChangeSupport

 Report a vetoable property update to any registered listeners.

first(). Method in class java.text.BreakIterator

 Return the first boundary.

first(). Method in interface java.text.CharacterIterator

 Set the position to getBeginIndex() and return the character at that  position.

first(). Method in class java.text.StringCharacterIterator

 Set the position to getBeginIndex() and return the character at that  position.

first(Container). Method in class java.awt.CardLayout

 Flip to the first card.

firstElement(). Method in class java.util.Vector

 Returns the first component of this vector.

flipBit(int). Method in class java.math.BigInteger

 Returns a BigInteger whose value is equivalent to this number  with the designated bit flipped.

FLOAT. Static variable in class java.sql.Types

 Float(double). Constructor for class java.lang.Float

 Constructs a newly allocated Floatobject that  represents the argument converted to type float.

Float(float). Constructor for class java.lang.Float

 Constructs a newly allocated Float object that  represents the primitive float argument.

Float(String). Constructor for class java.lang.Float

 Constructs a newly allocated Float object that  represents the floating- point value of type float  represented by the string.

floatToIntBits(float). Static method in class java.lang.Float

 Returns the bit represention of a single-float value.

floatValue(). Method in class java.math.BigDecimal

 Converts this number to a float.

floatValue(). Method in class java.math.BigInteger

 Converts this number to a float.

floatValue(). Method in class java.lang.Byte

 Returns the value of this Byte as a float.

floatValue(). Method in class java.lang.Double

 Returns the float value of this Double.

floatValue(). Method in class java.lang.Float

 Returns the float value of this Float object.

floatValue(). Method in class java.lang.Integer

 Returns the value of this Integer as a float.

floatValue(). Method in class java.lang.Long

 Returns the value of this Long as a float.

floatValue(). Method in class java.lang.Number

 Returns the value of the specified number as a float.

floatValue(). Method in class java.lang.Short

 Returns the value of this Short as a float.

floor(double). Static method in class java.lang.Math

 Returns the largest (closest to positive infinity)  double  value that is not greater than the argument and  is equal to a mathematical integer.

FlowLayout(). Constructor for class java.awt.FlowLayout

 Constructs a new Flow Layout with a centered alignment and a  default 5-unit horizontal and vertical gap.

FlowLayout(int). Constructor for class java.awt.FlowLayout

 Constructs a new Flow Layout with the specified alignment and a  default 5-unit horizontal and vertical gap.

FlowLayout(int, int, int). Constructor for class java.awt.FlowLayout

 Constructs a new Flow Layout with the specified alignment and gap  values.

flush(). Method in class java.io.BufferedOutputStream

 Flushes this buffered output stream.

flush(). Method in class java.io.BufferedWriter

 Flush the stream.

flush(). Method in class java.io.CharArrayWriter

 Flush the stream.

flush(). Method in class java.io.DataOutputStream

 Flushes this data output stream.

flush(). Method in class java.io.FilterOutputStream

 Flushes this output stream and forces any buffered output bytes  to be written out to the stream.

flush(). Method in class java.io.FilterWriter

 Flush the stream.

flush(). Method in class java.awt.Image

 Flushes all resources being used by this Image object.

flush(). Method in interface java.io.ObjectOutput

 Flushes the stream.

flush(). Method in class java.io.ObjectOutputStream

 Flushes the stream.

flush(). Method in class java.io.OutputStream

 Flushes this output stream and forces any buffered output bytes  to be written out.

flush(). Method in class java.io.OutputStreamWriter

 Flush the stream.

flush(). Method in class java.io.PipedOutputStream

 Flushes this output stream and forces any buffered output bytes  to be written out.

flush(). Method in class java.io.PipedWriter

 Flush the stream.

flush(). Method in class java.io.PrintStream

 Flushes this print stream.

flush(). Method in class java.io.PrintWriter

 Flush the stream.

flush(). Method in class java.io.StringWriter

 Flush the stream.

flush(). Method in class java.io.Writer

 Flush the stream.

FOCUS_EVENT_MASK. Static variable in class java.awt.AWTEvent

 The event mask for selecting focus events.

FOCUS_FIRST. Static variable in class java.awt.event.FocusEvent

 Marks the first integer id for the range of focus event ids.

FOCUS_GAINED. Static variable in class java.awt.event.FocusEvent

 The focus gained event type.

FOCUS_LAST. Static variable in class java.awt.event.FocusEvent

 Marks the last integer id for the range of focus event ids.

FOCUS_LOST. Static variable in class java.awt.event.FocusEvent

 The focus lost event type.

FocusAdapter(). Constructor for class java.awt.event.FocusAdapter

 FocusEvent(Component, int). Constructor for class java.awt.event.FocusEvent

 Constructs a permanent-level FocusEvent object with the  specified source component and type.

FocusEvent(Component, int, boolean). Constructor for class java.awt.event. FocusEvent

 Constructs a FocusEvent object with the specified source component,  type, and whether or not the focus event is a temporary level event.

focusGained(FocusEvent). Method in class java.awt.AWTEventMulticaster

 Handles the focusGained event by invoking the  focusGained methods on listener-a and listener-b.

focusGained(FocusEvent). Method in class java.awt.event.FocusAdapter

 focusGained(FocusEvent). Method in interface java.awt.event.FocusListener

 Invoked when a component gains the keyboard focus.

focusLost(FocusEvent). Method in class java.awt.AWTEventMulticaster

 Handles the focusLost event by invoking the  focusLost methods on listener-a and listener-b.

focusLost(FocusEvent). Method in class java.awt.event.FocusAdapter

 focusLost(FocusEvent). Method in interface java.awt.event.FocusListener

 Invoked when a component loses the keyboard focus.

following(int). Method in class java.text.BreakIterator

 Return the first boundary following the specified offset.

font. Variable in class java.awt.FontMetrics

 The actual font.

Font(String, int, int). Constructor for class java.awt.Font

 Creates a new font with the specified name, style and point size.

FontMetrics(Font). Constructor for class java.awt.FontMetrics

 Creates a new FontMetrics object with the specified font.

forClass(). Method in class java.io.ObjectStreamClass

 Return the class in the local VM that this version is mapped to.

forDigit(int, int). Static method in class java.lang.Character

 Determines the character representation for a specific digit in  the specified radix.

FORMAT. Static variable in class java.lang.Character

 Format(). Constructor for class java.text.Format

 format(Date). Method in class java.text.DateFormat

 Formats a Date into a date/time string.

format(Date, StringBuffer, FieldPosition). Method in class java.text. DateFormat

 Formats a Date into a date/time string.

format(Date, StringBuffer, FieldPosition). Method in class java.text. SimpleDateFormat

 Overrides DateFormat

Formats a date or time, which is the standard millis  since 24:00 GMT, Jan 1, 1970.

format(double). Method in class java.text.NumberFormat

 Specialization of format.

format(double, StringBuffer, FieldPosition). Method in class java.text. ChoiceFormat

 Specialization of format.

format(double, StringBuffer, FieldPosition). Method in class java.text. DecimalFormat

 Specialization of format.

format(double, StringBuffer, FieldPosition). Method in class java.text. NumberFormat

 Specialization of format.

format(long). Method in class java.text.NumberFormat

 Specialization of format.

format(long, StringBuffer, FieldPosition). Method in class java.text. ChoiceFormat

 Specialization of format.

format(long, StringBuffer, FieldPosition). Method in class java.text. DecimalFormat

 Specialization of format.

format(long, StringBuffer, FieldPosition). Method in class java.text. NumberFormat

 Specialization of format.

format(Object). Method in class java.text.Format

 Formats an object to produce a string.

format(Object, StringBuffer, FieldPosition). Method in class java.text. DateFormat

 Overrides Format.

format(Object, StringBuffer, FieldPosition). Method in class java.text.Format

 Formats an object to produce a string.

format(Object, StringBuffer, FieldPosition). Method in class java.text. MessageFormat

 Formats an object to produce a string.

format(Object, StringBuffer, FieldPosition). Method in class java.text. NumberFormat

 Formats an object to produce a string.

format(Object[], StringBuffer, FieldPosition). Method in class java.text. MessageFormat

 Returns pattern with formatted objects.

format(String, Object[]). Static method in class java.text.MessageFormat

 Convenience routine.

FormatException(String, int). Constructor for class java.text.FormatException

 Constructs a FormatException with the specified detail message and  offset.

forName(String). Static method in class java.lang.Class

 Returns the Class object associated with the class  with the given string name.

FRACTION_FIELD. Static variable in class java.text.NumberFormat

 Field constant used to construct a FieldPosition object.

Frame(). Constructor for class java.awt.Frame

 Constructs a new Frame that is initially invisible.

Frame(String). Constructor for class java.awt.Frame

 Constructs a new, initially invisible Frame with the specified  title.

FRAMEBITS. Static variable in interface java.awt.image.ImageObserver

 Another complete frame of a multi-frame image which was previously  drawn is now available to be drawn again.

FRANCE. Static variable in class java.util.Locale

 Useful constant for country.

freeMemory(). Method in class sun.tools.debug.RemoteDebugger

 Report the free memory available to the Java interpreter being debugged.

freeMemory(). Method in class java.lang.Runtime

 Returns the amount of free memory in the system.

FRENCH. Static variable in class java.util.Locale

 Useful constant for language.

FRIDAY. Static variable in class java.util.Calendar

 Useful constant for days of week.

fromHex(String). Static method in class sun.tools.debug.RemoteValue

 Convert hexadecimal strings to ints.

FULL. Static variable in class java.text.DateFormat

 Constant for full style pattern.

FULL_DECOMPOSITION. Static variable in class java.text.Collator

 Decomposition mode value.

______________________________________________________________________________

  G

gc(). Method in class java.lang.Runtime

 Runs the garbage collector.

gc(). Static method in class java.lang.System

 Runs the garbage collector.

gc(RemoteObject[]). Method in class sun.tools.debug.RemoteDebugger

 Free all objects referenced by the debugger.

gcd(BigInteger). Method in class java.math.BigInteger

 Returns a BigInteger whose value is the greatest common denominator  of abs(this) and abs(val).

generateKeyPair(). Method in class java.security.KeyPairGenerator

 Generates a key pair.

GERMAN. Static variable in class java.util.Locale

 Useful constant for language.

GERMANY. Static variable in class java.util.Locale

 Useful constant for country.

get(). Method in class sun.tools.debug.RemoteBoolean

 Return the boolean's value.

get(). Method in class sun.tools.debug.RemoteByte

 Return the byte's value.

get(). Method in class sun.tools.debug.RemoteChar

 Return the char's value.

get(). Method in class sun.tools.debug.RemoteDouble

 Return the double's value.

get(). Method in class sun.tools.debug.RemoteFloat

 Return the float's value.

get(). Method in class sun.tools.debug.RemoteInt

 Return the int's value.

get(). Method in class sun.tools.debug.RemoteLong

 Return the long's value.

get(). Method in class sun.tools.debug.RemoteShort

 Return the short's value.

get(int). Method in class java.util.BitSet

 Returns the value of the bit with the specified index.

get(int). Method in class java.util.Calendar

 Gets the value for a given time field.

get(Integer). Method in class sun.tools.debug.RemoteDebugger

 Get an object from the remote object cache.

get(Object). Method in class java.util.Dictionary

 Returns the value to which the key is mapped in this dictionary.

get(Object). Method in class java.lang.reflect.Field

 Returns the value of the field represented by this Field, on  the specified object.

get(Object). Method in class java.util.Hashtable

 Returns the value to which the specified key is mapped in this hashtable.

get(Object, int). Static method in class java.lang.reflect.Array

 Returns the value of the indexed component in the specified  array object.

getAbsolutePath(). Method in class java.io.File

 Returns the absolute pathname of the file represented by this object.

getActionCommand(). Method in class java.awt.event.ActionEvent

 Returns the command name associated with this action.

getActionCommand(). Method in class java.awt.Button

 Returns the command name of the action event fired by this button.

getActionCommand(). Method in class java.awt.MenuItem

 Returns the command name of the action event fired by this menu item.

getAdditionalBeanInfo(). Method in interface java.beans.BeanInfo

 This method allows a BeanInfo object to return an arbitrary collection  of other BeanInfo objects that provide additional information on the  current bean.

getAdditionalBeanInfo(). Method in class java.beans.SimpleBeanInfo

 Claim there are no other relevant BeanInfo objects.

getAddListenerMethod(). Method in class java.beans.EventSetDescriptor

 getAddress(). Method in class java.net.DatagramPacket

 Returns the IP address of the machine to which this datagram is being  sent or from which the datagram was received.

getAddress(). Method in class java.net.InetAddress

 Returns the raw IP address of this InetAddress  object.

getAdjustable(). Method in class java.awt.event.AdjustmentEvent

 Returns the Adjustable object where this event originated.

getAdjustmentType(). Method in class java.awt.event.AdjustmentEvent

 Returns the type of adjustment which caused the value changed  event.

getAdler(). Method in class java.util.zip.Deflater

 Returns the ADLER-32 value of the uncompressed data.

getAdler(). Method in class java.util.zip.Inflater

 Returns the ADLER-32 value of the uncompressed data.

getAlgorithm(). Method in interface java.security.Key

 Returns the standard algorithm name this key is for.

getAlgorithm(). Method in class java.security.KeyPairGenerator

 Returns the standard name of the algorithm for this key generator.

getAlgorithm(). Method in class java.security.MessageDigest

 Returns a string that identifies the algorithm, independent of  implementation details.

getAlgorithm(). Method in class java.security.Signature

 Returns the name of the algorithm for this signature object.

getAlgorithmProperty(String, String). Static method in class java.security. Security

 Gets a specified property for an algorithm.

getAlignment(). Method in class java.awt.FlowLayout

 Returns the alignment value for this layout, one of LEFT,  CENTER, or RIGHT.

getAlignment(). Method in class java.awt.Label

 Gets the current alignment of this label.

getAlignmentX(). Method in class java.awt.Component

 Returns the alignment along the x axis.

getAlignmentX(). Method in class java.awt.Container

 Returns the alignment along the x axis.

getAlignmentY(). Method in class java.awt.Component

 Returns the alignment along the y axis.

getAlignmentY(). Method in class java.awt.Container

 Returns the alignment along the y axis.

getAllByName(String). Static method in class java.net.InetAddress

 Determines all the IP addresses of a host, given the host's name.

getAllowUserInteraction(). Method in class java.net.URLConnection

 Returns the value of the allowUserInteraction field for  this object.

getAlpha(int). Method in class java.awt.image.ColorModel

 The subclass must provide a function which provides the alpha  color compoment for the specified pixel.

getAlpha(int). Method in class java.awt.image.DirectColorModel

 Return the alpha transparency value for the specified pixel in the  range 0-255.

getAlpha(int). Method in class java.awt.image.IndexColorModel

 Returns the alpha transparency value for the specified pixel in the  range 0-255.

getAlphaMask(). Method in class java.awt.image.DirectColorModel

 Returns the mask indicating which bits in a pixel contain the alpha  transparency component.

getAlphas(byte[]). Method in class java.awt.image.IndexColorModel

 Copies the array of alpha transparency values into the given array.

getAmPmStrings(). Method in class java.text.DateFormatSymbols

 Gets ampm strings.

getApplet(String). Method in interface java.applet.AppletContext

 Finds and returns the applet in the document represented by this  applet context with the given name.

getAppletContext(). Method in class java.applet.Applet

 Determines this applet's context, which allows the applet to  query and affect the environment in which it runs.

getAppletContext(). Method in interface java.applet.AppletStub

 Gets a handler to the applet's context.

getAppletInfo(). Method in class java.applet.Applet

 Returns information about this applet.

getApplets(). Method in interface java.applet.AppletContext

 Finds all the applets in the document represented by this applet  context.

getAscent(). Method in class java.awt.FontMetrics

 Gets the font ascent.

getAsciiStream(int). Method in interface java.sql.ResultSet

 A column value can be retrieved as a stream of ASCII characters  and then read in chunks from the stream.

getAsciiStream(String). Method in interface java.sql.ResultSet

 A column value can be retrieved as a stream of ASCII characters  and then read in chunks from the stream.

getAsText(). Method in interface java.beans.PropertyEditor

 getAsText(). Method in class java.beans. PropertyEditorSupport

 getAudioClip(URL). Method in class java.applet.Applet

 Returns the AudioClip object specified by the  URL argument.

getAudioClip(URL). Method in interface java.applet.AppletContext

 Creates an audio clip.

getAudioClip(URL, String). Method in class java.applet.Applet

 Returns the AudioClip object specified by the  URL and name  arguments.

getAutoCommit(). Method in interface java.sql.Connection

 Get the current auto-commit state.

getAvailableIDs(). Static method in class java.util.TimeZone

 Gets all the available IDs supported.

getAvailableIDs(int). Static method in class java.util.TimeZone

 Gets the available IDs according to the given time zone offset.

getAvailableLocales(). Static method in class java.text.BreakIterator

 Get the set of Locales for which TextBoundaries are installed

getAvailableLocales(). Static method in class java.util.Calendar

 Gets the set of locales for which Calendars are installed.

getAvailableLocales(). Static method in class java.text.Collator

 Get the set of Locales for which Collators are installed.

getAvailableLocales(). Static method in class java.text.DateFormat

 Gets the set of locales for which DateFormats are installed.

getAvailableLocales(). Static method in class java.text.NumberFormat

 Get the set of Locales for which NumberFormats are installed

getBackground(). Method in class java.awt.Component

 Gets the background color.

getBeanClass(). Method in class java.beans.BeanDescriptor

 getBeanDescriptor(). Method in interface java.beans. BeanInfo

 getBeanDescriptor(). Method in class java.beans. SimpleBeanInfo

 Deny knowledge about the class and customizer of the bean.

getBeanInfo(Class). Static method in class java.beans.Introspector

 Introspect on a Java bean and learn about all its properties, exposed  methods, and events.

getBeanInfo(Class, Class). Static method in class java.beans.Introspector

 Introspect on a Java bean and learn all about its properties, exposed  methods, below a given "stop" point.

getBeanInfoSearchPath(). Static method in class java.beans.Introspector

 getBeginIndex(). Method in interface java.text. CharacterIterator

 Return the start index of the text.

getBeginIndex(). Method in class java.text.FieldPosition

 Retrieve the index of the first character in the requested field.

getBeginIndex(). Method in class java.text.StringCharacterIterator

 Return the start index of the text.

getBestRowIdentifier(String, String, String, int, boolean). Method in interface java.sql.DatabaseMetaData

 Get a description of a table's optimal set of columns that  uniquely identifies a row.

getBigDecimal(int, int). Method in interface java.sql.CallableStatement

 Get the value of a NUMERIC parameter as a java.math.BigDecimal object.

getBigDecimal(int, int). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a java.lang.BigDecimal object.

getBigDecimal(String, int). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a java.lang.BigDecimal object.

getBinaryStream(int). Method in interface java.sql.ResultSet

 A column value can be retrieved as a stream of uninterpreted bytes  and then read in chunks from the stream.

getBinaryStream(String). Method in interface java.sql.ResultSet

 A column value can be retrieved as a stream of uninterpreted bytes  and then read in chunks from the stream.

getBlockIncrement(). Method in interface java.awt.Adjustable

 Gets the block value increment for the adjustable object.

getBlockIncrement(). Method in class java.awt.Scrollbar

 Gets the block increment for this scrollbar.

getBlue(). Method in class java.awt.Color

 Gets the blue component.

getBlue(int). Method in class java.awt.image.ColorModel

 The subclass must provide a function which provides the blue  color compoment for the specified pixel.

getBlue(int). Method in class java.awt.image.DirectColorModel

 Returns the blue color compoment for the specified pixel in the  range 0-255.

getBlue(int). Method in class java.awt.image.IndexColorModel

 Returns the blue color compoment for the specified pixel in the  range 0-255.

getBlueMask(). Method in class java.awt.image.DirectColorModel

 Returns the mask indicating which bits in a pixel contain the blue  color component.

getBlues(byte[]). Method in class java.awt.image.IndexColorModel

 Copies the array of blue color components into the given array.

getBoolean(int). Method in interface java.sql.CallableStatement

 Get the value of a BIT parameter as a Java boolean.

getBoolean(int). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a Java boolean.

getBoolean(Object). Method in class java.lang.reflect.Field

 Get the value of a field as a boolean on specified object.

getBoolean(Object, int). Static method in class java.lang.reflect.Array

 Returns the value of the indexed component in the specified  array object, as a boolean.

getBoolean(String). Static method in class java.lang.Boolean

 Returns is true if and only if the system property  named by the argument exists and is equal to the string  "true".

getBoolean(String). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a Java boolean.

getBoundingBox(). Method in class java.awt.Polygon

 getBounds(). Method in class java.awt.Component

 Returns the current bounds of this component.

getBounds(). Method in class java.awt.Polygon

 Returns the bounding box of the shape.

getBounds(). Method in class java.awt.Rectangle

 Returns the bounds of this rectangle.

getBounds(). Method in interface java.awt.Shape

 Return the bounding box of the shape.

getBuffer(). Method in class java.io.StringWriter

 Return the string buffer itself.

getBundle(String). Static method in class java.util.ResourceBundle

 Get the appropriate ResourceBundle subclass.

getBundle(String, Locale). Static method in class java.util.ResourceBundle

 Get the appropriate ResourceBundle subclass.

getByName(String). Static method in class java.net.InetAddress

 Determines the IP address of a host, given the host's name.

getByte(int). Method in interface java.sql.CallableStatement

 Get the value of a TINYINT parameter as a Java byte.

getByte(int). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a Java byte.

getByte(Object). Method in class java.lang.reflect.Field

 Get the value of a field as a byte on specified object.

getByte(Object, int). Static method in class java.lang.reflect.Array

 Returns the value of the indexed component in the specified  array object, as a byte.

getByte(String). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a Java byte.

getBytes(). Method in class java.lang.String

 Convert this String into bytes according to the platform's default  character encoding, storing the result into a new byte array.

getBytes(int). Method in interface java.sql.CallableStatement

 Get the value of a SQL BINARY or VARBINARY parameter as a Java byte[]

getBytes(int). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a Java byte array.

getBytes(int, int, byte[], int). Method in class java.lang.String

 Copies characters from this string into the destination byte  array.

getBytes(String). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a Java byte array.

getBytes(String). Method in class java.lang.String

 Convert this String into bytes according to the specified character  encoding, storing the result into a new byte array.

getCalendar(). Method in class java.text.DateFormat

 Gets the calendar associated with this date/time formatter.

getCanonicalPath(). Method in class java.io.File

 Gets the official, canonical path of the File.

getCaretPosition(). Method in class java.awt.TextComponent

 Returns the position of the text insertion caret for the  text component.

getCaretPosition(). Method in interface java.awt.peer.TextComponentPeer

 getCatalog(). Method in interface java.sql.Connection

 Return the Connection's current catalog name.

getCatalogName(int). Method in interface java.sql.ResultSetMetaData

 What's a column's table's catalog name?

getCatalogs(). Method in interface java.sql.DatabaseMetaData

 Get the catalog names available in this database.

getCatalogSeparator(). Method in interface java.sql.DatabaseMetaData

 What's the separator between catalog and table name?

getCatalogTerm(). Method in interface java.sql.DatabaseMetaData

 What's the database vendor's preferred term for "catalog"?

getChar(Object). Method in class java.lang.reflect.Field

 Get the value of a field as a char on specified object.

getChar(Object, int). Static method in class java.lang.reflect.Array

 Returns the value of the indexed component in the specified  array object, as a char.

getCharacterInstance(). Static method in class java.text.BreakIterator

 Create BreakIterator for character-breaks using default locale  Returns an instance of a BreakIterator implementing character breaks.

getCharacterInstance(Locale). Static method in class java.text.BreakIterator

 Create BreakIterator for character-breaks using specified locale  Returns an instance of a BreakIterator implementing character breaks.

getChars(int, int, char[], int). Method in class java.lang.String

 Copies characters from this string into the destination character array.

getChars(int, int, char[], int). Method in class java.lang.StringBuffer

 Characters are copied from this string buffer into the  destination character array dst .

getCheckboxGroup(). Method in class java.awt.Checkbox

 Returns the checkbox group.

getChecksum(). Method in class java.util.zip.CheckedInputStream

 Returns the Checksum for this input stream.

getChecksum(). Method in class java.util.zip.CheckedOutputStream

 Returns the Checksum for this output stream.

getChild(). Method in class java.awt.event.ContainerEvent

 Returns the child component that was added or removed in  this event.

getClass(). Method in class java.lang.Object

 Returns the runtime class of an object.

getClassContext(). Method in class java.lang.SecurityManager

 Returns the current execution stack as an array of classes.

getClasses(). Method in class java.lang.Class

 Returns an array containing Class objects representing all the  public classes and interfaces that are members of the class  represented by this Class object.

getClassLoader(). Method in class java.lang.Class

 Determines the class loader for the class.

getClassLoader(). Method in class sun.tools.debug.RemoteClass

 Return the classloader for this class.

getClassName(). Method in class java.util.MissingResourceException

 Gets parameter passed by constructor.

getClazz(). Method in class sun.tools.debug.RemoteObject

 Returns the object's class.

getClickCount(). Method in class java.awt.event.MouseEvent

 Return the number of mouse clicks associated with this event.

getClientHost(). Static method in class java.rmi.server.RemoteServer

 Return the hostname of the current client.

getClientHost(). Method in interface java.rmi.server.ServerRef

 Return the hostname of the current client.

getClip(). Method in class java.awt.Graphics

 Return a Shape object representing the current clipping area.

getClipBounds(). Method in class java.awt.Graphics

 Returns the bounding rectangle of the current clipping area.

getClipRect(). Method in class java.awt.Graphics

 getCodeBase(). Method in class java.applet.Applet

 Gets the base URL.

getCodeBase(). Method in interface java.applet.AppletStub

 Gets the base URL.

getCollationElementIterator(String). Method in class java.text. RuleBasedCollator

 Return a CollationElementIterator for the given String.

getCollationKey(String). Method in class java.text.Collator

 Transforms the String into a series of bits that can be compared bitwise  to other CollationKeys.

getCollationKey(String). Method in class java.text.RuleBasedCollator

 Transforms the string into a series of characters that can be compared  with CollationKey.compareTo.

getColor(). Method in class java.awt.Graphics

 Gets the current color.

getColor(String). Static method in class java.awt.Color

 Gets the specified Color property.

getColor(String, Color). Static method in class java.awt.Color

 Gets the specified Color property of the specified Color.

getColor(String, int). Static method in class java.awt.Color

 Gets the specified Color property of the color value.

getColorModel(). Method in class java.awt.Component

 Gets the ColorModel used to display the component on the output device.

getColorModel(). Method in interface java.awt.peer.ComponentPeer

 getColorModel(). Method in class java.awt.image. PixelGrabber

 Get the ColorModel for the pixels stored in the array.

getColorModel(). Method in class java.awt.Toolkit

 Returns the ColorModel of the screen.

getColumnCount(). Method in interface java.sql.ResultSetMetaData

 What's the number of columns in the ResultSet?

getColumnDisplaySize(int). Method in interface java.sql.ResultSetMetaData

 What's the column's normal max width in chars?

getColumnLabel(int). Method in interface java.sql.ResultSetMetaData

 What's the suggested column title for use in printouts and  displays?

getColumnName(int). Method in interface java.sql.ResultSetMetaData

 What's a column's name?

getColumnPrivileges(String, String, String, String). Method in interface java.sql.DatabaseMetaData

 Get a description of the access rights for a table's columns.

getColumns(). Method in class java.awt.GridLayout

 Returns the number of columns in this layout.

getColumns(). Method in class java.awt.TextArea

 Returns the number of columns in the TextArea.

getColumns(). Method in class java.awt.TextField

 Returns the number of columns in this TextField.

getColumns(String, String, String, String). Method in interface java.sql. DatabaseMetaData

 Get a description of table columns available in a catalog.

getColumnType(int). Method in interface java.sql.ResultSetMetaData

 What's a column's SQL type?

getColumnTypeName(int). Method in interface java.sql.ResultSetMetaData

 What's a column's data source specific type name?

getComment(). Method in class java.util.zip.ZipEntry

 Returns the comment string for the entry, or null if none.

getComponent(). Method in class java.awt.event.ComponentEvent

 Returns the component where this event originated.

getComponent(int). Method in class java.awt.Container

 Gets the nth component in this container.

getComponentAt(int, int). Method in class java.awt.Component

 Returns the component or subcomponent that contains the x,y location.

getComponentAt(int, int). Method in class java.awt.Container

 Locates the component that contains the x,y position.

getComponentAt(Point). Method in class java.awt.Component

 Returns the component or subcomponent that contains the  specified point.

getComponentAt(Point). Method in class java.awt.Container

 Locates the component that contains the specified point.

getComponentCount(). Method in class java.awt.Container

 Returns the number of components in this panel.

getComponents(). Method in class java.awt.Container

 Gets all the components in this container.

getComponentType(). Method in class java.lang.Class

 If this class represents an array type, returns the Class  object representing the component type of the array; otherwise  returns null.

getCompressedSize(). Method in class java.util.zip.ZipEntry

 Returns the compressed size of the entry data, or -1 if not known.

getConnection(String). Static method in class java.sql.DriverManager

 Attempt to establish a connection to the given database URL.

getConnection(String, Properties). Static method in class java.sql. DriverManager

 Attempt to establish a connection to the given database URL.

getConnection(String, String, String). Static method in class java.sql. DriverManager

 Attempt to establish a connection to the given database URL.

getConstraints(Component). Method in class java.awt.GridBagLayout

 Retrieves the constraints for the specified component.

getConstructor(Class[]). Method in class java.lang.Class

 Returns a Constructor object that reflects the specified public  constructor of the class represented by this Class object.

getConstructors(). Method in class java.lang.Class

 Returns an array containing Constructor objects reflecting  all the public constructors of the class represented by this  Class object.

getContainer(). Method in class java.awt.event.ContainerEvent

 Returns the container where this event originated.

getContent(). Method in class java.net.URL

 Returns the contents of this URL.

getContent(). Method in class java.net.URLConnection

 Retrieves the contents of this URL connection.

getContent(URLConnection). Method in class java.net.ContentHandler

 Given a URL connect stream positioned at the beginning of the  representation of an object, this method reads that stream and  creates an object from it.

getContentEncoding(). Method in class java.net.URLConnection

 Returns the value of the content-encoding header field.

getContentLength(). Method in class java.net.URLConnection

 Returns the value of the content-length header field.

getContents(). Method in class java.util.ListResourceBundle

 See class description.

getContents(Object). Method in class java.awt.datatransfer.Clipboard

 Returns a transferable object representing the current contents  of the clipboard.

getContentType(). Method in class java.net.URLConnection

 Returns the value of the content-type header field.

getContentTypeFor(String). Method in interface java.net.FileNameMap

 getCountry(). Method in class java.util.Locale

 Getter for programmatic name of field,  an uppercased two-letter ISO-3166 code.

getCrc(). Method in class java.util.zip.ZipEntry

 Returns the CRC-32 checksum of the uncompressed entry data, or -1 if  not known.

getCrossReference(String, String, String, String, String, String). Method in interface java.sql.DatabaseMetaData

 Get a description of the foreign key columns in the foreign key  table that reference the primary key columns of the primary key  table (describe how one table imports another's key.) This  should normally return a single foreign key/primary key pair  (most tables only import a foreign key from a table once.) They  are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and  KEY_SEQ.

getCurrencyInstance(). Static method in class java.text.NumberFormat

 Returns a currency format for the current default locale.

getCurrencyInstance(Locale). Static method in class java.text.NumberFormat

 Returns a currency format for the specified locale.

getCurrent(). Method in class java.awt.CheckboxGroup

 getCurrentFrame(). Method in class sun.tools.debug. RemoteThread

 Get the current stack frame.

getCurrentFrameIndex(). Method in class sun.tools.debug.RemoteThread

 Return the current stackframe index

getCursor(). Method in class java.awt.Component

 Gets the cursor set on this component.

getCursorName(). Method in interface java.sql.ResultSet

 Get the name of the SQL cursor used by this ResultSet.

getCursorType(). Method in class java.awt.Frame

 getCustomEditor(). Method in interface java.beans. PropertyEditor

 A PropertyEditor may choose to make available a full custom Component  that edits its property value.

getCustomEditor(). Method in class java.beans.PropertyEditorSupport

 A PropertyEditor may chose to make available a full custom Component  that edits its property value.

getCustomizerClass(). Method in class java.beans.BeanDescriptor

 getData(). Method in class java.net.DatagramPacket

 Returns the data received or the data to be sent.

getDatabaseProductName(). Method in interface java.sql.DatabaseMetaData

 What's the name of this database product?

getDatabaseProductVersion(). Method in interface java.sql.DatabaseMetaData

 What's the version of this database product?

getDataSize(). Method in class java.sql.DataTruncation

 Get the number of bytes of data that should have been transferred.

getDate(). Method in class java.util.Date

 Returns the day of the month represented by this date.

getDate(). Method in class java.sql.Time

 Returns the day of the month represented by this date.

getDate(). Method in class java.net.URLConnection

 Returns the value of the date header field.

getDate(int). Method in interface java.sql.CallableStatement

 Get the value of a SQL DATE parameter as a java.sql.Date object

getDate(int). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a java.sql.Date object.

getDate(String). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a java.sql.Date object.

getDateFormatSymbols(). Method in class java.text.SimpleDateFormat

 Gets the date/time formatting data.

getDateInstance(). Static method in class java.text.DateFormat

 Gets the date formatter with the default formatting style  for the default locale.

getDateInstance(int). Static method in class java.text.DateFormat

 Gets the date formatter with the given formatting style  for the default locale.

getDateInstance(int, Locale). Static method in class java.text.DateFormat

 Gets the date formatter with the given formatting style  for the given locale.

getDateTimeInstance(). Static method in class java.text.DateFormat

 Gets the date/time formatter with the default formatting style  for the default locale.

getDateTimeInstance(int, int). Static method in class java.text.DateFormat

 Gets the date/time formatter with the given date and time  formatting styles for the default locale.

getDateTimeInstance(int, int, Locale). Static method in class java.text. DateFormat

 Gets the date/time formatter with the given formatting styles  for the given locale.

getDay(). Method in class java.util.Date

 Returns the day of the week represented by this date.

getDay(). Method in class java.sql.Time

 Returns the day of the week represented by this date.

getDecimalFormatSymbols(). Method in class java.text.DecimalFormat

 Returns the decimal format symbols, which is generally not changed  by the programmer or user.

getDecimalSeparator(). Method in class java.text.DecimalFormatSymbols

 character used for decimal sign.

getDeclaredClasses(). Method in class java.lang.Class

 Returns an array of Class objects reflecting all the classes  and interfaces declared as members of the class represented by  this Class object.

getDeclaredConstructor(Class[]). Method in class java.lang.Class

 Returns a Constructor object that reflects the specified declared  constructor of the class or interface represented by this Class  object.

getDeclaredConstructors(). Method in class java.lang.Class

 Returns an array of Constructor objects reflecting all the  constructors declared by the class represented by this Class  object.

getDeclaredField(String). Method in class java.lang.Class

 Returns a Field object that reflects the specified declared  field of the class or interface represented by this Class  object.

getDeclaredFields(). Method in class java.lang.Class

 Returns an array of Field objects reflecting all the fields  declared by the class or interface represented by this Class  object.

getDeclaredMethod(String, Class[]). Method in class java.lang.Class

 Returns a Method object that reflects the specified declared  method of the class or interface represented by this Class  object.

getDeclaredMethods(). Method in class java.lang.Class

 Returns an array of Method objects reflecting all the methods  declared by the class or interface represented by this Class  object.

getDeclaringClass(). Method in class java.lang.Class

 If the class or interface represented by this Class object is  a member of another class, returns the Class object  representing the class of which it is a member (its  declaring class).

getDeclaringClass(). Method in class java.lang.reflect.Constructor

 Returns the Class object representing the class that declares  the constructor represented by this Constructor object.

getDeclaringClass(). Method in class java.lang.reflect.Field

 Returns the Class object representing the class or interface  that declares the field represented by this Field object.

getDeclaringClass(). Method in interface java.lang.reflect.Member

 Returns the Class object representing the class or interface  that declares the member or constructor represented by this Member.

getDeclaringClass(). Method in class java.lang.reflect.Method

 Returns the Class object representing the class or interface  that declares the method represented by this Method object.

getDecomposition(). Method in class java.text.Collator

 Get the decomposition mode of this Collator.

getDefault(). Static method in class java.util.Locale

 Common method of getting the current default Locale.

getDefault(). Static method in class java.util.TimeZone

 Gets the default TimeZone for this host.

getDefaultAllowUserInteraction(). Static method in class java.net. URLConnection

 Returns the default value of the allowUserInteraction  field.

getDefaultCursor(). Static method in class java.awt.Cursor

 Return the system default cursor.

getDefaultEventIndex(). Method in interface java.beans.BeanInfo

 A bean may have a "default" event that is the event that will  mostly commonly be used by human's when using the bean.

getDefaultEventIndex(). Method in class java.beans.SimpleBeanInfo

 Deny knowledge of a default event.

getDefaultPropertyIndex(). Method in interface java.beans.BeanInfo

 A bean may have a "default" property that is the property that will  mostly commonly be initially chosen for update by human's who are  customizing the bean.

getDefaultPropertyIndex(). Method in class java.beans.SimpleBeanInfo

 Deny knowledge of a default property.

getDefaultRequestProperty(String). Static method in class java.net. URLConnection

 Returns the value of the default request property.

getDefaultStream(). Static method in class java.rmi.server.LogStream

 Return the current default stream for new logs.

getDefaultToolkit(). Static method in class java.awt.Toolkit

 Returns the default toolkit.

getDefaultTransactionIsolation(). Method in interface java.sql. DatabaseMetaData

 What's the database's default transaction isolation level? The  values are defined in java.sql.Connection.

getDefaultUseCaches(). Method in class java.net.URLConnection

 Returns the default value of a URLConnection's  useCaches flag.

getDescent(). Method in class java.awt.FontMetrics

 Gets the font descent.

getDigit(). Method in class java.text.DecimalFormatSymbols

 character used for a digit in a pattern.

getDirectory(). Method in class java.awt.FileDialog

 Gets the directory of the Dialog.

getDisplayCountry(). Method in class java.util.Locale

 Getter for display of field to user.

getDisplayCountry(Locale). Method in class java.util.Locale

 Getter for display of field to user.

getDisplayLanguage(). Method in class java.util.Locale

 Getter for display of field to user.

getDisplayLanguage(Locale). Method in class java.util.Locale

 Getter for display of field to user.

getDisplayName(). Method in class java.beans.FeatureDescriptor

 getDisplayName(). Method in class java.util.Locale

 Getter for display of the entire locale to user.

getDisplayName(Locale). Method in class java.util.Locale

 Getter for display of the entire locale to user.

getDisplayVariant(). Method in class java.util.Locale

 Getter for display of field to user.

getDisplayVariant(Locale). Method in class java.util.Locale

 Getter for display of field to user  If the localized name is not found, returns the variant code.

getDocumentBase(). Method in class java.applet.Applet

 Gets the document URL.

getDocumentBase(). Method in interface java.applet.AppletStub

 Gets the document URL.

getDoInput(). Method in class java.net.URLConnection

 Returns the value of this URLConnection's  doInput flag.

getDoOutput(). Method in class java.net.URLConnection

 Returns the value of this URLConnection's  doOutput flag.

getDouble(int). Method in interface java.sql.CallableStatement

 Get the value of a DOUBLE parameter as a Java double.

getDouble(int). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a Java double.

getDouble(Object). Method in class java.lang.reflect.Field

 Get the value of a field as a double on specified object.

getDouble(Object, int). Static method in class java.lang.reflect.Array

 Returns the value of the indexed component in the specified  array object, as a double.

getDouble(String). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a Java double.

getDriver(String). Static method in class java.sql.DriverManager

 Attempt to locate a driver that understands the given URL.

getDriverMajorVersion(). Method in interface java.sql.DatabaseMetaData

 What's this JDBC driver's major version number?

getDriverMinorVersion(). Method in interface java.sql.DatabaseMetaData

 What's this JDBC driver's minor version number?

getDriverName(). Method in interface java.sql.DatabaseMetaData

 What's the name of this JDBC driver?

getDrivers(). Static method in class java.sql.DriverManager

 Return an Enumeration of all the currently loaded JDBC drivers  which the current caller has access to.

getDriverVersion(). Method in interface java.sql.DatabaseMetaData

 What's the version of this JDBC driver?

getEchoChar(). Method in class java.awt.TextField

 Returns the character to be used for echoing.

getEditorSearchPath(). Static method in class java.beans.PropertyEditorManager

 getElement(int). Method in class sun.tools.debug. RemoteArray

 Return an array element.

getElements(). Method in class sun.tools.debug.RemoteArray

 Returns a copy of the array as instances of RemoteValue.

getElements(int, int). Method in class sun.tools.debug.RemoteArray

 Returns a copy of a portion of the array as instances of RemoteValue.

getElementType(). Method in class sun.tools.debug.RemoteArray

 Return the element type as a "TC_" constant, such as "TC_CHAR".

getEncoded(). Method in interface java.security.Key

 Returns the encoded key.

getEncoding(). Method in class java.io.InputStreamReader

 Return the name of the encoding being used by this stream.

getEncoding(). Method in class java.io.OutputStreamWriter

 Return the name of the encoding being used by this stream.

getEndIndex(). Method in interface java.text.CharacterIterator

 Return the end index of the text.

getEndIndex(). Method in class java.text.FieldPosition

 Retrieve the index of the character following the last character in the  requested field.

getEndIndex(). Method in class java.text.StringCharacterIterator

 Return the end index of the text.

getEntry(String). Method in class java.util.zip.ZipFile

 Returns the ZIP file entry for the given path name.

getenv(String). Static method in class java.lang.System

 Gets an environment variable.

getEras(). Method in class java.text.DateFormatSymbols

 Gets era strings.

getErrorCode(). Method in class java.sql.SQLException

 Get the vendor specific exception code

getErrorOffset(). Method in class java.text.FormatException

 Returns the position where the error was found.

getErrorOffset(). Method in class java.text.ParseException

 Returns the position where the error was found.

getErrorsAny(). Method in class java.awt.MediaTracker

 Returns a list of all media that have encountered an error.

getErrorsID(int). Method in class java.awt.MediaTracker

 Returns a list of media with the specified ID that have encountered  an error.

getErrorStream(). Method in class java.lang.Process

 Gets the error stream of the subprocess.

getEventSetDescriptors(). Method in interface java.beans.BeanInfo

 getEventSetDescriptors(). Method in class java.beans. SimpleBeanInfo

 Deny knowledge of event sets.

getException(). Method in class java.lang.ExceptionInInitializerError

 Returns the exception that occurred during a static initialization that  caused this Error to be created.

getExceptionCatchList(). Method in class sun.tools.debug.RemoteDebugger

 Return the list of the exceptions the debugger will stop on.

getExceptionTypes(). Method in class java.lang.reflect.Constructor

 Returns an array of Class objects that represent the types of  the checked exceptions thrown by the underlying constructor  represented by this Constructor object.

getExceptionTypes(). Method in class java.lang.reflect.Method

 Returns an array of Class objects that represent the types of  the checked exceptions thrown by the underlying method  represented by this Method object.

getExpiration(). Method in class java.net.URLConnection

 Returns the value of the expires header field.

getExportedKeys(String, String, String). Method in interface java.sql. DatabaseMetaData

 Get a description of the foreign key columns that reference a  table's primary key columns (the foreign keys exported by a  table).

getExtra(). Method in class java.util.zip.ZipEntry

 Returns the extra field data for the entry, or null if none.

getExtraNameCharacters(). Method in interface java.sql.DatabaseMetaData

 Get all the "extra" characters that can be used in unquoted  identifier names (those beyond a-z, A-Z, 0-9 and _).

getFailureHandler(). Static method in class java.rmi.server.RMISocketFactory

 Returns the handler for socket creation failure.

getFamily(). Method in class java.awt.Font

 Gets the platform specific family name of the font.

getFD(). Method in class java.io.FileInputStream

 Returns the opaque file descriptor object associated with this stream.

getFD(). Method in class java.io.FileOutputStream

 Returns the file descriptor associated with this stream.

getFD(). Method in class java.io.RandomAccessFile

 Returns the opaque file descriptor object associated with this stream.

getField(). Method in class java.text.FieldPosition

 Retrieve the field identifier.

getField(int). Method in class sun.tools.debug.RemoteClass

 Return the static field, specified by index.

getField(int). Method in class sun.tools.debug.RemoteObject

 Return an instance variable, specified by slot number.

getField(String). Method in class java.lang.Class

 Returns a Field object that reflects the specified public  member field of the class or interface represented by  this Class object.

getField(String). Method in class sun.tools.debug.RemoteClass

 Return the static field, specified by name.

getField(String). Method in class sun.tools.debug.RemoteObject

 Return an instance variable, specified by name.

getFields(). Method in class java.lang.Class

 Returns an array containing Field objects reflecting all the  accessible public fields of the class or interface represented  by this Class object.

getFields(). Method in class sun.tools.debug.RemoteClass

 Return all the static fields for this class.

getFields(). Method in class sun.tools.debug.RemoteObject

 Return the instance (non-static) fields of an object.

getFieldValue(int). Method in class sun.tools.debug.RemoteClass

 Return the value of a static field, specified by its index.

getFieldValue(int). Method in class sun.tools.debug.RemoteObject

 Returns the value of an object's instance variable.

getFieldValue(String). Method in class sun.tools.debug.RemoteClass

 Return the value of a static field, specified by name.

getFieldValue(String). Method in class sun.tools.debug.RemoteObject

 Returns the value of an object's instance variable.

getFile(). Method in class java.awt.FileDialog

 Gets the file of the Dialog.

getFile(). Method in class java.net.URL

 Returns the file name of this URL.

getFileDescriptor(). Method in class java.net.DatagramSocketImpl

 Get the datagram socket file descriptor

getFileDescriptor(). Method in class java.net.SocketImpl

 Returns the value of this socket's fd field.

getFilenameFilter(). Method in class java.awt.FileDialog

 Gets the filter.

getFilePointer(). Method in class java.io.RandomAccessFile

 Returns the current offset in this file.

getFilterInstance(ImageConsumer). Method in class java.awt.image.ImageFilter

 Returns a unique instance of an ImageFilter object which will  actually perform the filtering for the specified ImageConsumer.

getFirstDayOfWeek(). Method in class java.util.Calendar

 Gets what the first day of the week is; e.g., Sunday in US,  Monday in France.

getFloat(int). Method in interface java.sql.CallableStatement

 Get the value of a FLOAT parameter as a Java float.

getFloat(int). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a Java float.

getFloat(Object). Method in class java.lang.reflect.Field

 Get the value of a field as a float on specified object.

getFloat(Object, int). Static method in class java.lang.reflect.Array

 Returns the value of the indexed component in the specified  array object, as a float.

getFloat(String). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a Java float.

getFocusOwner(). Method in class java.awt.Window

 Returns the child component of this Window which has focus if and  only if this Window is active.

getFollowRedirects(). Static method in class java.net.HttpURLConnection

 getFont(). Method in class java.awt.Component

 Gets the font of the component.

getFont(). Method in class java.awt.FontMetrics

 Gets the font.

getFont(). Method in class java.awt.Graphics

 Gets the current font.

getFont(). Method in class java.awt.MenuComponent

 Gets the font used for this MenuItem.

getFont(). Method in interface java.awt.MenuContainer

 getFont(String). Static method in class java.awt.Font

 Gets a font from the system properties list.

getFont(String, Font). Static method in class java.awt.Font

 Gets the specified font from the system properties list.

getFontList(). Method in class java.awt.Toolkit

 Returns the names of the available fonts.

 For 1.1, the following font names are deprecated (the replacement  name follows):

• TimesRoman (use Serif)

• Helvetica (use SansSerif)

• Courier (use Monospaced)

 The ZapfDingbats font is also deprecated in 1.1, but only as a  separate fontname.

getFontMetrics(). Method in class java.awt.Graphics

 Gets the font metrics of the current font.

getFontMetrics(Font). Method in class java.awt.Component

 Gets the font metrics for this component.

getFontMetrics(Font). Method in interface java.awt.peer.ComponentPeer

 getFontMetrics(Font). Method in class java.awt. Graphics

 Gets the font metrics for the specified font.

getFontMetrics(Font). Method in class java.awt.Toolkit

 Returns the screen metrics of the font.

getFontPeer(String, int). Method in class java.awt.Toolkit

 Uses the specified Peer interface to create a new Font.

getForeground(). Method in class java.awt.Component

 Gets the foreground color.

getFormat(). Method in interface java.security.Certificate

 Returns the name of the coding format.

getFormat(). Method in interface java.security.Key

 Returns the format used to encode the key or null if the key does not  support encoding.

getFormats(). Method in class java.text.ChoiceFormat

 Get the formats passed in the constructor.

getFormats(). Method in class java.text.MessageFormat

 Gets formats that were set with setFormats.

getG(). Method in interface java.security.interfaces.DSAParams

 Returns the base, g.

getGraphics(). Method in class java.awt.Component

 Gets a Graphics context for this component.

getGraphics(). Method in interface java.awt.peer.ComponentPeer

 getGraphics(). Method in class java.awt.Image

 Gets a graphics object to draw into this image.

getGraphics(). Method in class java.awt.PrintJob

 Gets a Graphics object that will draw to the next page.

getGreatestMinimum(int). Method in class java.util.Calendar

 Gets the highest minimum value for the given field if varies.

getGreatestMinimum(int). Method in class java.util.GregorianCalendar

 Returns highest minimum value for the given field if varies.

getGreen(). Method in class java.awt.Color

 Gets the green component.

getGreen(int). Method in class java.awt.image.ColorModel

 The subclass must provide a function which provides the green  color compoment for the specified pixel.

getGreen(int). Method in class java.awt.image.DirectColorModel

 Returns the green color compoment for the specified pixel in the  range 0-255.

getGreen(int). Method in class java.awt.image.IndexColorModel

 Returns the green color compoment for the specified pixel in the  range 0-255.

getGreenMask(). Method in class java.awt.image.DirectColorModel

 Returns the mask indicating which bits in a pixel contain the green  color component.

getGreens(byte[]). Method in class java.awt.image.IndexColorModel

 Copies the array of green color components into the given array.

getGregorianChange(). Method in class java.util.GregorianCalendar

 Gets the Gregorian Calendar change date.

getGroupingSeparator(). Method in class java.text.DecimalFormatSymbols

 character used for thousands separator.

getGroupingSize(). Method in class java.text.DecimalFormat

 Return the grouping size.

getGuarantor(). Method in interface java.security.Certificate

 Returns the guarantor of the certificate, that is, the principal  guaranteeing that the public key associated with this certificate  is that of the principal associated with this certificate.

getHAdjustable(). Method in class java.awt.ScrollPane

 Returns the Adjustable object which represents the state of  the horizontal scrollbar.

getHeaderField(int). Method in class java.net.URLConnection

 Returns the value for the nth header field.

getHeaderField(String). Method in class java.net.URLConnection

 Returns the name of the specified header field.

getHeaderFieldDate(String, long). Method in class java.net.URLConnection

 Returns the value of the named field parsed as date.

getHeaderFieldInt(String, int). Method in class java.net.URLConnection

 Returns the value of the named field parsed as a number.

getHeaderFieldKey(int). Method in class java.net.URLConnection

 Returns the key for the nth header field.

getHeight(). Method in class java.awt.FontMetrics

 Gets the standard height of a line of text in this font.

getHeight(). Method in class java.awt.image.PixelGrabber

 Get the height of the pixel buffer (after adjusting for image height).

getHeight(ImageObserver). Method in class java.awt.Image

 Gets the actual height of the image.

getHelpMenu(). Method in class java.awt.MenuBar

 Gets the help menu on the menu bar.

getHgap(). Method in class java.awt.BorderLayout

 Returns the horizontal gap between components.

getHgap(). Method in class java.awt.CardLayout

 Returns the horizontal gap between components.

getHgap(). Method in class java.awt.FlowLayout

 Returns the horizontal gap between components.

getHgap(). Method in class java.awt.GridLayout

 Returns the horizontal gap between components.

getHost(). Method in class java.net.URL

 Returns the host name of this URL, if applicable.

getHostAddress(). Method in class java.net.InetAddress

 Returns the IP address string "%d.%d.%d.%d"

getHostName(). Method in class java.net.InetAddress

 Returns the hostname for this address.

getHours(). Method in class java.sql.Date

 Returns the hour represented by this date.

getHours(). Method in class java.util.Date

 Returns the hour represented by this date.

getHSBColor(float, float, float). Static method in class java.awt.Color

 A static Color factory for generating a Color object from HSB  values.

getHScrollbarHeight(). Method in class java.awt.ScrollPane

 Returns the height that would be occupied by a horizontal  scrollbar, which is independent of whether it is currently  displayed by the scroll pane or not.

getHScrollbarHeight(). Method in interface java.awt.peer.ScrollPanePeer

 getHumanPresentableName(). Method in class java.awt.datatransfer.DataFlavor

 Returns the human presentable name for the data foramt that this  DataFlavor represents.

getIcon(int). Method in interface java.beans.BeanInfo

 This method returns an image object that can be used to  represent the bean in toolboxes, toolbars, etc.

getIcon(int). Method in class java.beans.SimpleBeanInfo

 Claim there are no icons available.

getIconImage(). Method in class java.awt.Frame

 Returns the icon image for this Frame.

getID(). Method in class java.awt.AWTEvent

 Returns the event type.

getId(). Method in class sun.tools.debug.RemoteObject

 Returns the id of the object.

getID(). Method in class java.util.TimeZone

 Gets the ID of this time zone.

getIdentifierQuoteString(). Method in interface java.sql.DatabaseMetaData

 What's the string used to quote SQL identifiers?  This returns a space " " if identifier quoting isn't supported.

getIdentity(Principal). Method in class java.security.IdentityScope

 Retrieves the identity whose name is the same as that of the  specified principal.

getIdentity(PublicKey). Method in class java.security.IdentityScope

 Retrieves the identity with the specified public key.

getIdentity(String). Method in class java.security.IdentityScope

 Returns the identity in this scope with the specified name (if any).

getIfModifiedSince(). Method in class java.net.URLConnection

 Returns the value of this object's ifModifiedSince field.

getImage(String). Method in class java.awt.Toolkit

 Returns an image which gets pixel data from the specified file.

getImage(URL). Method in class java.applet.Applet

 Returns an Image object that can then be painted on  the screen.

getImage(URL). Method in interface java.applet.AppletContext

 Returns an Image object that can then be painted on  the screen.

getImage(URL). Method in class java.awt.Toolkit

 Returns an image which gets pixel data from the specified URL.

getImage(URL, String). Method in class java.applet.Applet

 Returns an Image object that can then be painted on  the screen.

getImportedKeys(String, String, String). Method in interface java.sql. DatabaseMetaData

 Get a description of the primary key columns that are  referenced by a table's foreign key columns (the primary keys  imported by a table).

getInCheck(). Method in class java.lang.SecurityManager

 Tests if there is a security check in progress.

getIndex(). Method in interface java.text.CharacterIterator

 Return the current index.

getIndex(). Method in class java.sql.DataTruncation

 Get the index of the column or parameter that was truncated.

getIndex(). Method in class java.text.ParsePosition

 Retrieve the current parse position.

getIndex(). Method in class java.text.StringCharacterIterator

 Return the current index.

getIndexedPropertyType(). Method in class java.beans.IndexedPropertyDescriptor

 getIndexedReadMethod(). Method in class java.beans. IndexedPropertyDescriptor

 getIndexedWriteMethod(). Method in class java.beans. IndexedPropertyDescriptor

 getIndexInfo (String, String, String, boolean, boolean). Method in interface java.sql.DatabaseMetaData

 Get a description of a table's indices and statistics.

getInetAddress(). Method in class java.net.ServerSocket

 Returns the local address of this server socket.

getInetAddress(). Method in class java.net.Socket

 Returns the address to which the socket is connected.

getInetAddress(). Method in class java.net.SocketImpl

 Returns the value of this socket's address field.

getInfinity(). Method in class java.text.DecimalFormatSymbols

 character used to represent infinity.

getInfo(). Method in class java.security.Identity

 Returns general information previously specified for this identity.

getInfo(). Method in class java.security.Provider

 Returns a human-readable description of the provider and its  services.

getInputStream(). Method in class java.lang.Process

 Gets the input stream of the subprocess.

getInputStream(). Method in interface java.rmi.server.RemoteCall

 Get the InputStream that the stub/skeleton should get  results/arguments from.

getInputStream(). Method in class java.net.Socket

 Returns an input stream for this socket.

getInputStream(). Method in class java.net.SocketImpl

 Returns an input stream for this socket.

getInputStream(). Method in class java.net.URLConnection

 Returns an input stream that reads from this open connection.

getInputStream(ZipEntry). Method in class java.util.zip.ZipFile

 Returns an input stream for reading the contents of the specified  ZIP file entry.

getInsets(). Method in class java.awt.Container

 Returns the insets of the container.

getInsets(). Method in interface java.awt.peer.ContainerPeer

 getInstance(). Static method in class java.util. Calendar

 Gets a Calendar using the default timezone and locale.

getInstance(). Static method in class java.text.Collator

 Gets the Collator for the current default locale.

getInstance(). Static method in class java.text.DateFormat

 Get a default date/time formatter that uses the SHORT style for both the  date and the time.

getInstance(). Static method in class java.text.NumberFormat

 Returns the default number format for the current default locale.

getInstance(Locale). Static method in class java.util.Calendar

 Gets a Calendar using the default timezone and given locale.

getInstance(Locale). Static method in class java.text.Collator

 Gets the Collator for the desired locale.

getInstance(Locale). Static method in class java.text.NumberFormat

 Returns the default number format for the specified locale.

getInstance(String). Static method in class java.security.KeyPairGenerator

 Generates a KeyPairGenerator object that implements the algorithm  requested, as available in the environment.

getInstance(String). Static method in class java.security.MessageDigest

 Generates a MessageDigest object that implements the specified digest  algorithm.

getInstance(String). Static method in class java.security.Signature

 Generates a Signature object that implements the specified  algorithm.

getInstance(String, String). Static method in class java.security. KeyPairGenerator

 Generates a KeyPairGenerator object implementing the specified  algorithm, as supplied from the specified provider,  if such an algorithm is available from the provider.

getInstance(String, String). Static method in class java.security. MessageDigest

 Generates a MessageDigest object implementing the specified  algorithm, as supplied from the specified provider, if such an  algorithm is available from the provider.

getInstance(String, String). Static method in class java.security.Signature

 Generates a Signature object implementing the specified  algorithm, as supplied from the specified provider, if such an  algorithm is available from the provider.

getInstance(TimeZone). Static method in class java.util.Calendar

 Gets a Calendar using the given timezone and default locale.

getInstance(TimeZone, Locale). Static method in class java.util.Calendar

 Gets a Calendar using the given timezone and given locale.

getInstanceField(int). Method in class sun.tools.debug.RemoteClass

 Return the instance field, specified by its index.

getInstanceFields(). Method in class sun.tools.debug.RemoteClass

 Return all the instance fields for this class.

getInstanceOf(Object, Class). Static method in class java.beans.Beans

 From a given bean, obtain an object representing a specified  type view of that source object.

getInt(int). Method in interface java.sql.CallableStatement

 Get the value of an INTEGER parameter as a Java int.

getInt(int). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a Java int.

getInt(Object). Method in class java.lang.reflect.Field

 Get the value of a field as a int on specified object.

getInt(Object, int). Static method in class java.lang.reflect.Array

 Returns the value of the indexed component in the specified  array object, as an int.

getInt(String). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a Java int.

getInteger(String). Static method in class java.lang.Integer

 Determines the integer value of the system property with the  specified name.

getInteger(String, int). Static method in class java.lang.Integer

 Determines the integer value of the system property with the  specified name.

getInteger(String, Integer). Static method in class java.lang.Integer

 Determines the integer value of the system property with the  specified name.

getInterface(). Method in class java.net.MulticastSocket

 Retrieve the address of the network interface used for  multicast packets.

getInterfaces(). Method in class java.lang.Class

 Determines the interfaces implemented by the class or interface  represented by this object.

getInterfaces(). Method in class sun.tools.debug.RemoteClass

 Return the interfaces for this class.

getISO3Country(). Method in class java.util.Locale

 Getter for the three-letter ISO country abbreviation  of the locale.

getISO3Language(). Method in class java.util.Locale

 Getter for the three-letter ISO language abbreviation  of the locale.

getItem(). Method in class java.awt.event.ItemEvent

 Returns the item where the event occurred.

getItem(int). Method in class java.awt.Choice

 Returns the String at the specified index in the Choice.

getItem(int). Method in class java.awt.List

 Gets the item associated with the specified index.

getItem(int). Method in class java.awt.Menu

 Returns the item located at the specified index of this menu.

getItemCount(). Method in class java.awt.Choice

 Returns the number of items in this Choice.

getItemCount(). Method in class java.awt.List

 Returns the number of items in the list.

getItemCount(). Method in class java.awt.Menu

 Returns the number of elements in this menu.

getItems(). Method in class java.awt.List

 Returns the items in the list.

getItemSelectable(). Method in class java.awt.event.ItemEvent

 Returns the ItemSelectable object where this event originated.

getJavaInitializationString(). Method in interface java.beans.PropertyEditor

 This method is intended for use when generating Java code to set  the value of the property.

getJavaInitializationString(). Method in class java.beans.PropertyEditorSupport

 This method is intended for use when generating Java code to set  the value of the property.

getKey(). Method in class java.awt.MenuShortcut

 Return the raw keycode of this MenuShortcut.

getKey(). Method in class java.util.MissingResourceException

 Gets parameter passed by constructor.

getKeyChar(). Method in class java.awt.event.KeyEvent

 Returns the character associated with the key in this event.

getKeyCode(). Method in class java.awt.event.KeyEvent

 Returns the integer key-code associated with the key in this event.

getKeyModifiersText(int). Static method in class java.awt.event.KeyEvent

 Returns a String describing the modifier key(s), such as "Shift",  or "Ctrl+Shift".

getKeys(). Method in class java.util.ListResourceBundle

 Implementation of ResourceBundle.getKeys.

getKeys(). Method in class java.util.PropertyResourceBundle

 Implementation of ResourceBundle.getKeys.

getKeys(). Method in class java.util.ResourceBundle

 Return an enumeration of the keys.

getKeyText(int). Static method in class java.awt.event.KeyEvent

 Returns a String describing the keyCode, such as "HOME", "F1" or "A".

getLabel(). Method in class java.awt.Button

 Gets the label of the button.

getLabel(). Method in class java.awt.Checkbox

 Gets the label of the check box.

getLabel(). Method in class java.awt.MenuItem

 Gets the label for this menu item.

getLanguage(). Method in class java.util.Locale

 Getter for programmatic name of field,  an lowercased two-letter ISO-639 code.

getLastModified(). Method in class java.net.URLConnection

 Returns the value of the last-modified header field.

getLayout(). Method in class java.awt.Container

 Gets the layout manager for this container.

getLayoutAlignmentX(Container). Method in class java.awt.BorderLayout

 Returns the alignment along the x axis.

getLayoutAlignmentX(Container). Method in class java.awt.CardLayout

 Returns the alignment along the x axis.

getLayoutAlignmentX(Container). Method in class java.awt.GridBagLayout

 Returns the alignment along the x axis.

getLayoutAlignmentX(Container). Method in interface java.awt.LayoutManager2

 Returns the alignment along the x axis.

getLayoutAlignmentY(Container). Method in class java.awt.BorderLayout

 Returns the alignment along the y axis.

getLayoutAlignmentY(Container). Method in class java.awt.CardLayout

 Returns the alignment along the y axis.

getLayoutAlignmentY(Container). Method in class java.awt.GridBagLayout

 Returns the alignment along the y axis.

getLayoutAlignmentY(Container). Method in interface java.awt.LayoutManager2

 Returns the alignment along the y axis.

getLayoutDimensions(). Method in class java.awt.GridBagLayout

 GetLayoutInfo(Container, int). Method in class java.awt.GridBagLayout

 Print the layout constraints.

getLayoutOrigin(). Method in class java.awt.GridBagLayout

 getLayoutWeights(). Method in class java.awt. GridBagLayout

 getLeading(). Method in class java.awt.FontMetrics

 Gets the standard leading, or line spacing, for the font.

getLeastMaximum(int). Method in class java.util.Calendar

 Gets the lowest maximum value for the given field if varies.

getLeastMaximum(int). Method in class java.util.GregorianCalendar

 Returns lowest maximum value for the given field if varies.

getLength(). Method in class java.net.DatagramPacket

 Returns the length of the data to be sent or the length of the  data received.

getLength(Object). Static method in class java.lang.reflect.Array

 Returns the length of the specified array object, as an int.

getLimits(). Method in class java.text.ChoiceFormat

 Get the limits passed in the constructor.

getLineIncrement(). Method in class java.awt.Scrollbar

 getLineInstance(). Static method in class java.text. BreakIterator

 Create BreakIterator for line-breaks using default locale.

getLineInstance(Locale). Static method in class java.text.BreakIterator

 Create BreakIterator for line-breaks using default locale.

getLineNumber(). Method in class java.io.LineNumberInputStream

 Returns the current line number.

getLineNumber(). Method in class java.io.LineNumberReader

 Get the current line number.

getLineNumber(). Method in class sun.tools.debug.RemoteStackFrame

 Return the source file line number.

getLineNumbers(). Method in class sun.tools.debug.RemoteClass

 Return an array of all the class's source file line numbers which  have code associated with them.

getListenerMethodDescriptors(). Method in class java.beans.EventSetDescriptor

 getListenerMethods(). Method in class java.beans. EventSetDescriptor

 getListenerType(). Method in class java.beans. EventSetDescriptor

 getLocalAddress(). Method in class java.net. DatagramSocket

 Gets the local address to which the socket is bound.

getLocalAddress(). Method in class java.net.Socket

 Gets the local address to which the socket is bound.

getLocale(). Method in class java.applet.Applet

 Gets the Locale for the applet, if it has been set.

getLocale(). Method in class java.awt.Component

 Gets the locale of the component.

getLocale(). Method in class java.text.MessageFormat

 Gets the locale.

getLocale(). Method in class java.awt.Window

 Gets the Locale for the window, if it has been set.

getLocalHost(). Static method in class java.net.InetAddress

 Returns the local host.

getLocalizedInputStream(InputStream). Method in class java.lang.Runtime

 Creates a localized version of an input stream.

getLocalizedMessage(). Method in class java.lang.Throwable

 Creates a localized description of this Throwable.

getLocalizedOutputStream(OutputStream). Method in class java.lang.Runtime

 Creates a localized version of an output stream.

getLocalPatternChars(). Method in class java.text.DateFormatSymbols

 Gets localized date-time pattern characters.

getLocalPort(). Method in class java.net.DatagramSocket

 Returns the port number on the local host to which this socket is bound.

getLocalPort(). Method in class java.net.DatagramSocketImpl

 Get the local port.

getLocalPort(). Method in class java.net.ServerSocket

 Returns the port on which this socket is listening.

getLocalPort(). Method in class java.net.Socket

 Returns the local port to which this socket is bound.

getLocalPort(). Method in class java.net.SocketImpl

 Returns the value of this socket's localport field.

getLocalVariable(String). Method in class sun.tools.debug.RemoteStackFrame

 Return a specific (named) stack variable.

getLocalVariables(). Method in class sun.tools.debug.RemoteStackFrame

 Return an array of all valid local variables and method arguments  for this stack frame.

getLocation(). Method in class java.awt.Component

 Returns the current location of this component.

getLocation(). Method in class java.awt.Point

 Returns the location of this point.

getLocation(). Method in class java.awt.Rectangle

 Returns the location of this rectangle.

getLocationOnScreen(). Method in class java.awt.Component

 Returns the current location of this component in the screen's  coordinate space.

getLocationOnScreen(). Method in interface java.awt.peer.ComponentPeer

 getLog(). Static method in class java.rmi.server. RemoteServer

 Returns stream for the RMI call log.

getLoginTimeout(). Static method in class java.sql.DriverManager

 Get the maximum time in seconds that all drivers can wait  when attempting to log in to a database.

getLogStream(). Static method in class java.sql.DriverManager

 Get the logging/tracing PrintStream that is used by the DriverManager  and all drivers.

getLong(int). Method in interface java.sql.CallableStatement

 Get the value of a BIGINT parameter as a Java long.

getLong(int). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a Java long.

getLong(Object). Method in class java.lang.reflect.Field

 Get the value of a field as a long on specified object.

getLong(Object, int). Static method in class java.lang.reflect.Array

 Returns the value of the indexed component in the specified  array object, as a long.

getLong(String). Static method in class java.lang.Long

 Determines the long value of the system property  with the specified name.

getLong(String). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a Java long.

getLong(String, Long). Static method in class java.lang.Long

 Determines the long value of the system property  with the specified name.

getLong(String, long). Static method in class java.lang.Long

 Determines the long value of the system property  with the specified name.

getLowestSetBit(). Method in class java.math.BigInteger

 Returns the index of the rightmost (lowest-order) one bit in this  number (i.e., the number of zero bits to the right of the rightmost  one bit).

getMajorVersion(). Method in interface java.sql.Driver

 Get the driver's major version number.

getMapSize(). Method in class java.awt.image.IndexColorModel

 Returns the size of the color component arrays in this IndexColorModel.

getMaxAdvance(). Method in class java.awt.FontMetrics

 Gets the maximum advance width of any character in this Font.

getMaxAscent(). Method in class java.awt.FontMetrics

 Gets the maximum ascent of all characters in this Font.

getMaxBinaryLiteralLength(). Method in interface java.sql.DatabaseMetaData

 How many hex characters can you have in an inline binary literal?

getMaxCatalogNameLength(). Method in interface java.sql.DatabaseMetaData

 What's the maximum length of a catalog name?

getMaxCharLiteralLength(). Method in interface java.sql.DatabaseMetaData

 What's the max length for a character literal?

getMaxColumnNameLength(). Method in interface java.sql.DatabaseMetaData

 What's the limit on column name length?

getMaxColumnsInGroupBy(). Method in interface java.sql.DatabaseMetaData

 What's the maximum number of columns in a "GROUP BY" clause?

getMaxColumnsInIndex(). Method in interface java.sql.DatabaseMetaData

 What's the maximum number of columns allowed in an index?

getMaxColumnsInOrderBy(). Method in interface java.sql.DatabaseMetaData

 What's the maximum number of columns in an "ORDER BY" clause?

getMaxColumnsInSelect(). Method in interface java.sql.DatabaseMetaData

 What's the maximum number of columns in a "SELECT" list?

getMaxColumnsInTable(). Method in interface java.sql.DatabaseMetaData

 What's the maximum number of columns in a table?

getMaxConnections(). Method in interface java.sql.DatabaseMetaData

 How many active connections can we have at a time to this database?

getMaxCursorNameLength(). Method in interface java.sql.DatabaseMetaData

 What's the maximum cursor name length?

getMaxDecent(). Method in class java.awt.FontMetrics

 For backward compatibility only.

getMaxDescent(). Method in class java.awt.FontMetrics

 Gets the maximum descent of all characters in this Font.

getMaxFieldSize(). Method in interface java.sql.Statement

 The maxFieldSize limit (in bytes) is the maximum amount of data  returned for any column value; it only applies to BINARY,  VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR  columns.

getMaximum(). Method in interface java.awt.Adjustable

 Gets the maximum value of the adjustable object.

getMaximum(). Method in class java.awt.Scrollbar

 Returns the maximum value of this Scrollbar.

getMaximum(int). Method in class java.util.Calendar

 Gets the maximum value for the given time field.

getMaximum(int). Method in class java.util.GregorianCalendar

 Returns maximum value for the given field.

getMaximumFractionDigits(). Method in class java.text.NumberFormat

 Returns the maximum number of digits allowed in the fraction portion of a  number.

getMaximumIntegerDigits(). Method in class java.text.NumberFormat

 Returns the maximum number of digits allowed in the integer portion of a  number.

getMaximumSize(). Method in class java.awt.Component

 Returns the maximum size of this component.

getMaximumSize(). Method in class java.awt.Container

 Returns the maximum size of this container.

getMaxIndexLength(). Method in interface java.sql.DatabaseMetaData

 What's the maximum length of an index (in bytes)?

getMaxPriority(). Method in class java.lang.ThreadGroup

 Returns the maximum priority of this thread group.

getMaxProcedureNameLength(). Method in interface java.sql.DatabaseMetaData

 What's the maximum length of a procedure name?

getMaxRows(). Method in interface java.sql.Statement

 The maxRows limit is the maximum number of rows that a  ResultSet can contain.

getMaxRowSize(). Method in interface java.sql.DatabaseMetaData

 What's the maximum length of a single row?

getMaxSchemaNameLength(). Method in interface java.sql.DatabaseMetaData

 What's the maximum length allowed for a schema name?

getMaxStatementLength(). Method in interface java.sql.DatabaseMetaData

 What's the maximum length of a SQL statement?

getMaxStatements(). Method in interface java.sql.DatabaseMetaData

 How many active statements can we have open at one time to this  database?

getMaxTableNameLength(). Method in interface java.sql.DatabaseMetaData

 What's the maximum length of a table name?

getMaxTablesInSelect(). Method in interface java.sql.DatabaseMetaData

 What's the maximum number of tables in a SELECT?

getMaxUserNameLength(). Method in interface java.sql.DatabaseMetaData

 What's the maximum length of a user name?

getMenu(int). Method in class java.awt.MenuBar

 Gets the specified menu.

getMenu(String). Method in class java.util.ResourceBundle

 Get an object from a ResourceBundle.

getMenuBar(). Method in class java.awt.Frame

 Gets the menu bar for this Frame.

getMenuBar(String). Method in class java.util.ResourceBundle

 Get an object from a ResourceBundle.

getMenuCount(). Method in class java.awt.MenuBar

 Counts the number of menus on the menu bar.

getMenuShortcutKeyMask(). Method in class java.awt.Toolkit

 Return the Event modifier mask appropriate for shortcuts.

getMessage(). Method in class java.io.InvalidClassException

 Produce the message, include the classname if present.

getMessage(). Method in class java.rmi.RemoteException

 Produce the message, include the message from the nested  exception if there is one.

getMessage(). Method in class java.rmi.server.ServerCloneException

 Produce the message, include the message from the nested  exception if there is one.

getMessage(). Method in class java.lang.Throwable

 Returns the detail message of this throwable object.

getMessage(). Method in class java.io.WriteAbortedException

 Produce the message, include the message from the nested  exception if there is one.

getMessageDigest(). Method in class java.security.DigestInputStream

 Returns the message digest associated with this stream.

getMessageDigest(). Method in class java.security.DigestOutputStream

 Returns the message digest associated with this stream.

getMetaData(). Method in interface java.sql.Connection

 A Connection's database is able to provide information  describing its tables, its supported SQL grammar, its stored  procedures, the capabilities of this connection, etc.

getMetaData(). Method in interface java.sql.ResultSet

 The number, types and properties of a ResultSet's columns  are provided by the getMetaData method.

getMethod(). Method in class java.beans.MethodDescriptor

 getMethod(). Method in class java.util.zip.ZipEntry

 Returns the compression method of the entry, or -1 if not specified.

getMethod(String). Method in class sun.tools.debug.RemoteClass

 Return the method, specified by name.

getMethod(String, Class[]). Method in class java.lang.Class

 Returns a Method object that reflects the specified public  member method of the class or interface represented by this  Class object.

getMethodDescriptors(). Method in interface java.beans.BeanInfo

 getMethodDescriptors(). Method in class java.beans. SimpleBeanInfo

 Deny knowledge of methods.

getMethodLineNumber(int). Method in class sun.tools.debug.RemoteClass

 Return the first line number of the specified method, or throws  NoSuchLineNumber exception.

getMethodLineNumber(String). Method in class sun.tools.debug.RemoteClass

 Return the first line number of the specified method, or throws  NoSuchLineNumber exception.

getMethodName(). Method in class sun.tools.debug.RemoteStackFrame

 Get the method name referenced by this stackframe.

getMethodNames(). Method in class sun.tools.debug.RemoteClass

 Return the names of all methods supported by this class.

getMethods(). Method in class java.lang.Class

 Returns an array containing Method objects reflecting all the  public member  methods of the class or interface  represented by this Class object, including those declared by  the class or interface and and those inherited from  superclasses and superinterfaces.

getMethods(). Method in class sun.tools.debug.RemoteClass

 Return the class's methods.

getMimeType(). Method in class java.awt.datatransfer.DataFlavor

 Returns the MIME type string for this DataFlavor

getMinimalDaysInFirstWeek(). Method in class java.util.Calendar

 Gets what the minimal days required in the first week of the year are;  e.g., if the first week is defined as one that contains the first day  of the first month of a year, getMinimalDaysInFirstWeek returns 1.

getMinimum(). Method in interface java.awt.Adjustable

 Gets the minimum value of the adjustable object.

getMinimum(). Method in class java.awt.Scrollbar

 Returns the minimum value of this Scrollbar.

getMinimum(int). Method in class java.util.Calendar

 Gets the minimum value for the given time field.

getMinimum(int). Method in class java.util.GregorianCalendar

 Returns minimum value for the given field.

getMinimumFractionDigits(). Method in class java.text.NumberFormat

 Returns the minimum number of digits allowed in the fraction portion of a  number.

getMinimumIntegerDigits(). Method in class java.text.NumberFormat

 Returns the minimum number of digits allowed in the integer portion of a  number.

getMinimumSize(). Method in class java.awt.Component

 Returns the mininimum size of this component.

getMinimumSize(). Method in interface java.awt.peer.ComponentPeer

 getMinimumSize(). Method in class java.awt.Container

 Returns the minimum size of this container.

getMinimumSize(). Method in class java.awt.List

 Returns the minimum dimensions needed for the list.

getMinimumSize(). Method in class java.awt.TextArea

 Returns the minimum size Dimensions of the TextArea.

getMinimumSize(). Method in class java.awt.TextField

 Returns the minimum size Dimensions needed for this TextField.

getMinimumSize(int). Method in class java.awt.List

 Returns the minimum dimensions needed for the amount of rows in the  list.

getMinimumSize(int). Method in interface java.awt.peer.ListPeer

 getMinimumSize(int). Method in class java.awt. TextField

 Returns the minimum size Dimensions needed for this TextField  with the specified amount of columns.

getMinimumSize(int). Method in interface java.awt.peer.TextFieldPeer

 getMinimumSize(int, int). Method in class java.awt. TextArea

 Returns the specified minimum size Dimensions of the TextArea.

getMinimumSize(int, int). Method in interface java.awt.peer.TextAreaPeer

 getMinorVersion(). Method in interface java.sql.Driver

 Get the driver's minor version number.

GetMinSize(Container, GridBagLayoutInfo). Method in class java.awt. GridBagLayout

 getMinusSign(). Method in class java.text. DecimalFormatSymbols

 character used to represent minus sign.

getMinutes(). Method in class java.sql.Date

 Returns the number of minutes past the hour represented by this date.

getMinutes(). Method in class java.util.Date

 Returns the number of minutes past the hour represented by this date.

getMode(). Method in class java.awt.FileDialog

 Gets the mode of the file dialog.

getModifiers(). Method in class java.awt.event.ActionEvent

 Returns the modifiers held down during this action event.

getModifiers(). Method in class java.lang.Class

 Returns the Java language modifiers for this class or  interface, encoded in an integer.

getModifiers(). Method in class java.lang.reflect.Constructor

 Returns the Java language modifiers for the constructor  represented by this Constructor object, as an integer.

getModifiers(). Method in class java.lang.reflect.Field

 Returns the Java language modifiers for the field represented  by this Field object, as an integer.

getModifiers(). Method in class java.awt.event.InputEvent

 Returns the modifiers flag for this event.

getModifiers(). Method in interface java.lang.reflect.Member

 Returns the Java language modifiers for the member or  constructor represented by this Member, as an integer.

getModifiers(). Method in class java.lang.reflect.Method

 Returns the Java language modifiers for the method represented  by this Method object, as an integer.

getModifiers(). Method in class sun.tools.debug.RemoteField

 Returns a string with the field's modifiers, such as "public",  "static", "final", etc.

getMonth(). Method in class java.util.Date

 Returns the month represented by this date.

getMonth(). Method in class java.sql.Time

 Returns the month represented by this date.

getMonths(). Method in class java.text.DateFormatSymbols

 Gets month strings.

getMoreResults(). Method in interface java.sql.Statement

 getMoreResults moves to a Statement's next result.

getMultiplier(). Method in class java.text.DecimalFormat

 Get the multiplier for use in percent, permill, etc.

getName(). Method in interface java.security.acl.Acl

 Returns the name of this ACL.

getName(). Method in class java.lang.Class

 Returns the fully-qualified name of the type (class, interface,  array, or primitive) represented by this Class object, as a String.

getName(). Method in class java.awt.datatransfer.Clipboard

 Returns the name of this clipboard object.

getName(). Method in class java.awt.Component

 Gets the name of the component.

getName(). Method in class java.lang.reflect.Constructor

 Returns the name of this constructor, as a string.

getName(). Method in class java.beans.FeatureDescriptor

 getName(). Method in class java.lang.reflect.Field

 Returns the name of the field represented by this Field object.

getName(). Method in class java.io.File

 Returns the name of the file represented by this object.

getName(). Method in class java.awt.Font

 Gets the logical name of the font.

getName(). Method in class java.security.Identity

 Returns this identity's name.

getName(). Method in interface java.lang.reflect.Member

 Returns the simple name of the underlying member or constructor  represented by this Member.

getName(). Method in class java.awt.MenuComponent

 Gets the name of the menu component.

getName(). Method in class java.lang.reflect.Method

 Returns the name of the method represented by this Method  object, as a String.

getName(). Method in class java.io.ObjectStreamClass

 The name of the class described by this descriptor.

getName(). Method in interface java.security.Principal

 Returns the name of this principal.

getName(). Method in class java.security.Provider

 Returns the name of this provider.

getName(). Method in class sun.tools.debug.RemoteClass

 Returns the name of the class.

getName(). Method in class sun.tools.debug.RemoteField

 Returns the name of the field.

getName(). Method in class sun.tools.debug.RemoteStackVariable

 Return the name of a stack variable or argument.

getName(). Method in class sun.tools.debug.RemoteThread

 Return the name of the thread.

getName(). Method in class sun.tools.debug.RemoteThreadGroup

 Return the threadgroup's name.

getName(). Method in class java.lang.Thread

 Returns this thread's name.

getName(). Method in class java.lang.ThreadGroup

 Returns the name of this thread group.

getName(). Method in class java.util.zip.ZipEntry

 Returns the name of the entry.

getName(). Method in class java.util.zip.ZipFile

 Returns the path name of the ZIP file.

getNaN(). Method in class java.text.DecimalFormatSymbols

 character used to represent NaN.

getNanos(). Method in class java.sql.Timestamp

 Get the Timestamp's nanos value

getNativeContainer(Component). Static method in class java.awt.Toolkit

 Give native peers the ability to query the native container  given a native component (eg the direct parent may be lightweight).

getNegativePrefix(). Method in class java.text.DecimalFormat

 Get the negative prefix.

getNegativeSuffix(). Method in class java.text.DecimalFormat

 Get the negative suffix.

getNewValue(). Method in class java.beans.PropertyChangeEvent

 getNextEntry(). Method in class java.util.zip. ZipInputStream

 Reads the next ZIP file entry and positions stream at the beginning  of the entry data.

getNextEvent(). Method in class java.awt.EventQueue

 Remove an event from the queue and return it.

getNextException(). Method in class java.sql.SQLException

 Get the exception chained to this one.

getNextWarning(). Method in class java.sql.SQLWarning

 Get the warning chained to this one

getNumberInstance(). Method in class java.text.DateFormat

 Gets the number formatter which this date/time formatter uses to  format and parse a time.

getNumberInstance(). Static method in class java.text.NumberFormat

 Returns a general-purpose number format for the current default locale.

getNumberInstance(Locale). Static method in class java.text.NumberFormat

 Returns a general-purpose number format for the specified locale.

getNumericFunctions(). Method in interface java.sql.DatabaseMetaData

 Get a comma separated list of math functions.

getNumericValue(char). Static method in class java.lang.Character

 Returns the Unicode numeric value of the character as a  nonnegative integer.

getObject(int). Method in interface java.sql.CallableStatement

 Get the value of a parameter as a Java object.

getObject(int). Method in interface java.sql.ResultSet

Get the value of a column in the current row as a Java object.

getObject(String). Method in class java.util.ResourceBundle

 Get an object from a ResourceBundle.

getObject(String). Method in interface java.sql.ResultSet

Get the value of a column in the current row as a Java object.

getOffset(int, int, int, int, int, int). Method in class java.util. SimpleTimeZone

 Overrides TimeZone  Gets offset, for current date, modified in case of daylight savings.

getOffset(int, int, int, int, int, int). Method in class java.util.TimeZone

 Gets the time zone offset, for current date, modified in case of  daylight savings.

getOldValue(). Method in class java.beans.PropertyChangeEvent

 getOperation(). Method in class java.rmi.server. Operation

 Returns the name of the method.

getOperations(). Method in interface java.rmi.server.Skeleton

 getOrientation(). Method in interface java.awt. Adjustable

 Gets the orientation of the adjustable object.

getOrientation(). Method in class java.awt.Scrollbar

 Returns the orientation for this Scrollbar.

getOutputStream(). Method in class java.rmi.server.LogStream

 Return the current stream to which output from this log is sent.

getOutputStream(). Method in class java.lang.Process

 Gets the output stream of the subprocess.

getOutputStream(). Method in interface java.rmi.server.RemoteCall

 Return the output stream the stub/skeleton should put arguments/results  into.

getOutputStream(). Method in class java.net.Socket

 Returns an output stream for this socket.

getOutputStream(). Method in class java.net.SocketImpl

 Returns an output stream for this socket.

getOutputStream(). Method in class java.net.URLConnection

 Returns an output stream that writes to this connection.

getP(). Method in interface java.security.interfaces.DSAParams

 Returns the prime, p.

getPageDimension(). Method in class java.awt.PrintJob

 Returns the dimensions of the page in pixels.

getPageIncrement(). Method in class java.awt.Scrollbar

 getPageResolution(). Method in class java.awt. PrintJob

 Returns the resolution of the page in pixels per inch.

getParameter(). Method in class java.sql.DataTruncation

 Is this a truncated parameter value?

getParameter(String). Method in class java.applet.Applet

 Returns the value of the named parameter in the HTML tag.

getParameter(String). Method in interface java.applet.AppletStub

 Returns the value of the named parameter in the HTML tag.

getParameter(String). Method in class java.security.Signature

 Gets the value of the specified algorithm parameter.

getParameterDescriptors(). Method in class java.beans.MethodDescriptor

 getParameterInfo(). Method in class java.applet. Applet

 Returns information about the parameters than are understood by  this applet.

getParameterTypes(). Method in class java.lang.reflect.Constructor

 Returns an array of Class objects that represent the formal  parameter types, in declaration order, of the constructor  represented by this Constructor object.

getParameterTypes(). Method in class java.lang.reflect.Method

 Returns an array of Class objects that represent the formal  parameter types, in declaration order, of the method  represented by this Method object.

getParams(). Method in interface java.security.interfaces.DSAKey

 Returns the DSA-specific key parameters.

getParent(). Method in class java.awt.Component

 Gets the parent of the component.

getParent(). Method in class java.io.File

 Returns the parent directory of the file represented by this  object.

getParent(). Method in class java.awt.MenuComponent

 Returns the parent container.

getParent(). Method in class java.lang.ThreadGroup

 Returns the parent of this thread group.

getPath(). Method in class java.io.File

 Returns the pathname of the file represented by this object.

getPatternSeparator(). Method in class java.text.DecimalFormatSymbols

 character used to separate positive and negative subpatterns  in a pattern.

getPC(). Method in class sun.tools.debug.RemoteStackFrame

 Get the program counter referenced by this stackframe.

getPeer(). Method in class java.awt.Component

 getPeer(). Method in class java.awt.Font

 Gets the peer of the font.

getPeer(). Method in class java.awt.MenuComponent

 getPercent(). Method in class java.text. DecimalFormatSymbols

 character used for percent sign.

getPercentInstance(). Static method in class java.text.NumberFormat

 Returns a percentage format for the current default locale.

getPercentInstance(Locale). Static method in class java.text.NumberFormat

 Returns a percentage format for the specified locale.

getPerMill(). Method in class java.text.DecimalFormatSymbols

 character used for mille percent sign.

getPermissions(Principal). Method in interface java.security.acl.Acl

 Returns an enumeration for the set of allowed permissions for the  specified principal (representing an entity such as an individual or  a group).

getPixels(). Method in class java.awt.image.PixelGrabber

 Get the pixel buffer.

getPixelSize(). Method in class java.awt.image.ColorModel

 Returns the number of bits per pixel described by this ColorModel.

getPoint(). Method in class java.awt.event.MouseEvent

 Returns the x,y position of the event relative to the source component.

getPort(). Method in class java.net.DatagramPacket

 Returns the port number on the remote host to which this datagram is  being sent or from which the datagram was received.

getPort(). Method in class java.net.Socket

 Returns the remote port to which this socket is connected.

getPort(). Method in class java.net.SocketImpl

 Returns the value of this socket's port field.

getPort(). Method in class java.net.URL

 Returns the port number of this URL.

getPositivePrefix(). Method in class java.text.DecimalFormat

 Get the positive prefix.

getPositiveSuffix(). Method in class java.text.DecimalFormat

 Get the positive suffix.

getPrecision(int). Method in interface java.sql.ResultSetMetaData

 What's a column's number of decimal digits?

getPredefinedCursor(int). Static method in class java.awt.Cursor

 Returns a cursor object with the specified predefined type.

getPreferredSize(). Method in class java.awt.Component

 Returns the preferred size of this component.

getPreferredSize(). Method in interface java.awt.peer.ComponentPeer

 getPreferredSize(). Method in class java.awt. Container

 Returns the preferred size of this container.

getPreferredSize(). Method in class java.awt.List

 Returns the preferred dimensions needed for the list.

getPreferredSize(). Method in class java.awt.TextArea

 Returns the preferred size Dimensions of the TextArea.

getPreferredSize(). Method in class java.awt.TextField

 Returns the preferred size Dimensions needed for this TextField.

getPreferredSize(int). Method in class java.awt.List

 Returns the preferred dimensions needed for the list with the specified  amount of rows.

getPreferredSize(int). Method in interface java.awt.peer.ListPeer

 getPreferredSize(int). Method in class java.awt. TextField

 Returns the preferred size Dimensions needed for this TextField  with the specified amount of columns.

getPreferredSize(int). Method in interface java.awt.peer.TextFieldPeer

 getPreferredSize(int, int). Method in class java.awt. TextArea

 Returns the specified row and column Dimensions of the TextArea.

getPreferredSize(int, int). Method in interface java.awt.peer.TextAreaPeer

 getPrimaryKeys(String, String, String). Method in interface java.sql.DatabaseMetaData

 Get a description of a table's primary key columns.

getPrincipal(). Method in interface java.security.acl.AclEntry

 Returns the principal for which permissions are granted or denied by  this ACL entry.

getPrincipal(). Method in interface java.security.Certificate

 Returns the principal of the principal-key pair being guaranteed by  the guarantor.

getPrintJob(). Method in interface java.awt.PrintGraphics

 Returns the PrintJob object from which this PrintGraphics  object originated.

getPrintJob(Frame, String, Properties). Method in class java.awt.Toolkit

 Returns a PrintJob object which is the result of initiating  a print operation on the toolkit's platform.

getPriority(). Method in class java.lang.Thread

 Returns this thread's priority.

getPrivate(). Method in class java.security.KeyPair

 Returns the private key from this key pair.

getPrivateKey(). Method in class java.security.Signer

 Returns this signer's private key.

getProcedureColumns(String, String, String, String). Method in interface java.sql.DatabaseMetaData

 Get a description of a catalog's stored procedure parameters  and result columns.

getProcedures(String, String, String). Method in interface java.sql. DatabaseMetaData

 Get a description of stored procedures available in a  catalog.

getProcedureTerm(). Method in interface java.sql.DatabaseMetaData

 What's the database vendor's preferred term for "procedure"?

getPropagationId(). Method in class java.beans.PropertyChangeEvent

 The "propagationId" field is reserved for future use.

getProperties(). Static method in class java.lang.System

 Determines the current system properties.

getProperty(String). Method in class java.util.Properties

 Searches for the property with the specified key in this property list.

getProperty(String). Static method in class java.security.Security

 Gets a security property.

getProperty(String). Static method in class java.lang.System

 Gets the system property indicated by the specified key.

getProperty(String, ImageObserver). Method in class java.awt.Image

 Gets a property of the image by name.

getProperty(String, String). Method in class java.util.Properties

 Searches for the property with the specified key in this property list.

getProperty(String, String). Static method in class java.lang.System

 Gets the system property indicated by the specified key.

getProperty(String, String). Static method in class java.awt.Toolkit

 Gets a property with the specified key and default.

getPropertyChangeEvent(). Method in class java.beans.PropertyVetoException

 getPropertyDescriptors(). Method in interface java.beans.BeanInfo

 getPropertyDescriptors(). Method in class java.beans. SimpleBeanInfo

 Deny knowledge of properties.

getPropertyEditorClass(). Method in class java.beans.PropertyDescriptor

 getPropertyInfo(String, Properties). Method in interface java.sql.Driver

The getPropertyInfo method is intended to allow a generic GUI tool to  discover what properties it should prompt a human for in order to get  enough information to connect to a database.

getPropertyName(). Method in class java.beans.PropertyChangeEvent

 getPropertyType(). Method in class java.beans. PropertyDescriptor

 getProtocol(). Method in class java.net.URL

 Returns the protocol name this URL.

getProvider(String). Static method in class java.security.Security

 Returns the provider installed with the specified name, if  any.

getProviders(). Static method in class java.security.Security

 Returns all providers currently installed.

getPublic(). Method in class java.security.KeyPair

 Returns the public key from this key pair.

getPublicKey(). Method in interface java.security.Certificate

 Returns the key of the principal-key pair being guaranteed by  the guarantor.

getPublicKey(). Method in class java.security.Identity

 Returns this identity's public key.

getQ(). Method in interface java.security.interfaces.DSAParams

 Returns the subprime, q.

getQueryTimeout(). Method in interface java.sql.Statement

 The queryTimeout limit is the number of seconds the driver will  wait for a Statement to execute.

getRawOffset(). Method in class java.util.SimpleTimeZone

 Overrides TimeZone  Gets the GMT offset for this time zone.

getRawOffset(). Method in class java.util.TimeZone

 Gets unmodified offset, NOT modified in case of daylight savings.

getRead(). Method in class java.sql.DataTruncation

 Was this a read truncation?

getReadMethod(). Method in class java.beans.PropertyDescriptor

 getRed(). Method in class java.awt.Color

 Gets the red component.

getRed(int). Method in class java.awt.image.ColorModel

 The subclass must provide a function which provides the red  color compoment for the specified pixel.

getRed(int). Method in class java.awt.image.DirectColorModel

 Returns the red color compoment for the specified pixel in the  range 0-255.

getRed(int). Method in class java.awt.image.IndexColorModel

 Returns the red color compoment for the specified pixel in the  range 0-255.

getRedMask(). Method in class java.awt.image.DirectColorModel

 Returns the mask indicating which bits in a pixel contain the red  color component.

getReds(byte[]). Method in class java.awt.image.IndexColorModel

 Copies the array of red color components into the given array.

getRef(). Method in class java.net.URL

 Returns the anchor (also known as the "reference") of this  URL.

getRefClass(ObjectOutput). Method in interface java.rmi.server.RemoteRef

 Returns the class name of the ref type to be serialized onto  the stream 'out'.

getRegistry(). Static method in class java.rmi.registry.LocateRegistry

 Returns the remote object Registry for the local host.

getRegistry(int). Static method in class java.rmi.registry.LocateRegistry

 Returns the remote object Registry on the current host at the  specified port.

getRegistry(String). Static method in class java.rmi.registry.LocateRegistry

 Returns the remote object Registry on the specified host at a  default (i.e., well-known) port number.

getRegistry(String, int). Static method in class java.rmi.registry. LocateRegistry

 Returns the remote object Registry on the specified host at the  specified port.

getRemaining(). Method in class java.util.zip.Inflater

 Returns the total number of bytes remaining in the input buffer.

getRemoteClass(). Method in class sun.tools.debug.RemoteStackFrame

 Get the class this stackframe references.

getRemoveListenerMethod(). Method in class java.beans.EventSetDescriptor

 getRepresentationClass(). Method in class java.awt.datatransfer.DataFlavor

 Returns the Class which objects supporting this DataFlavor  will return when this DataFlavor is requested.

getRequestMethod(). Method in class java.net.HttpURLConnection

 Get the request method.

getRequestProperty(String). Method in class java.net.URLConnection

 Returns the value of the named general request property for this  connection.

getResource(String). Method in class java.lang.Class

 getResource(String). Method in class java.lang. ClassLoader

 Find a resource with a given name.

getResourceAsStream(String). Method in class java.lang.Class

 Find a resource with a given name.

getResourceAsStream(String). Method in class java.lang.ClassLoader

 Get an InputStream on a given resource.

getResponseCode(). Method in class java.net.HttpURLConnection

 Gets HTTP response status.

getResponseMessage(). Method in class java.net.HttpURLConnection

 Gets the HTTP response message, if any, returned along with the  response code from a server.

getResultSet(). Method in interface java.sql.Statement

 getResultSet returns the current result as a ResultSet.

getResultStream(boolean). Method in interface java.rmi.server.RemoteCall

 Returns an output stream (may put out header information  relating to the success of the call).

getReturnType(). Method in class java.lang.reflect.Method

 Returns a Class object that represents the formal return type  of the method represented by this Method object.

getRGB(). Method in class java.awt.Color

 Gets the RGB value representing the color in the default RGB ColorModel.

getRGB(). Method in class java.awt.SystemColor

 Gets the "current" RGB value representing the symbolic color.

getRGB(int). Method in class java.awt.image.ColorModel

 Returns the color of the pixel in the default RGB color model.

getRGB(int). Method in class java.awt.image.DirectColorModel

 Returns the color of the pixel in the default RGB color model.

getRGB(int). Method in class java.awt.image.IndexColorModel

 Returns the color of the pixel in the default RGB color model.

getRGBdefault(). Static method in class java.awt.image.ColorModel

 Return a ColorModel which describes the default format for  integer RGB values used throughout the AWT image interfaces.

getRows(). Method in class java.awt.GridLayout

 Returns the number of rows in this layout.

getRows(). Method in class java.awt.List

 Returns the number of visible lines in this list.

getRows(). Method in class java.awt.TextArea

 Returns the number of rows in the TextArea.

getRules(). Method in class java.text.RuleBasedCollator

 Gets the table-based rules for the collation object.

getRuntime(). Static method in class java.lang.Runtime

 Returns the runtime object associated with the current Java application.

getScale(int). Method in interface java.sql.ResultSetMetaData

 What's a column's number of digits to right of the decimal point?

getScaledInstance(int, int, int). Method in class java.awt.Image

 Returns a scaled version of this image.

getSchemaName(int). Method in interface java.sql.ResultSetMetaData

 What's a column's table's schema?

getSchemas(). Method in interface java.sql.DatabaseMetaData

 Get the schema names available in this database.

getSchemaTerm(). Method in interface java.sql.DatabaseMetaData

 What's the database vendor's preferred term for "schema"?

getScope(). Method in class java.security.Identity

 Returns this identity's scope.

getScreenResolution(). Method in class java.awt.Toolkit

 Returns the screen resolution in dots-per-inch.

getScreenSize(). Method in class java.awt.Toolkit

 Gets the size of the screen.

getScrollbarDisplayPolicy(). Method in class java.awt.ScrollPane

 Returns the display policy for the scrollbars.

getScrollbarVisibility(). Method in class java.awt.TextArea

 Returns the enumerated value describing which scrollbars  the text area has.

getScrollPosition(). Method in class java.awt.ScrollPane

 Returns the current x,y position within the child which is displayed  at the 0,0 location of the scrolled panel's view port.

getSearchStringEscape(). Method in interface java.sql.DatabaseMetaData

 This is the string that can be used to escape '_' or '%' in  the string pattern style catalog search parameters.

getSeconds(). Method in class java.sql.Date

 Returns the number of seconds past the minute represented by this date.

getSeconds(). Method in class java.util.Date

 Returns the number of seconds past the minute represented by this date.

getSecurityContext(). Method in class java.rmi.RMISecurityManager

 Returns the security context (e.g., a URL).

getSecurityContext(). Method in class java.lang.SecurityManager

 Creates an object that encapsulates the current execution  environment.

getSecurityContext(ClassLoader). Method in interface java.rmi.server. LoaderHandler

 Returns the security context of the given class loader  (e.g., a URL)

getSecurityContext(ClassLoader). Static method in class java.rmi.server. RMIClassLoader

 Returns the security context of the given class loader

getSecurityManager(). Static method in class java.lang.System

 Gets the system security interface.

getSeed(int). Static method in class java.security.SecureRandom

 Returns the given number of seed bytes, computed using the seed  generation algorithm that this class uses to seed itself.

getSelectedCheckbox(). Method in class java.awt.CheckboxGroup

 Gets the current choice.

getSelectedIndex(). Method in class java.awt.Choice

 Returns the index of the currently selected item.

getSelectedIndex(). Method in class java.awt.List

 Get the selected item on the list or -1 if no item is selected.

getSelectedIndexes(). Method in class java.awt.List

 Returns the selected indexes on the list.

getSelectedIndexes(). Method in interface java.awt.peer.ListPeer

 getSelectedItem(). Method in class java.awt.Choice

 Returns a String representation of the current choice.

getSelectedItem(). Method in class java.awt.List

 Returns the selected item on the list or null if no item is selected.

getSelectedItems(). Method in class java.awt.List

 Returns the selected items on the list in an array of Strings.

getSelectedObjects(). Method in class java.awt.Checkbox

 Returns the an array (length 1) containing the checkbox  label or null if the checkbox is not selected.

getSelectedObjects(). Method in class java.awt.CheckboxMenuItem

 Returns the an array (length 1) containing the checkbox menu item  label or null if the checkbox is not selected.

getSelectedObjects(). Method in class java.awt.Choice

 Returns an array (length 1) containing the currently selected  item.

getSelectedObjects(). Method in interface java.awt.ItemSelectable

 Returns the selected items or null if no items are selected.

getSelectedObjects(). Method in class java.awt.List

 Returns the selected items on the list in an array of Objects.

getSelectedText(). Method in class java.awt.TextComponent

 Returns the selected text contained in this TextComponent.

getSelectionEnd(). Method in class java.awt.TextComponent

 Returns the selected text's end position.

getSelectionEnd(). Method in interface java.awt.peer.TextComponentPeer

 getSelectionStart(). Method in class java.awt. TextComponent

 Returns the selected text's start position.

getSelectionStart(). Method in interface java.awt.peer.TextComponentPeer

 getSentenceInstance(). Static method in class java.text.BreakIterator

 Create BreakIterator for sentence-breaks using default locale  Returns an instance of a BreakIterator implementing sentence breaks.

getSentenceInstance(Locale). Static method in class java.text.BreakIterator

 Create BreakIterator for sentence-breaks using specified locale  Returns an instance of a BreakIterator implementing sentence breaks.

getSerialVersionUID(). Method in class java.io.ObjectStreamClass

 Return the serialVersionUID for this class.

getShort(int). Method in interface java.sql.CallableStatement

 Get the value of a SMALLINT parameter as a Java short.

getShort(int). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a Java short.

getShort(Object). Method in class java.lang.reflect.Field

 Get the value of a field as a short on specified object.

getShort(Object, int). Static method in class java.lang.reflect.Array

 Returns the value of the indexed component in the specified  array object, as a short.

getShort(String). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a Java short.

getShortcut(). Method in class java.awt.MenuItem

 Return the MenuShortcut associated with this MenuItem,  or null if none has been specified.

getShortcutMenuItem(MenuShortcut). Method in class java.awt.MenuBar

 Return the MenuItem associated with a MenuShortcut,  or null if none has been specified.

getShortDescription(). Method in class java.beans.FeatureDescriptor

 getShortMonths(). Method in class java.text. DateFormatSymbols

 Gets short month strings.

getShortWeekdays(). Method in class java.text.DateFormatSymbols

 Gets short weekday strings.

getSigners(). Method in class java.lang.Class

 Get the signers of this class.

getSize(). Method in class java.awt.Component

 Returns the current size of this component.

getSize(). Method in class java.awt.Dimension

 Returns the size of this Dimension object.

getSize(). Method in class java.awt.Font

 Gets the point size of the font.

getSize(). Method in class java.awt.Rectangle

 Returns the size (width by height) of this rectangle.

getSize(). Method in class sun.tools.debug.RemoteArray

 Return the number of elements in the array.

getSize(). Method in class java.util.zip.ZipEntry

 Returns the uncompressed size of the entry data, or -1 if not known.

getSocketFactory(). Static method in class java.rmi.server.RMISocketFactory

 Returns the socket factory used by RMI.

getSoLinger(). Method in class java.net.Socket

 Returns setting for SO_LINGER.

getSoTimeout(). Method in class java.net.DatagramSocket

 Retrive setting for SO_TIMEOUT.

getSoTimeout(). Method in class java.net.ServerSocket

 Retrive setting for SO_TIMEOUT.

getSoTimeout(). Method in class java.net.Socket

 Returns setting for SO_TIMEOUT.

getSource(). Method in class java.util.EventObject

 getSource(). Method in class java.awt.Image

 Gets the object that produces the pixels for the image.

getSourceFile(). Method in class sun.tools.debug.RemoteClass

 Get the source file referenced by this stackframe.

getSourceFileName(). Method in class sun.tools.debug.RemoteClass

 Get the name of the source file referenced by this stackframe.

getSourcePath(). Method in class sun.tools.debug.RemoteDebugger

 Return the source file path the Agent is currently using.

getSourceString(). Method in class java.text.CollationKey

 Returns the String that this CollationKey represents.

getSQLKeywords(). Method in interface java.sql.DatabaseMetaData

 Get a comma separated list of all a database's SQL keywords  that are NOT also SQL92 keywords.

getSQLState(). Method in class java.sql.SQLException

 Get the SQLState

getStackVariable(String). Method in class sun.tools.debug.RemoteThread

 Return a stack variable from the current stackframe.

getStackVariables(). Method in class sun.tools.debug.RemoteThread

 Return the arguments and local variable from the current stackframe.

getState(). Method in class java.awt.Checkbox

 Returns the boolean state of the Checkbox.

getState(). Method in class java.awt.CheckboxMenuItem

 Returns the state of this MenuItem.

getStateChange(). Method in class java.awt.event.ItemEvent

 Returns the state change type which generated the event.

getStaticFields(). Method in class sun.tools.debug.RemoteClass

 Return all the static fields for this class.

getStatus(). Method in class java.awt.image.PixelGrabber

 Return the status of the pixels.

getStatus(). Method in class sun.tools.debug.RemoteThread

 Return the thread status description

getStrength(). Method in class java.text.Collator

 Returns this Collator's strength property.

getString(int). Method in interface java.sql.CallableStatement

 Get the value of a CHAR, VARCHAR, or LONGVARCHAR parameter as a Java String.

getString(int). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a Java String.

getString(String). Method in class java.util.ResourceBundle

 Get an object from a ResourceBundle.

getString(String). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a Java String.

getStringArray(String). Method in class java.util.ResourceBundle

 Get an object from a ResourceBundle.

getStringFunctions(). Method in interface java.sql.DatabaseMetaData

 Get a comma separated list of string functions.

getStyle(). Method in class java.awt.Font

 Gets the style of the font.

getSuperclass(). Method in class java.lang.Class

 If this object represents any class other than the class  Object , then the object that represents the superclass  of that class is returned.

getSuperclass(). Method in class sun.tools.debug.RemoteClass

 Return the superclass for this class.

getSystemClipboard(). Method in class java.awt.Toolkit

 Returns an instance of the "system" clipboard which interfaces with  the clipboard facilities on the native platform.

getSystemEventQueue(). Method in class java.awt.Toolkit

 Get the application's or applet's EventQueue instance.

getSystemEventQueueImpl(). Method in class java.awt.Toolkit

 getSystemFunctions(). Method in interface java.sql. DatabaseMetaData

 Get a comma separated list of system functions.

getSystemResource(String). Static method in class java.lang.ClassLoader

 Find a resource with a given name.

getSystemResourceAsStream(String). Static method in class java.lang.ClassLoader

 Get an InputStream on a given resource..

getSystemScope(). Static method in class java.security.IdentityScope

 Returns the system's identity scope.

getTableName(int). Method in interface java.sql.ResultSetMetaData

 What's a column's table name?

getTablePrivileges(String, String, String). Method in interface java.sql. DatabaseMetaData

 Get a description of the access rights for each table available  in a catalog.

getTables(String, String, String, String[]). Method in interface java.sql. DatabaseMetaData

 Get a description of tables available in a catalog.

getTableTypes(). Method in interface java.sql.DatabaseMetaData

 Get the table types available in this database.

getTags(). Method in interface java.beans.PropertyEditor

 If the property value must be one of a set of known tagged values,  then this method should return an array of the tags.

getTags(). Method in class java.beans.PropertyEditorSupport

 If the property value must be one of a set of known tagged values,  then this method should return an array of the tag values.

getTargetException(). Method in class java.lang.reflect. InvocationTargetException

 Get the thrown target exception.

getTcpNoDelay(). Method in class java.net.Socket

 Tests if TCP_NODELAY is enabled.

getText(). Method in class java.text.BreakIterator

 Get the text being scanned

getText(). Method in class java.awt.Label

 Gets the text of this label.

getText(). Method in class java.awt.TextComponent

 Returns the text contained in this TextComponent.

getText(). Method in interface java.awt.peer.TextComponentPeer

 getThreadGroup(). Method in class java.lang. SecurityManager

 Returns the thread group into which to instantiate any new  thread being created at the time this is being called.

getThreadGroup(). Method in class java.lang.Thread

 Returns this thread's thread group.

getTime(). Method in class java.util.Calendar

 Gets this Calendar's current time.

getTime(). Method in class java.util.Date

 Returns the number of milliseconds since January 1, 1970, 00:00:00 GMT  represented by this date.

getTime(). Method in class java.util.zip.ZipEntry

 Returns the modification time of the entry, or -1 if not specified.

getTime(int). Method in interface java.sql.CallableStatement

 Get the value of a SQL TIME parameter as a java.sql.Time object.

getTime(int). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a java.sql.Time object.

getTime(String). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a java.sql.Time object.

getTimeDateFunctions(). Method in interface java.sql.DatabaseMetaData

 Get a comma separated list of time and date functions.

getTimeInMillis(). Method in class java.util.Calendar

 Gets this Calendar's current time as a long.

getTimeInstance(). Static method in class java.text.DateFormat

 Gets the time formatter with the default formatting style  for the default locale.

getTimeInstance(int). Static method in class java.text.DateFormat

 Gets the time formatter with the given formatting style  for the default locale.

getTimeInstance(int, Locale). Static method in class java.text.DateFormat

 Gets the time formatter with the given formatting style  for the given locale.

getTimestamp(int). Method in interface java.sql.CallableStatement

 Get the value of a SQL TIMESTAMP parameter as a java.sql.Timestamp object.

getTimestamp(int). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a java.sql.Timestamp object.

getTimestamp(String). Method in interface java.sql.ResultSet

 Get the value of a column in the current row as a java.sql.Timestamp object.

getTimeZone(). Method in class java.util.Calendar

 Gets the time zone.

getTimeZone(). Method in class java.text.DateFormat

 Gets the time zone.

getTimeZone(String). Static method in class java.util.TimeZone

 Gets the TimeZone for the given ID.

getTimezoneOffset(). Method in class java.util.Date

 Returns the local time-zone offset.

getTitle(). Method in class java.awt.Dialog

 Gets the title of the Dialog.

getTitle(). Method in class java.awt.Frame

 Gets the title of the Frame.

getToolkit(). Method in class java.awt.Component

 Gets the toolkit of the component.

getToolkit(). Method in interface java.awt.peer.ComponentPeer

 getToolkit(). Method in class java.awt.Window

 Returns the toolkit of this frame.

getTotalIn(). Method in class java.util.zip.Deflater

 Returns the total number of bytes input so far.

getTotalIn(). Method in class java.util.zip.Inflater

 Returns the total number of bytes input so far.

getTotalOut(). Method in class java.util.zip.Deflater

 Returns the total number of bytes output so far.

getTotalOut(). Method in class java.util.zip.Inflater

 Returns the total number of bytes output so far.

getTransactionIsolation(). Method in interface java.sql.Connection

 Get this Connection's current transaction isolation mode.

getTransferData(DataFlavor). Method in class java.awt.datatransfer. StringSelection

 If the data was requested in the "java.lang.String" flavor, return the  String representing the selection.

getTransferData(DataFlavor). Method in interface java.awt.datatransfer. Transferable

 Returns an object which represents the data to be transferred.

getTransferDataFlavors(). Method in class java.awt.datatransfer.StringSelection

 Returns the array of flavors in which it can provide the data.

getTransferDataFlavors(). Method in interface java.awt.datatransfer. Transferable

 Returns an array of DataFlavor objects indicating the flavors the data  can be provided in.

getTransferSize(). Method in class java.sql.DataTruncation

 Get the number of bytes of data actually transferred.

getTransparentPixel(). Method in class java.awt.image.IndexColorModel

 Returns the index of the transparent pixel in this IndexColorModel  or -1 if there is no transparent pixel.

getTreeLock(). Method in class java.awt.Component

 Gets the locking object for AWT component-tree and layout  operations.

getTTL(). Method in class java.net.DatagramSocketImpl

 Retrieve the TTL (time-to-live) option.

getTTL(). Method in class java.net.MulticastSocket

 Get the default time-to-live for multicast packets sent out  on the socket.

getType(). Method in class java.awt.Cursor

 Returns the type for this cursor.

getType(). Method in class java.lang.reflect.Field

 Returns a Class object that identifies the declared type for  the field represented by this Field object.

getType(). Method in class sun.tools.debug.RemoteField

 Returns a Type object for the field.

getType(). Method in class sun.tools.debug.RemoteStackVariable

 Returns a Type object for the field.

getType(). Method in class sun.tools.debug.RemoteValue

 Returns the RemoteValue's type.

getType(char). Static method in class java.lang.Character

 Returns a value indicating a character category.

getTypedName(). Method in class sun.tools.debug.RemoteField

 Returns a string describing the field with its full type.

getTypeInfo(). Method in interface java.sql.DatabaseMetaData

 Get a description of all the standard SQL types supported by  this database.

getUnicodeStream(int). Method in interface java.sql.ResultSet

 A column value can be retrieved as a stream of Unicode characters  and then read in chunks from the stream.

getUnicodeStream(String). Method in interface java.sql.ResultSet

 A column value can be retrieved as a stream of Unicode characters  and then read in chunks from the stream.

getUnitIncrement(). Method in interface java.awt.Adjustable

 Gets the unit value increment for the adjustable object.

getUnitIncrement(). Method in class java.awt.Scrollbar

 Gets the unit increment for this scrollbar.

getUpdateCount(). Method in interface java.sql.Statement

 getUpdateCount returns the current result as an update count;  if the result is a ResultSet or there are no more results, -1  is returned.

getUpdateRect(). Method in class java.awt.event.PaintEvent

 Returns the rectangle representing the area which needs to be  repainted in response to this event.

getURL(). Method in interface java.sql.DatabaseMetaData

 What's the url for this database?

getURL(). Method in class java.net.URLConnection

 Returns the value of this URLConnection's URL  field.

getUseCaches(). Method in class java.net.URLConnection

 Returns the value of this URLConnection's  useCaches field.

getUserName(). Method in interface java.sql.DatabaseMetaData

 What's our user name as known to the database?

getVAdjustable(). Method in class java.awt.ScrollPane

 Returns the Adjustable object which represents the state of  the vertical scrollbar.

getValue(). Method in interface java.awt.Adjustable

 Gets the current value of the adjustable object.

getValue(). Method in class java.awt.event.AdjustmentEvent

 Returns the current value in the adjustment event.

getValue(). Method in class java.util.zip.Adler32

 Returns checksum value.

getValue(). Method in interface java.util.zip.Checksum

 Returns the current checksum value.

getValue(). Method in class java.util.zip.CRC32

 Returns CRC-32 value.

getValue(). Method in class java.rmi.dgc.Lease

 Returns the lease duration.

getValue(). Method in interface java.beans.PropertyEditor

 getValue(). Method in class java.beans. PropertyEditorSupport

 getValue(). Method in class sun.tools.debug. RemoteStackVariable

 Return the value of a stack variable or argument.

getValue(). Method in class java.awt.Scrollbar

 Returns the current value of this Scrollbar.

getValue(String). Method in class java.beans.FeatureDescriptor

 Retrieve a named attribute with this feature.

getVariant(). Method in class java.util.Locale

 Getter for programmatic name of field.

getVersion(). Method in class java.security.Provider

 Returns the version number for this provider.

getVersionColumns(String, String, String). Method in interface java.sql. DatabaseMetaData

 Get a description of a table's columns that are automatically  updated when any value in a row is updated.

getVgap(). Method in class java.awt.BorderLayout

 Returns the vertical gap between components.

getVgap(). Method in class java.awt.CardLayout

 Returns the vertical gap between components.

getVgap(). Method in class java.awt.FlowLayout

 Returns the vertical gap between components.

getVgap(). Method in class java.awt.GridLayout

 Returns the vertical gap between components.

getViewportSize(). Method in class java.awt.ScrollPane

 Returns the current size of the scroll pane's view port.

getVisible(). Method in class java.awt.Scrollbar

 getVisibleAmount(). Method in interface java.awt. Adjustable

 Gets the length of the propertional indicator.

getVisibleAmount(). Method in class java.awt.Scrollbar

 Returns the visible amount of this Scrollbar.

getVisibleIndex(). Method in class java.awt.List

 Gets the index of the item that was last made visible by the method  makeVisible.

getVMID(). Method in class java.rmi.dgc.Lease

 Returns the client VMID associated with the lease.

getVScrollbarWidth(). Method in class java.awt.ScrollPane

 Returns the width that would be occupied by a vertical  scrollbar, which is independent of whether it is currently  displayed by the scroll pane or not.

getVScrollbarWidth(). Method in interface java.awt.peer.ScrollPanePeer

 getWarnings(). Method in interface java.sql. Connection

 The first warning reported by calls on this Connection is  returned.

getWarnings(). Method in interface java.sql.ResultSet

The first warning reported by calls on this ResultSet is  returned.

getWarnings(). Method in interface java.sql.Statement

 The first warning reported by calls on this Statement is  returned.

getWarningString(). Method in class java.awt.Window

 Gets the warning string for this window.

getWeekdays(). Method in class java.text.DateFormatSymbols

 Gets weekday strings.

getWhen(). Method in class java.awt.event.InputEvent

 Returns the timestamp of when this event occurred.

getWidth(). Method in class java.awt.image.PixelGrabber

 Get the width of the pixel buffer (after adjusting for image width).

getWidth(ImageObserver). Method in class java.awt.Image

 Gets the actual width of the image.

getWidths(). Method in class java.awt.FontMetrics

 Gets the advance widths of the first 256 characters in the Font.

getWindow(). Method in class java.awt.event.WindowEvent

 Returns the window where this event originated.

getWordInstance(). Static method in class java.text.BreakIterator

 Create BreakIterator for word-breaks using default locale.

getWordInstance(Locale). Static method in class java.text.BreakIterator

 Create BreakIterator for word-breaks using default locale.

getWriteMethod(). Method in class java.beans.PropertyDescriptor

 getX(). Method in interface java.security.interfaces. DSAPrivateKey

 Returns the value of the private key, x.

getX(). Method in class java.awt.event.MouseEvent

 Returns the x position of the event relative to the source component.

getY(). Method in interface java.security.interfaces.DSAPublicKey

 Returns the value of the public key, y.

getY(). Method in class java.awt.event.MouseEvent

 Returns the y position of the event relative to the source component.

getYear(). Method in class java.util.Date

 Returns the year represented by this date, minus 1900.

getYear(). Method in class java.sql.Time

 Returns the year represented by this date, minus 1900.

getZeroDigit(). Method in class java.text.DecimalFormatSymbols

 character used for zero.

getZoneStrings(). Method in class java.text.DateFormatSymbols

 Gets timezone strings.

GOT_FOCUS. Static variable in class java.awt.Event

 A component gained the focus.

gotFocus(Event, Object). Method in class java.awt.Component

 grabPixels(). Method in class java.awt.image. PixelGrabber

 Request the Image or ImageProducer to start delivering pixels and  wait for all of the pixels in the rectangle of interest to be  delivered.

grabPixels(long). Method in class java.awt.image.PixelGrabber

 Request the Image or ImageProducer to start delivering pixels and  wait for all of the pixels in the rectangle of interest to be  delivered or until the specified timeout has elapsed.

Graphics(). Constructor for class java.awt.Graphics

 Constructs a new Graphics object.

gray. Static variable in class java.awt.Color

 The color gray.

green. Static variable in class java.awt.Color

 The color green.

GregorianCalendar(). Constructor for class java.util.GregorianCalendar

 Constructs a default GregorianCalendar using the current time  in the default time zone with the default locale.

GregorianCalendar(int, int, int). Constructor for class java.util. GregorianCalendar

 Constructs a GregorianCalendar with the given date set  in the default time zone with the default locale.

GregorianCalendar(int, int, int, int, int). Constructor for class java.util. GregorianCalendar

 Constructs a GregorianCalendar with the given date  and time set for the default time zone with the default locale.

GregorianCalendar(int, int, int, int, int, int). Constructor for class java.util.GregorianCalendar

 Constructs a GregorianCalendar with the given date  and time set for the default time zone with the default locale.

GregorianCalendar(Locale). Constructor for class java.util.GregorianCalendar

 Constructs a GregorianCalendar based on the current time  in the default time zone with the given locale.

GregorianCalendar(TimeZone). Constructor for class java.util.GregorianCalendar

 Constructs a GregorianCalendar based on the current time  in the given time zone with the default locale.

GregorianCalendar(TimeZone, Locale). Constructor for class java.util. GregorianCalendar

 Constructs a GregorianCalendar based on the current time  in the given time zone with the given locale.

GridBagConstraints(). Constructor for class java.awt.GridBagConstraints

 GridBagLayout(). Constructor for class java.awt. GridBagLayout

 Creates a gridbag layout.

gridheight. Variable in class java.awt.GridBagConstraints

 GridLayout(). Constructor for class java.awt. GridLayout

 Creates a grid layout with a default of one column per component,  in a single row.

GridLayout(int, int). Constructor for class java.awt.GridLayout

 Creates a grid layout with the specified rows and columns.

GridLayout(int, int, int, int). Constructor for class java.awt.GridLayout

 Creates a grid layout with the specified rows, columns,  horizontal gap, and vertical gap.

gridwidth. Variable in class java.awt.GridBagConstraints

 gridx. Variable in class java.awt.GridBagConstraints

 gridy. Variable in class java.awt.GridBagConstraints

 grow(int, int). Method in class java.awt.Rectangle

 Grows the rectangle horizontally and vertically.

guessContentTypeFromName(String). Static method in class java.net. URLConnection

 Tries to determine the content type of an object, based  on the specified "file" component of a URL.

guessContentTypeFromStream(InputStream). Static method in class java.net. URLConnection

 Tries to determine the type of an input stream based on the  characters at the beginning of the input stream.

GZIP_MAGIC. Static variable in class java.util.zip.GZIPInputStream

 GZIP header magic number.

GZIPInputStream(InputStream). Constructor for class java.util.zip. GZIPInputStream

 Creates a new input stream with a default buffer size.

GZIPInputStream(InputStream, int). Constructor for class java.util.zip. GZIPInputStream

 Creates a new input stream with the specified buffer size.

GZIPOutputStream(OutputStream). Constructor for class java.util.zip. GZIPOutputStream

 Creates a new output stream with a default buffer size.

GZIPOutputStream(OutputStream, int). Constructor for class java.util.zip. GZIPOutputStream

 Creates a new output stream with the specified buffer size.

______________________________________________________________________________

  H

HAND_CURSOR. Static variable in class java.awt.Cursor

 The hand cursor type.

HAND_CURSOR. Static variable in class java.awt.Frame

 handleEvent(AWTEvent). Method in interface java.awt.peer.ComponentPeer

 handleEvent(Event). Method in class java.awt. Component

 handleGetObject(String). Method in class java.util. ListResourceBundle

 Override of ResourceBundle, same semantics

handleGetObject(String). Method in class java.util.PropertyResourceBundle

 Override of ResourceBundle, same semantics

handleGetObject(String). Method in class java.util.ResourceBundle

 Get an object from a ResourceBundle.

hasChanged(). Method in class java.util.Observable

 Tests if this object has changed.

hashCode(). Method in class java.math.BigDecimal

 Computes a hash code for this object.

hashCode(). Method in class java.math.BigInteger

 Computes a hash code for this object.

hashCode(). Method in class java.util.BitSet

 Returns a hash code value for this bit set.

hashCode(). Method in class java.lang.Boolean

 Returns a hash code for this Boolean.

hashCode(). Method in class java.lang.Byte

 Returns a hashcode for this Byte.

hashCode(). Method in class java.lang.Character

 Returns a hash code for this Character.

hashCode(). Method in class java.text.ChoiceFormat

 Generates a hash code for the message format object.

hashCode(). Method in class java.text.CollationKey

 Creates a hash code for this CollationKey.

hashCode(). Method in class java.text.Collator

 Generates the hash code for this Collator.

hashCode(). Method in class java.awt.Color

 Computes the hash code.

hashCode(). Method in class java.lang.reflect.Constructor

 Returns a hashcode for this Constructor.

hashCode(). Method in class java.util.Date

 Returns a hash code value for this object.

hashCode(). Method in class java.text.DateFormat

 Overrides hashCode

hashCode(). Method in class java.text.DateFormatSymbols

 Override hashCode.

hashCode(). Method in class java.text.DecimalFormat

 Overrides hashCode

hashCode(). Method in class java.text.DecimalFormatSymbols

 Override hashCode

hashCode(). Method in class java.lang.Double

 Returns a hashcode for this Double.

hashCode(). Method in class java.lang.reflect.Field

 Returns a hashcode for this Field.

hashCode(). Method in class java.io.File

 Computes a hashcode for the file.

hashCode(). Method in class java.lang.Float

 Returns a hashcode for this Float.

hashCode(). Method in class java.awt.Font

 Returns a hashcode for this font.

hashCode(). Method in class java.util.GregorianCalendar

 Override hashCode.

hashCode(). Method in class java.security.Identity

 Returns a hashcode for this identity.

hashCode(). Method in class java.net.InetAddress

 Returns a hashcode for this IP address.

hashCode(). Method in class java.lang.Integer

 Returns a hashcode for this Integer.

hashCode(). Method in class java.util.Locale

 Override hashCode.

hashCode(). Method in class java.lang.Long

 Computes a hashcode for this Long.

hashCode(). Method in class java.text.MessageFormat

 Generates a hash code for the message format object.

hashCode(). Method in class java.lang.reflect.Method

 Returns a hashcode for this Method.

hashCode(). Method in class java.text.NumberFormat

 Overrides hashCode

hashCode(). Method in class java.lang.Object

 Returns a hash code value for the object.

hashCode(). Method in class java.rmi.server.ObjID

 The hashcode is the object number.

hashCode(). Method in class java.awt.Point

 Returns the hashcode for this Point.

hashCode(). Method in interface java.security.Principal

 Returns a hashcode for this principal.

hashCode(). Method in class java.awt.Rectangle

 Returns the hashcode for this Rectangle.

hashCode(). Method in class java.rmi.server.RemoteObject

 Returns a hashcode for a remote object.

hashCode(). Method in class java.text.RuleBasedCollator

 Generates the hash code for the table-based collation object

hashCode(). Method in class java.lang.Short

 Returns a hashcode for this Short.

hashCode(). Method in class java.text.SimpleDateFormat

 Override hashCode.

hashCode(). Method in class java.util.SimpleTimeZone

 Override hashCode.

hashCode(). Method in class java.lang.String

 Returns a hashcode for this string.

hashCode(). Method in class java.text.StringCharacterIterator

 Compute a hashcode for this enumeration

hashCode(). Method in class java.rmi.server.UID

 Returns a hash code value for the object.

hashCode(). Method in class java.net.URL

 Creates an integer suitable for hash table indexing.

hashCode(). Method in class java.rmi.dgc.VMID

 Compute hash code for this VMID.

Hashtable(). Constructor for class java.util.Hashtable

 Constructs a new, empty hashtable with a default capacity and load  factor.

Hashtable(int). Constructor for class java.util.Hashtable

 Constructs a new, empty hashtable with the specified initial capacity  and default load factor.

Hashtable(int, float). Constructor for class java.util.Hashtable

 Constructs a new, empty hashtable with the specified initial  capacity and the specified load factor.

hasMoreElements(). Method in interface java.util.Enumeration

 Tests if this enumeration contains more elements.

hasMoreElements(). Method in class java.util.StringTokenizer

 Returns the same value as the hasMoreTokens  method.

hasMoreTokens(). Method in class java.util.StringTokenizer

 Tests if there are more tokens available from this tokenizer's string.

height. Variable in class java.awt.Dimension

 The height dimension.

HEIGHT. Static variable in interface java.awt.image.ImageObserver

 The height of the base image is now available and can be taken  from the height argument to the imageUpdate callback method.

height. Variable in class java.awt.Rectangle

 The height of the rectangle.

hide(). Method in class java.awt.Component

 hide(). Method in interface java.awt.peer. ComponentPeer

 DEPRECATED: Replaced by setVisible(boolean).

HOME. Static variable in class java.awt.Event

 The home action-key.

HORIZONTAL. Static variable in interface java.awt.Adjustable

 The horizontal orientation.

HORIZONTAL. Static variable in class java.awt.GridBagConstraints

 HORIZONTAL. Static variable in class java.awt. Scrollbar

 The horizontal Scrollbar variable.

HOUR. Static variable in class java.util.Calendar

 Useful constant for date and time.

HOUR0_FIELD. Static variable in class java.text.DateFormat

 Useful constant for zero-based HOUR field alignment.

HOUR1_FIELD. Static variable in class java.text.DateFormat

 Useful constant for one-based HOUR field alignment.

HOUR_OF_DAY. Static variable in class java.util.Calendar

 Useful constant for date and time.

HOUR_OF_DAY0_FIELD. Static variable in class java.text.DateFormat

 Useful constant for zero-based HOUR_OF_DAY field alignment.

HOUR_OF_DAY1_FIELD. Static variable in class java.text.DateFormat

 Useful constant for one-based HOUR_OF_DAY field alignment.

HSBtoRGB(float, float, float). Static method in class java.awt.Color

 Returns the RGB value defined by the default RGB ColorModel, of  the color corresponding to the given HSB color components.

HTTP_ACCEPTED. Static variable in class java.net.HttpURLConnection

 HTTP_BAD_GATEWAY. Static variable in class java.net. HttpURLConnection

 HTTP_BAD_METHOD. Static variable in class java.net. HttpURLConnection

 HTTP_BAD_REQUEST. Static variable in class java.net. HttpURLConnection

 4XX: client error

HTTP_CLIENT_TIMEOUT. Static variable in class java.net.HttpURLConnection

 HTTP_CONFLICT. Static variable in class java.net. HttpURLConnection

 HTTP_CREATED. Static variable in class java.net. HttpURLConnection

 HTTP_ENTITY_TOO_LARGE. Static variable in class java.net.HttpURLConnection

 HTTP_FORBIDDEN. Static variable in class java.net. HttpURLConnection

 HTTP_GATEWAY_TIMEOUT. Static variable in class java.net.HttpURLConnection

 HTTP_GONE. Static variable in class java.net. HttpURLConnection

 HTTP_INTERNAL_ERROR. Static variable in class java.net.HttpURLConnection

 HTTP_LENGTH_REQUIRED. Static variable in class java.net.HttpURLConnection

 HTTP_MOVED_PERM. Static variable in class java.net. HttpURLConnection

 HTTP_MOVED_TEMP. Static variable in class java.net. HttpURLConnection

 HTTP_MULT_CHOICE. Static variable in class java.net. HttpURLConnection

 3XX: relocation/redirect

HTTP_NO_CONTENT. Static variable in class java.net.HttpURLConnection

 HTTP_NOT_ACCEPTABLE. Static variable in class java.net.HttpURLConnection

 HTTP_NOT_AUTHORITATIVE. Static variable in class java.net.HttpURLConnection

 HTTP_NOT_FOUND. Static variable in class java.net. HttpURLConnection

 HTTP_NOT_MODIFIED. Static variable in class java.net.HttpURLConnection

 HTTP_OK. Static variable in class java.net. HttpURLConnection

 2XX: generally "OK"

HTTP_PARTIAL. Static variable in class java.net.HttpURLConnection

 HTTP_PAYMENT_REQUIRED. Static variable in class java.net.HttpURLConnection

 HTTP_PRECON_FAILED. Static variable in class java.net.HttpURLConnection

 HTTP_PROXY_AUTH. Static variable in class java.net. HttpURLConnection

 HTTP_REQ_TOO_LONG. Static variable in class java.net.HttpURLConnection

 HTTP_RESET. Static variable in class java.net. HttpURLConnection

 HTTP_SEE_OTHER. Static variable in class java.net. HttpURLConnection

 HTTP_SERVER_ERROR. Static variable in class java.net.HttpURLConnection

 5XX: server error

HTTP_UNAUTHORIZED. Static variable in class java.net.HttpURLConnection

 HTTP_UNAVAILABLE. Static variable in class java.net. HttpURLConnection

 HTTP_UNSUPPORTED_TYPE. Static variable in class java.net.HttpURLConnection

 HTTP_USE_PROXY. Static variable in class java.net. HttpURLConnection

 HTTP_VERSION. Static variable in class java.net. HttpURLConnection

 HttpURLConnection(URL). Constructor for class java.net.HttpURLConnection

 Constructor for the URLStreamHandler.

HUFFMAN_ONLY. Static variable in class java.util.zip.Deflater

 Compression strategy for Huffman coding only.

______________________________________________________________________________

  I

ICON_COLOR_16x16. Static variable in interface java.beans.BeanInfo

 Constant to indicate a 16 x 16 color icon.

ICON_COLOR_32x32. Static variable in interface java.beans.BeanInfo

 Constant to indicate a 32 x 32 color icon.

ICON_MONO_16x16. Static variable in interface java.beans.BeanInfo

 Constant to indicate a 16 x 16 monochrome icon.

ICON_MONO_32x32. Static variable in interface java.beans.BeanInfo

 Constant to indicate a 32 x 32 monochrome icon.

id. Variable in class java.awt.AWTEvent

 id. Variable in class java.awt.Event

 The type of this event.

IDENTICAL. Static variable in class java.text.Collator

 Collator strength value.

identities(). Method in class java.security.IdentityScope

 Returns an enumeration of all identities in this identity scope.

Identity(). Constructor for class java.security.Identity

 Constructor for serialization only.

Identity(String). Constructor for class java.security.Identity

 Constructs an identity with the specified name and no scope.

Identity(String, IdentityScope). Constructor for class java.security.Identity

 Constructs an identity with the specified name and scope.

identityEquals(Identity). Method in class java.security.Identity

 Tests for equality between the specified identity and this identity.

identityHashCode(Object). Static method in class java.lang.System

 Returns the same hashcode for the given object as  would be returned by the default method hashCode(),  whether or not the given object's class overrides  hashCode().

IdentityScope(). Constructor for class java.security.IdentityScope

 This constructor is used for serialization only and should not  be used by subclasses.

IdentityScope(String). Constructor for class java.security.IdentityScope

 Constructs a new identity scope with the specified name.

IdentityScope(String, IdentityScope). Constructor for class java.security. IdentityScope

 Constructs a new identity scope with the specified name and scope.

IEEEremainder(double, double). Static method in class java.lang.Math

 Computes the remainder operation on two arguments as prescribed  by the IEEE 754 standard.

ifModifiedSince. Variable in class java.net.URLConnection

 Some protocols support skipping the fetching of the object unless  the object has been modified more recently than a certain time.

ignoreExceptions(). Method in class sun.tools.debug.RemoteClass

 Don't enter the debugger when an instance of this class is thrown.

IllegalAccessError(). Constructor for class java.lang.IllegalAccessError

 Constructs an IllegalAccessError with no detail message.

IllegalAccessError(String). Constructor for class java.lang.IllegalAccessError

 Constructs an IllegalAccessError with the specified  detail message.

IllegalAccessException(). Constructor for class java.lang. IllegalAccessException

 Constructs an IllegalAccessException without a  detail message.

IllegalAccessException(String). Constructor for class java.lang. IllegalAccessException

 Constructs an IllegalAccessException with a detail message.

IllegalArgumentException(). Constructor for class java.lang. IllegalArgumentException

 Constructs an IllegalArgumentException with no  detail message.

IllegalArgumentException(String). Constructor for class java.lang. IllegalArgumentException

 Constructs an IllegalArgumentException with the  specified detail message.

IllegalComponentStateException(). Constructor for class java.awt. IllegalComponentStateException

 Constructs an IllegalComponentStateException with no detail message.

IllegalComponentStateException(String). Constructor for class java.awt. IllegalComponentStateException

 Constructs an IllegalComponentStateException with the specified detail  message.

IllegalMonitorStateException(). Constructor for class java.lang. IllegalMonitorStateException

 Constructs an IllegalMonitorStateException with no  detail message.

IllegalMonitorStateException(String). Constructor for class java.lang. IllegalMonitorStateException

 Constructs an IllegalMonitorStateException with the  specified detail message.

IllegalStateException(). Constructor for class java.lang.IllegalStateException

 Constructs an IllegalStateException with no detail message.

IllegalStateException(String). Constructor for class java.lang. IllegalStateException

 Constructs an IllegalStateException with the specified detail  message.

IllegalThreadStateException(). Constructor for class java.lang. IllegalThreadStateException

 Constructs an IllegalThreadStateException with no  detail message.

IllegalThreadStateException(String). Constructor for class java.lang. IllegalThreadStateException

 Constructs an IllegalThreadStateException with the  specified detail message.

Image(). Constructor for class java.awt.Image

 IMAGEABORTED. Static variable in interface java.awt.image.ImageConsumer

 The image creation process was deliberately aborted.

imageComplete(int). Method in interface java.awt.image.ImageConsumer

 The imageComplete method is called when the ImageProducer is  finished delivering all of the pixels that the source image  contains, or when a single frame of a multi-frame animation has  been completed, or when an error in loading or producing the  image has occured.

imageComplete(int). Method in class java.awt.image.ImageFilter

 Filters the information provided in the imageComplete method of  the ImageConsumer interface.

imageComplete(int). Method in class java.awt.image.PixelGrabber

 The imageComplete method is part of the ImageConsumer API which  this class must implement to retrieve the pixels.

IMAGEERROR. Static variable in interface java.awt.image.ImageConsumer

 An error was encountered while producing the image.

ImageFilter(). Constructor for class java.awt.image.ImageFilter

 imageUpdate(Image, int, int, int, int, int). Method in class java.awt.Component

 Repaints the component when the image has changed.

imageUpdate(Image, int, int, int, int, int). Method in interface java.awt.image. ImageObserver

 This method is called when information about an image which was  previously requested using an asynchronous interface becomes  available.

implAccept(Socket). Method in class java.net.ServerSocket

 Subclasses of ServerSocket use this method to override accept()  to return their own subclass of socket.

importedKeyCascade. Static variable in interface java.sql.DatabaseMetaData

 IMPORT KEY UPDATE_RULE and DELETE_RULE - for update, change  imported key to agree with primary key update; for delete,  delete rows that import a deleted key.

importedKeyInitiallyDeferred. Static variable in interface java.sql. DatabaseMetaData

 IMPORT KEY DEFERRABILITY - see SQL92 for definition

importedKeyInitiallyImmediate. Static variable in interface java.sql. DatabaseMetaData

 IMPORT KEY DEFERRABILITY - see SQL92 for definition

importedKeyNoAction. Static variable in interface java.sql.DatabaseMetaData

 IMPORT KEY UPDATE_RULE and DELETE_RULE - do not allow update or  delete of primary key if it has been imported.

importedKeyNotDeferrable. Static variable in interface java.sql. DatabaseMetaData

 IMPORT KEY DEFERRABILITY - see SQL92 for definition

importedKeyRestrict. Static variable in interface java.sql.DatabaseMetaData

 IMPORT KEY UPDATE_RULE and DELETE_RULE - do not allow update or  delete of primary key if it has been imported.

importedKeySetDefault. Static variable in interface java.sql.DatabaseMetaData

 IMPORT KEY UPDATE_RULE and DELETE_RULE - change imported key to  default values if its primary key has been updated or deleted.

importedKeySetNull. Static variable in interface java.sql.DatabaseMetaData

 IMPORT KEY UPDATE_RULE and DELETE_RULE - change imported key to  NULL if its primary key has been updated or deleted.

in. Static variable in class java.io.FileDescriptor

 A handle to the standard input stream.

in. Variable in class java.io.FilterInputStream

 The underlying input stream.

in. Variable in class java.io.FilterReader

 The underlying character-input stream, or null if the stream has been  closed

in. Variable in class java.io.PipedInputStream

 in. Static variable in class java.lang.System

 The "standard" input stream.

INACTIVE_CAPTION. Static variable in class java.awt.SystemColor

 The array index for the inactive caption background color.

INACTIVE_CAPTION_BORDER. Static variable in class java.awt.SystemColor

 The array index for the inactive caption border color.

INACTIVE_CAPTION_TEXT. Static variable in class java.awt.SystemColor

 The array index for the inactive caption text color.

inactiveCaption. Static variable in class java.awt.SystemColor

 The background color for inactive captions in window borders.

inactiveCaptionBorder. Static variable in class java.awt.SystemColor

 The border color for inactive captios in window borders.

inactiveCaptionText. Static variable in class java.awt.SystemColor

 The text color for inactive captions in window borders.

inCheck. Variable in class java.lang.SecurityManager

 This field is true if there is a security check in  progress; false  otherwise.

inClass(String). Method in class java.lang.SecurityManager

 Tests if the specified String is in this Class.

inClassLoader(). Method in class java.lang.SecurityManager

 Tests if the current ClassLoader is equal to  null.

IncompatibleClassChangeError(). Constructor for class java.lang. IncompatibleClassChangeError

 Constructs an IncompatibleClassChangeError with no  detail message.

IncompatibleClassChangeError(String). Constructor for class java.lang. IncompatibleClassChangeError

 Constructs an IncompatibleClassChangeError with the  specified detail message.

inDaylightTime(Date). Method in class java.util.SimpleTimeZone

 Overrides TimeZone  Queries if the given date is in Daylight Savings Time.

inDaylightTime(Date). Method in class java.util.TimeZone

 Queries if the given date is in Daylight Savings Time in  this time zone.

IndexColorModel(int, int, byte[], byte[], byte[]). Constructor for class java.awt.image.IndexColorModel

 Constructs an IndexColorModel from the given arrays of red,  green, and blue components.

IndexColorModel(int, int, byte[], byte[], byte[], byte[]). Constructor for class java.awt.image.IndexColorModel

 Constructs an IndexColorModel from the given arrays of red,  green, blue and alpha components.

IndexColorModel(int, int, byte[], byte[], byte[], int). Constructor for class java.awt.image.IndexColorModel

 Constructs an IndexColorModel from the given arrays of red,  green, and blue components.

IndexColorModel(int, int, byte[], int, boolean). Constructor for class java.awt.image.IndexColorModel

 Constructs an IndexColorModel from a single arrays of packed  red, green, blue and optional alpha components.

IndexColorModel(int, int, byte[], int, boolean, int). Constructor for class java.awt.image.IndexColorModel

 Constructs an IndexColorModel from a single arrays of packed  red, green, blue and optional alpha components.

IndexedPropertyDescriptor(String, Class). Constructor for class java.beans. IndexedPropertyDescriptor

 This constructor constructs an IndexedPropertyDescriptor for a property  that follows the standard Java conventions by having getFoo and setFoo  accessor methods, for both indexed access and array access.

IndexedPropertyDescriptor(String, Class, String, String, String, String). Constructor for class java.beans.IndexedPropertyDescriptor

 This constructor takes the name of a simple property, and method  names for reading and writing the property, both indexed  and non-indexed.

IndexedPropertyDescriptor(String, Method, Method, Method, Method). Constructor for class java.beans.IndexedPropertyDescriptor

 This constructor takes the name of a simple property, and Method  objects for reading and writing the property.

indexOf(int). Method in class java.lang.String

 Returns the index within this string of the first occurrence of the  specified character.

indexOf(int, int). Method in class java.lang.String

 Returns the index within this string of the first occurrence of the  specified character, starting the search at the specified index.

indexOf(Object). Method in class java.util.Vector

 Searches for the first occurence of the given argument, testing  for equality using the equals method.

indexOf(Object, int). Method in class java.util.Vector

 Searches for the first occurence of the given argument, beginning  the search at index , and testing for equality using  the equals method.

indexOf(String). Method in class java.lang.String

 Returns the index within this string of the first occurrence of the  specified substring.

indexOf(String, int). Method in class java.lang.String

 Returns the index within this string of the first occurrence of the  specified substring, starting at the specified index.

IndexOutOfBoundsException(). Constructor for class java.lang. IndexOutOfBoundsException

 Constructs an IndexOutOfBoundsException with no  detail message.

IndexOutOfBoundsException(String). Constructor for class java.lang. IndexOutOfBoundsException

 Constructs an IndexOutOfBoundsException with the  specified detail message.

inf. Variable in class java.util.zip.InflaterInputStream

 Decompressor for this stream.

inflate(byte[]). Method in class java.util.zip.Inflater

 Uncompresses bytes into specified buffer.

inflate(byte[], int, int). Method in class java.util.zip.Inflater

 Uncompresses bytes into specified buffer.

Inflater(). Constructor for class java.util.zip.Inflater

 Creates a new decompressor.

Inflater(boolean). Constructor for class java.util.zip.Inflater

 Creates a new decompressor.

InflaterInputStream(InputStream). Constructor for class java.util.zip. InflaterInputStream

 Creates a new input stream with a default decompressor and buffer size.

InflaterInputStream(InputStream, Inflater). Constructor for class java.util.zip.InflaterInputStream

 Creates a new input stream with the specified decompressor and a  default buffer size.

InflaterInputStream(InputStream, Inflater, int). Constructor for class java.util.zip.InflaterInputStream

 Creates a new input stream with the specified decompressor and  buffer size.

info. Static variable in class java.awt.SystemColor

 The background color for info(help) text.

INFO. Static variable in class java.awt.SystemColor

 The array index for the info background color.

INFO_TEXT. Static variable in class java.awt.SystemColor

 The array index for the info text color.

infoText. Static variable in class java.awt.SystemColor

 The text color for info(help) text.

init(). Method in class java.applet.Applet

 Called by the browser or applet viewer to inform  this applet that it has been loaded into the system.

initialize(DSAParams, SecureRandom). Method in interface java.security.interfaces.DSAKeyPairGenerator

 Initializes the key pair generator using p, q and g, the DSA  family parameters.

initialize(int). Method in class java.security.KeyPairGenerator

 Initializes the key pair generator for a certain strength using  a system-provided source of randomness.

initialize(int, boolean, SecureRandom). Method in interface java.security.interfaces.DSAKeyPairGenerator

 Initializes the key pair generator for a given modulus length,  without parameters.

initialize(int, SecureRandom). Method in class java.security.KeyPairGenerator

 Initializes the key pair generator for a certain strength.

initSign(PrivateKey). Method in class java.security.Signature

 Initialize this object for signing.

initVerify(PublicKey). Method in class java.security.Signature

 Initializes this object for verification.

InputStream(). Constructor for class java.io.InputStream

 InputStreamReader(InputStream). Constructor for class java.io.InputStreamReader

 Create an InputStreamReader that uses the default character encoding.

InputStreamReader(InputStream, String). Constructor for class java.io. InputStreamReader

 Create an InputStreamReader that uses the named character encoding.

inScope(). Method in class sun.tools.debug.RemoteStackVariable

 Return whether variable is in scope.

INSERT. Static variable in class java.awt.Event

 The Insert key.

insert(int, boolean). Method in class java.lang.StringBuffer

 Inserts the string representation of the boolean  argument into this string buffer.

insert(int, char). Method in class java.lang.StringBuffer

 Inserts the string representation of the char  argument into this string buffer.

insert(int, char[]). Method in class java.lang.StringBuffer

 Inserts the string representation of the char array  argument into this string buffer.

insert(int, double). Method in class java.lang.StringBuffer

 Inserts the string representation of the double  argument into this string buffer.

insert(int, float). Method in class java.lang.StringBuffer

 Inserts the string representation of the float  argument into this string buffer.

insert(int, int). Method in class java.lang.StringBuffer

 Inserts the string representation of the second int  argument into this string buffer.

insert(int, long). Method in class java.lang.StringBuffer

 Inserts the string representation of the long  argument into this string buffer.

insert(int, Object). Method in class java.lang.StringBuffer

 Inserts the string representation of the Object  argument into this string buffer.

insert(int, String). Method in class java.lang.StringBuffer

 Inserts the string into this string buffer.

insert(MenuItem, int). Method in class java.awt.Menu

 Inserts the MenuItem to this menu at the specified position.

insert(String, int). Method in class java.awt.Choice

 Inserts the item into this choice at the specified position.

insert(String, int). Method in class java.awt.Menu

 Inserts an item with the specified label to this menu  at the specified position.

insert(String, int). Method in class java.awt.TextArea

 Inserts the specified text at the specified position.

insert(String, int). Method in interface java.awt.peer.TextAreaPeer

 insertElementAt(Object, int). Method in class java.util.Vector

 Inserts the specified object as a component in this vector at the  specified index.

insertProviderAt(Provider, int). Static method in class java.security.Security

 Adds a new provider, at a specified position.

insertSeparator(int). Method in class java.awt.Menu

 Inserts a separator at the specified position

insertText(String, int). Method in class java.awt.TextArea

 insertText(String, int). Method in interface java.awt.peer.TextAreaPeer

 DEPRECATED: Replaced by insert(String, int).

insets. Variable in class java.awt.GridBagConstraints

 insets(). Method in class java.awt.Container

 insets(). Method in interface java.awt.peer. ContainerPeer

 DEPRECATED: Replaced by getInsets().

Insets(int, int, int, int). Constructor for class java.awt.Insets

 Constructs and initializes a new Inset with the specified top,  left, bottom, and right insets.

inside(int, int). Method in class java.awt.Component

 inside(int, int). Method in class java.awt.Polygon

 inside(int, int). Method in class java.awt.Rectangle

 instantiate(ClassLoader, String). Static method in class java.beans.Beans

 Instantiate a bean.

InstantiationError(). Constructor for class java.lang.InstantiationError

 Constructs an InstantiationError with no detail message.

InstantiationError(String). Constructor for class java.lang.InstantiationError

 Constructs an InstantiationError with the specified  detail message.

InstantiationException(). Constructor for class java.lang. InstantiationException

 Constructs an InstantiationException with no detail message.

InstantiationException(String). Constructor for class java.lang. InstantiationException

 Constructs an InstantiationException with the  specified detail message.

intBitsToFloat(int). Static method in class java.lang.Float

 Returns the single-float corresponding to a given bit represention.

INTEGER. Static variable in class java.sql.Types

 Integer(int). Constructor for class java.lang. Integer

 Constructs a newly allocated Integer object that  represents the primitive int argument.

Integer(String). Constructor for class java.lang.Integer

 Constructs a newly allocated Integer object that  represents the value represented by the string.

INTEGER_FIELD. Static variable in class java.text.NumberFormat

 Field constant used to construct a FieldPosition object.

INTERFACE. Static variable in class java.lang.reflect.Modifier

 intern(). Method in class java.lang.String

 Returns a canonical representation for the string object.

InternalError(). Constructor for class java.lang.InternalError

 Constructs an InternalError with no detail message.

InternalError(String). Constructor for class java.lang.InternalError

 Constructs an InternalError with the specified  detail message.

internalGet(int). Method in class java.util.Calendar

 Gets the value for a given time field.

interrupt(). Method in class java.lang.Thread

 Interrupts this thread.

interrupted(). Static method in class java.lang.Thread

 Tests is the current thread has been interrupted.

InterruptedException(). Constructor for class java.lang.InterruptedException

 Constructs an InterruptedException with no detail message.

InterruptedException(String). Constructor for class java.lang. InterruptedException

 Constructs an InterruptedException with the  specified detail message.

InterruptedIOException(). Constructor for class java.io.InterruptedIOException

 Constructs an InterruptedIOException with no detail  message.

InterruptedIOException(String). Constructor for class java.io. InterruptedIOException

 Constructs an InterruptedIOException with the  specified detail message.

intersection(Rectangle). Method in class java.awt.Rectangle

 Computes the intersection of two rectangles.

intersects(Rectangle). Method in class java.awt.Rectangle

 Checks if two rectangles intersect.

IntrospectionException(String). Constructor for class java.beans. IntrospectionException

 intValue(). Method in class java.math.BigDecimal

 Converts this number to an int.

intValue(). Method in class java.math.BigInteger

 Converts this number to an int.

intValue(). Method in class java.lang.Byte

 Returns the value of this Byte as an int.

intValue(). Method in class java.lang.Double

 Returns the integer value of this Double (by casting to an int).

intValue(). Method in class java.lang.Float

 Returns the integer value of this Float (by casting to an int).

intValue(). Method in class java.lang.Integer

 Returns the value of this Integer as an int.

intValue(). Method in class java.lang.Long

 Returns the value of this Long as an int.

intValue(). Method in class java.lang.Number

 Returns the value of the specified number as an int.

intValue(). Method in class java.lang.Short

 Returns the value of this Short as an int.

invalidate(). Method in class java.awt.Component

 Invalidates the component.

invalidate(). Method in class java.awt.Container

 Invalidates the container.

invalidateLayout(Container). Method in class java.awt.BorderLayout

 Invalidates the layout, indicating that if the layout manager  has cached information it should be discarded.

invalidateLayout(Container). Method in class java.awt.CardLayout

 Invalidates the layout, indicating that if the layout manager  has cached information it should be discarded.

invalidateLayout(Container). Method in class java.awt.GridBagLayout

 Invalidates the layout, indicating that if the layout manager  has cached information it should be discarded.

invalidateLayout(Container). Method in interface java.awt.LayoutManager2

 Invalidates the layout, indicating that if the layout manager  has cached information it should be discarded.

InvalidClassException(String). Constructor for class java.io. InvalidClassException

 Report a InvalidClassException for the specified reason.

InvalidClassException(String, String). Constructor for class java.io. InvalidClassException

 InvalidKeyException(). Constructor for class java.security.InvalidKeyException

 Constructs an InvalidKeyException with no detail message.

InvalidKeyException(String). Constructor for class java.security. InvalidKeyException

 Constructs an InvalidKeyException with the specified detail  message.

InvalidObjectException(String). Constructor for class java.io. InvalidObjectException

 Raised by a class when it is explicitly disallowing itself to  be serialized.

InvalidParameterException(). Constructor for class java.security. InvalidParameterException

 Constructs an InvalidParameterException with no detail message.

InvalidParameterException(String). Constructor for class java.security. InvalidParameterException

 Constructs an InvalidParameterException with the specified  detail message.

InvocationTargetException(). Constructor for class java.lang.reflect. InvocationTargetException

 InvocationTargetException(Throwable). Constructor for class java.lang.reflect.InvocationTargetException

 Constructs a InvocationTargetException with a target exception.

InvocationTargetException(Throwable, String). Constructor for class java.lang.reflect.InvocationTargetException

 Constructs a InvocationTargetException with a target exception  and a detail message.

invoke(Object, Object[]). Method in class java.lang.reflect.Method

 Invokes the underlying method represented by this Method  object, on the specified object with the specified parameters.

invoke(RemoteCall). Method in interface java.rmi.server.RemoteRef

 Executes the remote call.

IOException(). Constructor for class java.io.IOException

 Constructs an IOException with no detail message.

IOException(String). Constructor for class java.io.IOException

 Constructs an IOException with the specified detail  message.

ipadx. Variable in class java.awt.GridBagConstraints

 ipady. Variable in class java.awt.GridBagConstraints

 isAbsolute(). Method in class java.io.File

 Tests if the file represented by this File object is an  absolute pathname.

isAbstract(int). Static method in class java.lang.reflect.Modifier

 Return true if the specifier integer includes the abstract  modifier.

isActionKey(). Method in class java.awt.event.KeyEvent

 Returns whether or not the key in this event is an "action" key.

isActive(). Method in class java.applet.Applet

 Determines if this applet is active.

isActive(). Method in interface java.applet.AppletStub

 Determines if the applet is active.

isAlive(). Method in class java.lang.Thread

 Tests if this thread is alive.

isAltDown(). Method in class java.awt.event.InputEvent

 Returns whether or not the Alt modifier is down on this event.

isAncestorOf(Component). Method in class java.awt.Container

 Checks if the component is contained in the component hierarchy of  this container.

isArray(). Method in class java.lang.Class

 If this Class object represents an array type, returns true,  otherwise returns false.

isAssignableFrom(Class). Method in class java.lang.Class

 Determines if the class or interface  represented by this Class object is either the same as, or is a  superclass or superinterface of, the class or interface  represented by the specified Class parameter.

isAutoIncrement(int). Method in interface java.sql.ResultSetMetaData

 Is the column automatically numbered, thus read-only?

isBold(). Method in class java.awt.Font

 Returns true if the font is bold.

isBound(). Method in class java.beans.PropertyDescriptor

 Updates to "bound" properties will cause a "PropertyChange" event to  get fired when the property is changed.

isCaseSensitive(int). Method in interface java.sql.ResultSetMetaData

 Does a column's case matter?

isCatalogAtStart(). Method in interface java.sql.DatabaseMetaData

 Does a catalog appear at the start of a qualified table name?  (Otherwise it appears at the end)

isClosed(). Method in interface java.sql.Connection

 Tests to see if a Connection is closed.

isConstrained(). Method in class java.beans.PropertyDescriptor

 Attempted updates to "Constrained" properties will cause a "VetoableChange"  event to get fired when the property is changed.

isConsumed(). Method in class java.awt.AWTEvent

 isConsumed(). Method in class java.awt.event. InputEvent

 Returns whether or not this event has been consumed.

isConsumer(ImageConsumer). Method in class java.awt.image.FilteredImageSource

 Determines whether an ImageConsumer is on the list of consumers  currently interested in data for this image.

isConsumer(ImageConsumer). Method in interface java.awt.image.ImageProducer

 This method determines if a given ImageConsumer object  is currently registered with this ImageProducer as one  of its consumers.

isConsumer(ImageConsumer). Method in class java.awt.image.MemoryImageSource

 Determine if an ImageConsumer is on the list of consumers currently  interested in data for this image.

isControlDown(). Method in class java.awt.event.InputEvent

 Returns whether or not the Control modifier is down on this event.

isCurrency(int). Method in interface java.sql.ResultSetMetaData

 Is the column a cash value?

isDaemon(). Method in class java.lang.Thread

 Tests if this thread is a daemon thread.

isDaemon(). Method in class java.lang.ThreadGroup

 Tests if this thread group is a daemon thread group.

isDataFlavorSupported(DataFlavor). Method in class java.awt.datatransfer. StringSelection

 Returns whether the requested flavor is supported by this object.

isDataFlavorSupported(DataFlavor). Method in interface java.awt.datatransfer. Transferable

 Returns whether or not the specified data flavor is supported for  this object.

isDecimalSeparatorAlwaysShown(). Method in class java.text.DecimalFormat

 Allows you to get the behavior of the decimal separator with integers.

isDefined(char). Static method in class java.lang.Character

 Determines if a character has a defined meaning in Unicode.

isDefinitelyWritable(int). Method in interface java.sql.ResultSetMetaData

 Will a write on the column definitely succeed?

isDesignTime(). Static method in class java.beans.Beans

 Test if we are in design-mode.

isDestroyed(). Method in class java.lang.ThreadGroup

 Tests if this thread group has not been destroyed.

isDigit(char). Static method in class java.lang.Character

 Determines if the specified character is a digit.

isDirectory(). Method in class java.io.File

 Tests if the file represented by this File  object is a directory.

isDirectory(). Method in class java.util.zip.ZipEntry

 Returns true if this is a directory entry.

isEditable(). Method in class java.awt.TextComponent

 Returns the boolean indicating whether this TextComponent is  editable or not.

isEmpty(). Method in class java.util.Dictionary

 Tests if this dictionary maps no keys to value.

isEmpty(). Method in class java.util.Hashtable

 Tests if this hashtable maps no keys to values.

isEmpty(). Method in class java.awt.Rectangle

 Determines whether the rectangle is empty.

isEmpty(). Method in class java.util.Vector

 Tests if this vector has no components.

isEnabled(). Method in class java.awt.Component

 Checks if this Component is enabled.

isEnabled(). Method in class java.awt.MenuItem

 Checks whether the menu item is enabled.

isEqual(byte[], byte[]). Static method in class java.security. MessageDigest

 Compares two digests for equality.

isErrorAny(). Method in class java.awt.MediaTracker

 Checks the error status of all of the images.

isErrorID(int). Method in class java.awt.MediaTracker

 Checks the error status of all of the images with the specified ID.

isExpert(). Method in class java.beans.FeatureDescriptor

 The "expert" flag is used to distinguish between those features that are  intended for expert users from those that are intended for normal users.

isFile(). Method in class java.io.File

 Tests if the file represented by this File  object is a "normal" file.

isFinal(int). Static method in class java.lang.reflect.Modifier

 Return true if the specifier integer includes the final  modifier.

isFocusTraversable(). Method in class java.awt.Component

 Returns whether this component can be traversed using  Tab or Shift-Tab keyboard focus traversal.

isFocusTraversable(). Method in interface java.awt.peer.ComponentPeer

 isGroupingUsed(). Method in class java.text. NumberFormat

 Returns true if grouping is used in this format.

isGuiAvailable(). Static method in class java.beans.Beans

 isHidden(). Method in class java.beans. FeatureDescriptor

 The "hidden" flag is used to identify features that are intended only  for tool use, and which should not be exposed to humans.

isIdentifierIgnorable(char). Static method in class java.lang.Character

 Determines if the specified character should be regarded as  an ignorable character in a Java identifier or a Unicode identifier.

isInDefaultEventSet(). Method in class java.beans.EventSetDescriptor

 Report if an event set is in the "default set".

isIndexSelected(int). Method in class java.awt.List

 Returns true if the item at the specified index has been selected;  false otherwise.

isInfinite(). Method in class java.lang.Double

 Returns true if this Double value is infinitely large in magnitude.

isInfinite(). Method in class java.lang.Float

 Returns true if this Float value is infinitely large in magnitude.

isInfinite(double). Static method in class java.lang.Double

 Returns true if the specified number is infinitely large in magnitude.

isInfinite(float). Static method in class java.lang.Float

 Returns true if the specified number is infinitely large in magnitude.

isInstance(Object). Method in class java.lang.Class

 This method is the dynamic equivalent of the Java language  instanceof operator.

isInstanceOf(Object, Class). Static method in class java.beans.Beans

 Check if a bean can be viewed as a given target type.

isInterface(). Method in class java.lang.Class

 Determines if the specified Class object represents an interface type.

isInterface(). Method in class sun.tools.debug.RemoteClass

 Is this RemoteClass an interface?

isInterface(int). Static method in class java.lang.reflect.Modifier

 Return true if the specifier integer includes the interface  modifier.

isInterrupted(). Method in class java.lang.Thread

 Tests if the current thread has been interrupted.

isISOControl(char). Static method in class java.lang.Character

 Determines if the specified character is an ISO control character.

isItalic(). Method in class java.awt.Font

 Returns true if the font is italic.

isJavaIdentifierPart(char). Static method in class java.lang.Character

 Determines if the specified character may be part of a Java  identifier as other than the first character.

isJavaIdentifierStart(char). Static method in class java.lang.Character

 Determines if the specified character is  permissible as the first character in a Java identifier.

isJavaLetter(char). Static method in class java.lang.Character

 Determines if the specified character is a  "Java" letter, that is, the character is permissible  as the first character in an identifier in the Java language.

isJavaLetterOrDigit(char). Static method in class java.lang.Character

 Determines if the specified character is a  "Java" letter or digit, that is, the character is  permissible as a non-initial character in an identifier in the  Java language.

isLeapYear(int). Method in class java.util.GregorianCalendar

 Determines if the given year is a leap year.

isLenient(). Method in class java.util.Calendar

 Tell whether date/time interpretation is to be lenient.

isLenient(). Method in class java.text.DateFormat

 Tell whether date/time parsing is to be lenient.

isLetter(char). Static method in class java.lang.Character

 Determines if the specified character is a letter.

isLetterOrDigit(char). Static method in class java.lang.Character

 Determines if the specified character is a letter or digit.

isLowerCase(char). Static method in class java.lang.Character

 Determines if the specified character is a lowercase character.

isMember(Principal). Method in interface java.security.acl.Group

 Returns true if the passed principal is a member of the group.

isMetaDown(). Method in class java.awt.event.InputEvent

 Returns whether or not the Meta modifier is down on this event.

isMimeTypeEqual(DataFlavor). Method in class java.awt.datatransfer.DataFlavor

 Convenience function equivalent to calling:  isMimeTypeEqual(dataFlavor.getMimeType());

isMimeTypeEqual(String). Method in class java.awt.datatransfer.DataFlavor

 Is the string representation of the MIME type passed in equivalent  to the MIME type of this DataFlavor.

isModal(). Method in class java.awt.Dialog

 Returns true if the Dialog is modal.

isMulticastAddress(). Method in class java.net.InetAddress

 Utility routine to check if the InetAddress is a  IP multicast address.

isMultipleMode(). Method in class java.awt.List

 Returns true if this list allows multiple selections.

isNaN(). Method in class java.lang.Double

 Returns true if this Double value is the special Not-a-Number (NaN)  value.

isNaN(). Method in class java.lang.Float

 Returns true if this Float value is Not-a-Number (NaN).

isNaN(double). Static method in class java.lang.Double

 Returns true if the specified number is the special Not-a-Number (NaN)  value.

isNaN(float). Static method in class java.lang.Float

 Returns true if the specified number is the special Not-a-Number (NaN)  value.

isNative(int). Static method in class java.lang.reflect.Modifier

 Return true if the specifier integer includes the native  modifier.

isNegative(). Method in interface java.security.acl.AclEntry

 Returns true if this is a negative ACL entry (one denying the  associated principal the set of permissions in the entry), false  otherwise.

isNullable(int). Method in interface java.sql.ResultSetMetaData

 Can you put a NULL in this column?

isObject(). Method in class sun.tools.debug.RemoteValue

 Returns whether the RemoteValue is an Object (as opposed to  a primitive type, such as int).

isOwner(Principal). Method in interface java.security.acl.Owner

 Returns true if the given principal is an owner of the ACL.

isPaintable(). Method in interface java.beans.PropertyEditor

 isPaintable(). Method in class java.beans. PropertyEditorSupport

 isParseIntegerOnly(). Method in class java.text. NumberFormat

 Returns true if this format will parse numbers as integers only.

isPlain(). Method in class java.awt.Font

 Returns true if the font is plain.

isPopupTrigger(). Method in class java.awt.event.MouseEvent

 Returns whether or not this mouse event is the popup-menu  trigger event for the platform.

isPrimitive(). Method in class java.lang.Class

 Determines if the specified Class object represents a primitive Java  type.

isPrivate(int). Static method in class java.lang.reflect.Modifier

 Return true if the specifier integer includes the private  modifier.

isProbablePrime(int). Method in class java.math.BigInteger

 Returns true if this BigInteger is probably prime, false if it's  definitely composite.

isProtected(int). Static method in class java.lang.reflect.Modifier

 Return true if the specifier integer includes the protected  modifier.

isPublic(int). Static method in class java.lang.reflect.Modifier

 Return true if the specified integer includes the public  modifier.

isReadOnly(). Method in interface java.sql.Connection

 Tests to see if the connection is in read-only mode.

isReadOnly(). Method in interface java.sql.DatabaseMetaData

 Is the database in read-only mode?

isReadOnly(int). Method in interface java.sql.ResultSetMetaData

 Is a column definitely not writable?

isResizable(). Method in class java.awt.Dialog

 Returns true if the user can resize the dialog.

isResizable(). Method in class java.awt.Frame

 Returns true if the user can resize the Frame.

isSearchable(int). Method in interface java.sql.ResultSetMetaData

 Can the column be used in a where clause?

isSelected(int). Method in class java.awt.List

 isSet. Variable in class java.util.Calendar

 The flags which tell if a specified time field for the calendar is set.

isSet(int). Method in class java.util.Calendar

 Determines if the given time field has a value set.

isShiftDown(). Method in class java.awt.event.InputEvent

 Returns whether or not the Shift modifier is down on this event.

isShowing(). Method in class java.awt.Component

 Checks if this Component is showing on screen.

isShowing(). Method in class java.awt.Window

 Checks if this Window is showing on screen.

isSigned(int). Method in interface java.sql.ResultSetMetaData

 Is the column a signed number?

isSpace(char). Static method in class java.lang.Character

 Determines if the specified character is ISO-LATIN-1 white space.

isSpaceChar(char). Static method in class java.lang.Character

 Determines if the specified character is a Unicode space character.

isStatic(). Method in class sun.tools.debug.RemoteField

 Returns whether the field is static (a class variable or method).

isStatic(int). Static method in class java.lang.reflect.Modifier

 Return true if the specifier integer includes the static  modifier.

isString(). Method in class sun.tools.debug.RemoteValue

 Returns whether the RemoteValue is an instance of java.lang.String.

isSuspended(). Method in class sun.tools.debug.RemoteThread

 Return whether this thread is suspended.

isSynchronized(int). Static method in class java.lang.reflect.Modifier

 Return true if the specifier integer includes the final  modifier.

isTearOff(). Method in class java.awt.Menu

 Returns true if this is a tear-off menu.

isTemporary(). Method in class java.awt.event.FocusEvent

 Returns whether or not this focus change event is a temporary  change.

isTimeSet. Variable in class java.util.Calendar

 The flag which indicates if the current time is set for the calendar.

isTitleCase(char). Static method in class java.lang.Character

 Determines if the specified character is a titlecase character.

isTransient(int). Static method in class java.lang.reflect.Modifier

 Return true if the specifier integer includes the transient  modifier.

isUnicast(). Method in class java.beans.EventSetDescriptor

 Normally event sources are multicast.

isUnicodeIdentifierPart(char). Static method in class java.lang.Character

 Determines if the specified character may be part of a Unicode  identifier as other than the first character.

isUnicodeIdentifierStart(char). Static method in class java.lang.Character

 Determines if the specified character is  permissible as the first character in a Unicode identifier.

isUnique(). Static method in class java.rmi.dgc.VMID

 Return true if an accurate address can be determined for this  host.

isUpperCase(char). Static method in class java.lang.Character

 Determines if the specified character is an uppercase character.

isValid(). Method in class java.awt.Component

 Checks if this Component is valid.

isVisible(). Method in class java.awt.Component

 Checks if this Component is visible.

isVolatile(int). Static method in class java.lang.reflect.Modifier

 Return true if the specifier integer includes the volatile  modifier.

isWhitespace(char). Static method in class java.lang.Character

 Determines if the specified character is white space according to Java.

isWritable(int). Method in interface java.sql.ResultSetMetaData

 Is it possible for a write on the column to succeed?

ITALIAN. Static variable in class java.util.Locale

 Useful constant for language.

ITALIC. Static variable in class java.awt.Font

 The italicized style constant.

ITALY. Static variable in class java.util.Locale

 Useful constant for country.

ITEM_EVENT_MASK. Static variable in class java.awt.AWTEvent

 The event mask for selecting item events.

ITEM_FIRST. Static variable in class java.awt.event.ItemEvent

 Marks the first integer id for the range of item event ids.

ITEM_LAST. Static variable in class java.awt.event.ItemEvent

 Marks the last integer id for the range of item event ids.

ITEM_STATE_CHANGED. Static variable in class java.awt.event.ItemEvent

 The item state changed event type.

ItemEvent(ItemSelectable, int, Object, int). Constructor for class java.awt.event.ItemEvent

 Constructs a ItemSelectEvent object with the specified ItemSelectable source,  type, item, and item select state.

itemStateChanged(ItemEvent). Method in class java.awt.AWTEventMulticaster

 Handles the itemStateChanged event by invoking the  itemStateChanged methods on listener-a and listener-b.

itemStateChanged(ItemEvent). Method in interface java.awt.event.ItemListener

 Invoked when an item's state has been changed.

itrace(boolean). Method in class sun.tools.debug.RemoteDebugger

 Turn on/off instruction tracing.

______________________________________________________________________________

  J

JANUARY. Static variable in class java.util.Calendar

 Useful constant for month.

JAPAN. Static variable in class java.util.Locale

 Useful constant for country.

JAPANESE. Static variable in class java.util.Locale

 Useful constant for language.

jdbcCompliant(). Method in interface java.sql.Driver

 Report whether the Driver is a genuine JDBC COMPLIANT (tm) driver.

join(). Method in class java.lang.Thread

 Waits for this thread to die.

join(InetAddress). Method in class java.net.DatagramSocketImpl

 Join the multicast group.

join(long). Method in class java.lang.Thread

 Waits at most millis milliseconds for this thread to  die.

join(long, int). Method in class java.lang.Thread

 Waits at most millis milliseconds plus  nanos  nanoseconds for this thread to die.

joinGroup(InetAddress). Method in class java.net.MulticastSocket

 Joins a multicast group.

JULY. Static variable in class java.util.Calendar

 Useful constant for month.

JUNE. Static variable in class java.util.Calendar

 Useful constant for month.

______________________________________________________________________________

  K

key. Variable in class java.awt.Event

 The key code that was pressed in a keyboard event.

KEY_ACTION. Static variable in class java.awt.Event

 The action-key press keyboard event.

KEY_ACTION_RELEASE. Static variable in class java.awt.Event

 The action-key release keyboard event.

KEY_EVENT_MASK. Static variable in class java.awt.AWTEvent

 The event mask for selecting key events.

KEY_FIRST. Static variable in class java.awt.event.KeyEvent

 Marks the first integer id for the range of key event ids.

KEY_LAST. Static variable in class java.awt.event.KeyEvent

 Marks the last integer id for the range of key event ids.

KEY_PRESS. Static variable in class java.awt.Event

 The key press keyboard event.

KEY_PRESSED. Static variable in class java.awt.event.KeyEvent

 The key pressed event type.

KEY_RELEASE. Static variable in class java.awt.Event

 The key release keyboard event.

KEY_RELEASED. Static variable in class java.awt.event.KeyEvent

 The key released event type.

KEY_TYPED. Static variable in class java.awt.event.KeyEvent

 The key typed event type.

KeyAdapter(). Constructor for class java.awt.event.KeyAdapter

 keyDown(Event, int). Method in class java.awt. Component

 KeyEvent(Component, int, long, int, int). Constructor for class java.awt.event.KeyEvent

 KeyEvent(Component, int, long, int, int, char). Constructor for class java.awt.event.KeyEvent

 Constructs a KeyEvent object with the specified source component,  type, modifiers, and key.

KeyException(). Constructor for class java.security.KeyException

 Constructs a KeyException with no detail message.

KeyException(String). Constructor for class java.security.KeyException

 Constructs a KeyException with the specified detail message.

KeyManagementException(). Constructor for class java.security. KeyManagementException

 Constructs a KeyManagementException with no detail message.

KeyManagementException(String). Constructor for class java.security. KeyManagementException

 Constructs a KeyManagementException with the specified detail  message.

KeyPair(PublicKey, PrivateKey). Constructor for class java.security.KeyPair

 Constructs a key with the specified public key and private key.

KeyPairGenerator(String). Constructor for class java.security.KeyPairGenerator

 Creates a KeyPairGenerator object for the specified algorithm.

keyPressed(KeyEvent). Method in class java.awt.AWTEventMulticaster

 Handles the keyPressed event by invoking the  keyPressed methods on listener-a and listener-b.

keyPressed(KeyEvent). Method in class java.awt.event.KeyAdapter

 keyPressed(KeyEvent). Method in interface java.awt.event.KeyListener

 Invoked when a key has been pressed.

keyReleased(KeyEvent). Method in class java.awt.AWTEventMulticaster

 Handles the keyReleased event by invoking the  keyReleased methods on listener-a and listener-b.

keyReleased(KeyEvent). Method in class java.awt.event.KeyAdapter

 keyReleased(KeyEvent). Method in interface java.awt.event.KeyListener

 Invoked when a key has been released.

keys(). Method in class java.util.Dictionary

 Returns an enumeration of the keys in this dictionary.

keys(). Method in class java.util.Hashtable

 Returns an enumeration of the keys in this hashtable.

keyTyped(KeyEvent). Method in class java.awt.AWTEventMulticaster

 Handles the keyTyped event by invoking the  keyTyped methods on listener-a and listener-b.

keyTyped(KeyEvent). Method in class java.awt.event.KeyAdapter

 keyTyped(KeyEvent). Method in interface java.awt.event.KeyListener

 Invoked when a key has been typed.

keyUp(Event, int). Method in class java.awt.Component

 KOREA. Static variable in class java.util.Locale

 Useful constant for country.

KOREAN. Static variable in class java.util.Locale

 Useful constant for language.

______________________________________________________________________________

  L

Label(). Constructor for class java.awt.Label

 Constructs an empty label.

Label(String). Constructor for class java.awt.Label

 Constructs a new label with the specified String of text.

Label(String, int). Constructor for class java.awt.Label

 Constructs a new label with the specified String of  text and the specified alignment.

last(). Method in class java.text.BreakIterator

 Return the last boundary.

last(). Method in interface java.text.CharacterIterator

 Set the position to getEndIndex()-1, return the character at that position.

last(). Method in class java.text.StringCharacterIterator

 Set the position to getEndIndex() and return the character at that  position.

last(Container). Method in class java.awt.CardLayout

 Flips to the last card of the specified container.

lastElement(). Method in class java.util.Vector

 Returns the last component of the vector.

lastIndexOf(int). Method in class java.lang.String

 Returns the index within this string of the last occurrence of the  specified character.

lastIndexOf(int, int). Method in class java.lang.String

 Returns the index within this string of the last occurrence of the  specified character, searching backward starting at the specified index.

lastIndexOf(Object). Method in class java.util.Vector

 Returns the index of the last occurrence of the specified object in  this vector.

lastIndexOf(Object, int). Method in class java.util.Vector

 Searches backwards for the specified object, starting from the  specified index, and returns an index to it.

lastIndexOf(String). Method in class java.lang.String

 Returns the index within this string of the rightmost occurrence  of the specified substring.

lastIndexOf(String, int). Method in class java.lang.String

 Returns the index within this string of the last occurrence of  the specified substring.

lastModified(). Method in class java.io.File

 Returns the time that the file represented by this  File object was last modified.

LastOwnerException(). Constructor for class java.security.acl. LastOwnerException

 Constructs a LastOwnerException.

lastPageFirst(). Method in class java.awt.PrintJob

 Returns true if the last page will be printed first.

layout(). Method in class java.awt.Component

 layout(). Method in class java.awt.Container

 layout(). Method in class java.awt.ScrollPane

 layoutContainer(Container). Method in class java.awt.BorderLayout

 Lays out the specified container.

layoutContainer(Container). Method in class java.awt.CardLayout

 Performs a layout in the specified panel.

layoutContainer(Container). Method in class java.awt.FlowLayout

 Lays out the container.

layoutContainer(Container). Method in class java.awt.GridBagLayout

 Lays out the container in the specified panel.

layoutContainer(Container). Method in class java.awt.GridLayout

 Lays out the container in the specified panel.

layoutContainer(Container). Method in interface java.awt.LayoutManager

 Lays out the container in the specified panel.

layoutInfo. Variable in class java.awt.GridBagLayout

 Lease(VMID, long). Constructor for class java.rmi.dgc.Lease

 Constructs a lease with a specific VMID and lease duration.

leave(InetAddress). Method in class java.net.DatagramSocketImpl

 Leave the multicast group.

leaveGroup(InetAddress). Method in class java.net.MulticastSocket

 Leave a multicast group.

LEFT. Static variable in class java.awt.Event

 The left arrow action-key.

LEFT. Static variable in class java.awt.FlowLayout

 The left alignment variable.

left. Variable in class java.awt.Insets

 The inset from the left.

LEFT. Static variable in class java.awt.Label

 The left alignment.

LEFT_ALIGNMENT. Static variable in class java.awt.Component

 Ease of use constant for getAlignmentX().

len. Variable in class java.util.zip.InflaterInputStream

 Length of input buffer.

length. Variable in class java.io.OptionalDataException

 The number of bytes available to be read in the current buffer.

length(). Method in class java.io.File

 Returns the length of the file represented by this  File object.

length(). Method in class java.io.RandomAccessFile

 Returns the length of this file.

length(). Method in class java.lang.String

 Returns the length of this string.

length(). Method in class java.lang.StringBuffer

 Returns the length (character count) of this string buffer.

LETTER_NUMBER. Static variable in class java.lang.Character

 lightGray. Static variable in class java.awt.Color

 The color light gray.

LINE_SEPARATOR. Static variable in class java.lang.Character

 lineno(). Method in class java.io.StreamTokenizer

 Return the current line number.

LineNumberInputStream(InputStream). Constructor for class java.io. LineNumberInputStream

 Constructs a newline number input stream that reads its input  from the specified input stream.

LineNumberReader(Reader). Constructor for class java.io.LineNumberReader

 Create a new line-numbering reader, using the default input-buffer  size.

LineNumberReader(Reader, int). Constructor for class java.io.LineNumberReader

 Create a new line-numbering reader, reading characters into a buffer of  the given size.

LinkageError(). Constructor for class java.lang.LinkageError

 Constructs a LinkageError with no detail message.

LinkageError(String). Constructor for class java.lang.LinkageError

 Constructs a LinkageError with the specified detail  message.

list(). Method in class java.awt.Component

 Prints a listing to System.out.

list(). Method in class java.io.File

 Returns a list of the files in the directory specified by this  File object.

List(). Constructor for class java.awt.List

 Creates a new scrolling list initialized with no visible Lines  or multiple selections.

list(). Method in interface java.rmi.registry.Registry

 Returns an array of the names in the registry.

list(). Method in class java.lang.ThreadGroup

 Prints information about this thread group to the standard  output.

list(FilenameFilter). Method in class java.io.File

 Returns a list of the files in the directory specified by this  File  that satisfy the specified filter.

List(int). Constructor for class java.awt.List

 Creates a new scrolling list initialized with the specified  number of visible lines and a boolean stating whether multiple  selections are allowed or not.

List(int, boolean). Constructor for class java.awt.List

 Creates a new scrolling list initialized with the specified  number of visible lines and a boolean stating whether multiple  selections are allowed or not.

list(PrintStream). Method in class java.awt.Component

 Prints a listing to the specified print stream.

list(PrintStream). Method in class java.util.Properties

 Prints this property list out to the specified output stream.

list(PrintStream, int). Method in class java.awt.Component

 Prints out a list, starting at the specified indention, to the specified  print stream.

list(PrintStream, int). Method in class java.awt.Container

 Prints out a list, starting at the specified indention, to the specified  out stream.

list(PrintWriter). Method in class java.awt.Component

 Prints a listing to the specified print writer.

list(PrintWriter). Method in class java.util.Properties

 Prints this property list out to the specified output stream.

list(PrintWriter, int). Method in class java.awt.Component

 Prints out a list, starting at the specified indention, to the specified  print writer.

list(PrintWriter, int). Method in class java.awt.Container

 Prints out a list, starting at the specified indention, to the specified  print writer.

list(String). Static method in class java.rmi.Naming

 Returns an array of strings of the URLs in the registry.

LIST_DESELECT. Static variable in class java.awt.Event

 LIST_SELECT. Static variable in class java.awt.Event

 listBreakpoints(). Method in class sun.tools.debug. RemoteDebugger

 Return a list of the breakpoints which are currently set.

listClasses(). Method in class sun.tools.debug.RemoteDebugger

 List the currently known classes.

listen(int). Method in class java.net.SocketImpl

 Sets the maximum queue length for incoming connection indications  (a request to connect) to the count argument.

ListResourceBundle(). Constructor for class java.util.ListResourceBundle

 listThreadGroups(RemoteThreadGroup). Method in class sun.tools.debug.RemoteDebugger

 List threadgroups

listThreads(boolean). Method in class sun.tools.debug.RemoteThreadGroup

 List a threadgroup's threads

LOAD. Static variable in class java.awt.FileDialog

 The file load variable.

load(InputStream). Method in class java.util.Properties

 Reads a property list from an input stream.

load(String). Method in class java.lang.Runtime

 Loads the specified filename as a dynamic library.

load(String). Static method in class java.lang.System

 Loads the specified filename as a dynamic library.

LOAD_FILE. Static variable in class java.awt.Event

 A file loading event.

loadClass(String). Method in class java.lang.ClassLoader

 Requests the class loader to load a class with the specified  name.

loadClass(String). Method in interface java.rmi.server.LoaderHandler

 Load class using java.rmi.server.codebase property.

loadClass(String). Static method in class java.rmi.server.RMIClassLoader

 Load a class from the URL specified in the  java.rmi.server.codebase property.

loadClass(String, boolean). Method in class java.lang.ClassLoader

 Resolves the specified name to a Class.

loadClass(URL, String). Method in interface java.rmi.server.LoaderHandler

 Load class from codebase URL specified.

loadClass(URL, String). Static method in class java.rmi.server.RMIClassLoader

 Load a class from a URL.

loadImage(String). Method in class java.beans.SimpleBeanInfo

 This is a utility method to help in loading icon images.

LOADING. Static variable in class java.awt.MediaTracker

 Flag indicating some media is currently being loaded.

loadLibrary(String). Method in class java.lang.Runtime

 Loads the dynamic library with the specified library name.

loadLibrary(String). Static method in class java.lang.System

 Loads the system library specified by the libname  argument.

loadSystemColors(int[]). Method in class java.awt.Toolkit

 Fills in the provided int array with the current system color values

locale. Variable in class java.awt.Component

 The locale for the component.

Locale(String, String). Constructor for class java.util.Locale

 Construct a locale from language, country.

Locale(String, String, String). Constructor for class java.util.Locale

 Construct a locale from language, country, variant.

localPort. Variable in class java.net.DatagramSocketImpl

 localport. Variable in class java.net.SocketImpl

 The local port number to which this socket is connected.

locate(int, int). Method in class java.awt.Component

 locate(int, int). Method in class java.awt.Container

 location(). Method in class java.awt.Component

 location(int, int). Method in class java.awt. GridBagLayout

 lock. Variable in class java.io.Reader

 The object used to synchronize operations on this stream.

lock. Variable in class java.io.Writer

 The object used to synchronize operations on this stream.

log(double). Static method in class java.lang.Math

 Returns the natural logarithm (base e) of a double  value.

log(String). Static method in class java.rmi.server.LogStream

 Return the LogStream identified by the given name.

LONG. Static variable in class java.text.DateFormat

 Constant for long style pattern.

Long(long). Constructor for class java.lang.Long

 Constructs a newly allocated Long object that  represents the primitive long argument.

Long(String). Constructor for class java.lang.Long

 Constructs a newly allocated Long object that  represents the value represented by the string.

longBitsToDouble(long). Static method in class java.lang.Double

 Returns the double-float corresponding to a given bit represention.

longValue(). Method in class java.math.BigDecimal

 Converts this number to a long.

longValue(). Method in class java.math.BigInteger

 Converts this number to a long.

longValue(). Method in class java.lang.Byte

 Returns the value of this Byte as a long.

longValue(). Method in class java.lang.Double

 Returns the long value of this Double (by casting to a long).

longValue(). Method in class java.lang.Float

 Returns the long value of this Float (by casting to a long).

longValue(). Method in class java.lang.Integer

 Returns the value of this Integer as a long.

longValue(). Method in class java.lang.Long

 Returns the value of this Long as a long.

longValue(). Method in class java.lang.Number

 Returns the value of the specified number as a long.

longValue(). Method in class java.lang.Short

 Returns the value of this Short as a long.

LONGVARBINARY. Static variable in class java.sql.Types

 LONGVARCHAR. Static variable in class java.sql.Types

 lookup(Class). Static method in class java.io. ObjectStreamClass

 Find the descriptor for a class that can be serialized.

lookup(String). Static method in class java.rmi.Naming

 Returns the remote object for the URL.

lookup(String). Method in interface java.rmi.registry.Registry

 Returns the remote object associated with the specified name in the  registry.

lookupConstraints(Component). Method in class java.awt.GridBagLayout

 Retrieves the constraints for the specified component.

loop(). Method in interface java.applet.AudioClip

 Starts playing this audio clip in a loop.

LOST_FOCUS. Static variable in class java.awt.Event

 A component lost the focus.

lostFocus(Event, Object). Method in class java.awt.Component

 lostOwnership(Clipboard, Transferable). Method in interface java.awt.datatransfer.ClipboardOwner

 Notifies this object that it is no longer the owner of  the contents of the clipboard.

lostOwnership(Clipboard, Transferable). Method in class java.awt.datatransfer. StringSelection

 LOWERCASE_LETTER. Static variable in class java.lang.Character

 lowerCaseMode(boolean). Method in class java.io. StreamTokenizer

 Determines whether or not word token are automatically lowercased.

______________________________________________________________________________

  M

magenta. Static variable in class java.awt.Color

 The color magneta.

makeVisible(int). Method in class java.awt.List

 Forces the item at the specified index to be visible.

makeVisible(int). Method in interface java.awt.peer.ListPeer

 MalformedURLException(). Constructor for class java.net.MalformedURLException

 Constructs a MalformedURLException with no detail message.

MalformedURLException(String). Constructor for class java.net. MalformedURLException

 Constructs a MalformedURLException with the  specified detail message.

MARCH. Static variable in class java.util.Calendar

 Useful constant for month.

mark. Variable in class java.io.ByteArrayInputStream

 The currently marked position in the stream.

mark(int). Method in class java.io.BufferedInputStream

 Marks the current position in this input stream.

mark(int). Method in class java.io.BufferedReader

 Mark the present position in the stream.

mark(int). Method in class java.io.ByteArrayInputStream

 Set the current marked position in the stream.

mark(int). Method in class java.io.CharArrayReader

 Mark the present position in the stream.

mark(int). Method in class java.io.FilterInputStream

 Marks the current position in this input stream.

mark(int). Method in class java.io.FilterReader

 Mark the present position in the stream.

mark(int). Method in class java.io.InputStream

 Marks the current position in this input stream.

mark(int). Method in class java.io.LineNumberInputStream

 Marks the current position in this input stream.

mark(int). Method in class java.io.LineNumberReader

 Mark the present position in the stream.

mark(int). Method in class java.io.Reader

 Mark the present position in the stream.

mark(int). Method in class java.io.StringReader

 Mark the present position in the stream.

markedPos. Variable in class java.io.CharArrayReader

 Position of mark in buffer

marklimit. Variable in class java.io.BufferedInputStream

 The maximum read ahead allowed after a call to the  mark  method before subsequent calls to the  reset method fail.

markpos. Variable in class java.io.BufferedInputStream

 The value of the pos field at the time the last  mark method was called.

markSupported(). Method in class java.io.BufferedInputStream

 Tests if this input stream supports the mark  and reset methods.

markSupported(). Method in class java.io.BufferedReader

 Tell whether this stream supports the mark() operation, which it does.

markSupported(). Method in class java.io.ByteArrayInputStream

 Tests if ByteArrayInputStream supports mark/reset.

markSupported(). Method in class java.io.CharArrayReader

 Tell whether this stream supports the mark() operation, which it does.

markSupported(). Method in class java.io.FilterInputStream

 Tests if this input stream supports the mark  and reset methods.

markSupported(). Method in class java.io.FilterReader

 Tell whether this stream supports the mark() operation.

markSupported(). Method in class java.io.InputStream

 Tests if this input stream supports the mark  and reset methods.

markSupported(). Method in class java.io.PushbackInputStream

 Tests if the input stream supports the mark and  reset methods.

markSupported(). Method in class java.io.PushbackReader

 Tell whether this stream supports the mark() operation, which it does  not.

markSupported(). Method in class java.io.Reader

 Tell whether this stream supports the mark() operation.

markSupported(). Method in class java.io.StringReader

 Tell whether this stream supports the mark() operation, which it does.

MarshalException(String). Constructor for class java.rmi.MarshalException

 Create a new marshal exception with a descriptive string.

MarshalException(String, Exception). Constructor for class java.rmi. MarshalException

 Create a new marshal exception with a descriptive string and an  exception.

MATH_SYMBOL. Static variable in class java.lang.Character

 max(BigDecimal). Method in class java.math.BigDecimal

 Returns the BigDecimal whose value is the greater of this and val.

max(BigInteger). Method in class java.math.BigInteger

 Returns the BigInteger whose value is the greater of this and val.

max(double, double). Static method in class java.lang.Math

 Returns the greater of two double values.

max(float, float). Static method in class java.lang.Math

 Returns the greater of two float values.

max(int, int). Static method in class java.lang.Math

 Returns the greater of two int values.

max(long, long). Static method in class java.lang.Math

 Returns the greater of two long values.

MAX_PRIORITY. Static variable in class java.lang.Thread

 The maximum priority that a thread can have.

MAX_RADIX. Static variable in class java.lang.Character

 The maximum radix available for conversion to and from Strings.

MAX_VALUE. Static variable in class java.lang.Byte

 The maximum value a Byte can have.

MAX_VALUE. Static variable in class java.lang.Character

 The constant value of this field is the largest value of type  char.

MAX_VALUE. Static variable in class java.lang.Double

 The largest positive value of type double.

MAX_VALUE. Static variable in class java.lang.Float

 The largest positive value of type float.

MAX_VALUE. Static variable in class java.lang.Integer

 The largest value of type int.

MAX_VALUE. Static variable in class java.lang.Long

 The largest value of type long.

MAX_VALUE. Static variable in class java.lang.Short

 The maximum value a Short can have.

MAXGRIDSIZE. Static variable in class java.awt.GridBagLayout

 maximumLayoutSize(Container). Method in class java.awt.BorderLayout

 Returns the maximum dimensions for this layout given the components  in the specified target container.

maximumLayoutSize(Container). Method in class java.awt.CardLayout

 Returns the maximum dimensions for this layout given the components  in the specified target container.

maximumLayoutSize(Container). Method in class java.awt.GridBagLayout

 Returns the maximum dimensions for this layout given the components  in the specified target container.

maximumLayoutSize(Container). Method in interface java.awt.LayoutManager2

 Returns the maximum size of this component.

MAY. Static variable in class java.util.Calendar

 Useful constant for month.

MediaTracker(Component). Constructor for class java.awt.MediaTracker

 Creates a Media tracker to track images for a given Component.

MEDIUM. Static variable in class java.text.DateFormat

 Constant for medium style pattern.

members(). Method in interface java.security.acl.Group

 Returns an enumeration of the members in the group.

MemoryImageSource(int, int, ColorModel, byte[], int, int). Constructor for class java.awt.image.MemoryImageSource

 Constructs an ImageProducer object which uses an array of bytes  to produce data for an Image object.

MemoryImageSource(int, int, ColorModel, byte[], int, int, Hashtable). Constructor for class java.awt.image.MemoryImageSource

 Constructs an ImageProducer object which uses an array of bytes  to produce data for an Image object.

MemoryImageSource(int, int, ColorModel, int[], int, int). Constructor for class java.awt.image.MemoryImageSource

 Constructs an ImageProducer object which uses an array of integers  to produce data for an Image object.

MemoryImageSource(int, int, ColorModel, int[], int, int, Hashtable). Constructor for class java.awt.image.MemoryImageSource

 Constructs an ImageProducer object which uses an array of integers  to produce data for an Image object.

MemoryImageSource(int, int, int[], int, int). Constructor for class java.awt.image.MemoryImageSource

 Constructs an ImageProducer object which uses an array of integers  in the default RGB ColorModel to produce data for an Image object.

MemoryImageSource(int, int, int[], int, int, Hashtable). Constructor for class java.awt.image.MemoryImageSource

 Constructs an ImageProducer object which uses an array of integers  in the default RGB ColorModel to produce data for an Image object.

MENU. Static variable in class java.awt.SystemColor

 The array index for the menu background color.

menu. Static variable in class java.awt.SystemColor

 The background color for menus.

Menu(). Constructor for class java.awt.Menu

 Constructs a new Menu with an empty label.

Menu(String). Constructor for class java.awt.Menu

 Constructs a new Menu with the specified label.

Menu(String, boolean). Constructor for class java.awt.Menu

 Constructs a new Menu with the specified label.

MENU_TEXT. Static variable in class java.awt.SystemColor

 The array index for the menu text color.

MenuBar(). Constructor for class java.awt.MenuBar

 Creates a new menu bar.

MenuComponent(). Constructor for class java.awt.MenuComponent

 MenuItem(). Constructor for class java.awt.MenuItem

 Constructs a new MenuItem with an empty label and no keyboard  shortcut.

MenuItem(String). Constructor for class java.awt.MenuItem

 Constructs a new MenuItem with the specified label and no  keyboard shortcut.

MenuItem(String, MenuShortcut). Constructor for class java.awt.MenuItem

 Create a MenuItem with an associated keyboard shortcut.

MenuShortcut(int). Constructor for class java.awt.MenuShortcut

 Constructs a new MenuShortcut for the specified key.

MenuShortcut(int, boolean). Constructor for class java.awt.MenuShortcut

 Constructs a new MenuShortcut for the specified key.

menuText. Static variable in class java.awt.SystemColor

 The text color for menus.

MessageDigest(String). Constructor for class java.security.MessageDigest

 Creates a message digest with the specified algorithm name.

MessageFormat(String). Constructor for class java.text.MessageFormat

 Constructs with the specified pattern.

META_MASK. Static variable in class java.awt.event.ActionEvent

 The meta modifier constant.

META_MASK. Static variable in class java.awt.Event

 The meta modifier constant.

META_MASK. Static variable in class java.awt.event.InputEvent

 The meta key modifier constant.

metaDown(). Method in class java.awt.Event

 Checks if the meta key is down.

method. Variable in class java.net.HttpURLConnection

 methodArgument(). Method in class sun.tools.debug. RemoteStackVariable

 Return whether variable is a method argument.

MethodDescriptor(Method). Constructor for class java.beans.MethodDescriptor

 MethodDescriptor(Method, ParameterDescriptor[]). Constructor for class java.beans.MethodDescriptor

 MILLISECOND. Static variable in class java.util. Calendar

 Useful constant for date and time.

MILLISECOND_FIELD. Static variable in class java.text.DateFormat

 Useful constant for MILLISECOND field alignment.

min(BigDecimal). Method in class java.math.BigDecimal

 Returns the BigDecimal whose value is the lesser of this and val.

min(BigInteger). Method in class java.math.BigInteger

 Returns the BigInteger whose value is the lesser of this and val.

min(double, double). Static method in class java.lang.Math

 Returns the smaller of two double values.

min(float, float). Static method in class java.lang.Math

 Returns the smaller of two float values.

min(int, int). Static method in class java.lang.Math

 Returns the smaller of two int values.

min(long, long). Static method in class java.lang.Math

 Returns the smaller of two long values.

MIN_PRIORITY. Static variable in class java.lang.Thread

 The minimum priority that a thread can have.

MIN_RADIX. Static variable in class java.lang.Character

 The minimum radix available for conversion to and from Strings.

MIN_VALUE. Static variable in class java.lang.Byte

 The minimum value a Byte can have.

MIN_VALUE. Static variable in class java.lang.Character

 The constant value of this field is the smallest value of type  char.

MIN_VALUE. Static variable in class java.lang.Double

 The smallest positive value of type double.

MIN_VALUE. Static variable in class java.lang.Float

 The smallest positive value of type float.

MIN_VALUE. Static variable in class java.lang.Integer

 The smallest value of type int.

MIN_VALUE. Static variable in class java.lang.Long

 The smallest value of type long.

MIN_VALUE. Static variable in class java.lang.Short

 The minimum value a Short can have.

minimumLayoutSize(Container). Method in class java.awt.BorderLayout

 Returns the minimum dimensions needed to layout the components  contained in the specified target container.

minimumLayoutSize(Container). Method in class java.awt.CardLayout

 Calculates the minimum size for the specified panel.

minimumLayoutSize(Container). Method in class java.awt.FlowLayout

 Returns the minimum dimensions needed to layout the components  contained in the specified target container.

minimumLayoutSize(Container). Method in class java.awt.GridBagLayout

 Returns the minimum dimensions needed to layout the components  contained in the specified panel.

minimumLayoutSize(Container). Method in class java.awt.GridLayout

 Returns the minimum dimensions needed to layout the components  contained in the specified panel.

minimumLayoutSize(Container). Method in interface java.awt.LayoutManager

 Calculates the minimum size dimensions for the specified  panel given the components in the specified parent container.

minimumSize(). Method in class java.awt.Component

 minimumSize(). Method in interface java.awt.peer. ComponentPeer

 DEPRECATED: Replaced by getMinimumSize().

minimumSize(). Method in class java.awt.Container

 minimumSize(). Method in class java.awt.List

 minimumSize(). Method in class java.awt.TextArea

 minimumSize(). Method in class java.awt.TextField

 minimumSize(int). Method in class java.awt.List

 minimumSize(int). Method in interface java.awt.peer. ListPeer

 DEPRECATED: Replaced by getMinimumSize(int).

minimumSize(int). Method in class java.awt.TextField

 minimumSize(int). Method in interface java.awt.peer. TextFieldPeer

 DEPRECATED: Replaced by getMinimumSize(int).

minimumSize(int, int). Method in class java.awt.TextArea

 minimumSize(int, int). Method in interface java.awt.peer.TextAreaPeer

 DEPRECATED: Replaced by getMinimumSize(int, int).

MINSIZE. Static variable in class java.awt.GridBagLayout

 MINUTE. Static variable in class java.util.Calendar

 Useful constant for date and time.

MINUTE_FIELD. Static variable in class java.text.DateFormat

 Useful constant for MINUTE field alignment.

MissingResourceException(String, String, String). Constructor for class java.util.MissingResourceException

 Constructs a MissingResourceException with the specified information.

mkdir(). Method in class java.io.File

 Creates a directory whose pathname is specified by this  File object.

mkdirs(). Method in class java.io.File

 Creates a directory whose pathname is specified by this  File  object, including any necessary parent directories.

mod(BigInteger). Method in class java.math.BigInteger

 Returns a BigInteger whose value is this mod m.

Modifier(). Constructor for class java.lang.reflect.Modifier

 MODIFIER_LETTER. Static variable in class java.lang. Character

 MODIFIER_SYMBOL. Static variable in class java.lang. Character

 modifiers. Variable in class java.awt.Event

 The state of the modifier keys.

modInverse(BigInteger). Method in class java.math.BigInteger

 Returns modular multiplicative inverse of this, mod m.

modPow(BigInteger, BigInteger). Method in class java.math.BigInteger

 Returns a BigInteger whose value is (this ** exponent) mod m.

MONDAY. Static variable in class java.util.Calendar

 Useful constant for days of week.

MONTH. Static variable in class java.util.Calendar

 Useful constant for date and time.

MONTH_FIELD. Static variable in class java.text.DateFormat

 Useful constant for MONTH field alignment.

MOUSE_CLICKED. Static variable in class java.awt.event.MouseEvent

 The mouse clicked event type.

MOUSE_DOWN. Static variable in class java.awt.Event

 The mouse down event.

MOUSE_DRAG. Static variable in class java.awt.Event

 The mouse drag event.

MOUSE_DRAGGED. Static variable in class java.awt.event.MouseEvent

 The mouse dragged event type.

MOUSE_ENTER. Static variable in class java.awt.Event

 The mouse enter event.

MOUSE_ENTERED. Static variable in class java.awt.event.MouseEvent

 The mouse entered event type.

MOUSE_EVENT_MASK. Static variable in class java.awt.AWTEvent

 The event mask for selecting mouse events.

MOUSE_EXIT. Static variable in class java.awt.Event

 The mouse exit event.

MOUSE_EXITED. Static variable in class java.awt.event.MouseEvent

 The mouse exited event type.

MOUSE_FIRST. Static variable in class java.awt.event.MouseEvent

 Marks the first integer id for the range of mouse event ids.

MOUSE_LAST. Static variable in class java.awt.event.MouseEvent

 Marks the last integer id for the range of mouse event ids.

MOUSE_MOTION_EVENT_MASK. Static variable in class java.awt.AWTEvent

 The event mask for selecting mouse motion events.

MOUSE_MOVE. Static variable in class java.awt.Event

 The mouse move event.

MOUSE_MOVED. Static variable in class java.awt.event.MouseEvent

 The mouse moved event type.

MOUSE_PRESSED. Static variable in class java.awt.event.MouseEvent

 The mouse pressed event type.

MOUSE_RELEASED. Static variable in class java.awt.event.MouseEvent

 The mouse released event type.

MOUSE_UP. Static variable in class java.awt.Event

 The mouse up event.

MouseAdapter(). Constructor for class java.awt.event.MouseAdapter

 mouseClicked(MouseEvent). Method in class java.awt. AWTEventMulticaster

 Handles the mouseClicked event by invoking the  mouseClicked methods on listener-a and listener-b.

mouseClicked(MouseEvent). Method in class java.awt.event.MouseAdapter

 mouseClicked(MouseEvent). Method in interface java.awt.event.MouseListener

 Invoked when the mouse has been clicked on a component.

mouseDown(Event, int, int). Method in class java.awt.Component

 mouseDrag(Event, int, int). Method in class java.awt. Component

 mouseDragged(MouseEvent). Method in class java.awt. AWTEventMulticaster

 Handles the mouseDragged event by invoking the  mouseDragged methods on listener-a and listener-b.

mouseDragged(MouseEvent). Method in class java.awt.event.MouseMotionAdapter

 mouseDragged(MouseEvent). Method in interface java.awt.event.MouseMotionListener

 Invoked when a mouse button is pressed on a component and then  dragged.

mouseEnter(Event, int, int). Method in class java.awt.Component

 mouseEntered(MouseEvent). Method in class java.awt. AWTEventMulticaster

 Handles the mouseEntered event by invoking the  mouseEntered methods on listener-a and listener-b.

mouseEntered(MouseEvent). Method in class java.awt.event.MouseAdapter

 mouseEntered(MouseEvent). Method in interface java.awt.event.MouseListener

 Invoked when the mouse enters a component.

MouseEvent(Component, int, long, int, int, int, int, boolean). Constructor for class java.awt.event.MouseEvent

 Constructs a MouseEvent object with the specified source component,  type, modifiers, coordinates, and click count.

mouseExit(Event, int, int). Method in class java.awt.Component

 mouseExited(MouseEvent). Method in class java.awt. AWTEventMulticaster

 Handles the mouseExited event by invoking the  mouseExited methods on listener-a and listener-b.

mouseExited(MouseEvent). Method in class java.awt.event.MouseAdapter

 mouseExited(MouseEvent). Method in interface java.awt.event.MouseListener

 Invoked when the mouse exits a component.

MouseMotionAdapter(). Constructor for class java.awt.event.MouseMotionAdapter

 mouseMove(Event, int, int). Method in class java.awt. Component

 mouseMoved(MouseEvent). Method in class java.awt. AWTEventMulticaster

 Handles the mouseMoved event by invoking the  mouseMoved methods on listener-a and listener-b.

mouseMoved(MouseEvent). Method in class java.awt.event.MouseMotionAdapter

 mouseMoved(MouseEvent). Method in interface java.awt.event.MouseMotionListener

 Invoked when the mouse button has been moved on a component  (with no buttons no down).

mousePressed(MouseEvent). Method in class java.awt.AWTEventMulticaster

 Handles the mousePressed event by invoking the  mousePressed methods on listener-a and listener-b.

mousePressed(MouseEvent). Method in class java.awt.event.MouseAdapter

 mousePressed(MouseEvent). Method in interface java.awt.event.MouseListener

 Invoked when a mouse button has been pressed on a component.

mouseReleased(MouseEvent). Method in class java.awt.AWTEventMulticaster

 Handles the mouseReleased event by invoking the  mouseReleased methods on listener-a and listener-b.

mouseReleased(MouseEvent). Method in class java.awt.event.MouseAdapter

 mouseReleased(MouseEvent). Method in interface java.awt.event.MouseListener

 Invoked when a mouse button has been released on a component.

mouseUp(Event, int, int). Method in class java.awt.Component

 move(int, int). Method in class java.awt.Component

 move(int, int). Method in class java.awt.Point

 Changes the point to have the specified location.

move(int, int). Method in class java.awt.Rectangle

 MOVE_CURSOR. Static variable in class java.awt.Cursor

 The move cursor type.

MOVE_CURSOR. Static variable in class java.awt.Frame

 movePointLeft(int). Method in class java.math. BigDecimal

 Returns a BigDecimal which is equivalent to this one with the decimal  point moved n places to the left.

movePointRight(int). Method in class java.math.BigDecimal

 Moves the decimal point the specified number of places to the right.

MulticastSocket(). Constructor for class java.net.MulticastSocket

 Create a multicast socket.

MulticastSocket(int). Constructor for class java.net.MulticastSocket

 Create a multicast socket and bind it to a specific port.

multiply(BigDecimal). Method in class java.math.BigDecimal

 Returns a BigDecimal whose value is (this * val), and whose scale is  this.scale() + val.scale.

multiply(BigInteger). Method in class java.math.BigInteger

 Returns a BigInteger whose value is (this * val).

______________________________________________________________________________

  N

N_RESIZE_CURSOR. Static variable in class java.awt.Cursor

 The north-resize cursor type.

N_RESIZE_CURSOR. Static variable in class java.awt.Frame

 name. Variable in class java.sql.DriverPropertyInfo

 The name of the property.

name. Variable in class java.awt.Font

 The logical name of this font.

NaN. Static variable in class java.lang.Double

 A NaN value of type double.

NaN. Static variable in class java.lang.Float

 The NaN value of type float.

NATIVE. Static variable in class java.lang.reflect.Modifier

 nativeSQL(String). Method in interface java.sql. Connection

 A driver may convert the JDBC sql grammar into its system's  native SQL grammar prior to sending it; nativeSQL returns the  native form of the statement that the driver would have sent.

NE_RESIZE_CURSOR. Static variable in class java.awt.Cursor

 The north-east-resize cursor type.

NE_RESIZE_CURSOR. Static variable in class java.awt.Frame

 needsDictionary(). Method in class java.util.zip. Inflater

 Returns true if a preset dictionary is needed for decompression.

needsGui(). Method in interface java.beans.Visibility

 needsInput(). Method in class java.util.zip.Deflater

 Returns true if the input data buffer is empty and setInput()  should be called in order to provide more input.

needsInput(). Method in class java.util.zip.Inflater

 Returns true if no data remains in the input buffer.

negate(). Method in class java.math.BigDecimal

 Returns a BigDecimal whose value is -1 * this, and whose scale is  this.scale().

negate(). Method in class java.math.BigInteger

 Returns a BigInteger whose value is (-1 * this).

NEGATIVE_INFINITY. Static variable in class java.lang.Double

 The negative infinity of type double.

NEGATIVE_INFINITY. Static variable in class java.lang.Float

 The negative infinity of type float.

NegativeArraySizeException(). Constructor for class java.lang. NegativeArraySizeException

 Constructs a NegativeArraySizeException with no  detail message.

NegativeArraySizeException(String). Constructor for class java.lang. NegativeArraySizeException

 Constructs a NegativeArraySizeException with the  specified detail message.

newCall(RemoteObject, Operation[], int, long). Method in interface java.rmi.server.RemoteRef

 Creates an appropriate call object for a new remote method  invocation on this object.

newInstance(). Method in class java.lang.Class

 Creates a new instance of a class.

newInstance(Class, int). Static method in class java.lang.reflect.Array

 Creates a new array with the specified component type and  length.

newInstance(Class, int[]). Static method in class java.lang.reflect.Array

 Creates a new array with the specified component type and  dimensions.

newInstance(Object[]). Method in class java.lang.reflect.Constructor

 Uses the constructor represented by this Constructor object to  create and initialize a new instance of the constructor's  declaring class, with the specified initialization parameters.

newLine(). Method in class java.io.BufferedWriter

 Write a line separator.

newmodel. Variable in class java.awt.image.RGBImageFilter

 newPixels(). Method in class java.awt.image. MemoryImageSource

 Send a whole new buffer of pixels to any ImageConsumers that  are currently interested in the data for this image and notify  them that an animation frame is complete.

newPixels(byte[], ColorModel, int, int). Method in class java.awt.image. MemoryImageSource

 Change to a new byte array to hold the pixels for this image.

newPixels(int, int, int, int). Method in class java.awt.image. MemoryImageSource

 Send a rectangular region of the buffer of pixels to any  ImageConsumers that are currently interested in the data for  this image and notify them that an animation frame is complete.

newPixels(int, int, int, int, boolean). Method in class java.awt.image. MemoryImageSource

 Send a rectangular region of the buffer of pixels to any  ImageConsumers that are currently interested in the data for  this image.

newPixels(int[], ColorModel, int, int). Method in class java.awt.image. MemoryImageSource

 Change to a new int array to hold the pixels for this image.

next(). Method in class java.text.BreakIterator

 Return the boundary following the current boundary.

next(). Method in interface java.text.CharacterIterator

 Increment the iterator's index by one and return the character  at the new index.

next(). Method in class java.text.CollationElementIterator

 Get the ordering priority of the next character in the string.

next(). Method in class sun.tools.debug.RemoteThread

 Continue execution of this thread to the next line, but don't step  into a method call.

next(). Method in interface java.sql.ResultSet

 A ResultSet is initially positioned before its first row; the  first call to next makes the first row the current row; the  second call makes the second row the current row, etc.

next(). Method in class java.text.StringCharacterIterator

 Increment the iterator's index by one and return the character  at the new index.

next(Container). Method in class java.awt.CardLayout

 Flips to the next card of the specified container.

next(int). Method in class java.text.BreakIterator

 Return the nth boundary from the current boundary

next(int). Method in class java.util.Random

 Generates the next pseudorandom number.

next(int). Method in class java.security.SecureRandom

 Generates an integer containing the user-specified number of  pseudo-random bits (right justified, with leading zeros).

nextBytes(byte[]). Method in class java.util.Random

 Generates a user specified number of random bytes.

nextBytes(byte[]). Method in class java.security.SecureRandom

 Generates a user-specified number of random bytes.

nextDouble(). Method in class java.util.Random

 Returns the next pseudorandom, uniformly distributed  double value between 0.0 and  1.0 from this random number generator's sequence.

nextDouble(double). Static method in class java.text.ChoiceFormat

 Finds the least double greater than d.

nextDouble(double, boolean). Static method in class java.text.ChoiceFormat

 nextElement(). Method in interface java.util. Enumeration

 Returns the next element of this enumeration.

nextElement(). Method in class java.util.StringTokenizer

 Returns the same value as the nextToken method,  except that its declared return value is Object rather than  String.

nextFloat(). Method in class java.util.Random

 Returns the next pseudorandom, uniformly distributed float  value between 0.0 and 1.0 from this random  number generator's sequence.

nextFocus(). Method in class java.awt.Component

 nextGaussian(). Method in class java.util.Random

 Returns the next pseudorandom, Gaussian ("normally") distributed  double  value with mean 0.0 and standard  deviation 1.0  from this random number generator's sequence.

nextInt(). Method in class java.util.Random

 Returns the next pseudorandom, uniformly distributed int  value from this random number generator's sequence.

nextLong(). Method in class java.util.Random

 Returns the next pseudorandom, uniformly distributed long  value from this random number generator's sequence.

nextToken(). Method in class java.io.StreamTokenizer

 Parses the next token from the input stream of this tokenizer.

nextToken(). Method in class java.util.StringTokenizer

 Returns the next token from this string tokenizer.

nextToken(String). Method in class java.util.StringTokenizer

 Returns the next token in this string tokenizer's string.

NO_COMPRESSION. Static variable in class java.util.zip.Deflater

 Compression level for no compression.

NO_DECOMPOSITION. Static variable in class java.text.Collator

 Decomposition mode value.

NoClassDefFoundError(). Constructor for class java.lang.NoClassDefFoundError

 Constructs a NoClassDefFoundError with no detail message.

NoClassDefFoundError(String). Constructor for class java.lang. NoClassDefFoundError

 Constructs a NoClassDefFoundError with the specified  detail message.

NON_SPACING_MARK. Static variable in class java.lang.Character

 NONE. Static variable in class java.awt. GridBagConstraints

 NORM_PRIORITY. Static variable in class java.lang. Thread

 The default priority that is assigned to a thread.

normalizeMimeType(String). Method in class java.awt.datatransfer.DataFlavor

 Called for each MIME type string to give DataFlavor subtypes the  opportunity to change how the normalization of MIME types is accomplished.

normalizeMimeTypeParameter(String, String). Method in class java.awt.datatransfer.DataFlavor

 Called on DataFlavor for every MIME Type parameter to allow DataFlavor  subclasses to handle special parameters like the text/plain charset  parameters, whose values are case insensitive.

NoRouteToHostException(). Constructor for class java.net.NoRouteToHostException

 Construct a new NoRouteToHostException with no detailed message.

NoRouteToHostException(String). Constructor for class java.net. NoRouteToHostException

 Constructs a new NoRouteToHostException with the specified detail  message as to why the remote host cannot be reached.

NORTH. Static variable in class java.awt.BorderLayout

 The north layout constraint.

NORTH. Static variable in class java.awt.GridBagConstraints

 NORTHEAST. Static variable in class java.awt. GridBagConstraints

 NORTHWEST. Static variable in class java.awt. GridBagConstraints

 NoSessionException(). Constructor for class sun.tools.debug.NoSessionException

 Constructor.

NoSessionException(String). Constructor for class sun.tools.debug. NoSessionException

 Constructor with a detail message.

NoSuchAlgorithmException(). Constructor for class java.security. NoSuchAlgorithmException

 Constructs a NoSuchAlgorithmException with no detail  message.

NoSuchAlgorithmException(String). Constructor for class java.security. NoSuchAlgorithmException

 Constructs a NoSuchAlgorithmException with the specified  detail message.

NoSuchElementException(). Constructor for class java.util. NoSuchElementException

 Constructs a NoSuchElementException with no detail message.

NoSuchElementException(String). Constructor for class java.util. NoSuchElementException

 Constructs a NoSuchElementException with the  specified detail message.

NoSuchFieldError(). Constructor for class java.lang.NoSuchFieldError

 Constructs a NoSuchFieldException with no detail message.

NoSuchFieldError(String). Constructor for class java.lang.NoSuchFieldError

 Constructs a NoSuchFieldException with the specified  detail message.

NoSuchFieldException(). Constructor for class java.lang.NoSuchFieldException

 Constructor.

NoSuchFieldException(String). Constructor for class java.lang. NoSuchFieldException

 Constructor with a detail message.

NoSuchLineNumberException(). Constructor for class sun.tools.debug. NoSuchLineNumberException

 Constructor.

NoSuchLineNumberException(String). Constructor for class sun.tools.debug. NoSuchLineNumberException

 Constructor with a detail message.

NoSuchMethodError(). Constructor for class java.lang.NoSuchMethodError

 NoSuchMethodError(String). Constructor for class java.lang.NoSuchMethodError

 Constructs a NoSuchMethodException with the  specified detail message.

NoSuchMethodException(). Constructor for class java.lang.NoSuchMethodException

 Constructs a NoSuchMethodException without a detail message.

NoSuchMethodException(String). Constructor for class java.lang. NoSuchMethodException

 Constructs a NoSuchMethodException with a detail message.

NoSuchObjectException(String). Constructor for class java.rmi. NoSuchObjectException

 Create a new NoSuchObjectException with a description.

NoSuchProviderException(). Constructor for class java.security. NoSuchProviderException

 Constructs a NoSuchProviderException with no detail message.

NoSuchProviderException(String). Constructor for class java.security. NoSuchProviderException

 Constructs a NoSuchProviderException with the specified detail  message.

not(). Method in class java.math.BigInteger

 Returns a BigInteger whose value is (~this).

NotActiveException(). Constructor for class java.io.NotActiveException

 Constructor to create a new NotActiveException with no reason.

NotActiveException(String). Constructor for class java.io.NotActiveException

 Constructor to create a new NotActiveException with the reason given.

NotBoundException(). Constructor for class java.rmi.NotBoundException

 NotBoundException(String). Constructor for class java.rmi.NotBoundException

 notify(). Method in class java.lang.Object

 Wakes up a single thread that is waiting on this object's  monitor.

notifyAll(). Method in class java.lang.Object

 Wakes up all threads that are waiting on this object's monitor.

notifyObservers(). Method in class java.util.Observable

 If this object has changed, as indicated by the  hasChanged  method, then notify all of its observers  and then call the clearChanged method to  indicate that this object has no longer changed.

notifyObservers(Object). Method in class java.util.Observable

 If this object has changed, as indicated by the  hasChanged  method, then notify all of its observers  and then call the clearChanged  method to indicate  that this object has no longer changed.

NotOwnerException(). Constructor for class java.security.acl.NotOwnerException

 Constructs a NotOwnerException.

NotSerializableException(). Constructor for class java.io. NotSerializableException

 NotSerializableException(String). Constructor for class java.io.NotSerializableException

 NOVEMBER. Static variable in class java.util. Calendar

 Useful constant for month.

npoints. Variable in class java.awt.Polygon

 The total number of points.

NULL. Static variable in class java.sql.Types

 NULLORDER. Static variable in class java.text. CollationElementIterator

 Null order which indicates the end of string is reached by the  cursor.

nullPlusNonNullIsNull(). Method in interface java.sql.DatabaseMetaData

 Are concatenations between NULL and non-NULL values NULL?  A JDBC-Compliant driver always returns true.

NullPointerException(). Constructor for class java.lang.NullPointerException

 Constructs a NullPointerException with no detail message.

NullPointerException(String). Constructor for class java.lang. NullPointerException

 Constructs a NullPointerException with the specified  detail message.

nullsAreSortedAtEnd(). Method in interface java.sql.DatabaseMetaData

 Are NULL values sorted at the end regardless of sort order?

nullsAreSortedAtStart(). Method in interface java.sql.DatabaseMetaData

 Are NULL values sorted at the start regardless of sort order?

nullsAreSortedHigh(). Method in interface java.sql.DatabaseMetaData

 Are NULL values sorted high?

nullsAreSortedLow(). Method in interface java.sql.DatabaseMetaData

 Are NULL values sorted low?

NUM_COLORS. Static variable in class java.awt.SystemColor

 The number of system colors in the array.

NUM_LOCK. Static variable in class java.awt.Event

 The NumLock action-key.

Number(). Constructor for class java.lang.Number

 numberFormat. Variable in class java.text.DateFormat

 The number formatter that DateFormat uses to format numbers in dates  and times.

NumberFormat(). Constructor for class java.text.NumberFormat

 NumberFormatException(). Constructor for class java.lang.NumberFormatException

 Constructs a NumberFormatException with no detail message.

NumberFormatException(String). Constructor for class java.lang. NumberFormatException

 Constructs a NumberFormatException with the  specified detail message.

NUMERIC. Static variable in class java.sql.Types

 nval. Variable in class java.io.StreamTokenizer

 If the current token is a number, this field contains the value  of that number.

NW_RESIZE_CURSOR. Static variable in class java.awt.Cursor

 The north-west-resize cursor type.

NW_RESIZE_CURSOR. Static variable in class java.awt.Frame

______________________________________________________________________________

  O

Object(). Constructor for class java.lang.Object

 ObjectInputStream(InputStream). Constructor for class java.io.ObjectInputStream

 Create an ObjectInputStream that reads from the specified InputStream.

ObjectOutputStream(OutputStream). Constructor for class java.io. ObjectOutputStream

 Creates an ObjectOutputStream that writes to the specified OutputStream.

ObjectStreamException(). Constructor for class java.io.ObjectStreamException

 Create an ObjectStreamException.

ObjectStreamException(String). Constructor for class java.io. ObjectStreamException

 Create an ObjectStreamException with the specified argument.

ObjID(). Constructor for class java.rmi.server.ObjID

 Generate unique object identifier.

ObjID(int). Constructor for class java.rmi.server.ObjID

 Generate a "well-known" object ID.

Observable(). Constructor for class java.util.Observable

 Creates an observable object with no observers.

OCTOBER. Static variable in class java.util.Calendar

 Useful constant for month.

okToUseGui(). Method in interface java.beans.Visibility

 This method instructs the bean that it is OK to use the Gui.

on(boolean). Method in class java.security.DigestInputStream

 Turns the digest function on or off.

on(boolean). Method in class java.security.DigestOutputStream

 Turns the digest function on or off.

openConnection(). Method in class java.net.URL

 Returns a URLConnection object that represents a  connection to the remote object referred to by the URL.

openConnection(URL). Method in class java.net.URLStreamHandler

 Opens a connection to the object referenced by the  URL argument.

openStream(). Method in class java.net.URL

 Opens a connection to this URL and returns an  InputStream  for reading from that connection.

Operation(String). Constructor for class java.rmi.server.Operation

 Creates a new Operation object.

or(BigInteger). Method in class java.math.BigInteger

 Returns a BigInteger whose value is (this | val).

or(BitSet). Method in class java.util.BitSet

 Performs a logical OR of this bit set with the bit set  argument.

orange. Static variable in class java.awt.Color

 The color orange.

ordinaryChar(int). Method in class java.io.StreamTokenizer

 Specifies that the character argument is "ordinary"  in this tokenizer.

ordinaryChars(int, int). Method in class java.io.StreamTokenizer

 Specifies that all characters c in the range  low <= c <= high   are "ordinary" in this tokenizer.

origmodel. Variable in class java.awt.image.RGBImageFilter

 OTHER. Static variable in class java.sql.Types

 OTHER indicates that the SQL type is database specific and  gets mapped to a Java object which can be accessed via  getObject and setObject.

OTHER_LETTER. Static variable in class java.lang.Character

 OTHER_NUMBER. Static variable in class java.lang. Character

 OTHER_PUNCTUATION. Static variable in class java.lang.Character

 OTHER_SYMBOL. Static variable in class java.lang. Character

 out. Static variable in class java.io.FileDescriptor

 A handle to the standard output stream.

out. Variable in class java.io.FilterOutputStream

 The underlying output stream.

out. Variable in class java.io.FilterWriter

 The underlying character-output stream.

out. Variable in class java.io.PipedInputStream

 out. Static variable in class java.lang.System

 The "standard" output stream.

OutOfMemoryError(). Constructor for class java.lang.OutOfMemoryError

 Constructs an OutOfMemoryError with no detail message.

OutOfMemoryError(String). Constructor for class java.lang.OutOfMemoryError

 Constructs an OutOfMemoryError with the specified  detail message.

outpixbuf. Variable in class java.awt.image.ReplicateScaleFilter

 OutputStream(). Constructor for class java.io. OutputStream

 OutputStreamWriter(OutputStream). Constructor for class java.io.OutputStreamWriter

 Create an OutputStreamWriter that uses the default character encoding.

OutputStreamWriter(OutputStream, String). Constructor for class java.io. OutputStreamWriter

 Create an OutputStreamWriter that uses the named character encoding.

owner. Variable in class java.awt.datatransfer.Clipboard

______________________________________________________________________________

  P

pack(). Method in class java.awt.Window

 Packs the components of the Window.

packagePrefix. Static variable in interface java.rmi.server.LoaderHandler

 Find loader handler package prefix: assumes that the implementation of  the LoaderHandler class is located in the package defined by the  prefix.

packagePrefix. Static variable in interface java.rmi.server.RemoteRef

 Find server package prefix: assumes that the implementation of  server ref classes (e.g., UnicastRef, UnicastServerRef) are  located in the package defined by the prefix.

PAINT. Static variable in class java.awt.event.PaintEvent

 The paint event type.

paint(Graphics). Method in class java.awt.Canvas

 Paints the canvas in the default background color.

paint(Graphics). Method in class java.awt.Component

 Paints the component.

paint(Graphics). Method in interface java.awt.peer.ComponentPeer

 paint(Graphics). Method in class java.awt.Container

 Paints the container.

PAINT_FIRST. Static variable in class java.awt.event.PaintEvent

 Marks the first integer id for the range of paint event ids.

PAINT_LAST. Static variable in class java.awt.event.PaintEvent

 Marks the last integer id for the range of paint event ids.

paintAll(Graphics). Method in class java.awt.Component

 Paints the component and its subcomponents.

paintComponents(Graphics). Method in class java.awt.Container

 Paints the components in this container.

PaintEvent(Component, int, Rectangle). Constructor for class java.awt.event. PaintEvent

 Constructs a FocusEvent object with the specified source component  and type.

paintValue(Graphics, Rectangle). Method in interface java.beans.PropertyEditor

 Paint a representation of the value into a given area of screen  real estate.

paintValue(Graphics, Rectangle). Method in class java.beans. PropertyEditorSupport

 Paint a representation of the value into a given area of screen  real estate.

Panel(). Constructor for class java.awt.Panel

 Creates a new panel.

Panel(LayoutManager). Constructor for class java.awt.Panel

 Creates a new panel with the specified layout manager.

PARAGRAPH_SEPARATOR. Static variable in class java.lang.Character

 ParameterDescriptor(). Constructor for class java.beans.ParameterDescriptor

 paramString(). Method in class java.awt.event. ActionEvent

 paramString(). Method in class java.awt.event. AdjustmentEvent

 paramString(). Method in class java.awt.AWTEvent

 paramString(). Method in class java.awt.Button

 Returns the parameter String of this button.

paramString(). Method in class java.awt.Checkbox

 Returns the parameter String of this Checkbox.

paramString(). Method in class java.awt.CheckboxMenuItem

 Returns the parameter String of this button.

paramString(). Method in class java.awt.Choice

 Returns the parameter String of this Choice.

paramString(). Method in class java.awt.Component

 Returns the parameter String of this Component.

paramString(). Method in class java.awt.event.ComponentEvent

 paramString(). Method in class java.awt.Container

 Returns the parameter String of this Container.

paramString(). Method in class java.awt.event.ContainerEvent

 paramString(). Method in class java.awt.Dialog

 Returns the parameter String of this Dialog.

paramString(). Method in class java.awt.Event

 Returns the parameter String of this Event.

paramString(). Method in class java.awt.FileDialog

 Returns the parameter String of this file dialog.

paramString(). Method in class java.awt.event.FocusEvent

 paramString(). Method in class java.awt.Frame

 Returns the parameter String of this Frame.

paramString(). Method in class java.awt.event.ItemEvent

 paramString(). Method in class java.awt.event. KeyEvent

 paramString(). Method in class java.awt.Label

 Returns the parameter String of this label.

paramString(). Method in class java.awt.List

 Returns the parameter String of this list.

paramString(). Method in class java.awt.Menu

 Returns the String parameter of the menu.

paramString(). Method in class java.awt.MenuComponent

 Returns the String parameter of this MenuComponent.

paramString(). Method in class java.awt.MenuItem

 Returns the String parameter of the menu item.

paramString(). Method in class java.awt.MenuShortcut

 paramString(). Method in class java.awt.event. MouseEvent

 paramString(). Method in class java.awt.event. PaintEvent

 paramString(). Method in class java.awt.Scrollbar

 Returns the String parameters for this Scrollbar.

paramString(). Method in class java.awt.ScrollPane

 Returns the parameter String of this Container.

paramString(). Method in class java.awt.TextArea

 Returns the String of parameters for this TextArea.

paramString(). Method in class java.awt.TextComponent

 Returns the String of parameters for this TextComponent.

paramString(). Method in class java.awt.event.TextEvent

 paramString(). Method in class java.awt.TextField

 Returns the String of parameters for this TextField.

paramString(). Method in class java.awt.event.WindowEvent

 parent. Variable in class java.util.ResourceBundle

 The parent bundle is consulted by getObject when this bundle  does not contain a particular resource.

parentOf(ThreadGroup). Method in class java.lang.ThreadGroup

 Tests if this thread group is either the thread group  argument or one of its ancestor thread groups.

parse(String). Static method in class java.util.Date

 Given a string representing a time, parse it and return the time  value.

parse(String). Method in class java.text.DateFormat

 Parse a date/time string.

parse(String). Method in class java.text.MessageFormat

 Parses the string.

parse(String). Method in class java.text.NumberFormat

 Convenience method.

parse(String, ParsePosition). Method in class java.text.ChoiceFormat

 Returns a Long if possible (e.g.

parse(String, ParsePosition). Method in class java.text.DateFormat

 Parse a date/time string according to the given parse position.

parse(String, ParsePosition). Method in class java.text.DecimalFormat

 Returns a Long if possible (e.g.

parse(String, ParsePosition). Method in class java.text.MessageFormat

 Parses the string.

parse(String, ParsePosition). Method in class java.text.NumberFormat

 Returns a Long if possible (e.g.

parse(String, ParsePosition). Method in class java.text.SimpleDateFormat

 Overrides DateFormat

parseByte(String). Static method in class java.lang.Byte

 Assuming the specified String represents a byte, returns  that byte's value.

parseByte(String, int). Static method in class java.lang.Byte

 Assuming the specified String represents a byte, returns  that byte's value.

ParseException(String, int). Constructor for class java.text.ParseException

 Constructs a ParseException with the specified detail message and  offset.

parseInt(String). Static method in class java.lang.Integer

 Parses the string argument as a signed decimal integer.

parseInt(String, int). Static method in class java.lang.Integer

 Parses the string argument as a signed integer in the radix  specified by the second argument.

parseLevel(String). Static method in class java.rmi.server.LogStream

 Convert a string name of a logging level to its internal  integer representation.

parseLong(String). Static method in class java.lang.Long

 Parses the string argument as a signed decimal long.

parseLong(String, int). Static method in class java.lang.Long

 Parses the string argument as a signed long in the  radix specified by the second argument.

parseNumbers(). Method in class java.io.StreamTokenizer

 Specifies that numbers should be parsed by this tokenizer.

parseObject(String). Method in class java.text.Format

 Parses a string to produce an object.

parseObject(String, ParsePosition). Method in class java.text.DateFormat

 Parse a date/time string into an Object.

parseObject(String, ParsePosition). Method in class java.text.Format

 Parses a string to produce an object.

parseObject(String, ParsePosition). Method in class java.text.MessageFormat

 Parses the string.

parseObject(String, ParsePosition). Method in class java.text.NumberFormat

 Parses a string to produce an object.

ParsePosition(int). Constructor for class java.text.ParsePosition

 Create a new ParsePosition with the given initial index.

parseShort(String). Static method in class java.lang.Short

 Assuming the specified String represents a short, returns  that short's value.

parseShort(String, int). Static method in class java.lang.Short

 Assuming the specified String represents a short, returns  that short's value.

parseURL(URL, String, int, int). Method in class java.net.URLStreamHandler

 Parses the string representation of a URL into a  URL object.

pathSeparator. Static variable in class java.io.File

 The system-dependent path separator string.

pathSeparatorChar. Static variable in class java.io.File

 The system-dependent path separator character.

PAUSE. Static variable in class java.awt.Event

 The Pause action-key.

peek(). Method in class java.util.Stack

 Looks at the object at the top of this stack without removing it  from the stack.

peek(InetAddress). Method in class java.net.DatagramSocketImpl

 Peek at the packet to see who it is from.

peekEvent(). Method in class java.awt.EventQueue

 Return the first event without removing it.

peekEvent(int). Method in class java.awt.EventQueue

 permissions(). Method in interface java.security.acl. AclEntry

 Returns an enumeration of the permissions in this ACL entry.

PGDN. Static variable in class java.awt.Event

 The page down action-key.

PGUP. Static variable in class java.awt.Event

 The page up action-key.

PI. Static variable in class java.lang.Math

 The double value that is closer than any other to  pi , the ratio of the circumference of a circle to its diameter.

pink. Static variable in class java.awt.Color

 The color pink.

PIPE_SIZE. Static variable in class java.io.PipedInputStream

 PipedInputStream(). Constructor for class java.io. PipedInputStream

 Creates a piped input stream that is not yet connected to a piped  output stream.

PipedInputStream(PipedOutputStream). Constructor for class java.io. PipedInputStream

 Creates a piped input stream connected to the specified piped  output stream.

PipedOutputStream(). Constructor for class java.io.PipedOutputStream

 Creates a piped output stream that is not yet connected to a  piped input stream.

PipedOutputStream(PipedInputStream). Constructor for class java.io. PipedOutputStream

 Creates a piped output stream connected to the specified piped  input stream.

PipedReader(). Constructor for class java.io.PipedReader

 Create a reader that is not yet connected to a piped writer.

PipedReader(PipedWriter). Constructor for class java.io.PipedReader

 Create a reader for the specified piped character-output stream.

PipedWriter(). Constructor for class java.io.PipedWriter

 Create a writer that is not yet connected to a piped reader.

PipedWriter(PipedReader). Constructor for class java.io.PipedWriter

 Create a writer for the specified piped character-input stream.

pixel_bits. Variable in class java.awt.image.ColorModel

 PixelGrabber(Image, int, int, int, int, boolean). Constructor for class java.awt.image.PixelGrabber

 Create a PixelGrabber object to grab the (x, y, w, h) rectangular  section of pixels from the specified image.

PixelGrabber(Image, int, int, int, int, int[], int, int). Constructor for class java.awt.image.PixelGrabber

 Create a PixelGrabber object to grab the (x, y, w, h) rectangular  section of pixels from the specified image into the given array.

PixelGrabber(ImageProducer, int, int, int, int, int[], int, int). Constructor for class java.awt.image.PixelGrabber

 Create a PixelGrabber object to grab the (x, y, w, h) rectangular  section of pixels from the image produced by the specified  ImageProducer into the given array.

PLAIN. Static variable in class java.awt.Font

 The plain style constant.

plainTextFlavor. Static variable in class java.awt.datatransfer.DataFlavor

 The DataFlavor representing plain text with unicode encoding, where:

 representationClass = InputStream
 mimeType = "text/plain; charset=unicode"

 play(). Method in interface java.applet.AudioClip

 Starts playing this audio clip.

play(URL). Method in class java.applet.Applet

 Plays the audio clip at the specified absolute URL.

play(URL, String). Method in class java.applet.Applet

 Plays the audio clip given the URL and a specifier that is  relative to it.

PM. Static variable in class java.util.Calendar

 Useful constant for hour in 12-hour clock.

Point(). Constructor for class java.awt.Point

 Constructs and initializes a Point initialized with (0, 0).

Point(int, int). Constructor for class java.awt.Point

 Constructs and initializes a Point from the specified x and y  coordinates.

Point(Point). Constructor for class java.awt.Point

 Constructs and initializes a Point with the same location as  the specified Point.

Polygon(). Constructor for class java.awt.Polygon

 Creates an empty polygon.

Polygon(int[], int[], int). Constructor for class java.awt.Polygon

 Constructs and initializes a Polygon from the specified parameters.

pop(). Method in class java.util.Stack

 Removes the object at the top of this stack and returns that  object as the value of this function.

PopupMenu(). Constructor for class java.awt.PopupMenu

 Creates a new popup menu.

PopupMenu(String). Constructor for class java.awt.PopupMenu

 Creates a new popup menu with the specified name.

port. Variable in class java.net.SocketImpl

 The port number on the remote host to which this socket is connected.

pos. Variable in class java.io.BufferedInputStream

 The current position in the buffer.

pos. Variable in class java.io.ByteArrayInputStream

 The index of the next character to read from the input stream buffer.

pos. Variable in class java.io.CharArrayReader

 Current buffer position

pos. Variable in class java.io.PushbackInputStream

 The current position within the buffer.

pos. Variable in class java.io.StringBufferInputStream

 The index of the next character to read from the input stream buffer.

POSITIVE_INFINITY. Static variable in class java.lang.Double

 The positive infinity of type double.

POSITIVE_INFINITY. Static variable in class java.lang.Float

 The positive infinity of type float.

postEvent(AWTEvent). Method in class java.awt.EventQueue

 Post a 1.1-style event to the EventQueue.

postEvent(Event). Method in class java.awt.Component

 postEvent(Event). Method in class java.awt. MenuComponent

 Posts the specified event to the menu.

postEvent(Event). Method in interface java.awt.MenuContainer

 postEvent(Event). Method in class java.awt.Window

 pow(double, double). Static method in class java.lang.Math

 Returns of value of the first argument raised to the power of the  second argument.

pow(int). Method in class java.math.BigInteger

 Returns a BigInteger whose value is (this ** exponent).

PRC. Static variable in class java.util.Locale

 Useful constant for country.

predefined. Static variable in class java.awt.Cursor

 preferredLayoutSize(Container). Method in class java.awt.BorderLayout

 Returns the preferred dimensions for this layout given the components  in the specified target container.

preferredLayoutSize(Container). Method in class java.awt.CardLayout

 Calculates the preferred size for the specified panel.

preferredLayoutSize(Container). Method in class java.awt.FlowLayout

 Returns the preferred dimensions for this layout given the components  in the specified target container.

preferredLayoutSize(Container). Method in class java.awt.GridBagLayout

 Returns the preferred dimensions for this layout given the components  in the specified panel.

preferredLayoutSize(Container). Method in class java.awt.GridLayout

 Returns the preferred dimensions for this layout given the components  int the specified panel.

preferredLayoutSize(Container). Method in interface java.awt.LayoutManager

 Calculates the preferred size dimensions for the specified  panel given the components in the specified parent container.

PREFERREDSIZE. Static variable in class java.awt.GridBagLayout

 preferredSize(). Method in class java.awt.Component

 preferredSize(). Method in interface java.awt.peer. ComponentPeer

 DEPRECATED: Replaced by getPreferredSize().

preferredSize(). Method in class java.awt.Container

 preferredSize(). Method in class java.awt.List

 preferredSize(). Method in class java.awt.TextArea

 preferredSize(). Method in class java.awt.TextField

 preferredSize(int). Method in class java.awt.List

 preferredSize(int). Method in interface java.awt.peer.ListPeer

 DEPRECATED: Replaced by getPreferredSize(int).

preferredSize(int). Method in class java.awt.TextField

 preferredSize(int). Method in interface java.awt.peer.TextFieldPeer

 DEPRECATED: Replaced by getPreferredSize(int).

preferredSize(int, int). Method in class java.awt.TextArea

 preferredSize(int, int). Method in interface java.awt.peer.TextAreaPeer

 DEPRECATED: Replaced by getPreferredSize(int, int).

prepareCall(String). Method in interface java.sql.Connection

 A SQL stored procedure call statement is handled by creating a  CallableStatement for it.

prepareImage(Image, ImageObserver). Method in class java.awt.Component

 Prepares an image for rendering on this Component.

prepareImage(Image, int, int, ImageObserver). Method in class java.awt. Component

 Prepares an image for rendering on this Component at the  specified width and height.

prepareImage(Image, int, int, ImageObserver). Method in interface java.awt.peer.ComponentPeer

 prepareImage(Image, int, int, ImageObserver). Method in class java.awt.Toolkit

 Prepares an image for rendering on the default screen at the  specified width and height.

prepareStatement(String). Method in interface java.sql.Connection

 A SQL statement with or without IN parameters can be  pre-compiled and stored in a PreparedStatement object.

previous(). Method in class java.text.BreakIterator

 Return the boundary preceding the current boundary.

previous(). Method in interface java.text.CharacterIterator

 Decrement the iterator's index by one and return the character  at the new index.

previous(). Method in class java.text.StringCharacterIterator

 Decrement the iterator's index by one and return the character  at the new index.

previous(Container). Method in class java.awt.CardLayout

 Flips to the previous card of the specified container.

previousDouble(double). Static method in class java.text.ChoiceFormat

 Finds the greatest double less than d.

PRIMARY. Static variable in class java.text.Collator

 Collator strength value.

primaryOrder(int). Static method in class java.text.CollationElementIterator

 Get the primary order of a collation order.

print(boolean). Method in class java.io.PrintStream

 Prints the string "true" to the underlying output  stream if the value of the boolean argument is  true; otherwise, prints the string  "false"  to the underlying output stream.

print(boolean). Method in class java.io.PrintWriter

 Print a boolean.

print(char). Method in class java.io.PrintStream

 Prints the low eight bits of the character argument to this print  stream's underlying output stream.

print(char). Method in class java.io.PrintWriter

 Print a character.

print(char[]). Method in class java.io.PrintStream

 Prints the low eight bits of each of the characters in the character  array to this print stream's underlying output stream.

print(char[]). Method in class java.io.PrintWriter

 Print an array of chracters.

print(double). Method in class java.io.PrintStream

 Prints the string representation of the double to  this print stream's underlying output stream.

print(double). Method in class java.io.PrintWriter

 Print a double.

print(float). Method in class java.io.PrintStream

 Prints the string representation of the float to  this print stream's underlying output stream.

print(float). Method in class java.io.PrintWriter

 Print a float.

print(Graphics). Method in class java.awt.Component

 Prints this component.

print(Graphics). Method in interface java.awt.peer.ComponentPeer

 print(Graphics). Method in class java.awt.Container

 Prints the container.

print(int). Method in class java.io.PrintStream

 Prints the string representation of the int to this  print stream's underlying output stream.

print(int). Method in class java.io.PrintWriter

 Print an integer.

print(long). Method in class java.io.PrintStream

 Prints the string representation of the long to this  print stream's underlying output stream.

print(long). Method in class java.io.PrintWriter

 Print a long.

print(Object). Method in class java.io.PrintStream

 Prints the string representation of the Object to  this print stream's underlying output stream.

print(Object). Method in class java.io.PrintWriter

 Print an object.

print(String). Method in class java.io.PrintStream

 If the string argument is null, the string  "null"  is printed to this print stream's underlying  output stream.

print(String). Method in class java.io.PrintWriter

 Print a String.

PRINT_SCREEN. Static variable in class java.awt.Event

 The PrintScreen action-key.

printAll(Graphics). Method in class java.awt.Component

 Prints the component and its subcomponents.

printComponents(Graphics). Method in class java.awt.Container

 Prints the components in this container.

printComponents(Graphics). Method in class java.awt.ScrollPane

 Prints the component in this scroll pane.

PrintJob(). Constructor for class java.awt.PrintJob

 println(). Method in class java.io.PrintStream

 Prints a newline character to this print stream's underlying  output stream.

println(). Method in class java.io.PrintWriter

 Finish the line.

println(boolean). Method in class java.io.PrintStream

 Prints the string "true" followed by a newline  character to this print stream's underlying output stream if the  value of the boolean  argument is true;  otherwise prints the string "false" followed by a  newline character to the underlying output stream.

println(boolean). Method in class java.io.PrintWriter

 Print a boolean, and then finish the line.

println(char). Method in class java.io.PrintStream

 Prints the low eight bits of the character argument followed by a  newline character to this print stream's underlying output stream.

println(char). Method in class java.io.PrintWriter

 Print a character, and then finish the line.

println(char[]). Method in class java.io.PrintStream

 Prints the low eight bits of each of the characters in the character  array, followed by a newline character, to this print stream's  underlying output stream.

println(char[]). Method in class java.io.PrintWriter

 Print an array of characters, and then finish the line.

println(double). Method in class java.io.PrintStream

 Prints the string representation of the double  followed by a newline to this print stream's underlying output  stream.

println(double). Method in class java.io.PrintWriter

 Print a double, and then finish the line.

println(float). Method in class java.io.PrintStream

 Prints the string representation of the float  followed by a newline to this print stream's underlying output  stream.

println(float). Method in class java.io.PrintWriter

 Print a float, and then finish the line.

println(int). Method in class java.io.PrintStream

 Prints the string representation of the int followed  by a newline to this print stream's underlying output stream.

println(int). Method in class java.io.PrintWriter

 Print an integer, and then finish the line.

println(long). Method in class java.io.PrintStream

 Prints the string representation of the long  followed by a newline to this print stream's underlying output  stream.

println(long). Method in class java.io.PrintWriter

 Print a long, and then finish the line.

println(Object). Method in class java.io.PrintStream

 Prints the string representation of the Object  followed by a newline to this print stream's underlying output  stream.

println(Object). Method in class java.io.PrintWriter

 Print an Object, and then finish the line.

println(String). Static method in class java.sql.DriverManager

 Print a message to the current JDBC log stream

println(String). Method in class java.io.PrintStream

 If the string argument is null, the string  "null"  followed by a newline character is printed to  this print stream's underlying output stream.

println(String). Method in class java.io.PrintWriter

 Print a String, and then finish the line.

printStackTrace(). Method in class java.lang.Throwable

 Prints this Throwable and its backtrace to the  standard error stream.

printStackTrace(PrintStream). Method in class java.lang.Throwable

 Prints this Throwable and its backtrace to the  specified print stream.

printStackTrace(PrintWriter). Method in class java.lang.Throwable

 Prints this Throwable and its backtrace to the specified  print writer.

PrintStream(OutputStream). Constructor for class java.io.PrintStream

 Constructs a new print stream that writes its output to the  specified underlying output stream.

PrintStream(OutputStream, boolean). Constructor for class java.io.PrintStream

 Constructs a new print stream that writes its output to the  specified underlying output stream.

printToConsole(String). Method in interface sun.tools.debug.DebuggerCallback

 Print text to the debugger's console window.

PrintWriter(OutputStream). Constructor for class java.io.PrintWriter

 Create a new PrintWriter, without automatic line flushing, from an  existing OutputStream.

PrintWriter(OutputStream, boolean). Constructor for class java.io.PrintWriter

 Create a new PrintWriter from an existing OutputStream.

PrintWriter(Writer). Constructor for class java.io.PrintWriter

 Create a new PrintWriter, without automatic line flushing.

PrintWriter(Writer, boolean). Constructor for class java.io.PrintWriter

 Create a new PrintWriter.

PRIVATE. Static variable in class java.lang.reflect.Modifier

 PRIVATE_USE. Static variable in class java.lang. Character

 procedureColumnIn. Static variable in interface java.sql.DatabaseMetaData

 COLUMN_TYPE - IN parameter.

procedureColumnInOut. Static variable in interface java.sql.DatabaseMetaData

 COLUMN_TYPE - INOUT parameter.

procedureColumnOut. Static variable in interface java.sql.DatabaseMetaData

 COLUMN_TYPE - OUT parameter.

procedureColumnResult. Static variable in interface java.sql.DatabaseMetaData

 COLUMN_TYPE - result column in ResultSet.

procedureColumnReturn. Static variable in interface java.sql.DatabaseMetaData

 COLUMN_TYPE - procedure return value.

procedureColumnUnknown. Static variable in interface java.sql.DatabaseMetaData

 COLUMN_TYPE - nobody knows.

procedureNoNulls. Static variable in interface java.sql.DatabaseMetaData

 TYPE NULLABLE - does not allow NULL values.

procedureNoResult. Static variable in interface java.sql.DatabaseMetaData

 PROCEDURE_TYPE - Does not return a result.

procedureNullable. Static variable in interface java.sql.DatabaseMetaData

 TYPE NULLABLE - allows NULL values.

procedureNullableUnknown. Static variable in interface java.sql. DatabaseMetaData

 TYPE NULLABLE - nullability unknown.

procedureResultUnknown. Static variable in interface java.sql.DatabaseMetaData

 PROCEDURE_TYPE - May return a result.

procedureReturnsResult. Static variable in interface java.sql.DatabaseMetaData

 PROCEDURE_TYPE - Returns a result.

Process(). Constructor for class java.lang.Process

 processActionEvent(ActionEvent). Method in class java.awt.Button

 Processes action events occurring on this button by  dispatching them to any registered ActionListener objects.

processActionEvent(ActionEvent). Method in class java.awt.List

 Processes action events occurring on this component by  dispatching them to any registered ActionListener objects.

processActionEvent(ActionEvent). Method in class java.awt.MenuItem

 Processes action events occurring on this menu item by  dispatching them to any registered ActionListener objects.

processActionEvent(ActionEvent). Method in class java.awt.TextField

 Processes action events occurring on this textfield by  dispatching them to any registered ActionListener objects.

processAdjustmentEvent(AdjustmentEvent). Method in class java.awt.Scrollbar

 Processes adjustment events occurring on this scrollbar by  dispatching them to any registered AdjustmentListener objects.

processComponentEvent(ComponentEvent). Method in class java.awt.Component

 Processes component events occurring on this component by  dispatching them to any registered ComponentListener objects.

processContainerEvent(ContainerEvent). Method in class java.awt.Container

 Processes container events occurring on this container by  dispatching them to any registered ContainerListener objects.

processEvent(AWTEvent). Method in class java.awt.Button

 Processes events on this button.

processEvent(AWTEvent). Method in class java.awt.Checkbox

 Processes events on this checkbox.

processEvent(AWTEvent). Method in class java.awt.CheckboxMenuItem

 Processes events on this checkbox menu item.

processEvent(AWTEvent). Method in class java.awt.Choice

 Processes events on this choice.

processEvent(AWTEvent). Method in class java.awt.Component

 Processes events occurring on this component.

processEvent(AWTEvent). Method in class java.awt.Container

 Processes events on this container.

processEvent(AWTEvent). Method in class java.awt.List

 Processes events on this list.

processEvent(AWTEvent). Method in class java.awt.MenuComponent

 Processes events occurring on this menu component.

processEvent(AWTEvent). Method in class java.awt.MenuItem

 Processes events on this menu item.

processEvent(AWTEvent). Method in class java.awt.Scrollbar

 Processes events on this scrollbar.

processEvent(AWTEvent). Method in class java.awt.TextComponent

 Processes events on this textcomponent.

processEvent(AWTEvent). Method in class java.awt.TextField

 Processes events on this textfield.

processEvent(AWTEvent). Method in class java.awt.Window

 Processes events on this window.

processFocusEvent(FocusEvent). Method in class java.awt.Component

 Processes focus events occurring on this component by  dispatching them to any registered FocusListener objects.

processItemEvent(ItemEvent). Method in class java.awt.Checkbox

 Processes item events occurring on this checkbox by  dispatching them to any registered ItemListener objects.

processItemEvent(ItemEvent). Method in class java.awt.CheckboxMenuItem

 Processes item events occurring on this checkbox menu item by  dispatching them to any registered ItemListener objects.

processItemEvent(ItemEvent). Method in class java.awt.Choice

 Processes item events occurring on this choice by  dispatching them to any registered ItemListener objects.

processItemEvent(ItemEvent). Method in class java.awt.List

 Processes item events occurring on this list by  dispatching them to any registered ItemListener objects.

processKeyEvent(KeyEvent). Method in class java.awt.Component

 Processes key events occurring on this component by  dispatching them to any registered KeyListener objects.

processMouseEvent(MouseEvent). Method in class java.awt.Component

 Processes mouse events occurring on this component by  dispatching them to any registered MouseListener objects.

processMouseMotionEvent(MouseEvent). Method in class java.awt.Component

 Processes mouse motion events occurring on this component by  dispatching them to any registered MouseMotionListener objects.

processTextEvent(TextEvent). Method in class java.awt.TextComponent

 Processes text events occurring on this text component by  dispatching them to any registered TextListener objects.

processWindowEvent(WindowEvent). Method in class java.awt.Window

 Processes window events occurring on this window by  dispatching them to any registered WindowListener objects.

PROPERTIES. Static variable in interface java.awt.image.ImageObserver

 The properties of the image are now available.

Properties(). Constructor for class java.util.Properties

 Creates an empty property list with no default values.

Properties(Properties). Constructor for class java.util.Properties

 Creates an empty property list with the specified defaults.

propertyChange(PropertyChangeEvent). Method in interface java.beans. PropertyChangeListener

 This method gets called when a bound property is changed.

PropertyChangeEvent(Object, String, Object, Object). Constructor for class java.beans.PropertyChangeEvent

 PropertyChangeSupport(Object). Constructor for class java.beans.PropertyChangeSupport

 PropertyDescriptor(String, Class). Constructor for class java.beans.PropertyDescriptor

 Constructs a PropertyDescriptor for a property that follows  the standard Java convention by having getFoo and setFoo  accessor methods.

PropertyDescriptor(String, Class, String, String). Constructor for class java.beans.PropertyDescriptor

 This constructor takes the name of a simple property, and method  names for reading and writing the property.

PropertyDescriptor(String, Method, Method). Constructor for class java.beans. PropertyDescriptor

 This constructor takes the name of a simple property, and Method  objects for reading and writing the property.

PropertyEditorManager(). Constructor for class java.beans.PropertyEditorManager

 PropertyEditorSupport(). Constructor for class java.beans.PropertyEditorSupport

 Constructor for use by derived PropertyEditor classes.

PropertyEditorSupport(Object). Constructor for class java.beans. PropertyEditorSupport

 Constructor for use when a PropertyEditor is delegating to us.

propertyNames(). Method in class java.util.Properties

 Returns an enumeration of all the keys in this property list, including  the keys in the default property list.

PropertyResourceBundle(InputStream). Constructor for class java.util. PropertyResourceBundle

 Creates a property resource

PropertyVetoException(String, PropertyChangeEvent). Constructor for class java.beans.PropertyVetoException

 PROTECTED. Static variable in class java.lang.reflect.Modifier

 ProtocolException(). Constructor for class java.net. ProtocolException

 Constructs a new ProtocolException with no detail message.

ProtocolException(String). Constructor for class java.net.ProtocolException

 Constructs a new ProtocolException with the  specified detail message.

Provider(String, double, String). Constructor for class java.security.Provider

 Constructs a provider with the specified name, version number,  and information.

ProviderException(). Constructor for class java.security.ProviderException

 Constructs a ProviderException with no detail message.

ProviderException(String). Constructor for class java.security. ProviderException

 Constructs a ProviderException with the specified detail  message.

PUBLIC. Static variable in interface java.lang.reflect.Member

 Identifies the set of all public members of a class or interface,  including inherited members.

PUBLIC. Static variable in class java.lang.reflect.Modifier

 push(Object). Method in class java.util.Stack

 Pushes an item onto the top of this stack.

pushBack(). Method in class java.io.StreamTokenizer

 Causes the next call to the nextToken method of this  tokenizer to return the current value in the ttype  field, and not to modify the value in the nval or  sval field.

PushbackInputStream(InputStream). Constructor for class java.io. PushbackInputStream

 Constructs a new pushback input stream that reads its input from  the specified input stream.

PushbackInputStream(InputStream, int). Constructor for class java.io. PushbackInputStream

 Creates a new input stream with a push back buffer of specified size.

PushbackReader(Reader). Constructor for class java.io.PushbackReader

 Create a new pushback reader with a one-character pushback buffer.

PushbackReader(Reader, int). Constructor for class java.io.PushbackReader

 Create a new pushback reader with a pushback buffer of the given size.

put(Object, Object). Method in class java.util.Dictionary

 Maps the specified key to the specified  value in this dictionary.

put(Object, Object). Method in class java.util.Hashtable

 Maps the specified key to the specified  value in this hashtable.

putNextEntry(ZipEntry). Method in class java.util.zip.ZipOutputStream

 Begins writing a new ZIP file entry and positions the stream to the  start of the entry data.

______________________________________________________________________________

  Q

quitEvent(). Method in interface sun.tools.debug.DebuggerCallback

 The client interpreter has exited, either by returning from its  main thread, or by calling System.exit().

quoteChar(int). Method in class java.io.StreamTokenizer

 Specifies that matching pairs of this character delimit string  constants in this tokenizer.

______________________________________________________________________________

  R

random(). Static method in class java.lang.Math

 Returns a random number between 0.0 and 1.0.

Random(). Constructor for class java.util.Random

 Creates a new random number generator.

Random(long). Constructor for class java.util.Random

 Creates a new random number generator using a single  long seed.

RandomAccessFile(File, String). Constructor for class java.io.RandomAccessFile

 Creates a random access file stream to read from, and optionally  to write to, the file specified by the File argument.

RandomAccessFile(String, String). Constructor for class java.io. RandomAccessFile

 Creates a random access file stream to read from, and optionally  to write to, a file with the specified name.

RANDOMPIXELORDER. Static variable in interface java.awt.image.ImageConsumer

 The pixels will be delivered in a random order.

read(). Method in class java.io.BufferedInputStream

 Reads the next byte of data from this buffered input stream.

read(). Method in class java.io.BufferedReader

 Read a single character.

read(). Method in class java.io.ByteArrayInputStream

 Reads the next byte of data from this input stream.

read(). Method in class java.io.CharArrayReader

 Read a single character.

read(). Method in class java.util.zip.CheckedInputStream

 Reads a byte.

read(). Method in class java.security.DigestInputStream

 Reads a byte, and updates the message digest (if the digest  function is on).

read(). Method in class java.io.FileInputStream

 Reads a byte of data from this input stream.

read(). Method in class java.io.FilterInputStream

 Reads the next byte of data from this input stream.

read(). Method in class java.io.FilterReader

 Read a single character.

read(). Method in class java.util.zip.InflaterInputStream

 Reads a byte of uncompressed data.

read(). Method in class java.io.InputStream

 Reads the next byte of data from this input stream.

read(). Method in class java.io.InputStreamReader

 Read a single character.

read(). Method in class java.io.LineNumberInputStream

 Reads the next byte of data from this input stream.

read(). Method in class java.io.LineNumberReader

 Read a single character.

read(). Method in interface java.io.ObjectInput

 Reads a byte of data.

read(). Method in class java.io.ObjectInputStream

 Reads a byte of data.

read(). Method in class java.io.PipedInputStream

 Reads the next byte of data from this piped input stream.

read(). Method in class java.io.PushbackInputStream

 Reads the next byte of data from this input stream.

read(). Method in class java.io.PushbackReader

 Read a single character.

read(). Method in class java.io.RandomAccessFile

 Reads a byte of data from this file.

read(). Method in class java.io.Reader

 Read a single character.

read(). Method in class java.io.SequenceInputStream

 Reads the next byte of data from this input stream.

read(). Method in class java.io.StringBufferInputStream

 Reads the next byte of data from this input stream.

read(). Method in class java.io.StringReader

 Read a single character.

read(byte[]). Method in class java.io.DataInputStream

 Reads up to byte.length bytes of data from this data  input stream into an array of bytes.

read(byte[]). Method in class java.io.FileInputStream

 Reads up to b.length bytes of data from this input  stream into an array of bytes.

read(byte[]). Method in class java.io.FilterInputStream

 Reads up to byte.length bytes of data from this  input stream into an array of bytes.

read(byte[]). Method in class java.io.InputStream

 Reads up to b.length bytes of data from this input  stream into an array of bytes.

read(byte[]). Method in interface java.io.ObjectInput

 Reads into an array of bytes.

read(byte[]). Method in class java.io.RandomAccessFile

 Reads up to b.length bytes of data from this file  into an array of bytes.

read(byte[], int, int). Method in class java.io.BufferedInputStream

 Reads up to len bytes of data from this buffered  input stream into an array of bytes.

read(byte[], int, int). Method in class java.io.ByteArrayInputStream

 Reads up to len bytes of data into an array of bytes  from this input stream.

read(byte[], int, int). Method in class java.util.zip.CheckedInputStream

 Reads into an array of bytes.

read(byte[], int, int). Method in class java.io.DataInputStream

 Reads up to len bytes of data from this data input  stream into an array of bytes.

read(byte[], int, int). Method in class java.security.DigestInputStream

 Reads into a byte array, and updates the message digest (if the  digest function is on).

read(byte[], int, int). Method in class java.io.FileInputStream

 Reads up to len bytes of data from this input stream  into an array of bytes.

read(byte[], int, int). Method in class java.io.FilterInputStream

 Reads up to len bytes of data from this input stream  into an array of bytes.

read(byte[], int, int). Method in class java.util.zip.GZIPInputStream

 Reads uncompressed data into an array of bytes.

read(byte[], int, int). Method in class java.util.zip.InflaterInputStream

 Reads uncompressed data into an array of bytes.

read(byte[], int, int). Method in class java.io.InputStream

 Reads up to len bytes of data from this input stream  into an array of bytes.

read(byte[], int, int). Method in class java.io.LineNumberInputStream

 Reads up to len bytes of data from this input stream  into an array of bytes.

read(byte[], int, int). Method in interface java.io.ObjectInput

 Reads into an array of bytes.

read(byte[], int, int). Method in class java.io.ObjectInputStream

 Reads into an array of bytes.

read(byte[], int, int). Method in class java.io.PipedInputStream

 Reads up to len bytes of data from this piped input  stream into an array of bytes.

read(byte[], int, int). Method in class java.io.PushbackInputStream

 Reads up to len bytes of data from this input stream  into an array of bytes.

read(byte[], int, int). Method in class java.io.RandomAccessFile

 Reads up to len bytes of data from this file into an  array of bytes.

read(byte[], int, int). Method in class java.io.SequenceInputStream

 Reads up to len bytes of data from this input stream  into an array of bytes.

read(byte[], int, int). Method in class java.io.StringBufferInputStream

 Reads up to len bytes of data from this input stream  into an array of bytes.

read(byte[], int, int). Method in class java.util.zip.ZipInputStream

 Reads from the current ZIP entry into an array of bytes.

read(char[]). Method in class java.io.Reader

 Read characters into an array.

read(char[], int, int). Method in class java.io.BufferedReader

 Read characters into a portion of an array.

read(char[], int, int). Method in class java.io.CharArrayReader

 Read characters into a portion of an array.

read(char[], int, int). Method in class java.io.FilterReader

 Read characters into a portion of an array.

read(char[], int, int). Method in class java.io.InputStreamReader

 Read characters into a portion of an array.

read(char[], int, int). Method in class java.io.LineNumberReader

 Read characters into a portion of an array.

read(char[], int, int). Method in class java.io.PipedReader

 Read characters into a portion of an array.

read(char[], int, int). Method in class java.io.PushbackReader

 Read characters into a portion of an array.

read(char[], int, int). Method in class java.io.Reader

 Read characters into a portion of an array.

read(char[], int, int). Method in class java.io.StringReader

 Read characters into a portion of an array.

read(DataInput). Static method in class java.rmi.server.UID

 Get the uid from the input stream.

read(ObjectInput). Static method in class java.rmi.server.ObjID

 The read method constructs an object id whose contents is read  from the specified input stream.

readBoolean(). Method in interface java.io.DataInput

 Reads a boolean value from the input stream.

readBoolean(). Method in class java.io.DataInputStream

 Reads a boolean from this data input stream.

readBoolean(). Method in class java.io.ObjectInputStream

 Reads in a boolean.

readBoolean(). Method in class java.io.RandomAccessFile

 Reads a boolean from this file.

readByte(). Method in interface java.io.DataInput

 Reads a signed 8-bit value from the input stream.

readByte(). Method in class java.io.DataInputStream

 Reads a signed 8-bit value from this data input stream.

readByte(). Method in class java.io.ObjectInputStream

 Reads an 8 bit byte.

readByte(). Method in class java.io.RandomAccessFile

 Reads a signed 8-bit value from this file.

readChar(). Method in interface java.io.DataInput

 Reads a Unicode char value from the input stream.

readChar(). Method in class java.io.DataInputStream

 Reads a Unicode character from this data input stream.

readChar(). Method in class java.io.ObjectInputStream

 Reads a 16 bit char.

readChar(). Method in class java.io.RandomAccessFile

 Reads a Unicode character from this file.

readDouble(). Method in interface java.io.DataInput

 Reads a double value from the input stream.

readDouble(). Method in class java.io.DataInputStream

 Reads a double from this data input stream.

readDouble(). Method in class java.io.ObjectInputStream

 Reads a 64 bit double.

readDouble(). Method in class java.io.RandomAccessFile

 Reads a double from this file.

Reader(). Constructor for class java.io.Reader

 Create a new character-stream reader whose critical sections will  synchronize on the reader itself.

Reader(Object). Constructor for class java.io.Reader

 Create a new character-stream reader whose critical sections will  synchronize on the given object.

readExternal(ObjectInput). Method in interface java.io.Externalizable

 The object implements the readExternal method to restore its  contents by calling the methods of DataInput for primitive  types and readObject for objects, strings and arrays.

readFloat(). Method in interface java.io.DataInput

 Reads a float value from the input stream.

readFloat(). Method in class java.io.DataInputStream

 Reads a float from this data input stream.

readFloat(). Method in class java.io.ObjectInputStream

 Reads a 32 bit float.

readFloat(). Method in class java.io.RandomAccessFile

 Reads a float from this file.

readFully(byte[]). Method in interface java.io.DataInput

 Reads b.length bytes into the byte array.

readFully(byte[]). Method in class java.io.DataInputStream

 Reads b.length bytes from this data input stream  into the byte array.

readFully(byte[]). Method in class java.io.ObjectInputStream

 Reads bytes, blocking until all bytes are read.

readFully(byte[]). Method in class java.io.RandomAccessFile

 Reads b.length bytes from this file into the byte  array.

readFully(byte[], int, int). Method in interface java.io.DataInput

 Reads b.length bytes into the byte array.

readFully(byte[], int, int). Method in class java.io.DataInputStream

 Reads exactly len bytes from this data input stream  into the byte array.

readFully(byte[], int, int). Method in class java.io.ObjectInputStream

 Reads bytes, blocking until all bytes are read.

readFully(byte[], int, int). Method in class java.io.RandomAccessFile

 Reads exactly len bytes from this file into the byte  array.

readInt(). Method in interface java.io.DataInput

 Reads an int value from the input stream.

readInt(). Method in class java.io.DataInputStream

 Reads a signed 32-bit integer from this data input stream.

readInt(). Method in class java.io.ObjectInputStream

 Reads a 32 bit int.

readInt(). Method in class java.io.RandomAccessFile

 Reads a signed 32-bit integer from this file.

readLine(). Method in class java.io.BufferedReader

 Read a line of text.

readLine(). Method in interface java.io.DataInput

 Reads the next line of text from the input stream.

readLine(). Method in class java.io.DataInputStream

 Reads the next line of text from this data input stream.

readLine(). Method in class java.io.LineNumberReader

 Read a line of text.

readLine(). Method in class java.io.ObjectInputStream

 Reads in a line that has been terminated by a \n, \r,  \r\n or EOF.

readLine(). Method in class java.io.RandomAccessFile

 Reads the next line of text from this file.

readLong(). Method in interface java.io.DataInput

 Reads a long value from the input stream.

readLong(). Method in class java.io.DataInputStream

 Reads a signed 64-bit integer from this data input stream.

readLong(). Method in class java.io.ObjectInputStream

 Reads a 64 bit long.

readLong(). Method in class java.io.RandomAccessFile

 Reads a signed 64-bit integer from this file.

readObject(). Method in interface java.io.ObjectInput

 Read and return an object.

readObject(). Method in class java.io.ObjectInputStream

 Read an object from the ObjectInputStream.

readShort(). Method in interface java.io.DataInput

 Reads a 16-bit value from the input stream.

readShort(). Method in class java.io.DataInputStream

 Reads a signed 16-bit number from this data input stream.

readShort(). Method in class java.io.ObjectInputStream

 Reads a 16 bit short.

readShort(). Method in class java.io.RandomAccessFile

 Reads a signed 16-bit number from this file.

readStreamHeader(). Method in class java.io.ObjectInputStream

 The readStreamHeader method is provided to allow subclasses to  read and verify their own stream headers.

readUnsignedByte(). Method in interface java.io.DataInput

 Reads an unsigned 8-bit value from the input stream.

readUnsignedByte(). Method in class java.io.DataInputStream

 Reads an unsigned 8-bit number from this data input stream.

readUnsignedByte(). Method in class java.io.ObjectInputStream

 Reads an unsigned 8 bit byte.

readUnsignedByte(). Method in class java.io.RandomAccessFile

 Reads an unsigned 8-bit number from this file.

readUnsignedShort(). Method in interface java.io.DataInput

 Reads an unsigned 16-bit value from the input stream.

readUnsignedShort(). Method in class java.io.DataInputStream

 Reads an unsigned 16-bit number from this data input stream.

readUnsignedShort(). Method in class java.io.ObjectInputStream

 Reads an unsigned 16 bit short.

readUnsignedShort(). Method in class java.io.RandomAccessFile

 Reads an unsigned 16-bit number from this file.

readUTF(). Method in interface java.io.DataInput

 Reads in a string that has been encoded using a modified UTF-8 format.

readUTF(). Method in class java.io.DataInputStream

 Reads in a string that has been encoded using a modified UTF-8  format from this data input stream.

readUTF(). Method in class java.io.ObjectInputStream

 Reads a UTF format String.

readUTF(). Method in class java.io.RandomAccessFile

 Reads in a string from this file.

readUTF(DataInput). Static method in class java.io.DataInputStream

 Reads in a string from the specified data input stream.

ready(). Method in class java.io.BufferedReader

 Tell whether this stream is ready to be read.

ready(). Method in class java.io.CharArrayReader

 Tell whether this stream is ready to be read.

ready(). Method in class java.io.FilterReader

 Tell whether this stream is ready to be read.

ready(). Method in class java.io.InputStreamReader

 Tell whether this stream is ready to be read.

ready(). Method in class java.io.PushbackReader

 Tell whether this stream is ready to be read.

ready(). Method in class java.io.Reader

 Tell whether this stream is ready to be read.

ready(). Method in class java.io.StringReader

 Tell whether this stream is ready to be read.

REAL. Static variable in class java.sql.Types

 rebind(String, Remote). Static method in class java.rmi.Naming

 Rebind the name to a new object; replaces any existing binding.

rebind(String, Remote). Method in interface java.rmi.registry.Registry

 Rebind the name to a new object, replacing any existing binding.

receive(DatagramPacket). Method in class java.net.DatagramSocket

 Receives a datagram packet from this socket.

receive(DatagramPacket). Method in class java.net.DatagramSocketImpl

 Receive the datagram packet.

receive(int). Method in class java.io.PipedInputStream

 Receives a byte of data.

Rectangle(). Constructor for class java.awt.Rectangle

 Constructs a new rectangle, initialized to location (0, 0) and  size (0, 0).

Rectangle(Dimension). Constructor for class java.awt.Rectangle

 Constructs a rectangle and initializes it to the specified width and  height.

Rectangle(int, int). Constructor for class java.awt.Rectangle

 Constructs a rectangle and initializes it with the specified width and  height parameters.

Rectangle(int, int, int, int). Constructor for class java.awt.Rectangle

 Constructs and initializes a rectangle with the specified parameters.

Rectangle(Point). Constructor for class java.awt.Rectangle

 Constructs a rectangle and initializes it to the specified point.

Rectangle(Point, Dimension). Constructor for class java.awt.Rectangle

 Constructs a rectangle and initializes it to a specified point and  dimension.

Rectangle(Rectangle). Constructor for class java.awt.Rectangle

 Constructs a new rectangle, initialized to match the values of  the specificed rectangle.

red. Static variable in class java.awt.Color

 The color red.

ref. Variable in class java.rmi.server.RemoteObject

 regionMatches(boolean, int, String, int, int). Method in class java.lang.String

 Tests if two string regions are equal.

regionMatches(int, String, int, int). Method in class java.lang.String

 Tests if two string regions are equal.

registerDriver(Driver). Static method in class java.sql.DriverManager

 A newly loaded driver class should call registerDriver to make itself  known to the DriverManager.

registerEditor(Class, Class). Static method in class java.beans. PropertyEditorManager

 Register an editor class to be used to editor values of  a given target class.

registerOutParameter(int, int). Method in interface java.sql.CallableStatement

 Before executing a stored procedure call, you must explicitly  call registerOutParameter to register the java.sql.Type of each  out parameter.

registerOutParameter(int, int, int). Method in interface java.sql. CallableStatement

 Use this version of registerOutParameter for registering  Numeric or Decimal out parameters.

registerValidation(ObjectInputValidation, int). Method in class java.io. ObjectInputStream

 Register an object to be validated before the graph is  returned.

REGISTRY_ID. Static variable in class java.rmi.server.ObjID

 well-known id for the registry

REGISTRY_PORT. Static variable in interface java.rmi.registry.Registry

 Well known port for registry

registryImpl(int). Method in interface java.rmi.registry.RegistryHandler

 Constructs and exports a Registry on the specified port.

registryStub(String, int). Method in interface java.rmi.registry. RegistryHandler

 Returns a "stub" for contacting a remote registry  on the specified host and port.

rehash(). Method in class java.util.Hashtable

 Rehashes the contents of the hashtable into a hashtable with a  larger capacity.

RELATIVE. Static variable in class java.awt.GridBagConstraints

 releaseInputStream(). Method in interface java.rmi.server.RemoteCall

 Release the input stream.

releaseOutputStream(). Method in interface java.rmi.server.RemoteCall

 Release the output stream; in some transports this would release  the stream.

REMAINDER. Static variable in class java.awt.GridBagConstraints

 remainder(BigInteger). Method in class java.math. BigInteger

 Returns a BigInteger whose value is (this % val).

RemoteDebugger(String, DebuggerCallback, boolean). Constructor for class sun.tools.debug.RemoteDebugger

 Create a remote debugger.

 RemoteDebugger (String, String, DebuggerCallback, boolean). Constructor for class sun.tools.debug.RemoteDebugger

 Create a remote debugger, connecting it with a running Java  interpreter.

To connect to a running interpreter, it must be  started with the "-debug" option, whereupon it will print out  the password for that debugging session.

remoteEquals(RemoteRef). Method in interface java.rmi.server.RemoteRef

 Compares two remote objects for equality.

RemoteException(). Constructor for class java.rmi.RemoteException

 Create a remote exception

RemoteException(String). Constructor for class java.rmi.RemoteException

 Create a remote exception with the specified string

RemoteException(String, Throwable). Constructor for class java.rmi. RemoteException

 Create a remote exception with the specified string, and the  exception specified.

remoteHashCode(). Method in interface java.rmi.server.RemoteRef

 Returns a hashcode for a remote object.

RemoteInt(int). Constructor for class sun.tools.debug.RemoteInt

 RemoteObject(). Constructor for class java.rmi.server.RemoteObject

 Create a remote object.

RemoteObject(RemoteRef). Constructor for class java.rmi.server.RemoteObject

 Create a remote object, initialized with the specified remote reference.

RemoteServer(). Constructor for class java.rmi.server.RemoteServer

 RemoteServer(RemoteRef). Constructor for class java.rmi.server.RemoteServer

 RemoteStub(). Constructor for class java.rmi.server. RemoteStub

 Constructor for RemoteStub.

RemoteStub(RemoteRef). Constructor for class java.rmi.server.RemoteStub

 Constructor for RemoteStub, with the specified remote reference.

remoteToString(). Method in interface java.rmi.server.RemoteRef

 Returns a String that represents the reference of this remote  object.

remove(ActionListener, ActionListener). Static method in class java.awt. AWTEventMulticaster

 Removes the old action-listener from action-listener-l and  returns the resulting multicast listener.

remove(AdjustmentListener, AdjustmentListener). Static method in class java.awt.AWTEventMulticaster

 Removes the old adjustment-listener from adjustment-listener-l and  returns the resulting multicast listener.

remove(Component). Method in class java.awt.Container

 Removes the specified component from this container.

remove(ComponentListener, ComponentListener). Static method in class java.awt. AWTEventMulticaster

 Removes the old component-listener from component-listener-l and  returns the resulting multicast listener.

remove(ContainerListener, ContainerListener). Static method in class java.awt. AWTEventMulticaster

 Removes the old container-listener from container-listener-l and  returns the resulting multicast listener.

remove(EventListener). Method in class java.awt.AWTEventMulticaster

 Removes a listener from this multicaster and returns the  resulting multicast listener.

remove(FocusListener, FocusListener). Static method in class java.awt. AWTEventMulticaster

 Removes the old focus-listener from focus-listener-l and  returns the resulting multicast listener.

remove(int). Method in class java.awt.Choice

 Removes an item from the choice menu.

remove(int). Method in interface java.awt.peer.ChoicePeer

 remove(int). Method in class java.awt.Container

 Removes the component at the specified index from this container.

remove(int). Method in class java.awt.List

 Removes an item from the list.

remove(int). Method in class java.awt.Menu

 Deletes the item from this menu at the specified index.

remove(int). Method in class java.awt.MenuBar

 Removes the menu located at the specified index from the menu bar.

remove(ItemListener, ItemListener). Static method in class java.awt. AWTEventMulticaster

 Removes the old item-listener from item-listener-l and  returns the resulting multicast listener.

remove(KeyListener, KeyListener). Static method in class java.awt. AWTEventMulticaster

 Removes the old key-listener from key-listener-l and  returns the resulting multicast listener.

remove(MenuComponent). Method in class java.awt.Component

 Removes the specified popup menu from the component.

remove(MenuComponent). Method in class java.awt.Frame

 Removes the specified menu bar from this Frame.

remove(MenuComponent). Method in class java.awt.Menu

 Deletes the specified item from this menu.

remove(MenuComponent). Method in class java.awt.MenuBar

 Removes the specified menu from the menu bar.

remove(MenuComponent). Method in interface java.awt.MenuContainer

 remove(MouseListener, MouseListener). Static method in class java.awt.AWTEventMulticaster

 Removes the old mouse-listener from mouse-listener-l and  returns the resulting multicast listener.

remove(MouseMotionListener, MouseMotionListener). Static method in class java.awt.AWTEventMulticaster

 Removes the old mouse-motion-listener from mouse-motion-listener-l  and returns the resulting multicast listener.

remove(Object). Method in class java.util.Dictionary

 Removes the key (and its corresponding  value) from this dictionary.

remove(Object). Method in class java.util.Hashtable

 Removes the key (and its corresponding value) from this  hashtable.

remove(String). Method in class java.awt.Choice

 Remove the first occurrence of item from the choice menu.

remove(String). Method in class java.awt.List

 Remove the first occurrence of item from the list.

remove(TextListener, TextListener). Static method in class java.awt. AWTEventMulticaster

 remove(WindowListener, WindowListener). Static method in class java.awt.AWTEventMulticaster

 Removes the old window-listener from window-listener-l and  returns the resulting multicast listener.

removeActionListener(ActionListener). Method in class java.awt.Button

 Removes the specified action listener so it no longer receives  action events from this button.

removeActionListener(ActionListener). Method in class java.awt.List

 Removes the specified action listener so it no longer receives  action events from this list.

removeActionListener(ActionListener). Method in class java.awt.MenuItem

 Removes the specified action listener so it no longer receives  action events from this menu item.

removeActionListener(ActionListener). Method in class java.awt.TextField

 Removes the specified action listener so that it no longer  receives action events from this textfield.

removeAdjustmentListener(AdjustmentListener). Method in interface java.awt. Adjustable

 Removes an adjustment listener.

removeAdjustmentListener(AdjustmentListener). Method in class java.awt. Scrollbar

 Removes the specified adjustment listener so that it no longer  receives adjustment events from this scrollbar..

removeAll(). Method in class java.awt.Choice

 Removes all items from the choice menu.

removeAll(). Method in class java.awt.Container

 Removes all the components from this container.

removeAll(). Method in class java.awt.List

 Removes all items from the list.

removeAll(). Method in interface java.awt.peer.ListPeer

 removeAll(). Method in class java.awt.Menu

 Deletes all items from this menu.

removeAllElements(). Method in class java.util.Vector

 Removes all components from this vector and sets its size to zero.

removeCertificate(Certificate). Method in class java.security.Identity

 Removes a certificate from this identity.

removeComponentListener(ComponentListener). Method in class java.awt.Component

 Removes the specified listener so it no longer receives component  events from this component.

removeConsumer(ImageConsumer). Method in class java.awt.image. FilteredImageSource

 Removes an ImageConsumer from the list of consumers interested in  data for this image.

removeConsumer(ImageConsumer). Method in interface java.awt.image.ImageProducer

 This method removes the given ImageConsumer object  from the list of consumers currently registered to  receive image data.

removeConsumer(ImageConsumer). Method in class java.awt.image. MemoryImageSource

 Remove an ImageConsumer from the list of consumers interested in  data for this image.

removeContainerListener(ContainerListener). Method in class java.awt.Container

 Removes the specified container listener so it no longer receives  container events from this container.

removeElement(Object). Method in class java.util.Vector

 Removes the first occurrence of the argument from this vector.

removeElementAt(int). Method in class java.util.Vector

 Deletes the component at the specified index.

removeEntry(Principal, AclEntry). Method in interface java.security.acl.Acl

 Removes an ACL entry from this ACL.

removeFocusListener(FocusListener). Method in class java.awt.Component

 Removes the specified focus listener so it no longer receives focus  events from this component.

removeIdentity(Identity). Method in class java.security.IdentityScope

 Removes an identity from this identity scope.

removeImage(Image). Method in class java.awt.MediaTracker

 Remove the specified Image from this MediaTracker.

removeImage(Image, int). Method in class java.awt.MediaTracker

 Remove the specified Image from the specified ID of this MediaTracker.

removeImage(Image, int, int, int). Method in class java.awt.MediaTracker

 Remove the specified image with the specified size and ID from  this MediaTracker.

removeInternal(EventListener, EventListener). Static method in class java.awt. AWTEventMulticaster

 Returns the resulting multicast listener after removing the  old listener from listener-l.

removeItemListener(ItemListener). Method in class java.awt.Checkbox

 Removes the specified item listener so that it no longer  receives item events from this checkbox.

removeItemListener(ItemListener). Method in class java.awt.CheckboxMenuItem

 Removes the specified item listener so it no longer receives  item events from this checkbox menu item.

removeItemListener(ItemListener). Method in class java.awt.Choice

 Removes the specified item listener so that it no longer  receives item events from this choice.

removeItemListener(ItemListener). Method in interface java.awt.ItemSelectable

 Removes an item listener.

removeItemListener(ItemListener). Method in class java.awt.List

 Removes the specified item listener so it no longer receives  item events from this list.

removeKeyListener(KeyListener). Method in class java.awt.Component

 Removes the specified key listener so it no longer receives key  events from this component.

removeLayoutComponent(Component). Method in class java.awt.BorderLayout

 Removes the specified component from the layout.

removeLayoutComponent(Component). Method in class java.awt.CardLayout

 Removes the specified component from the layout.

removeLayoutComponent(Component). Method in class java.awt.FlowLayout

 Removes the specified component from the layout.

removeLayoutComponent(Component). Method in class java.awt.GridBagLayout

 Removes the specified component from the layout.

removeLayoutComponent(Component). Method in class java.awt.GridLayout

 Removes the specified component from the layout.

removeLayoutComponent(Component). Method in interface java.awt.LayoutManager

 Removes the specified component from the layout.

removeMember(Principal). Method in interface java.security.acl.Group

 Removes the specified member from the group.

removeMouseListener(MouseListener). Method in class java.awt.Component

 Removes the specified mouse listener so it no longer receives mouse  events from this component.

removeMouseMotionListener(MouseMotionListener). Method in class java.awt. Component

 Removes the specified mouse motion listener so it no longer  receives mouse motion events from this component.

removeNotify(). Method in class java.awt.Component

 Notifies the Component that it has been removed from its  container and if a peers ecists, it destroys it.

removeNotify(). Method in class java.awt.Container

 Notifies the container to remove its peer.

removeNotify(). Method in class java.awt.List

 Removes the peer for this list.

removeNotify(). Method in class java.awt.Menu

 Removes the menu's peer.

removeNotify(). Method in class java.awt.MenuBar

 Removes the menu bar's peer.

removeNotify(). Method in class java.awt.MenuComponent

 Removes the menu component's peer.

removeNotify(). Method in class java.awt.TextComponent

 Removes the TextComponent's peer.

removePermission(Permission). Method in interface java.security.acl.AclEntry

 Removes the specified permission from this ACL entry.

removePropertyChangeListener(PropertyChangeListener). Method in interface java.beans.Customizer

 Remove a listener for the PropertyChange event.

removePropertyChangeListener(PropertyChangeListener). Method in class java.beans.PropertyChangeSupport

 Remove a PropertyChangeListener from the listener list.

removePropertyChangeListener(PropertyChangeListener). Method in interface java.beans.PropertyEditor

 Remove a listener for the PropertyChange event.

removePropertyChangeListener(PropertyChangeListener). Method in class java.beans.PropertyEditorSupport

 Remove a listener for the PropertyChange event.

removeProvider(String). Static method in class java.security.Security

 Removes the provider with the specified name.

removeTextListener(TextListener). Method in class java.awt.TextComponent

 Removes the specified text event listener so that it no longer  receives text events from this textcomponent

removeVetoableChangeListener(VetoableChangeListener). Method in class java.beans.VetoableChangeSupport

 Remove a VetoableChangeListener from the listener list.

removeWindowListener(WindowListener). Method in class java.awt.Window

 Removes the specified window listener so that it no longer  receives window events from this window.

renameTo(File). Method in class java.io.File

 Renames the file specified by this File object to  have the pathname given by the File argument.

repaint(). Method in class java.awt.Component

 Repaints the component.

repaint(int, int, int, int). Method in class java.awt.Component

 Repaints part of the component.

repaint(long). Method in class java.awt.Component

 Repaints the component.

repaint(long, int, int, int, int). Method in class java.awt.Component

 Repaints part of the component.

repaint(long, int, int, int, int). Method in interface java.awt.peer. ComponentPeer

 replace(char, char). Method in class java.lang. String

 Returns a new string resulting from replacing all occurrences of  oldChar  in this string with newChar.

replaceItem(String, int). Method in class java.awt.List

 Replaces the item at the given index.

replaceObject(Object). Method in class java.io.ObjectOutputStream

 This method will allow trusted subclasses of ObjectOutputStream  to substitute one object for another during  serialization.

replaceRange(String, int, int). Method in class java.awt.TextArea

 Replaces text from the indicated start to end position with the  new text specified.

replaceRange(String, int, int). Method in interface java.awt.peer.TextAreaPeer

 replaceText(String, int, int). Method in class java.awt.TextArea

 replaceText(String, int, int). Method in interface java.awt.peer.TextAreaPeer

 DEPRECATED: Replaced by ReplaceRange(String, int, int).

ReplicateScaleFilter(int, int). Constructor for class java.awt.image. ReplicateScaleFilter

 Constructs a ReplicateScaleFilter that scales the pixels from  its source Image as specified by the width and height parameters.

requestFocus(). Method in class java.awt.Component

 Requests the input focus.

requestFocus(). Method in interface java.awt.peer.ComponentPeer

 requestTopDownLeftRightResend(ImageConsumer). Method in class java.awt.image.FilteredImageSource

 Requests that a given ImageConsumer have the image data delivered  one more time in top-down, left-right order.

requestTopDownLeftRightResend(ImageConsumer). Method in interface java.awt.image.ImageProducer

 This method is used by an ImageConsumer to request that  the ImageProducer attempt to resend the image data one  more time in TOPDOWNLEFTRIGHT order so that higher  quality conversion algorithms which depend on receiving  pixels in order can be used to produce a better output  version of the image.

requestTopDownLeftRightResend(ImageConsumer). Method in class java.awt.image. MemoryImageSource

 Requests that a given ImageConsumer have the image data delivered  one more time in top-down, left-right order.

required. Variable in class java.sql.DriverPropertyInfo

 "required" is true if a value must be supplied for this property  during Driver.connect.

resendTopDownLeftRight(ImageProducer). Method in class java.awt.image. ImageFilter

 Responds to a request for a TopDownLeftRight (TDLR) ordered resend  of the pixel data from an ImageConsumer.

reset(). Method in class java.util.zip.Adler32

 Resets checksum to initial value.

reset(). Method in class java.io.BufferedInputStream

 Repositions this stream to the position at the time the  mark  method was last called on this input stream.

reset(). Method in class java.io.BufferedReader

 Reset the stream to the most recent mark.

reset(). Method in class java.io.ByteArrayInputStream

 Resets the buffer to the marked position.

reset(). Method in class java.io.ByteArrayOutputStream

 Resets the count field of this byte array output  stream to zero, so that all currently accumulated output in the  ouput stream is discarded.

reset(). Method in class java.io.CharArrayReader

 Reset the stream to the most recent mark, or to the beginning if it has  never been marked.

reset(). Method in class java.io.CharArrayWriter

 Resets the buffer so that you can use it again without  throwing away the already allocated buffer.

reset(). Method in interface java.util.zip.Checksum

 Resets the checksum to its initial value.

reset(). Method in class java.text.CollationElementIterator

 Resets the cursor to the beginning of the string.

reset(). Method in class java.util.zip.CRC32

 Resets CRC-32 to initial value.

reset(). Method in class java.util.zip.Deflater

 Resets deflater so that a new set of input data can be processed.

reset(). Method in class java.io.FilterInputStream

 Repositions this stream to the position at the time the  mark  method was last called on this input stream.

reset(). Method in class java.io.FilterReader

 Reset the stream.

reset(). Method in class java.util.zip.Inflater

 Resets inflater so that a new set of input data can be processed.

reset(). Method in class java.io.InputStream

 Repositions this stream to the position at the time the  mark  method was last called on this input stream.

reset(). Method in class java.io.LineNumberInputStream

 Repositions this stream to the position at the time the  mark  method was last called on this input stream.

reset(). Method in class java.io.LineNumberReader

 Reset the stream to the most recent mark.

reset(). Method in class java.security.MessageDigest

 Resets the digest for further use.

reset(). Method in class java.io.ObjectOutputStream

 Reset will disregard the state of any objects already written  to the stream.

reset(). Method in class java.io.Reader

 Reset the stream.

reset(). Method in class java.io.StringBufferInputStream

 Resets the input stream to begin reading from the first character  of this input stream's underlying buffer.

reset(). Method in class java.io.StringReader

 Reset the stream to the most recent mark, or to the beginning of the  string if it has never been marked.

resetCurrentFrameIndex(). Method in class sun.tools.debug.RemoteThread

 Reset the current stackframe

resetSyntax(). Method in class java.io.StreamTokenizer

 Resets this tokenizer's syntax table so that all characters are  "ordinary." See the ordinaryChar method  for more information on a character being ordinary.

reshape(int, int, int, int). Method in class java.awt.Component

 reshape(int, int, int, int). Method in interface java.awt.peer.ComponentPeer

 DEPRECATED: Replaced by setBounds(int, int, int, int).

reshape(int, int, int, int). Method in class java.awt.Rectangle

 resize(Dimension). Method in class java.applet. Applet

 Requests that this applet be resized.

resize(Dimension). Method in class java.awt.Component

 resize(int, int). Method in class java.applet.Applet

 Requests that this applet be resized.

resize(int, int). Method in class java.awt.Component

 resize(int, int). Method in class java.awt.Rectangle

 resolveClass(Class). Method in class java.lang. ClassLoader

 Resolves the class so that an instance of the class can be  created, or so that one of its methods can be called.

resolveClass(ObjectStreamClass). Method in class java.io.ObjectInputStream

 Subclasses may implement this method to allow classes to be  fetched from an alternate source.

resolveObject(Object). Method in class java.io.ObjectInputStream

 This method will allow trusted subclasses of ObjectInputStream  to substitute one object for another during  deserialization.

ResourceBundle(). Constructor for class java.util.ResourceBundle

 responseCode. Variable in class java.net. HttpURLConnection

 responseMessage. Variable in class java.net. HttpURLConnection

 resume(). Method in class sun.tools.debug. RemoteThread

 Resume execution of this thread.

resume(). Method in class java.lang.Thread

 Resumes a suspended thread.

resume(). Method in class java.lang.ThreadGroup

 Resumes all processes in this thread group.

reverse(). Method in class java.lang.StringBuffer

 The character sequence contained in this string buffer is  replaced by the reverse of the sequence.

RGBImageFilter(). Constructor for class java.awt.image.RGBImageFilter

 RGBtoHSB(int, int, int, float[]). Static method in class java.awt.Color

 Returns the HSB values corresponding to the color defined by the  red, green, and blue components.

RIGHT. Static variable in class java.awt.Event

 The right arrow action-key.

RIGHT. Static variable in class java.awt.FlowLayout

 The right alignment variable.

right. Variable in class java.awt.Insets

 The inset from the right.

RIGHT. Static variable in class java.awt.Label

 The right alignment.

RIGHT_ALIGNMENT. Static variable in class java.awt.Component

 Ease of use constant for getAlignmentX().

rint(double). Static method in class java.lang.Math

 returns the closest integer to the argument.

RMISecurityException(String). Constructor for class java.rmi. RMISecurityException

 Constructs a RMISecurityException with no detail message.

RMISecurityException(String, String). Constructor for class java.rmi. RMISecurityException

 Constructs a RMISecurityException with the specified detail message.

RMISecurityManager(). Constructor for class java.rmi.RMISecurityManager

 Construct and initialize.

RMISocketFactory(). Constructor for class java.rmi.server.RMISocketFactory

 roll(int, boolean). Method in class java.util. Calendar

 Time Field Rolling function.

roll(int, boolean). Method in class java.util.GregorianCalendar

 Overrides Calendar  Time Field Rolling function.

rollback(). Method in interface java.sql.Connection

 Rollback drops all changes made since the previous  commit/rollback and releases any database locks currently held  by the Connection.

round(double). Static method in class java.lang.Math

 Returns the closest long to the argument.

round(float). Static method in class java.lang.Math

 Returns the closest int to the argument.

ROUND_CEILING. Static variable in class java.math.BigDecimal

 If the BigDecimal is positive, behave as for ROUND_UP; if negative,  behave as for ROUND_DOWN.

ROUND_DOWN. Static variable in class java.math.BigDecimal

 Never increment the digit prior to a discarded fraction (i.e.,  truncate).

ROUND_FLOOR. Static variable in class java.math.BigDecimal

 If the BigDecimal is positive, behave as for ROUND_DOWN; if negative  behave as for ROUND_UP.

ROUND_HALF_DOWN. Static variable in class java.math.BigDecimal

 Behave as for ROUND_UP if the discarded fraction is > .5; otherwise,  behave as for ROUND_DOWN.

ROUND_HALF_EVEN. Static variable in class java.math.BigDecimal

 Behave as for ROUND_HALF_UP if the digit to the left of the discarded  fraction is odd; behave as for ROUND_HALF_DOWN if it's even.

ROUND_HALF_UP. Static variable in class java.math.BigDecimal

 Behave as for ROUND_UP if the discarded fraction is >= .5; otherwise,  behave as for ROUND_DOWN.

ROUND_UNNECESSARY. Static variable in class java.math.BigDecimal

 This "pseudo-rounding-mode" is actually an assertion that the requested  operation has an exact result, hence no rounding is necessary.

ROUND_UP. Static variable in class java.math.BigDecimal

 Always increment the digit prior to a non-zero discarded fraction.

rowHeights. Variable in class java.awt.GridBagLayout

 rowWeights. Variable in class java.awt.GridBagLayout

 RuleBasedCollator(String). Constructor for class java.text.RuleBasedCollator

 RuleBasedCollator constructor.

run(). Method in interface java.lang.Runnable

 When an object implementing interface Runnable is used  to create a thread, starting the thread causes the object's  run  method to be called in that separately executing  thread.

run(). Method in class java.lang.Thread

 If this thread was constructed using a separate  Runnable run object, then that  Runnable object's run method is called;  otherwise, this method does nothing and returns.

run(int, String[]). Method in class sun.tools.debug.RemoteDebugger

 Load and run a runnable Java class, with any optional parameters.

runFinalization(). Method in class java.lang.Runtime

 Runs the finalization methods of any objects pending finalization.

runFinalization(). Static method in class java.lang.System

 Runs the finalization methods of any objects pending finalization.

runFinalizersOnExit(boolean). Static method in class java.lang.Runtime

 Enable or disable finalization on exit; doing so specifies that the  finalizers of all objects that have finalizers that have not yet been  automatically invoked are to be run before the Java runtime exits.

runFinalizersOnExit(boolean). Static method in class java.lang.System

 Enable or disable finalization on exit; doing so specifies that the  finalizers of all objects that have finalizers that have not yet been  automatically invoked are to be run before the Java runtime exits.

RuntimeException(). Constructor for class java.lang.RuntimeException

 Constructs a RuntimeException with no detail message.

RuntimeException(String). Constructor for class java.lang.RuntimeException

 Constructs a RuntimeException with the specified  detail message.

______________________________________________________________________________

  S

S_RESIZE_CURSOR. Static variable in class java.awt.Cursor

 The south-resize cursor type.

S_RESIZE_CURSOR. Static variable in class java.awt.Frame

 sameFile(URL). Method in class java.net.URL

 Compares two URLs, excluding the "ref" fields.

SATURDAY. Static variable in class java.util.Calendar

 Useful constant for days of week.

SAVE. Static variable in class java.awt.FileDialog

 The file save variable.

save(OutputStream, String). Method in class java.util.Properties

 Stores this property list to the specified output stream.

SAVE_FILE. Static variable in class java.awt.Event

 A file saving event.

saveInternal(ObjectOutputStream, String). Method in class java.awt. AWTEventMulticaster

 scale(). Method in class java.math.BigDecimal

 Returns the scale of this number.

SCALE_AREA_AVERAGING. Static variable in class java.awt.Image

 Use the Area Averaging image scaling algorithm.

SCALE_DEFAULT. Static variable in class java.awt.Image

 Use the default image scaling algorithm.

SCALE_FAST. Static variable in class java.awt.Image

 Choose an image scaling algorithm that gives higher priority  to scaling speed than smoothness of the scaled image.

SCALE_REPLICATE. Static variable in class java.awt.Image

 Use the ReplicateScaleFilter image scaling algorithm.

SCALE_SMOOTH. Static variable in class java.awt.Image

 Choose an image scaling algorithm that gives higher priority  to image smoothness than scaling speed.

SCROLL_ABSOLUTE. Static variable in class java.awt.Event

 The absolute scroll event.

SCROLL_BEGIN. Static variable in class java.awt.Event

 The scroll begin event.

SCROLL_END. Static variable in class java.awt.Event

 The scroll end event.

SCROLL_LINE_DOWN. Static variable in class java.awt.Event

 The line down scroll event.

SCROLL_LINE_UP. Static variable in class java.awt.Event

 The line up scroll event.

SCROLL_LOCK. Static variable in class java.awt.Event

 The ScrollLock action-key.

SCROLL_PAGE_DOWN. Static variable in class java.awt.Event

 The page down scroll event.

SCROLL_PAGE_UP. Static variable in class java.awt.Event

 The page up scroll event.

scrollbar. Static variable in class java.awt.SystemColor

 The background color for scrollbars.

SCROLLBAR. Static variable in class java.awt.SystemColor

 The array index for the scrollbar background color.

Scrollbar(). Constructor for class java.awt.Scrollbar

 Constructs a new vertical Scrollbar.

Scrollbar(int). Constructor for class java.awt.Scrollbar

 Constructs a new Scrollbar with the specified orientation.

Scrollbar(int, int, int, int, int). Constructor for class java.awt.Scrollbar

 Constructs a new Scrollbar with the specified orientation,  value, page size, and minumum and maximum values.

SCROLLBARS_ALWAYS. Static variable in class java.awt.ScrollPane

 Specifies that horizontal/vertical scrollbars should always be  shown regardless of the respective sizes of the scrollpane and child.

SCROLLBARS_AS_NEEDED. Static variable in class java.awt.ScrollPane

 Specifies that horizontal/vertical scrollbar should be shown  only when the size of the child exceeds the size of the scrollpane  in the horizontal/vertical dimension.

SCROLLBARS_BOTH. Static variable in class java.awt.TextArea

 Create and display both vertical and horizontal scrollbars.

SCROLLBARS_HORIZONTAL_ONLY. Static variable in class java.awt.TextArea

 Create and display horizontal scrollbar only.

SCROLLBARS_NEVER. Static variable in class java.awt.ScrollPane

 Specifies that horizontal/vertical scrollbars should never be shown  regardless of the respective sizes of the scrollpane and child.

SCROLLBARS_NONE. Static variable in class java.awt.TextArea

 Do not create or display any scrollbars for the text area.

SCROLLBARS_VERTICAL_ONLY. Static variable in class java.awt.TextArea

 Create and display vertical scrollbar only.

ScrollPane(). Constructor for class java.awt.ScrollPane

 Create a new scrollpane container with a scrollbar display policy of  "as needed".

ScrollPane(int). Constructor for class java.awt.ScrollPane

 Create a new scrollpane container.

SE_RESIZE_CURSOR. Static variable in class java.awt.Cursor

 The south-east-resize cursor type.

SE_RESIZE_CURSOR. Static variable in class java.awt.Frame

 search(Object). Method in class java.util.Stack

 Returns where an object is on this stack.

SECOND. Static variable in class java.util.Calendar

 Useful constant for date and time.

SECOND_FIELD. Static variable in class java.text.DateFormat

 Useful constant for SECOND field alignment.

SECONDARY. Static variable in class java.text.Collator

 Collator strength value.

secondaryOrder(int). Static method in class java.text.CollationElementIterator

 Get the secondary order of a collation order.

SecureRandom(). Constructor for class java.security.SecureRandom

 This empty constructor automatically seeds the generator.

SecureRandom(byte[]). Constructor for class java.security.SecureRandom

 This constructor uses a user-provided seed in preference to the  self-seeding algorithm referred to in the empty constructor  description.

SecurityException(). Constructor for class java.lang.SecurityException

 Constructs a SecurityException with no detail message.

SecurityException(String). Constructor for class java.lang.SecurityException

 Constructs a SecurityException with the specified  detail message.

SecurityManager(). Constructor for class java.lang.SecurityManager

 Constructs a new SecurityManager.

seek(long). Method in class java.io.RandomAccessFile

 Sets the offset from the beginning of this file at which the next  read or write occurs.

select(int). Method in class java.awt.Choice

 Selects the item with the specified postion.

select(int). Method in interface java.awt.peer.ChoicePeer

 select(int). Method in class java.awt.List

 Selects the item at the specified index.

select(int). Method in interface java.awt.peer.ListPeer

 select(int, int). Method in class java.awt. TextComponent

 Selects the text found between the specified start and end locations.

select(int, int). Method in interface java.awt.peer.TextComponentPeer

 select(String). Method in class java.awt.Choice

 Selects the item with the specified String.

selectAll(). Method in class java.awt.TextComponent

 Selects all the text in the TextComponent.

SELECTED. Static variable in class java.awt.event.ItemEvent

 The item selected state change type.

send(DatagramPacket). Method in class java.net.DatagramSocket

 Sends a datagram packet from this socket.

send(DatagramPacket). Method in class java.net.DatagramSocketImpl

 Sends a datagram packet.

send(DatagramPacket, byte). Method in class java.net.MulticastSocket

 Sends a datagram packet to the destination, with a TTL (time-  to-live) other than the default for the socket.

separator. Static variable in class java.io.File

 The system-dependent path separator character.

separatorChar. Static variable in class java.io.File

 The system-dependent path separator string.

SEPTEMBER. Static variable in class java.util.Calendar

 Useful constant for month.

SequenceInputStream(Enumeration). Constructor for class java.io. SequenceInputStream

 Constructs a new sequence input stream initialized to the  specified enumeration of input streams.

SequenceInputStream(InputStream, InputStream). Constructor for class java.io. SequenceInputStream

 Constructs a new sequence input stream initialized to read first  from the input stream s1, and then from the input  stream s2.

ServerCloneException(String). Constructor for class java.rmi.server. ServerCloneException

 Create A remote exception with the specified string

ServerCloneException(String, Exception). Constructor for class java.rmi.server. ServerCloneException

 Create A remote exception with the specified string, and the  exception specified.

ServerError(String, Error). Constructor for class java.rmi.ServerError

 Create a new "server error" exception with the string and  the specified exception.

ServerException(String). Constructor for class java.rmi.ServerException

 Create a new server exception with a descriptive string.

ServerException(String, Exception). Constructor for class java.rmi. ServerException

 Create a new server exception with a descriptive string and an  exception.

ServerNotActiveException(). Constructor for class java.rmi.server. ServerNotActiveException

 Create a new exception.

ServerNotActiveException(String). Constructor for class java.rmi.server. ServerNotActiveException

 ServerRuntimeException(String, Exception). Constructor for class java.rmi.ServerRuntimeException

 Create a new runtime exception with the strings and  the specified exception.

ServerSocket(int). Constructor for class java.net.ServerSocket

 Creates a server socket on a specified port.

ServerSocket(int, int). Constructor for class java.net.ServerSocket

 Creates a server socket and binds it to the specified local port  number.

ServerSocket(int, int, InetAddress). Constructor for class java.net.ServerSocket

 Create a server with the specified port, listen backlog, and  local IP address to bind to.

set(int). Method in class java.util.BitSet

 Sets the bit specified by the index to true.

set(int, int). Method in class java.util.Calendar

 Sets the time field with the given value.

set(int, int, int). Method in class java.util.Calendar

 Sets the values for the fields year, month, and date.

set(int, int, int, int, int). Method in class java.util.Calendar

 Sets the values for the fields year, month, date, hour, and minute.

set(int, int, int, int, int, int). Method in class java.util.Calendar

 Sets the values for the fields year, month, date, hour, minute,  and second.

set(Object, int, Object). Static method in class java.lang.reflect.Array

 Sets the value of the indexed component of the specified array  object to the specified new value.

set(Object, Object). Method in class java.lang.reflect.Field

 Sets the field represented by this Field object on the  specified object argument to the specified new value.

set(String, String, int, String, String). Method in class java.net.URL

 Sets the fields of the URL.

setActionCommand(String). Method in class java.awt.Button

 Sets the command name of the action event fired by this button.

setActionCommand(String). Method in class java.awt.MenuItem

 Sets the command name of the action event fired by this menu item.

setAddress(InetAddress). Method in class java.net.DatagramPacket

 setAlignment(int). Method in class java.awt. FlowLayout

 Sets the alignment value for this layout.

setAlignment(int). Method in class java.awt.Label

 Sets the alignment for this label to the specified  alignment.

setAlignment(int). Method in interface java.awt.peer.LabelPeer

 setAllowUserInteraction(boolean). Method in class java.net.URLConnection

 Set the value of the allowUserInteraction field of  this URLConnection.

setAmPmStrings(String[]). Method in class java.text.DateFormatSymbols

 Sets ampm strings.

setAnimated(boolean). Method in class java.awt.image.MemoryImageSource

 Change this memory image into a multi-frame animation or a  single-frame static image depending on the animated parameter.

setAsciiStream(int, InputStream, int). Method in interface java.sql. PreparedStatement

 When a very large ASCII value is input to a LONGVARCHAR  parameter, it may be more practical to send it via a  java.io.InputStream.

setAsText(String). Method in interface java.beans.PropertyEditor

 Set the property value by parsing a given String.

setAsText(String). Method in class java.beans.PropertyEditorSupport

 Set the property value by parsing a given String.

setAutoCommit(boolean). Method in interface java.sql.Connection

 If a connection is in auto-commit mode, then all its SQL  statements will be executed and committed as individual  transactions.

setBackground(Color). Method in class java.awt.Component

 Sets the background color.

setBackground(Color). Method in interface java.awt.peer.ComponentPeer

 setBeanInfoSearchPath(String[]). Static method in class java.beans.Introspector

 Change the list of package names that will be used for 	finding BeanInfo classes.

setBigDecimal(int, BigDecimal). Method in interface java.sql.PreparedStatement

 Set a parameter to a java.lang.BigDecimal value.

setBinaryStream(int, InputStream, int). Method in interface java.sql. PreparedStatement

 When a very large binary value is input to a LONGVARBINARY  parameter, it may be more practical to send it via a  java.io.InputStream.

setBit(int). Method in class java.math.BigInteger

 Returns a BigInteger whose value is equivalent to this number  with the designated bit set.

setBlockIncrement(int). Method in interface java.awt.Adjustable

 Sets the block value increment for the adjustable object.

setBlockIncrement(int). Method in class java.awt.Scrollbar

 Sets the block increment for this scrollbar.

setBoolean(int, boolean). Method in interface java.sql.PreparedStatement

 Set a parameter to a Java boolean value.

setBoolean(Object, boolean). Method in class java.lang.reflect.Field

 Set the value of a field as a boolean on specified object.

setBoolean(Object, int, boolean). Static method in class java.lang.reflect. Array

 Sets the value of the indexed component of the specified array  object to the specified boolean value.

setBound(boolean). Method in class java.beans.PropertyDescriptor

 Updates to "bound" properties will cause a "PropertyChange" event to  get fired when the property is changed.

setBounds(int, int, int, int). Method in class java.awt.Component

 Reshapes the Component to the specified bounding box.

setBounds(int, int, int, int). Method in interface java.awt.peer.ComponentPeer

 setBounds(int, int, int, int). Method in class java.awt.Rectangle

 Set the bounds of this rectangle to the specified x, y, width,  and height.

setBounds(Rectangle). Method in class java.awt.Component

 Reshapes the Component to the specified bounding box.

setBounds(Rectangle). Method in class java.awt.Rectangle

 Set the bounds of this rectangle to match the specified rectangle.

setBreakpointLine(int). Method in class sun.tools.debug.RemoteClass

 Set a breakpoint at a specified source line number in a class.

setBreakpointMethod(RemoteField). Method in class sun.tools.debug.RemoteClass

 Set a breakpoint at the first line of a class method.

setByte(int, byte). Method in interface java.sql.PreparedStatement

 Set a parameter to a Java byte value.

setByte(Object, byte). Method in class java.lang.reflect.Field

 Set the value of a field as a byte on specified object.

setByte(Object, int, byte). Static method in class java.lang.reflect.Array

 Sets the value of the indexed component of the specified array  object to the specified boolean value.

setBytes(int, byte[]). Method in interface java.sql.PreparedStatement

 Set a parameter to a Java array of bytes.

setCalendar(Calendar). Method in class java.text.DateFormat

 Set the calendar to be used by this date format.

setCaretPosition(int). Method in class java.awt.TextComponent

 Sets the position of the text insertion caret for the TextComponent

setCaretPosition(int). Method in interface java.awt.peer.TextComponentPeer

 setCatalog(String). Method in interface java.sql. Connection

 A sub-space of this Connection's database may be selected by setting a  catalog name.

setChanged(). Method in class java.util.Observable

 Indicates that this object has changed.

setChar(Object, char). Method in class java.lang.reflect.Field

 Set the value of a field as a char on specified object.

setChar(Object, int, char). Static method in class java.lang.reflect.Array

 Sets the value of the indexed component of the specified array  object to the specified byte value.

setCharAt(int, char). Method in class java.lang.StringBuffer

 The character at the specified index of this string buffer is set  to ch.

setCheckboxGroup(CheckboxGroup). Method in class java.awt.Checkbox

 Sets the CheckboxGroup to the specified group.

setCheckboxGroup(CheckboxGroup). Method in interface java.awt.peer.CheckboxPeer

 setChoices(double[], String[]). Method in class java.text.ChoiceFormat

 Set the choices to be used in formatting.

setClip(int, int, int, int). Method in class java.awt.Graphics

 Sets the current clip to the rectangle specified by the given  coordinates.

setClip(Shape). Method in class java.awt.Graphics

 Set the current clipping area to an arbitrary clip shape.

setColor(Color). Method in class java.awt.Graphics

 Sets the current color to the specified color.

setColorModel(ColorModel). Method in interface java.awt.image.ImageConsumer

 The ColorModel object used for the majority of  the pixels reported using the setPixels method  calls.

setColorModel(ColorModel). Method in class java.awt.image.ImageFilter

 Filter the information provided in the setColorModel method  of the ImageConsumer interface.

setColorModel(ColorModel). Method in class java.awt.image.PixelGrabber

 The setColorModel method is part of the ImageConsumer API which  this class must implement to retrieve the pixels.

setColorModel(ColorModel). Method in class java.awt.image.RGBImageFilter

 If the ColorModel is an IndexColorModel, and the subclass has  set the canFilterIndexColorModel flag to true, we substitute  a filtered version of the color model here and wherever  that original ColorModel object appears in the setPixels methods.

setColumns(int). Method in class java.awt.GridLayout

 Sets the number of columns in this layout.

setColumns(int). Method in class java.awt.TextArea

 Sets the number of columns for this TextArea.

setColumns(int). Method in class java.awt.TextField

 Sets the number of columns in this TextField.

setComment(String). Method in class java.util.zip.ZipEntry

 Sets the optional comment string for the entry.

setComment(String). Method in class java.util.zip.ZipOutputStream

 Sets the ZIP file comment.

setConstrained(boolean). Method in class java.beans.PropertyDescriptor

 Attempted updates to "Constrained" properties will cause a "VetoableChange"  event to get fired when the property is changed.

setConstraints(Component, GridBagConstraints). Method in class java.awt. GridBagLayout

 Sets the constraints for the specified component.

setContentHandlerFactory(ContentHandlerFactory). Static method in class java.net.URLConnection

 Sets the ContentHandlerFactory of an  application.

setContents(Transferable, ClipboardOwner). Method in class java.awt.datatransfer.Clipboard

 Sets the current contents of the clipboard to the specified  transferable object and registers the specified clipboard owner  as the owner of the new contents.

setCrc(long). Method in class java.util.zip.ZipEntry

 Sets the CRC-32 checksum of the uncompressed entry data.

setCurrent(Checkbox). Method in class java.awt.CheckboxGroup

 setCurrentFrameIndex(int). Method in class sun.tools.debug.RemoteThread

 Set the current stackframe index

setCursor(Cursor). Method in class java.awt.Component

 Set the cursor image to a predefined cursor.

setCursor(Cursor). Method in interface java.awt.peer.ComponentPeer

 setCursor(int). Method in class java.awt.Frame

 setCursorName(String). Method in interface java.sql. Statement

 setCursorname defines the SQL cursor name that will be used by  subsequent Statement execute methods.

setDaemon(boolean). Method in class java.lang.Thread

 Marks this thread as either a daemon thread or a user thread.

setDaemon(boolean). Method in class java.lang.ThreadGroup

 Changes the daemon status of this thread group.

setData(byte[]). Method in class java.net.DatagramPacket

 setDate(int). Method in class java.util.Date

 Sets the day of the month of this date to the specified value.

setDate(int). Method in class java.sql.Time

 Sets the day of the month of this date to the specified value.

setDate(int, Date). Method in interface java.sql.PreparedStatement

 Set a parameter to a java.sql.Date value.

setDateFormatSymbols(DateFormatSymbols). Method in class java.text. SimpleDateFormat

 Allows you to set the date/time formatting data.

setDecimalFormatSymbols(DecimalFormatSymbols). Method in class java.text. DecimalFormat

 Sets the decimal format symbols, which is generally not changed  by the programmer or user.

setDecimalSeparator(char). Method in class java.text.DecimalFormatSymbols

 setDecimalSeparatorAlwaysShown(boolean). Method in class java.text.DecimalFormat

 Allows you to set the behavior of the decimal separator with integers.

setDecomposition(int). Method in class java.text.Collator

 Set the decomposition mode of this Collator.

setDefault(Locale). Static method in class java.util.Locale

 Sets the default.

setDefault(TimeZone). Static method in class java.util.TimeZone

 Sets time zone to using the given TimeZone.

setDefaultAllowUserInteraction(boolean). Static method in class java.net. URLConnection

 Sets the default value of the  allowUserInteraction field for all future  URLConnection objects to the specified value.

setDefaultRequestProperty(String, String). Static method in class java.net. URLConnection

 Sets the default value of a general request property.

setDefaultStream(PrintStream). Static method in class java.rmi.server.LogStream

 Set the default stream for new logs.

setDefaultUseCaches(boolean). Method in class java.net.URLConnection

 Sets the default value of the useCaches field to the  specified value.

setDesignTime(boolean). Static method in class java.beans.Beans

 Used to indicate whether of not we are running in an application  builder environment.

setDictionary(byte[]). Method in class java.util.zip.Deflater

 Sets preset dictionary for compression.

setDictionary(byte[]). Method in class java.util.zip.Inflater

 Sets the preset dictionary to the given array of bytes.

setDictionary(byte[], int, int). Method in class java.util.zip.Deflater

 Sets preset dictionary for compression.

setDictionary(byte[], int, int). Method in class java.util.zip.Inflater

 Sets the preset dictionary to the given array of bytes.

setDigit(char). Method in class java.text.DecimalFormatSymbols

 setDimensions(int, int). Method in class java.awt.image.CropImageFilter

 Override the source image's dimensions and pass the dimensions  of the rectangular cropped region to the ImageConsumer.

setDimensions(int, int). Method in interface java.awt.image.ImageConsumer

 The dimensions of the source image are reported using the  setDimensions method call.

setDimensions(int, int). Method in class java.awt.image.ImageFilter

 Filters the information provided in the setDimensions method  of the ImageConsumer interface.

setDimensions(int, int). Method in class java.awt.image.PixelGrabber

 The setDimensions method is part of the ImageConsumer API which  this class must implement to retrieve the pixels.

setDimensions(int, int). Method in class java.awt.image.ReplicateScaleFilter

 Override the dimensions of the source image and pass the dimensions  of the new scaled size to the ImageConsumer.

setDirectory(String). Method in class java.awt.FileDialog

 Set the directory of the Dialog to the specified directory.

setDirectory(String). Method in interface java.awt.peer.FileDialogPeer

 setDisplayName(String). Method in class java.beans. FeatureDescriptor

 setDoInput(boolean). Method in class java.net. URLConnection

 Sets the value of the doInput field for this  URLConnection  to the specified value.

setDoOutput(boolean). Method in class java.net.URLConnection

 Sets the value of the doOutput field for this  URLConnection  to the specified value.

setDouble(int, double). Method in interface java.sql.PreparedStatement

 Set a parameter to a Java double value.

setDouble(Object, double). Method in class java.lang.reflect.Field

 Set the value of a field as a double on specified object.

setDouble(Object, int, double). Static method in class java.lang.reflect.Array

 Sets the value of the indexed component of the specified array  object to the specified double value.

setEchoChar(char). Method in class java.awt.TextField

 Sets the echo character for this TextField.

setEchoChar(char). Method in interface java.awt.peer.TextFieldPeer

 setEchoCharacter(char). Method in class java.awt. TextField

 setEchoCharacter(char). Method in interface java.awt.peer.TextFieldPeer

 DEPRECATED: Replaced by setEchoChar(char echoChar).

setEditable(boolean). Method in class java.awt.TextComponent

 Sets the specified boolean to indicate whether or not this  TextComponent should be editable.

setEditable(boolean). Method in interface java.awt.peer.TextComponentPeer

 setEditorSearchPath(String[]). Static method in class java.beans.PropertyEditorManager

 Change the list of package names that will be used for 	finding property editors.

setElementAt(Object, int). Method in class java.util.Vector

 Sets the component at the specified index of this  vector to be the specified object.

setEnabled(boolean). Method in class java.awt.Component

 Enables a component.

setEnabled(boolean). Method in interface java.awt.peer.ComponentPeer

 setEnabled(boolean). Method in class java.awt. MenuItem

 Sets whether or not this menu item can be chosen.

setEnabled(boolean). Method in interface java.awt.peer.MenuItemPeer

 setEndRule(int, int, int, int). Method in class java.util.SimpleTimeZone

 Sets the daylight savings ending rule.

setEras(String[]). Method in class java.text.DateFormatSymbols

 Sets era strings.

setErr(PrintStream). Static method in class java.lang.System

 Reassigns the "standard" error output stream.

setError(). Method in class java.io.PrintStream

 Indicates that an error has occurred.

setError(). Method in class java.io.PrintWriter

 Indicate that an error has occurred.

setEscapeProcessing(boolean). Method in interface java.sql.Statement

 If escape scanning is on (the default), the driver will do  escape substitution before sending the SQL to the database.

setExpert(boolean). Method in class java.beans.FeatureDescriptor

 The "expert" flag is used to distinguish between features that are  intended for expert users from those that are intended for normal users.

setExtra(byte[]). Method in class java.util.zip.ZipEntry

 Sets the optional extra field data for the entry.

setFailureHandler(RMIFailureHandler). Static method in class java.rmi.server. RMISocketFactory

 Set the failure handler to be called by the RMI runtime if  socket creation fails.

setField(int, boolean). Method in class sun.tools.debug.RemoteObject

 Set a boolean instance variable, specified by slot.

setField(int, char). Method in class sun.tools.debug.RemoteObject

 Set a char instance variable, specified by slot.

setField(int, double). Method in class sun.tools.debug.RemoteObject

 Set a double instance variable, specified by slot.

setField(int, float). Method in class sun.tools.debug.RemoteObject

 Set a float instance variable, specified by slot.

setField(int, int). Method in class sun.tools.debug.RemoteObject

 Set an int instance variable, specified by slot.

setField(int, long). Method in class sun.tools.debug.RemoteObject

 Set a long instance variable, specified by slot.

setField(int, RemoteObject). Method in class sun.tools.debug.RemoteObject

 Set an object instance variable, specified by slot.

setField(String, boolean). Method in class sun.tools.debug.RemoteObject

 Set a boolean instance variable, specified by name.

setField(String, char). Method in class sun.tools.debug.RemoteObject

 Set a char instance variable, specified by name.

setField(String, double). Method in class sun.tools.debug.RemoteObject

 Set a double instance variable, specified by name.

setField(String, float). Method in class sun.tools.debug.RemoteObject

 Set a float instance variable, specified by name.

setField(String, int). Method in class sun.tools.debug.RemoteObject

 Set an int instance variable, specified by name.

setField(String, long). Method in class sun.tools.debug.RemoteObject

 Set a long instance variable, specified by name.

setField(String, RemoteObject). Method in class sun.tools.debug.RemoteObject

 Set an object instance variable, specified by name.

setFile(String). Method in class java.awt.FileDialog

 Sets the file for this dialog to the specified file.

setFile(String). Method in interface java.awt.peer.FileDialogPeer

 setFilenameFilter(FilenameFilter). Method in class java.awt.FileDialog

 Sets the filter for this dialog to the specified filter.

setFilenameFilter(FilenameFilter). Method in interface java.awt.peer. FileDialogPeer

 setFirstDayOfWeek(int). Method in class java.util. Calendar

 Sets what the first day of the week is; e.g., Sunday in US,  Monday in France.

setFloat(int, float). Method in interface java.sql.PreparedStatement

 Set a parameter to a Java float value.

setFloat(Object, float). Method in class java.lang.reflect.Field

 Set the value of a field as a float on specified object.

setFloat(Object, int, float). Static method in class java.lang.reflect.Array

 Sets the value of the indexed component of the specified array  object to the specified float value.

setFollowRedirects(boolean). Static method in class java.net.HttpURLConnection

 Sets whether HTTP redirects (requests with response code 3xx) should  be automatically followed by this class.

setFont(Font). Method in class java.awt.Component

 Sets the font of the component.

setFont(Font). Method in interface java.awt.peer.ComponentPeer

 setFont(Font). Method in class java.awt.Graphics

 Sets the font for all subsequent text rendering operations.

setFont(Font). Method in class java.awt.MenuComponent

 Sets the font to be used for this MenuItem to the specified font.

setForeground(Color). Method in class java.awt.Component

 Sets the foreground color.

setForeground(Color). Method in interface java.awt.peer.ComponentPeer

 setFormat(int, Format). Method in class java.text. MessageFormat

 Sets formats individually to use on parameters.

setFormats(Format[]). Method in class java.text.MessageFormat

 Sets formats to use on parameters.

setFullBufferUpdates(boolean). Method in class java.awt.image. MemoryImageSource

 Specify whether this animated memory image should always be  updated by sending the complete buffer of pixels whenever  there is a change.

setGregorianChange(Date). Method in class java.util.GregorianCalendar

 Sets the GregorianCalendar change date.

setGroupingSeparator(char). Method in class java.text.DecimalFormatSymbols

 setGroupingSize(int). Method in class java.text. DecimalFormat

 Set the grouping size.

setGroupingUsed(boolean). Method in class java.text.NumberFormat

 Set whether or not grouping will be used in this format.

setGuiAvailable(boolean). Static method in class java.beans.Beans

 Used to indicate whether of not we are running in an environment  where GUI interaction is available.

setHelpMenu(Menu). Method in class java.awt.MenuBar

 Sets the help menu to the specified menu on the menu bar.

setHgap(int). Method in class java.awt.BorderLayout

 Sets the horizontal gap between components.

setHgap(int). Method in class java.awt.CardLayout

 Sets the horizontal gap between components.

setHgap(int). Method in class java.awt.FlowLayout

 Sets the horizontal gap between components.

setHgap(int). Method in class java.awt.GridLayout

 Sets the horizontal gap between components.

setHidden(boolean). Method in class java.beans.FeatureDescriptor

 The "hidden" flag is used to identify features that are intended only  for tool use, and which should not be exposed to humans.

setHints(int). Method in class java.awt.image.AreaAveragingScaleFilter

 Detect if the data is being delivered with the necessary hints  to allow the averaging algorithm to do its work.

setHints(int). Method in interface java.awt.image.ImageConsumer

 The ImageProducer can deliver the pixels in any order, but  the ImageConsumer may be able to scale or convert the pixels  to the destination ColorModel more efficiently or with higher  quality if it knows some information about how the pixels will  be delivered up front.

setHints(int). Method in class java.awt.image.ImageFilter

 Filters the information provided in the setHints method  of the ImageConsumer interface.

setHints(int). Method in class java.awt.image.PixelGrabber

 The setHints method is part of the ImageConsumer API which  this class must implement to retrieve the pixels.

setHours(int). Method in class java.sql.Date

 Sets the hour of this date to the specified value.

setHours(int). Method in class java.util.Date

 Sets the hour of this date to the specified value.

setHumanPresentableName(String). Method in class java.awt.datatransfer. DataFlavor

 Sets the human presentable name for the data format that this  DataFlavor represents.

setIconImage(Image). Method in class java.awt.Frame

 Sets the image to display when this Frame is iconized.

setIconImage(Image). Method in interface java.awt.peer.FramePeer

 setID(String). Method in class java.util.TimeZone

 Sets the time zone ID.

setIfModifiedSince(long). Method in class java.net.URLConnection

 Sets the value of the ifModifiedSince field of  this URLConnection  to the specified value.

setIn(InputStream). Static method in class java.lang.System

 Reassigns the "standard" input stream.

setInDefaultEventSet(boolean). Method in class java.beans.EventSetDescriptor

 Mark an event set as being in the "default" set (or not).

setIndex(int). Method in interface java.text.CharacterIterator

 Set the position to the specified position in the text and return that  character.

setIndex(int). Method in class java.text.ParsePosition

 Set the current parse position.

setIndex(int). Method in class java.text.StringCharacterIterator

 Set the position to specified position in the text and return that  character.

setInfinity(String). Method in class java.text.DecimalFormatSymbols

 setInfo(String). Method in class java.security. Identity

 Specifies a general information string for this identity.

setInput(byte[]). Method in class java.util.zip.Deflater

 Sets input data for compression.

setInput(byte[]). Method in class java.util.zip.Inflater

 Sets input data for decompression.

setInput(byte[], int, int). Method in class java.util.zip.Deflater

 Sets input data for compression.

setInput(byte[], int, int). Method in class java.util.zip.Inflater

 Sets input data for decompression.

setInt(int, int). Method in interface java.sql.PreparedStatement

 Set a parameter to a Java int value.

setInt(Object, int). Method in class java.lang.reflect.Field

 Set the value of a field as an int on specified object.

setInt(Object, int, int). Static method in class java.lang.reflect.Array

 Sets the value of the indexed component of the specified array  object to the specified int value.

setInterface(InetAddress). Method in class java.net.MulticastSocket

 Set the outgoing network interface for multicast packets on this  socket, to other than the system default.

setKeyChar(char). Method in class java.awt.event.KeyEvent

 setKeyCode(int). Method in class java.awt.event. KeyEvent

 setKeyPair(KeyPair). Method in class java.security. Signer

 Sets the key pair (public key and private key) for this signer.

setLabel(String). Method in class java.awt.Button

 Sets the button with the specified label.

setLabel(String). Method in interface java.awt.peer.ButtonPeer

 setLabel(String). Method in class java.awt.Checkbox

 Sets this check box's label to be the specified string.

setLabel(String). Method in interface java.awt.peer.CheckboxPeer

 setLabel(String). Method in class java.awt.MenuItem

 Sets the label to be the specified label.

setLabel(String). Method in interface java.awt.peer.MenuItemPeer

 setLayout(LayoutManager). Method in class java.awt. Container

 Sets the layout manager for this container.

setLayout(LayoutManager). Method in class java.awt.ScrollPane

 Sets the layout manager for this container.

setLength(int). Method in class java.net.DatagramPacket

 setLength(int). Method in class java.lang. StringBuffer

 Sets the length of this String buffer.

setLenient(boolean). Method in class java.util.Calendar

 Specify whether or not date/time interpretation is to be lenient.

setLenient(boolean). Method in class java.text.DateFormat

 Specify whether or not date/time parsing is to be lenient.

setLevel(int). Method in class java.util.zip.Deflater

 Sets the current compression level to the specified value.

setLevel(int). Method in class java.util.zip.ZipOutputStream

 Sets the compression level for subsequent entries which are DEFLATED.

setLineIncrement(int). Method in class java.awt.Scrollbar

 setLineIncrement(int). Method in interface java.awt.peer.ScrollbarPeer

 setLineNumber(int). Method in class java.io. LineNumberInputStream

 Sets the line number to the specified argument.

setLineNumber(int). Method in class java.io.LineNumberReader

 Set the current line number.

setLocale(Locale). Method in class java.awt.Component

 Sets the locale of the component.

setLocale(Locale). Method in class java.text.MessageFormat

 Constructs with the specified pattern and formats for the  arguments in that pattern.

setLocalPatternChars(String). Method in class java.text.DateFormatSymbols

 Sets localized date-time pattern characters.

setLocation(int, int). Method in class java.awt.Component

 Moves the Component to a new location.

setLocation(int, int). Method in class java.awt.Point

 Changes the point to have the specificed location.

setLocation(int, int). Method in class java.awt.Rectangle

 Moves the rectangle to have the specificed location.

setLocation(Point). Method in class java.awt.Component

 Moves the Component to a new location.

setLocation(Point). Method in class java.awt.Point

 Changes the point to have the specificed location.

setLocation(Point). Method in class java.awt.Rectangle

 Moves the rectangle to have the specificed location.

setLog(OutputStream). Static method in class java.rmi.server.RemoteServer

 Log RMI calls to the output stream out.

setLoginTimeout(int). Static method in class java.sql.DriverManager

 Set the maximum time in seconds that all drivers can wait  when attempting to log in to a database.

setLogStream(PrintStream). Static method in class java.sql.DriverManager

 Set the logging/tracing PrintStream that is used by the DriverManager  and all drivers.

setLong(int, long). Method in interface java.sql.PreparedStatement

 Set a parameter to a Java long value.

setLong(Object, int, long). Static method in class java.lang.reflect.Array

 Sets the value of the indexed component of the specified array  object to the specified long value.

setLong(Object, long). Method in class java.lang.reflect.Field

 Set the value of a field as a long on specified object.

setMaxFieldSize(int). Method in interface java.sql.Statement

 The maxFieldSize limit (in bytes) is set to limit the size of  data that can be returned for any column value; it only applies  to BINARY, VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and  LONGVARCHAR fields.

setMaximum(int). Method in interface java.awt.Adjustable

 Sets the maximum value of the adjustable object.

setMaximum(int). Method in class java.awt.Scrollbar

 Sets the maximum value for this Scrollbar.

setMaximumFractionDigits(int). Method in class java.text.NumberFormat

 Sets the maximum number of digits allowed in the fraction portion of a  number.

setMaximumIntegerDigits(int). Method in class java.text.NumberFormat

 Sets the maximum number of digits allowed in the integer portion of a  number.

setMaxPriority(int). Method in class java.lang.ThreadGroup

 Sets the maximum priority of the group.

setMaxRows(int). Method in interface java.sql.Statement

 The maxRows limit is set to limit the number of rows that any  ResultSet can contain.

setMenuBar(MenuBar). Method in class java.awt.Frame

 Sets the menubar for this Frame to the specified menubar.

setMenuBar(MenuBar). Method in interface java.awt.peer.FramePeer

 setMessageDigest(MessageDigest). Method in class java.security.DigestInputStream

 Associates the specified message digest with this stream.

setMessageDigest(MessageDigest). Method in class java.security. DigestOutputStream

 Associates the specified message digest with this stream.

setMethod(int). Method in class java.util.zip.ZipEntry

 Sets the compression method for the entry.

setMethod(int). Method in class java.util.zip.ZipOutputStream

 Sets the default compression method for subsequent entries.

setMinimalDaysInFirstWeek(int). Method in class java.util.Calendar

 Sets what the minimal days required in the first week of the year are;  For example, if the first week is defined as one that contains the first  day of the first month of a year, call the method with value 1.

setMinimum(int). Method in interface java.awt.Adjustable

 Sets the minimum value of the adjustable object.

setMinimum(int). Method in class java.awt.Scrollbar

 Sets the minimum value for this Scrollbar.

setMinimumFractionDigits(int). Method in class java.text.NumberFormat

 Sets the minimum number of digits allowed in the fraction portion of a  number.

setMinimumIntegerDigits(int). Method in class java.text.NumberFormat

 Sets the minimum number of digits allowed in the integer portion of a  number.

setMinusSign(char). Method in class java.text.DecimalFormatSymbols

 setMinutes(int). Method in class java.sql.Date

 Sets the minutes of this date to the specified value.

setMinutes(int). Method in class java.util.Date

 Sets the minutes of this date to the specified value.

setModal(boolean). Method in class java.awt.Dialog

 Specifies whether this Dialog is modal.

setMode(int). Method in class java.awt.FileDialog

 Sets the mode of the file dialog.

setModifiers(int). Method in class java.awt.event.KeyEvent

 setMonth(int). Method in class java.util.Date

 Sets the month of this date to the specified value.

setMonth(int). Method in class java.sql.Time

 Sets the month of this date to the specified value.

setMonths(String[]). Method in class java.text.DateFormatSymbols

 Sets month strings.

setMultipleMode(boolean). Method in class java.awt.List

 Sets whether this list should allow multiple selections or not.

setMultipleMode(boolean). Method in interface java.awt.peer.ListPeer

 setMultipleSelections(boolean). Method in class java.awt.List

 setMultipleSelections(boolean). Method in interface java.awt.peer.ListPeer

 DEPRECATED: Replaced by setMultipleMode(boolean).

setMultiplier(int). Method in class java.text.DecimalFormat

 Set the multiplier for use in percent, permill, etc.

setName(Principal, String). Method in interface java.security.acl.Acl

 Sets the name of this ACL.

setName(String). Method in class java.awt.Component

 Sets the name of the component to the specified string.

setName(String). Method in class java.beans.FeatureDescriptor

 setName(String). Method in class java.awt. MenuComponent

 Sets the name of the component to the specified string.

setName(String). Method in class java.lang.Thread

 Changes the name of this thread to be equal to the argument  name.

setNaN(String). Method in class java.text.DecimalFormatSymbols

 setNanos(int). Method in class java.sql.Timestamp

 Set the Timestamp's nanos value

setNegativePermissions(). Method in interface java.security.acl.AclEntry

 Sets this ACL entry to be a negative one.

setNegativePrefix(String). Method in class java.text.DecimalFormat

 Set the negative prefix.

setNegativeSuffix(String). Method in class java.text.DecimalFormat

 Set the positive suffix.

setNextException(SQLException). Method in class java.sql.SQLException

 Add an SQLException to the end of the chain.

setNextWarning(SQLWarning). Method in class java.sql.SQLWarning

 Add an SQLWarning to the end of the chain.

setNull(int, int). Method in interface java.sql.PreparedStatement

 Set a parameter to SQL NULL.

setNumberFormat(NumberFormat). Method in class java.text.DateFormat

 Allows you to set the number formatter.

setObject(int, Object). Method in interface java.sql.PreparedStatement

Set the value of a parameter using an object; use the  java.lang equivalent objects for integral values.

setObject(int, Object, int). Method in interface java.sql.PreparedStatement

 This method is like setObject above, but assumes a scale of zero.

setObject(int, Object, int, int). Method in interface java.sql. PreparedStatement

Set the value of a parameter using an object; use the  java.lang equivalent objects for integral values.

setObject(Object). Method in interface java.beans.Customizer

 Set the object to be customized.

setOrientation(int). Method in class java.awt.Scrollbar

 Sets the orientation for this Scrollbar.

setOut(PrintStream). Static method in class java.lang.System

 Reassigns the "standard" output stream.

setOutputStream(OutputStream). Method in class java.rmi.server.LogStream

 Set the stream to which output from this log is sent.

setPageIncrement(int). Method in class java.awt.Scrollbar

 setPageIncrement(int). Method in interface java.awt.peer.ScrollbarPeer

 setPaintMode(). Method in class java.awt.Graphics

 Sets the logical pixel operation function to the Paint, or  overwrite mode.

setParameter(String, Object). Method in class java.security.Signature

 Sets the specified algorithm parameter to the specified value.

setParent(ResourceBundle). Method in class java.util.ResourceBundle

 Set the parent bundle of this bundle.

setParseIntegerOnly(boolean). Method in class java.text.NumberFormat

 Sets whether or not numbers should be parsed as integers only.

setPatternSeparator(char). Method in class java.text.DecimalFormatSymbols

 setPercent(char). Method in class java.text. DecimalFormatSymbols

 setPerMill(char). Method in class java.text. DecimalFormatSymbols

 setPixels (int, int, int, int, ColorModel, byte[], int, int). Method in class java.awt.image. AreaAveragingScaleFilter

 Combine the components for the delivered byte pixels into the  accumulation arrays and send on any averaged data for rows of  pixels that are complete.

setPixels(int, int, int, int, ColorModel, byte[], int, int). Method in class java.awt.image.CropImageFilter

 Determine whether the delivered byte pixels intersect the region to  be extracted and passes through only that subset of pixels that  appear in the output region.

setPixels(int, int, int, int, ColorModel, byte[], int, int). Method in interface java.awt.image.ImageConsumer

 The pixels of the image are delivered using one or more calls  to the setPixels method.

setPixels(int, int, int, int, ColorModel, byte[], int, int). Method in class java.awt.image.ImageFilter

 Filters the information provided in the setPixels method of the  ImageConsumer interface which takes an array of bytes.

setPixels(int, int, int, int, ColorModel, byte[], int, int). Method in class java.awt.image.PixelGrabber

 The setPixels method is part of the ImageConsumer API which  this class must implement to retrieve the pixels.

setPixels(int, int, int, int, ColorModel, byte[], int, int). Method in class java.awt.image.ReplicateScaleFilter

 Choose which rows and columns of the delivered byte pixels are  needed for the destination scaled image and pass through just  those rows and columns that are needed, replicated as necessary.

setPixels(int, int, int, int, ColorModel, byte[], int, int). Method in class java.awt.image.RGBImageFilter

 If the ColorModel object is the same one that has already  been converted, then simply passes the pixels through with the  converted ColorModel.

setPixels(int, int, int, int, ColorModel, int[], int, int). Method in class java.awt.image.AreaAveragingScaleFilter

 Combine the components for the delivered int pixels into the  accumulation arrays and send on any averaged data for rows of  pixels that are complete.

setPixels(int, int, int, int, ColorModel, int[], int, int). Method in class java.awt.image.CropImageFilter

 Determine if the delivered int pixels intersect the region to  be extracted and pass through only that subset of pixels that  appear in the output region.

setPixels(int, int, int, int, ColorModel, int[], int, int). Method in interface java.awt.image.ImageConsumer

 The pixels of the image are delivered using one or more calls  to the setPixels method.

setPixels(int, int, int, int, ColorModel, int[], int, int). Method in class java.awt.image.ImageFilter

 Filters the information provided in the setPixels method of the  ImageConsumer interface which takes an array of integers.

setPixels(int, int, int, int, ColorModel, int[], int, int). Method in class java.awt.image.PixelGrabber

 The setPixels method is part of the ImageConsumer API which  this class must implement to retrieve the pixels.

setPixels(int, int, int, int, ColorModel, int[], int, int). Method in class java.awt.image.ReplicateScaleFilter

 Choose which rows and columns of the delivered int pixels are  needed for the destination scaled image and pass through just  those rows and columns that are needed, replicated as necessary.

setPixels(int, int, int, int, ColorModel, int[], int, int). Method in class java.awt.image.RGBImageFilter

 If the ColorModel object is the same one that has already  been converted, then simply passes the pixels through with the  converted ColorModel, otherwise converts the buffer of integer  pixels to the default RGB ColorModel and passes the converted  buffer to the filterRGBPixels method to be converted one by one.

setPort(int). Method in class java.net.DatagramPacket

 setPositivePrefix(String). Method in class java.text.DecimalFormat

 Set the positive prefix.

setPositiveSuffix(String). Method in class java.text.DecimalFormat

 Set the positive suffix.

setPrincipal(Principal). Method in interface java.security.acl.AclEntry

 Specifies the principal for which permissions are granted or denied  by this ACL entry.

setPriority(int). Method in class java.lang.Thread

 Changes the priority of this thread.

setPropagationId(Object). Method in class java.beans.PropertyChangeEvent

 setProperties(Hashtable). Method in class java.awt.image.CropImageFilter

 Passes along the properties from the source object after adding a  property indicating the cropped region.

setProperties(Hashtable). Method in interface java.awt.image.ImageConsumer

 Sets the extensible list of properties associated with this image.

setProperties(Hashtable). Method in class java.awt.image.ImageFilter

 Passes the properties from the source object along after adding a  property indicating the stream of filters it has been run through.

setProperties(Hashtable). Method in class java.awt.image.PixelGrabber

 The setProperties method is part of the ImageConsumer API which  this class must implement to retrieve the pixels.

setProperties(Hashtable). Method in class java.awt.image.ReplicateScaleFilter

 Passes along the properties from the source object after adding a  property indicating the scale applied.

setProperties(Properties). Static method in class java.lang.System

 Sets the system properties to the Properties  argument.

setProperty(String, String). Static method in class java.security.Security

 Sets a security property.

setPropertyEditorClass(Class). Method in class java.beans.PropertyDescriptor

 Normally PropertyEditors will be found using the PropertyEditorManager.

setPublicKey(PublicKey). Method in class java.security.Identity

 Sets this identity's public key.

setQueryTimeout(int). Method in interface java.sql.Statement

 The queryTimeout limit is the number of seconds the driver will  wait for a Statement to execute.

setRawOffset(int). Method in class java.util.SimpleTimeZone

 Overrides TimeZone  Sets the base time zone offset to GMT.

setRawOffset(int). Method in class java.util.TimeZone

 Sets the base time zone offset to GMT.

setReadOnly(boolean). Method in interface java.sql.Connection

 You can put a connection in read-only mode as a hint to enable  database optimizations.

setRef(RemoteStub, RemoteRef). Static method in class java.rmi.server. RemoteStub

 setRequestMethod(String). Method in class java.net. HttpURLConnection

 Set the method for the URL request, one of:

• GET

• POST

• HEAD

• OPTIONS

• PUT

• DELETE

• TRACE

 are legal, subject to protocol restrictions.

setRequestProperty(String, String). Method in class java.net.URLConnection

 Sets the general request property.

setResizable(boolean). Method in class java.awt.Dialog

 Sets the resizable flag.

setResizable(boolean). Method in interface java.awt.peer.DialogPeer

 setResizable(boolean). Method in class java.awt. Frame

 Sets the resizable flag.

setResizable(boolean). Method in interface java.awt.peer.FramePeer

 setRows(int). Method in class java.awt.GridLayout

 Sets the number of rows in this layout.

setRows(int). Method in class java.awt.TextArea

 Sets the number of rows for this TextArea.

setScale(int). Method in class java.math.BigDecimal

 Returns a BigDecimal whose scale is the specified value, and whose  value is exactly equal to this number's.

setScale(int, int). Method in class java.math.BigDecimal

 Returns a BigDecimal whose scale is the specified value, and whose  integer value is determined by multiplying or dividing this BigDecimal's  integer value by the appropriate power of ten to maintain the overall  value.

setScrollPosition(int, int). Method in class java.awt.ScrollPane

 Scrolls to the specified position within the child component.

setScrollPosition(int, int). Method in interface java.awt.peer.ScrollPanePeer

 setScrollPosition(Point). Method in class java.awt. ScrollPane

 Scrolls to the specified position within the child component.

setSeconds(int). Method in class java.sql.Date

 Sets the seconds of this date to the specified value.

setSeconds(int). Method in class java.util.Date

 Sets the seconds of this date to the specified value.

setSecurityManager(SecurityManager). Static method in class java.lang.System

 Sets the System security.

setSeed(byte[]). Method in class java.security.SecureRandom

 Reseeds this random object.

setSeed(long). Method in class java.util.Random

 Sets the seed of this random number generator using a single  long seed.

setSeed(long). Method in class java.security.SecureRandom

 Reseeds this random object, using the eight bytes contained  in the given long seed.

setSelectedCheckbox(Checkbox). Method in class java.awt.CheckboxGroup

 Sets the current choice to the specified Checkbox.

setSelectionEnd(int). Method in class java.awt.TextComponent

 Sets the selection end to the specified position.

setSelectionStart(int). Method in class java.awt.TextComponent

 Sets the selection start to the specified position.

setShort(int, short). Method in interface java.sql.PreparedStatement

 Set a parameter to a Java short value.

setShort(Object, int, short). Static method in class java.lang.reflect.Array

 Sets the value of the indexed component of the specified array  object to the specified short value.

setShort(Object, short). Method in class java.lang.reflect.Field

 Set the value of a field as a short on specified object.

setShortcut(MenuShortcut). Method in class java.awt.MenuItem

 Set this MenuItem's MenuShortcut.

setShortDescription(String). Method in class java.beans.FeatureDescriptor

 You can associate a short descriptive string with a feature.

setShortMonths(String[]). Method in class java.text.DateFormatSymbols

 Sets short month strings.

setShortWeekdays(String[]). Method in class java.text.DateFormatSymbols

 Sets short weekday strings.

setSigners(Class, Object[]). Method in class java.lang.ClassLoader

 Sets the signers of a class.

setSize(Dimension). Method in class java.awt.Component

 Resizes the Component to the specified dimension.

setSize(Dimension). Method in class java.awt.Dimension

 Set the size of this Dimension object to match the specified size.

setSize(Dimension). Method in class java.awt.Rectangle

 Set the size of this rectangle to match the specified size.

setSize(int). Method in class java.util.Vector

 Sets the size of this vector.

setSize(int, int). Method in class java.awt.Component

 Resizes the Component to the specified width and height.

setSize(int, int). Method in class java.awt.Dimension

 Set the size of this Dimension object to the specified width  and height.

setSize(int, int). Method in class java.awt.Rectangle

 Set the size of this rectangle to the specified width and height.

setSize(long). Method in class java.util.zip.ZipEntry

 Sets the uncompressed size of the entry data.

setSocketFactory(RMISocketFactory). Static method in class java.rmi.server. RMISocketFactory

 Set the socket factory from which RMI gets sockets.

setSocketFactory(SocketImplFactory). Static method in class java.net. ServerSocket

 Sets the server socket implementation factory for the  application.

setSocketImplFactory(SocketImplFactory). Static method in class java.net. Socket

 Sets the client socket implementation factory for the  application.

setSoLinger(boolean, int). Method in class java.net.Socket

 Enable/disable SO_LINGER with the specified linger time.

setSoTimeout(int). Method in class java.net.DatagramSocket

 Enable/disable SO_TIMEOUT with the specified timeout, in  milliseconds.

setSoTimeout(int). Method in class java.net.ServerSocket

 Enable/disable SO_TIMEOUT with the specified timeout, in  milliseconds.

setSoTimeout(int). Method in class java.net.Socket

 Enable/disable SO_TIMEOUT with the specified timeout, in  milliseconds.

setSourcePath(String). Method in class sun.tools.debug.RemoteDebugger

 Specify the list of paths to use when searching for a source file.

setStartRule(int, int, int, int). Method in class java.util.SimpleTimeZone

 Sets the daylight savings starting rule.

setStartYear(int). Method in class java.util.SimpleTimeZone

 Sets the daylight savings starting year.

setState(boolean). Method in class java.awt.Checkbox

 Sets the Checkbox to the specifed boolean state.

setState(boolean). Method in class java.awt.CheckboxMenuItem

 Sets the state of this MenuItem if it is a Checkbox.

setState(boolean). Method in interface java.awt.peer.CheckboxMenuItemPeer

 setState(boolean). Method in interface java.awt.peer. CheckboxPeer

 setStrategy(int). Method in class java.util.zip. Deflater

 Sets the compression strategy to the specified value.

setStrength(int). Method in class java.text.Collator

 Sets this Collator's strength property.

setString(int, String). Method in interface java.sql.PreparedStatement

 Set a parameter to a Java String value.

setStub(AppletStub). Method in class java.applet.Applet

 Sets this applet's stub.

setSystemScope(IdentityScope). Static method in class java.security. IdentityScope

 Sets the system's identity scope.

setTcpNoDelay(boolean). Method in class java.net.Socket

 Enable/disable TCP_NODELAY (disable/enable Nagle's algorithm).

setText(CharacterIterator). Method in class java.text.BreakIterator

 Set a new text for scanning.

setText(String). Method in class java.text.BreakIterator

 Set a new text string to be scanned.

setText(String). Method in class java.awt.Label

 Sets the text for this label to the specified text.

setText(String). Method in interface java.awt.peer.LabelPeer

 setText(String). Method in class java.awt. TextComponent

 Sets the text of this TextComponent to the specified text.

setText(String). Method in interface java.awt.peer.TextComponentPeer

 setTime(Date). Method in class java.util.Calendar

 Sets this Calendar's current time with the given Date.

setTime(int, Time). Method in interface java.sql.PreparedStatement

 Set a parameter to a java.sql.Time value.

setTime(long). Method in class java.sql.Date

 Set a Date using a milliseconds time value

setTime(long). Method in class java.util.Date

 Sets this date to represent the specified number of milliseconds  since January 1, 1970 00:00:00 GMT.

setTime(long). Method in class java.sql.Time

 Set a Time using a milliseconds time value

setTime(long). Method in class java.util.zip.ZipEntry

 Sets the modification time of the entry.

setTimeInMillis(long). Method in class java.util.Calendar

 Sets this Calendar's current time from the given long value.

setTimestamp(int, Timestamp). Method in interface java.sql.PreparedStatement

 Set a parameter to a java.sql.Timestamp value.

setTimeZone(TimeZone). Method in class java.util.Calendar

 Sets the time zone with the given time zone value.

setTimeZone(TimeZone). Method in class java.text.DateFormat

 Sets the time zone for the calendar of this DateFormat object.

setTitle(String). Method in class java.awt.Dialog

 Sets the title of the Dialog.

setTitle(String). Method in interface java.awt.peer.DialogPeer

 setTitle(String). Method in class java.awt.Frame

 Sets the title for this Frame to the specified title.

setTitle(String). Method in interface java.awt.peer.FramePeer

 setTransactionIsolation(int). Method in interface java.sql.Connection

 You can call this method to try to change the transaction  isolation level using one of the TRANSACTION_* values.

setTTL(byte). Method in class java.net.DatagramSocketImpl

 Set the TTL (time-to-live) option.

setTTL(byte). Method in class java.net.MulticastSocket

 Set the default time-to-live for multicast packets sent out  on this socket.

setUnicast(boolean). Method in class java.beans.EventSetDescriptor

 Mark an event set as unicast (or not).

setUnicodeStream(int, InputStream, int). Method in interface java.sql. PreparedStatement

 When a very large UNICODE value is input to a LONGVARCHAR  parameter, it may be more practical to send it via a  java.io.InputStream.

setUnitIncrement(Adjustable, int). Method in interface java.awt.peer. ScrollPanePeer

 setUnitIncrement(int). Method in interface java.awt. Adjustable

 Sets the unit value increment for the adjustable object.

setUnitIncrement(int). Method in class java.awt.Scrollbar

 Sets the unit increment for this scrollbar.

setUpdateRect(Rectangle). Method in class java.awt.event.PaintEvent

 Sets the rectangle representing the area which needs to be  repainted in response to this event.

setURL(URL, String, String, int, String, String). Method in class java.net. URLStreamHandler

 Sets the fields of the URL argument to the indicated values.

setURLStreamHandlerFactory(URLStreamHandlerFactory). Static method in class java.net.URL

 Sets an application's URLStreamHandlerFactory.

setUseCaches(boolean). Method in class java.net.URLConnection

 Sets the value of the useCaches field of this  URLConnection  to the specified value.

setValue(Adjustable, int). Method in interface java.awt.peer.ScrollPanePeer

 setValue(int). Method in interface java.awt. Adjustable

 Sets the current value of the adjustable object.

setValue(int). Method in class java.awt.Scrollbar

 Sets the value of this Scrollbar to the specified value.

setValue(Object). Method in interface java.beans.PropertyEditor

 Set (or change) the object that is to be edited.

setValue(Object). Method in class java.beans.PropertyEditorSupport

 Set (or change) the object that is to be edited.

setValue(String, Object). Method in class java.beans.FeatureDescriptor

 Associate a named attribute with this feature.

setValues(int, int, int, int). Method in class java.awt.Scrollbar

 Sets the values for this Scrollbar.

setValues(int, int, int, int). Method in interface java.awt.peer.ScrollbarPeer

 setVgap(int). Method in class java.awt.BorderLayout

 Sets the vertical gap between components.

setVgap(int). Method in class java.awt.CardLayout

 Sets the vertical gap between components.

setVgap(int). Method in class java.awt.FlowLayout

 Sets the vertical gap between components.

setVgap(int). Method in class java.awt.GridLayout

 Sets the vertical gap between components.

setVisible(boolean). Method in class java.awt.Component

 Shows or hides the component depending on the boolean flag b.

setVisible(boolean). Method in interface java.awt.peer.ComponentPeer

 setVisibleAmount(int). Method in interface java.awt. Adjustable

 Sets the length of the proportionl indicator of the  adjustable object.

setVisibleAmount(int). Method in class java.awt.Scrollbar

 Sets the visible amount of this Scrollbar, which is the range  of values represented by the width of the scroll bar's bubble.

setWeekdays(String[]). Method in class java.text.DateFormatSymbols

 Sets weekday strings.

setXORMode(Color). Method in class java.awt.Graphics

 Sets the logical pixel operation function to the XOR mode,  which alternates pixels between the current color and a new  specified XOR alternation color.

setYear(int). Method in class java.util.Date

 Sets the year of this date to be the specified value plus 1900.

setYear(int). Method in class java.sql.Time

 Sets the year of this date to be the specified value plus 1900.

setZeroDigit(char). Method in class java.text.DecimalFormatSymbols

 setZoneStrings(String[][]). Method in class java.text.DateFormatSymbols

 Sets timezone strings.

SHIFT_MASK. Static variable in class java.awt.event.ActionEvent

 The shift modifier constant.

SHIFT_MASK. Static variable in class java.awt.Event

 The shift modifier constant.

SHIFT_MASK. Static variable in class java.awt.event.InputEvent

 The shift key modifier constant.

shiftDown(). Method in class java.awt.Event

 Checks if the shift key is down.

shiftLeft(int). Method in class java.math.BigInteger

 Returns a BigInteger whose value is (this  shiftRight(int). Method in class java.math.BigInteger

 Returns a BigInteger whose value is (this >> n).

SHORT. Static variable in class java.text.DateFormat

 Constant for short style pattern.

Short(short). Constructor for class java.lang.Short

 Constructs a Short object initialized to the specified short value.

Short(String). Constructor for class java.lang.Short

 Constructs a Short object initialized to the value specified by the  String parameter.

shortcuts(). Method in class java.awt.MenuBar

 Get an Enumeration of all MenuShortcuts this MenuBar manages.

shortValue(). Method in class java.lang.Byte

 Returns the value of this Byte as a short.

shortValue(). Method in class java.lang.Double

 Returns the value of this Double as a short (by casting to a short).

shortValue(). Method in class java.lang.Float

 Returns the value of this Float as a short (by casting to a short).

shortValue(). Method in class java.lang.Integer

 Returns the value of this Integer as a short.

shortValue(). Method in class java.lang.Long

 Returns the value of this Long as a short.

shortValue(). Method in class java.lang.Number

 Returns the value of the specified number as a short.

shortValue(). Method in class java.lang.Short

 Returns the value of this Short as a short.

show(). Method in class java.awt.Component

 show(). Method in interface java.awt.peer. ComponentPeer

 DEPRECATED: Replaced by setVisible(boolean).

show(). Method in class java.awt.Dialog

 Shows the dialog.

show(). Method in class java.awt.Window

 Shows the Window.

show(boolean). Method in class java.awt.Component

 show(Component, int, int). Method in class java.awt. PopupMenu

 Shows the popup menu at the x, y position relative to an origin component.

show(Container, String). Method in class java.awt.CardLayout

 Flips to the specified component name in the specified container.

show(Event). Method in interface java.awt.peer.PopupMenuPeer

 showDocument(URL). Method in interface java.applet. AppletContext

 Replaces the Web page currently being viewed with the given URL.

showDocument(URL, String). Method in interface java.applet.AppletContext

 Requests that the browser or applet viewer show the Web page  indicated by the url  argument.

showStatus(String). Method in class java.applet.Applet

 Requests that the argument string be displayed in the  "status window".

showStatus(String). Method in interface java.applet.AppletContext

 Requests that the argument string be displayed in the  "status window".

SIGN. Static variable in class java.security.Signature

 Possible state  value, signifying that  this signature object has been initialized for signing.

sign(). Method in class java.security.Signature

 Returns the signature bytes of all the data updated.

Signature(String). Constructor for class java.security.Signature

 Creates a Signature object for the specified algorithm.

SignatureException(). Constructor for class java.security.SignatureException

 Constructs a SignatureException with no detail message.

SignatureException(String). Constructor for class java.security. SignatureException

 Constructs a SignatureException with the specified detail  message.

Signer(). Constructor for class java.security.Signer

 Creates a signer.

Signer(String). Constructor for class java.security.Signer

 Creates a signer with the specified identity name.

Signer(String, IdentityScope). Constructor for class java.security.Signer

 Creates a signer with the specified identity name and scope.

signum(). Method in class java.math.BigDecimal

 Returns the signum function of this number (i.e., -1, 0 or 1 as  the value of this number is negative, zero or positive).

signum(). Method in class java.math.BigInteger

 Returns the signum function of this number (i.e., -1, 0 or 1 as  the value of this number is negative, zero or positive).

SILENT. Static variable in class java.rmi.server.LogStream

 constants for logging levels

SimpleBeanInfo(). Constructor for class java.beans.SimpleBeanInfo

 SimpleDateFormat(). Constructor for class java.text. SimpleDateFormat

 Construct a SimpleDateFormat using the default pattern for the default  locale.

SimpleDateFormat(String). Constructor for class java.text.SimpleDateFormat

 Construct a SimpleDateFormat using the given pattern in the default  locale.

SimpleDateFormat(String, DateFormatSymbols). Constructor for class java.text. SimpleDateFormat

 Construct a SimpleDateFormat using the given pattern and  locale-specific symbol data.

SimpleDateFormat(String, Locale). Constructor for class java.text. SimpleDateFormat

 Construct a SimpleDateFormat using the given pattern and locale.

SimpleTimeZone(int, String). Constructor for class java.util.SimpleTimeZone

 Constructs a SimpleTimeZone with the given base time zone offset  from GMT and time zone ID.

SimpleTimeZone(int, String, int, int, int, int, int, int, int, int). Constructor for class java.util.SimpleTimeZone

 Constructs a SimpleTimeZone with the given base time zone offset  from GMT, time zone ID, time to start and end the daylight time.

SIMPLIFIED_CHINESE. Static variable in class java.util.Locale

 Useful constant for language.

sin(double). Static method in class java.lang.Math

 Returns the trigonometric sine of an angle.

SINGLEFRAME. Static variable in interface java.awt.image.ImageConsumer

 The image contain a single static image.

SINGLEFRAMEDONE. Static variable in interface java.awt.image.ImageConsumer

 One frame of the image is complete but there are more frames  to be delivered.

SINGLEPASS. Static variable in interface java.awt.image.ImageConsumer

 The pixels will be delivered in a single pass.

size. Variable in class java.awt.Font

 The point size of this font.

size(). Method in class java.util.BitSet

 Returns the number of bits currently in this bit set.

size(). Method in class java.io.ByteArrayOutputStream

 Returns the current size of the buffer.

size(). Method in class java.io.CharArrayWriter

 Returns the current size of the buffer.

size(). Method in class java.awt.Component

 size(). Method in class java.io.DataOutputStream

 Returns the number of bytes written to this data output stream.

size(). Method in class java.util.Dictionary

 Returns the number of keys in this dictionary.

size(). Method in class java.util.Hashtable

 Returns the number of keys in this hashtable.

size(). Method in class java.security.IdentityScope

 Returns the number of identities within this identity scope.

size(). Method in class java.util.Vector

 Returns the number of components in this vector.

SkeletonMismatchException(String). Constructor for class java.rmi.server. SkeletonMismatchException

 Create a new SkeletonMismatchException exception with a descriptive string.

SkeletonNotFoundException(String). Constructor for class java.rmi.server. SkeletonNotFoundException

 Create a new SkeletonNotFoundException exception with a descriptive string.

SkeletonNotFoundException(String, Exception). Constructor for class java.rmi.server.SkeletonNotFoundException

 Create a new SkeletonNotFoundException with a descriptive string and an exception.

skip(long). Method in class java.io.BufferedInputStream

 Skips over and discards n bytes of data from the  input stream.

skip(long). Method in class java.io.BufferedReader

 Skip characters.

skip(long). Method in class java.io.ByteArrayInputStream

 Skips n bytes of input from this input stream.

skip(long). Method in class java.io.CharArrayReader

 Skip characters.

skip(long). Method in class java.util.zip.CheckedInputStream

 Skips specified number of bytes of input.

skip(long). Method in class java.io.FileInputStream

 Skips over and discards n bytes of data from the  input stream.

skip(long). Method in class java.io.FilterInputStream

 Skips over and discards n bytes of data from the  input stream.

skip(long). Method in class java.io.FilterReader

 Skip characters.

skip(long). Method in class java.util.zip.InflaterInputStream

 Skips specified number of bytes of uncompressed data.

skip(long). Method in class java.io.InputStream

 Skips over and discards n bytes of data from this  input stream.

skip(long). Method in class java.io.LineNumberInputStream

 Skips over and discards n bytes of data from the  input stream.

skip(long). Method in class java.io.LineNumberReader

 Skip characters.

skip(long). Method in interface java.io.ObjectInput

 Skips n bytes of input.

skip(long). Method in class java.io.Reader

 Skip characters.

skip(long). Method in class java.io.StringBufferInputStream

 Skips n bytes of input from this input stream.

skip(long). Method in class java.io.StringReader

 Skip characters.

skip(long). Method in class java.util.zip.ZipInputStream

 Skips specified number of bytes in the current ZIP entry.

skipBytes(int). Method in interface java.io.DataInput

 Skips exactly n bytes of input.

skipBytes(int). Method in class java.io.DataInputStream

 Skips exactly n bytes of input in the underlying  input stream.

skipBytes(int). Method in class java.io.ObjectInputStream

 Skips bytes, block until all bytes are skipped.

skipBytes(int). Method in class java.io.RandomAccessFile

 Skips exactly n bytes of input.

slashSlashComments(boolean). Method in class java.io.StreamTokenizer

 Determines whether or not the tokenizer recognizes C++-style comments.

slashStarComments(boolean). Method in class java.io.StreamTokenizer

 Determines whether or not the tokenizer recognizes C-style comments.

sleep(long). Static method in class java.lang.Thread

 Causes the currently executing thread to sleep (temporarily cease  execution) for the specified number of milliseconds.

sleep(long, int). Static method in class java.lang.Thread

 Causes the currently executing thread to sleep (cease execution)  for the specified number of milliseconds plus the specified number  of nanoseconds.

SMALLINT. Static variable in class java.sql.Types

 Socket(). Constructor for class java.net.Socket

 Creates an unconnected socket, with the  system-default type of SocketImpl.

Socket(InetAddress, int). Constructor for class java.net.Socket

 Creates a stream socket and connects it to the specified port  number at the specified IP address.

Socket(InetAddress, int, boolean). Constructor for class java.net.Socket

 Creates a socket and connects it to the specified port number at  the specified IP address.

Socket(InetAddress, int, InetAddress, int). Constructor for class java.net. Socket

 Creates a socket and connects it to the specified remote address on  the specified remote port.

Socket(SocketImpl). Constructor for class java.net.Socket

 Creates an unconnected Socket with a user-specified  SocketImpl.

Socket(String, int). Constructor for class java.net.Socket

 Creates a stream socket and connects it to the specified port  number on the named host.

Socket(String, int, boolean). Constructor for class java.net.Socket

 Creates a stream socket and connects it to the specified port  number on the named host.

Socket(String, int, InetAddress, int). Constructor for class java.net.Socket

 Creates a socket and connects it to the specified remote host on  the specified remote port.

SocketException(). Constructor for class java.net.SocketException

 Constructs a new ProtocolException with no detail message.

SocketException(String). Constructor for class java.net.SocketException

 Constructs a new ProtocolException with the  specified detail message.

SocketImpl(). Constructor for class java.net.SocketImpl

 SocketSecurityException(String). Constructor for class java.rmi.server.SocketSecurityException

 Create A remote exception with the specified string

SocketSecurityException(String, Exception). Constructor for class java.rmi.server.SocketSecurityException

 Create A remote exception with the specified string, and the  exception specified.

SOMEBITS. Static variable in interface java.awt.image.ImageObserver

 More pixels needed for drawing a scaled variation of the image  are available.

source. Variable in class java.util.EventObject

 SOUTH. Static variable in class java.awt. BorderLayout

 The south layout constraint.

SOUTH. Static variable in class java.awt.GridBagConstraints

 SOUTHEAST. Static variable in class java.awt. GridBagConstraints

 SOUTHWEST. Static variable in class java.awt. GridBagConstraints

 SPACE_SEPARATOR. Static variable in class java.lang. Character

 SQLException(). Constructor for class java.sql. SQLException

 Construct an SQLException; reason defaults to null, SQLState  defaults to null and vendorCode defaults to 0.

SQLException(String). Constructor for class java.sql.SQLException

 Construct an SQLException with a reason; SQLState defaults to  null and vendorCode defaults to 0.

SQLException(String, String). Constructor for class java.sql.SQLException

 Construct an SQLException with a reason and SQLState;  vendorCode defaults to 0.

SQLException(String, String, int). Constructor for class java.sql.SQLException

 Construct a fully-specified SQLException

SQLWarning(). Constructor for class java.sql.SQLWarning

 Construct an SQLWarning ; reason defaults to null, SQLState  defaults to null and vendorCode defaults to 0.

SQLWarning(String). Constructor for class java.sql.SQLWarning

 Construct an SQLWarning with a reason; SQLState defaults to  null and vendorCode defaults to 0.

SQLWarning(String, String). Constructor for class java.sql.SQLWarning

 Construct an SQLWarning with a reason and SQLState;  vendorCode defaults to 0.

SQLWarning(String, String, int). Constructor for class java.sql.SQLWarning

 Construct a fully specified SQLWarning.

sqrt(double). Static method in class java.lang.Math

 Returns the square root of a double value.

srccols. Variable in class java.awt.image.ReplicateScaleFilter

 srcHeight. Variable in class java.awt.image. ReplicateScaleFilter

 srcrows. Variable in class java.awt.image. ReplicateScaleFilter

 srcWidth. Variable in class java.awt.image. ReplicateScaleFilter

 Stack(). Constructor for class java.util.Stack

 StackFrame(). Constructor for class sun.tools.debug. StackFrame

 StackOverflowError(). Constructor for class java.lang.StackOverflowError

 Constructs a StackOverflowError with no detail message.

StackOverflowError(String). Constructor for class java.lang.StackOverflowError

 Constructs a StackOverflowError with the specified  detail message.

start(). Method in class java.applet.Applet

 Called by the browser or applet viewer to inform  this applet that it should start its execution.

start(). Method in class java.lang.Thread

 Causes this thread to begin execution; the Java Virtual Machine  calls the run  method of this thread.

START_PUNCTUATION. Static variable in class java.lang.Character

 startGrabbing(). Method in class java.awt.image. PixelGrabber

 Request the PixelGrabber to start fetching the pixels.

startProduction(ImageConsumer). Method in class java.awt.image. FilteredImageSource

 Adds an ImageConsumer to the list of consumers interested in  data for this image, and immediately starts delivery of the  image data through the ImageConsumer interface.

startProduction(ImageConsumer). Method in interface java.awt.image. ImageProducer

 This method both registers the given ImageConsumer object  as a consumer and starts an immediate reconstruction of  the image data which will then be delivered to this  consumer and any other consumer which may have already  been registered with the producer.

startProduction(ImageConsumer). Method in class java.awt.image. MemoryImageSource

 Adds an ImageConsumer to the list of consumers interested in  data for this image, and immediately start delivery of the  image data through the ImageConsumer interface.

startsWith(String). Method in class java.lang.String

 Tests if this string starts with the specified prefix.

startsWith(String, int). Method in class java.lang.String

 Tests if this string starts with the specified prefix.

state. Variable in class java.security.Signature

 Current state of this signature object.

STATIC. Static variable in class java.lang.reflect.Modifier

 STATICIMAGEDONE. Static variable in interface java.awt.image.ImageConsumer

 The image is complete and there are no more pixels or frames  to be delivered.

status(). Method in class java.awt.image.PixelGrabber

 DEPRECATED: Replaced by getStatus().

statusAll(boolean). Method in class java.awt.MediaTracker

 Returns the boolean OR of the status of all of the media being  tracked.

statusID(int, boolean). Method in class java.awt.MediaTracker

 Returns the boolean OR of the status of all of the media with  a given ID.

step(boolean). Method in class sun.tools.debug.RemoteThread

 Continue execution of this thread to the next instruction or line.

stop(). Method in class java.applet.Applet

 Called by the browser or applet viewer to inform  this applet that it should stop its execution.

stop(). Method in interface java.applet.AudioClip

 Stops playing this audio clip.

stop(). Method in class sun.tools.debug.RemoteThread

 Stop the remote thread.

stop(). Method in class sun.tools.debug.RemoteThreadGroup

 Stop the remote threadgroup.

stop(). Method in class java.lang.Thread

 Forces the thread to stop executing.

stop(). Method in class java.lang.ThreadGroup

 Stops all processes in this thread group.

stop(Throwable). Method in class java.lang.Thread

 Forces the thread to stop executing.

STORED. Static variable in class java.util.zip.ZipEntry

 Compression method for uncompressed entries.

STORED. Static variable in class java.util.zip.ZipOutputStream

 Compression method for uncompressed (STORED) entries.

storesLowerCaseIdentifiers(). Method in interface java.sql.DatabaseMetaData

 Does the database treat mixed case unquoted SQL identifiers as  case insensitive and store them in lower case?

storesLowerCaseQuotedIdentifiers(). Method in interface java.sql. DatabaseMetaData

 Does the database treat mixed case quoted SQL identifiers as  case insensitive and store them in lower case?

storesMixedCaseIdentifiers(). Method in interface java.sql.DatabaseMetaData

 Does the database treat mixed case unquoted SQL identifiers as  case insensitive and store them in mixed case?

storesMixedCaseQuotedIdentifiers(). Method in interface java.sql. DatabaseMetaData

 Does the database treat mixed case quoted SQL identifiers as  case insensitive and store them in mixed case?

storesUpperCaseIdentifiers(). Method in interface java.sql.DatabaseMetaData

 Does the database treat mixed case unquoted SQL identifiers as  case insensitive and store them in upper case?

storesUpperCaseQuotedIdentifiers(). Method in interface java.sql. DatabaseMetaData

 Does the database treat mixed case quoted SQL identifiers as  case insensitive and store them in upper case?

StreamCorruptedException(). Constructor for class java.io. StreamCorruptedException

 Create a StreamCorruptedException with no reason.

StreamCorruptedException(String). Constructor for class java.io. StreamCorruptedException

 Create a StreamCorruptedException with a reason.

StreamTokenizer(InputStream). Constructor for class java.io.StreamTokenizer

 Creates a stream tokenizer that parses the specified input  stream.

StreamTokenizer(Reader). Constructor for class java.io.StreamTokenizer

 Create a tokenizer that parses the given character stream.

String(). Constructor for class java.lang.String

 Allocates a new String containing no characters.

String(byte[]). Constructor for class java.lang.String

 Construct a new String by converting the specified array of bytes using  the platform's default character encoding.

String(byte[], int). Constructor for class java.lang.String

 Allocates a new String containing characters  constructed from an array of 8-bit integer values.

String(byte[], int, int). Constructor for class java.lang.String

 Construct a new String by converting the specified subarray of bytes  using the platform's default character encoding.

String(byte[], int, int, int). Constructor for class java.lang.String

 Allocates a new String constructed from a subarray  of an array of 8-bit integer values.

String(byte[], int, int, String). Constructor for class java.lang.String

 Construct a new String by converting the specified subarray of bytes  using the specified character encoding.

String(byte[], String). Constructor for class java.lang.String

 Construct a new String by converting the specified array of bytes using  the specified character encoding.

String(char[]). Constructor for class java.lang.String

 Allocates a new String so that it represents the  sequence of characters currently contained in the character array  argument.

String(char[], int, int). Constructor for class java.lang.String

 Allocates a new String that contains characters from  a subarray of the character array argument.

String(String). Constructor for class java.lang.String

 Allocates a new string that contains the same sequence of  characters as the string argument.

String(StringBuffer). Constructor for class java.lang.String

 Allocates a new string that contains the sequence of characters  currently contained in the string buffer argument.

StringBuffer(). Constructor for class java.lang.StringBuffer

 Constructs a string buffer with no characters in it and an  initial capacity of 16 characters.

StringBuffer(int). Constructor for class java.lang.StringBuffer

 Constructs a string buffer with no characters in it and an  initial capacity specified by the length argument.

StringBuffer(String). Constructor for class java.lang.StringBuffer

 Constructs a string buffer so that it represents the same  sequence of characters as the string argument.

StringBufferInputStream(String). Constructor for class java.io. StringBufferInputStream

 Creates a string input stream to read data from the specified string.

StringCharacterIterator(String). Constructor for class java.text. StringCharacterIterator

 Construct an iterator with an initial index of 0.

StringCharacterIterator(String, int). Constructor for class java.text. StringCharacterIterator

 Construct an iterator with the specified initial index.

StringCharacterIterator(String, int, int, int). Constructor for class java.text.StringCharacterIterator

 Construct an iterator over the given range of the given string, with the  index set at the specified position.

stringFlavor. Static variable in class java.awt.datatransfer.DataFlavor

 The DataFlavor representing a Java Unicode String class, where:

 representationClass = java.lang.String
 mimeType = "application/x-javaserializedobject"

 StringIndexOutOfBoundsException(). Constructor for class java.lang.StringIndexOutOfBoundsException

 Constructs a StringIndexOutOfBoundsException with no  detail message.

StringIndexOutOfBoundsException(int). Constructor for class java.lang. StringIndexOutOfBoundsException

 Constructs a new StringIndexOutOfBoundsException  class with an argument indicating the illegal index.

StringIndexOutOfBoundsException(String). Constructor for class java.lang. StringIndexOutOfBoundsException

 Constructs a StringIndexOutOfBoundsException with  the specified detail message.

StringReader(String). Constructor for class java.io.StringReader

 Create a new string reader.

StringSelection(String). Constructor for class java.awt.datatransfer. StringSelection

 Creates a transferable object capable of transferring the  specified string in plain text format.

StringTokenizer(String). Constructor for class java.util.StringTokenizer

 Constructs a string tokenizer for the specified string.

StringTokenizer(String, String). Constructor for class java.util. StringTokenizer

 Constructs a string tokenizer for the specified string.

StringTokenizer(String, String, boolean). Constructor for class java.util. StringTokenizer

 Constructs a string tokenizer for the specified string.

stringWidth(String). Method in class java.awt.FontMetrics

 Returns the total advance width for showing the specified String  in this Font.

StringWriter(). Constructor for class java.io.StringWriter

 Create a new string writer, using the default initial string-buffer  size.

StringWriter(int). Constructor for class java.io.StringWriter

 Create a new string writer, using the specified initial string-buffer  size.

StubNotFoundException(String). Constructor for class java.rmi. StubNotFoundException

 Create a new StubNotFoundException with a descriptive string.

StubNotFoundException(String, Exception). Constructor for class java.rmi. StubNotFoundException

 Create a new StubNotFoundException with a descriptive string and an exception.

style. Variable in class java.awt.Font

 The style of the font.

substituteColorModel(ColorModel, ColorModel). Method in class java.awt.image. RGBImageFilter

 Registers two ColorModel objects for substitution.

substring(int). Method in class java.lang.String

 Returns a new string that is a substring of this string.

substring(int, int). Method in class java.lang.String

 Returns a new string that is a substring of this string.

subtract(BigDecimal). Method in class java.math.BigDecimal

 Returns a BigDecimal whose value is (this - val), and whose scale is  MAX(this.scale(), val.scale).

subtract(BigInteger). Method in class java.math.BigInteger

 Returns a BigInteger whose value is (this - val).

SUNDAY. Static variable in class java.util.Calendar

 Useful constant for days of week.

supportsAlterTableWithAddColumn(). Method in interface java.sql. DatabaseMetaData

 Is "ALTER TABLE" with add column supported?

supportsAlterTableWithDropColumn(). Method in interface java.sql. DatabaseMetaData

 Is "ALTER TABLE" with drop column supported?

supportsANSI92EntryLevelSQL(). Method in interface java.sql.DatabaseMetaData

 Is the ANSI92 entry level SQL grammar supported?  All JDBC-Compliant drivers must return true.

supportsANSI92FullSQL(). Method in interface java.sql.DatabaseMetaData

 Is the ANSI92 full SQL grammar supported?

supportsANSI92IntermediateSQL(). Method in interface java.sql. DatabaseMetaData

 Is the ANSI92 intermediate SQL grammar supported?

supportsCatalogsInDataManipulation(). Method in interface java.sql. DatabaseMetaData

 Can a catalog name be used in a data manipulation statement?

supportsCatalogsInIndexDefinitions(). Method in interface java.sql. DatabaseMetaData

 Can a catalog name be used in an index definition statement?

supportsCatalogsInPrivilegeDefinitions(). Method in interface java.sql. DatabaseMetaData

 Can a catalog name be used in a privilege definition statement?

supportsCatalogsInProcedureCalls(). Method in interface java.sql. DatabaseMetaData

 Can a catalog name be used in a procedure call statement?

supportsCatalogsInTableDefinitions(). Method in interface java.sql. DatabaseMetaData

 Can a catalog name be used in a table definition statement?

supportsColumnAliasing(). Method in interface java.sql.DatabaseMetaData

 Is column aliasing supported?

If so, the SQL AS clause can be used to provide names for  computed columns or to provide alias names for columns as  required.

supportsConvert(). Method in interface java.sql.DatabaseMetaData

 Is the CONVERT function between SQL types supported?

supportsConvert(int, int). Method in interface java.sql.DatabaseMetaData

 Is CONVERT between the given SQL types supported?

supportsCoreSQLGrammar(). Method in interface java.sql.DatabaseMetaData

 Is the ODBC Core SQL grammar supported?

supportsCorrelatedSubqueries(). Method in interface java.sql.DatabaseMetaData

 Are correlated subqueries supported?  A JDBC-Compliant driver always returns true.

supportsCustomEditor(). Method in interface java.beans.PropertyEditor

 supportsCustomEditor(). Method in class java.beans. PropertyEditorSupport

 supportsDataDefinitionAndDataManipulationTransactions (). Method in interface java.sql.DatabaseMetaData

 Are both data definition and data manipulation statements  within a transaction supported?

supportsDataManipulationTransactionsOnly(). Method in interface java.sql. DatabaseMetaData

 Are only data manipulation statements within a transaction  supported?

supportsDifferentTableCorrelationNames(). Method in interface java.sql. DatabaseMetaData

 If table correlation names are supported, are they restricted  to be different from the names of the tables?

supportsExpressionsInOrderBy(). Method in interface java.sql.DatabaseMetaData

 Are expressions in "ORDER BY" lists supported?

supportsExtendedSQLGrammar(). Method in interface java.sql.DatabaseMetaData

 Is the ODBC Extended SQL grammar supported?

supportsFullOuterJoins(). Method in interface java.sql.DatabaseMetaData

 Are full nested outer joins supported?

supportsGroupBy(). Method in interface java.sql.DatabaseMetaData

 Is some form of "GROUP BY" clause supported?

supportsGroupByBeyondSelect(). Method in interface java.sql.DatabaseMetaData

 Can a "GROUP BY" clause add columns not in the SELECT  provided it specifies all the columns in the SELECT?

supportsGroupByUnrelated(). Method in interface java.sql.DatabaseMetaData

 Can a "GROUP BY" clause use columns not in the SELECT?

supportsIntegrityEnhancementFacility(). Method in interface java.sql. DatabaseMetaData

 Is the SQL Integrity Enhancement Facility supported?

supportsLikeEscapeClause(). Method in interface java.sql.DatabaseMetaData

 Is the escape character in "LIKE" clauses supported?  A JDBC-Compliant driver always returns true.

supportsLimitedOuterJoins(). Method in interface java.sql.DatabaseMetaData

 Is there limited support for outer joins? (This will be true  if supportFullOuterJoins is true.)

supportsMinimumSQLGrammar(). Method in interface java.sql.DatabaseMetaData

 Is the ODBC Minimum SQL grammar supported?  All JDBC-Compliant drivers must return true.

supportsMixedCaseIdentifiers(). Method in interface java.sql.DatabaseMetaData

 Does the database treat mixed case unquoted SQL identifiers as  case sensitive and as a result store them in mixed case?  A JDBC-Compliant driver will always return false.

supportsMixedCaseQuotedIdentifiers(). Method in interface java.sql. DatabaseMetaData

 Does the database treat mixed case quoted SQL identifiers as  case sensitive and as a result store them in mixed case?  A JDBC-Compliant driver will always return true.

supportsMultipleResultSets(). Method in interface java.sql.DatabaseMetaData

 Are multiple ResultSets from a single execute supported?

supportsMultipleTransactions(). Method in interface java.sql.DatabaseMetaData

 Can we have multiple transactions open at once (on different  connections)?

supportsNonNullableColumns(). Method in interface java.sql.DatabaseMetaData

 Can columns be defined as non-nullable?  A JDBC-Compliant driver always returns true.

supportsOpenCursorsAcrossCommit(). Method in interface java.sql. DatabaseMetaData

 Can cursors remain open across commits?

supportsOpenCursorsAcrossRollback(). Method in interface java.sql. DatabaseMetaData

 Can cursors remain open across rollbacks?

supportsOpenStatementsAcrossCommit(). Method in interface java.sql. DatabaseMetaData

 Can statements remain open across commits?

supportsOpenStatementsAcrossRollback(). Method in interface java.sql. DatabaseMetaData

 Can statements remain open across rollbacks?

supportsOrderByUnrelated(). Method in interface java.sql.DatabaseMetaData

 Can an "ORDER BY" clause use columns not in the SELECT?

supportsOuterJoins(). Method in interface java.sql.DatabaseMetaData

 Is some form of outer join supported?

supportsPositionedDelete(). Method in interface java.sql.DatabaseMetaData

 Is positioned DELETE supported?

supportsPositionedUpdate(). Method in interface java.sql.DatabaseMetaData

 Is positioned UPDATE supported?

supportsSchemasInDataManipulation(). Method in interface java.sql. DatabaseMetaData

 Can a schema name be used in a data manipulation statement?

supportsSchemasInIndexDefinitions(). Method in interface java.sql. DatabaseMetaData

 Can a schema name be used in an index definition statement?

supportsSchemasInPrivilegeDefinitions(). Method in interface java.sql. DatabaseMetaData

 Can a schema name be used in a privilege definition statement?

supportsSchemasInProcedureCalls(). Method in interface java.sql. DatabaseMetaData

 Can a schema name be used in a procedure call statement?

supportsSchemasInTableDefinitions(). Method in interface java.sql. DatabaseMetaData

 Can a schema name be used in a table definition statement?

supportsSelectForUpdate(). Method in interface java.sql.DatabaseMetaData

 Is SELECT for UPDATE supported?

supportsStoredProcedures(). Method in interface java.sql.DatabaseMetaData

 Are stored procedure calls using the stored procedure escape  syntax supported?

supportsSubqueriesInComparisons(). Method in interface java.sql. DatabaseMetaData

 Are subqueries in comparison expressions supported?  A JDBC-Compliant driver always returns true.

supportsSubqueriesInExists(). Method in interface java.sql.DatabaseMetaData

 Are subqueries in 'exists' expressions supported?  A JDBC-Compliant driver always returns true.

supportsSubqueriesInIns(). Method in interface java.sql.DatabaseMetaData

 Are subqueries in 'in' statements supported?  A JDBC-Compliant driver always returns true.

supportsSubqueriesInQuantifieds(). Method in interface java.sql. DatabaseMetaData

 Are subqueries in quantified expressions supported?  A JDBC-Compliant driver always returns true.

supportsTableCorrelationNames(). Method in interface java.sql. DatabaseMetaData

 Are table correlation names supported?  A JDBC-Compliant driver always returns true.

supportsTransactionIsolationLevel(int). Method in interface java.sql. DatabaseMetaData

 Does the database support the given transaction isolation level?

supportsTransactions(). Method in interface java.sql.DatabaseMetaData

 Are transactions supported? If not, commit is a noop and the  isolation level is TRANSACTION_NONE.

supportsUnion(). Method in interface java.sql.DatabaseMetaData

 Is SQL UNION supported?

supportsUnionAll(). Method in interface java.sql.DatabaseMetaData

 Is SQL UNION ALL supported?

SURROGATE. Static variable in class java.lang.Character

 suspend(). Method in class sun.tools.debug. RemoteThread

 Suspend execution of this thread.

suspend(). Method in class java.lang.Thread

 Suspends this thread.

suspend(). Method in class java.lang.ThreadGroup

 Suspends all processes in this thread group.

sval. Variable in class java.io.StreamTokenizer

 If the current token is a word token, this field contains a  string giving the characters of the word token.

SW_RESIZE_CURSOR. Static variable in class java.awt.Cursor

 The south-west-resize cursor type.

SW_RESIZE_CURSOR. Static variable in class java.awt.Frame

 sync(). Method in class java.io.FileDescriptor

 Force all system buffers to synchronize with the underlying  device.

sync(). Method in class java.awt.Toolkit

 Syncs the graphics state; useful when doing animation.

SyncFailedException(String). Constructor for class java.io.SyncFailedException

 Constructs an SyncFailedException with a detail message.

SYNCHRONIZED. Static variable in class java.lang.reflect.Modifier

______________________________________________________________________________

  T

TAB. Static variable in class java.awt.Event

 The Tab key.

tableIndexClustered. Static variable in interface java.sql.DatabaseMetaData

 INDEX INFO TYPE - this identifies a clustered index

tableIndexHashed. Static variable in interface java.sql.DatabaseMetaData

 INDEX INFO TYPE - this identifies a hashed index

tableIndexOther. Static variable in interface java.sql.DatabaseMetaData

 INDEX INFO TYPE - this identifies some other form of index

tableIndexStatistic. Static variable in interface java.sql.DatabaseMetaData

 INDEX INFO TYPE - this identifies table statistics that are  returned in conjuction with a table's index descriptions

TAIWAN. Static variable in class java.util.Locale

 Useful constant for country.

tan(double). Static method in class java.lang.Math

 Returns the trigonometric tangent of an angle.

target. Variable in class java.awt.Event

 The target component.

TERTIARY. Static variable in class java.text.Collator

 Collator strength value.

tertiaryOrder(int). Static method in class java.text.CollationElementIterator

 Get the tertiary order of a collation order.

testBit(int). Method in class java.math.BigInteger

 Returns true iff the designated bit is set.

text. Static variable in class java.awt.SystemColor

 The background color for text components.

TEXT. Static variable in class java.awt.SystemColor

 The array index for the text background color.

TEXT_CURSOR. Static variable in class java.awt.Cursor

 The text cursor type.

TEXT_CURSOR. Static variable in class java.awt.Frame

 TEXT_EVENT_MASK. Static variable in class java.awt. AWTEvent

 The event mask for selecting text events.

TEXT_FIRST. Static variable in class java.awt.event.TextEvent

 Marks the first integer id for the range of adjustment event ids.

TEXT_HIGHLIGHT. Static variable in class java.awt.SystemColor

 The array index for the text highlight color.

TEXT_HIGHLIGHT_TEXT. Static variable in class java.awt.SystemColor

 The array index for the text highlight text color.

TEXT_INACTIVE_TEXT. Static variable in class java.awt.SystemColor

 The array index for the text inactive text color.

TEXT_LAST. Static variable in class java.awt.event.TextEvent

 Marks the last integer id for the range of adjustment event ids.

TEXT_TEXT. Static variable in class java.awt.SystemColor

 The array index for the text text color.

TEXT_VALUE_CHANGED. Static variable in class java.awt.event.TextEvent

 The adjustment value changed event.

TextArea(). Constructor for class java.awt.TextArea

 Constructs a new TextArea.

TextArea(int, int). Constructor for class java.awt.TextArea

 Constructs a new empty TextArea with the specified number of  rows and columns.

TextArea(String). Constructor for class java.awt.TextArea

 Constructs a new TextArea with the specified text displayed.

TextArea(String, int, int). Constructor for class java.awt.TextArea

 Constructs a new TextArea with the specified text and number  of rows and columns.

TextArea(String, int, int, int). Constructor for class java.awt.TextArea

 Constructs a new TextArea with the specified text and number  of rows, columns, and scrollbar visibility.

TextEvent(Object, int). Constructor for class java.awt.event.TextEvent

 Constructs a TextEvent object with the specified TextComponent source,  and type.

TextField(). Constructor for class java.awt.TextField

 Constructs a new TextField.

TextField(int). Constructor for class java.awt.TextField

 Constructs a new empty TextField with the specified number of columns.

TextField(String). Constructor for class java.awt.TextField

 Constructs a new TextField initialized with the specified text.

TextField(String, int). Constructor for class java.awt.TextField

 Constructs a new TextField initialized with the specified text  and columns.

textHighlight. Static variable in class java.awt.SystemColor

 The background color for highlighted text.

textHighlightText. Static variable in class java.awt.SystemColor

 The text color for highlighted text.

textInactiveText. Static variable in class java.awt.SystemColor

 The text color for inactive text.

textListener. Variable in class java.awt.TextComponent

 textText. Static variable in class java.awt. SystemColor

 The text color for text components.

textValueChanged(TextEvent). Method in class java.awt.AWTEventMulticaster

 textValueChanged(TextEvent). Method in interface java.awt.event.TextListener

 Invoked when the value of the text has changed.

Thread(). Constructor for class java.lang.Thread

 Allocates a new Thread object.

Thread(Runnable). Constructor for class java.lang.Thread

 Allocates a new Thread object.

Thread(Runnable, String). Constructor for class java.lang.Thread

 Allocates a new Thread object.

Thread(String). Constructor for class java.lang.Thread

 Allocates a new Thread object.

Thread(ThreadGroup, Runnable). Constructor for class java.lang.Thread

 Allocates a new Thread object.

Thread(ThreadGroup, Runnable, String). Constructor for class java.lang.Thread

 Allocates a new Thread object so that it has  target  as its run object, has the specified  name  as its name, and belongs to the thread group  referred to by group.

Thread(ThreadGroup, String). Constructor for class java.lang.Thread

 Allocates a new Thread object.

ThreadDeath(). Constructor for class java.lang.ThreadDeath

 threadDeathEvent(RemoteThread). Method in interface sun.tools.debug.DebuggerCallback

 A thread has died.

ThreadGroup(String). Constructor for class java.lang.ThreadGroup

 Constructs a new thread group.

ThreadGroup(ThreadGroup, String). Constructor for class java.lang.ThreadGroup

 Creates a new thread group.

Throwable(). Constructor for class java.lang.Throwable

 Constructs a new Throwable with no detail message.

Throwable(String). Constructor for class java.lang.Throwable

 Constructs a new Throwable with the specified detail  message.

THURSDAY. Static variable in class java.util.Calendar

 Useful constant for days of week.

time. Variable in class java.util.Calendar

 The current time set for the calendar.

TIME. Static variable in class java.sql.Types

 Time(int, int, int). Constructor for class java.sql. Time

 Construct a Time Object

Time(long). Constructor for class java.sql.Time

 Construct a Time using a milliseconds time value

TIMESTAMP. Static variable in class java.sql.Types

 Timestamp(int, int, int, int, int, int, int). Constructor for class java.sql.Timestamp

 Construct a Timestamp Object

Timestamp(long). Constructor for class java.sql.Timestamp

 Construct a Timestamp using a milliseconds time value.

TimeZone(). Constructor for class java.util.TimeZone

 TIMEZONE_FIELD. Static variable in class java.text. DateFormat

 Useful constant for TIMEZONE field alignment.

TINYINT. Static variable in class java.sql.Types

 TITLECASE_LETTER. Static variable in class java.lang.Character

 toBack(). Method in class java.awt.Window

 Places this window at the bottom of the stacking order and  makes the corresponding adjustment to other visible windows.

toBack(). Method in interface java.awt.peer.WindowPeer

 toBigInteger(). Method in class java.math.BigDecimal

 Converts this number to a BigInteger.

toBinaryString(int). Static method in class java.lang.Integer

 Creates a string representation of the integer argument as an  unsigned integer in base 2.

toBinaryString(long). Static method in class java.lang.Long

 Creates a string representation of the long argument as an  unsigned integer in base 2.

toByteArray(). Method in class java.math.BigInteger

 Returns the two's-complement representation of this number.

toByteArray(). Method in class java.io.ByteArrayOutputStream

 Creates a newly allocated byte array.

toByteArray(). Method in class java.text.CollationKey

 Converts the CollationKey to a sequence of bits.

toCharArray(). Method in class java.io.CharArrayWriter

 Returns a copy of the input data.

toCharArray(). Method in class java.lang.String

 Converts this string to a new character array.

toExternalForm(). Method in class java.net.URL

 Constructs a string representation of this URL.

toExternalForm(URL). Method in class java.net.URLStreamHandler

 Converts a URL of a specific protocol to a  String.

toFront(). Method in class java.awt.Window

 Places this window at the top of the stacking order and  shows it in front of any other windows.

toFront(). Method in interface java.awt.peer.WindowPeer

 toGMTString(). Method in class java.util.Date

 Creates a string representation of this date.

toHex(int). Static method in class sun.tools.debug.RemoteValue

 Convert an int to a hexadecimal string.

toHexString(int). Static method in class java.lang.Integer

 Creates a string representation of the integer argument as an  unsigned integer in base 16.

toHexString(long). Static method in class java.lang.Long

 Creates a string representation of the long argument as an  unsigned integer in base 16.

toLocaleString(). Method in class java.util.Date

 Creates a string representation of this date in an  implementation-dependent form.

toLocalizedPattern(). Method in class java.text.DecimalFormat

 Synthesizes a localized pattern string that represents the current  state of this Format object.

toLocalizedPattern(). Method in class java.text.SimpleDateFormat

 Return a localized pattern string describing this date format.

toLowerCase(). Method in class java.lang.String

 Converts this string to lowercase.

toLowerCase(char). Static method in class java.lang.Character

 The given character is mapped to its lowercase equivalent; if the  character has no lowercase equivalent, the character itself is  returned.

toLowerCase(Locale). Method in class java.lang.String

 Converts all of the characters in this String to lower case using  the rules of the given locale.

toOctalString(int). Static method in class java.lang.Integer

 Creates a string representation of the integer argument as an  unsigned integer in base 8.

toOctalString(long). Static method in class java.lang.Long

 Creates a string representation of the long argument as an  unsigned integer in base 8.

Toolkit(). Constructor for class java.awt.Toolkit

 TooManyListenersException(). Constructor for class java.util.TooManyListenersException

 Constructs a TooManyListenersException with no detail message.

TooManyListenersException(String). Constructor for class java.util. TooManyListenersException

 Constructs a TooManyListenersException with the specified detail message.

top. Variable in class java.awt.Insets

 The inset from the top.

TOP_ALIGNMENT. Static variable in class java.awt.Component

 Ease of use constant for getAlignmentY().

toPattern(). Method in class java.text.ChoiceFormat

 Gets the pattern.

toPattern(). Method in class java.text.DecimalFormat

 Synthesizes a pattern string that represents the current state  of this Format object.

toPattern(). Method in class java.text.MessageFormat

 Gets the pattern.

toPattern(). Method in class java.text.SimpleDateFormat

 Return a pattern string describing this date format.

TOPDOWNLEFTRIGHT. Static variable in interface java.awt.image.ImageConsumer

 The pixels will be delivered in top-down, left-to-right order.

toString(). Method in interface java.security.acl.Acl

 Returns a string representation of the  ACL contents.

toString(). Method in interface java.security.acl.AclEntry

 Returns a string representation of the contents of this ACL entry.

toString(). Method in class java.awt.AWTEvent

 Returns a string representation of the object.

toString(). Method in class java.math.BigDecimal

 Returns the string representation of this number.

toString(). Method in class java.math.BigInteger

 Returns the string representation of this number, radix 10.

toString(). Method in class java.util.BitSet

 Returns a string representation of this bit set.

toString(). Method in class java.lang.Boolean

 Returns a String object representing this Boolean's value.

toString(). Method in class java.awt.BorderLayout

 Returns the String representation of this BorderLayout's values.

toString(). Method in class java.lang.Byte

 Returns a String object representing this Byte's value.

toString(). Method in class java.io.ByteArrayOutputStream

 Creates a newly allocated string.

toString(). Method in class java.awt.CardLayout

 Returns the String representation of this CardLayout's values.

toString(). Method in class java.lang.Character

 Returns a String object representing this character's value.

toString(). Method in class java.io.CharArrayWriter

 Converts input data to a string.

toString(). Method in class java.awt.CheckboxGroup

 Returns the String representation of this CheckboxGroup's values.

toString(). Method in class java.lang.Class

 Converts the object to a string.

toString(). Method in class java.awt.Color

 Returns the String representation of this Color's values.

toString(). Method in class java.awt.Component

 Returns the String representation of this Component's values.

toString(). Method in class java.lang.reflect.Constructor

 Return a string describing this Constructor.

toString(). Method in class java.sql.Date

 Format a date in JDBC date escape format

toString(). Method in class java.util.Date

 Returns a canonical string representation of the date.

toString(). Method in class java.security.DigestInputStream

 Prints a string representation of this digest input stream and  its associated message digest object.

toString(). Method in class java.security.DigestOutputStream

 Prints a string representation of this digest output stream and  its associated message digest object.

toString(). Method in class java.awt.Dimension

 Returns the String representation of this Dimension's values.

toString(). Method in class java.lang.Double

 Returns a String representation of this Double object.

toString(). Method in class java.awt.Event

 Returns the String representation of this Event's values.

toString(). Method in class java.util.EventObject

 Returns a string representation of the object.

toString(). Method in class java.lang.reflect.Field

 Return a string describing this Field.

toString(). Method in class java.io.File

 Returns a string representation of this object.

toString(). Method in class java.lang.Float

 Returns a String representation of this Float object.

toString(). Method in class java.awt.FlowLayout

 Returns the String representation of this FlowLayout's values.

toString(). Method in class java.awt.Font

 Converts this object to a String representation.

toString(). Method in class java.awt.FontMetrics

 Returns the String representation of this FontMetric's values.

toString(). Method in class java.awt.Graphics

 Returns a String object representing this Graphics object's value.

toString(). Method in class java.awt.GridBagLayout

 Returns the String representation of this GridLayout's values.

toString(). Method in class java.awt.GridLayout

 Returns the String representation of this GridLayout's values.

toString(). Method in class java.util.Hashtable

 Returns a rather long string representation of this hashtable.

toString(). Method in class java.security.Identity

 Returns a short string describing this identity, telling its  name and its scope (if any).

toString(). Method in class java.security.IdentityScope

 Returns a string representation of this identity scope, including  its name, its scope name, and the number of identities in this  identity scope.

toString(). Method in class java.net.InetAddress

 Converts this IP address to a String.

toString(). Method in class java.awt.Insets

 Returns a String object representing this Inset's values.

toString(). Method in class java.lang.Integer

 Returns a String object representing this Integer's value.

toString(). Method in class java.util.Locale

 Getter for the programmatic name of the entire locale,  with the language, country and variant separated by underbars.

toString(). Method in class java.rmi.server.LogStream

 Return log name as string representation

toString(). Method in class java.lang.Long

 Returns a String object representing this Long's value.

toString(). Method in class java.awt.MenuComponent

 Returns the String representation of this MenuComponent's values.

toString(). Method in class java.awt.MenuShortcut

 Returns an internationalized description of the MenuShortcut.

toString(). Method in class java.security.MessageDigest

 Returns a string representation of this message digest object.

toString(). Method in class java.lang.reflect.Method

 Returns a string describing this Method.

toString(). Method in class java.lang.Object

 Returns a string representation of the object.

toString(). Method in class java.io.ObjectStreamClass

 Return a string describing this ObjectStreamClass.

toString(). Method in class java.rmi.server.ObjID

 Returns a string containing the object id representation.

toString(). Method in class java.rmi.server.Operation

 Returns a string representation of the object.

toString(). Method in interface java.security.acl.Permission

 Prints a string representation of this permission.

toString(). Method in class java.awt.Point

 Returns the String representation of this Point's coordinates.

toString(). Method in interface java.security.Principal

 Returns a string representation of this principal.

toString(). Method in class java.security.Provider

 Returns a string with the name and the version number  of this provider.

toString(). Method in class java.awt.Rectangle

 Returns the String representation of this Rectangle's values.

toString(). Method in class sun.tools.debug.RemoteArray

 Return a string version of the array.

toString(). Method in class sun.tools.debug.RemoteBoolean

 Return the boolean's value as a string.

toString(). Method in class sun.tools.debug.RemoteByte

 Return the byte's value as a string.

toString(). Method in class sun.tools.debug.RemoteChar

 Return the char's value as a string.

toString(). Method in class sun.tools.debug.RemoteClass

 Return a (somewhat verbose) description.

toString(). Method in class sun.tools.debug.RemoteDouble

 Return the double's value as a string.

toString(). Method in class sun.tools.debug.RemoteField

 Returns a string representation of the object.

toString(). Method in class sun.tools.debug.RemoteFloat

 Return the float's value as a string.

toString(). Method in class sun.tools.debug.RemoteInt

 Return the int's value as a string.

toString(). Method in class sun.tools.debug.RemoteLong

 Return the long's value as a string.

toString(). Method in class java.rmi.server.RemoteObject

 Returns a String that represents the value of this remote object.

toString(). Method in class sun.tools.debug.RemoteObject

 Return object as a string.

toString(). Method in class sun.tools.debug.RemoteShort

 Return the short's value as a string.

toString(). Method in class sun.tools.debug.RemoteString

 Return the string value, or "null"

toString(). Method in class java.net.ServerSocket

 Returns the implementation address and implementation port of  this socket as a String .

toString(). Method in class java.lang.Short

 Returns a String object representing this Short's value.

toString(). Method in class java.security.Signature

 Returns a string representation of this signature object,  providing information that includes the state of the object  and the name of the algorithm used.

toString(). Method in class java.security.Signer

 Returns a string of information about the signer.

toString(). Method in class java.net.Socket

 Converts this socket to a String.

toString(). Method in class java.net.SocketImpl

 Returns the address and port of this socket as a String.

toString(). Method in class sun.tools.debug.StackFrame

 Returns a string representation of the object.

toString(). Method in class java.io.StreamTokenizer

 Returns the string representation of the current stream token.

toString(). Method in class java.lang.String

 This object (which is already a string!) is itself returned.

toString(). Method in class java.lang.StringBuffer

 Converts to a string representing the data in this string buffer.

toString(). Method in class java.io.StringWriter

 Return the buffer's current value as a string.

toString(). Method in class java.awt.SystemColor

 Returns the String representation of this Color's values.

toString(). Method in class java.lang.Thread

 Returns a string representation of this thread, including the  thread's name, priority, and thread group.

toString(). Method in class java.lang.ThreadGroup

 Returns a string representation of this Thread group.

toString(). Method in class java.lang.Throwable

 Returns a short description of this throwable object.

toString(). Method in class java.sql.Time

 Format a time in JDBC date escape format

toString(). Method in class java.sql.Timestamp

 Format a timestamp in JDBC timestamp escape format

toString(). Method in class java.rmi.server.UID

 Returns a string representation of the object.

toString(). Method in class java.net.URL

 Constructs a string representation of this URL.

toString(). Method in class java.net.URLConnection

 Returns a String representation of this URL connection.

toString(). Method in class java.util.Vector

 Returns a string representation of this vector.

toString(). Method in class java.rmi.dgc.VMID

 Return string representation of this VMID.

toString(). Method in class java.util.zip.ZipEntry

 Returns a string representation of the ZIP entry.

toString(boolean). Method in interface java.security.Certificate

 Returns a string that represents the contents of the certificate.

toString(boolean). Method in class java.security.Identity

 Returns a string representation of this identity, with  optionally more details than that provided by the  toString  method without any arguments.

toString(byte). Static method in class java.lang.Byte

 Returns a new String object representing the specified Byte.

toString(double). Static method in class java.lang.Double

 Creates a string representation of the double  argument.

toString(float). Static method in class java.lang.Float

 Returns a String representation for the specified float value.

toString(int). Method in class java.math.BigInteger

 Returns the string representation of this number in the given radix.

toString(int). Method in class java.io.ByteArrayOutputStream

 Creates a newly allocated string.

toString(int). Static method in class java.lang.Integer

 Returns a new String object representing the specified integer.

toString(int). Static method in class java.lang.reflect.Modifier

 Return a string describing the access modifier flags in  the specified modifier.

toString(int, int). Static method in class java.lang.Integer

 Creates a string representation of the first argument in the  radix specified by the second argument.

toString(long). Static method in class java.lang.Long

 Returns a new String object representing the specified integer.

toString(long, int). Static method in class java.lang.Long

 Creates a string representation of the first argument in the  radix specified by the second argument.

toString(short). Static method in class java.lang.Short

 Returns a new String object representing the specified  Short.

toString(String). Method in class java.io.ByteArrayOutputStream

 Converts input data to a string, using the specified character encoding.

totalMemory(). Method in class sun.tools.debug.RemoteDebugger

 Report the total memory usage of the Java interpreter being debugged.

totalMemory(). Method in class java.lang.Runtime

 Returns the total amount of memory in the Java Virtual Machine.

toTitleCase(char). Static method in class java.lang.Character

 Converts the character argument to titlecase.

toUpperCase(). Method in class java.lang.String

 Converts this string to uppercase.

toUpperCase(char). Static method in class java.lang.Character

 Converts the character argument to uppercase.

toUpperCase(Locale). Method in class java.lang.String

 Converts all of the characters in this String to upper case using  the rules of the given locale.

trace(boolean). Method in class sun.tools.debug.RemoteDebugger

 Turn on/off method call tracing.

traceInstructions(boolean). Method in class java.lang.Runtime

 Enables/Disables tracing of instructions.

traceMethodCalls(boolean). Method in class java.lang.Runtime

 Enables/Disables tracing of method calls.

TRACK. Static variable in class java.awt.event.AdjustmentEvent

 The absolute tracking adjustment type.

TRADITIONAL_CHINESE. Static variable in class java.util.Locale

 Useful constant for language.

TRANSACTION_NONE. Static variable in interface java.sql.Connection

 Transactions are not supported.

TRANSACTION_READ_COMMITTED. Static variable in interface java.sql.Connection

 Dirty reads are prevented; non-repeatable reads and phantom  reads can occur.

TRANSACTION_READ_UNCOMMITTED. Static variable in interface java.sql.Connection

 Dirty reads, non-repeatable reads and phantom reads can occur.

TRANSACTION_REPEATABLE_READ. Static variable in interface java.sql.Connection

 Dirty reads and non-repeatable reads are prevented; phantom  reads can occur.

TRANSACTION_SERIALIZABLE. Static variable in interface java.sql.Connection

 Dirty reads, non-repeatable reads and phantom reads are prevented.

transferFocus(). Method in class java.awt.Component

 Transfers the focus to the next component.

TRANSIENT. Static variable in class java.lang.reflect.Modifier

 translate(int, int). Method in class java.awt.Event

 Translates an event relative to the given component.

translate(int, int). Method in class java.awt.Graphics

 Translates the origin of the graphics context to the point  (x, y) in the current coordinate system.

translate(int, int). Method in class java.awt.Point

 Translates the point.

translate(int, int). Method in class java.awt.Polygon

 Translates the vertices by deltaX, deltaY.

translate(int, int). Method in class java.awt.Rectangle

 Translates the rectangle.

translatePoint(int, int). Method in class java.awt.event.MouseEvent

 Translates the coordinate position of the event by x, y.

trim(). Method in class java.lang.String

 Removes white space from both ends of this string.

trimToSize(). Method in class java.util.Vector

 Trims the capacity of this vector to be the vector's current  size.

TRUE. Static variable in class java.lang.Boolean

 The Boolean object corresponding to the primitive  value true.

TT_EOF. Static variable in class java.io.StreamTokenizer

 A constant indicating that the end of the stream has been read.

TT_EOL. Static variable in class java.io.StreamTokenizer

 A constant indicating that the end of the line has been read.

TT_NUMBER. Static variable in class java.io.StreamTokenizer

 A constant indicating that a number token has been read.

TT_WORD. Static variable in class java.io.StreamTokenizer

 A constant indicating that a word token has been read.

ttype. Variable in class java.io.StreamTokenizer

 After a call to the nextToken method, this field  contains the type of the token just read.

TUESDAY. Static variable in class java.util.Calendar

 Useful constant for days of week.

TYPE. Static variable in class java.lang.Boolean

 The Class object representing the primitive type boolean.

TYPE. Static variable in class java.lang.Byte

 The Class object representing the primitive type byte.

TYPE. Static variable in class java.lang.Character

 The Class object representing the primitive type char.

TYPE. Static variable in class java.lang.Double

 The Class object representing the primitive type double.

TYPE. Static variable in class java.lang.Float

 The Class object representing the primitive type float.

TYPE. Static variable in class java.lang.Integer

 The Class object representing the primitive type int.

TYPE. Static variable in class java.lang.Long

 The Class object representing the primitive type long.

TYPE. Static variable in class java.lang.Short

 The Class object representing the primitive type short.

TYPE. Static variable in class java.lang.Void

 The Class object representing the primitive Java type void.

typeName(). Method in class sun.tools.debug.RemoteArray

 Return this RemoteValue's type ("array").

typeName(). Method in class sun.tools.debug.RemoteBoolean

 Print this RemoteValue's type ("boolean").

typeName(). Method in class sun.tools.debug.RemoteByte

 Print this RemoteValue's type ("byte").

typeName(). Method in class sun.tools.debug.RemoteChar

 Print this RemoteValue's type ("char").

typeName(). Method in class sun.tools.debug.RemoteClass

 Returns the name of the class as its type.

typeName(). Method in class sun.tools.debug.RemoteDouble

 Print this RemoteValue's type ("double").

typeName(). Method in class sun.tools.debug.RemoteFloat

 Print this RemoteValue's type ("float").

typeName(). Method in class sun.tools.debug.RemoteInt

 Print this RemoteValue's type ("int").

typeName(). Method in class sun.tools.debug.RemoteLong

 Print this RemoteValue's type ("long").

typeName(). Method in class sun.tools.debug.RemoteObject

 Returns the RemoteValue's type name ("Object").

typeName(). Method in class sun.tools.debug.RemoteShort

 Print this RemoteValue's type ("short").

typeName(). Method in class sun.tools.debug.RemoteString

 Print this RemoteValue's type ("String").

typeName(). Method in class sun.tools.debug.RemoteValue

 Returns the RemoteValue's type as a string.

typeNoNulls. Static variable in interface java.sql.DatabaseMetaData

 TYPE NULLABLE - does not allow NULL values.

typeNullable. Static variable in interface java.sql.DatabaseMetaData

 TYPE NULLABLE - allows NULL values.

typeNullableUnknown. Static variable in interface java.sql.DatabaseMetaData

 TYPE NULLABLE - nullability unknown.

typePredBasic. Static variable in interface java.sql.DatabaseMetaData

 TYPE INFO SEARCHABLE - Supported except for WHERE ..

typePredChar. Static variable in interface java.sql.DatabaseMetaData

 TYPE INFO SEARCHABLE - Only supported with WHERE ..

typePredNone. Static variable in interface java.sql.DatabaseMetaData

 TYPE INFO SEARCHABLE - No support.

typeSearchable. Static variable in interface java.sql.DatabaseMetaData

 TYPE INFO SEARCHABLE - Supported for all WHERE ...

______________________________________________________________________________

  U

UID(). Constructor for class java.rmi.server.UID

 Create a pure identifier that is unique with respect to the  host on which it is generated.

UID(short). Constructor for class java.rmi.server.UID

 Create a "well-known" ID.

UK. Static variable in class java.util.Locale

 Useful constant for country.

UNASSIGNED. Static variable in class java.lang.Character

 unbind(String). Static method in class java.rmi. Naming

 Unbind the name.

unbind(String). Method in interface java.rmi.registry.Registry

 Unbind the name.

uncaughtException(Thread, Throwable). Method in class java.lang.ThreadGroup

 Called by the Java Virtual Machine when a thread in this  thread group stops because of an uncaught exception.

UNDECIMBER. Static variable in class java.util.Calendar

 Useful constant for month.

UndefinedProperty. Static variable in class java.awt.Image

 The UndefinedProperty object should be returned whenever a  property which was not defined for a particular image is  fetched.

UnexpectedException(String). Constructor for class java.rmi.UnexpectedException

 Create a new UnexpectedException with a description.

UnexpectedException(String, Exception). Constructor for class java.rmi. UnexpectedException

 Create a new UnexpectedException with a description, and detail  exception.

UnicastRemoteObject(). Constructor for class java.rmi.server. UnicastRemoteObject

 Create and export a new UnicastRemoteObject object using an  anonymous port.

UNINITIALIZED. Static variable in class java.security.Signature

 Possible state  value, signifying that  this signature object has not yet been initialized.

union(Rectangle). Method in class java.awt.Rectangle

 Computes the union of two rectangles.

UNIT_DECREMENT. Static variable in class java.awt.event.AdjustmentEvent

 The unit decrement adjustment type.

UNIT_INCREMENT. Static variable in class java.awt.event.AdjustmentEvent

 The unit increment adjustment type.

UnknownError(). Constructor for class java.lang.UnknownError

 Constructs an UnknownError with no detail message.

UnknownError(String). Constructor for class java.lang.UnknownError

 Constructs an UnknownError with the specified detail  message.

UnknownHostException(). Constructor for class java.net.UnknownHostException

 Constructs a new UnknownHostException with no detail  message.

UnknownHostException(String). Constructor for class java.net. UnknownHostException

 Constructs a new UnknownHostException with the  specified detail message.

UnknownHostException(String). Constructor for class java.rmi. UnknownHostException

 Create a new UnknownHostException with a description.

UnknownHostException(String, Exception). Constructor for class java.rmi. UnknownHostException

 Create a new UnknownHostException with a description and  detail exception.

UnknownServiceException(). Constructor for class java.net. UnknownServiceException

 Constructs a new UnknownServiceException with no  detail message.

UnknownServiceException(String). Constructor for class java.net. UnknownServiceException

 Constructs a new UnknownServiceException with the  specified detail message.

UnmarshalException(String). Constructor for class java.rmi.UnmarshalException

 Create a new marshal exception with a descriptive string.

UnmarshalException(String, Exception). Constructor for class java.rmi. UnmarshalException

 Create a new marshal exception with a descriptive string and an  exception.

unread(byte[]). Method in class java.io.PushbackInputStream

 Pushes back an array of bytes.

unread(byte[], int, int). Method in class java.io.PushbackInputStream

 Pushes back an array of bytes.

unread(char[]). Method in class java.io.PushbackReader

 Push back an entire array of characters.

unread(char[], int, int). Method in class java.io.PushbackReader

 Push back from an array of characters.

unread(int). Method in class java.io.PushbackInputStream

 Pushes back a character so that it is read again by the next call  to the read  method on this input stream.

unread(int). Method in class java.io.PushbackReader

 Push back a single character.

unreferenced(). Method in interface java.rmi.server.Unreferenced

 Called when there are no current references to this remote object.

UnsatisfiedLinkError(). Constructor for class java.lang.UnsatisfiedLinkError

 Constructs an UnsatisfiedLinkError with no detail message.

UnsatisfiedLinkError(String). Constructor for class java.lang. UnsatisfiedLinkError

 Constructs an UnsatisfiedLinkError with the  specified detail message.

UnsupportedEncodingException(). Constructor for class java.io. UnsupportedEncodingException

 no detailed message

UnsupportedEncodingException(String). Constructor for class java.io. UnsupportedEncodingException

 detailed message

UnsupportedFlavorException(DataFlavor). Constructor for class java.awt.datatransfer.UnsupportedFlavorException

 Constructs an UnsupportedFlavorException.

UP. Static variable in class java.awt.Event

 The up arrow action-key.

up(int). Method in class sun.tools.debug.RemoteThread

 Change the current stackframe to be one or more frames higher  (as in, away from the current program counter).

UPDATE. Static variable in class java.awt.event.PaintEvent

 The update event type.

update(byte). Method in class java.security.MessageDigest

 Updates the digest using the specified byte.

update(byte). Method in class java.security.Signature

 Updates the data to be signed or verified by a byte.

update(byte[]). Method in class java.util.zip.Adler32

 Updates checksum with specified array of bytes.

update(byte[]). Method in class java.util.zip.CRC32

 Updates CRC-32 with specified array of bytes.

update(byte[]). Method in class java.security.MessageDigest

 Updates the digest using the specified array of bytes.

update(byte[]). Method in class java.security.Signature

 Updates the data to be signed or verified, using the specified  array of bytes.

update(byte[], int, int). Method in class java.util.zip.Adler32

 Updates checksum with specified array of bytes.

update(byte[], int, int). Method in interface java.util.zip.Checksum

 Updates the current checksum with the specified array of bytes.

update(byte[], int, int). Method in class java.util.zip.CRC32

 Updates CRC-32 with specified array of bytes.

update(byte[], int, int). Method in class java.security.MessageDigest

 Updates the digest using the specified array of bytes, starting  at the specified offset.

update(byte[], int, int). Method in class java.security.Signature

 Updates the data to be signed or verified, using the specified  array of bytes, starting at the specified offset.

update(Graphics). Method in class java.awt.Component

 Updates the component.

update(int). Method in class java.util.zip.Adler32

 Updates checksum with specified byte.

update(int). Method in interface java.util.zip.Checksum

 Updates the current checksum with the specified byte.

update(int). Method in class java.util.zip.CRC32

 Updates CRC-32 with specified byte.

update(Observable, Object). Method in interface java.util.Observer

 This method is called whenever the observed object is changed.

UPPERCASE_LETTER. Static variable in class java.lang.Character

 url. Variable in class java.net.URLConnection

 The URL represents the remote object on the World Wide Web to  which this connection is opened.

URL(String). Constructor for class java.net.URL

 Creates a URL object from the String  representation.

URL(String, String, int, String). Constructor for class java.net.URL

 Creates a URL object from the specified  protocol, host, port  number, and file.

URL(String, String, String). Constructor for class java.net.URL

 Creates an absolute URL from the specified protocol  name, host name, and file name.

URL(URL, String). Constructor for class java.net.URL

 Creates a URL by parsing the specification spec  within a specified context.

URLConnection(URL). Constructor for class java.net.URLConnection

 Constructs a URL connection to the specified URL.

URLStreamHandler(). Constructor for class java.net.URLStreamHandler

 US. Static variable in class java.util.Locale

 Useful constant for country.

useCaches. Variable in class java.net.URLConnection

 If true, the protocol is allowed to use caching  whenever it can.

useDaylightTime(). Method in class java.util.SimpleTimeZone

 Overrides TimeZone  Queries if this time zone uses Daylight Savings Time.

useDaylightTime(). Method in class java.util.TimeZone

 Queries if this time zone uses Daylight Savings Time.

usesLocalFilePerTable(). Method in interface java.sql.DatabaseMetaData

 Does the database use a file for each table?

usesLocalFiles(). Method in interface java.sql.DatabaseMetaData

 Does the database store tables in a local file?

usesShiftModifier(). Method in class java.awt.MenuShortcut

 Return whether this MenuShortcut must be invoked using the SHIFT key.

usingProxy(). Method in class java.net.HttpURLConnection

 Indicates if the connection is going through a proxy.

UTC(int, int, int, int, int, int). Static method in class java.util.Date

 Determines the date and time based on the arguments.

UTFDataFormatException(). Constructor for class java.io.UTFDataFormatException

 Constructs a UTFDataFormatException with no detail  message.

UTFDataFormatException(String). Constructor for class java.io. UTFDataFormatException

 Constructs a UTFDataFormatException with the  specified detail message.

______________________________________________________________________________

  V

valid(). Method in class java.io.FileDescriptor

 Tests if this file descriptor object is valid.

validate(). Method in class java.awt.Component

 Ensures that a component has a valid layout.

validate(). Method in class java.awt.Container

 Validates this Container and all of the components contained  within it.

validateObject(). Method in interface java.io.ObjectInputValidation

 Validates the object

validateTree(). Method in class java.awt.Container

 Recursively descends the container tree and recomputes the  layout for any subtrees marked as needing it (those marked as  invalid).

value. Variable in class java.sql.DriverPropertyInfo

 "value" specifies the current value of the property, based on a  combination of the information supplied to getPropertyInfo, the  Java environment, and driver supplied default values.

valueOf(boolean). Static method in class java.lang.String

 Returns the string representation of the boolean argument.

valueOf(char). Static method in class java.lang.String

 Returns the string representation of the char * argument.

valueOf(char[]). Static method in class java.lang.String

 Returns the string representation of the char array  argument.

valueOf(char[], int, int). Static method in class java.lang.String

 Returns the string representation of a specific subarray of the  char array argument.

valueOf(double). Static method in class java.lang.String

 Returns the string representation of the double argument.

valueOf(float). Static method in class java.lang.String

 Returns the string representation of the float argument.

valueOf(int). Static method in class java.lang.String

 Returns the string representation of the int argument.

valueOf(long). Static method in class java.math.BigDecimal

 Returns a BigDecimal with the given value and a scale of zero.

valueOf(long). Static method in class java.math.BigInteger

 Returns a BigInteger with the specified value.

valueOf(long). Static method in class java.lang.String

 Returns the string representation of the long argument.

valueOf(long, int). Static method in class java.math.BigDecimal

 Returns a BigDecimal with a value of (val/10**scale).

valueOf(Object). Static method in class java.lang.String

 Returns the string representation of the Object argument.

valueOf(String). Static method in class java.lang.Boolean

 Returns the boolean value represented by the specified String.

valueOf(String). Static method in class java.lang.Byte

 Assuming the specified String represents a byte, returns a  new Byte object initialized to that value.

valueOf(String). Static method in class java.sql.Date

 Convert a string in JDBC date escape format to a Date value

valueOf(String). Static method in class java.lang.Double

 Returns a new Double value initialized to the value represented by the  specified String.

valueOf(String). Static method in class java.lang.Float

 Returns the floating point value represented by the specified String.

valueOf(String). Static method in class java.lang.Integer

 Returns a new Integer object initialized to the value of the  specified String.

valueOf(String). Static method in class java.lang.Long

 Returns a new long object initialized to the value of the  specified String.

valueOf(String). Static method in class java.lang.Short

 Assuming the specified String represents a short, returns a  new Short object initialized to that value.

valueOf(String). Static method in class java.sql.Time

 Convert a string in JDBC time escape format to a Time value

valueOf(String). Static method in class java.sql.Timestamp

 Convert a string in JDBC timestamp escape format to a Timestamp value

valueOf(String, int). Static method in class java.lang.Byte

 Assuming the specified String represents a byte, returns a  new Byte object initialized to that value.

valueOf(String, int). Static method in class java.lang.Integer

 Returns a new Integer object initialized to the value of the  specified String.

valueOf(String, int). Static method in class java.lang.Long

 Returns a new long object initialized to the value of the  specified String.

valueOf(String, int). Static method in class java.lang.Short

 Assuming the specified String represents a short, returns a  new Short object initialized to that value.

VARBINARY. Static variable in class java.sql.Types

 VARCHAR. Static variable in class java.sql.Types

 Vector(). Constructor for class java.util.Vector

 Constructs an empty vector.

Vector(int). Constructor for class java.util.Vector

 Constructs an empty vector with the specified initial capacity.

Vector(int, int). Constructor for class java.util.Vector

 Constructs an empty vector with the specified initial capacity and  capacity increment.

VERBOSE. Static variable in class java.rmi.server.LogStream

 VERIFY. Static variable in class java.security. Signature

 Possible state  value, signifying that  this signature object has been initialized for verification.

verify(byte[]). Method in class java.security.Signature

 Verifies the passed-in signature.

VerifyError(). Constructor for class java.lang.VerifyError

 Constructs an VerifyError with no detail message.

VerifyError(String). Constructor for class java.lang.VerifyError

 Constructs an VerifyError with the specified detail message.

versionColumnNotPseudo. Static variable in interface java.sql. DatabaseMetaData

 VERSION COLUMNS PSEUDO_COLUMN - is NOT a pseudo column.

versionColumnPseudo. Static variable in interface java.sql.DatabaseMetaData

 VERSION COLUMNS PSEUDO_COLUMN - is a pseudo column.

versionColumnUnknown. Static variable in interface java.sql.DatabaseMetaData

 VERSION COLUMNS PSEUDO_COLUMN - may or may not be pseudo column.

VERTICAL. Static variable in interface java.awt.Adjustable

 The vertical orientation.

VERTICAL. Static variable in class java.awt.GridBagConstraints

 VERTICAL. Static variable in class java.awt. Scrollbar

 The vertical Scrollbar variable.

vetoableChange(PropertyChangeEvent). Method in interface java.beans. VetoableChangeListener

 This method gets called when a constrained property is changed.

VetoableChangeSupport(Object). Constructor for class java.beans. VetoableChangeSupport

 VirtualMachineError(). Constructor for class java.lang.VirtualMachineError

 Constructs a VirtualMachineError with no detail message.

VirtualMachineError(String). Constructor for class java.lang. VirtualMachineError

 Constructs a VirtualMachineError with the specified  detail message.

VK_0. Static variable in class java.awt.event.KeyEvent

 VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39)

VK_1. Static variable in class java.awt.event.KeyEvent

 VK_2. Static variable in class java.awt.event. KeyEvent

 VK_3. Static variable in class java.awt.event. KeyEvent

 VK_4. Static variable in class java.awt.event. KeyEvent

 VK_5. Static variable in class java.awt.event. KeyEvent

 VK_6. Static variable in class java.awt.event. KeyEvent

 VK_7. Static variable in class java.awt.event. KeyEvent

 VK_8. Static variable in class java.awt.event. KeyEvent

 VK_9. Static variable in class java.awt.event. KeyEvent

 VK_A. Static variable in class java.awt.event. KeyEvent

 VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A)

VK_ACCEPT. Static variable in class java.awt.event.KeyEvent

 VK_ADD. Static variable in class java.awt.event. KeyEvent

 VK_ALT. Static variable in class java.awt.event. KeyEvent

 VK_B. Static variable in class java.awt.event. KeyEvent

 VK_BACK_QUOTE. Static variable in class java.awt.event.KeyEvent

 VK_BACK_SLASH. Static variable in class java.awt.event.KeyEvent

 VK_BACK_SPACE. Static variable in class java.awt.event.KeyEvent

 VK_C. Static variable in class java.awt.event. KeyEvent

 VK_CANCEL. Static variable in class java.awt.event. KeyEvent

 VK_CAPS_LOCK. Static variable in class java.awt.event.KeyEvent

 VK_CLEAR. Static variable in class java.awt.event. KeyEvent

 VK_CLOSE_BRACKET. Static variable in class java.awt.event.KeyEvent

 VK_COMMA. Static variable in class java.awt.event. KeyEvent

 VK_CONTROL. Static variable in class java.awt.event. KeyEvent

 VK_CONVERT. Static variable in class java.awt.event. KeyEvent

 VK_D. Static variable in class java.awt.event. KeyEvent

 VK_DECIMAL. Static variable in class java.awt.event. KeyEvent

 VK_DELETE. Static variable in class java.awt.event. KeyEvent

 VK_DIVIDE. Static variable in class java.awt.event. KeyEvent

 VK_DOWN. Static variable in class java.awt.event. KeyEvent

 VK_E. Static variable in class java.awt.event. KeyEvent

 VK_END. Static variable in class java.awt.event. KeyEvent

 VK_ENTER. Static variable in class java.awt.event. KeyEvent

 Virtual key codes.

VK_EQUALS. Static variable in class java.awt.event.KeyEvent

 VK_ESCAPE. Static variable in class java.awt.event. KeyEvent

 VK_F. Static variable in class java.awt.event. KeyEvent

 VK_F1. Static variable in class java.awt.event. KeyEvent

 VK_F10. Static variable in class java.awt.event. KeyEvent

 VK_F11. Static variable in class java.awt.event. KeyEvent

 VK_F12. Static variable in class java.awt.event. KeyEvent

 VK_F2. Static variable in class java.awt.event. KeyEvent

 VK_F3. Static variable in class java.awt.event. KeyEvent

 VK_F4. Static variable in class java.awt.event. KeyEvent

 VK_F5. Static variable in class java.awt.event. KeyEvent

 VK_F6. Static variable in class java.awt.event. KeyEvent

 VK_F7. Static variable in class java.awt.event. KeyEvent

 VK_F8. Static variable in class java.awt.event. KeyEvent

 VK_F9. Static variable in class java.awt.event. KeyEvent

 VK_FINAL. Static variable in class java.awt.event. KeyEvent

 for Asian Keyboard

VK_G. Static variable in class java.awt.event.KeyEvent

 VK_H. Static variable in class java.awt.event. KeyEvent

 VK_HELP. Static variable in class java.awt.event. KeyEvent

 VK_HOME. Static variable in class java.awt.event. KeyEvent

 VK_I. Static variable in class java.awt.event. KeyEvent

 VK_INSERT. Static variable in class java.awt.event. KeyEvent

 VK_J. Static variable in class java.awt.event. KeyEvent

 VK_K. Static variable in class java.awt.event. KeyEvent

 VK_KANA. Static variable in class java.awt.event. KeyEvent

 VK_KANJI. Static variable in class java.awt.event. KeyEvent

 VK_L. Static variable in class java.awt.event. KeyEvent

 VK_LEFT. Static variable in class java.awt.event. KeyEvent

 VK_M. Static variable in class java.awt.event. KeyEvent

 VK_META. Static variable in class java.awt.event. KeyEvent

 VK_MODECHANGE. Static variable in class java.awt.event.KeyEvent

 VK_MULTIPLY. Static variable in class java.awt.event.KeyEvent

 VK_N. Static variable in class java.awt.event. KeyEvent

 VK_NONCONVERT. Static variable in class java.awt.event.KeyEvent

 VK_NUM_LOCK. Static variable in class java.awt.event.KeyEvent

 VK_NUMPAD0. Static variable in class java.awt.event. KeyEvent

 VK_NUMPAD1. Static variable in class java.awt.event. KeyEvent

 VK_NUMPAD2. Static variable in class java.awt.event. KeyEvent

 VK_NUMPAD3. Static variable in class java.awt.event. KeyEvent

 VK_NUMPAD4. Static variable in class java.awt.event. KeyEvent

 VK_NUMPAD5. Static variable in class java.awt.event. KeyEvent

 VK_NUMPAD6. Static variable in class java.awt.event. KeyEvent

 VK_NUMPAD7. Static variable in class java.awt.event. KeyEvent

 VK_NUMPAD8. Static variable in class java.awt.event. KeyEvent

 VK_NUMPAD9. Static variable in class java.awt.event. KeyEvent

 VK_O. Static variable in class java.awt.event. KeyEvent

 VK_OPEN_BRACKET. Static variable in class java.awt.event.KeyEvent

 VK_P. Static variable in class java.awt.event. KeyEvent

 VK_PAGE_DOWN. Static variable in class java.awt.event.KeyEvent

 VK_PAGE_UP. Static variable in class java.awt.event.KeyEvent

 VK_PAUSE. Static variable in class java.awt.event. KeyEvent

 VK_PERIOD. Static variable in class java.awt.event. KeyEvent

 VK_PRINTSCREEN. Static variable in class java.awt.event.KeyEvent

 VK_Q. Static variable in class java.awt.event. KeyEvent

 VK_QUOTE. Static variable in class java.awt.event. KeyEvent

 VK_R. Static variable in class java.awt.event. KeyEvent

 VK_RIGHT. Static variable in class java.awt.event. KeyEvent

 VK_S. Static variable in class java.awt.event. KeyEvent

 VK_SCROLL_LOCK. Static variable in class java.awt.event.KeyEvent

 VK_SEMICOLON. Static variable in class java.awt.event.KeyEvent

 VK_SEPARATER. Static variable in class java.awt.event.KeyEvent

 VK_SHIFT. Static variable in class java.awt.event. KeyEvent

 VK_SLASH. Static variable in class java.awt.event. KeyEvent

 VK_SPACE. Static variable in class java.awt.event. KeyEvent

 VK_SUBTRACT. Static variable in class java.awt.event.KeyEvent

 VK_T. Static variable in class java.awt.event. KeyEvent

 VK_TAB. Static variable in class java.awt.event. KeyEvent

 VK_U. Static variable in class java.awt.event. KeyEvent

 VK_UNDEFINED. Static variable in class java.awt.event.KeyEvent

 KEY_TYPED events do not have a defined keyCode.

VK_UP. Static variable in class java.awt.event.KeyEvent

 VK_V. Static variable in class java.awt.event. KeyEvent

 VK_W. Static variable in class java.awt.event. KeyEvent

 VK_X. Static variable in class java.awt.event. KeyEvent

 VK_Y. Static variable in class java.awt.event. KeyEvent

 VK_Z. Static variable in class java.awt.event. KeyEvent

 VMID(). Constructor for class java.rmi.dgc.VMID

 Create a new VMID.

VOLATILE. Static variable in class java.lang.reflect.Modifier

______________________________________________________________________________

  W

W_RESIZE_CURSOR. Static variable in class java.awt.Cursor

 The west-resize cursor type.

W_RESIZE_CURSOR. Static variable in class java.awt.Frame

 wait(). Method in class java.lang.Object

 Waits to be notified by another thread of a change in this object.

wait(long). Method in class java.lang.Object

 Waits to be notified by another thread of a change in this object.

wait(long, int). Method in class java.lang.Object

 Waits to be notified by another thread of a change in this object.

WAIT_CURSOR. Static variable in class java.awt.Cursor

 The wait cursor type.

WAIT_CURSOR. Static variable in class java.awt.Frame

 waitFor(). Method in class java.lang.Process

 Waits for the subprocess to complete.

waitForAll(). Method in class java.awt.MediaTracker

 Starts loading all images.

waitForAll(long). Method in class java.awt.MediaTracker

 Starts loading all images.

waitForID(int). Method in class java.awt.MediaTracker

 Starts loading all images with the specified ID and waits until they  have finished loading or receive an error.

waitForID(int, long). Method in class java.awt.MediaTracker

 Starts loading all images with the specified ID.

wasNull(). Method in interface java.sql.CallableStatement

 An OUT parameter may have the value of SQL NULL; wasNull reports  whether the last value read has this special value.

wasNull(). Method in interface java.sql.ResultSet

 A column may have the value of SQL NULL; wasNull reports whether  the last column read had this special value.

WEDNESDAY. Static variable in class java.util.Calendar

 Useful constant for days of week.

WEEK_OF_MONTH. Static variable in class java.util.Calendar

 Useful constant for date and time.

WEEK_OF_MONTH_FIELD. Static variable in class java.text.DateFormat

 Useful constant for WEEK_OF_MONTH field alignment.

WEEK_OF_YEAR. Static variable in class java.util.Calendar

 Useful constant for date and time.

WEEK_OF_YEAR_FIELD. Static variable in class java.text.DateFormat

 Useful constant for WEEK_OF_YEAR field alignment.

weightx. Variable in class java.awt.GridBagConstraints

 weighty. Variable in class java.awt. GridBagConstraints

 WEST. Static variable in class java.awt.BorderLayout

 The west layout constraint.

WEST. Static variable in class java.awt.GridBagConstraints

 when. Variable in class java.awt.Event

 The time stamp.

white. Static variable in class java.awt.Color

 The color white.

whitespaceChars(int, int). Method in class java.io.StreamTokenizer

 Specifies that all characters c in the range  low <= c <= high   are white space characters.

width. Variable in class java.awt.Dimension

 The width dimension.

WIDTH. Static variable in interface java.awt.image.ImageObserver

 The width of the base image is now available and can be taken  from the width argument to the imageUpdate callback method.

width. Variable in class java.awt.Rectangle

 The width of the rectangle.

window. Static variable in class java.awt.SystemColor

 The background color for windows.

WINDOW. Static variable in class java.awt.SystemColor

 The array index for the window background color.

Window(Frame). Constructor for class java.awt.Window

 Constructs a new Window initialized to an invisible state.

WINDOW_ACTIVATED. Static variable in class java.awt.event.WindowEvent

 The window activated event type.

WINDOW_BORDER. Static variable in class java.awt.SystemColor

 The array index for the window border color.

WINDOW_CLOSED. Static variable in class java.awt.event.WindowEvent

 The window closed event type.

WINDOW_CLOSING. Static variable in class java.awt.event.WindowEvent

 The window closing event type.

WINDOW_DEACTIVATED. Static variable in class java.awt.event.WindowEvent

 The window deactivated event type.

WINDOW_DEICONIFIED. Static variable in class java.awt.event.WindowEvent

 The window deiconified event type.

WINDOW_DEICONIFY. Static variable in class java.awt.Event

 The de-iconify window event.

WINDOW_DESTROY. Static variable in class java.awt.Event

 The destroy window event.

WINDOW_EVENT_MASK. Static variable in class java.awt.AWTEvent

 The event mask for selecting window events.

WINDOW_EXPOSE. Static variable in class java.awt.Event

 The expose window event.

WINDOW_FIRST. Static variable in class java.awt.event.WindowEvent

 Marks the first integer id for the range of window event ids.

WINDOW_ICONIFIED. Static variable in class java.awt.event.WindowEvent

 The window iconified event type.

WINDOW_ICONIFY. Static variable in class java.awt.Event

 The iconify window event.

WINDOW_LAST. Static variable in class java.awt.event.WindowEvent

 Marks the last integer id for the range of window event ids.

WINDOW_MOVED. Static variable in class java.awt.Event

 The move window event.

WINDOW_OPENED. Static variable in class java.awt.event.WindowEvent

 The window opened event type.

WINDOW_TEXT. Static variable in class java.awt.SystemColor

 The array index for the window text color.

windowActivated(WindowEvent). Method in class java.awt.AWTEventMulticaster

 Handles the windowActivated event by invoking the  windowActivated methods on listener-a and listener-b.

windowActivated(WindowEvent). Method in class java.awt.event.WindowAdapter

 windowActivated(WindowEvent). Method in interface java.awt.event.WindowListener

 Invoked when a window is activated.

WindowAdapter(). Constructor for class java.awt.event.WindowAdapter

 windowBorder. Static variable in class java.awt. SystemColor

 The border color for windows.

windowClosed(WindowEvent). Method in class java.awt.AWTEventMulticaster

 Handles the windowClosed event by invoking the  windowClosed methods on listener-a and listener-b.

windowClosed(WindowEvent). Method in class java.awt.event.WindowAdapter

 windowClosed(WindowEvent). Method in interface java.awt.event.WindowListener

 Invoked when a window has been closed.

windowClosing(WindowEvent). Method in class java.awt.AWTEventMulticaster

 Handles the windowClosing event by invoking the  windowClosing methods on listener-a and listener-b.

windowClosing(WindowEvent). Method in class java.awt.event.WindowAdapter

 windowClosing(WindowEvent). Method in interface java.awt.event.WindowListener

 Invoked when a window is in the process of being closed.

windowDeactivated(WindowEvent). Method in class java.awt.AWTEventMulticaster

 Handles the windowDeactivated event by invoking the  windowDeactivated methods on listener-a and listener-b.

windowDeactivated(WindowEvent). Method in class java.awt.event.WindowAdapter

 windowDeactivated(WindowEvent). Method in interface java.awt.event.WindowListener

 Invoked when a window is de-activated.

windowDeiconified(WindowEvent). Method in class java.awt.AWTEventMulticaster

 Handles the windowDeiconfied event by invoking the  windowDeiconified methods on listener-a and listener-b.

windowDeiconified(WindowEvent). Method in class java.awt.event.WindowAdapter

 windowDeiconified(WindowEvent). Method in interface java.awt.event.WindowListener

 Invoked when a window is de-iconified.

WindowEvent(Window, int). Constructor for class java.awt.event.WindowEvent

 Constructs a WindowEvent object with the specified source window  and type.

windowIconified(WindowEvent). Method in class java.awt.AWTEventMulticaster

 Handles the windowIconified event by invoking the  windowIconified methods on listener-a and listener-b.

windowIconified(WindowEvent). Method in class java.awt.event.WindowAdapter

 windowIconified(WindowEvent). Method in interface java.awt.event.WindowListener

 Invoked when a window is iconified.

windowOpened(WindowEvent). Method in class java.awt.AWTEventMulticaster

 Handles the windowOpened event by invoking the  windowOpened methods on listener-a and listener-b.

windowOpened(WindowEvent). Method in class java.awt.event.WindowAdapter

 windowOpened(WindowEvent). Method in interface java.awt.event.WindowListener

 Invoked when a window has been opened.

windowText. Static variable in class java.awt.SystemColor

 The text color for windows.

wordChars(int, int). Method in class java.io.StreamTokenizer

 Specifies that all characters c in the range  low <= c <= high   are word constituents.

write(byte[]). Method in interface java.io.DataOutput

 Writes b.length bytes from the specified byte array  to this output stream.

write(byte[]). Method in class java.io.FileOutputStream

 Writes b.length bytes from the specified byte array  to this file output stream.

write(byte[]). Method in class java.io.FilterOutputStream

 Writes b.length bytes to this output stream.

write(byte[]). Method in interface java.io.ObjectOutput

 Writes an array of bytes.

write(byte[]). Method in class java.io.ObjectOutputStream

 Writes an array of bytes.

write(byte[]). Method in class java.io.OutputStream

 Writes b.length bytes from the specified byte array  to this output stream.

write(byte[]). Method in class java.io.RandomAccessFile

 Writes b.length bytes from the specified byte array  starting at offset off  to this file.

write(byte[], int, int). Method in class java.io.BufferedOutputStream

 Writes len bytes from the specified byte array  starting at offset off  to this buffered output stream.

write(byte[], int, int). Method in class java.io.ByteArrayOutputStream

 Writes len bytes from the specified byte array  starting at offset off  to this byte array output stream.

write(byte[], int, int). Method in class java.util.zip.CheckedOutputStream

 Writes an array of bytes.

write(byte[], int, int). Method in interface java.io.DataOutput

 Writes len bytes from the specified byte array  starting at offset off  to this output stream.

write(byte[], int, int). Method in class java.io.DataOutputStream

 Writes len bytes from the specified byte array  starting at offset off  to the underlying output stream.

write(byte[], int, int). Method in class java.util.zip.DeflaterOutputStream

 Writes an array of bytes to the compressed output stream.

write(byte[], int, int). Method in class java.security.DigestOutputStream

 Updates the message digest (if the digest function is on) using  the specified subarray, and in any case writes the subarray to  the output stream.

write(byte[], int, int). Method in class java.io.FileOutputStream

 Writes len bytes from the specified byte array  starting at offset off  to this file output stream.

write(byte[], int, int). Method in class java.io.FilterOutputStream

 Writes len bytes from the specified  byte array starting at offset off to  this output stream.

write(byte[], int, int). Method in class java.util.zip.GZIPOutputStream

 Writes array of bytes to the compressed output stream.

write(byte[], int, int). Method in class java.rmi.server.LogStream

 Write a subarray of bytes.

write(byte[], int, int). Method in interface java.io.ObjectOutput

 Writes a sub array of bytes.

write(byte[], int, int). Method in class java.io.ObjectOutputStream

 Writes a sub array of bytes.

write(byte[], int, int). Method in class java.io.OutputStream

 Writes len bytes from the specified byte array  starting at offset off  to this output stream.

write(byte[], int, int). Method in class java.io.PipedOutputStream

 Writes len bytes from the specified byte array  starting at offset off  to this piped output stream.

write(byte[], int, int). Method in class java.io.PrintStream

 Writes a portion of the specified byte array, blocking if necessary.

write(byte[], int, int). Method in class java.io.RandomAccessFile

 Writes len bytes from the specified byte array  starting at offset off  to this file.

write(byte[], int, int). Method in class java.util.zip.ZipOutputStream

 Writes an array of bytes to the current ZIP entry data.

write(char[]). Method in class java.io.PrintWriter

 Write an array of characters.

write(char[]). Method in class java.io.Writer

 Write an array of characters.

write(char[], int, int). Method in class java.io.BufferedWriter

 Write a portion of an array of characters.

write(char[], int, int). Method in class java.io.CharArrayWriter

 Writes characters to the buffer.

write(char[], int, int). Method in class java.io.FilterWriter

 Write a portion of an array of characters.

write(char[], int, int). Method in class java.io.OutputStreamWriter

 Write a portion of an array of characters.

write(char[], int, int). Method in class java.io.PipedWriter

 Write a portion of an array of characters.

write(char[], int, int). Method in class java.io.PrintWriter

 Write a portion of an array of characters.

write(char[], int, int). Method in class java.io.StringWriter

 Write a portion of an array of characters.

write(char[], int, int). Method in class java.io.Writer

 Write a portion of an array of characters.

write(DataOutput). Method in class java.rmi.server.UID

 Write uid to output stream.

write(int). Method in class java.io.BufferedOutputStream

 Writes the specified byte to this buffered output stream.

write(int). Method in class java.io.BufferedWriter

 Write a single character.

write(int). Method in class java.io.ByteArrayOutputStream

 Writes the specified byte to this byte array output stream.

write(int). Method in class java.io.CharArrayWriter

 Writes a character to the buffer.

write(int). Method in class java.util.zip.CheckedOutputStream

 Writes a byte.

write(int). Method in interface java.io.DataOutput

 Writes the specified byte to this data output stream.

write(int). Method in class java.io.DataOutputStream

 Writes the specified byte to the underlying output stream.

write(int). Method in class java.util.zip.DeflaterOutputStream

 Writes a byte to the compressed output stream.

write(int). Method in class java.security.DigestOutputStream

 Updates the message digest (if the digest function is on) using  the specified byte, and in any case writes the byte  to the output stream.

write(int). Method in class java.io.FileOutputStream

 Writes the specified byte to this file output stream.

write(int). Method in class java.io.FilterOutputStream

 Writes the specified byte to this output stream.

write(int). Method in class java.io.FilterWriter

 Write a single character.

write(int). Method in class java.rmi.server.LogStream

 Write a byte of data to the stream.

write(int). Method in interface java.io.ObjectOutput

 Writes a byte.

write(int). Method in class java.io.ObjectOutputStream

 Writes a byte.

write(int). Method in class java.io.OutputStream

 Writes the specified byte to this output stream.

write(int). Method in class java.io.OutputStreamWriter

 Write a single character.

write(int). Method in class java.io.PipedOutputStream

 Writes the specified byte to the piped output stream.

write(int). Method in class java.io.PrintStream

 Writes the specified byte to this print stream.

write(int). Method in class java.io.PrintWriter

 Write a single character.

write(int). Method in class java.io.RandomAccessFile

 Writes the specified byte to this file.

write(int). Method in class java.io.StringWriter

 Write a single character.

write(int). Method in class java.io.Writer

 Write a single character.

write(ObjectOutput). Method in class java.rmi.server.ObjID

 Marshal object id to output stream.

write(String). Method in class java.io.PrintWriter

 Write a string.

write(String). Method in class java.io.StringWriter

 Write a string.

write(String). Method in class java.io.Writer

 Write a string.

write(String, int, int). Method in class java.io.BufferedWriter

 Write a portion of a String.

write(String, int, int). Method in class java.io.CharArrayWriter

 Write a portion of a string to the buffer.

write(String, int, int). Method in class java.io.FilterWriter

 Write a portion of a string.

write(String, int, int). Method in class java.io.OutputStreamWriter

 Write a portion of a string.

write(String, int, int). Method in class java.io.PrintWriter

 Write a portion of a string.

write(String, int, int). Method in class java.io.StringWriter

 Write a portion of a string.

write(String, int, int). Method in class java.io.Writer

 Write a portion of a string.

WriteAbortedException(String, Exception). Constructor for class java.io. WriteAbortedException

 A WriteAbortedException is thrown during a read when one of the  ObjectStreamExceptions was thrown during writing.

writeBoolean(boolean). Method in interface java.io.DataOutput

 Writes a boolean value to this output stream.

writeBoolean(boolean). Method in class java.io.DataOutputStream

 Writes a boolean to the underlying output stream as  a 1-byte value.

writeBoolean(boolean). Method in class java.io.ObjectOutputStream

 Writes a boolean.

writeBoolean(boolean). Method in class java.io.RandomAccessFile

 Writes a boolean to the file as a 1-byte value.

writeByte(int). Method in interface java.io.DataOutput

 Writes an 8-bit value to this output stream.

writeByte(int). Method in class java.io.DataOutputStream

 Writes out a byte to the underlying output stream as  a 1-byte value.

writeByte(int). Method in class java.io.ObjectOutputStream

 Writes an 8 bit byte.

writeByte(int). Method in class java.io.RandomAccessFile

 Writes a byte to the file as a 1-byte value.

writeBytes(String). Method in interface java.io.DataOutput

 Writes a string to this output stream.

writeBytes(String). Method in class java.io.DataOutputStream

 Writes out the string to the underlying output stream as a  sequence of bytes.

writeBytes(String). Method in class java.io.ObjectOutputStream

 Writes a String as a sequence of bytes.

writeBytes(String). Method in class java.io.RandomAccessFile

 Writes the string to the file as a sequence of bytes.

writeChar(int). Method in interface java.io.DataOutput

 Writes a char value to this output stream.

writeChar(int). Method in class java.io.DataOutputStream

 Writes a char to the underlying output stream as a  2-byte value, high byte first.

writeChar(int). Method in class java.io.ObjectOutputStream

 Writes a 16 bit char.

writeChar(int). Method in class java.io.RandomAccessFile

 Writes a char to the file as a 2-byte value, high  byte first.

writeChars(String). Method in interface java.io.DataOutput

 Writes a string to this output stream.

writeChars(String). Method in class java.io.DataOutputStream

 Writes a string to the underlying output stream as a sequence of  characters.

writeChars(String). Method in class java.io.ObjectOutputStream

 Writes a String as a sequence of chars.

writeChars(String). Method in class java.io.RandomAccessFile

 Writes a string to the file as a sequence of characters.

writeDouble(double). Method in interface java.io.DataOutput

 Writes a double value to this output stream.

writeDouble(double). Method in class java.io.DataOutputStream

 Converts the double argument to a long using the  doubleToLongBits  method in class Double,  and then writes that long  value to the underlying  output stream as an 8-byte quantity, high byte first.

writeDouble(double). Method in class java.io.ObjectOutputStream

 Writes a 64 bit double.

writeDouble(double). Method in class java.io.RandomAccessFile

 Converts the double argument to a long using the  doubleToLongBits  method in class Double,  and then writes that long  value to the file as an  8-byte quantity, high byte first.

writeExternal(ObjectOutput). Method in interface java.io.Externalizable

 The object implements the writeExternal method to save its contents  by calling the methods of DataOutput for its primitive values or  calling the writeObject method of ObjectOutput for objects, strings  and arrays.

writeFloat(float). Method in interface java.io.DataOutput

 Writes a float value to this output stream.

writeFloat(float). Method in class java.io.DataOutputStream

 Converts the float argument to an int using the  floatToIntBits  method in class Float,  and then writes that int value to the underlying  output stream as a 4-byte quantity, high byte first.

writeFloat(float). Method in class java.io.ObjectOutputStream

 Writes a 32 bit float.

writeFloat(float). Method in class java.io.RandomAccessFile

 Converts the float argument to an int using the  floatToIntBits  method in class Float,  and then writes that int value to the file as a  4-byte quantity, high byte first.

writeInt(int). Method in interface java.io.DataOutput

 Writes an int value to this output stream.

writeInt(int). Method in class java.io.DataOutputStream

 Writes an int to the underlying output stream as four  bytes, high byte first.

writeInt(int). Method in class java.io.ObjectOutputStream

 Writes a 32 bit int.

writeInt(int). Method in class java.io.RandomAccessFile

 Writes an int to the file as four bytes, high byte first.

writeLong(long). Method in interface java.io.DataOutput

 Writes a long value to this output stream.

writeLong(long). Method in class java.io.DataOutputStream

 Writes a long to the underlying output stream as eight  bytes, high byte first.

writeLong(long). Method in class java.io.ObjectOutputStream

 Writes a 64 bit long.

writeLong(long). Method in class java.io.RandomAccessFile

 Writes a long to the file as eight bytes, high byte first.

writeObject(Object). Method in interface java.io.ObjectOutput

 Write an object to the underlying storage or stream.

writeObject(Object). Method in class java.io.ObjectOutputStream

 Write the specified object to the ObjectOutputStream.

Writer(). Constructor for class java.io.Writer

 Create a new character-stream writer whose critical sections will  synchronize on the writer itself.

Writer(Object). Constructor for class java.io.Writer

 Create a new character-stream writer whose critical sections will  synchronize on the given object.

writeShort(int). Method in interface java.io.DataOutput

 Writes a 16-bit value to this output stream.

writeShort(int). Method in class java.io.DataOutputStream

 Writes a short to the underlying output stream as two  bytes, high byte first.

writeShort(int). Method in class java.io.ObjectOutputStream

 Writes a 16 bit short.

writeShort(int). Method in class java.io.RandomAccessFile

 Writes a short to the file as two bytes, high byte first.

writeStreamHeader(). Method in class java.io.ObjectOutputStream

 The writeStreamHeader method is provided so subclasses can  append or prepend their own header to the stream.

writeTo(OutputStream). Method in class java.io.ByteArrayOutputStream

 Writes the complete contents of this byte array output stream to  the specified output stream argument, as if by calling the output  stream's write method using out.write(buf, 0, count).

writeTo(Writer). Method in class java.io.CharArrayWriter

 Writes the contents of the buffer to another character stream.

writeUTF(String). Method in interface java.io.DataOutput

 Writes a Unicode string by encoding it using modified UTF-8 format.

writeUTF(String). Method in class java.io.DataOutputStream

 Writes a string to the underlying output stream using UTF-8  encoding in a machine-independent manner.

writeUTF(String). Method in class java.io.ObjectOutputStream

 Writes a String in UTF format.

writeUTF(String). Method in class java.io.RandomAccessFile

 Writes a string to the file using UTF-8 encoding in a  machine-independent manner.

written. Variable in class java.io.DataOutputStream

 The number of bytes written to the data output stream.

______________________________________________________________________________

  X

x. Variable in class java.awt.Event

 The x coordinate of the event.

x. Variable in class java.awt.Point

 The x coordinate.

x. Variable in class java.awt.Rectangle

 The x coordinate of the rectangle.

xor(BigInteger). Method in class java.math.BigInteger

 Returns a BigInteger whose value is (this ^ val).

xor(BitSet). Method in class java.util.BitSet

 Performs a logical XOR of this bit set with the bit set  argument.

xpoints. Variable in class java.awt.Polygon

 The array of x coordinates.

______________________________________________________________________________

  Y

y. Variable in class java.awt.Event

 The y coordinate of the event.

y. Variable in class java.awt.Point

 The y coordinate.

y. Variable in class java.awt.Rectangle

 The y coordinate of the rectangle.

YEAR. Static variable in class java.util.Calendar

 Useful constant for date and time.

YEAR_FIELD. Static variable in class java.text.DateFormat

 Useful constant for YEAR field alignment.

yellow. Static variable in class java.awt.Color

 The color yellow.

yield(). Static method in class java.lang.Thread

 Causes the currently executing thread object to temporarily pause  and allow other threads to execute.

ypoints. Variable in class java.awt.Polygon

 The array of y coordinates.

Generated using an evaluation version of HyperAct HTMheLp


 API User's Guide

 Java API

Java Application Programming Interface

User's Guide

How the API Is Organized

There are three levels to the API:

• All Packages

• All Classes (within a package)

• This Class (selected class).

Level 1 - All Packages

This level of the API provides links to the packages in the 1.0 release.

Level 2 - This Package

 This level provides links to the classes and interfaces in a given package. There are three catogories in the listing:

• Interfaces

• Classes

• Exceptions

Level 3 - This Class/Interface

 This level begins with an index, followed by the detailed API. There are three categories at the class level.

• Variables

• Constructors

• Methods

A category is omitted when a class has no applicable entries.

Within these categories there is additional color coding as follows:

 Instance Variables

 Static Variables

 Constructors

 Instance Methods

 Static Methods

How to Locate Items

• To Browse A Package

• Select a package from the list of All Packages. 	This list is the home page for the the Java API.

• To Locate a Class

• Use the searchable index tool.

• Or, select its package.

• Select the class from the alphabetical index.

• To Browse a Class

• Use the Next/Previous anchors to browse alphabetically.

• Or, traverse the links within the class.

• To Locate a Method

• Use the searchable index tool.

• Or, scroll through the alphabetical class index to locate a method.

A Closer Look at the Class-Level API

 Take a look at class String in the package java.lang. The navigational anchors are at the top. This is followed by the fully qualified class name and a representation of its position in the class hierarchy.

The next entries are links to the superclass and the interfaces, if any. This is followed by a description of the class, taken from the class comment. Notice how the programmer has embedded some code samples using html tags.

The author also chose to include a See Also entry to another class. Following the class-level entries for See Also, Version, and Author, the index begins.

The Index

 Each class/interface begins with an index of its variables, constructors and methods, sorted alphabetically. The entry consists of the declaration and short description. The description is the first sentence of the doc comment for that item. The index e ntries are linked to their corresponding entries in the application programming inteface which immediately follows.

The Detailed API

The index is followed by the complete API for each entry. Within the three categories: Variables, Constructors, and Methods, the entries are presented in the order they  appear in the source. This is done to preserve the logical groupings established by the programmer.

Where Are All the Links in the API?

• At the top of each class/interface there are navigational anchors to the other levels and to Previous and Next (class or interface).

• There are links in the class type of every method and variable definition.

• At the top of each class/interface there is a drawing of the tree structure down to the current class/interface, in which each superclass is a link.

• Every method contains a list of exceptions that it may throw. These are linked to the appropriate class.

• The superclass and interface references at the beginning of the class are links.

• Every See Also is a link.

• When a method overrides a method in the superclass, the API has the entry "Overrides: foo in class bar." Both foo (the method name) and bar (the class name) are links.

______________________________________________________________________________

Generated using an evaluation version of HyperAct HTMheLp


  Class java.applet.Applet

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class java.applet.Applet

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Panel
                           |
                           +----java.applet.Applet

______________________________________________________________________________

 public class Applet

 extends Panel

An applet is a small program that is intended not to be run on  its own, but rather to be embedded inside another application.

 The Applet class must be the superclass of any  applet that is to be embedded in a Web page or viewed by the Java  Applet Viewer. The Applet class provides a standard  interface between applets and their environment.

______________________________________________________________________________

 	Applet()

 	destroy()

 Called by the browser or applet viewer to inform  this applet that it is being reclaimed and that it should destroy  any resources that it has allocated.

 	getAppletContext()

 Determines this applet's context, which allows the applet to  query and affect the environment in which it runs.

 	getAppletInfo()

 Returns information about this applet.

 	getAudioClip(URL)

 Returns the AudioClip object specified by the  URL argument.

 	getAudioClip(URL, String)

 Returns the AudioClip object specified by the  URL and name  arguments.

 	getCodeBase()

 Gets the base URL.

 	getDocumentBase()

 Gets the document URL.

 	getImage(URL)

 Returns an Image object that can then be painted on  the screen.

 	getImage(URL, String)

 Returns an Image object that can then be painted on  the screen.

 	getLocale()

 Gets the Locale for the applet, if it has been set.

 	getParameter(String)

 Returns the value of the named parameter in the HTML tag.

 	getParameterInfo()

 Returns information about the parameters than are understood by  this applet.

 	init()

 Called by the browser or applet viewer to inform  this applet that it has been loaded into the system.

 	isActive()

 Determines if this applet is active.

 	play(URL)

 Plays the audio clip at the specified absolute URL.

 	play(URL, String)

 Plays the audio clip given the URL and a specifier that is  relative to it.

 	resize(Dimension)

 Requests that this applet be resized.

 	resize(int, int)

 Requests that this applet be resized.

 	setStub(AppletStub)

 Sets this applet's stub.

 	showStatus(String)

 Requests that the argument string be displayed in the  "status window".

 	start()

 Called by the browser or applet viewer to inform  this applet that it should start its execution.

 	stop()

 Called by the browser or applet viewer to inform  this applet that it should stop its execution.

 Applet

  public Applet()

 setStub

  public final void setStub(AppletStub stub)

 Sets this applet's stub. This is done automatically by the system.

Parameters:

 stub - the new stub.

 isActive

  public boolean isActive()

 Determines if this applet is active. An applet is marked active  just before its start method is called. It becomes  inactive immediately after its stop method is called.

Returns:

true if the applet is active;  false otherwise.

See Also:

start, stop

 getDocumentBase

  public URL getDocumentBase()

 Gets the document URL. This is the URL of the document in which  the applet is embedded.

Returns:

 the URL of  the document that contains this applet.

See Also:

getCodeBase

 getCodeBase

  public URL getCodeBase()

 Gets the base URL. This is the URL of the applet itself.

Returns:

 the URL of  this applet.

See Also:

getDocumentBase

 getParameter

  public String getParameter(String name)

 Returns the value of the named parameter in the HTML tag. For  example, if this applet is specified as

 	<applet code="Clock" width=50 height=50>
 <param name=Color value="blue">
 </applet>

 then a call to getParameter("Color") returns the  value "blue".

 The name argument is case insensitive.

Parameters:

 name - a parameter name.

Returns:

 the value of the named parameter.

 getAppletContext

  public AppletContext getAppletContext()

 Determines this applet's context, which allows the applet to  query and affect the environment in which it runs.

 This environment of an applet represents the document that  contains the applet.

Returns:

 the applet's context.

 resize

  public void resize(int width,
                     int height)

 Requests that this applet be resized.

Parameters:

 width - the new requested width for the applet.

 height - the new requested height for the applet.

Overrides:

resize in class Component

 resize

  public void resize(Dimension d)

 Requests that this applet be resized.

Parameters:

 d - an object giving the new width and height.

Overrides:

resize in class Component

 showStatus

  public void showStatus(String msg)

 Requests that the argument string be displayed in the  "status window". Many browsers and applet viewers  provide such a window, where the application can inform users of  its current state.

Parameters:

 msg - a string to display in the status window.

 getImage

  public Image getImage(URL url)

 Returns an Image object that can then be painted on  the screen. The url that is passed as an argument  must specify an absolute URL.

 This method always returns immediately, whether or not the image  exists. When this applet attempts to draw the image on the screen,  the data will be loaded. The graphics primitives that draw the  image will incrementally paint on the screen.

Parameters:

 url - an absolute URL giving the location of the image.

Returns:

 the image at the specified URL.

See Also:

Image

 getImage

  public Image getImage(URL url,
                        String name)

 Returns an Image object that can then be painted on  the screen. The url argument must specify an absolute  URL. The name  argument is a specifier that is  relative to the url argument.

 This method always returns immediately, whether or not the image  exists. When this applet attempts to draw the image on the screen,  the data will be loaded. The graphics primitives that draw the  image will incrementally paint on the screen.

Parameters:

 url - an absolute URL giving the base location of the image.

 name - the location of the image, relative to the  url argument.

Returns:

 the image at the specified URL.

See Also:

Image

 getAudioClip

  public AudioClip getAudioClip(URL url)

 Returns the AudioClip object specified by the  URL argument.

 This method always returns immediately, whether or not the audio  clip exists. When this applet attempts to play the audio clip, the  data will be loaded.

Parameters:

 url - an absolute URL giving the location of the audio clip.

Returns:

 the audio clip at the specified URL.

See Also:

AudioClip

 getAudioClip

  public AudioClip getAudioClip(URL url,
                                String name)

 Returns the AudioClip object specified by the  URL and name arguments.

 This method always returns immediately, whether or not the audio  clip exists. When this applet attempts to play the audio clip, the  data will be loaded.

Parameters:

 url - an absolute URL giving the base location of the  audio clip.

 name - the location of the audio clip, relative to the  url argument.

Returns:

 the audio clip at the specified URL.

See Also:

AudioClip

 getAppletInfo

  public String getAppletInfo()

 Returns information about this applet. An applet should override  this method to return a String containing information  about the author, version, and copyright of the applet.

 The implementation of this method provided by the  Applet class returns null.

Returns:

 a string containing information about the author, version, and  copyright of the applet.

 getLocale

  public Locale getLocale()

 Gets the Locale for the applet, if it has been set.  If no Locale has been set, then the default Locale  is returned.

Returns:

 [Needs to be documented!]

Overrides:

getLocale in class Component

 getParameterInfo

  public String[][] getParameterInfo()

 Returns information about the parameters than are understood by  this applet. An applet should override this method to return an  array of Strings  describing these parameters.

 Each element of the array should be a set of three  Strings  containing the name, the type, and a  description. For example:

 String pinfo[][] = {
         {"fps",    "1-10",    "frames per second"},
         {"repeat", "boolean", "repeat image loop"},
         {"imgs",   "url",     "images directory"}
 };

 The implementation of this method provided by the  Applet class returns null.

Returns:

 an array describing the parameters this applet looks for.

 play

  public void play(URL url)

 Plays the audio clip at the specified absolute URL. Nothing  happens if the audio clip cannot be found.

Parameters:

 url - an absolute URL giving the location of the audio clip.

 play

  public void play(URL url,
                   String name)

 Plays the audio clip given the URL and a specifier that is  relative to it. Nothing happens if the audio clip cannot be found.

Parameters:

 url - an absolute URL giving the base location of the  audio clip.

 name - the location of the audio clip, relative to the  url argument.

 init

  public void init()

 Called by the browser or applet viewer to inform  this applet that it has been loaded into the system. It is always  called before the first time that the start method is  called.

 A subclass of Applet should override this method if  it has initialization to perform. For example, an applet with  threads would use the init method to create the  threads and the destroy method to kill them.

 The implementation of this method provided by the  Applet class does nothing.

See Also:

destroy, start, stop

 start

  public void start()

 Called by the browser or applet viewer to inform  this applet that it should start its execution. It is called after  the init  method and each time the applet is revisited  in a Web page.

 A subclass of Applet should override this method if  it has any operation that it wants to perform each time the Web  page containing it is visited. For example, an applet with  animation might want to use the start method to  resume animation, and the stop method to suspend the  animation.

 The implementation of this method provided by the  Applet class does nothing.

See Also:

destroy, init, stop

 stop

  public void stop()

 Called by the browser or applet viewer to inform  this applet that it should stop its execution. It is called when  the Web page that contains this applet has been replaced by  another page, and also just before the applet is to be destroyed.

 A subclass of Applet should override this method if  it has any operation that it wants to perform each time the Web  page containing it is no longer visible. For example, an applet  with animation might want to use the start method to  resume animation, and the stop method to suspend the  animation.

 The implementation of this method provided by the  Applet class does nothing.

See Also:

destroy, init

 destroy

  public void destroy()

 Called by the browser or applet viewer to inform  this applet that it is being reclaimed and that it should destroy  any resources that it has allocated. The stop method  will always be called before destroy.

 A subclass of Applet should override this method if  it has any operation that it wants to perform before it is  destroyed. For example, an applet with threads would use the  init  method to create the threads and the  destroy method to kill them.

 The implementation of this method provided by the  Applet class does nothing.

See Also:

init, start, stop

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.applet.AppletContext

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.applet.AppletContext

 public interface AppletContext

This interface corresponds to an applet's environment: the  document containing the applet and the other applets in the same  document.

 The methods in this interface can be used by an applet to obtain  information about its environment.

______________________________________________________________________________

 	getApplet(String)

 Finds and returns the applet in the document represented by this  applet context with the given name.

 	getApplets()

 Finds all the applets in the document represented by this applet  context.

 	getAudioClip(URL)

 Creates an audio clip.

 	getImage(URL)

 Returns an Image object that can then be painted on  the screen.

 	showDocument(URL)

 Replaces the Web page currently being viewed with the given URL.

 	showDocument(URL, String)

 Requests that the browser or applet viewer show the Web page  indicated by the url  argument.

 	showStatus(String)

 Requests that the argument string be displayed in the  "status window".

 getAudioClip

  public abstract AudioClip getAudioClip(URL url)

 Creates an audio clip.

Parameters:

 url - an absolute URL giving the location of the audio clip.

Returns:

 the audio clip at the specified URL.

 getImage

  public abstract Image getImage(URL url)

 Returns an Image object that can then be painted on  the screen. The url argument that is  passed as an argument must specify an absolute URL.

 This method always returns immediately, whether or not the image  exists. When the applet attempts to draw the image on the screen,  the data will be loaded. The graphics primitives that draw the  image will incrementally paint on the screen.

Parameters:

 url - an absolute URL giving the location of the image.

Returns:

 the image at the specified URL.

See Also:

Image

 getApplet

  public abstract Applet getApplet(String name)

 Finds and returns the applet in the document represented by this  applet context with the given name. The name can be set in the  HTML tag by setting the name attribute.

Parameters:

 name - an applet name.

Returns:

 the applet with the given name, or null if  not found.

 getApplets

  public abstract Enumeration getApplets()

 Finds all the applets in the document represented by this applet  context.

Returns:

 an enumeration of all applets in the document represented by  this applet context.

 showDocument

  public abstract void showDocument(URL url)

 Replaces the Web page currently being viewed with the given URL.  This method may be ignored by applet contexts that are not  browsers.

Parameters:

 url - an absolute URL giving the location of the document.

 showDocument

  public abstract void showDocument(URL url,
                                    String target)

 Requests that the browser or applet viewer show the Web page  indicated by the url argument. The  target  argument indicates where to display the frame.  The target argument is interpreted as follows:

"_self"
show in the current frame
"_parent"
show in the parent frame
"_top"
show in the topmost frame
"_blank"
show in a new unnamed  top-level window
name
show in a new top-level window named
name
 An applet viewer or browser is free to ignore showDocument.

Parameters:

 url - an absolute URL giving the location of the document.

 target - a String indicating where to display  the page.

 showStatus

  public abstract void showStatus(String status)

 Requests that the argument string be displayed in the  "status window". Many browsers and applet viewers  provide such a window, where the application can inform users of  its current state.

Parameters:

 status - a string to display in the status window.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.applet.AppletStub

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.applet.AppletStub

 public interface AppletStub

When an applet is first created, an applet stub is attached to it  using the applet's setStub method. This stub  serves as the interface between the applet and the browser  environment or applet viewer environment in which the application  is running.

See Also:

setStub

______________________________________________________________________________

 	appletResize(int, int)

 Called when the applet wants to be resized.

 	getAppletContext()

 Gets a handler to the applet's context.

 	getCodeBase()

 Gets the base URL.

 	getDocumentBase()

 Gets the document URL.

 	getParameter(String)

 Returns the value of the named parameter in the HTML tag.

 	isActive()

 Determines if the applet is active.

 isActive

  public abstract boolean isActive()

 Determines if the applet is active. An applet is active just  before its start method is called. It becomes  inactive immediately after its stop method is called.

Returns:

true if the applet is active;  false otherwise.

 getDocumentBase

  public abstract URL getDocumentBase()

 Gets the document URL.

Returns:

 the URL of the document containing the applet.

 getCodeBase

  public abstract URL getCodeBase()

 Gets the base URL.

Returns:

 the URL of the applet.

 getParameter

  public abstract String getParameter(String name)

 Returns the value of the named parameter in the HTML tag. For  example, if an applet is specified as

 	<applet code="Clock" width=50 height=50>
 <param name=Color value="blue">
 </applet>

 then a call to getParameter("Color") returns the  value "blue".

Parameters:

 name - a parameter name.

Returns:

 the value of the named parameter.

 getAppletContext

  public abstract AppletContext getAppletContext()

 Gets a handler to the applet's context.

Returns:

 the applet's context.

 appletResize

  public abstract void appletResize(int width,
                                    int height)

 Called when the applet wants to be resized.

Parameters:

 width - the new requested width for the applet.

 height - the new requested height for the applet.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.applet.AudioClip

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.applet.AudioClip

 public interface AudioClip

The AudioClip interface is a simple abstraction for  playing a sound clip. Multiple AudioClip items can be  playing at the same time, and the resulting sound is mixed  together to produce a composite.

______________________________________________________________________________

 	loop()

 Starts playing this audio clip in a loop.

 	play()

 Starts playing this audio clip.

 	stop()

 Stops playing this audio clip.

 play

  public abstract void play()

 Starts playing this audio clip. Each time this method is called,  the clip is restarted from the beginning.

 loop

  public abstract void loop()

 Starts playing this audio clip in a loop.

 stop

  public abstract void stop()

 Stops playing this audio clip.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.Adjustable

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.Adjustable

 public interface Adjustable

The interface for objects which have an adjustable numeric value  contained within a bounded range of values.

______________________________________________________________________________

 	HORIZONTAL

 The horizontal orientation.

 	VERTICAL

 The vertical orientation.

 	addAdjustmentListener(AdjustmentListener)

 Add a listener to recieve adjustment events when the value of  the adjustable object changes.

 	getBlockIncrement()

 Gets the block value increment for the adjustable object.

 	getMaximum()

 Gets the maximum value of the adjustable object.

 	getMinimum()

 Gets the minimum value of the adjustable object.

 	getOrientation()

 Gets the orientation of the adjustable object.

 	getUnitIncrement()

 Gets the unit value increment for the adjustable object.

 	getValue()

 Gets the current value of the adjustable object.

 	getVisibleAmount()

 Gets the length of the propertional indicator.

 	removeAdjustmentListener(AdjustmentListener)

 Removes an adjustment listener.

 	setBlockIncrement(int)

 Sets the block value increment for the adjustable object.

 	setMaximum(int)

 Sets the maximum value of the adjustable object.

 	setMinimum(int)

 Sets the minimum value of the adjustable object.

 	setUnitIncrement(int)

 Sets the unit value increment for the adjustable object.

 	setValue(int)

 Sets the current value of the adjustable object.

 	setVisibleAmount(int)

 Sets the length of the proportionl indicator of the  adjustable object.

 HORIZONTAL

  public final static int HORIZONTAL

 The horizontal orientation.

 VERTICAL

  public final static int VERTICAL

 The vertical orientation.

 getOrientation

  public abstract int getOrientation()

 Gets the orientation of the adjustable object.

 setMinimum

  public abstract void setMinimum(int min)

 Sets the minimum value of the adjustable object.

Parameters:

 min - the minimum value

 getMinimum

  public abstract int getMinimum()

 Gets the minimum value of the adjustable object.

 setMaximum

  public abstract void setMaximum(int max)

 Sets the maximum value of the adjustable object.

Parameters:

 max - the maximum value

 getMaximum

  public abstract int getMaximum()

 Gets the maximum value of the adjustable object.

 setUnitIncrement

  public abstract void setUnitIncrement(int u)

 Sets the unit value increment for the adjustable object.

Parameters:

 u - the unit increment

 getUnitIncrement

  public abstract int getUnitIncrement()

 Gets the unit value increment for the adjustable object.

 setBlockIncrement

  public abstract void setBlockIncrement(int b)

 Sets the block value increment for the adjustable object.

Parameters:

 b - the block increment

 getBlockIncrement

  public abstract int getBlockIncrement()

 Gets the block value increment for the adjustable object.

 setVisibleAmount

  public abstract void setVisibleAmount(int v)

 Sets the length of the proportionl indicator of the  adjustable object.

Parameters:

 v - the length of the indicator

 getVisibleAmount

  public abstract int getVisibleAmount()

 Gets the length of the propertional indicator.

 setValue

  public abstract void setValue(int v)

 Sets the current value of the adjustable object. This  value must be within the range defined by the minimum and  maximum values for this object.

Parameters:

 v - the current value

 getValue

  public abstract int getValue()

 Gets the current value of the adjustable object.

 addAdjustmentListener

  public abstract void addAdjustmentListener(AdjustmentListener l)

 Add a listener to recieve adjustment events when the value of  the adjustable object changes.

Parameters:

 l - the listener to recieve events

See Also:

AdjustmentEvent

 removeAdjustmentListener

  public abstract void removeAdjustmentListener(AdjustmentListener l)

 Removes an adjustment listener.

Parameters:

 l - the listener being removed

See Also:

AdjustmentEvent

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.AWTError

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class java.awt.AWTError

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Error
                   |
                   +----java.awt.AWTError

______________________________________________________________________________

 public class AWTError

 extends Error

An AWT Error.

______________________________________________________________________________

 	AWTError(String)

 AWTError

  public AWTError(String msg)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.AWTEvent

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.AWTEvent

java.lang.Object
   |
   +----java.util.EventObject
           |
           +----java.awt.AWTEvent

______________________________________________________________________________

 public class AWTEvent

 extends EventObject

The root event class for all AWT events.  This class and its subclasses supercede the original  java.awt.Event class.  The event masks defined in this class are needed ONLY by  component subclasses which are using Component.enableEvents()  to select for event types not selected by registered listeners.  If a listener is registered on a component, the appropriate event  mask is already set internally by the component.

See Also:

enableEvents, ComponentEvent, FocusEvent, KeyEvent, MouseEvent, WindowEvent, ActionEvent, AdjustmentEvent, ItemEvent, TextEvent

______________________________________________________________________________

 	ACTION_EVENT_MASK

 The event mask for selecting action events.

 	ADJUSTMENT_EVENT_MASK

 The event mask for selecting adjustment events.

 	COMPONENT_EVENT_MASK

 The event mask for selecting component events.

 	consumed

  	CONTAINER_EVENT_MASK

 The event mask for selecting container events.

 	FOCUS_EVENT_MASK

 The event mask for selecting focus events.

 	id

  	ITEM_EVENT_MASK

 The event mask for selecting item events.

 	KEY_EVENT_MASK

 The event mask for selecting key events.

 	MOUSE_EVENT_MASK

 The event mask for selecting mouse events.

 	MOUSE_MOTION_EVENT_MASK

 The event mask for selecting mouse motion events.

 	TEXT_EVENT_MASK

 The event mask for selecting text events.

 	WINDOW_EVENT_MASK

 The event mask for selecting window events.

 	AWTEvent(Event)

 Constructs an AWTEvent object from the parameters of a 1.0-style event.

 	AWTEvent(Object, int)

 Constructs an AWTEvent object with the specified source object and type.

 	consume()

  	getID()

 Returns the event type.

 	isConsumed()

  	paramString()

  	toString()

 Returns a string representation of the object.

 id

  protected int id

 consumed

  protected boolean consumed

 COMPONENT_EVENT_MASK

  public final static long COMPONENT_EVENT_MASK

 The event mask for selecting component events.

 CONTAINER_EVENT_MASK

  public final static long CONTAINER_EVENT_MASK

 The event mask for selecting container events.

 FOCUS_EVENT_MASK

  public final static long FOCUS_EVENT_MASK

 The event mask for selecting focus events.

 KEY_EVENT_MASK

  public final static long KEY_EVENT_MASK

 The event mask for selecting key events.

 MOUSE_EVENT_MASK

  public final static long MOUSE_EVENT_MASK

 The event mask for selecting mouse events.

 MOUSE_MOTION_EVENT_MASK

  public final static long MOUSE_MOTION_EVENT_MASK

 The event mask for selecting mouse motion events.

 WINDOW_EVENT_MASK

  public final static long WINDOW_EVENT_MASK

 The event mask for selecting window events.

 ACTION_EVENT_MASK

  public final static long ACTION_EVENT_MASK

 The event mask for selecting action events.

 ADJUSTMENT_EVENT_MASK

  public final static long ADJUSTMENT_EVENT_MASK

 The event mask for selecting adjustment events.

 ITEM_EVENT_MASK

  public final static long ITEM_EVENT_MASK

 The event mask for selecting item events.

 TEXT_EVENT_MASK

  public final static long TEXT_EVENT_MASK

 The event mask for selecting text events.

 AWTEvent

  public AWTEvent(Event event)

 Constructs an AWTEvent object from the parameters of a 1.0-style event.

Parameters:

 event - the old-style event

 AWTEvent

  public AWTEvent(Object source,
                  int id)

 Constructs an AWTEvent object with the specified source object and type.

Parameters:

 source - the object where the event originated

 getID

  public int getID()

 Returns the event type.

 toString

  public String toString()

 Returns a string representation of the object.

Overrides:

toString in class EventObject

 paramString

  public String paramString()

 consume

  protected void consume()

 isConsumed

  protected boolean isConsumed()

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.AWTEventMulticaster

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.AWTEventMulticaster

java.lang.Object
   |
   +----java.awt.AWTEventMulticaster

______________________________________________________________________________

 public class AWTEventMulticaster

 extends Object

 implements ComponentListener, ContainerListener, FocusListener, KeyListener, MouseListener, MouseMotionListener, WindowListener , ActionListener, ItemListener, AdjustmentListener, TextListener

A class which implements efficient multi-cast event dispatching  for the AWT events defined in the java.awt.event package. This  class will manage the structure of a chain of event listeners  and dispatch events to those listeners.  An example of how this class could be used to implement a new  component which fires "action" events:

 public myComponent extends Component {
     ActionListener actionListener = null;
     public void addActionListener(ActionListener l) {
           actionListener = AWTEventMulticaster.add(actionListener, l);
     }
     public void removeActionListener(ActionListener l) {
           actionListener = AWTEventMulticaster.remove(actionListener, l);
     }
     public void processEvent(AWTEvent e) {
         // when event occurs which causes "action" semantic
         if (actionListener != null) {
             actionListener.actionPerformed(new ActionEvent());
         }
 }

______________________________________________________________________________

 	a

  	b

 	AWTEventMulticaster(EventListener, EventListener)

 Creates an event multicaster instance which chains listener-a  with listener-b.

 	actionPerformed(ActionEvent)

 Handles the actionPerformed event by invoking the  actionPerformed methods on listener-a and listener-b.

 	add(ActionListener, ActionListener)

 Adds action-listener-a with action-listener-b and  returns the resulting multicast listener.

 	add(AdjustmentListener, AdjustmentListener)

 Adds adjustment-listener-a with adjustment-listener-b and  returns the resulting multicast listener.

 	add(ComponentListener, ComponentListener)

 Adds component-listener-a with component-listener-b and  returns the resulting multicast listener.

 	add(ContainerListener, ContainerListener)

 Adds container-listener-a with container-listener-b and  returns the resulting multicast listener.

 	add(FocusListener, FocusListener)

 Adds focus-listener-a with focus-listener-b and  returns the resulting multicast listener.

 	add(ItemListener, ItemListener)

 Adds item-listener-a with item-listener-b and  returns the resulting multicast listener.

 	add(KeyListener, KeyListener)

 Adds key-listener-a with key-listener-b and  returns the resulting multicast listener.

 	add(MouseListener, MouseListener)

 Adds mouse-listener-a with mouse-listener-b and  returns the resulting multicast listener.

 	add(MouseMotionListener, MouseMotionListener)

 Adds mouse-motion-listener-a with mouse-motion-listener-b and  returns the resulting multicast listener.

 	add(TextListener, TextListener)

  	add (WindowListener, WindowListener)

 Adds window-listener-a with window-listener-b and  returns the resulting multicast listener.

 	addInternal(EventListener, EventListener)

 Returns the resulting multicast listener from adding listener-a  and listener-b together.

 	adjustmentValueChanged(AdjustmentEvent)

 Handles the adjustmentValueChanged event by invoking the  adjustmentValueChanged methods on listener-a and listener-b.

 	componentAdded(ContainerEvent)

 Handles the componentAdded container event by invoking the  componentAdded methods on listener-a and listener-b.

 	componentHidden(ComponentEvent)

 Handles the componentHidden event by invoking the  componentHidden methods on listener-a and listener-b.

 	componentMoved(ComponentEvent)

 Handles the componentMoved event by invoking the  componentMoved methods on listener-a and listener-b.

 	componentRemoved(ContainerEvent)

 Handles the componentRemoved container event by invoking the  componentRemoved methods on listener-a and listener-b.

 	componentResized(ComponentEvent)

 Handles the componentResized event by invoking the  componentResized methods on listener-a and listener-b.

 	componentShown(ComponentEvent)

 Handles the componentShown event by invoking the  componentShown methods on listener-a and listener-b.

 	focusGained(FocusEvent)

 Handles the focusGained event by invoking the  focusGained methods on listener-a and listener-b.

 	focusLost(FocusEvent)

 Handles the focusLost event by invoking the  focusLost methods on listener-a and listener-b.

 	itemStateChanged(ItemEvent)

 Handles the itemStateChanged event by invoking the  itemStateChanged methods on listener-a and listener-b.

 	keyPressed(KeyEvent)

 Handles the keyPressed event by invoking the  keyPressed methods on listener-a and listener-b.

 	keyReleased(KeyEvent)

 Handles the keyReleased event by invoking the  keyReleased methods on listener-a and listener-b.

 	keyTyped(KeyEvent)

 Handles the keyTyped event by invoking the  keyTyped methods on listener-a and listener-b.

 	mouseClicked(MouseEvent)

 Handles the mouseClicked event by invoking the  mouseClicked methods on listener-a and listener-b.

 	mouseDragged(MouseEvent)

 Handles the mouseDragged event by invoking the  mouseDragged methods on listener-a and listener-b.

 	mouseEntered(MouseEvent)

 Handles the mouseEntered event by invoking the  mouseEntered methods on listener-a and listener-b.

 	mouseExited(MouseEvent)

 Handles the mouseExited event by invoking the  mouseExited methods on listener-a and listener-b.

 	mouseMoved(MouseEvent)

 Handles the mouseMoved event by invoking the  mouseMoved methods on listener-a and listener-b.

 	mousePressed(MouseEvent)

 Handles the mousePressed event by invoking the  mousePressed methods on listener-a and listener-b.

 	mouseReleased(MouseEvent)

 Handles the mouseReleased event by invoking the  mouseReleased methods on listener-a and listener-b.

 	remove(ActionListener, ActionListener)

 Removes the old action-listener from action-listener-l and  returns the resulting multicast listener.

 	remove(AdjustmentListener, AdjustmentListener)

 Removes the old adjustment-listener from adjustment-listener-l and  returns the resulting multicast listener.

 	remove(ComponentListener, ComponentListener)

 Removes the old component-listener from component-listener-l and  returns the resulting multicast listener.

 	remove(ContainerListener, ContainerListener)

 Removes the old container-listener from container-listener-l and  returns the resulting multicast listener.

 	remove(EventListener)

 Removes a listener from this multicaster and returns the  resulting multicast listener.

 	remove(FocusListener, FocusListener)

 Removes the old focus-listener from focus-listener-l and  returns the resulting multicast listener.

 	remove(ItemListener, ItemListener)

 Removes the old item-listener from item-listener-l and  returns the resulting multicast listener.

 	remove(KeyListener, KeyListener)

 Removes the old key-listener from key-listener-l and  returns the resulting multicast listener.

 	remove(MouseListener, MouseListener)

 Removes the old mouse-listener from mouse-listener-l and  returns the resulting multicast listener.

 	remove(MouseMotionListener, MouseMotionListener)

 Removes the old mouse-motion-listener from mouse-motion-listener-l  and returns the resulting multicast listener.

 	remove(TextListener, TextListener)

  	remove (WindowListener, WindowListener)

 Removes the old window-listener from window-listener-l and  returns the resulting multicast listener.

 	removeInternal(EventListener, EventListener)

 Returns the resulting multicast listener after removing the  old listener from listener-l.

 	saveInternal(ObjectOutputStream, String)

  	textValueChanged(TextEvent)

  	windowActivated(WindowEvent)

 Handles the windowActivated event by invoking the  windowActivated methods on listener-a and listener-b.

 	windowClosed(WindowEvent)

 Handles the windowClosed event by invoking the  windowClosed methods on listener-a and listener-b.

 	windowClosing(WindowEvent)

 Handles the windowClosing event by invoking the  windowClosing methods on listener-a and listener-b.

 	windowDeactivated(WindowEvent)

 Handles the windowDeactivated event by invoking the  windowDeactivated methods on listener-a and listener-b.

 	windowDeiconified(WindowEvent)

 Handles the windowDeiconfied event by invoking the  windowDeiconified methods on listener-a and listener-b.

 	windowIconified(WindowEvent)

 Handles the windowIconified event by invoking the  windowIconified methods on listener-a and listener-b.

 	windowOpened(WindowEvent)

 Handles the windowOpened event by invoking the  windowOpened methods on listener-a and listener-b.

 a

  protected EventListener a

 b

  protected EventListener b

 AWTEventMulticaster

  protected AWTEventMulticaster(EventListener a,
                                EventListener b)

 Creates an event multicaster instance which chains listener-a  with listener-b.

Parameters:

 a - listener-a

 b - listener-b

 remove

  protected EventListener remove(EventListener oldl)

 Removes a listener from this multicaster and returns the  resulting multicast listener.

Parameters:

 oldl - the listener to be removed

 componentResized

  public void componentResized(ComponentEvent e)

 Handles the componentResized event by invoking the  componentResized methods on listener-a and listener-b.

Parameters:

 e - the component event

 componentMoved

  public void componentMoved(ComponentEvent e)

 Handles the componentMoved event by invoking the  componentMoved methods on listener-a and listener-b.

Parameters:

 e - the component event

 componentShown

  public void componentShown(ComponentEvent e)

 Handles the componentShown event by invoking the  componentShown methods on listener-a and listener-b.

Parameters:

 e - the component event

 componentHidden

  public void componentHidden(ComponentEvent e)

 Handles the componentHidden event by invoking the  componentHidden methods on listener-a and listener-b.

Parameters:

 e - the component event

 componentAdded

  public void componentAdded(ContainerEvent e)

 Handles the componentAdded container event by invoking the  componentAdded methods on listener-a and listener-b.

Parameters:

 e - the component event

 componentRemoved

  public void componentRemoved(ContainerEvent e)

 Handles the componentRemoved container event by invoking the  componentRemoved methods on listener-a and listener-b.

Parameters:

 e - the component event

 focusGained

  public void focusGained(FocusEvent e)

 Handles the focusGained event by invoking the  focusGained methods on listener-a and listener-b.

Parameters:

 e - the focus event

 focusLost

  public void focusLost(FocusEvent e)

 Handles the focusLost event by invoking the  focusLost methods on listener-a and listener-b.

Parameters:

 e - the focus event

 keyTyped

  public void keyTyped(KeyEvent e)

 Handles the keyTyped event by invoking the  keyTyped methods on listener-a and listener-b.

Parameters:

 e - the key event

 keyPressed

  public void keyPressed(KeyEvent e)

 Handles the keyPressed event by invoking the  keyPressed methods on listener-a and listener-b.

Parameters:

 e - the key event

 keyReleased

  public void keyReleased(KeyEvent e)

 Handles the keyReleased event by invoking the  keyReleased methods on listener-a and listener-b.

Parameters:

 e - the key event

 mouseClicked

  public void mouseClicked(MouseEvent e)

 Handles the mouseClicked event by invoking the  mouseClicked methods on listener-a and listener-b.

Parameters:

 e - the mouse event

 mousePressed

  public void mousePressed(MouseEvent e)

 Handles the mousePressed event by invoking the  mousePressed methods on listener-a and listener-b.

Parameters:

 e - the mouse event

 mouseReleased

  public void mouseReleased(MouseEvent e)

 Handles the mouseReleased event by invoking the  mouseReleased methods on listener-a and listener-b.

Parameters:

 e - the mouse event

 mouseEntered

  public void mouseEntered(MouseEvent e)

 Handles the mouseEntered event by invoking the  mouseEntered methods on listener-a and listener-b.

Parameters:

 e - the mouse event

 mouseExited

  public void mouseExited(MouseEvent e)

 Handles the mouseExited event by invoking the  mouseExited methods on listener-a and listener-b.

Parameters:

 e - the mouse event

 mouseDragged

  public void mouseDragged(MouseEvent e)

 Handles the mouseDragged event by invoking the  mouseDragged methods on listener-a and listener-b.

Parameters:

 e - the mouse event

 mouseMoved

  public void mouseMoved(MouseEvent e)

 Handles the mouseMoved event by invoking the  mouseMoved methods on listener-a and listener-b.

Parameters:

 e - the mouse event

 windowOpened

  public void windowOpened(WindowEvent e)

 Handles the windowOpened event by invoking the  windowOpened methods on listener-a and listener-b.

Parameters:

 e - the window event

 windowClosing

  public void windowClosing(WindowEvent e)

 Handles the windowClosing event by invoking the  windowClosing methods on listener-a and listener-b.

Parameters:

 e - the window event

 windowClosed

  public void windowClosed(WindowEvent e)

 Handles the windowClosed event by invoking the  windowClosed methods on listener-a and listener-b.

Parameters:

 e - the window event

 windowIconified

  public void windowIconified(WindowEvent e)

 Handles the windowIconified event by invoking the  windowIconified methods on listener-a and listener-b.

Parameters:

 e - the window event

 windowDeiconified

  public void windowDeiconified(WindowEvent e)

 Handles the windowDeiconfied event by invoking the  windowDeiconified methods on listener-a and listener-b.

Parameters:

 e - the window event

 windowActivated

  public void windowActivated(WindowEvent e)

 Handles the windowActivated event by invoking the  windowActivated methods on listener-a and listener-b.

Parameters:

 e - the window event

 windowDeactivated

  public void windowDeactivated(WindowEvent e)

 Handles the windowDeactivated event by invoking the  windowDeactivated methods on listener-a and listener-b.

Parameters:

 e - the window event

 actionPerformed

  public void actionPerformed(ActionEvent e)

 Handles the actionPerformed event by invoking the  actionPerformed methods on listener-a and listener-b.

Parameters:

 e - the action event

 itemStateChanged

  public void itemStateChanged(ItemEvent e)

 Handles the itemStateChanged event by invoking the  itemStateChanged methods on listener-a and listener-b.

Parameters:

 e - the item event

 adjustmentValueChanged

  public void adjustmentValueChanged(AdjustmentEvent e)

 Handles the adjustmentValueChanged event by invoking the  adjustmentValueChanged methods on listener-a and listener-b.

Parameters:

 e - the adjustment event

 textValueChanged

  public void textValueChanged(TextEvent e)

 add

  public static ComponentListener add(ComponentListener a,
                                      ComponentListener b)

 Adds component-listener-a with component-listener-b and  returns the resulting multicast listener.

Parameters:

 a - component-listener-a

 b - component-listener-b

 add

  public static ContainerListener add(ContainerListener a,
                                      ContainerListener b)

 Adds container-listener-a with container-listener-b and  returns the resulting multicast listener.

Parameters:

 a - container-listener-a

 b - container-listener-b

 add

  public static FocusListener add(FocusListener a,
                                  FocusListener b)

 Adds focus-listener-a with focus-listener-b and  returns the resulting multicast listener.

Parameters:

 a - focus-listener-a

 b - focus-listener-b

 add

  public static KeyListener add(KeyListener a,
                                KeyListener b)

 Adds key-listener-a with key-listener-b and  returns the resulting multicast listener.

Parameters:

 a - key-listener-a

 b - key-listener-b

 add

  public static MouseListener add(MouseListener a,
                                  MouseListener b)

 Adds mouse-listener-a with mouse-listener-b and  returns the resulting multicast listener.

Parameters:

 a - mouse-listener-a

 b - mouse-listener-b

 add

  public static MouseMotionListener add(MouseMotionListener a,
                                        MouseMotionListener b)

 Adds mouse-motion-listener-a with mouse-motion-listener-b and  returns the resulting multicast listener.

Parameters:

 a - mouse-motion-listener-a

 b - mouse-motion-listener-b

 add

  public static WindowListener add(WindowListener a,
                                   WindowListener b)

 Adds window-listener-a with window-listener-b and  returns the resulting multicast listener.

Parameters:

 a - window-listener-a

 b - window-listener-b

 add

  public static ActionListener add(ActionListener a,
                                   ActionListener b)

 Adds action-listener-a with action-listener-b and  returns the resulting multicast listener.

Parameters:

 a - action-listener-a

 b - action-listener-b

 add

  public static ItemListener add(ItemListener a,
                                 ItemListener b)

 Adds item-listener-a with item-listener-b and  returns the resulting multicast listener.

Parameters:

 a - item-listener-a

 b - item-listener-b

 add

  public static AdjustmentListener add(AdjustmentListener a,
                                       AdjustmentListener b)

 Adds adjustment-listener-a with adjustment-listener-b and  returns the resulting multicast listener.

Parameters:

 a - adjustment-listener-a

 b - adjustment-listener-b

 add

  public static TextListener add(TextListener a,
                                 TextListener b)

 remove

  public static ComponentListener remove(ComponentListener l,
                                         ComponentListener oldl)

 Removes the old component-listener from component-listener-l and  returns the resulting multicast listener.

Parameters:

 l - component-listener-l

 oldl - the component-listener being removed

 remove

  public static ContainerListener remove(ContainerListener l,
                                         ContainerListener oldl)

 Removes the old container-listener from container-listener-l and  returns the resulting multicast listener.

Parameters:

 l - container-listener-l

 oldl - the container-listener being removed

 remove

  public static FocusListener remove(FocusListener l,
                                     FocusListener oldl)

 Removes the old focus-listener from focus-listener-l and  returns the resulting multicast listener.

Parameters:

 l - focus-listener-l

 oldl - the focus-listener being removed

 remove

  public static KeyListener remove(KeyListener l,
                                   KeyListener oldl)

 Removes the old key-listener from key-listener-l and  returns the resulting multicast listener.

Parameters:

 l - key-listener-l

 oldl - the key-listener being removed

 remove

  public static MouseListener remove(MouseListener l,
                                     MouseListener oldl)

 Removes the old mouse-listener from mouse-listener-l and  returns the resulting multicast listener.

Parameters:

 l - mouse-listener-l

 oldl - the mouse-listener being removed

 remove

  public static MouseMotionListener remove(MouseMotionListener l,
                                           MouseMotionListener oldl)

 Removes the old mouse-motion-listener from mouse-motion-listener-l  and returns the resulting multicast listener.

Parameters:

 l - mouse-motion-listener-l

 oldl - the mouse-motion-listener being removed

 remove

  public static WindowListener remove(WindowListener l,
                                      WindowListener oldl)

 Removes the old window-listener from window-listener-l and  returns the resulting multicast listener.

Parameters:

 l - window-listener-l

 oldl - the window-listener being removed

 remove

  public static ActionListener remove(ActionListener l,
                                      ActionListener oldl)

 Removes the old action-listener from action-listener-l and  returns the resulting multicast listener.

Parameters:

 l - action-listener-l

 oldl - the action-listener being removed

 remove

  public static ItemListener remove(ItemListener l,
                                    ItemListener oldl)

 Removes the old item-listener from item-listener-l and  returns the resulting multicast listener.

Parameters:

 l - item-listener-l

 oldl - the item-listener being removed

 remove

  public static AdjustmentListener remove(AdjustmentListener l,
                                          AdjustmentListener oldl)

 Removes the old adjustment-listener from adjustment-listener-l and  returns the resulting multicast listener.

Parameters:

 l - adjustment-listener-l

 oldl - the adjustment-listener being removed

 remove

  public static TextListener remove(TextListener l,
                                    TextListener oldl)

 addInternal

  protected static EventListener addInternal(EventListener a,
                                             EventListener b)

 Returns the resulting multicast listener from adding listener-a  and listener-b together.  If listener-a is null, it returns listener-b;  If listener-b is null, it returns listener-a  If neither are null, then it creates and returns  a new AWTEventMulticaster instance which chains a with b.

Parameters:

 a - event listener-a

 b - event listener-b

 removeInternal

  protected static EventListener removeInternal(EventListener l,
                                                EventListener oldl)

 Returns the resulting multicast listener after removing the  old listener from listener-l.  If listener-l equals the old listener OR listener-l is null,  returns null.  Else if listener-l is an instance of AWTEventMulticaster,  then it removes the old listener from it.  Else, returns listener l.

Parameters:

 l - the listener being removed from

 oldl - the listener being removed

 saveInternal

  protected void saveInternal(ObjectOutputStream s,
                              String k) throws IOException

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.AWTException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.AWTException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.awt.AWTException

______________________________________________________________________________

 public class AWTException

 extends Exception

Signals that an Absract Window Toolkit exception has occurred.

______________________________________________________________________________

 	AWTException(String)

 Constructs an AWTException with the specified detail message.

 AWTException

  public AWTException(String msg)

 Constructs an AWTException with the specified detail message.  A detail message is a String that describes this particular  exception.

Parameters:

 msg - the detail message

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.BorderLayout

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.BorderLayout

java.lang.Object
   |
   +----java.awt.BorderLayout

______________________________________________________________________________

 public class BorderLayout

 extends Object

 implements LayoutManager2, Serializable

A TNT style border bag layout. It will layout a container  using members named "North", "South", "East", "West" and  "Center".  When you add a component to a container that has a BorderLayout  layout manager, be sure to specify a string for where to add the  component, for example:

    Panel p = new Panel();
    p.setLayout(new BorderLayout());
    p.add(new Button("Okay"), "South");

 As a convenience, BorderLayout interprets the absence of a string  specification the same as "Center":

    Panel p2 = new Panel();
    p2.setLayout(new BorderLayout());
    p2.add(new TextArea());  // Same as p.add(new TextArea(), "Center");

 The "North", "South", "East" and "West" components get layed out  according to their preferred sizes and the constraints of the  container's size. The "Center" component will get any space left  over.

______________________________________________________________________________

 	CENTER

 The center layout constraint.

 	EAST

 The east layout constraint.

 	NORTH

 The north layout constraint.

 	SOUTH

 The south layout constraint.

 	WEST

 The west layout constraint.

 	BorderLayout()

 Constructs a new BorderLayout with no gaps between components.

 	BorderLayout(int, int)

 Constructs a BorderLayout with the specified gaps.

 	addLayoutComponent(Component, Object)

 Adds the specified component to the layout, using the specified  constraint object.

 	addLayoutComponent(String, Component)

 Replaced by addLayoutComponent(Component, Object). Deprecated.

 	getHgap()

 Returns the horizontal gap between components.

 	getLayoutAlignmentX(Container)

 Returns the alignment along the x axis.

 	getLayoutAlignmentY(Container)

 Returns the alignment along the y axis.

 	getVgap()

 Returns the vertical gap between components.

 	invalidateLayout(Container)

 Invalidates the layout, indicating that if the layout manager  has cached information it should be discarded.

 	layoutContainer(Container)

 Lays out the specified container.

 	maximumLayoutSize(Container)

 Returns the maximum dimensions for this layout given the components  in the specified target container.

 	minimumLayoutSize(Container)

 Returns the minimum dimensions needed to layout the components  contained in the specified target container.

 	preferredLayoutSize(Container)

 Returns the preferred dimensions for this layout given the components  in the specified target container.

 	removeLayoutComponent(Component)

 Removes the specified component from the layout.

 	setHgap(int)

 Sets the horizontal gap between components.

 	setVgap(int)

 Sets the vertical gap between components.

 	toString()

 Returns the String representation of this BorderLayout's values.

 NORTH

  public final static String NORTH

 The north layout constraint.

 SOUTH

  public final static String SOUTH

 The south layout constraint.

 EAST

  public final static String EAST

 The east layout constraint.

 WEST

  public final static String WEST

 The west layout constraint.

 CENTER

  public final static String CENTER

 The center layout constraint.

 BorderLayout

  public BorderLayout()

 Constructs a new BorderLayout with no gaps between components.

 BorderLayout

  public BorderLayout(int hgap,
                      int vgap)

 Constructs a BorderLayout with the specified gaps.

Parameters:

 hgap - the horizontal gap

 vgap - the vertical gap

 getHgap

  public int getHgap()

 Returns the horizontal gap between components.

 setHgap

  public void setHgap(int hgap)

 Sets the horizontal gap between components.

Parameters:

 hgap - the horizontal gap between components

 getVgap

  public int getVgap()

 Returns the vertical gap between components.

 setVgap

  public void setVgap(int vgap)

 Sets the vertical gap between components.

Parameters:

 vgap - the vertical gap between components

 addLayoutComponent

  public void addLayoutComponent(Component comp,
                                 Object constraints)

 Adds the specified component to the layout, using the specified  constraint object.

Parameters:

 comp - the component to be added

 constraints - where/how the component is added to the layout.

 addLayoutComponent

  public void addLayoutComponent(String name,
                                 Component comp)

 Note: addLayoutComponent() is deprecated.

 Replaced by addLayoutComponent(Component, Object).

 removeLayoutComponent

  public void removeLayoutComponent(Component comp)

 Removes the specified component from the layout.

Parameters:

 comp - the component to be removed

 minimumLayoutSize

  public Dimension minimumLayoutSize(Container target)

 Returns the minimum dimensions needed to layout the components  contained in the specified target container.

Parameters:

 target - the Container on which to do the layout

See Also:

Container, preferredLayoutSize

 preferredLayoutSize

  public Dimension preferredLayoutSize(Container target)

 Returns the preferred dimensions for this layout given the components  in the specified target container.

Parameters:

 target - the component which needs to be laid out

See Also:

Container, minimumLayoutSize

 maximumLayoutSize

  public Dimension maximumLayoutSize(Container target)

 Returns the maximum dimensions for this layout given the components  in the specified target container.

Parameters:

 target - the component which needs to be laid out

See Also:

Container, minimumLayoutSize, preferredLayoutSize

 getLayoutAlignmentX

  public float getLayoutAlignmentX(Container parent)

 Returns the alignment along the x axis. This specifies how  the component would like to be aligned relative to other  components. The value should be a number between 0 and 1  where 0 represents alignment along the origin, 1 is aligned  the furthest away from the origin, 0.5 is centered, etc.

 getLayoutAlignmentY

  public float getLayoutAlignmentY(Container parent)

 Returns the alignment along the y axis. This specifies how  the component would like to be aligned relative to other  components. The value should be a number between 0 and 1  where 0 represents alignment along the origin, 1 is aligned  the furthest away from the origin, 0.5 is centered, etc.

 invalidateLayout

  public void invalidateLayout(Container target)

 Invalidates the layout, indicating that if the layout manager  has cached information it should be discarded.

 layoutContainer

  public void layoutContainer(Container target)

 Lays out the specified container. This method will actually reshape the   components in the specified target container in order to satisfy the  constraints of the BorderLayout object.

Parameters:

 target - the component being laid out

See Also:

Container

 toString

  public String toString()

 Returns the String representation of this BorderLayout's values.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Button

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Button

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Button

______________________________________________________________________________

 public class Button

 extends Component

A class that produces a labeled button component.

______________________________________________________________________________

 	Button()

 Constructs a Button with no label.

 	Button(String)

 Constructs a Button with the specified label.

 	addActionListener(ActionListener)

 Adds the specified action listener to receive action events  from this button.

 	addNotify()

 Creates the peer of the button.

 	getActionCommand()

 Returns the command name of the action event fired by this button.

 	getLabel()

 Gets the label of the button.

 	paramString()

 Returns the parameter String of this button.

 	processActionEvent(ActionEvent)

 Processes action events occurring on this button by  dispatching them to any registered ActionListener objects.

 	processEvent(AWTEvent)

 Processes events on this button.

 	removeActionListener(ActionListener)

 Removes the specified action listener so it no longer receives  action events from this button.

 	setActionCommand(String)

 Sets the command name of the action event fired by this button.

 	setLabel(String)

 Sets the button with the specified label.

 Button

  public Button()

 Constructs a Button with no label.

 Button

  public Button(String label)

 Constructs a Button with the specified label.

Parameters:

 label - the label of the button

 addNotify

  public void addNotify()

 Creates the peer of the button. This peer allows us to  change the look of the button without changing its functionality.

Overrides:

addNotify in class Component

 getLabel

  public String getLabel()

 Gets the label of the button.

See Also:

setLabel

 setLabel

  public synchronized void setLabel(String label)

 Sets the button with the specified label.

Parameters:

 label - the label to set the button with

See Also:

getLabel

 setActionCommand

  public void setActionCommand(String command)

 Sets the command name of the action event fired by this button.  By default this will be set to the label of the button.

 getActionCommand

  public String getActionCommand()

 Returns the command name of the action event fired by this button.

 addActionListener

  public void addActionListener(ActionListener l)

 Adds the specified action listener to receive action events  from this button.

Parameters:

 l - the action listener

 removeActionListener

  public void removeActionListener(ActionListener l)

 Removes the specified action listener so it no longer receives  action events from this button.

Parameters:

 l - the action listener

 processEvent

  protected void processEvent(AWTEvent e)

 Processes events on this button. If the event is an ActionEvent,  it invokes the processActionEvent method, else it invokes its  superclass's processEvent.

Parameters:

 e - the event

Overrides:

processEvent in class Component

 processActionEvent

  protected void processActionEvent(ActionEvent e)

 Processes action events occurring on this button by  dispatching them to any registered ActionListener objects.  NOTE: This method will not be called unless action events  are enabled for this component; this happens when one of the  following occurs:  a) An ActionListener object is registered via addActionListener()  b) Action events are enabled via enableEvents()

Parameters:

 e - the action event

See Also:

enableEvents

 paramString

  protected String paramString()

 Returns the parameter String of this button.

Overrides:

paramString in class Component

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Canvas

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Canvas

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Canvas

______________________________________________________________________________

 public class Canvas

 extends Component

A Canvas component. This is a generic component which  needs to be subclassed in order to add some interesting  functionality.

______________________________________________________________________________

 	Canvas()

 Constructs a new Canvas.

 	addNotify()

 Creates the peer of the canvas.

 	paint(Graphics)

 Paints the canvas in the default background color.

 Canvas

  public Canvas()

 Constructs a new Canvas.

 addNotify

  public void addNotify()

 Creates the peer of the canvas. This peer allows you to change the  user interface of the canvas without changing its functionality.

Overrides:

addNotify in class Component

 paint

  public void paint(Graphics g)

 Paints the canvas in the default background color.

Parameters:

 g - the specified Graphics window

Overrides:

paint in class Component

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.CardLayout

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.CardLayout

java.lang.Object
   |
   +----java.awt.CardLayout

______________________________________________________________________________

 public class CardLayout

 extends Object

 implements LayoutManager2, Serializable

A layout manager for a container that contains several  'cards'. Only one card is visible at a time,  allowing you to flip through the cards.

______________________________________________________________________________

 	CardLayout()

 Creates a new card layout with gaps of size zero.

 	CardLayout(int, int)

 Creates a card layout with the specified gaps.

 	addLayoutComponent(Component, Object)

 Adds the specified component to the layout, using the specified  constraint object.

 	addLayoutComponent(String, Component)

 Replaced by addLayoutComponent(Component, Object). Deprecated.

 	first(Container)

 Flip to the first card.

 	getHgap()

 Returns the horizontal gap between components.

 	getLayoutAlignmentX(Container)

 Returns the alignment along the x axis.

 	getLayoutAlignmentY(Container)

 Returns the alignment along the y axis.

 	getVgap()

 Returns the vertical gap between components.

 	invalidateLayout(Container)

 Invalidates the layout, indicating that if the layout manager  has cached information it should be discarded.

 	last(Container)

 Flips to the last card of the specified container.

 	layoutContainer(Container)

 Performs a layout in the specified panel.

 	maximumLayoutSize(Container)

 Returns the maximum dimensions for this layout given the components  in the specified target container.

 	minimumLayoutSize(Container)

 Calculates the minimum size for the specified panel.

 	next(Container)

 Flips to the next card of the specified container.

 	preferredLayoutSize(Container)

 Calculates the preferred size for the specified panel.

 	previous(Container)

 Flips to the previous card of the specified container.

 	removeLayoutComponent(Component)

 Removes the specified component from the layout.

 	setHgap(int)

 Sets the horizontal gap between components.

 	setVgap(int)

 Sets the vertical gap between components.

 	show(Container, String)

 Flips to the specified component name in the specified container.

 	toString()

 Returns the String representation of this CardLayout's values.

 CardLayout

  public CardLayout()

 Creates a new card layout with gaps of size zero.

 CardLayout

  public CardLayout(int hgap,
                    int vgap)

 Creates a card layout with the specified gaps.

Parameters:

 hgap - the horizontal gap

 vgap - the vertical gap

 getHgap

  public int getHgap()

 Returns the horizontal gap between components.

 setHgap

  public void setHgap(int hgap)

 Sets the horizontal gap between components.

Parameters:

 hgap - the horizontal gap between components

 getVgap

  public int getVgap()

 Returns the vertical gap between components.

 setVgap

  public void setVgap(int vgap)

 Sets the vertical gap between components.

Parameters:

 vgap - the vertical gap between components

 addLayoutComponent

  public void addLayoutComponent(Component comp,
                                 Object constraints)

 Adds the specified component to the layout, using the specified  constraint object.

Parameters:

 comp - the component to be added

 constraints - where/how the component is added to the layout.

 addLayoutComponent

  public void addLayoutComponent(String name,
                                 Component comp)

 Note: addLayoutComponent() is deprecated.

 Replaced by addLayoutComponent(Component, Object).

 removeLayoutComponent

  public void removeLayoutComponent(Component comp)

 Removes the specified component from the layout.

Parameters:

 comp - the component to be removed

 preferredLayoutSize

  public Dimension preferredLayoutSize(Container parent)

 Calculates the preferred size for the specified panel.

Parameters:

 parent - the name of the parent container

Returns:

 the dimensions of this panel.

See Also:

minimumLayoutSize

 minimumLayoutSize

  public Dimension minimumLayoutSize(Container parent)

 Calculates the minimum size for the specified panel.

Parameters:

 parent - the name of the parent container

Returns:

 the dimensions of this panel.

See Also:

preferredLayoutSize

 maximumLayoutSize

  public Dimension maximumLayoutSize(Container target)

 Returns the maximum dimensions for this layout given the components  in the specified target container.

Parameters:

 target - the component which needs to be laid out

See Also:

Container, minimumLayoutSize, preferredLayoutSize

 getLayoutAlignmentX

  public float getLayoutAlignmentX(Container parent)

 Returns the alignment along the x axis. This specifies how  the component would like to be aligned relative to other  components. The value should be a number between 0 and 1  where 0 represents alignment along the origin, 1 is aligned  the furthest away from the origin, 0.5 is centered, etc.

 getLayoutAlignmentY

  public float getLayoutAlignmentY(Container parent)

 Returns the alignment along the y axis. This specifies how  the component would like to be aligned relative to other  components. The value should be a number between 0 and 1  where 0 represents alignment along the origin, 1 is aligned  the furthest away from the origin, 0.5 is centered, etc.

 invalidateLayout

  public void invalidateLayout(Container target)

 Invalidates the layout, indicating that if the layout manager  has cached information it should be discarded.

 layoutContainer

  public void layoutContainer(Container parent)

 Performs a layout in the specified panel.

Parameters:

 parent - the name of the parent container

 first

  public void first(Container parent)

 Flip to the first card.

Parameters:

 parent - the name of the parent container

 next

  public void next(Container parent)

 Flips to the next card of the specified container.

Parameters:

 parent - the name of the container

 previous

  public void previous(Container parent)

 Flips to the previous card of the specified container.

Parameters:

 parent - the name of the parent container

 last

  public void last(Container parent)

 Flips to the last card of the specified container.

Parameters:

 parent - the name of the parent container

 show

  public void show(Container parent,
                   String name)

 Flips to the specified component name in the specified container.

Parameters:

 parent - the name of the parent container

 name - the component name

 toString

  public String toString()

 Returns the String representation of this CardLayout's values.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Checkbox

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Checkbox

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Checkbox

______________________________________________________________________________

 public class Checkbox

 extends Component

 implements ItemSelectable

A Checkbox object is a graphical user interface element that has a boolean  state.

______________________________________________________________________________

 	Checkbox()

 Constructs a Checkbox with an empty label.

 	Checkbox(String)

 Constructs a Checkbox with the specified label.

 	Checkbox(String, boolean)

 Constructs a Checkbox with the specified label.

 	Checkbox(String, boolean, CheckboxGroup)

 Constructs a Checkbox with the specified label, set to the  specified state, and in the specified check box group.

 	Checkbox(String, CheckboxGroup, boolean)

 Constructs a Checkbox with the specified label, set to the  specified state, and in the specified check box group.

 	addItemListener(ItemListener)

 Adds the specified item listener to recieve item events from  this checkbox.

 	addNotify()

 Creates the peer of the Checkbox.

 	getCheckboxGroup()

 Returns the checkbox group.

 	getLabel()

 Gets the label of the check box.

 	getSelectedObjects()

 Returns the an array (length 1) containing the checkbox  label or null if the checkbox is not selected.

 	getState()

 Returns the boolean state of the Checkbox.

 	paramString()

 Returns the parameter String of this Checkbox.

 	processEvent(AWTEvent)

 Processes events on this checkbox.

 	processItemEvent(ItemEvent)

 Processes item events occurring on this checkbox by  dispatching them to any registered ItemListener objects.

 	removeItemListener(ItemListener)

 Removes the specified item listener so that it no longer  receives item events from this checkbox.

 	setCheckboxGroup(CheckboxGroup)

 Sets the CheckboxGroup to the specified group.

 	setLabel(String)

 Sets this check box's label to be the specified string.

 	setState(boolean)

 Sets the Checkbox to the specifed boolean state.

 Checkbox

  public Checkbox()

 Constructs a Checkbox with an empty label. The check box starts in a  false state and is not part of any check box group.

 Checkbox

  public Checkbox(String label)

 Constructs a Checkbox with the specified label. The check box  starts in a false state and is not part of any check box group.

Parameters:

 label - the label on the Checkbox

 Checkbox

  public Checkbox(String label,
                  boolean state)

 Constructs a Checkbox with the specified label. The check box  starts in the specified state and is not part of any check box  group.

Parameters:

 label - the label on the Checkbox

 state - is the initial state of this Checkbox

 group - the CheckboxGroup this Checkbox is in

 Checkbox

  public Checkbox(String label,
                  boolean state,
                  CheckboxGroup group)

 Constructs a Checkbox with the specified label, set to the  specified state, and in the specified check box group.

Parameters:

 label - the label on the Checkbox

 state - is the initial state of this Checkbox

 group - the CheckboxGroup this Checkbox is in

 Checkbox

  public Checkbox(String label,
                  CheckboxGroup group,
                  boolean state)

 Constructs a Checkbox with the specified label, set to the  specified state, and in the specified check box group.

 addNotify

  public void addNotify()

 Creates the peer of the Checkbox. The peer allows you to change the  look of the Checkbox without changing its functionality.

Overrides:

addNotify in class Component

 getLabel

  public String getLabel()

 Gets the label of the check box.

See Also:

setLabel

 setLabel

  public synchronized void setLabel(String label)

 Sets this check box's label to be the specified string.

Parameters:

 label - the label of the button

See Also:

getLabel

 getState

  public boolean getState()

 Returns the boolean state of the Checkbox.

See Also:

setState

 setState

  public void setState(boolean state)

 Sets the Checkbox to the specifed boolean state.

Parameters:

 state - the boolean state

See Also:

getState

 getSelectedObjects

  public Object[] getSelectedObjects()

 Returns the an array (length 1) containing the checkbox  label or null if the checkbox is not selected.

See Also:

ItemSelectable

 getCheckboxGroup

  public CheckboxGroup getCheckboxGroup()

 Returns the checkbox group.

See Also:

setCheckboxGroup

 setCheckboxGroup

  public void setCheckboxGroup(CheckboxGroup g)

 Sets the CheckboxGroup to the specified group.

Parameters:

 g - the new CheckboxGroup

See Also:

getCheckboxGroup

 addItemListener

  public void addItemListener(ItemListener l)

 Adds the specified item listener to recieve item events from  this checkbox.

Parameters:

 l - the item listener

 removeItemListener

  public void removeItemListener(ItemListener l)

 Removes the specified item listener so that it no longer  receives item events from this checkbox.

Parameters:

 l - the item listener

 processEvent

  protected void processEvent(AWTEvent e)

 Processes events on this checkbox. If the event is an ItemEvent,  it invokes the handleItemEvent method, else it calls its  superclass's processEvent.

Parameters:

 e - the event

Overrides:

processEvent in class Component

 processItemEvent

  protected void processItemEvent(ItemEvent e)

 Processes item events occurring on this checkbox by  dispatching them to any registered ItemListener objects.  NOTE: This method will not be called unless item events  are enabled for this component; this happens when one of the  following occurs:  a) An ItemListener object is registered via addItemListener()  b) Item events are enabled via enableEvents()

Parameters:

 e - the item event

See Also:

enableEvents

 paramString

  protected String paramString()

 Returns the parameter String of this Checkbox.

Overrides:

paramString in class Component

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.CheckboxGroup

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.CheckboxGroup

java.lang.Object
   |
   +----java.awt.CheckboxGroup

______________________________________________________________________________

 public class CheckboxGroup

 extends Object

 implements Serializable

This class is used to create a multiple-exclusion scope for a set  of Checkbox buttons. For example, creating a set of Checkbox buttons  with the same CheckboxGroup object means that only one of those Checkbox  buttons will be allowed to be "on" at a time.

______________________________________________________________________________

 	CheckboxGroup()

 Creates a new CheckboxGroup.

 	getCurrent()

Deprecated.

 	getSelectedCheckbox()

 Gets the current choice.

 	setCurrent(Checkbox)

Deprecated.

 	setSelectedCheckbox(Checkbox)

 Sets the current choice to the specified Checkbox.

 	toString()

 Returns the String representation of this CheckboxGroup's values.

 CheckboxGroup

  public CheckboxGroup()

 Creates a new CheckboxGroup.

 getSelectedCheckbox

  public Checkbox getSelectedCheckbox()

 Gets the current choice.

 getCurrent

  public Checkbox getCurrent()

 Note: getCurrent() is deprecated. As of JDK version 1.1,  replaced by getSelectedCheckbox().

 setSelectedCheckbox

  public synchronized void setSelectedCheckbox(Checkbox box)

 Sets the current choice to the specified Checkbox.  If the Checkbox belongs to a different group, just return.

Parameters:

 box - the current Checkbox choice

 setCurrent

  public synchronized void setCurrent(Checkbox box)

 Note: setCurrent() is deprecated. As of JDK version 1.1,  replaced by setSelectedCheckbox(Checkbox).

 toString

  public String toString()

 Returns the String representation of this CheckboxGroup's values.  Convert to String.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.CheckboxMenuItem

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.CheckboxMenuItem

java.lang.Object
   |
   +----java.awt.MenuComponent
           |
           +----java.awt.MenuItem
                   |
                   +----java.awt.CheckboxMenuItem

______________________________________________________________________________

 public class CheckboxMenuItem

 extends MenuItem

 implements ItemSelectable

This class produces a checkbox that represents a choice in a menu.

______________________________________________________________________________

 	CheckboxMenuItem()

 Creates a checkbox menu item with an empty label, initially set  to off (false state).

 	CheckboxMenuItem(String)

 Creates the checkbox item with the specified label, initially  set to off (false state).

 	CheckboxMenuItem(String, boolean)

 Creates a checkbox menu item with the specified label and state.

 	addItemListener(ItemListener)

 Adds the specified item listener to recieve item events from  this checkbox menu item.

 	addNotify()

 Creates the peer of the checkbox item.

 	getSelectedObjects()

 Returns the an array (length 1) containing the checkbox menu item  label or null if the checkbox is not selected.

 	getState()

 Returns the state of this MenuItem.

 	paramString()

 Returns the parameter String of this button.

 	processEvent(AWTEvent)

 Processes events on this checkbox menu item.

 	processItemEvent(ItemEvent)

 Processes item events occurring on this checkbox menu item by  dispatching them to any registered ItemListener objects.

 	removeItemListener(ItemListener)

 Removes the specified item listener so it no longer receives  item events from this checkbox menu item.

 	setState(boolean)

 Sets the state of this MenuItem if it is a Checkbox.

 CheckboxMenuItem

  public CheckboxMenuItem()

 Creates a checkbox menu item with an empty label, initially set  to off (false state).

 CheckboxMenuItem

  public CheckboxMenuItem(String label)

 Creates the checkbox item with the specified label, initially  set to off (false state).

Parameters:

 label - the button label

 CheckboxMenuItem

  public CheckboxMenuItem(String label,
                          boolean state)

 Creates a checkbox menu item with the specified label and state.

Parameters:

 label - the button label

 state - the initial state of the menu item: true  indicates "on"; false indicates "off".

 addNotify

  public void addNotify()

 Creates the peer of the checkbox item. This peer allows us to  change the look of the checkbox item without changing its  functionality.

Overrides:

addNotify in class MenuItem

 getState

  public boolean getState()

 Returns the state of this MenuItem. This method is only valid for a  Checkbox.

 setState

  public synchronized void setState(boolean b)

 Sets the state of this MenuItem if it is a Checkbox.

Parameters:

 t - the specified state of the checkbox

 getSelectedObjects

  public synchronized Object[] getSelectedObjects()

 Returns the an array (length 1) containing the checkbox menu item  label or null if the checkbox is not selected.

See Also:

ItemSelectable

 addItemListener

  public void addItemListener(ItemListener l)

 Adds the specified item listener to recieve item events from  this checkbox menu item.

Parameters:

 l - the item listener

 removeItemListener

  public void removeItemListener(ItemListener l)

 Removes the specified item listener so it no longer receives  item events from this checkbox menu item.

Parameters:

 l - the item listener

 processEvent

  protected void processEvent(AWTEvent e)

 Processes events on this checkbox menu item. If the event is  an ItemEvent, it invokes the handleItemEvent method.  NOTE: Checkbox menu items currently only support action and  item events.

Parameters:

 e - the event

Overrides:

processEvent in class MenuItem

 processItemEvent

  protected void processItemEvent(ItemEvent e)

 Processes item events occurring on this checkbox menu item by  dispatching them to any registered ItemListener objects.  NOTE: This method will not be called unless item events  are enabled for this checkbox menu item; this happens when one of the  following occurs:  a) An ItemListener object is registered via addItemListener()  b) Item events are enabled via enableEvents()

Parameters:

 e - the item event

See Also:

enableEvents

 paramString

  public String paramString()

 Returns the parameter String of this button.

Overrides:

paramString in class MenuItem

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Choice

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Choice

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Choice

______________________________________________________________________________

 public class Choice

 extends Component

 implements ItemSelectable

The Choice class is a pop-up menu of choices. The current choice is  displayed as the title of the menu.

______________________________________________________________________________

 	Choice()

 Constructs a new Choice.

 	add(String)

 Adds an item to this Choice.

 	addItem(String)

 Adds an item to this Choice.

 	addItemListener(ItemListener)

 Adds the specified item listener to recieve item events from  this choice.

 	addNotify()

 Creates the Choice's peer.

 	countItems()

Deprecated.

 	getItem(int)

 Returns the String at the specified index in the Choice.

 	getItemCount()

 Returns the number of items in this Choice.

 	getSelectedIndex()

 Returns the index of the currently selected item.

 	getSelectedItem()

 Returns a String representation of the current choice.

 	getSelectedObjects()

 Returns an array (length 1) containing the currently selected  item.

 	insert(String, int)

 Inserts the item into this choice at the specified position.

 	paramString()

 Returns the parameter String of this Choice.

 	processEvent(AWTEvent)

 Processes events on this choice.

 	processItemEvent(ItemEvent)

 Processes item events occurring on this choice by  dispatching them to any registered ItemListener objects.

 	remove(int)

 Removes an item from the choice menu.

 	remove(String)

 Remove the first occurrence of item from the choice menu.

 	removeAll()

 Removes all items from the choice menu.

 	removeItemListener(ItemListener)

 Removes the specified item listener so that it no longer  receives item events from this choice.

 	select(int)

 Selects the item with the specified postion.

 	select(String)

 Selects the item with the specified String.

 Choice

  public Choice()

 Constructs a new Choice.

 addNotify

  public void addNotify()

 Creates the Choice's peer. This peer allows us to change the look  of the Choice without changing its functionality.

Overrides:

addNotify in class Component

 getItemCount

  public int getItemCount()

 Returns the number of items in this Choice.

See Also:

getItem

 countItems

  public int countItems()

 Note: countItems() is deprecated. As of JDK version 1.1,  replaced by getItemCount().

 getItem

  public String getItem(int index)

 Returns the String at the specified index in the Choice.

Parameters:

 index - the index at which to begin

See Also:

getItemCount

 add

  public synchronized void add(String item)

 Adds an item to this Choice.

Parameters:

 item - the item to be added

Throws: NullPointerException

 If the item's value is equal to null.

 addItem

  public synchronized void addItem(String item)

 Adds an item to this Choice.

Parameters:

 item - the item to be added

Throws: NullPointerException

 If the item's value is equal to null.

 insert

  public synchronized void insert(String item,
                                  int index)

 Inserts the item into this choice at the specified position.

Parameters:

 item - the item to be inserted

 index - the position at which the item should be inserted

Throws: IllegalArgumentException

 if index is less than 0.

 remove

  public synchronized void remove(String item)

 Remove the first occurrence of item from the choice menu.

Parameters:

 item - the item to remove from the choice menu

Throws: IllegalArgumentException

 If the item doesn't exist in the choice menu.

 remove

  public synchronized void remove(int position)

 Removes an item from the choice menu.

 removeAll

  public synchronized void removeAll()

 Removes all items from the choice menu.

See Also:

remove

 getSelectedItem

  public synchronized String getSelectedItem()

 Returns a String representation of the current choice.

See Also:

getSelectedIndex

 getSelectedObjects

  public synchronized Object[] getSelectedObjects()

 Returns an array (length 1) containing the currently selected  item. If this choice has no items, returns null.

See Also:

ItemSelectable

 getSelectedIndex

  public int getSelectedIndex()

 Returns the index of the currently selected item.

See Also:

getSelectedItem

 select

  public synchronized void select(int pos)

 Selects the item with the specified postion.

Parameters:

 pos - the choice item position

Throws: IllegalArgumentException

 If the choice item position is  invalid.

See Also:

getSelectedItem, getSelectedIndex

 select

  public synchronized void select(String str)

 Selects the item with the specified String.

Parameters:

 str - the specified String

See Also:

getSelectedItem, getSelectedIndex

 addItemListener

  public void addItemListener(ItemListener l)

 Adds the specified item listener to recieve item events from  this choice.

Parameters:

 l - the item listener

 removeItemListener

  public void removeItemListener(ItemListener l)

 Removes the specified item listener so that it no longer  receives item events from this choice.

Parameters:

 l - the item listener

 processEvent

  protected void processEvent(AWTEvent e)

 Processes events on this choice. If the event is an ItemEvent,  it invokes the handleItemEvent method, else it calls its  superclass's processEvent.

Parameters:

 e - the event

Overrides:

processEvent in class Component

 processItemEvent

  protected void processItemEvent(ItemEvent e)

 Processes item events occurring on this choice by  dispatching them to any registered ItemListener objects.  NOTE: This method will not be called unless item events  are enabled for this component; this happens when one of the  following occurs:  a) An ItemListener object is registered via addItemListener()  b) Item events are enabled via enableEvents()

Parameters:

 e - the item event

See Also:

enableEvents

 paramString

  protected String paramString()

 Returns the parameter String of this Choice.

Overrides:

paramString in class Component

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Color

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Color

java.lang.Object
   |
   +----java.awt.Color

______________________________________________________________________________

 public class Color

 extends Object

 implements Serializable

A class to encapsulate RGB Colors.

______________________________________________________________________________

 	black

 The color black.

 	blue

 The color blue.

 	cyan

 The color cyan.

 	darkGray

 The color dark gray.

 	gray

 The color gray.

 	green

 The color green.

 	lightGray

 The color light gray.

 	magenta

 The color magneta.

 	orange

 The color orange.

 	pink

 The color pink.

 	red

 The color red.

 	white

 The color white.

 	yellow

 The color yellow.

 	Color(float, float, float)

 Creates a color with the specified red, green, and blue values in the  range (0.0 - 1.0).

 	Color(int)

 Creates a color with the specified combined RGB value consisting of  the red component in bits 16-23, the green component in bits 8-15,  and the blue component in bits 0-7.

 	Color(int, int, int)

 Creates a color with the specified red, green, and blue values in  the range (0 - 255).

 	brighter()

 Returns a brighter version of this color.

 	darker()

 Returns a darker version of this color.

 	decode(String)

 Gets the specified Color.

 	equals(Object)

 Compares this object against the specified object.

 	getBlue()

 Gets the blue component.

 	getColor(String)

 Gets the specified Color property.

 	getColor(String, Color)

 Gets the specified Color property of the specified Color.

 	getColor(String, int)

 Gets the specified Color property of the color value.

 	getGreen()

 Gets the green component.

 	getHSBColor(float, float, float)

 A static Color factory for generating a Color object from HSB  values.

 	getRed()

 Gets the red component.

 	getRGB()

 Gets the RGB value representing the color in the default RGB ColorModel.

 	hashCode()

 Computes the hash code.

 	HSBtoRGB(float, float, float)

 Returns the RGB value defined by the default RGB ColorModel, of  the color corresponding to the given HSB color components.

 	RGBtoHSB(int, int, int, float[])

 Returns the HSB values corresponding to the color defined by the  red, green, and blue components.

 	toString()

 Returns the String representation of this Color's values.

 white

  public final static Color white

 The color white.

 lightGray

  public final static Color lightGray

 The color light gray.

 gray

  public final static Color gray

 The color gray.

 darkGray

  public final static Color darkGray

 The color dark gray.

 black

  public final static Color black

 The color black.

 red

  public final static Color red

 The color red.

 pink

  public final static Color pink

 The color pink.

 orange

  public final static Color orange

 The color orange.

 yellow

  public final static Color yellow

 The color yellow.

 green

  public final static Color green

 The color green.

 magenta

  public final static Color magenta

 The color magneta.

 cyan

  public final static Color cyan

 The color cyan.

 blue

  public final static Color blue

 The color blue.

 Color

  public Color(int r,
               int g,
               int b)

 Creates a color with the specified red, green, and blue values in  the range (0 - 255). The actual color used in rendering will depend  on finding the best match given the color space available for a  given output device.

Parameters:

 r - the red component

 g - the green component

 b - the blue component

See Also:

getRed, getGreen, getBlue, getRGB

 Color

  public Color(int rgb)

 Creates a color with the specified combined RGB value consisting of  the red component in bits 16-23, the green component in bits 8-15,  and the blue component in bits 0-7. The actual color used in  rendering will depend on finding the best match given the color space  available for a given output device.

Parameters:

 rgb - the combined RGB components

See Also:

getRGBdefault, getRed, getGreen, getBlue, getRGB

 Color

  public Color(float r,
               float g,
               float b)

 Creates a color with the specified red, green, and blue values in the  range (0.0 - 1.0). The actual color  used in rendering will depend on finding the best match given the  color space available for a given output device.

Parameters:

 r - the red component

 g - the red component

 b - the red component

See Also:

getRed, getGreen, getBlue, getRGB

 getRed

  public int getRed()

 Gets the red component.

See Also:

getRGB

 getGreen

  public int getGreen()

 Gets the green component.

See Also:

getRGB

 getBlue

  public int getBlue()

 Gets the blue component.

See Also:

getRGB

 getRGB

  public int getRGB()

 Gets the RGB value representing the color in the default RGB ColorModel.  (Bits 24-31 are 0xff, 16-23 are red, 8-15 are green, 0-7 are blue).

See Also:

getRGBdefault, getRed, getGreen, getBlue

 brighter

  public Color brighter()

 Returns a brighter version of this color.

 darker

  public Color darker()

 Returns a darker version of this color.

 hashCode

  public int hashCode()

 Computes the hash code.

Overrides:

hashCode in class Object

 equals

  public boolean equals(Object obj)

 Compares this object against the specified object.

Parameters:

 obj - the object to compare with.

Returns:

 true if the objects are the same; false otherwise.

Overrides:

equals in class Object

 toString

  public String toString()

 Returns the String representation of this Color's values.

Overrides:

toString in class Object

 decode

  public static Color decode(String nm) throws NumberFormatException

 Gets the specified Color.

Parameters:

 nm - representation of the color as a 24-bit integer

Returns:

 the new color

 getColor

  public static Color getColor(String nm)

 Gets the specified Color property.

Parameters:

 nm - the name of the color property

 getColor

  public static Color getColor(String nm,
                               Color v)

 Gets the specified Color property of the specified Color.

Parameters:

 nm - the name of the color property

 v - the specified color

Returns:

 the new color.

 getColor

  public static Color getColor(String nm,
                               int v)

 Gets the specified Color property of the color value.

Parameters:

 nm - the name of the color property

 v - the color value

Returns:

 the new color.

 HSBtoRGB

  public static int HSBtoRGB(float hue,
                             float saturation,
                             float brightness)

 Returns the RGB value defined by the default RGB ColorModel, of  the color corresponding to the given HSB color components.

Parameters:

 hue - the hue component of the color

 saturation - the saturation of the color

 brightness - the brightness of the color

See Also:

getRGBdefault, getRGB

 RGBtoHSB

  public static float[] RGBtoHSB(int r,
                                 int g,
                                 int b,
                                 float hsbvals[])

 Returns the HSB values corresponding to the color defined by the  red, green, and blue components.

Parameters:

 r - the red component of the color

 g - the green component of the color

 b - the blue component of the color

 hsbvals - the array to be used to return the 3 HSB values, or null

Returns:

 the array used to store the results [hue, saturation, brightness]

See Also:

getRGBdefault, getRGB

 getHSBColor

  public static Color getHSBColor(float h,
                                  float s,
                                  float b)

 A static Color factory for generating a Color object from HSB  values.

Parameters:

 h - the hue component

 s - the saturation of the color

 b - the brightness of the color

Returns:

 the Color object for the corresponding RGB color

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Component

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Component

java.lang.Object
   |
   +----java.awt.Component

______________________________________________________________________________

 public class Component

 extends Object

 implements ImageObserver, MenuContainer, Serializable

A generic Abstract Window Toolkit component.

______________________________________________________________________________

 	BOTTOM_ALIGNMENT

 Ease of use constant for getAlignmentY().

 	CENTER_ALIGNMENT

 Ease of use constant for getAlignmentY() and getAlignmentX().

 	LEFT_ALIGNMENT

 Ease of use constant for getAlignmentX().

 	locale

 The locale for the component.

 	RIGHT_ALIGNMENT

 Ease of use constant for getAlignmentX().

 	TOP_ALIGNMENT

 Ease of use constant for getAlignmentY().

 	Component()

 Constructs a new Component.

 	action(Event, Object)

Deprecated.

 	add(PopupMenu)

 Adds the specified popup menu to the component.

 	addComponentListener(ComponentListener)

 Adds the specified component listener to receive component events  from this component.

 	addFocusListener(FocusListener)

 Adds the specified focus listener to receive focus events  from this component.

 	addKeyListener(KeyListener)

 Adds the specified key listener to receive key events  from this component.

 	addMouseListener(MouseListener)

 Adds the specified mouse listener to receive mouse events  from this component.

 	addMouseMotionListener(MouseMotionListener)

 Adds the specified mouse motion listener to receive mouse motion events  from this component.

 	addNotify()

 Notifies the Component that it has been added to a container  and if a peer is required, it should be created.

 	bounds()

Deprecated.

 	checkImage(Image, ImageObserver)

 Returns the status of the construction of a screen representation  of the specified image.

 	checkImage(Image, int, int, ImageObserver)

 Returns the status of the construction of a scaled screen  representation of the specified image.

 	contains(int, int)

 Checks whether this component "contains" the specified (x, y)  location, where x and y are defined to be relative to the  coordinate system of this component.

 	contains(Point)

 Checks whether this component "contains" the specified point,  where x and y in the point are defined to be relative to the  coordinate system of this component.

 	createImage(ImageProducer)

 Creates an image from the specified image producer.

 	createImage(int, int)

 Creates an off-screen drawable Image to be used for double buffering.

 	deliverEvent(Event)

Deprecated.

 	disable()

Deprecated.

 	disableEvents(long)

 Disables the events defined by the specified event mask parameter  from being delivered to this component.

 	dispatchEvent(AWTEvent)

 Dispatches an event to this component or one of its sub components.

 	doLayout()

 Lays out the component.

 	enable()

Deprecated.

 	enable(boolean)

Deprecated.

 	enableEvents(long)

 Enables the events defined by the specified event mask parameter  to be delivered to this component.

 	getAlignmentX()

 Returns the alignment along the x axis.

 	getAlignmentY()

 Returns the alignment along the y axis.

 	getBackground()

 Gets the background color.

 	getBounds()

 Returns the current bounds of this component.

 	getColorModel()

 Gets the ColorModel used to display the component on the output device.

 	getComponentAt(int, int)

 Returns the component or subcomponent that contains the x,y location.

 	getComponentAt(Point)

 Returns the component or subcomponent that contains the  specified point.

 	getCursor()

 Gets the cursor set on this component.

 	getFont()

 Gets the font of the component.

 	getFontMetrics(Font)

 Gets the font metrics for this component.

 	getForeground()

 Gets the foreground color.

 	getGraphics()

 Gets a Graphics context for this component.

 	getLocale()

 Gets the locale of the component.

 	getLocation()

 Returns the current location of this component.

 	getLocationOnScreen()

 Returns the current location of this component in the screen's  coordinate space.

 	getMaximumSize()

 Returns the maximum size of this component.

 	getMinimumSize()

 Returns the mininimum size of this component.

 	getName()

 Gets the name of the component.

 	getParent()

 Gets the parent of the component.

 	getPeer()

Deprecated.

 	getPreferredSize()

 Returns the preferred size of this component.

 	getSize()

 Returns the current size of this component.

 	getToolkit()

 Gets the toolkit of the component.

 	getTreeLock()

 Gets the locking object for AWT component-tree and layout  operations.

 	gotFocus(Event, Object)

Deprecated.

 	handleEvent(Event)

Deprecated.

 	hide()

Deprecated.

 	imageUpdate(Image, int, int, int, int, int)

 Repaints the component when the image has changed.

 	inside(int, int)

Deprecated.

 	invalidate()

 Invalidates the component.

 	isEnabled()

 Checks if this Component is enabled.

 	isFocusTraversable()

 Returns whether this component can be traversed using  Tab or Shift-Tab keyboard focus traversal.

 	isShowing()

 Checks if this Component is showing on screen.

 	isValid()

 Checks if this Component is valid.

 	isVisible()

 Checks if this Component is visible.

 	keyDown(Event, int)

Deprecated.

 	keyUp(Event, int)

Deprecated.

 	layout()

Deprecated.

 	list()

 Prints a listing to System.out.

 	list(PrintStream)

 Prints a listing to the specified print stream.

 	list(PrintStream, int)

 Prints out a list, starting at the specified indention, to the specified  print stream.

 	list(PrintWriter)

 Prints a listing to the specified print writer.

 	list(PrintWriter, int)

 Prints out a list, starting at the specified indention, to the specified  print writer.

 	locate(int, int)

Deprecated.

 	location()

Deprecated.

 	lostFocus(Event, Object)

Deprecated.

 	minimumSize()

Deprecated.

 	mouseDown(Event, int, int)

Deprecated.

 	mouseDrag(Event, int, int)

Deprecated.

 	mouseEnter(Event, int, int)

Deprecated.

 	mouseExit(Event, int, int)

Deprecated.

 	mouseMove(Event, int, int)

Deprecated.

 	mouseUp(Event, int, int)

Deprecated.

 	move(int, int)

Deprecated.

 	nextFocus()

Deprecated.

 	paint(Graphics)

 Paints the component.

 	paintAll(Graphics)

 Paints the component and its subcomponents.

 	paramString()

 Returns the parameter String of this Component.

 	postEvent(Event)

Deprecated.

 	preferredSize()

Deprecated.

 	prepareImage(Image, ImageObserver)

 Prepares an image for rendering on this Component.

 	prepareImage(Image, int, int, ImageObserver)

 Prepares an image for rendering on this Component at the  specified width and height.

 	print(Graphics)

 Prints this component.

 	printAll(Graphics)

 Prints the component and its subcomponents.

 	processComponentEvent(ComponentEvent)

 Processes component events occurring on this component by  dispatching them to any registered ComponentListener objects.

 	processEvent(AWTEvent)

 Processes events occurring on this component.

 	processFocusEvent(FocusEvent)

 Processes focus events occurring on this component by  dispatching them to any registered FocusListener objects.

 	processKeyEvent(KeyEvent)

 Processes key events occurring on this component by  dispatching them to any registered KeyListener objects.

 	processMouseEvent(MouseEvent)

 Processes mouse events occurring on this component by  dispatching them to any registered MouseListener objects.

 	processMouseMotionEvent(MouseEvent)

 Processes mouse motion events occurring on this component by  dispatching them to any registered MouseMotionListener objects.

 	remove(MenuComponent)

 Removes the specified popup menu from the component.

 	removeComponentListener(ComponentListener)

 Removes the specified listener so it no longer receives component  events from this component.

 	removeFocusListener(FocusListener)

 Removes the specified focus listener so it no longer receives focus  events from this component.

 	removeKeyListener(KeyListener)

 Removes the specified key listener so it no longer receives key  events from this component.

 	removeMouseListener(MouseListener)

 Removes the specified mouse listener so it no longer receives mouse  events from this component.

 	removeMouseMotionListener(MouseMotionListener)

 Removes the specified mouse motion listener so it no longer  receives mouse motion events from this component.

 	removeNotify()

 Notifies the Component that it has been removed from its  container and if a peers ecists, it destroys it.

 	repaint()

 Repaints the component.

 	repaint(int, int, int, int)

 Repaints part of the component.

 	repaint(long)

 Repaints the component.

 	repaint(long, int, int, int, int)

 Repaints part of the component.

 	requestFocus()

 Requests the input focus.

 	reshape(int, int, int, int)

Deprecated.

 	resize(Dimension)

Deprecated.

 	resize(int, int)

Deprecated.

 	setBackground(Color)

 Sets the background color.

 	setBounds(int, int, int, int)

 Reshapes the Component to the specified bounding box.

 	setBounds(Rectangle)

 Reshapes the Component to the specified bounding box.

 	setCursor(Cursor)

 Set the cursor image to a predefined cursor.

 	setEnabled(boolean)

 Enables a component.

 	setFont(Font)

 Sets the font of the component.

 	setForeground(Color)

 Sets the foreground color.

 	setLocale(Locale)

 Sets the locale of the component.

 	setLocation(int, int)

 Moves the Component to a new location.

 	setLocation(Point)

 Moves the Component to a new location.

 	setName(String)

 Sets the name of the component to the specified string.

 	setSize(Dimension)

 Resizes the Component to the specified dimension.

 	setSize(int, int)

 Resizes the Component to the specified width and height.

 	setVisible(boolean)

 Shows or hides the component depending on the boolean flag b.

 	show()

Deprecated.

 	show(boolean)

Deprecated.

 	size()

Deprecated.

 	toString()

 Returns the String representation of this Component's values.

 	transferFocus()

 Transfers the focus to the next component.

 	update(Graphics)

 Updates the component.

 	validate()

 Ensures that a component has a valid layout.

 locale

  protected Locale locale

 The locale for the component.

See Also:

getLocale

 TOP_ALIGNMENT

  public final static float TOP_ALIGNMENT

 Ease of use constant for getAlignmentY(). Specifies an  alignment to the top of the component.

 CENTER_ALIGNMENT

  public final static float CENTER_ALIGNMENT

 Ease of use constant for getAlignmentY() and getAlignmentX().  Specifies an alignment to the center of the component.

 BOTTOM_ALIGNMENT

  public final static float BOTTOM_ALIGNMENT

 Ease of use constant for getAlignmentY(). Specifies an  alignment to the bottom of the component.

 LEFT_ALIGNMENT

  public final static float LEFT_ALIGNMENT

 Ease of use constant for getAlignmentX(). Specifies an  alignment to the left side of the component.

 RIGHT_ALIGNMENT

  public final static float RIGHT_ALIGNMENT

 Ease of use constant for getAlignmentX(). Specifies an  alignment to the right side of the component.

 Component

  protected Component()

 Constructs a new Component. Components can be extended directly,  but are lightweight in this case and must be hosted by a native  container somewhere higher up in the component tree (such as  a Frame for example).

 getName

  public String getName()

 Gets the name of the component.

 setName

  public void setName(String name)

 Sets the name of the component to the specified string.

Parameters:

 name - the name of the component.

 getParent

  public Container getParent()

 Gets the parent of the component.

 getPeer

  public ComponentPeer getPeer()

 Note: getPeer() is deprecated. As of JDK version 1.1,  programs should not directly manipulate peers.

 getTreeLock

  public final Object getTreeLock()

 Gets the locking object for AWT component-tree and layout  operations.

 getToolkit

  public Toolkit getToolkit()

 Gets the toolkit of the component. This toolkit is  used to create the peer for this component. Note that  the Frame which contains a Component controls which  toolkit is used so if the Component has not yet been  added to a Frame or if it is later moved to a different  Frame, the toolkit it uses may change.

 isValid

  public boolean isValid()

 Checks if this Component is valid. Components are invalidated when  they are first shown on the screen.

See Also:

validate, invalidate

 isVisible

  public boolean isVisible()

 Checks if this Component is visible. Components are initially visible  (with the exception of top level components such as Frame).

See Also:

setVisible

 isShowing

  public boolean isShowing()

 Checks if this Component is showing on screen. This means that the  component must be visible, and it must be in a container that is  visible and showing.

See Also:

setVisible

 isEnabled

  public boolean isEnabled()

 Checks if this Component is enabled. Components are initially enabled.

See Also:

setEnabled

 setEnabled

  public void setEnabled(boolean b)

 Enables a component.

See Also:

isEnabled

 enable

  public void enable()

 Note: enable() is deprecated. As of JDK version 1.1,  replaced by setEnabled(boolean).

 enable

  public void enable(boolean b)

 Note: enable() is deprecated. As of JDK version 1.1,  replaced by setEnabled(boolean).

 disable

  public void disable()

 Note: disable() is deprecated. As of JDK version 1.1,  replaced by setEnabled(boolean).

 setVisible

  public void setVisible(boolean b)

 Shows or hides the component depending on the boolean flag b.

Parameters:

 b - if true, show the component; otherwise, hide the component.

See Also:

isVisible

 show

  public void show()

 Note: show() is deprecated. As of JDK version 1.1,   replaced by setVisible(boolean).

 show

  public void show(boolean b)

 Note: show() is deprecated. As of JDK version 1.1,   replaced by setVisible(boolean).

 hide

  public void hide()

 Note: hide() is deprecated. As of JDK version 1.1,   replaced by setVisible(boolean).

 getForeground

  public Color getForeground()

 Gets the foreground color. If the component does  not have a foreground color, the foreground color  of its parent is returned.

See Also:

setForeground

 setForeground

  public void setForeground(Color c)

 Sets the foreground color.

Parameters:

 c - the Color

See Also:

getForeground

 getBackground

  public Color getBackground()

 Gets the background color. If the component does  not have a background color, the background color  of its parent is returned.

See Also:

setBackground

 setBackground

  public void setBackground(Color c)

 Sets the background color.

Parameters:

 c - the Color

See Also:

getBackground

 getFont

  public Font getFont()

 Gets the font of the component. If the component does  not have a font, the font of its parent is returned.

See Also:

setFont

 setFont

  public synchronized void setFont(Font f)

 Sets the font of the component.

Parameters:

 f - the font

See Also:

getFont

 getLocale

  public Locale getLocale()

 Gets the locale of the component. If the component does  not have a locale, the locale of its parent is returned.

Throws: IllegalComponentStateException

 If the Component  does not have its own locale and has not yet been added to  a containment hierarchy such that the locale can be determined  from the containing parent.

See Also:

setLocale

 setLocale

  public void setLocale(Locale l)

 Sets the locale of the component.

Parameters:

 l - the locale

See Also:

getLocale

 getColorModel

  public ColorModel getColorModel()

 Gets the ColorModel used to display the component on the output device.

See Also:

ColorModel

 getLocation

  public Point getLocation()

 Returns the current location of this component.  The location will be in the parent's coordinate space.

See Also:

setLocation

 getLocationOnScreen

  public Point getLocationOnScreen()

 Returns the current location of this component in the screen's  coordinate space.

See Also:

setLocation, getLocation

 location

  public Point location()

 Note: location() is deprecated. As of JDK version 1.1,  replaced by getLocation().

 setLocation

  public void setLocation(int x,
                          int y)

 Moves the Component to a new location. The x and y coordinates  are in the parent's coordinate space.

Parameters:

 x - the x coordinate

 y - the y coordinate

See Also:

getLocation, setBounds

 move

  public void move(int x,
                   int y)

 Note: move() is deprecated. As of JDK version 1.1,   replaced by setLocation(int, int).

 setLocation

  public void setLocation(Point p)

 Moves the Component to a new location. The point p is given in  the parent's coordinate space.

Parameters:

 p - the new location for the coordinate

See Also:

getLocation, setBounds

 getSize

  public Dimension getSize()

 Returns the current size of this component.

See Also:

setSize

 size

  public Dimension size()

 Note: size() is deprecated. As of JDK version 1.1,   replaced by getSize().

 setSize

  public void setSize(int width,
                      int height)

 Resizes the Component to the specified width and height.

Parameters:

 width - the width of the component

 height - the height of the component

See Also:

getSize, setBounds

 resize

  public void resize(int width,
                     int height)

 Note: resize() is deprecated. As of JDK version 1.1,  replaced by setSize(int, int).

 setSize

  public void setSize(Dimension d)

 Resizes the Component to the specified dimension.

Parameters:

 d - the component dimension

See Also:

setSize, setBounds

 resize

  public void resize(Dimension d)

 Note: resize() is deprecated. As of JDK version 1.1,  replaced by setSize(Dimension).

 getBounds

  public Rectangle getBounds()

 Returns the current bounds of this component.

See Also:

setBounds

 bounds

  public Rectangle bounds()

 Note: bounds() is deprecated. As of JDK version 1.1,  replaced by getBounds().

 setBounds

  public void setBounds(int x,
                        int y,
                        int width,
                        int height)

 Reshapes the Component to the specified bounding box.

Parameters:

 x - the x coordinate

 y - the y coordinate

 width - the width of the component

 height - the height of the component

See Also:

getBounds, setLocation, setSize

 reshape

  public void reshape(int x,
                      int y,
                      int width,
                      int height)

 Note: reshape() is deprecated. As of JDK version 1.1,  replaced by setBounds(int, int, int, int).

 setBounds

  public void setBounds(Rectangle r)

 Reshapes the Component to the specified bounding box.

Parameters:

 r - the new bounding rectangle for the component

See Also:

getBounds, setLocation, setSize

 getPreferredSize

  public Dimension getPreferredSize()

 Returns the preferred size of this component.

See Also:

getMinimumSize, LayoutManager

 preferredSize

  public Dimension preferredSize()

 Note: preferredSize() is deprecated. As of JDK version 1.1,  replaced by getPreferredSize().

 getMinimumSize

  public Dimension getMinimumSize()

 Returns the mininimum size of this component.

See Also:

getPreferredSize, LayoutManager

 minimumSize

  public Dimension minimumSize()

 Note: minimumSize() is deprecated. As of JDK version 1.1,  replaced by getMinimumSize().

 getMaximumSize

  public Dimension getMaximumSize()

 Returns the maximum size of this component.

See Also:

getMinimumSize, getPreferredSize, LayoutManager

 getAlignmentX

  public float getAlignmentX()

 Returns the alignment along the x axis. This specifies how  the component would like to be aligned relative to other  components. The value should be a number between 0 and 1  where 0 represents alignment along the origin, 1 is aligned  the furthest away from the origin, 0.5 is centered, etc.

 getAlignmentY

  public float getAlignmentY()

 Returns the alignment along the y axis. This specifies how  the component would like to be aligned relative to other  components. The value should be a number between 0 and 1  where 0 represents alignment along the origin, 1 is aligned  the furthest away from the origin, 0.5 is centered, etc.

 doLayout

  public void doLayout()

 Lays out the component. This is usually called when the  component (more specifically, container) is validated.

See Also:

validate, LayoutManager

 layout

  public void layout()

 Note: layout() is deprecated. As of JDK version 1.1,  replaced by doLayout().

 validate

  public void validate()

 Ensures that a component has a valid layout. This method is  primarily intended to operate on Container instances.

See Also:

invalidate, doLayout, LayoutManager, validate

 invalidate

  public void invalidate()

 Invalidates the component. The component and all parents  above it are marked as needing to be laid out. This method can  be called often, so it needs to execute quickly.

See Also:

validate, doLayout, LayoutManager

 getGraphics

  public Graphics getGraphics()

 Gets a Graphics context for this component. This method will  return null if the component is currently not on the screen.

See Also:

paint

 getFontMetrics

  public FontMetrics getFontMetrics(Font font)

 Gets the font metrics for this component.

Parameters:

 font - the font

See Also:

getFont

 setCursor

  public synchronized void setCursor(Cursor cursor)

 Set the cursor image to a predefined cursor.

Parameters:

 cursorType - one of the cursor constants defined above.

See Also:

Cursor

 getCursor

  public Cursor getCursor()

 Gets the cursor set on this component.

 paint

  public void paint(Graphics g)

 Paints the component. This method is called when the contents  of the component should be painted in response to the component  first being shown or damage needing repair. The clip rectangle  in the Graphics parameter will be set to the area which needs  to be painted.

Parameters:

 g - the specified Graphics window

See Also:

update

 update

  public void update(Graphics g)

 Updates the component. This method is called in  response to a call to repaint. You can assume that  the background is not cleared.

Parameters:

 g - the specified Graphics window

See Also:

paint, repaint

 paintAll

  public void paintAll(Graphics g)

 Paints the component and its subcomponents.

Parameters:

 g - the specified Graphics window

See Also:

paint

 repaint

  public void repaint()

 Repaints the component. This will result in a  call to update as soon as possible.

See Also:

paint

 repaint

  public void repaint(long tm)

 Repaints the component. This will result in a  call to update within tm milliseconds.

Parameters:

 tm - maximum time in milliseconds before update

See Also:

paint

 repaint

  public void repaint(int x,
                      int y,
                      int width,
                      int height)

 Repaints part of the component. This will result in a  call to update as soon as possible.

Parameters:

 x - the x coordinate

 y - the y coordinate

 width - the width

 height - the height

See Also:

repaint

 repaint

  public void repaint(long tm,
                      int x,
                      int y,
                      int width,
                      int height)

 Repaints part of the component. This will result in a  call to update width tm millseconds.

Parameters:

 tm - maximum time in milliseconds before update

 x - the x coordinate

 y - the y coordinate

 width - the width

 height - the height

See Also:

repaint

 print

  public void print(Graphics g)

 Prints this component. The default implementation of this  method calls paint.

Parameters:

 g - the specified Graphics window

See Also:

paint

 printAll

  public void printAll(Graphics g)

 Prints the component and its subcomponents.

Parameters:

 g - the specified Graphics window

See Also:

print

 imageUpdate

  public boolean imageUpdate(Image img,
                             int flags,
                             int x,
                             int y,
                             int w,
                             int h)

 Repaints the component when the image has changed.

Returns:

 true if image has changed; false otherwise.

 createImage

  public Image createImage(ImageProducer producer)

 Creates an image from the specified image producer.

Parameters:

 producer - the image producer

 createImage

  public Image createImage(int width,
                           int height)

 Creates an off-screen drawable Image to be used for double buffering.

Parameters:

 width - the specified width

 height - the specified height

 prepareImage

  public boolean prepareImage(Image image,
                              ImageObserver observer)

 Prepares an image for rendering on this Component. The image  data is downloaded asynchronously in another thread and the  appropriate screen representation of the image is generated.

Parameters:

 image - the Image to prepare a screen representation for

 observer - the ImageObserver object to be notified as the  image is being prepared

Returns:

 true if the image has already been fully prepared

See Also:

ImageObserver

 prepareImage

  public boolean prepareImage(Image image,
                              int width,
                              int height,
                              ImageObserver observer)

 Prepares an image for rendering on this Component at the  specified width and height. The image data is downloaded  asynchronously in another thread and an appropriately scaled  screen representation of the image is generated.

Parameters:

 image - the Image to prepare a screen representation for

 width - the width of the desired screen representation

 height - the height of the desired screen representation

 observer - the ImageObserver object to be notified as the  image is being prepared

Returns:

 true if the image has already been fully prepared

See Also:

ImageObserver

 checkImage

  public int checkImage(Image image,
                        ImageObserver observer)

 Returns the status of the construction of a screen representation  of the specified image.  This method does not cause the image to begin loading. Use the  prepareImage method to force the loading of an image.

Parameters:

 image - the Image to check the status of

 observer - the ImageObserver object to be notified as the  image is being prepared

Returns:

 the boolean OR of the ImageObserver flags for the  data that is currently available

See Also:

ImageObserver, prepareImage

 checkImage

  public int checkImage(Image image,
                        int width,
                        int height,
                        ImageObserver observer)

 Returns the status of the construction of a scaled screen  representation of the specified image.  This method does not cause the image to begin loading, use the  prepareImage method to force the loading of an image.

Parameters:

 image - the Image to check the status of

 width - the width of the scaled version to check the status of

 height - the height of the scaled version to check the status of

 observer - the ImageObserver object to be notified as the  image is being prepared

Returns:

 the boolean OR of the ImageObserver flags for the  data that is currently available

See Also:

ImageObserver, prepareImage

 contains

  public boolean contains(int x,
                          int y)

 Checks whether this component "contains" the specified (x, y)  location, where x and y are defined to be relative to the  coordinate system of this component.

Parameters:

 x - the x coordinate

 y - the y coordinate

See Also:

getComponentAt

 inside

  public boolean inside(int x,
                        int y)

 Note: inside() is deprecated. As of JDK version 1.1,  replaced by contains(int, int).

 contains

  public boolean contains(Point p)

 Checks whether this component "contains" the specified point,  where x and y in the point are defined to be relative to the  coordinate system of this component.

Parameters:

 p - the point

See Also:

getComponentAt

 getComponentAt

  public Component getComponentAt(int x,
                                  int y)

 Returns the component or subcomponent that contains the x,y location.

Parameters:

 x - the x coordinate

 y - the y coordinate

See Also:

contains

 locate

  public Component locate(int x,
                          int y)

 Note: locate() is deprecated. As of JDK version 1.1,  replaced by getComponentAt(int, int).

 getComponentAt

  public Component getComponentAt(Point p)

 Returns the component or subcomponent that contains the  specified point.

Parameters:

 p - the point

See Also:

contains

 deliverEvent

  public void deliverEvent(Event e)

 Note: deliverEvent() is deprecated. As of JDK version 1.1

 dispatchEvent

  public final void dispatchEvent(AWTEvent e)

 Dispatches an event to this component or one of its sub components.

Parameters:

 e - the event

 postEvent

  public boolean postEvent(Event e)

 Note: postEvent() is deprecated. As of JDK version 1.1,  replaced by dispatchEvent(AWTEvent).

 addComponentListener

  public synchronized void addComponentListener(ComponentListener l)

 Adds the specified component listener to receive component events  from this component.

Parameters:

 l - the component listener

 removeComponentListener

  public synchronized void removeComponentListener(ComponentListener l)

 Removes the specified listener so it no longer receives component  events from this component.

Parameters:

 l - the component listener

 addFocusListener

  public synchronized void addFocusListener(FocusListener l)

 Adds the specified focus listener to receive focus events  from this component.

Parameters:

 l - the focus listener

 removeFocusListener

  public synchronized void removeFocusListener(FocusListener l)

 Removes the specified focus listener so it no longer receives focus  events from this component.

Parameters:

 l - the focus listener

 addKeyListener

  public synchronized void addKeyListener(KeyListener l)

 Adds the specified key listener to receive key events  from this component.

Parameters:

 l - the key listener

 removeKeyListener

  public synchronized void removeKeyListener(KeyListener l)

 Removes the specified key listener so it no longer receives key  events from this component.

Parameters:

 l - the key listener

 addMouseListener

  public synchronized void addMouseListener(MouseListener l)

 Adds the specified mouse listener to receive mouse events  from this component.

Parameters:

 l - the mouse listener

 removeMouseListener

  public synchronized void removeMouseListener(MouseListener l)

 Removes the specified mouse listener so it no longer receives mouse  events from this component.

Parameters:

 l - the mouse listener

 addMouseMotionListener

  public synchronized void addMouseMotionListener(MouseMotionListener l)

 Adds the specified mouse motion listener to receive mouse motion events   from this component.

Parameters:

 l - the mouse motion listener

 removeMouseMotionListener

  public synchronized void removeMouseMotionListener(MouseMotionListener l)

 Removes the specified mouse motion listener so it no longer  receives mouse motion events from this component.

Parameters:

 l - the mouse motion listener

 enableEvents

  protected final void enableEvents(long eventsToEnable)

 Enables the events defined by the specified event mask parameter  to be delivered to this component. Event types are automatically  enabled when a listener for that type is added to the component,  therefore this method only needs to be invoked by subclasses of  a component which desire to have the specified event types  delivered to processEvent regardless of whether a listener is  registered.

Parameters:

 eventsToEnable - the event mask defining the event types

 disableEvents

  protected final void disableEvents(long eventsToDisable)

 Disables the events defined by the specified event mask parameter  from being delivered to this component.

Parameters:

 eventsToDisable - the event mask defining the event types

 processEvent

  protected void processEvent(AWTEvent e)

 Processes events occurring on this component. By default this  method will call the appropriate processXXXEvent method for the  class of event. This method will not be called unless and event  type is enabled for this component; this happens when one of the  following occurs:  a) A listener object is registered for that event type  b) The event type is enabled via enableEvents()  Classes overriding this method should call super.processEvent()  to ensure default event processing continues normally.

Parameters:

 e - the event

See Also:

enableEvents, processComponentEvent, processFocusEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent

 processComponentEvent

  protected void processComponentEvent(ComponentEvent e)

 Processes component events occurring on this component by  dispatching them to any registered ComponentListener objects.  NOTE: This method will not be called unless component events  are enabled for this component; this happens when one of the  following occurs:  a) A ComponentListener object is registered via addComponentListner()  b) Component events are enabled via enableEvents()  Classes overriding this method should call super.processComponentEvent()  to ensure default event processing continues normally.

Parameters:

 e - the component event

 processFocusEvent

  protected void processFocusEvent(FocusEvent e)

 Processes focus events occurring on this component by  dispatching them to any registered FocusListener objects.  NOTE: This method will not be called unless focus events  are enabled for this component; this happens when one of the  following occurs:  a) A FocusListener object is registered via addFocusListener()  b) Focus events are enabled via enableEvents()  Classes overriding this method should call super.processFocusEvent()  to ensure default event processing continues normally.

Parameters:

 e - the focus event

 processKeyEvent

  protected void processKeyEvent(KeyEvent e)

 Processes key events occurring on this component by  dispatching them to any registered KeyListener objects.  NOTE: This method will not be called unless key events  are enabled for this component; this happens when one of the  following occurs:  a) A KeyListener object is registered via addKeyListener()  b) Key events are enabled via enableEvents()  Classes overriding this method should call super.processKeyEvent()  to ensure default event processing continues normally.

Parameters:

 e - the key event

 processMouseEvent

  protected void processMouseEvent(MouseEvent e)

 Processes mouse events occurring on this component by  dispatching them to any registered MouseListener objects.  NOTE: This method will not be called unless mouse events  are enabled for this component; this happens when one of the  following occurs:  a) A MouseListener object is registered via addMouseListener()  b) Mouse events are enabled via enableEvents()  Classes overriding this method should call super.processMouseEvent()  to ensure default event processing continues normally.

Parameters:

 e - the mouse event

 processMouseMotionEvent

  protected void processMouseMotionEvent(MouseEvent e)

 Processes mouse motion events occurring on this component by  dispatching them to any registered MouseMotionListener objects.  NOTE: This method will not be called unless mouse motion events  are enabled for this component; this happens when one of the  following occurs:  a) A MouseMotionListener object is registered via addMouseMotionListener()  b) Mouse Motion events are enabled via enableEvents()  Classes overriding this method should call super.processMouseMotionEvent()  to ensure default event processing continues normally.

Parameters:

 e - the mouse motion event

 handleEvent

  public boolean handleEvent(Event evt)

 Note: handleEvent() is deprecated. As of JDK version 1.1  replaced by processEvent(AWTEvent).

 mouseDown

  public boolean mouseDown(Event evt,
                           int x,
                           int y)

 Note: mouseDown() is deprecated. As of JDK version 1.1,  replaced by processMouseEvent(MouseEvent).

 mouseDrag

  public boolean mouseDrag(Event evt,
                           int x,
                           int y)

 Note: mouseDrag() is deprecated. As of JDK version 1.1,  replaced by processMouseMotionEvent(MouseEvent).

 mouseUp

  public boolean mouseUp(Event evt,
                         int x,
                         int y)

 Note: mouseUp() is deprecated. As of JDK version 1.1,  replaced by processMouseEvent(MouseEvent).

 mouseMove

  public boolean mouseMove(Event evt,
                           int x,
                           int y)

 Note: mouseMove() is deprecated. As of JDK version 1.1,  replaced by processMouseMotionEvent(MouseEvent).

 mouseEnter

  public boolean mouseEnter(Event evt,
                            int x,
                            int y)

 Note: mouseEnter() is deprecated. As of JDK version 1.1,  replaced by processMouseEvent(MouseEvent).

 mouseExit

  public boolean mouseExit(Event evt,
                           int x,
                           int y)

 Note: mouseExit() is deprecated. As of JDK version 1.1,  replaced by processMouseEvent(MouseEvent).

 keyDown

  public boolean keyDown(Event evt,
                         int key)

 Note: keyDown() is deprecated. As of JDK version 1.1,  replaced by processKeyEvent(KeyEvent).

 keyUp

  public boolean keyUp(Event evt,
                       int key)

 Note: keyUp() is deprecated. As of JDK version 1.1,  replaced by processKeyEvent(KeyEvent).

 action

  public boolean action(Event evt,
                        Object what)

 Note: action() is deprecated. As of JDK version 1.1,  should register this component as ActionListener on component  which fires action events.

 addNotify

  public void addNotify()

 Notifies the Component that it has been added to a container  and if a peer is required, it should be created.  This method should be called by Container.add, and not by user  code directly.

See Also:

removeNotify

 removeNotify

  public void removeNotify()

 Notifies the Component that it has been removed from its  container and if a peers ecists, it destroys it.  This method should be called by Container.remove, and not by user  code directly.

See Also:

addNotify

 gotFocus

  public boolean gotFocus(Event evt,
                          Object what)

 Note: gotFocus() is deprecated. As of JDK version 1.1,  replaced by processFocusEvent(FocusEvent).

 lostFocus

  public boolean lostFocus(Event evt,
                           Object what)

 Note: lostFocus() is deprecated. As of JDK version 1.1,  replaced by processFocusEvent(FocusEvent).

 isFocusTraversable

  public boolean isFocusTraversable()

 Returns whether this component can be traversed using  Tab or Shift-Tab keyboard focus traversal. If this method  returns "false", this component may still request the keyboard  focus using requestFocus(), but it will not automatically  be assigned focus during tab traversal.

 requestFocus

  public void requestFocus()

 Requests the input focus. A FocusGained event will be delivered  if this request succeeds. The component must be visible  on the screen for this request to be granted.

See Also:

FocusEvent, addFocusListener, processFocusEvent, isFocusTraversable

 transferFocus

  public void transferFocus()

 Transfers the focus to the next component.

See Also:

requestFocus

 nextFocus

  public void nextFocus()

 Note: nextFocus() is deprecated. As of JDK version 1.1,  replaced by transferFocus().

 add

  public synchronized void add(PopupMenu popup)

 Adds the specified popup menu to the component.

Parameters:

 popup - the popup menu to be added to the component

 remove

  public synchronized void remove(MenuComponent popup)

 Removes the specified popup menu from the component.

Parameters:

 popup - the popup menu to be removed

 paramString

  protected String paramString()

 Returns the parameter String of this Component.

 toString

  public String toString()

 Returns the String representation of this Component's values.

Overrides:

toString in class Object

 list

  public void list()

 Prints a listing to System.out.

 list

  public void list(PrintStream out)

 Prints a listing to the specified print stream.

Parameters:

 out - the Stream name

 list

  public void list(PrintStream out,
                   int indent)

 Prints out a list, starting at the specified indention, to the specified  print stream.

Parameters:

 out - the Stream name

 indent - the start of the list

 list

  public void list(PrintWriter out)

 Prints a listing to the specified print writer.

 list

  public void list(PrintWriter out,
                   int indent)

 Prints out a list, starting at the specified indention, to the specified  print writer.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Container

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Container

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container

______________________________________________________________________________

 public class Container

 extends Component

A generic Abstract Window Toolkit(AWT) container object is a component  that can contain other AWT components.

 Components added to a container are tracked in a list. The order  of the list will define the components' front-to-back stacking order  within the container. If no index is specified when adding a  component to a container, it will be added to the end of the list  (and hence to the bottom of the stacking order).

______________________________________________________________________________

 	Container()

 Constructs a new Container.

 	add(Component)

 Adds the specified component to this container.

 	add(Component, int)

 Adds the specified component to this container at the given  position in the container's component list.

 	add(Component, Object)

 Adds the specified component to this container at the specified  index.

 	add(Component, Object, int)

 Adds the specified component to this container with the specified  constraints at the specified index.

 	add(String, Component)

 Adds the specified component to this container.

 	addContainerListener(ContainerListener)

 Adds the specified container listener to receive container events  from this container.

 	addImpl(Component, Object, int)

 Adds the specified component to this container at the specified  index.

 	addNotify()

 Notifies the container to create a peer.

 	countComponents()

Deprecated.

 	deliverEvent(Event)

Deprecated.

 	doLayout()

 Does a layout on this Container.

 	getAlignmentX()

 Returns the alignment along the x axis.

 	getAlignmentY()

 Returns the alignment along the y axis.

 	getComponent(int)

 Gets the nth component in this container.

 	getComponentAt(int, int)

 Locates the component that contains the x,y position.

 	getComponentAt(Point)

 Locates the component that contains the specified point.

 	getComponentCount()

 Returns the number of components in this panel.

 	getComponents()

 Gets all the components in this container.

 	getInsets()

 Returns the insets of the container.

 	getLayout()

 Gets the layout manager for this container.

 	getMaximumSize()

 Returns the maximum size of this container.

 	getMinimumSize()

 Returns the minimum size of this container.

 	getPreferredSize()

 Returns the preferred size of this container.

 	insets()

Deprecated.

 	invalidate()

 Invalidates the container.

 	isAncestorOf(Component)

 Checks if the component is contained in the component hierarchy of  this container.

 	layout()

Deprecated.

 	list(PrintStream, int)

 Prints out a list, starting at the specified indention, to the specified  out stream.

 	list(PrintWriter, int)

 Prints out a list, starting at the specified indention, to the specified  print writer.

 	locate(int, int)

Deprecated.

 	minimumSize()

Deprecated.

 	paint(Graphics)

 Paints the container.

 	paintComponents(Graphics)

 Paints the components in this container.

 	paramString()

 Returns the parameter String of this Container.

 	preferredSize()

Deprecated.

 	print(Graphics)

 Prints the container.

 	printComponents(Graphics)

 Prints the components in this container.

 	processContainerEvent(ContainerEvent)

 Processes container events occurring on this container by  dispatching them to any registered ContainerListener objects.

 	processEvent(AWTEvent)

 Processes events on this container.

 	remove(Component)

 Removes the specified component from this container.

 	remove(int)

 Removes the component at the specified index from this container.

 	removeAll()

 Removes all the components from this container.

 	removeContainerListener(ContainerListener)

 Removes the specified container listener so it no longer receives  container events from this container.

 	removeNotify()

 Notifies the container to remove its peer.

 	setLayout(LayoutManager)

 Sets the layout manager for this container.

 	validate()

 Validates this Container and all of the components contained  within it.

 	validateTree()

 Recursively descends the container tree and recomputes the  layout for any subtrees marked as needing it (those marked as  invalid).

 Container

  protected Container()

 Constructs a new Container. Containers can be extended directly,  but are lightweight in this case and must be contained by a parent  somewhere higher up in the component tree that is native.  (such as Frame for example).

 getComponentCount

  public int getComponentCount()

 Returns the number of components in this panel.

See Also:

getComponent

 countComponents

  public int countComponents()

 Note: countComponents() is deprecated. As of JDK version 1.1,  replaced by getComponentCount().

 getComponent

  public Component getComponent(int n)

 Gets the nth component in this container.

Parameters:

 n - the number of the component to get

Throws: ArrayIndexOutOfBoundsException

 If the nth value does not  exist.

 getComponents

  public Component[] getComponents()

 Gets all the components in this container.

 getInsets

  public Insets getInsets()

 Returns the insets of the container. The insets indicate the size of  the border of the container. A Frame, for example, will have a top inset  that corresponds to the height of the Frame's title bar.

See Also:

LayoutManager

 insets

  public Insets insets()

 Note: insets() is deprecated. As of JDK version 1.1,  replaced by getInsets().

 add

  public Component add(Component comp)

 Adds the specified component to this container.

Parameters:

 comp - the component to be added

 add

  public Component add(String name,
                       Component comp)

 Adds the specified component to this container.  It is strongly advised to use the 1.1 method, add(Component, Object),  in place of this method.

 add

  public Component add(Component comp,
                       int index)

 Adds the specified component to this container at the given  position in the container's component list.

Parameters:

 comp - the component to be added

 index - the position in the container's list at which to  insert the component. -1 means insert at the end.

See Also:

remove

 add

  public void add(Component comp,
                  Object constraints)

 Adds the specified component to this container at the specified  index. Also notifies the layout manager to add the component to  the this container's layout using the specified constraints object.

Parameters:

 comp - the component to be added

 constraints - an object expressing layout contraints for this  component

See Also:

remove, LayoutManager

 add

  public void add(Component comp,
                  Object constraints,
                  int index)

 Adds the specified component to this container with the specified  constraints at the specified index. Also notifies the layout  manager to add the component to the this container's layout using  the specified constraints object.

Parameters:

 comp - the component to be added

 constraints - an object expressing layout contraints for this

 index - the position in the container's list at which to insert  the component. -1 means insert at the end.  component

See Also:

remove, LayoutManager

 addImpl

  protected void addImpl(Component comp,
                         Object constraints,
                         int index)

 Adds the specified component to this container at the specified  index. Also notifies the layout manager to add the component to  the this container's layout using the specified constraints object.

 This is the method to override if you want to track every add  request to a container. An overriding method should usually  include a call to super.addImpl(comp, constraints, index).

Parameters:

 comp - the component to be added

 constraints - an object expressing layout contraints for this  component

 index - the position in the container's list at which to  insert the component. -1 means insert at the end.

See Also:

remove, LayoutManager

 remove

  public void remove(int index)

 Removes the component at the specified index from this container.

Parameters:

 index - the index of the component to be removed

See Also:

add

 remove

  public void remove(Component comp)

 Removes the specified component from this container.

Parameters:

 comp - the component to be removed

See Also:

add

 removeAll

  public void removeAll()

 Removes all the components from this container.

See Also:

add, remove

 getLayout

  public LayoutManager getLayout()

 Gets the layout manager for this container.

See Also:

doLayout, setLayout

 setLayout

  public void setLayout(LayoutManager mgr)

 Sets the layout manager for this container.

Parameters:

 mgr - the specified layout manager

See Also:

doLayout, getLayout

 doLayout

  public void doLayout()

 Does a layout on this Container. Most programs should not call  this directly, but should invoke validate instead.

Overrides:

doLayout in class Component

See Also:

setLayout, validate

 layout

  public void layout()

 Note: layout() is deprecated. As of JDK version 1.1,  replaced by doLayout().

Overrides:

layout in class Component

 invalidate

  public void invalidate()

 Invalidates the container. The container and all parents  above it are marked as needing to be laid out. This method can  be called often, so it needs to execute quickly.

Overrides:

invalidate in class Component

See Also:

validate, layout, LayoutManager

 validate

  public void validate()

 Validates this Container and all of the components contained  within it.

Overrides:

validate in class Component

See Also:

validate, invalidate

 validateTree

  protected void validateTree()

 Recursively descends the container tree and recomputes the  layout for any subtrees marked as needing it (those marked as  invalid). Synchronization should be provided by the method  that calls this: validate.

 getPreferredSize

  public Dimension getPreferredSize()

 Returns the preferred size of this container.

Overrides:

getPreferredSize in class Component

See Also:

getMinimumSize

 preferredSize

  public Dimension preferredSize()

 Note: preferredSize() is deprecated. As of JDK version 1.1,  replaced by getPreferredSize().

Overrides:

preferredSize in class Component

 getMinimumSize

  public Dimension getMinimumSize()

 Returns the minimum size of this container.

Overrides:

getMinimumSize in class Component

See Also:

getPreferredSize

 minimumSize

  public Dimension minimumSize()

 Note: minimumSize() is deprecated. As of JDK version 1.1,  replaced by getMinimumSize().

Overrides:

minimumSize in class Component

 getMaximumSize

  public Dimension getMaximumSize()

 Returns the maximum size of this container.

Overrides:

getMaximumSize in class Component

See Also:

getPreferredSize

 getAlignmentX

  public float getAlignmentX()

 Returns the alignment along the x axis. This specifies how  the component would like to be aligned relative to other  components. The value should be a number between 0 and 1  where 0 represents alignment along the origin, 1 is aligned  the furthest away from the origin, 0.5 is centered, etc.

Overrides:

getAlignmentX in class Component

 getAlignmentY

  public float getAlignmentY()

 Returns the alignment along the y axis. This specifies how  the component would like to be aligned relative to other  components. The value should be a number between 0 and 1  where 0 represents alignment along the origin, 1 is aligned  the furthest away from the origin, 0.5 is centered, etc.

Overrides:

getAlignmentY in class Component

 paint

  public void paint(Graphics g)

 Paints the container. This forwards the paint to any lightweight components  that are children of this container. If this method is reimplemented,  super.paint(g) should be called so that lightweight components are properly  rendered. If a child component is entirely clipped by the current clipping  setting in g, paint() will not be forwarded to that child.

Parameters:

 g - the specified Graphics window

Overrides:

paint in class Component

See Also:

update

 print

  public void print(Graphics g)

 Prints the container. This forwards the print to any lightweight components  that are children of this container. If this method is reimplemented,  super.print(g) should be called so that lightweight components are properly  rendered. If a child component is entirely clipped by the current clipping  setting in g, print() will not be forwarded to that child.

Parameters:

 g - the specified Graphics window

Overrides:

print in class Component

See Also:

update

 paintComponents

  public void paintComponents(Graphics g)

 Paints the components in this container.

Parameters:

 g - the specified Graphics window

See Also:

paint, paintAll

 printComponents

  public void printComponents(Graphics g)

 Prints the components in this container.

Parameters:

 g - the specified Graphics window

See Also:

print, printAll

 addContainerListener

  public void addContainerListener(ContainerListener l)

 Adds the specified container listener to receive container events  from this container.

Parameters:

 l - the container listener

 removeContainerListener

  public void removeContainerListener(ContainerListener l)

 Removes the specified container listener so it no longer receives  container events from this container.

Parameters:

 l - the container listener

 processEvent

  protected void processEvent(AWTEvent e)

 Processes events on this container. If the event is a ContainerEvent,  it invokes the processContainerEvent method, else it invokes its  superclass's processEvent.

Parameters:

 e - the event

Overrides:

processEvent in class Component

 processContainerEvent

  protected void processContainerEvent(ContainerEvent e)

 Processes container events occurring on this container by  dispatching them to any registered ContainerListener objects.  NOTE: This method will not be called unless container events  are enabled for this component; this happens when one of the  following occurs:  a) A ContainerListener object is registered via addContainerListener()  b) Container events are enabled via enableEvents()

Parameters:

 e - the container event

See Also:

enableEvents

 deliverEvent

  public void deliverEvent(Event e)

 Note: deliverEvent() is deprecated. As of JDK version 1.1,  replaced by dispatchEvent(AWTEvent e)

Overrides:

deliverEvent in class Component

 getComponentAt

  public Component getComponentAt(int x,
                                  int y)

 Locates the component that contains the x,y position. The  top-most child component is returned in the case where there  is overlap in the components. This is determined by finding  the component closest to the index 0 that claims to contain  the given point via Component.contains().

Parameters:

 x - the x coordinate

 y - the y coordinate

Returns:

 null if the component does not contain the position.  If there is no child component at the requested point and the  point is within the bounds of the container the container itself  is returned, otherwise the top-most child is returned.

Overrides:

getComponentAt in class Component

See Also:

contains

 locate

  public Component locate(int x,
                          int y)

 Note: locate() is deprecated. As of JDK version 1.1,  replaced by getComponentAt(int, int).

Overrides:

locate in class Component

 getComponentAt

  public Component getComponentAt(Point p)

 Locates the component that contains the specified point.

Parameters:

 p - the point

Returns:

 null if the component does not contain the point;  returns the component otherwise.

Overrides:

getComponentAt in class Component

See Also:

contains

 addNotify

  public void addNotify()

 Notifies the container to create a peer. It will also  notify the components contained in this container.  This method should be called by Container.add, and not by user  code directly.

Overrides:

addNotify in class Component

See Also:

removeNotify

 removeNotify

  public void removeNotify()

 Notifies the container to remove its peer. It will  also notify the components contained in this container.  This method should be called by Container.remove, and not by user  code directly.

Overrides:

removeNotify in class Component

See Also:

addNotify

 isAncestorOf

  public boolean isAncestorOf(Component c)

 Checks if the component is contained in the component hierarchy of  this container.

Parameters:

 c - the component

 paramString

  protected String paramString()

 Returns the parameter String of this Container.

Overrides:

paramString in class Component

 list

  public void list(PrintStream out,
                   int indent)

 Prints out a list, starting at the specified indention, to the specified  out stream.

Parameters:

 out - the Stream name

 indent - the start of the list

Overrides:

list in class Component

 list

  public void list(PrintWriter out,
                   int indent)

 Prints out a list, starting at the specified indention, to the specified  print writer.

Overrides:

list in class Component

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Cursor

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Cursor

java.lang.Object
   |
   +----java.awt.Cursor

______________________________________________________________________________

 public class Cursor

 extends Object

 implements Serializable

A class to encapsulate the bitmap representation of the mouse cursor.

See Also:

setCursor

______________________________________________________________________________

 	CROSSHAIR_CURSOR

 The crosshair cursor type.

 	DEFAULT_CURSOR

 The default cursor type (gets set if no cursor is defined).

 	E_RESIZE_CURSOR

 The east-resize cursor type.

 	HAND_CURSOR

 The hand cursor type.

 	MOVE_CURSOR

 The move cursor type.

 	N_RESIZE_CURSOR

 The north-resize cursor type.

 	NE_RESIZE_CURSOR

 The north-east-resize cursor type.

 	NW_RESIZE_CURSOR

 The north-west-resize cursor type.

 	predefined

  	S_RESIZE_CURSOR

 The south-resize cursor type.

 	SE_RESIZE_CURSOR

 The south-east-resize cursor type.

 	SW_RESIZE_CURSOR

 The south-west-resize cursor type.

 	TEXT_CURSOR

 The text cursor type.

 	W_RESIZE_CURSOR

 The west-resize cursor type.

 	WAIT_CURSOR

 The wait cursor type.

 	Cursor(int)

 Creates a new cursor object with the specified type.

 	getDefaultCursor()

 Return the system default cursor.

 	getPredefinedCursor(int)

 Returns a cursor object with the specified predefined type.

 	getType()

 Returns the type for this cursor.

 DEFAULT_CURSOR

  public final static int DEFAULT_CURSOR

 The default cursor type (gets set if no cursor is defined).

 CROSSHAIR_CURSOR

  public final static int CROSSHAIR_CURSOR

 The crosshair cursor type.

 TEXT_CURSOR

  public final static int TEXT_CURSOR

 The text cursor type.

 WAIT_CURSOR

  public final static int WAIT_CURSOR

 The wait cursor type.

 SW_RESIZE_CURSOR

  public final static int SW_RESIZE_CURSOR

 The south-west-resize cursor type.

 SE_RESIZE_CURSOR

  public final static int SE_RESIZE_CURSOR

 The south-east-resize cursor type.

 NW_RESIZE_CURSOR

  public final static int NW_RESIZE_CURSOR

 The north-west-resize cursor type.

 NE_RESIZE_CURSOR

  public final static int NE_RESIZE_CURSOR

 The north-east-resize cursor type.

 N_RESIZE_CURSOR

  public final static int N_RESIZE_CURSOR

 The north-resize cursor type.

 S_RESIZE_CURSOR

  public final static int S_RESIZE_CURSOR

 The south-resize cursor type.

 W_RESIZE_CURSOR

  public final static int W_RESIZE_CURSOR

 The west-resize cursor type.

 E_RESIZE_CURSOR

  public final static int E_RESIZE_CURSOR

 The east-resize cursor type.

 HAND_CURSOR

  public final static int HAND_CURSOR

 The hand cursor type.

 MOVE_CURSOR

  public final static int MOVE_CURSOR

 The move cursor type.

 predefined

  protected static Cursor predefined[]

 Cursor

  public Cursor(int type)

 Creates a new cursor object with the specified type.

Parameters:

 type - the type of cursor

 getPredefinedCursor

  public static Cursor getPredefinedCursor(int type)

 Returns a cursor object with the specified predefined type.

Parameters:

 type - the type of predefined cursor

 getDefaultCursor

  public static Cursor getDefaultCursor()

 Return the system default cursor.

 getType

  public int getType()

 Returns the type for this cursor.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.datatransfer.Clipboard

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.datatransfer.Clipboard

java.lang.Object
   |
   +----java.awt.datatransfer.Clipboard

______________________________________________________________________________

 public class Clipboard

 extends Object

A class which implements a mechanism to transfer data using  cut/copy/paste operations.

______________________________________________________________________________

 	contents

  	owner

 	Clipboard(String)

 Creates a clipboard object.

 	getContents(Object)

 Returns a transferable object representing the current contents  of the clipboard.

 	getName()

 Returns the name of this clipboard object.

 	setContents(Transferable, ClipboardOwner)

 Sets the current contents of the clipboard to the specified  transferable object and registers the specified clipboard owner  as the owner of the new contents.

 owner

  protected ClipboardOwner owner

 contents

  protected Transferable contents

 Clipboard

  public Clipboard(String name)

 Creates a clipboard object.

 getName

  public String getName()

 Returns the name of this clipboard object.

 setContents

  public synchronized void setContents(Transferable contents,
                                       ClipboardOwner owner)

 Sets the current contents of the clipboard to the specified  transferable object and registers the specified clipboard owner  as the owner of the new contents. If there is an existing owner  registered, that owner is notified that it no longer holds ownership  of the clipboard contents.

Parameters:

 content - the transferable object representing the clipboard content

 owner - the object which owns the clipboard content

 getContents

  public synchronized Transferable getContents(Object requestor)

 Returns a transferable object representing the current contents  of the clipboard. If the clipboard currently has no contents,  it returns null.

Parameters:

 requestor - the object requesting the clip data

Returns:

 the current transferable object on the clipboard

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.datatransfer.ClipboardOwner

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.datatransfer.ClipboardOwner

 public interface ClipboardOwner

Defines the interface for classes that will provide data to  a clipboard.

______________________________________________________________________________

 	lostOwnership(Clipboard, Transferable)

 Notifies this object that it is no longer the owner of  the contents of the clipboard.

 lostOwnership

  public abstract void lostOwnership(Clipboard clipboard,
                                     Transferable contents)

 Notifies this object that it is no longer the owner of  the contents of the clipboard.

Parameters:

 clipboard - the clipboard that is no longer owned

 contents - the contents which this owner had placed on the clipboard

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.datatransfer.DataFlavor

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.datatransfer.DataFlavor

java.lang.Object
   |
   +----java.awt.datatransfer.DataFlavor

______________________________________________________________________________

 public class DataFlavor

 extends Object

Each instance represents the opaque concept of a data format as would  appear on a clipboard, during drag and drop, or in a file system.

______________________________________________________________________________

 	plainTextFlavor

 The DataFlavor representing plain text with unicode encoding, where:

 representationClass = InputStream
 mimeType = "text/plain; charset=unicode"

  	stringFlavor

 The DataFlavor representing a Java Unicode String class, where:

 representationClass = java.lang.String
 mimeType = "application/x-javaserializedobject"

 	DataFlavor(Class, String)

 Construct a DataFlavor that represents a Java class

 The returned DataFlavor will have the following characteristics

 representationClass = representationClass
 mimeType = application/x-javaserializedobject

  	DataFlavor(String, String)

 Construct a DataFlavor that represents a MimeType

 The returned DataFlavor will have the following characteristics:

 If the mimeType is  "application/x-javaserializedobject; class=",  the result is the same as calling  new DataFlavor(Class:forName() as above

 otherwise:

 representationClass = InputStream
 mimeType = mimeType

 	equals(DataFlavor)

  	getHumanPresentableName()

 Returns the human presentable name for the data foramt that this  DataFlavor represents.

 	getMimeType()

 Returns the MIME type string for this DataFlavor

 	getRepresentationClass()

 Returns the Class which objects supporting this DataFlavor  will return when this DataFlavor is requested.

 	isMimeTypeEqual(DataFlavor)

 Convenience function equivalent to calling:  isMimeTypeEqual(dataFlavor.getMimeType());

 	isMimeTypeEqual(String)

 Is the string representation of the MIME type passed in equivalent  to the MIME type of this DataFlavor.

 	normalizeMimeType(String)

 Called for each MIME type string to give DataFlavor subtypes the  opportunity to change how the normalization of MIME types is accomplished.

 	normalizeMimeTypeParameter(String, String)

 Called on DataFlavor for every MIME Type parameter to allow DataFlavor  subclasses to handle special parameters like the text/plain charset  parameters, whose values are case insensitive.

 	setHumanPresentableName(String)

 Sets the human presentable name for the data format that this  DataFlavor represents.

 stringFlavor

  public static DataFlavor stringFlavor

 The DataFlavor representing a Java Unicode String class, where:

 representationClass = java.lang.String
 mimeType = "application/x-javaserializedobject"

 plainTextFlavor

  public static DataFlavor plainTextFlavor

 The DataFlavor representing plain text with unicode encoding, where:

 representationClass = InputStream
 mimeType = "text/plain; charset=unicode"

 DataFlavor

  public DataFlavor(Class representationClass,
                    String humanPresentableName)

 Construct a DataFlavor that represents a Java class

 The returned DataFlavor will have the following characteristics

 representationClass = representationClass
 mimeType = application/x-javaserializedobject

Parameters:

 representationClass - the class used to transfer data in this flavor

 humanPresentableName - the human-readible string used to identify this flavor

 DataFlavor

  public DataFlavor(String mimeType,
                    String humanPresentableName)

 Construct a DataFlavor that represents a MimeType

 The returned DataFlavor will have the following characteristics:

 If the mimeType is  "application/x-javaserializedobject; class=",  the result is the same as calling  new DataFlavor(Class:forName() as above

 otherwise:

 representationClass = InputStream
 mimeType = mimeType

Parameters:

 mimeType - the string used to identify the MIME type for this flavor

 humanPresentableName - the human-readible string used to identify this flavor

 getMimeType

  public String getMimeType()

 Returns the MIME type string for this DataFlavor

 getRepresentationClass

  public Class getRepresentationClass()

 Returns the Class which objects supporting this DataFlavor  will return when this DataFlavor is requested.

 getHumanPresentableName

  public String getHumanPresentableName()

 Returns the human presentable name for the data foramt that this  DataFlavor represents. This name would be localized for different  countries

 setHumanPresentableName

  public void setHumanPresentableName(String humanPresentableName)

 Sets the human presentable name for the data format that this  DataFlavor represents. This name would be localized for different  countries

 equals

  public boolean equals(DataFlavor dataFlavor)

 isMimeTypeEqual

  public boolean isMimeTypeEqual(String mimeType)

 Is the string representation of the MIME type passed in equivalent  to the MIME type of this DataFlavor. This may involve adding default  attributes for some MIME types (like adding charset=US-ASCII to  text/plain MIME types that have no charset parameter specified)

 isMimeTypeEqual

  public final boolean isMimeTypeEqual(DataFlavor dataFlavor)

 Convenience function equivalent to calling:  isMimeTypeEqual(dataFlavor.getMimeType());

 normalizeMimeTypeParameter

  protected String normalizeMimeTypeParameter(String parameterName,
                                              String parameterValue)

 Called on DataFlavor for every MIME Type parameter to allow DataFlavor  subclasses to handle special parameters like the text/plain charset  parameters, whose values are case insensitive. (MIME type parameter  values are supposed to be case sensitive.

 This method is called for each parameter name/value pair and should  return the normalized representation of the parameterValue

 normalizeMimeType

  protected String normalizeMimeType(String mimeType)

 Called for each MIME type string to give DataFlavor subtypes the  opportunity to change how the normalization of MIME types is accomplished.  One possible use would be to add default parameter/value pairs in cases  where none are present in the MIME type string passed in

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.datatransfer.StringSelection

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.datatransfer.StringSelection

java.lang.Object
   |
   +----java.awt.datatransfer.StringSelection

______________________________________________________________________________

 public class StringSelection

 extends Object

 implements Transferable, ClipboardOwner

A class which implements the capability required to transfer a  simple java String in plain text format.

______________________________________________________________________________

 	StringSelection(String)

 Creates a transferable object capable of transferring the  specified string in plain text format.

 	getTransferData(DataFlavor)

 If the data was requested in the "java.lang.String" flavor, return the  String representing the selection.

 	getTransferDataFlavors()

 Returns the array of flavors in which it can provide the data.

 	isDataFlavorSupported(DataFlavor)

 Returns whether the requested flavor is supported by this object.

 	lostOwnership(Clipboard, Transferable)

 StringSelection

  public StringSelection(String data)

 Creates a transferable object capable of transferring the  specified string in plain text format.

 getTransferDataFlavors

  public synchronized DataFlavor[] getTransferDataFlavors()

 Returns the array of flavors in which it can provide the data.

 isDataFlavorSupported

  public boolean isDataFlavorSupported(DataFlavor flavor)

 Returns whether the requested flavor is supported by this object.

Parameters:

 flavor - the requested flavor for the data

 getTransferData

  public synchronized Object getTransferData(DataFlavor flavor) throws UnsupportedFlavorException, IOException

 If the data was requested in the "java.lang.String" flavor, return the  String representing the selection.

Parameters:

 flavor - the requested flavor for the data

Throws: UnsupportedFlavorException

 if the requested data flavor is  not supported in the "java.lang.String" flavor.

 lostOwnership

  public void lostOwnership(Clipboard clipboard,
                            Transferable contents)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.datatransfer.Transferable

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.datatransfer.Transferable

 public interface Transferable

Defines the interface for classes that can be used to provide data  for a transfer operation.

______________________________________________________________________________

 	getTransferData(DataFlavor)

 Returns an object which represents the data to be transferred.

 	getTransferDataFlavors()

 Returns an array of DataFlavor objects indicating the flavors the data  can be provided in.

 	isDataFlavorSupported(DataFlavor)

 Returns whether or not the specified data flavor is supported for  this object.

 getTransferDataFlavors

  public abstract DataFlavor[] getTransferDataFlavors()

 Returns an array of DataFlavor objects indicating the flavors the data  can be provided in. The array should be ordered according to preference  for providing the data (from most richly descriptive to least descriptive).

Returns:

 an array of data flavors in which this data can be transferred

 isDataFlavorSupported

  public abstract boolean isDataFlavorSupported(DataFlavor flavor)

 Returns whether or not the specified data flavor is supported for  this object.

Parameters:

 flavor - the requested flavor for the data

Returns:

 boolean indicating wjether or not the data flavor is supported

 getTransferData

  public abstract Object getTransferData(DataFlavor flavor) throws UnsupportedFlavorException, IOException

 Returns an object which represents the data to be transferred. The class  of the object returned is defined by the representation class of the flavor.

Parameters:

 flavor - the requested flavor for the data

Throws: IOException

 if the data is no longer available  in the requested flavor.

Throws: UnsupportedFlavorException

 if the requested data flavor is  not supported.

See Also:

getRepresentationClass

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.datatransfer.UnsupportedFlavorException

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class java.awt.datatransfer.UnsupportedFlavorException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.awt.datatransfer.UnsupportedFlavorException

______________________________________________________________________________

 public class UnsupportedFlavorException

 extends Exception

Signals that the requested data is not supported in this flavor.

See Also:

getTransferData

______________________________________________________________________________

 	UnsupportedFlavorException(DataFlavor)

 Constructs an UnsupportedFlavorException.

 UnsupportedFlavorException

  public UnsupportedFlavorException(DataFlavor flavor)

 Constructs an UnsupportedFlavorException.

Parameters:

 flavor - the flavor object which caused the exception

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Dialog

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Dialog

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Window
                           |
                           +----java.awt.Dialog

______________________________________________________________________________

 public class Dialog

 extends Window

A class that produces a dialog - a window that takes input from the user.  The default layout for a dialog is BorderLayout.  Dialogs are capable of generating the following window events:  WindowOpened, WindowClosing, WindowClosed, WindowActivated, WindowDeactivated.

See Also:

WindowEvent, addWindowListener

______________________________________________________________________________

 	Dialog(Frame)

 Constructs an initially invisible Dialog with an empty title.

 	Dialog(Frame, boolean)

 Constructs an initially invisible Dialog with an empty title.

 	Dialog(Frame, String)

 Constructs an initially invisible Dialog with a title.

 	Dialog(Frame, String, boolean)

 Constructs an initially invisible Dialog with a title.

 	addNotify()

 Creates the frame's peer.

 	getTitle()

 Gets the title of the Dialog.

 	isModal()

 Returns true if the Dialog is modal.

 	isResizable()

 Returns true if the user can resize the dialog.

 	paramString()

 Returns the parameter String of this Dialog.

 	setModal(boolean)

 Specifies whether this Dialog is modal.

 	setResizable(boolean)

 Sets the resizable flag.

 	setTitle(String)

 Sets the title of the Dialog.

 	show()

 Shows the dialog.

 Dialog

  public Dialog(Frame parent)

 Constructs an initially invisible Dialog with an empty title.

Parameters:

 parent - the owner of the dialog

See Also:

setSize, setVisible

 Dialog

  public Dialog(Frame parent,
                boolean modal)

 Constructs an initially invisible Dialog with an empty title.  A modal Dialog grabs all the input from the user.

Parameters:

 parent - the owner of the dialog

 modal - if true, dialog blocks input to other windows when shown

 Dialog

  public Dialog(Frame parent,
                String title)

 Constructs an initially invisible Dialog with a title.

Parameters:

 parent - the owner of the dialog

 title - the title of the dialog

See Also:

setSize, setVisible

 Dialog

  public Dialog(Frame parent,
                String title,
                boolean modal)

 Constructs an initially invisible Dialog with a title.  A modal Dialog grabs all the input from the user.

Parameters:

 parent - the owner of the dialog

 title - the title of the dialog

 modal - if true, dialog blocks input to other windows when shown

See Also:

setSize, setVisible

 addNotify

  public void addNotify()

 Creates the frame's peer. The peer allows us to change the appearance  of the frame without changing its functionality.

Overrides:

addNotify in class Window

 isModal

  public boolean isModal()

 Returns true if the Dialog is modal. A modal  Dialog grabs all the input from the user.

 setModal

  public void setModal(boolean b)

 Specifies whether this Dialog is modal. A modal  Dialog grabs all the input from the user.

 getTitle

  public String getTitle()

 Gets the title of the Dialog.

See Also:

setTitle

 setTitle

  public synchronized void setTitle(String title)

 Sets the title of the Dialog.

Parameters:

 title - the new title being given to the Dialog

See Also:

getTitle

 show

  public void show()

 Shows the dialog. This will bring the dialog to the  front if the dialog is already visible. If the dialog is  modal, this call will block until the dialog is taken down  by calling hide or dispose. It is permissible to show modal  dialogs from the event dispatching thread because the toolkit  will ensure that another dispatching thread will run while  the one which invoked show is blocked.

Overrides:

show in class Window

See Also:

hide

 isResizable

  public boolean isResizable()

 Returns true if the user can resize the dialog.

 setResizable

  public synchronized void setResizable(boolean resizable)

 Sets the resizable flag.

Parameters:

 resizable - true if resizable; false otherwise

 paramString

  protected String paramString()

 Returns the parameter String of this Dialog.

Overrides:

paramString in class Container

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Dimension

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Dimension

java.lang.Object
   |
   +----java.awt.Dimension

______________________________________________________________________________

 public class Dimension

 extends Object

 implements Serializable

A class to encapsulate a width and a height Dimension.

______________________________________________________________________________

 	height

 The height dimension.

 	width

 The width dimension.

 	Dimension()

 Constructs a Dimension object with 0 width and 0 height.

 	Dimension(Dimension)

 Constructs a Dimension and initializes it to the specified value.

 	Dimension(int, int)

 Constructs a Dimension and initializes it to the specified width and  specified height.

 	equals(Object)

 Checks whether two dimension objects have equal values.

 	getSize()

 Returns the size of this Dimension object.

 	setSize(Dimension)

 Set the size of this Dimension object to match the specified size.

 	setSize(int, int)

 Set the size of this Dimension object to the specified width  and height.

 	toString()

 Returns the String representation of this Dimension's values.

 width

  public int width

 The width dimension.

 height

  public int height

 The height dimension.

 Dimension

  public Dimension()

 Constructs a Dimension object with 0 width and 0 height.

 Dimension

  public Dimension(Dimension d)

 Constructs a Dimension and initializes it to the specified value.

Parameters:

 d - the specified dimension for the width and height values

 Dimension

  public Dimension(int width,
                   int height)

 Constructs a Dimension and initializes it to the specified width and  specified height.

Parameters:

 width - the specified width dimension

 height - the specified height dimension

 getSize

  public Dimension getSize()

 Returns the size of this Dimension object.  This method is included for completeness, to parallel the  getSize method of Component.

 setSize

  public void setSize(Dimension d)

 Set the size of this Dimension object to match the specified size.  This method is included for completeness, to parallel the  getSize method of Component.

Parameters:

 d - the new size for the Dimension object

 setSize

  public void setSize(int width,
                      int height)

 Set the size of this Dimension object to the specified width  and height.  This method is included for completeness, to parallel the  getSize method of Component.

Parameters:

 width - the new width for the Dimension object

 height - the new height for the Dimension object

 equals

  public boolean equals(Object obj)

 Checks whether two dimension objects have equal values.

Overrides:

equals in class Object

 toString

  public String toString()

 Returns the String representation of this Dimension's values.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.event.ActionEvent

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.event.ActionEvent

java.lang.Object
   |
   +----java.util.EventObject
           |
           +----java.awt.AWTEvent
                   |
                   +----java.awt.event.ActionEvent

______________________________________________________________________________

 public class ActionEvent

 extends AWTEvent

The action semantic event.

See Also:

ActionListener

______________________________________________________________________________

 	ACTION_FIRST

 Marks the first integer id for the range of action event ids.

 	ACTION_LAST

 Marks the last integer id for the range of action event ids.

 	ACTION_PERFORMED

 An action performed event type.

 	ALT_MASK

 The alt modifier constant.

 	CTRL_MASK

 The control modifier constant.

 	META_MASK

 The meta modifier constant.

 	SHIFT_MASK

 The shift modifier constant.

 	ActionEvent(Object, int, String)

 Constructs an ActionEvent object with the specified source object.

 	ActionEvent(Object, int, String, int)

 Constructs an ActionEvent object with the specified source object.

 	getActionCommand()

 Returns the command name associated with this action.

 	getModifiers()

 Returns the modifiers held down during this action event.

 	paramString()

 SHIFT_MASK

  public final static int SHIFT_MASK

 The shift modifier constant.

 CTRL_MASK

  public final static int CTRL_MASK

 The control modifier constant.

 META_MASK

  public final static int META_MASK

 The meta modifier constant.

 ALT_MASK

  public final static int ALT_MASK

 The alt modifier constant.

 ACTION_FIRST

  public final static int ACTION_FIRST

 Marks the first integer id for the range of action event ids.

 ACTION_LAST

  public final static int ACTION_LAST

 Marks the last integer id for the range of action event ids.

 ACTION_PERFORMED

  public final static int ACTION_PERFORMED

 An action performed event type.

 ActionEvent

  public ActionEvent(Object source,
                     int id,
                     String command)

 Constructs an ActionEvent object with the specified source object.

Parameters:

 source - the object where the event originated

 id - the type of event

 command - the command string for this action event

 ActionEvent

  public ActionEvent(Object source,
                     int id,
                     String command,
                     int modifiers)

 Constructs an ActionEvent object with the specified source object.

Parameters:

 source - the object where the event originated

 id - the type of event

 command - the command string for this action event

 modifiers - the modifiers held down during this action

 getActionCommand

  public String getActionCommand()

 Returns the command name associated with this action.

 getModifiers

  public int getModifiers()

 Returns the modifiers held down during this action event.

 paramString

  public String paramString()

Overrides:

paramString in class AWTEvent

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.event.ActionListener

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.event.ActionListener

 public interface ActionListener

 extends EventListener

The listener interface for receiving action events.

______________________________________________________________________________

 	actionPerformed(ActionEvent)

 Invoked when an action occurs.

 actionPerformed

  public abstract void actionPerformed(ActionEvent e)

 Invoked when an action occurs.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.event.AdjustmentEvent

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.event.AdjustmentEvent

java.lang.Object
   |
   +----java.util.EventObject
           |
           +----java.awt.AWTEvent
                   |
                   +----java.awt.event.AdjustmentEvent

______________________________________________________________________________

 public class AdjustmentEvent

 extends AWTEvent

The adjustment event emitted by Adjustable objects.

See Also:

Adjustable, AdjustmentListener

______________________________________________________________________________

 	ADJUSTMENT_FIRST

 Marks the first integer id for the range of adjustment event ids.

 	ADJUSTMENT_LAST

 Marks the last integer id for the range of adjustment event ids.

 	ADJUSTMENT_VALUE_CHANGED

 The adjustment value changed event.

 	BLOCK_DECREMENT

 The block decrement adjustment type.

 	BLOCK_INCREMENT

 The block increment adjustment type.

 	TRACK

 The absolute tracking adjustment type.

 	UNIT_DECREMENT

 The unit decrement adjustment type.

 	UNIT_INCREMENT

 The unit increment adjustment type.

 	AdjustmentEvent(Adjustable, int, int, int)

 Constructs a AdjustmentEvent object with the specified Adjustable source,  type, and value.

 	getAdjustable()

 Returns the Adjustable object where this event originated.

 	getAdjustmentType()

 Returns the type of adjustment which caused the value changed  event.

 	getValue()

 Returns the current value in the adjustment event.

 	paramString()

 ADJUSTMENT_FIRST

  public final static int ADJUSTMENT_FIRST

 Marks the first integer id for the range of adjustment event ids.

 ADJUSTMENT_LAST

  public final static int ADJUSTMENT_LAST

 Marks the last integer id for the range of adjustment event ids.

 ADJUSTMENT_VALUE_CHANGED

  public final static int ADJUSTMENT_VALUE_CHANGED

 The adjustment value changed event.

 UNIT_INCREMENT

  public final static int UNIT_INCREMENT

 The unit increment adjustment type.

 UNIT_DECREMENT

  public final static int UNIT_DECREMENT

 The unit decrement adjustment type.

 BLOCK_DECREMENT

  public final static int BLOCK_DECREMENT

 The block decrement adjustment type.

 BLOCK_INCREMENT

  public final static int BLOCK_INCREMENT

 The block increment adjustment type.

 TRACK

  public final static int TRACK

 The absolute tracking adjustment type.

 AdjustmentEvent

  public AdjustmentEvent(Adjustable source,
                         int id,
                         int type,
                         int value)

 Constructs a AdjustmentEvent object with the specified Adjustable source,  type, and value.

Parameters:

 source - the Adjustable object where the event originated

 getAdjustable

  public Adjustable getAdjustable()

 Returns the Adjustable object where this event originated.

 getValue

  public int getValue()

 Returns the current value in the adjustment event.

 getAdjustmentType

  public int getAdjustmentType()

 Returns the type of adjustment which caused the value changed  event.

See Also:

 UNIT_INCREMENT, UNIT_DECREMENT, BLOCK_INCREMENT, BLOCK_DECREMENT, TRACK

 paramString

  public String paramString()

Overrides:

paramString in class AWTEvent

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.event.AdjustmentListener

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.event.AdjustmentListener

 public interface AdjustmentListener

 extends EventListener

The listener interface for receiving adjustment events.

______________________________________________________________________________

 	adjustmentValueChanged(AdjustmentEvent)

 Invoked when the value of the adjustable has changed.

 adjustmentValueChanged

  public abstract void adjustmentValueChanged(AdjustmentEvent e)

 Invoked when the value of the adjustable has changed.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.event.ComponentAdapter

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.event.ComponentAdapter

java.lang.Object
   |
   +----java.awt.event.ComponentAdapter

______________________________________________________________________________

 public class ComponentAdapter

 extends Object

 implements ComponentListener

The adapter which receives component events.  The methods in this class are empty; this class is provided as a  convenience for easily creating listeners by extending this class  and overriding only the methods of interest.

______________________________________________________________________________

 	ComponentAdapter()

 	componentHidden(ComponentEvent)

  	componentMoved (ComponentEvent)

  	componentResized (ComponentEvent)

  	componentShown (ComponentEvent)

 ComponentAdapter

  public ComponentAdapter()

 componentResized

  public void componentResized(ComponentEvent e)

 componentMoved

  public void componentMoved(ComponentEvent e)

 componentShown

  public void componentShown(ComponentEvent e)

 componentHidden

  public void componentHidden(ComponentEvent e)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.event.ComponentEvent

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.event.ComponentEvent

java.lang.Object
   |
   +----java.util.EventObject
           |
           +----java.awt.AWTEvent
                   |
                   +----java.awt.event.ComponentEvent

______________________________________________________________________________

 public class ComponentEvent

 extends AWTEvent

The root event class for all component-level events.  These events are provided for notification purposes ONLY;  The AWT will automatically handle component moves and resizes  internally so that GUI layout works properly regardless of  whether a program is receiving these events or not.

See Also:

ComponentListener

______________________________________________________________________________

 	COMPONENT_FIRST

 Marks the first integer id for the range of component event ids.

 	COMPONENT_HIDDEN

 The component hidden event type.

 	COMPONENT_LAST

 Marks the last integer id for the range of component event ids.

 	COMPONENT_MOVED

 The component moved event type.

 	COMPONENT_RESIZED

 The component resized event type.

 	COMPONENT_SHOWN

 The component shown event type.

 	ComponentEvent(Component, int)

 Constructs a ComponentEvent object with the specified source component  and type.

 	getComponent()

 Returns the component where this event originated.

 	paramString()

 COMPONENT_FIRST

  public final static int COMPONENT_FIRST

 Marks the first integer id for the range of component event ids.

 COMPONENT_LAST

  public final static int COMPONENT_LAST

 Marks the last integer id for the range of component event ids.

 COMPONENT_MOVED

  public final static int COMPONENT_MOVED

 The component moved event type.

 COMPONENT_RESIZED

  public final static int COMPONENT_RESIZED

 The component resized event type.

 COMPONENT_SHOWN

  public final static int COMPONENT_SHOWN

 The component shown event type.

 COMPONENT_HIDDEN

  public final static int COMPONENT_HIDDEN

 The component hidden event type.

 ComponentEvent

  public ComponentEvent(Component source,
                        int id)

 Constructs a ComponentEvent object with the specified source component  and type.

Parameters:

 source - the component where the event originated

 getComponent

  public Component getComponent()

 Returns the component where this event originated.

 paramString

  public String paramString()

Overrides:

paramString in class AWTEvent

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.event.ComponentListener

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.event.ComponentListener

 public interface ComponentListener

 extends EventListener

The listener interface for receiving component events.  Component events are provided for notification purposes ONLY;  The AWT will automatically handle component moves and resizes  internally so that GUI layout works properly regardless of  whether a program registers a ComponentListener or not.

______________________________________________________________________________

 	componentHidden(ComponentEvent)

 Invoked when component has been hidden.

 	componentMoved(ComponentEvent)

 Invoked when component has been moved.

 	componentResized(ComponentEvent)

 Invoked when component has been resized.

 	componentShown(ComponentEvent)

 Invoked when component has been shown.

 componentResized

  public abstract void componentResized(ComponentEvent e)

 Invoked when component has been resized.

 componentMoved

  public abstract void componentMoved(ComponentEvent e)

 Invoked when component has been moved.

 componentShown

  public abstract void componentShown(ComponentEvent e)

 Invoked when component has been shown.

 componentHidden

  public abstract void componentHidden(ComponentEvent e)

 Invoked when component has been hidden.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.event.ContainerAdapter

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.event.ContainerAdapter

java.lang.Object
   |
   +----java.awt.event.ContainerAdapter

______________________________________________________________________________

 public class ContainerAdapter

 extends Object

 implements ContainerListener

The adapter which receives container events.  The methods in this class are empty; this class is provided as a  convenience for easily creating listeners by extending this class  and overriding only the methods of interest.

______________________________________________________________________________

 	ContainerAdapter()

 	componentAdded(ContainerEvent)

  	componentRemoved (ContainerEvent)

 ContainerAdapter

  public ContainerAdapter()

 componentAdded

  public void componentAdded(ContainerEvent e)

 componentRemoved

  public void componentRemoved(ContainerEvent e)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.event.ContainerEvent

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.event.ContainerEvent

java.lang.Object
   |
   +----java.util.EventObject
           |
           +----java.awt.AWTEvent
                   |
                   +----java.awt.event.ComponentEvent
                           |
                           +----java.awt.event.ContainerEvent

______________________________________________________________________________

 public class ContainerEvent

 extends ComponentEvent

The class for container-level events.  These events are provided for notification purposes ONLY;  The AWT will automatically handle container add and remove  operations internally.

See Also:

ContainerListener

______________________________________________________________________________

 	COMPONENT_ADDED

 The component moved event type.

 	COMPONENT_REMOVED

 The component resized event type.

 	CONTAINER_FIRST

 Marks the first integer id for the range of container event ids.

 	CONTAINER_LAST

 Marks the last integer id for the range of container event ids.

 	ContainerEvent(Component, int, Component)

 Constructs a ContainerEvent object with the specified source  container, type, and child which is being added or removed.

 	getChild()

 Returns the child component that was added or removed in  this event.

 	getContainer()

 Returns the container where this event originated.

 	paramString()

 CONTAINER_FIRST

  public final static int CONTAINER_FIRST

 Marks the first integer id for the range of container event ids.

 CONTAINER_LAST

  public final static int CONTAINER_LAST

 Marks the last integer id for the range of container event ids.

 COMPONENT_ADDED

  public final static int COMPONENT_ADDED

 The component moved event type.

 COMPONENT_REMOVED

  public final static int COMPONENT_REMOVED

 The component resized event type.

 ContainerEvent

  public ContainerEvent(Component source,
                        int id,
                        Component child)

 Constructs a ContainerEvent object with the specified source  container, type, and child which is being added or removed.

Parameters:

 source - the container where the event originated

 getContainer

  public Container getContainer()

 Returns the container where this event originated.

 getChild

  public Component getChild()

 Returns the child component that was added or removed in  this event.

 paramString

  public String paramString()

Overrides:

paramString in class ComponentEvent

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.event.ContainerListener

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.event.ContainerListener

 public interface ContainerListener

 extends EventListener

The listener interface for receiving container events.  Container events are provided for notification purposes ONLY;  The AWT will automatically handle add and remove operations  internally.

______________________________________________________________________________

 	componentAdded(ContainerEvent)

 Invoked when a component has been added to the container.

 	componentRemoved(ContainerEvent)

 Invoked when a component has been removed from the container.

 componentAdded

  public abstract void componentAdded(ContainerEvent e)

 Invoked when a component has been added to the container.

 componentRemoved

  public abstract void componentRemoved(ContainerEvent e)

 Invoked when a component has been removed from the container.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.event.FocusAdapter

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.event.FocusAdapter

java.lang.Object
   |
   +----java.awt.event.FocusAdapter

______________________________________________________________________________

 public class FocusAdapter

 extends Object

 implements FocusListener

The adapter which receives focus events.  The methods in this class are empty; this class is provided as a  convenience for easily creating listeners by extending this class  and overriding only the methods of interest.

______________________________________________________________________________

 	FocusAdapter()

 	focusGained(FocusEvent)

  	focusLost(FocusEvent)

 FocusAdapter

  public FocusAdapter()

 focusGained

  public void focusGained(FocusEvent e)

 focusLost

  public void focusLost(FocusEvent e)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.event.FocusEvent

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.event.FocusEvent

java.lang.Object
   |
   +----java.util.EventObject
           |
           +----java.awt.AWTEvent
                   |
                   +----java.awt.event.ComponentEvent
                           |
                           +----java.awt.event.FocusEvent

______________________________________________________________________________

 public class FocusEvent

 extends ComponentEvent

The component-level focus event.  There are two levels of focus change events: permanent and temporary.  Permanent focus change events occur when focus is directly moved  from one component to another, such as through calls to requestFocus()  or as the user uses the Tab key to traverse components.  Temporary focus change events occur when focus is temporarily  gained or lost for a component as the indirect result of another  operation, such as window deactivation or a scrollbar drag. In this  case, the original focus state will automatically be restored once  that operation is finished, or, for the case of window deactivation,  when the window is reactivated. Both permanent and temporary focus  events are delivered using the FOCUS_GAINED and FOCUS_LOST event ids;  the levels may be distinguished in the event using the isTemporary()  method.

______________________________________________________________________________

 	FOCUS_FIRST

 Marks the first integer id for the range of focus event ids.

 	FOCUS_GAINED

 The focus gained event type.

 	FOCUS_LAST

 Marks the last integer id for the range of focus event ids.

 	FOCUS_LOST

 The focus lost event type.

 	FocusEvent(Component, int)

 Constructs a permanent-level FocusEvent object with the  specified source component and type.

 	FocusEvent(Component, int, boolean)

 Constructs a FocusEvent object with the specified source component,  type, and whether or not the focus event is a temporary level event.

 	isTemporary()

 Returns whether or not this focus change event is a temporary  change.

 	paramString()

 FOCUS_FIRST

  public final static int FOCUS_FIRST

 Marks the first integer id for the range of focus event ids.

 FOCUS_LAST

  public final static int FOCUS_LAST

 Marks the last integer id for the range of focus event ids.

 FOCUS_GAINED

  public final static int FOCUS_GAINED

 The focus gained event type.

 FOCUS_LOST

  public final static int FOCUS_LOST

 The focus lost event type.

 FocusEvent

  public FocusEvent(Component source,
                    int id,
                    boolean temporary)

 Constructs a FocusEvent object with the specified source component,  type, and whether or not the focus event is a temporary level event.

Parameters:

 source - the object where the event originated

 FocusEvent

  public FocusEvent(Component source,
                    int id)

 Constructs a permanent-level FocusEvent object with the  specified source component and type.

Parameters:

 source - the object where the event originated

 isTemporary

  public boolean isTemporary()

 Returns whether or not this focus change event is a temporary  change.

 paramString

  public String paramString()

Overrides:

paramString in class ComponentEvent

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.event.FocusListener

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.event.FocusListener

 public interface FocusListener

 extends EventListener

The listener interface for receiving keyboard focus events on  a component.

______________________________________________________________________________

 	focusGained(FocusEvent)

 Invoked when a component gains the keyboard focus.

 	focusLost(FocusEvent)

 Invoked when a component loses the keyboard focus.

 focusGained

  public abstract void focusGained(FocusEvent e)

 Invoked when a component gains the keyboard focus.

 focusLost

  public abstract void focusLost(FocusEvent e)

 Invoked when a component loses the keyboard focus.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Event

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Event

java.lang.Object
   |
   +----java.awt.Event

______________________________________________________________________________

 public class Event

 extends Object

 implements Serializable

Event is a platform-independent class that encapsulates events from  the local Graphical User Interface(GUI) platform.

 The event contains an  id which indicates the type  of event it is and which other Event variables are relavent for the event.  For keyboard events,  key will contain a value indicating  the key that was activated and  modifiers  will  contain the modifiers. For KEY_PRESS and KEY_RELEASE event ids, the value of key  will be the unicode character code for the key; for KEY_ACTION and KEY_ACTION_RELEASE,  the value of key will be one of the defined action-key identifiers in the Event  class (PGUP, PGDN, F1, F2, etc).

______________________________________________________________________________

 	ACTION_EVENT

 An action event.

 	ALT_MASK

 The alt modifier constant.

 	arg

 An arbitrary argument.

 	BACK_SPACE

 The BackSpace key.

 	CAPS_LOCK

 The CapsLock action-key.

 	clickCount

 The number of consecutive clicks.

 	CTRL_MASK

 The control modifier constant.

 	DELETE

 The Delete key.

 	DOWN

 The down arrow action-key.

 	END

 The end action-key.

 	ENTER

 The Enter key.

 	ESCAPE

 The Escape key.

 	evt

 The next event.

 	F1

 The F1 function action-key.

 	F10

 The F10 function action-key.

 	F11

 The F11 function action-key.

 	F12

 The F12 function action-key.

 	F2

 The F2 function action-key.

 	F3

 The F3 function action-key.

 	F4

 The F4 function action-key.

 	F5

 The F5 function action-key.

 	F6

 The F6 function action-key.

 	F7

 The F7 function action-key.

 	F8

 The F8 function action-key.

 	F9

 The F9 function action-key.

 	GOT_FOCUS

 A component gained the focus.

 	HOME

 The home action-key.

 	id

 The type of this event.

 	INSERT

 The Insert key.

 	key

 The key code that was pressed in a keyboard event.

 	KEY_ACTION

 The action-key press keyboard event.

 	KEY_ACTION_RELEASE

 The action-key release keyboard event.

 	KEY_PRESS

 The key press keyboard event.

 	KEY_RELEASE

 The key release keyboard event.

 	LEFT

 The left arrow action-key.

 	LIST_DESELECT

  	LIST_SELECT

  	LOAD_FILE

 A file loading event.

 	LOST_FOCUS

 A component lost the focus.

 	META_MASK

 The meta modifier constant.

 	modifiers

 The state of the modifier keys.

 	MOUSE_DOWN

 The mouse down event.

 	MOUSE_DRAG

 The mouse drag event.

 	MOUSE_ENTER

 The mouse enter event.

 	MOUSE_EXIT

 The mouse exit event.

 	MOUSE_MOVE

 The mouse move event.

 	MOUSE_UP

 The mouse up event.

 	NUM_LOCK

 The NumLock action-key.

 	PAUSE

 The Pause action-key.

 	PGDN

 The page down action-key.

 	PGUP

 The page up action-key.

 	PRINT_SCREEN

 The PrintScreen action-key.

 	RIGHT

 The right arrow action-key.

 	SAVE_FILE

 A file saving event.

 	SCROLL_ABSOLUTE

 The absolute scroll event.

 	SCROLL_BEGIN

 The scroll begin event.

 	SCROLL_END

 The scroll end event.

 	SCROLL_LINE_DOWN

 The line down scroll event.

 	SCROLL_LINE_UP

 The line up scroll event.

 	SCROLL_LOCK

 The ScrollLock action-key.

 	SCROLL_PAGE_DOWN

 The page down scroll event.

 	SCROLL_PAGE_UP

 The page up scroll event.

 	SHIFT_MASK

 The shift modifier constant.

 	TAB

 The Tab key.

 	target

 The target component.

 	UP

 The up arrow action-key.

 	when

 The time stamp.

 	WINDOW_DEICONIFY

 The de-iconify window event.

 	WINDOW_DESTROY

 The destroy window event.

 	WINDOW_EXPOSE

 The expose window event.

 	WINDOW_ICONIFY

 The iconify window event.

 	WINDOW_MOVED

 The move window event.

 	x

 The x coordinate of the event.

 	y

 The y coordinate of the event.

 	Event(Object, int, Object)

 Constructs an event with the specified target component,  event type, and argument.

 	Event(Object, long, int, int, int, int, int)

 Constructs an event with the specified target component, time stamp,  event type, x and y coordinates, keyboard key, state of the modifier  keys and an argument set to null.

 	Event(Object, long, int, int, int, int, int, Object)

 Constructs an event with the specified target component, time stamp,  event type, x and y coordinates, keyboard key, state of the modifier  keys and argument.

 	controlDown()

 Checks if the control key is down.

 	metaDown()

 Checks if the meta key is down.

 	paramString()

 Returns the parameter String of this Event.

 	shiftDown()

 Checks if the shift key is down.

 	toString()

 Returns the String representation of this Event's values.

 	translate(int, int)

 Translates an event relative to the given component.

 SHIFT_MASK

  public final static int SHIFT_MASK

 The shift modifier constant.

 CTRL_MASK

  public final static int CTRL_MASK

 The control modifier constant.

 META_MASK

  public final static int META_MASK

 The meta modifier constant.

 ALT_MASK

  public final static int ALT_MASK

 The alt modifier constant.

 HOME

  public final static int HOME

 The home action-key.

 END

  public final static int END

 The end action-key.

 PGUP

  public final static int PGUP

 The page up action-key.

 PGDN

  public final static int PGDN

 The page down action-key.

 UP

  public final static int UP

 The up arrow action-key.

 DOWN

  public final static int DOWN

 The down arrow action-key.

 LEFT

  public final static int LEFT

 The left arrow action-key.

 RIGHT

  public final static int RIGHT

 The right arrow action-key.

 F1

  public final static int F1

 The F1 function action-key.

 F2

  public final static int F2

 The F2 function action-key.

 F3

  public final static int F3

 The F3 function action-key.

 F4

  public final static int F4

 The F4 function action-key.

 F5

  public final static int F5

 The F5 function action-key.

 F6

  public final static int F6

 The F6 function action-key.

 F7

  public final static int F7

 The F7 function action-key.

 F8

  public final static int F8

 The F8 function action-key.

 F9

  public final static int F9

 The F9 function action-key.

 F10

  public final static int F10

 The F10 function action-key.

 F11

  public final static int F11

 The F11 function action-key.

 F12

  public final static int F12

 The F12 function action-key.

 PRINT_SCREEN

  public final static int PRINT_SCREEN

 The PrintScreen action-key.

 SCROLL_LOCK

  public final static int SCROLL_LOCK

 The ScrollLock action-key.

 CAPS_LOCK

  public final static int CAPS_LOCK

 The CapsLock action-key.

 NUM_LOCK

  public final static int NUM_LOCK

 The NumLock action-key.

 PAUSE

  public final static int PAUSE

 The Pause action-key.

 INSERT

  public final static int INSERT

 The Insert key.

 ENTER

  public final static int ENTER

 The Enter key.

 BACK_SPACE

  public final static int BACK_SPACE

 The BackSpace key.

 TAB

  public final static int TAB

 The Tab key.

 ESCAPE

  public final static int ESCAPE

 The Escape key.

 DELETE

  public final static int DELETE

 The Delete key.

 WINDOW_DESTROY

  public final static int WINDOW_DESTROY

 The destroy window event.

 WINDOW_EXPOSE

  public final static int WINDOW_EXPOSE

 The expose window event.

 WINDOW_ICONIFY

  public final static int WINDOW_ICONIFY

 The iconify window event.

 WINDOW_DEICONIFY

  public final static int WINDOW_DEICONIFY

 The de-iconify window event.

 WINDOW_MOVED

  public final static int WINDOW_MOVED

 The move window event.

 KEY_PRESS

  public final static int KEY_PRESS

 The key press keyboard event.

 KEY_RELEASE

  public final static int KEY_RELEASE

 The key release keyboard event.

 KEY_ACTION

  public final static int KEY_ACTION

 The action-key press keyboard event.

 KEY_ACTION_RELEASE

  public final static int KEY_ACTION_RELEASE

 The action-key release keyboard event.

 MOUSE_DOWN

  public final static int MOUSE_DOWN

 The mouse down event.

 MOUSE_UP

  public final static int MOUSE_UP

 The mouse up event.

 MOUSE_MOVE

  public final static int MOUSE_MOVE

 The mouse move event.

 MOUSE_ENTER

  public final static int MOUSE_ENTER

 The mouse enter event.

 MOUSE_EXIT

  public final static int MOUSE_EXIT

 The mouse exit event.

 MOUSE_DRAG

  public final static int MOUSE_DRAG

 The mouse drag event.

 SCROLL_LINE_UP

  public final static int SCROLL_LINE_UP

 The line up scroll event.

 SCROLL_LINE_DOWN

  public final static int SCROLL_LINE_DOWN

 The line down scroll event.

 SCROLL_PAGE_UP

  public final static int SCROLL_PAGE_UP

 The page up scroll event.

 SCROLL_PAGE_DOWN

  public final static int SCROLL_PAGE_DOWN

 The page down scroll event.

 SCROLL_ABSOLUTE

  public final static int SCROLL_ABSOLUTE

 The absolute scroll event.

 SCROLL_BEGIN

  public final static int SCROLL_BEGIN

 The scroll begin event.

 SCROLL_END

  public final static int SCROLL_END

 The scroll end event.

 LIST_SELECT

  public final static int LIST_SELECT

 LIST_DESELECT

  public final static int LIST_DESELECT

 ACTION_EVENT

  public final static int ACTION_EVENT

 An action event.

 LOAD_FILE

  public final static int LOAD_FILE

 A file loading event.

 SAVE_FILE

  public final static int SAVE_FILE

 A file saving event.

 GOT_FOCUS

  public final static int GOT_FOCUS

 A component gained the focus.

 LOST_FOCUS

  public final static int LOST_FOCUS

 A component lost the focus.

 target

  public Object target

 The target component.

 when

  public long when

 The time stamp.

 id

  public int id

 The type of this event.

 x

  public int x

 The x coordinate of the event.

 y

  public int y

 The y coordinate of the event.

 key

  public int key

 The key code that was pressed in a keyboard event.

 modifiers

  public int modifiers

 The state of the modifier keys.

 clickCount

  public int clickCount

 The number of consecutive clicks. This field is relevant only for  MOUSE_DOWN events. If the field isn't set it will be 0. Otherwise,  it will be 1 for single-clicks, 2 for double-clicks, and so on.

 arg

  public Object arg

 An arbitrary argument.

 evt

  public Event evt

 The next event. Used when putting events into a linked list.

 Event

  public Event(Object target,
               long when,
               int id,
               int x,
               int y,
               int key,
               int modifiers,
               Object arg)

 Constructs an event with the specified target component, time stamp,  event type, x and y coordinates, keyboard key, state of the modifier  keys and argument.

Parameters:

 target - the target component

 when - the time stamp

 id - the event type

 x - the x coordinate

 y - the y coordinate

 key - the key pressed in a keyboard event

 modifiers - the state of the modifier keys

 arg - the specified argument

 Event

  public Event(Object target,
               long when,
               int id,
               int x,
               int y,
               int key,
               int modifiers)

 Constructs an event with the specified target component, time stamp,  event type, x and y coordinates, keyboard key, state of the modifier  keys and an argument set to null.

Parameters:

 target - the target component

 when - the time stamp

 id - the event type

 x - the x coordinate

 y - the y coordinate

 key - the key pressed in a keyboard event

 modifiers - the state of the modifier keys

 Event

  public Event(Object target,
               int id,
               Object arg)

 Constructs an event with the specified target component,  event type, and argument.

Parameters:

 target - the target component

 id - the event type

 arg - the specified argument

 translate

  public void translate(int x,
                        int y)

 Translates an event relative to the given component. This  involves at a minimum translating the coordinates so they make  sense within the given component. It may also involve  translating a region in the case of an expose event.

Parameters:

 x - the x coordinate

 y - the y coordinate

 shiftDown

  public boolean shiftDown()

 Checks if the shift key is down.

See Also:

modifiers, controlDown, metaDown

 controlDown

  public boolean controlDown()

 Checks if the control key is down.

See Also:

modifiers, shiftDown, metaDown

 metaDown

  public boolean metaDown()

 Checks if the meta key is down.

See Also:

modifiers, shiftDown, controlDown

 paramString

  protected String paramString()

 Returns the parameter String of this Event.

 toString

  public String toString()

 Returns the String representation of this Event's values.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.event.InputEvent

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.event.InputEvent

java.lang.Object
   |
   +----java.util.EventObject
           |
           +----java.awt.AWTEvent
                   |
                   +----java.awt.event.ComponentEvent
                           |
                           +----java.awt.event.InputEvent

______________________________________________________________________________

 public class InputEvent

 extends ComponentEvent

The root event class for all component-level input events.  Input events are delivered to listeners before they are  processed normally by the source where they originated.  This allows listeners and component subclasses to "consume"  the event so that the source will not process them in their  default manner. For example, consuming mousePressed events  on a Button component will prevent the Button from being  activated.

______________________________________________________________________________

 	ALT_MASK

 The alt key modifier constant.

 	BUTTON1_MASK

 The mouse button1 modifier constant.

 	BUTTON2_MASK

 The mouse button2 modifier constant.

 	BUTTON3_MASK

 The mouse button3 modifier constant.

 	CTRL_MASK

 The control key modifier constant.

 	META_MASK

 The meta key modifier constant.

 	SHIFT_MASK

 The shift key modifier constant.

 	consume()

 Consumes this event so that it will not be processed  in the default manner by the source which originated it.

 	getModifiers()

 Returns the modifiers flag for this event.

 	getWhen()

 Returns the timestamp of when this event occurred.

 	isAltDown()

 Returns whether or not the Alt modifier is down on this event.

 	isConsumed()

 Returns whether or not this event has been consumed.

 	isControlDown()

 Returns whether or not the Control modifier is down on this event.

 	isMetaDown()

 Returns whether or not the Meta modifier is down on this event.

 	isShiftDown()

 Returns whether or not the Shift modifier is down on this event.

 SHIFT_MASK

  public final static int SHIFT_MASK

 The shift key modifier constant.

 CTRL_MASK

  public final static int CTRL_MASK

 The control key modifier constant.

 META_MASK

  public final static int META_MASK

 The meta key modifier constant.

 ALT_MASK

  public final static int ALT_MASK

 The alt key modifier constant.

 BUTTON1_MASK

  public final static int BUTTON1_MASK

 The mouse button1 modifier constant.

 BUTTON2_MASK

  public final static int BUTTON2_MASK

 The mouse button2 modifier constant.

 BUTTON3_MASK

  public final static int BUTTON3_MASK

 The mouse button3 modifier constant.

 isShiftDown

  public boolean isShiftDown()

 Returns whether or not the Shift modifier is down on this event.

 isControlDown

  public boolean isControlDown()

 Returns whether or not the Control modifier is down on this event.

 isMetaDown

  public boolean isMetaDown()

 Returns whether or not the Meta modifier is down on this event.

 isAltDown

  public boolean isAltDown()

 Returns whether or not the Alt modifier is down on this event.

 getWhen

  public long getWhen()

 Returns the timestamp of when this event occurred.

 getModifiers

  public int getModifiers()

 Returns the modifiers flag for this event.

 consume

  public void consume()

 Consumes this event so that it will not be processed  in the default manner by the source which originated it.

Overrides:

consume in class AWTEvent

 isConsumed

  public boolean isConsumed()

 Returns whether or not this event has been consumed.

Overrides:

isConsumed in class AWTEvent

See Also:

consume

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.event.ItemEvent

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.event.ItemEvent

java.lang.Object
   |
   +----java.util.EventObject
           |
           +----java.awt.AWTEvent
                   |
                   +----java.awt.event.ItemEvent

______________________________________________________________________________

 public class ItemEvent

 extends AWTEvent

The item event emitted by ItemSelectable objects.  This event is generated when an item is selected, de-selected, expanded,  or contracted.

See Also:

ItemSelectable, ItemListener

______________________________________________________________________________

 	DESELECTED

 The item de-selected state change type.

 	ITEM_FIRST

 Marks the first integer id for the range of item event ids.

 	ITEM_LAST

 Marks the last integer id for the range of item event ids.

 	ITEM_STATE_CHANGED

 The item state changed event type.

 	SELECTED

 The item selected state change type.

 	ItemEvent(ItemSelectable, int, Object, int)

 Constructs a ItemSelectEvent object with the specified ItemSelectable source,  type, item, and item select state.

 	getItem()

 Returns the item where the event occurred.

 	getItemSelectable()

 Returns the ItemSelectable object where this event originated.

 	getStateChange()

 Returns the state change type which generated the event.

 	paramString()

 ITEM_FIRST

  public final static int ITEM_FIRST

 Marks the first integer id for the range of item event ids.

 ITEM_LAST

  public final static int ITEM_LAST

 Marks the last integer id for the range of item event ids.

 ITEM_STATE_CHANGED

  public final static int ITEM_STATE_CHANGED

 The item state changed event type.

 SELECTED

  public final static int SELECTED

 The item selected state change type.

 DESELECTED

  public final static int DESELECTED

 The item de-selected state change type.

 ItemEvent

  public ItemEvent(ItemSelectable source,
                   int id,
                   Object item,
                   int stateChange)

 Constructs a ItemSelectEvent object with the specified ItemSelectable source,  type, item, and item select state.

Parameters:

 source - the ItemSelectable object where the event originated

 getItemSelectable

  public ItemSelectable getItemSelectable()

 Returns the ItemSelectable object where this event originated.

 getItem

  public Object getItem()

 Returns the item where the event occurred.

 getStateChange

  public int getStateChange()

 Returns the state change type which generated the event.

See Also:

SELECTED, DESELECTED

 paramString

  public String paramString()

Overrides:

paramString in class AWTEvent

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.event.ItemListener

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.event.ItemListener

 public interface ItemListener

 extends EventListener

The listener interface for receiving item events.

See Also:

 ItemSelectable

______________________________________________________________________________

 	itemStateChanged(ItemEvent)

 Invoked when an item's state has been changed.

 itemStateChanged

  public abstract void itemStateChanged(ItemEvent e)

 Invoked when an item's state has been changed.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.event.KeyAdapter

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.event.KeyAdapter

java.lang.Object
   |
   +----java.awt.event.KeyAdapter

______________________________________________________________________________

 public class KeyAdapter

 extends Object

 implements KeyListener

The adapter which receives keyboard events.  The methods in this class are empty; this class is provided as a  convenience for easily creating listeners by extending this class  and overriding only the methods of interest.

______________________________________________________________________________

 	KeyAdapter()

 	keyPressed(KeyEvent)

  	keyReleased(KeyEvent)

  	keyTyped(KeyEvent)

 KeyAdapter

  public KeyAdapter()

 keyTyped

  public void keyTyped(KeyEvent e)

 keyPressed

  public void keyPressed(KeyEvent e)

 keyReleased

  public void keyReleased(KeyEvent e)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.event.KeyEvent

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.event.KeyEvent

java.lang.Object
   |
   +----java.util.EventObject
           |
           +----java.awt.AWTEvent
                   |
                   +----java.awt.event.ComponentEvent
                           |
                           +----java.awt.event.InputEvent
                                   |
                                   +----java.awt.event.KeyEvent

______________________________________________________________________________

 public class KeyEvent

 extends InputEvent

The component-level keyboard event.

______________________________________________________________________________

 	CHAR_UNDEFINED

 KEY_PRESSED and KEY_RELEASED events which do not map to a  valid Unicode character do not have a defined keyChar.

 	KEY_FIRST

 Marks the first integer id for the range of key event ids.

 	KEY_LAST

 Marks the last integer id for the range of key event ids.

 	KEY_PRESSED

 The key pressed event type.

 	KEY_RELEASED

 The key released event type.

 	KEY_TYPED

 The key typed event type.

 	VK_0

 VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39)

 	VK_1

  	VK_2

  	VK_3

  	VK_4

  	VK_5

  	VK_6

  	VK_7

  	VK_8

  	VK_9

  	VK_A

 VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A)

 	VK_ACCEPT

  	VK_ADD

  	VK_ALT

  	VK_B

  	VK_BACK_QUOTE

  	VK_BACK_SLASH

  	VK_BACK_SPACE

  	VK_C

  	VK_CANCEL

  	VK_CAPS_LOCK

  	VK_CLEAR

  	VK_CLOSE_BRACKET

  	VK_COMMA

  	VK_CONTROL

  	VK_CONVERT

  	VK_D

  	VK_DECIMAL

  	VK_DELETE

  	VK_DIVIDE

  	VK_DOWN

  	VK_E

  	VK_END

  	VK_ENTER

 Virtual key codes.

 	VK_EQUALS

  	VK_ESCAPE

  	VK_F

  	VK_F1

  	VK_F10

  	VK_F11

  	VK_F12

  	VK_F2

  	VK_F3

  	VK_F4

  	VK_F5

  	VK_F6

  	VK_F7

  	VK_F8

  	VK_F9

  	VK_FINAL

 for Asian Keyboard

 	VK_G

  	VK_H

  	VK_HELP

  	VK_HOME

  	VK_I

  	VK_INSERT

  	VK_J

  	VK_K

  	VK_KANA

  	VK_KANJI

  	VK_L

  	VK_LEFT

  	VK_M

  	VK_META

  	VK_MODECHANGE

  	VK_MULTIPLY

  	VK_N

  	VK_NONCONVERT

  	VK_NUM_LOCK

  	VK_NUMPAD0

  	VK_NUMPAD1

  	VK_NUMPAD2

  	VK_NUMPAD3

  	VK_NUMPAD4

  	VK_NUMPAD5

  	VK_NUMPAD6

  	VK_NUMPAD7

  	VK_NUMPAD8

  	VK_NUMPAD9

  	VK_O

  	VK_OPEN_BRACKET

  	VK_P

  	VK_PAGE_DOWN

  	VK_PAGE_UP

  	VK_PAUSE

  	VK_PERIOD

  	VK_PRINTSCREEN

  	VK_Q

  	VK_QUOTE

  	VK_R

  	VK_RIGHT

  	VK_S

  	VK_SCROLL_LOCK

  	VK_SEMICOLON

  	VK_SEPARATER

  	VK_SHIFT

  	VK_SLASH

  	VK_SPACE

  	VK_SUBTRACT

  	VK_T

  	VK_TAB

  	VK_U

  	VK_UNDEFINED

 KEY_TYPED events do not have a defined keyCode.

 	VK_UP

  	VK_V

  	VK_W

  	VK_X

  	VK_Y

  	VK_Z

 	KeyEvent(Component, int, long, int, int)

  	KeyEvent (Component, int, long, int, int, char)

 Constructs a KeyEvent object with the specified source component,  type, modifiers, and key.

 	getKeyChar()

 Returns the character associated with the key in this event.

 	getKeyCode()

 Returns the integer key-code associated with the key in this event.

 	getKeyModifiersText(int)

 Returns a String describing the modifier key(s), such as "Shift",  or "Ctrl+Shift".

 	getKeyText(int)

 Returns a String describing the keyCode, such as "HOME", "F1" or "A".

 	isActionKey()

 Returns whether or not the key in this event is an "action" key.

 	paramString()

  	setKeyChar(char)

  	setKeyCode(int)

  	setModifiers(int)

 KEY_FIRST

  public final static int KEY_FIRST

 Marks the first integer id for the range of key event ids.

 KEY_LAST

  public final static int KEY_LAST

 Marks the last integer id for the range of key event ids.

 KEY_TYPED

  public final static int KEY_TYPED

 The key typed event type. This type is generated by a combination  of a key press followed by a key release.

 KEY_PRESSED

  public final static int KEY_PRESSED

 The key pressed event type.

 KEY_RELEASED

  public final static int KEY_RELEASED

 The key released event type.

 VK_ENTER

  public final static int VK_ENTER

 Virtual key codes. These codes report which keyboard key has  been pressed, rather than any character generated by one or more  keys being pressed.  For example, pressing the Shift key will cause a KEY_PRESSED event  with a VK_SHIFT keyCode, while pressing the 'a' key will result in  a VK_A keyCode. After the 'a' key is released, a KEY_RELEASED event  will be fired with VK_A, followed by a KEY_TYPED event with a keyChar  value of 'A'. Key combinations which do not result in characters,  such as action keys like F1, will not generate KEY_TYPED events.  Note: not all keyboards or systems are capable of generating all  virtual key codes. No attempt is made in Java to artificially  generate these keys.  WARNING: aside from those keys where are defined by the Java language  (VK_ENTER, VK_BACK_SPACE, and VK_TAB), do not rely on the values of these  constants. Sun reserves the right to change these values as needed  to accomodate a wider range of keyboards in the future.

 VK_BACK_SPACE

  public final static int VK_BACK_SPACE

 VK_TAB

  public final static int VK_TAB

 VK_CANCEL

  public final static int VK_CANCEL

 VK_CLEAR

  public final static int VK_CLEAR

 VK_SHIFT

  public final static int VK_SHIFT

 VK_CONTROL

  public final static int VK_CONTROL

 VK_ALT

  public final static int VK_ALT

 VK_PAUSE

  public final static int VK_PAUSE

 VK_CAPS_LOCK

  public final static int VK_CAPS_LOCK

 VK_ESCAPE

  public final static int VK_ESCAPE

 VK_SPACE

  public final static int VK_SPACE

 VK_PAGE_UP

  public final static int VK_PAGE_UP

 VK_PAGE_DOWN

  public final static int VK_PAGE_DOWN

 VK_END

  public final static int VK_END

 VK_HOME

  public final static int VK_HOME

 VK_LEFT

  public final static int VK_LEFT

 VK_UP

  public final static int VK_UP

 VK_RIGHT

  public final static int VK_RIGHT

 VK_DOWN

  public final static int VK_DOWN

 VK_COMMA

  public final static int VK_COMMA

 VK_PERIOD

  public final static int VK_PERIOD

 VK_SLASH

  public final static int VK_SLASH

 VK_0

  public final static int VK_0

 VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39)

 VK_1

  public final static int VK_1

 VK_2

  public final static int VK_2

 VK_3

  public final static int VK_3

 VK_4

  public final static int VK_4

 VK_5

  public final static int VK_5

 VK_6

  public final static int VK_6

 VK_7

  public final static int VK_7

 VK_8

  public final static int VK_8

 VK_9

  public final static int VK_9

 VK_SEMICOLON

  public final static int VK_SEMICOLON

 VK_EQUALS

  public final static int VK_EQUALS

 VK_A

  public final static int VK_A

 VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A)

 VK_B

  public final static int VK_B

 VK_C

  public final static int VK_C

 VK_D

  public final static int VK_D

 VK_E

  public final static int VK_E

 VK_F

  public final static int VK_F

 VK_G

  public final static int VK_G

 VK_H

  public final static int VK_H

 VK_I

  public final static int VK_I

 VK_J

  public final static int VK_J

 VK_K

  public final static int VK_K

 VK_L

  public final static int VK_L

 VK_M

  public final static int VK_M

 VK_N

  public final static int VK_N

 VK_O

  public final static int VK_O

 VK_P

  public final static int VK_P

 VK_Q

  public final static int VK_Q

 VK_R

  public final static int VK_R

 VK_S

  public final static int VK_S

 VK_T

  public final static int VK_T

 VK_U

  public final static int VK_U

 VK_V

  public final static int VK_V

 VK_W

  public final static int VK_W

 VK_X

  public final static int VK_X

 VK_Y

  public final static int VK_Y

 VK_Z

  public final static int VK_Z

 VK_OPEN_BRACKET

  public final static int VK_OPEN_BRACKET

 VK_BACK_SLASH

  public final static int VK_BACK_SLASH

 VK_CLOSE_BRACKET

  public final static int VK_CLOSE_BRACKET

 VK_NUMPAD0

  public final static int VK_NUMPAD0

 VK_NUMPAD1

  public final static int VK_NUMPAD1

 VK_NUMPAD2

  public final static int VK_NUMPAD2

 VK_NUMPAD3

  public final static int VK_NUMPAD3

 VK_NUMPAD4

  public final static int VK_NUMPAD4

 VK_NUMPAD5

  public final static int VK_NUMPAD5

 VK_NUMPAD6

  public final static int VK_NUMPAD6

 VK_NUMPAD7

  public final static int VK_NUMPAD7

 VK_NUMPAD8

  public final static int VK_NUMPAD8

 VK_NUMPAD9

  public final static int VK_NUMPAD9

 VK_MULTIPLY

  public final static int VK_MULTIPLY

 VK_ADD

  public final static int VK_ADD

 VK_SEPARATER

  public final static int VK_SEPARATER

 VK_SUBTRACT

  public final static int VK_SUBTRACT

 VK_DECIMAL

  public final static int VK_DECIMAL

 VK_DIVIDE

  public final static int VK_DIVIDE

 VK_F1

  public final static int VK_F1

 VK_F2

  public final static int VK_F2

 VK_F3

  public final static int VK_F3

 VK_F4

  public final static int VK_F4

 VK_F5

  public final static int VK_F5

 VK_F6

  public final static int VK_F6

 VK_F7

  public final static int VK_F7

 VK_F8

  public final static int VK_F8

 VK_F9

  public final static int VK_F9

 VK_F10

  public final static int VK_F10

 VK_F11

  public final static int VK_F11

 VK_F12

  public final static int VK_F12

 VK_DELETE

  public final static int VK_DELETE

 VK_NUM_LOCK

  public final static int VK_NUM_LOCK

 VK_SCROLL_LOCK

  public final static int VK_SCROLL_LOCK

 VK_PRINTSCREEN

  public final static int VK_PRINTSCREEN

 VK_INSERT

  public final static int VK_INSERT

 VK_HELP

  public final static int VK_HELP

 VK_META

  public final static int VK_META

 VK_BACK_QUOTE

  public final static int VK_BACK_QUOTE

 VK_QUOTE

  public final static int VK_QUOTE

 VK_FINAL

  public final static int VK_FINAL

 for Asian Keyboard

 VK_CONVERT

  public final static int VK_CONVERT

 VK_NONCONVERT

  public final static int VK_NONCONVERT

 VK_ACCEPT

  public final static int VK_ACCEPT

 VK_MODECHANGE

  public final static int VK_MODECHANGE

 VK_KANA

  public final static int VK_KANA

 VK_KANJI

  public final static int VK_KANJI

 VK_UNDEFINED

  public final static int VK_UNDEFINED

 KEY_TYPED events do not have a defined keyCode.

 CHAR_UNDEFINED

  public final static char CHAR_UNDEFINED

 KEY_PRESSED and KEY_RELEASED events which do not map to a  valid Unicode character do not have a defined keyChar.

 KeyEvent

  public KeyEvent(Component source,
                  int id,
                  long when,
                  int modifiers,
                  int keyCode,
                  char keyChar)

 Constructs a KeyEvent object with the specified source component,  type, modifiers, and key.

Parameters:

 source - the object where the event originated

 KeyEvent

  public KeyEvent(Component source,
                  int id,
                  long when,
                  int modifiers,
                  int keyCode)

 getKeyCode

  public int getKeyCode()

 Returns the integer key-code associated with the key in this event.  For KEY_TYPED events, keyCode is VK_UNDEFINED.

 setKeyCode

  public void setKeyCode(int keyCode)

 setKeyChar

  public void setKeyChar(char keyChar)

 setModifiers

  public void setModifiers(int modifiers)

 getKeyChar

  public char getKeyChar()

 Returns the character associated with the key in this event.  If no valid Unicode character exists for this key event, keyChar  is CHAR_UNDEFINED.

 getKeyText

  public static String getKeyText(int keyCode)

 Returns a String describing the keyCode, such as "HOME", "F1" or "A".  These strings can be localized by changing the awt.properties file.

 getKeyModifiersText

  public static String getKeyModifiersText(int modifiers)

 Returns a String describing the modifier key(s), such as "Shift",  or "Ctrl+Shift". These strings can be localized by changing the  awt.properties file.

 isActionKey

  public boolean isActionKey()

 Returns whether or not the key in this event is an "action" key.

 paramString

  public String paramString()

Overrides:

paramString in class ComponentEvent

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.event.KeyListener

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.event.KeyListener

 public interface KeyListener

 extends EventListener

The listener interface for receiving keyboard events.

______________________________________________________________________________

 	keyPressed(KeyEvent)

 Invoked when a key has been pressed.

 	keyReleased(KeyEvent)

 Invoked when a key has been released.

 	keyTyped(KeyEvent)

 Invoked when a key has been typed.

 keyTyped

  public abstract void keyTyped(KeyEvent e)

 Invoked when a key has been typed.  This event occurs when a key press is followed by a key release.

 keyPressed

  public abstract void keyPressed(KeyEvent e)

 Invoked when a key has been pressed.

 keyReleased

  public abstract void keyReleased(KeyEvent e)

 Invoked when a key has been released.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.event.MouseAdapter

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.event.MouseAdapter

java.lang.Object
   |
   +----java.awt.event.MouseAdapter

______________________________________________________________________________

 public class MouseAdapter

 extends Object

 implements MouseListener

The adapter which receives mouse events.  The methods in this class are empty; this class is provided as a  convenience for easily creating listeners by extending this class  and overriding only the methods of interest.

______________________________________________________________________________

 	MouseAdapter()

 	mouseClicked(MouseEvent)

  	mouseEntered(MouseEvent)

  	mouseExited(MouseEvent)

  	mousePressed(MouseEvent)

  	mouseReleased(MouseEvent)

 MouseAdapter

  public MouseAdapter()

 mouseClicked

  public void mouseClicked(MouseEvent e)

 mousePressed

  public void mousePressed(MouseEvent e)

 mouseReleased

  public void mouseReleased(MouseEvent e)

 mouseEntered

  public void mouseEntered(MouseEvent e)

 mouseExited

  public void mouseExited(MouseEvent e)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.event.MouseEvent

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.event.MouseEvent

java.lang.Object
   |
   +----java.util.EventObject
           |
           +----java.awt.AWTEvent
                   |
                   +----java.awt.event.ComponentEvent
                           |
                           +----java.awt.event.InputEvent
                                   |
                                   +----java.awt.event.MouseEvent

______________________________________________________________________________

 public class MouseEvent

 extends InputEvent

The mouse event.

______________________________________________________________________________

 	MOUSE_CLICKED

 The mouse clicked event type.

 	MOUSE_DRAGGED

 The mouse dragged event type.

 	MOUSE_ENTERED

 The mouse entered event type.

 	MOUSE_EXITED

 The mouse exited event type.

 	MOUSE_FIRST

 Marks the first integer id for the range of mouse event ids.

 	MOUSE_LAST

 Marks the last integer id for the range of mouse event ids.

 	MOUSE_MOVED

 The mouse moved event type.

 	MOUSE_PRESSED

 The mouse pressed event type.

 	MOUSE_RELEASED

 The mouse released event type.

 	MouseEvent (Component, int, long, int, int, int, int, boolean)

 Constructs a MouseEvent object with the specified source component,  type, modifiers, coordinates, and click count.

 	getClickCount()

 Return the number of mouse clicks associated with this event.

 	getPoint()

 Returns the x,y position of the event relative to the source component.

 	getX()

 Returns the x position of the event relative to the source component.

 	getY()

 Returns the y position of the event relative to the source component.

 	isPopupTrigger()

 Returns whether or not this mouse event is the popup-menu  trigger event for the platform.

 	paramString()

  	translatePoint(int, int)

 Translates the coordinate position of the event by x, y.

 MOUSE_FIRST

  public final static int MOUSE_FIRST

 Marks the first integer id for the range of mouse event ids.

 MOUSE_LAST

  public final static int MOUSE_LAST

 Marks the last integer id for the range of mouse event ids.

 MOUSE_CLICKED

  public final static int MOUSE_CLICKED

 The mouse clicked event type.

 MOUSE_PRESSED

  public final static int MOUSE_PRESSED

 The mouse pressed event type.

 MOUSE_RELEASED

  public final static int MOUSE_RELEASED

 The mouse released event type.

 MOUSE_MOVED

  public final static int MOUSE_MOVED

 The mouse moved event type.

 MOUSE_ENTERED

  public final static int MOUSE_ENTERED

 The mouse entered event type.

 MOUSE_EXITED

  public final static int MOUSE_EXITED

 The mouse exited event type.

 MOUSE_DRAGGED

  public final static int MOUSE_DRAGGED

 The mouse dragged event type.

 MouseEvent

  public MouseEvent(Component source,
                    int id,
                    long when,
                    int modifiers,
                    int x,
                    int y,
                    int clickCount,
                    boolean popupTrigger)

 Constructs a MouseEvent object with the specified source component,  type, modifiers, coordinates, and click count.

Parameters:

 source - the object where the event originated

 getX

  public int getX()

 Returns the x position of the event relative to the source component.

 getY

  public int getY()

 Returns the y position of the event relative to the source component.

 getPoint

  public Point getPoint()

 Returns the x,y position of the event relative to the source component.

 translatePoint

  public synchronized void translatePoint(int x,
                                          int y)

 Translates the coordinate position of the event by x, y.

Parameters:

 x - the x value added to the current x coordinate position

 y - the y value added to the current y coordinate position

 getClickCount

  public int getClickCount()

 Return the number of mouse clicks associated with this event.

 isPopupTrigger

  public boolean isPopupTrigger()

 Returns whether or not this mouse event is the popup-menu  trigger event for the platform.

 paramString

  public String paramString()

Overrides:

paramString in class ComponentEvent

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.event.MouseListener

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.event.MouseListener

 public interface MouseListener

 extends EventListener

The listener interface for receiving mouse events on a component.

______________________________________________________________________________

 	mouseClicked(MouseEvent)

 Invoked when the mouse has been clicked on a component.

 	mouseEntered(MouseEvent)

 Invoked when the mouse enters a component.

 	mouseExited(MouseEvent)

 Invoked when the mouse exits a component.

 	mousePressed(MouseEvent)

 Invoked when a mouse button has been pressed on a component.

 	mouseReleased(MouseEvent)

 Invoked when a mouse button has been released on a component.

 mouseClicked

  public abstract void mouseClicked(MouseEvent e)

 Invoked when the mouse has been clicked on a component.

 mousePressed

  public abstract void mousePressed(MouseEvent e)

 Invoked when a mouse button has been pressed on a component.

 mouseReleased

  public abstract void mouseReleased(MouseEvent e)

 Invoked when a mouse button has been released on a component.

 mouseEntered

  public abstract void mouseEntered(MouseEvent e)

 Invoked when the mouse enters a component.

 mouseExited

  public abstract void mouseExited(MouseEvent e)

 Invoked when the mouse exits a component.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.event.MouseMotionAdapter

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.event.MouseMotionAdapter

java.lang.Object
   |
   +----java.awt.event.MouseMotionAdapter

______________________________________________________________________________

 public class MouseMotionAdapter

 extends Object

 implements MouseMotionListener

The adapter which receives mouse motion events.  The methods in this class are empty; this class is provided as a  convenience for easily creating listeners by extending this class  and overriding only the methods of interest.

______________________________________________________________________________

 	MouseMotionAdapter()

 	mouseDragged(MouseEvent)

  	mouseMoved(MouseEvent)

 MouseMotionAdapter

  public MouseMotionAdapter()

 mouseDragged

  public void mouseDragged(MouseEvent e)

 mouseMoved

  public void mouseMoved(MouseEvent e)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.event.MouseMotionListener

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.event.MouseMotionListener

 public interface MouseMotionListener

 extends EventListener

The listener interface for receiving mouse motion events on a component.

______________________________________________________________________________

 	mouseDragged(MouseEvent)

 Invoked when a mouse button is pressed on a component and then  dragged.

 	mouseMoved(MouseEvent)

 Invoked when the mouse button has been moved on a component  (with no buttons no down).

 mouseDragged

  public abstract void mouseDragged(MouseEvent e)

 Invoked when a mouse button is pressed on a component and then  dragged. Mouse drag events will continue to be delivered to  the component where the first originated until the mouse button is  released (regardless of whether the mouse position is within the  bounds of the component).

 mouseMoved

  public abstract void mouseMoved(MouseEvent e)

 Invoked when the mouse button has been moved on a component  (with no buttons no down).

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.event.PaintEvent

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.event.PaintEvent

java.lang.Object
   |
   +----java.util.EventObject
           |
           +----java.awt.AWTEvent
                   |
                   +----java.awt.event.ComponentEvent
                           |
                           +----java.awt.event.PaintEvent

______________________________________________________________________________

 public class PaintEvent

 extends ComponentEvent

The component-level paint event.  This event is a special type which is used to ensure that  paint/update method calls are serialized along with the other  events delivered from the event queue. This event is not  designed to be used with the Event Listener model; programs  should continue to override paint/update methods in order  render themselves properly.

______________________________________________________________________________

 	PAINT

 The paint event type.

 	PAINT_FIRST

 Marks the first integer id for the range of paint event ids.

 	PAINT_LAST

 Marks the last integer id for the range of paint event ids.

 	UPDATE

 The update event type.

 	PaintEvent(Component, int, Rectangle)

 Constructs a FocusEvent object with the specified source component  and type.

 	getUpdateRect()

 Returns the rectangle representing the area which needs to be  repainted in response to this event.

 	paramString()

  	setUpdateRect(Rectangle)

 Sets the rectangle representing the area which needs to be  repainted in response to this event.

 PAINT_FIRST

  public final static int PAINT_FIRST

 Marks the first integer id for the range of paint event ids.

 PAINT_LAST

  public final static int PAINT_LAST

 Marks the last integer id for the range of paint event ids.

 PAINT

  public final static int PAINT

 The paint event type.

 UPDATE

  public final static int UPDATE

 The update event type.

 PaintEvent

  public PaintEvent(Component source,
                    int id,
                    Rectangle updateRect)

 Constructs a FocusEvent object with the specified source component  and type.

Parameters:

 source - the object where the event originated

 getUpdateRect

  public Rectangle getUpdateRect()

 Returns the rectangle representing the area which needs to be  repainted in response to this event.

 setUpdateRect

  public void setUpdateRect(Rectangle updateRect)

 Sets the rectangle representing the area which needs to be  repainted in response to this event.

Parameters:

 updateRect - the rectangle area which needs to be repainted

 paramString

  public String paramString()

Overrides:

paramString in class ComponentEvent

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.event.TextEvent

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.event.TextEvent

java.lang.Object
   |
   +----java.util.EventObject
           |
           +----java.awt.AWTEvent
                   |
                   +----java.awt.event.TextEvent

______________________________________________________________________________

 public class TextEvent

 extends AWTEvent

The text event emitted by TextComponents.

See Also:

TextComponent, TextEventListener

______________________________________________________________________________

 	TEXT_FIRST

 Marks the first integer id for the range of adjustment event ids.

 	TEXT_LAST

 Marks the last integer id for the range of adjustment event ids.

 	TEXT_VALUE_CHANGED

 The adjustment value changed event.

 	TextEvent(Object, int)

 Constructs a TextEvent object with the specified TextComponent source,  and type.

 	paramString()

 TEXT_FIRST

  public final static int TEXT_FIRST

 Marks the first integer id for the range of adjustment event ids.

 TEXT_LAST

  public final static int TEXT_LAST

 Marks the last integer id for the range of adjustment event ids.

 TEXT_VALUE_CHANGED

  public final static int TEXT_VALUE_CHANGED

 The adjustment value changed event.

 TextEvent

  public TextEvent(Object source,
                   int id)

 Constructs a TextEvent object with the specified TextComponent source,  and type.

Parameters:

 source - the TextComponent where the event originated

 paramString

  public String paramString()

Overrides:

paramString in class AWTEvent

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.event.TextListener

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.event.TextListener

 public interface TextListener

 extends EventListener

The listener interface for receiving adjustment events.

______________________________________________________________________________

 	textValueChanged(TextEvent)

 Invoked when the value of the text has changed.

 textValueChanged

  public abstract void textValueChanged(TextEvent e)

 Invoked when the value of the text has changed.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.event.WindowAdapter

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.event.WindowAdapter

java.lang.Object
   |
   +----java.awt.event.WindowAdapter

______________________________________________________________________________

 public class WindowAdapter

 extends Object

 implements WindowListener

The adapter which receives window events.  The methods in this class are empty; this class is provided as a  convenience for easily creating listeners by extending this class  and overriding only the methods of interest.

______________________________________________________________________________

 	WindowAdapter()

 	windowActivated(WindowEvent)

  	windowClosed(WindowEvent)

  	windowClosing(WindowEvent)

  	windowDeactivated (WindowEvent)

  	windowDeiconified (WindowEvent)

  	windowIconified(WindowEvent)

  	windowOpened(WindowEvent)

 WindowAdapter

  public WindowAdapter()

 windowOpened

  public void windowOpened(WindowEvent e)

 windowClosing

  public void windowClosing(WindowEvent e)

 windowClosed

  public void windowClosed(WindowEvent e)

 windowIconified

  public void windowIconified(WindowEvent e)

 windowDeiconified

  public void windowDeiconified(WindowEvent e)

 windowActivated

  public void windowActivated(WindowEvent e)

 windowDeactivated

  public void windowDeactivated(WindowEvent e)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.event.WindowEvent

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.event.WindowEvent

java.lang.Object
   |
   +----java.util.EventObject
           |
           +----java.awt.AWTEvent
                   |
                   +----java.awt.event.ComponentEvent
                           |
                           +----java.awt.event.WindowEvent

______________________________________________________________________________

 public class WindowEvent

 extends ComponentEvent

The window-level event.

______________________________________________________________________________

 	WINDOW_ACTIVATED

 The window activated event type.

 	WINDOW_CLOSED

 The window closed event type.

 	WINDOW_CLOSING

 The window closing event type.

 	WINDOW_DEACTIVATED

 The window deactivated event type.

 	WINDOW_DEICONIFIED

 The window deiconified event type.

 	WINDOW_FIRST

 Marks the first integer id for the range of window event ids.

 	WINDOW_ICONIFIED

 The window iconified event type.

 	WINDOW_LAST

 Marks the last integer id for the range of window event ids.

 	WINDOW_OPENED

 The window opened event type.

 	WindowEvent(Window, int)

 Constructs a WindowEvent object with the specified source window  and type.

 	getWindow()

 Returns the window where this event originated.

 	paramString()

 WINDOW_FIRST

  public final static int WINDOW_FIRST

 Marks the first integer id for the range of window event ids.

 WINDOW_LAST

  public final static int WINDOW_LAST

 Marks the last integer id for the range of window event ids.

 WINDOW_OPENED

  public final static int WINDOW_OPENED

 The window opened event type. This event is delivered only  the first time a window is made visible.

 WINDOW_CLOSING

  public final static int WINDOW_CLOSING

 The window closing event type. This event is delivered when  the user selects "Quit" from the window's system menu. If  the program does not explicitly hide or destroy the window as  a result of this event, the window close operation will be  cancelled.

 WINDOW_CLOSED

  public final static int WINDOW_CLOSED

 The window closed event type. This event is delivered after  the window has been closed as the result of a call to hide or  destroy.

 WINDOW_ICONIFIED

  public final static int WINDOW_ICONIFIED

 The window iconified event type.

 WINDOW_DEICONIFIED

  public final static int WINDOW_DEICONIFIED

 The window deiconified event type.

 WINDOW_ACTIVATED

  public final static int WINDOW_ACTIVATED

 The window activated event type.

 WINDOW_DEACTIVATED

  public final static int WINDOW_DEACTIVATED

 The window deactivated event type.

 WindowEvent

  public WindowEvent(Window source,
                     int id)

 Constructs a WindowEvent object with the specified source window  and type.

Parameters:

 source - the component where the event originated

 getWindow

  public Window getWindow()

 Returns the window where this event originated.

 paramString

  public String paramString()

Overrides:

paramString in class ComponentEvent

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.event.WindowListener

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.event.WindowListener

 public interface WindowListener

 extends EventListener

The listener interface for receiving window events.

______________________________________________________________________________

 	windowActivated(WindowEvent)

 Invoked when a window is activated.

 	windowClosed(WindowEvent)

 Invoked when a window has been closed.

 	windowClosing(WindowEvent)

 Invoked when a window is in the process of being closed.

 	windowDeactivated(WindowEvent)

 Invoked when a window is de-activated.

 	windowDeiconified(WindowEvent)

 Invoked when a window is de-iconified.

 	windowIconified(WindowEvent)

 Invoked when a window is iconified.

 	windowOpened(WindowEvent)

 Invoked when a window has been opened.

 windowOpened

  public abstract void windowOpened(WindowEvent e)

 Invoked when a window has been opened.

 windowClosing

  public abstract void windowClosing(WindowEvent e)

 Invoked when a window is in the process of being closed.  The close operation can be overridden at this point.

 windowClosed

  public abstract void windowClosed(WindowEvent e)

 Invoked when a window has been closed.

 windowIconified

  public abstract void windowIconified(WindowEvent e)

 Invoked when a window is iconified.

 windowDeiconified

  public abstract void windowDeiconified(WindowEvent e)

 Invoked when a window is de-iconified.

 windowActivated

  public abstract void windowActivated(WindowEvent e)

 Invoked when a window is activated.

 windowDeactivated

  public abstract void windowDeactivated(WindowEvent e)

 Invoked when a window is de-activated.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.EventQueue

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.EventQueue

java.lang.Object
   |
   +----java.awt.EventQueue

______________________________________________________________________________

 public class EventQueue

 extends Object

EventQueue is a platform-independent class that queues events, both  from the underlying peer classes and from trusted application classes.  There is only one EventQueue for the system.

______________________________________________________________________________

 	EventQueue()

 	getNextEvent()

 Remove an event from the queue and return it.

 	peekEvent()

 Return the first event without removing it.

 	peekEvent(int)

  	postEvent(AWTEvent)

 Post a 1.1-style event to the EventQueue.

 EventQueue

  public EventQueue()

 postEvent

  public synchronized void postEvent(AWTEvent theEvent)

 Post a 1.1-style event to the EventQueue.

Parameters:

 theEvent - an instance of java.awt.AWTEvent, or a  subclass of it.

 getNextEvent

  public synchronized AWTEvent getNextEvent() throws InterruptedException

 Remove an event from the queue and return it. This method will  block until an event has been posted by another thread.

Returns:

 the next AWTEvent

Throws: InterruptedException

 if another thread has  interrupted this thread.

 peekEvent

  public synchronized AWTEvent peekEvent()

 Return the first event without removing it.

Returns:

 the first AWTEvent

 peekEvent

  public synchronized AWTEvent peekEvent(int id)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.FileDialog

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.FileDialog

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Window
                           |
                           +----java.awt.Dialog
                                   |
                                   +----java.awt.FileDialog

______________________________________________________________________________

 public class FileDialog

 extends Dialog

The File Dialog class displays a file selection dialog. It is a  modal dialog and will block the calling thread when the show method  is called to display it, until the user has chosen a file.

See Also:

show

______________________________________________________________________________

 	LOAD

 The file load variable.

 	SAVE

 The file save variable.

 	FileDialog(Frame)

 Creates a file dialog for loading a file.

 	FileDialog(Frame, String)

 Creates a file dialog for loading a file.

 	FileDialog(Frame, String, int)

 Creates a file dialog with the specified title and mode.

 	addNotify()

 Creates the file dialog's peer.

 	getDirectory()

 Gets the directory of the Dialog.

 	getFile()

 Gets the file of the Dialog.

 	getFilenameFilter()

 Gets the filter.

 	getMode()

 Gets the mode of the file dialog.

 	paramString()

 Returns the parameter String of this file dialog.

 	setDirectory(String)

 Set the directory of the Dialog to the specified directory.

 	setFile(String)

 Sets the file for this dialog to the specified file.

 	setFilenameFilter(FilenameFilter)

 Sets the filter for this dialog to the specified filter.

 	setMode(int)

 Sets the mode of the file dialog.

 LOAD

  public final static int LOAD

 The file load variable.

 SAVE

  public final static int SAVE

 The file save variable.

 FileDialog

  public FileDialog(Frame parent)

 Creates a file dialog for loading a file. The title of the  file dialog is initialy empty.

Parameters:

 parent - the owner of the dialog

 FileDialog

  public FileDialog(Frame parent,
                    String title)

 Creates a file dialog for loading a file.

Parameters:

 parent - the owner of the dialog

 title - the title of the Dialog

 FileDialog

  public FileDialog(Frame parent,
                    String title,
                    int mode)

 Creates a file dialog with the specified title and mode.

Parameters:

 parent - the owner of the dialog

 title - the title of the Dialog

 mode - the mode of the Dialog

 addNotify

  public void addNotify()

 Creates the file dialog's peer. The peer allows us to change the look  of the file dialog without changing its functionality.

Overrides:

addNotify in class Dialog

 getMode

  public int getMode()

 Gets the mode of the file dialog. The mode determines whether  this file dialog will be used for loading a file (LOAD) or  saving a file (SAVE).

 setMode

  public void setMode(int mode)

 Sets the mode of the file dialog.

Parameters:

 mode - the mode (LOAD or SAVE) for this file dialog.

 getDirectory

  public String getDirectory()

 Gets the directory of the Dialog.

 setDirectory

  public synchronized void setDirectory(String dir)

 Set the directory of the Dialog to the specified directory.

Parameters:

 dir - the specific directory

 getFile

  public String getFile()

 Gets the file of the Dialog.

 setFile

  public synchronized void setFile(String file)

 Sets the file for this dialog to the specified file. This will  become the default file if set before the dialog is shown.

Parameters:

 file - the file being set

 getFilenameFilter

  public FilenameFilter getFilenameFilter()

 Gets the filter.

 setFilenameFilter

  public synchronized void setFilenameFilter(FilenameFilter filter)

 Sets the filter for this dialog to the specified filter.

Parameters:

 filter - the specified filter

 paramString

  protected String paramString()

 Returns the parameter String of this file dialog.  Parameter String.

Overrides:

paramString in class Dialog

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.FlowLayout

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.FlowLayout

java.lang.Object
   |
   +----java.awt.FlowLayout

______________________________________________________________________________

 public class FlowLayout

 extends Object

 implements LayoutManager, Serializable

Flow layout is used to layout buttons in a panel. It will arrange  buttons left to right until no more buttons fit on the same line.  Each line is centered.

______________________________________________________________________________

 	CENTER

 The right alignment variable.

 	LEFT

 The left alignment variable.

 	RIGHT

 The right alignment variable.

 	FlowLayout()

 Constructs a new Flow Layout with a centered alignment and a  default 5-unit horizontal and vertical gap.

 	FlowLayout(int)

 Constructs a new Flow Layout with the specified alignment and a  default 5-unit horizontal and vertical gap.

 	FlowLayout(int, int, int)

 Constructs a new Flow Layout with the specified alignment and gap  values.

 	addLayoutComponent(String, Component)

 Adds the specified component to the layout.

 	getAlignment()

 Returns the alignment value for this layout, one of LEFT,  CENTER, or RIGHT.

 	getHgap()

 Returns the horizontal gap between components.

 	getVgap()

 Returns the vertical gap between components.

 	layoutContainer(Container)

 Lays out the container.

 	minimumLayoutSize(Container)

 Returns the minimum dimensions needed to layout the components  contained in the specified target container.

 	preferredLayoutSize(Container)

 Returns the preferred dimensions for this layout given the components  in the specified target container.

 	removeLayoutComponent(Component)

 Removes the specified component from the layout.

 	setAlignment(int)

 Sets the alignment value for this layout.

 	setHgap(int)

 Sets the horizontal gap between components.

 	setVgap(int)

 Sets the vertical gap between components.

 	toString()

 Returns the String representation of this FlowLayout's values.

 LEFT

  public final static int LEFT

 The left alignment variable.

 CENTER

  public final static int CENTER

 The right alignment variable.

 RIGHT

  public final static int RIGHT

 The right alignment variable.

 FlowLayout

  public FlowLayout()

 Constructs a new Flow Layout with a centered alignment and a  default 5-unit horizontal and vertical gap.

 FlowLayout

  public FlowLayout(int align)

 Constructs a new Flow Layout with the specified alignment and a  default 5-unit horizontal and vertical gap.

Parameters:

 align - the alignment value

 FlowLayout

  public FlowLayout(int align,
                    int hgap,
                    int vgap)

 Constructs a new Flow Layout with the specified alignment and gap  values.

Parameters:

 align - the alignment value

 hgap - the horizontal gap variable

 vgap - the vertical gap variable

 getAlignment

  public int getAlignment()

 Returns the alignment value for this layout, one of LEFT,  CENTER, or RIGHT.

 setAlignment

  public void setAlignment(int align)

 Sets the alignment value for this layout.

Parameters:

 align - the alignment value, one of LEFT, CENTER, or RIGHT.

 getHgap

  public int getHgap()

 Returns the horizontal gap between components.

 setHgap

  public void setHgap(int hgap)

 Sets the horizontal gap between components.

Parameters:

 hgap - the horizontal gap between components

 getVgap

  public int getVgap()

 Returns the vertical gap between components.

 setVgap

  public void setVgap(int vgap)

 Sets the vertical gap between components.

Parameters:

 vgap - the vertical gap between components

 addLayoutComponent

  public void addLayoutComponent(String name,
                                 Component comp)

 Adds the specified component to the layout. Not used by this class.

Parameters:

 name - the name of the component

 comp - the the component to be added

 removeLayoutComponent

  public void removeLayoutComponent(Component comp)

 Removes the specified component from the layout. Not used by  this class.

Parameters:

 comp - the component to remove

 preferredLayoutSize

  public Dimension preferredLayoutSize(Container target)

 Returns the preferred dimensions for this layout given the components  in the specified target container.

Parameters:

 target - the component which needs to be laid out

See Also:

Container, minimumLayoutSize

 minimumLayoutSize

  public Dimension minimumLayoutSize(Container target)

 Returns the minimum dimensions needed to layout the components  contained in the specified target container.

Parameters:

 target - the component which needs to be laid out

See Also:

preferredLayoutSize

 layoutContainer

  public void layoutContainer(Container target)

 Lays out the container. This method will actually reshape the  components in the target in order to satisfy the constraints of  the BorderLayout object.

Parameters:

 target - the specified component being laid out.

See Also:

Container

 toString

  public String toString()

 Returns the String representation of this FlowLayout's values.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Font

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Font

java.lang.Object
   |
   +----java.awt.Font

______________________________________________________________________________

 public class Font

 extends Object

 implements Serializable

A class that produces font objects.

______________________________________________________________________________

 	BOLD

 The bold style constant.

 	ITALIC

 The italicized style constant.

 	name

 The logical name of this font.

 	PLAIN

 The plain style constant.

 	size

 The point size of this font.

 	style

 The style of the font.

 	Font(String, int, int)

 Creates a new font with the specified name, style and point size.

 	decode(String)

 Gets the specified font using the name passed in.

 	equals(Object)

 Compares this object to the specifed object.

 	getFamily()

 Gets the platform specific family name of the font.

 	getFont(String)

 Gets a font from the system properties list.

 	getFont(String, Font)

 Gets the specified font from the system properties list.

 	getName()

 Gets the logical name of the font.

 	getPeer()

 Gets the peer of the font.

 	getSize()

 Gets the point size of the font.

 	getStyle()

 Gets the style of the font.

 	hashCode()

 Returns a hashcode for this font.

 	isBold()

 Returns true if the font is bold.

 	isItalic()

 Returns true if the font is italic.

 	isPlain()

 Returns true if the font is plain.

 	toString()

 Converts this object to a String representation.

 PLAIN

  public final static int PLAIN

 The plain style constant. This can be combined with the other style  constants for mixed styles.

 BOLD

  public final static int BOLD

 The bold style constant. This can be combined with the other style  constants for mixed styles.

 ITALIC

  public final static int ITALIC

 The italicized style constant. This can be combined with the other  style constants for mixed styles.

 name

  protected String name

 The logical name of this font.

 style

  protected int style

 The style of the font. This is the sum of the  constants PLAIN, BOLD, or ITALIC.

 size

  protected int size

 The point size of this font.

 Font

  public Font(String name,
              int style,
              int size)

 Creates a new font with the specified name, style and point size.

Parameters:

 name - the font name

 style - the constant style used

 size - the point size of the font

See Also:

getFontList

 getPeer

  public FontPeer getPeer()

 Gets the peer of the font.

 getFamily

  public String getFamily()

 Gets the platform specific family name of the font.  Use getName to get the logical name of the font.

See Also:

getName

 getName

  public String getName()

 Gets the logical name of the font.

See Also:

getFamily

 getStyle

  public int getStyle()

 Gets the style of the font.

See Also:

isPlain, isBold, isItalic

 getSize

  public int getSize()

 Gets the point size of the font.

 isPlain

  public boolean isPlain()

 Returns true if the font is plain.

See Also:

getStyle

 isBold

  public boolean isBold()

 Returns true if the font is bold.

See Also:

getStyle

 isItalic

  public boolean isItalic()

 Returns true if the font is italic.

See Also:

getStyle

 getFont

  public static Font getFont(String nm)

 Gets a font from the system properties list.

Parameters:

 nm - the property name

 decode

  public static Font decode(String str)

 Gets the specified font using the name passed in.

Parameters:

 str - the name

 getFont

  public static Font getFont(String nm,
                             Font font)

 Gets the specified font from the system properties list.

Parameters:

 nm - the property name

 font - a default font to return if property 'nm' is not defined

 hashCode

  public int hashCode()

 Returns a hashcode for this font.

Overrides:

hashCode in class Object

 equals

  public boolean equals(Object obj)

 Compares this object to the specifed object.

Parameters:

 obj - the object to compare with

Returns:

 true if the objects are the same; false otherwise.

Overrides:

equals in class Object

 toString

  public String toString()

 Converts this object to a String representation.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.FontMetrics

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.FontMetrics

java.lang.Object
   |
   +----java.awt.FontMetrics

______________________________________________________________________________

 public class FontMetrics

 extends Object

 implements Serializable

A font metrics object. Note that the implementations of these  methods are inefficient, they are usually overridden with more  efficient toolkit specific implementations.

______________________________________________________________________________

 	font

 The actual font.

 	FontMetrics(Font)

 Creates a new FontMetrics object with the specified font.

 	bytesWidth(byte[], int, int)

 Returns the total advance width for showing the specified array  of bytes in this Font.

 	charsWidth(char[], int, int)

 Returns the total advance width for showing the specified array  of characters in this Font.

 	charWidth(char)

 Returns the advance width of the specified character in this Font.

 	charWidth(int)

 Returns the advance width of the specified character in this Font.

 	getAscent()

 Gets the font ascent.

 	getDescent()

 Gets the font descent.

 	getFont()

 Gets the font.

 	getHeight()

 Gets the standard height of a line of text in this font.

 	getLeading()

 Gets the standard leading, or line spacing, for the font.

 	getMaxAdvance()

 Gets the maximum advance width of any character in this Font.

 	getMaxAscent()

 Gets the maximum ascent of all characters in this Font.

 	getMaxDecent()

 For backward compatibility only.

 	getMaxDescent()

 Gets the maximum descent of all characters in this Font.

 	getWidths()

 Gets the advance widths of the first 256 characters in the Font.

 	stringWidth(String)

 Returns the total advance width for showing the specified String  in this Font.

 	toString()

 Returns the String representation of this FontMetric's values.

 font

  protected Font font

 The actual font.

See Also:

getFont

 FontMetrics

  protected FontMetrics(Font font)

 Creates a new FontMetrics object with the specified font.

Parameters:

 font - the font

See Also:

Font

 getFont

  public Font getFont()

 Gets the font.

 getLeading

  public int getLeading()

 Gets the standard leading, or line spacing, for the font.  This is the logical amount of space to be reserved between the  descent of one line of text and the ascent of the next line.  The height metric is calculated to include this extra space.

 getAscent

  public int getAscent()

 Gets the font ascent. The font ascent is the distance from the  base line to the top of most Alphanumeric characters. Note,  however, that some characters in the font may extend above  this height.

See Also:

getMaxAscent

 getDescent

  public int getDescent()

 Gets the font descent. The font descent is the distance from the  base line to the bottom of most Alphanumeric characters. Note,  however, that some characters in the font may extend below this  height.

See Also:

getMaxDescent

 getHeight

  public int getHeight()

 Gets the standard height of a line of text in this font. This  is the distance between the baseline of adjacent lines of text.  It is the sum of the leading + ascent + descent. There is no  guarantee that lines of text spaced at this distance will be  disjoint; such lines may overlap if some characters overshoot  either the standard ascent or the standard descent metric.

 getMaxAscent

  public int getMaxAscent()

 Gets the maximum ascent of all characters in this Font.  No character will extend further above the baseline than this  distance.

See Also:

getAscent

 getMaxDescent

  public int getMaxDescent()

 Gets the maximum descent of all characters in this Font.  No character will descend futher below the baseline than this  distance.

See Also:

getDescent

 getMaxDecent

  public int getMaxDecent()

 For backward compatibility only.

See Also:

getMaxDescent

 getMaxAdvance

  public int getMaxAdvance()

 Gets the maximum advance width of any character in this Font.  The advance width is the amount by which the current point is  moved from one character to the next in a line of text.

Returns:

 -1 if the max advance is not known.

 charWidth

  public int charWidth(int ch)

 Returns the advance width of the specified character in this Font.  The advance width is the amount by which the current point is  moved from one character to the next in a line of text.

Parameters:

 ch - the character to be measured

See Also:

stringWidth

 charWidth

  public int charWidth(char ch)

 Returns the advance width of the specified character in this Font.  The advance width is the amount by which the current point is  moved from one character to the next in a line of text.

Parameters:

 ch - the character to be measured

See Also:

stringWidth

 stringWidth

  public int stringWidth(String str)

 Returns the total advance width for showing the specified String  in this Font.  The advance width is the amount by which the current point is  moved from one character to the next in a line of text.

Parameters:

 str - the String to be measured

See Also:

charsWidth, bytesWidth

 charsWidth

  public int charsWidth(char data[],
                        int off,
                        int len)

 Returns the total advance width for showing the specified array  of characters in this Font.  The advance width is the amount by which the current point is  moved from one character to the next in a line of text.

Parameters:

 data - the array of characters to be measured

 off - the start offset of the characters in the array

 len - the number of characters to be measured from the array

See Also:

stringWidth, bytesWidth

 bytesWidth

  public int bytesWidth(byte data[],
                        int off,
                        int len)

 Returns the total advance width for showing the specified array  of bytes in this Font.  The advance width is the amount by which the current point is  moved from one character to the next in a line of text.

Parameters:

 data - the array of bytes to be measured

 off - the start offset of the bytes in the array

 len - the number of bytes to be measured from the array

See Also:

stringWidth, charsWidth

 getWidths

  public int[] getWidths()

 Gets the advance widths of the first 256 characters in the Font.  The advance width is the amount by which the current point is  moved from one character to the next in a line of text.

 toString

  public String toString()

 Returns the String representation of this FontMetric's values.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Frame

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Frame

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Window
                           |
                           +----java.awt.Frame

______________________________________________________________________________

 public class Frame

 extends Window

 implements MenuContainer

A Frame is a top-level window with a title.  The default layout for a frame is BorderLayout.  Frames are capable of generating the following types of window events:  WindowOpened, WindowClosing, WindowClosed, WindowIconified,  WindowDeiconified, WindowActivated, WindowDeactivated.

See Also:

WindowEvent, addWindowListener

______________________________________________________________________________

 	CROSSHAIR_CURSOR

  	DEFAULT_CURSOR

  	E_RESIZE_CURSOR

  	HAND_CURSOR

  	MOVE_CURSOR

  	N_RESIZE_CURSOR

  	NE_RESIZE_CURSOR

  	NW_RESIZE_CURSOR

  	S_RESIZE_CURSOR

  	SE_RESIZE_CURSOR

  	SW_RESIZE_CURSOR

  	TEXT_CURSOR

  	W_RESIZE_CURSOR

  	WAIT_CURSOR

 	Frame()

 Constructs a new Frame that is initially invisible.

 	Frame(String)

 Constructs a new, initially invisible Frame with the specified  title.

 	addNotify()

 Creates the Frame's peer.

 	dispose()

 Disposes of the Frame.

 	getCursorType()

Deprecated.

 	getIconImage()

 Returns the icon image for this Frame.

 	getMenuBar()

 Gets the menu bar for this Frame.

 	getTitle()

 Gets the title of the Frame.

 	isResizable()

 Returns true if the user can resize the Frame.

 	paramString()

 Returns the parameter String of this Frame.

 	remove(MenuComponent)

 Removes the specified menu bar from this Frame.

 	setCursor(int)

Deprecated.

 	setIconImage(Image)

 Sets the image to display when this Frame is iconized.

 	setMenuBar(MenuBar)

 Sets the menubar for this Frame to the specified menubar.

 	setResizable(boolean)

 Sets the resizable flag.

 	setTitle(String)

 Sets the title for this Frame to the specified title.

 DEFAULT_CURSOR

  public final static int DEFAULT_CURSOR

 CROSSHAIR_CURSOR

  public final static int CROSSHAIR_CURSOR

 TEXT_CURSOR

  public final static int TEXT_CURSOR

 WAIT_CURSOR

  public final static int WAIT_CURSOR

 SW_RESIZE_CURSOR

  public final static int SW_RESIZE_CURSOR

 SE_RESIZE_CURSOR

  public final static int SE_RESIZE_CURSOR

 NW_RESIZE_CURSOR

  public final static int NW_RESIZE_CURSOR

 NE_RESIZE_CURSOR

  public final static int NE_RESIZE_CURSOR

 N_RESIZE_CURSOR

  public final static int N_RESIZE_CURSOR

 S_RESIZE_CURSOR

  public final static int S_RESIZE_CURSOR

 W_RESIZE_CURSOR

  public final static int W_RESIZE_CURSOR

 E_RESIZE_CURSOR

  public final static int E_RESIZE_CURSOR

 HAND_CURSOR

  public final static int HAND_CURSOR

 MOVE_CURSOR

  public final static int MOVE_CURSOR

 Frame

  public Frame()

 Constructs a new Frame that is initially invisible.

See Also:

setSize, setVisible

 Frame

  public Frame(String title)

 Constructs a new, initially invisible Frame with the specified  title.

Parameters:

 title - the title for the frame

See Also:

setSize, setVisible

 addNotify

  public void addNotify()

 Creates the Frame's peer. The peer allows us to change the look  of the Frame without changing its functionality.

Overrides:

addNotify in class Window

 getTitle

  public String getTitle()

 Gets the title of the Frame.

See Also:

setTitle

 setTitle

  public synchronized void setTitle(String title)

 Sets the title for this Frame to the specified title.

Parameters:

 title - the specified title of this Frame

See Also:

getTitle

 getIconImage

  public Image getIconImage()

 Returns the icon image for this Frame.

 setIconImage

  public synchronized void setIconImage(Image image)

 Sets the image to display when this Frame is iconized. Note that  not all platforms support the concept of iconizing a window.

Parameters:

 image - the icon image to be displayed

 getMenuBar

  public MenuBar getMenuBar()

 Gets the menu bar for this Frame.

 setMenuBar

  public synchronized void setMenuBar(MenuBar mb)

 Sets the menubar for this Frame to the specified menubar.

Parameters:

 mb - the menubar being set

 isResizable

  public boolean isResizable()

 Returns true if the user can resize the Frame.

 setResizable

  public synchronized void setResizable(boolean resizable)

 Sets the resizable flag.

Parameters:

 resizable - true if resizable; false otherwise.

 remove

  public synchronized void remove(MenuComponent m)

 Removes the specified menu bar from this Frame.

Overrides:

remove in class Component

 dispose

  public synchronized void dispose()

 Disposes of the Frame. This method must  be called to release the resources that  are used for the frame. All components  contained by the frame and all windows  owned by the frame will also be destroyed.

Overrides:

dispose in class Window

 paramString

  protected String paramString()

 Returns the parameter String of this Frame.

Overrides:

paramString in class Container

 setCursor

  public synchronized void setCursor(int cursorType)

 Note: setCursor() is deprecated. As of JDK version 1.1,  replaced by Component.setCursor(Cursor).

 getCursorType

  public int getCursorType()

 Note: getCursorType() is deprecated. As of JDK version 1.1,  replaced by Component.getCursor().

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Graphics

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Graphics

java.lang.Object
   |
   +----java.awt.Graphics

______________________________________________________________________________

 public class Graphics

 extends Object

Graphics is the abstract base class for all graphics contexts  which allow an application to draw onto components realized on  various devices or onto off-screen images.  A Graphics object encapsulates the state information needed  for the various rendering operations that Java supports. This  state information includes:

• The Component to draw on

• A translation origin for rendering and clipping coordinates

• The current clip

• The current color

• The current font

• The current logical pixel operation function (XOR or Paint)

• The current XOR alternation color  (see setXORMode)

 Coordinates are infinitely thin and lie between the pixels of the  output device.  Operations which draw the outline of a figure operate by traversing  along the infinitely thin path with a pixel-sized pen that hangs  down and to the right of the anchor point on the path.  Operations which fill a figure operate by filling the interior  of the infinitely thin path.  Operations which render horizontal text render the ascending  portion of the characters entirely above the baseline coordinate.

 Some important points to consider are that drawing a figure that  covers a given rectangle will occupy one extra row of pixels on  the right and bottom edges compared to filling a figure that is  bounded by that same rectangle.  Also, drawing a horizontal line along the same y coordinate as  the baseline of a line of text will draw the line entirely below  the text except for any descenders.  Both of these properties are due to the pen hanging down and to  the right from the path that it traverses.

 All coordinates which appear as arguments to the methods of this  Graphics object are considered relative to the translation origin  of this Graphics object prior to the invocation of the method.  All rendering operations modify only pixels which lie within the  area bounded by both the current clip of the graphics context  and the extents of the Component used to create the Graphics object.

______________________________________________________________________________

 	Graphics()

 Constructs a new Graphics object.

 	clearRect(int, int, int, int)

 Clears the specified rectangle by filling it with the background  color of the current drawing surface.

 	clipRect(int, int, int, int)

 Intersects the current clip with the specified rectangle.

 	copyArea(int, int, int, int, int, int)

 Copies an area of the Component by a distance specified by dx  and dy to the right and down.

 	create()

 Creates a new Graphics object that is a copy of this Graphics object.

 	create(int, int, int, int)

 Creates a new Graphics object based on this Graphics object,  but with a new translation and clip area.

 	dispose()

 Dispose of the system resources used by this graphics context.

 	draw3DRect(int, int, int, int, boolean)

 Draws a 3-D highlighted outline of the specified rectangle.

 	drawArc(int, int, int, int, int, int)

 Draws the outline of an arc covering the specified rectangle,  starting at startAngle and extending for arcAngle degrees,  using the current color.

 	drawBytes(byte[], int, int, int, int)

 Draws the specified bytes using the current font and color.

 	drawChars(char[], int, int, int, int)

 Draws the specified characters using the current font and color.

 	drawImage(Image, int, int, Color, ImageObserver)

 Draws as much of the specified image as is currently available at  the specified coordinate (x, y) with the given solid background color.

 	drawImage(Image, int, int, ImageObserver)

 Draws as much of the specified image as is currently available at  the specified coordinate (x, y).

 	drawImage (Image, int, int, int, int, Color, ImageObserver)

 Draws as much of the specified image as has already been scaled  to fit inside the specified rectangle with the given solid  background color.

 	drawImage(Image, int, int, int, int, ImageObserver)

 Draws as much of the specified image as has already been scaled  to fit inside the specified rectangle.

 	drawImage (Image, int, int, int, int, int, int, int, int, Color, ImageObserver)

 Draws as much of the specified area of the specified image as is  currently available, scaling it on the fly to fit inside the  specified area of the destination drawable surface with the  given solid background color.

 	drawImage (Image, int, int, int, int, int, int, int, int, ImageObserver)

 Draws as much of the specified area of the specified image as is  currently available, scaling it on the fly to fit inside the  specified area of the destination drawable surface.

 	drawLine(int, int, int, int)

 Draws a line between the coordinates (x1,y1) and (x2,y2) using  the current color.

 	drawOval(int, int, int, int)

 Draws the outline of an oval covering the specified rectangle  using the current color.

 	drawPolygon(int[], int[], int)

 Draws the outline of a polygon defined by arrays of x coordinates  and y coordinates using the current color.

 	drawPolygon(Polygon)

 Draws the outline of a polygon defined by the specified Polygon  object using the current color.

 	drawPolyline(int[], int[], int)

 Draws a sequence of connected lines defined by arrays of x coordinates  and y coordinates using the current color.

 	drawRect(int, int, int, int)

 Draws the outline of the specified rectangle using the current  color.

 	drawRoundRect(int, int, int, int, int, int)

 Draws the outline of the specified rounded corner rectangle  using the current color.

 	drawString(String, int, int)

 Draws the specified String using the current font and color.

 	fill3DRect(int, int, int, int, boolean)

 Paints a 3-D highlighted rectangle filled with the current color.

 	fillArc(int, int, int, int, int, int)

 Fills an arc bounded by the specified rectangle, starting at  startAngle and extending for arcAngle degrees, with the  current color.

 	fillOval(int, int, int, int)

 Fills an oval bounded by the specified rectangle with the  current color.

 	fillPolygon(int[], int[], int)

 Fills a polygon defined by arrays of x coordinates and y  coordinates with the current color using an even-odd fill  rule (otherwise known as an alternating rule).

 	fillPolygon(Polygon)

 Fills the polygon defined by the specified Polygon object with  the current color using an even-odd fill rule (otherwise known  as an alternating rule).

 	fillRect(int, int, int, int)

 Fills the specified rectangle with the current color.

 	fillRoundRect(int, int, int, int, int, int)

 Fills the specified rounded corner rectangle with the current color.

 	finalize()

 Disposes of this graphics context once it is no longer referenced.

 	getClip()

 Return a Shape object representing the current clipping area.

 	getClipBounds()

 Returns the bounding rectangle of the current clipping area.

 	getClipRect()

Deprecated.

 	getColor()

 Gets the current color.

 	getFont()

 Gets the current font.

 	getFontMetrics()

 Gets the font metrics of the current font.

 	getFontMetrics(Font)

 Gets the font metrics for the specified font.

 	setClip(int, int, int, int)

 Sets the current clip to the rectangle specified by the given  coordinates.

 	setClip(Shape)

 Set the current clipping area to an arbitrary clip shape.

 	setColor(Color)

 Sets the current color to the specified color.

 	setFont(Font)

 Sets the font for all subsequent text rendering operations.

 	setPaintMode()

 Sets the logical pixel operation function to the Paint, or  overwrite mode.

 	setXORMode(Color)

 Sets the logical pixel operation function to the XOR mode,  which alternates pixels between the current color and a new  specified XOR alternation color.

 	toString()

 Returns a String object representing this Graphics object's value.

 	translate(int, int)

 Translates the origin of the graphics context to the point  (x, y) in the current coordinate system.

 Graphics

  protected Graphics()

 Constructs a new Graphics object. Since Graphics is an abstract  class, and since it must be customized by subclasses for different  output devices, Graphics objects cannot be created directly.  Instead, Graphics objects must be obtained from another Graphics  object or created by a Component.

See Also:

getGraphics, create

 create

  public abstract Graphics create()

 Creates a new Graphics object that is a copy of this Graphics object.

 create

  public Graphics create(int x,
                         int y,
                         int width,
                         int height)

 Creates a new Graphics object based on this Graphics object,  but with a new translation and clip area.  The new Graphics object will have its origin translated to the  specified coordinate (x, y) and will also have its current clip  intersected with the specified rectangle. The arguments are all  interpreted in the coordinate system of the original Graphics  object.

Parameters:

 x - the x coordinate of the new translation origin  and rectangle to intersect the clip with

 y - the y coordinate of the new translation origin  and rectangle to intersect the clip with

 width - the width of the rectangle to intersect the clip with

 height - the height of the rectangle to intersect the clip with

See Also:

translate, clipRect

 translate

  public abstract void translate(int x,
                                 int y)

 Translates the origin of the graphics context to the point  (x, y) in the current coordinate system. All coordinates  used in subsequent rendering operations on this graphics  context will be relative to this new origin.

Parameters:

 x - the x coordinate of the new translation origin

 y - the y coordinate of the new translation origin

 getColor

  public abstract Color getColor()

 Gets the current color.

See Also:

Color, setColor

 setColor

  public abstract void setColor(Color c)

 Sets the current color to the specified color. All subsequent  rendering operations will use this specified color.

Parameters:

 c - the new rendering color

See Also:

Color, getColor

 setPaintMode

  public abstract void setPaintMode()

 Sets the logical pixel operation function to the Paint, or  overwrite mode. All subsequent rendering operations will  overwrite the destination with the current color.

 setXORMode

  public abstract void setXORMode(Color c1)

 Sets the logical pixel operation function to the XOR mode,  which alternates pixels between the current color and a new  specified XOR alternation color.  When subsequent rendering operations are performed on top of  pixels which are the specified XOR alternation color, they  will be changed to the current color and vice versa.  Drawing an image on a region of pixels of the specified XOR  alternation color will also change those pixels to the colors  in the image.  Drawing on pixels of other colors will not necessarily result  in a predictable final color but all rendering operations will  always be reversible in this mode; if you draw the same figure  twice then all pixels will be restored to their original values.

Parameters:

 c1 - the XOR alternation color

 getFont

  public abstract Font getFont()

 Gets the current font.

See Also:

Font, setFont

 setFont

  public abstract void setFont(Font font)

 Sets the font for all subsequent text rendering operations.

Parameters:

 font - the specified font

See Also:

Font, getFont, drawString, drawBytes, drawChars

 getFontMetrics

  public FontMetrics getFontMetrics()

 Gets the font metrics of the current font.

See Also:

getFont

 getFontMetrics

  public abstract FontMetrics getFontMetrics(Font f)

 Gets the font metrics for the specified font.

Parameters:

 f - the specified font

See Also:

getFont, getFontMetrics

 getClipBounds

  public abstract Rectangle getClipBounds()

 Returns the bounding rectangle of the current clipping area.  The coordinates in the rectangle are relative to the coordinate  system origin of this graphics context.

See Also:

getClip, clipRect, setClip, setClip

 clipRect

  public abstract void clipRect(int x,
                                int y,
                                int width,
                                int height)

 Intersects the current clip with the specified rectangle.  The resulting clipping area is the intersection of the current  clipping area and the specified rectangle.  This method can only be used to make the current clip smaller.  To set the current clip larger, use any of the setClip methods.  Rendering operations have no effect outside of the clipping area.

Parameters:

 x - the x coordinate of the rectangle to intersect the clip with

 y - the y coordinate of the rectangle to intersect the clip with

 width - the width of the rectangle to intersect the clip with

 height - the height of the rectangle to intersect the clip with

See Also:

setClip, setClip

 setClip

  public abstract void setClip(int x,
                               int y,
                               int width,
                               int height)

 Sets the current clip to the rectangle specified by the given  coordinates.  Rendering operations have no effect outside of the clipping area.

Parameters:

 x - the x coordinate of the new clip rectangle

 y - the y coordinate of the new clip rectangle

 width - the width of the new clip rectangle

 height - the height of the new clip rectangle

See Also:

clipRect, setClip

 getClip

  public abstract Shape getClip()

 Return a Shape object representing the current clipping area.

See Also:

getClipBounds, clipRect, setClip, setClip

 setClip

  public abstract void setClip(Shape clip)

 Set the current clipping area to an arbitrary clip shape.  Not all objects which implement the Shape interface can be  used to set the clip. The only Shape objects which are  guaranteed to be supported are Shape objects which are  obtained from the getClip() method and Rectangle objects.

See Also:

getClip, clipRect, setClip

 copyArea

  public abstract void copyArea(int x,
                                int y,
                                int width,
                                int height,
                                int dx,
                                int dy)

 Copies an area of the Component by a distance specified by dx  and dy to the right and down. To copy a portion of the Component  to the left or upwards, specify a negative distance for either  dx or dy.  If a portion of the source rectangle to be copied lies outside of  the bounds of the Component or is obscured by another Component  or window, the damage resulting from not being able to copy the  associated pixels will be repaired by a call to the paint method  of the Component.

Parameters:

 x - the x coordinate of the source rectangle

 y - the y coordinate of the source rectangle

 width - the width of the source rectangle

 height - the height of the source rectangle

 dx - the horizontal distance to copy the pixels to the right

 dy - the vertical distance to copy the pixels downward

 drawLine

  public abstract void drawLine(int x1,
                                int y1,
                                int x2,
                                int y2)

 Draws a line between the coordinates (x1,y1) and (x2,y2) using  the current color.

Parameters:

 x1 - the x coordinate of the start of the line

 y1 - the y coordinate of the start of the line

 x2 - the x coordinate of the end of the line

 y2 - the y coordinate of the end of the line

 fillRect

  public abstract void fillRect(int x,
                                int y,
                                int width,
                                int height)

 Fills the specified rectangle with the current color.

Parameters:

 x - the x coordinate of the rectangle to be filled

 y - the y coordinate of the rectangle to be filled

 width - the width of the rectangle to be filled

 height - the height of the rectangle to be filled

See Also:

drawRect, clearRect

 drawRect

  public void drawRect(int x,
                       int y,
                       int width,
                       int height)

 Draws the outline of the specified rectangle using the current  color. The resulting rectangle will cover an area (width + 1)  pixels wide by (height + 1) pixels tall.

Parameters:

 x - the x coordinate of the rectangle to be drawn

 y - the y coordinate of the rectangle to be drawn

 width - the width of the rectangle to be drawn

 height - the height of the rectangle to be drawn

See Also:

fillRect, clearRect

 clearRect

  public abstract void clearRect(int x,
                                 int y,
                                 int width,
                                 int height)

 Clears the specified rectangle by filling it with the background  color of the current drawing surface.

Parameters:

 x - the x coordinate of the rectangle to clear

 y - the y coordinate of the rectangle to clear

 width - the width of the rectangle to clear

 height - the height of the rectangle to clear

See Also:

fillRect, drawRect

 drawRoundRect

  public abstract void drawRoundRect(int x,
                                     int y,
                                     int width,
                                     int height,
                                     int arcWidth,
                                     int arcHeight)

 Draws the outline of the specified rounded corner rectangle  using the current color.  The resulting rectangle will cover an area (width + 1) pixels wide  by (height + 1) pixels tall.

Parameters:

 x - the x coordinate of the rectangle to be drawn

 y - the y coordinate of the rectangle to be drawn

 width - the width of the rectangle to be drawn

 height - the height of the rectangle to be drawn

 arcWidth - the horizontal diameter of the arc at the four corners

 arcHeight - the vertical diameter of the arc at the four corners

See Also:

fillRoundRect

 fillRoundRect

  public abstract void fillRoundRect(int x,
                                     int y,
                                     int width,
                                     int height,
                                     int arcWidth,
                                     int arcHeight)

 Fills the specified rounded corner rectangle with the current color.

Parameters:

 x - the x coordinate of the rectangle to be filled

 y - the y coordinate of the rectangle to be filled

 width - the width of the rectangle to be filled

 height - the height of the rectangle to be filled

 arcWidth - the horizontal diameter of the arc at the four corners

 arcHeight - the vertical diameter of the arc at the four corners

See Also:

drawRoundRect

 draw3DRect

  public void draw3DRect(int x,
                         int y,
                         int width,
                         int height,
                         boolean raised)

 Draws a 3-D highlighted outline of the specified rectangle.  The edges of the rectangle will be highlighted so that it appears  as if the edges were beveled and lit from the upper left corner.  The colors used for the highlighting effect will be determined from  the current color.  The resulting rectangle will cover an area (width + 1) pixels wide  by (height + 1) pixels tall.

Parameters:

 x - the x coordinate of the rectangle to be drawn

 y - the y coordinate of the rectangle to be drawn

 width - the width of the rectangle to be drawn

 height - the height of the rectangle to be drawn

 raised - a boolean that determines whether the rectangle  appears to be raised above the surface or sunk into the surface

See Also:

brighter, darker

 fill3DRect

  public void fill3DRect(int x,
                         int y,
                         int width,
                         int height,
                         boolean raised)

 Paints a 3-D highlighted rectangle filled with the current color.  The edges of the rectangle will be highlighted so that it appears  as if the edges were beveled and lit from the upper left corner.  The colors used for the highlighting effect will be determined from  the current color.

Parameters:

 x - the x coordinate of the rectangle to be filled

 y - the y coordinate of the rectangle to be filled

 width - the width of the rectangle to be filled

 height - the height of the rectangle to be filled

 raised - a boolean that determines whether the rectangle  appears to be raised above the surface or sunk into the surface

See Also:

brighter, darker

 drawOval

  public abstract void drawOval(int x,
                                int y,
                                int width,
                                int height)

 Draws the outline of an oval covering the specified rectangle  using the current color.  The resulting oval will cover an area (width + 1) pixels wide  by (height + 1) pixels tall.

Parameters:

 x - the x coordinate of the upper left corner of the oval  to be drawn

 y - the y coordinate of the upper left corner of the oval  to be drawn

 width - the width of the oval to be drawn

 height - the height of the oval to be drawn

See Also:

fillOval

 fillOval

  public abstract void fillOval(int x,
                                int y,
                                int width,
                                int height)

 Fills an oval bounded by the specified rectangle with the  current color.

Parameters:

 x - the x coordinate of the upper left corner of the oval  to be filled

 y - the y coordinate of the upper left corner of the oval  to be filled

 width - the width of the oval to be filled

 height - the height of the oval to be filled

See Also:

drawOval

 drawArc

  public abstract void drawArc(int x,
                               int y,
                               int width,
                               int height,
                               int startAngle,
                               int arcAngle)

 Draws the outline of an arc covering the specified rectangle,  starting at startAngle and extending for arcAngle degrees,  using the current color.  The angles are interpreted such that 0 degrees is at the 3-o'clock  position, and positive values indicate counter-clockwise rotations  while negative values indicate clockwise rotations.  The resulting arc will cover an area (width + 1) pixels wide  by (height + 1) pixels tall.

Parameters:

 x - the x coordinate of the upper left corner of the arc  to be drawn

 y - the y coordinate of the upper left corner of the arc  to be drawn

 width - the width of the arc to be drawn

 height - the height of the arc to be drawn

 startAngle - the beginning angle

 arcAngle - the angular extent of the arc (relative to startAngle)

See Also:

fillArc

 fillArc

  public abstract void fillArc(int x,
                               int y,
                               int width,
                               int height,
                               int startAngle,
                               int arcAngle)

 Fills an arc bounded by the specified rectangle, starting at  startAngle and extending for arcAngle degrees, with the  current color.  This method generates a pie shape.  The angles are interpreted such that 0 degrees is at the 3-o'clock  position, and positive values indicate counter-clockwise rotations  while negative values indicate clockwise rotations.

Parameters:

 x - the x coordinate of the upper left corner of the arc  to be filled

 y - the y coordinate of the upper left corner of the arc  to be filled

 width - the width of the arc to be filled

 height - the height of the arc to be filled

 startAngle - the beginning angle

 arcAngle - the angular extent of the arc (relative to startAngle).

See Also:

drawArc

 drawPolyline

  public abstract void drawPolyline(int xPoints[],
                                    int yPoints[],
                                    int nPoints)

 Draws a sequence of connected lines defined by arrays of x coordinates  and y coordinates using the current color.  The figure is not automatically closed if the first coordinate is  different from the last coordinate.

Parameters:

 xPoints - an array of x points

 yPoints - an array of y points

 nPoints - the total number of points

See Also:

drawPolygon

 drawPolygon

  public abstract void drawPolygon(int xPoints[],
                                   int yPoints[],
                                   int nPoints)

 Draws the outline of a polygon defined by arrays of x coordinates  and y coordinates using the current color.  The figure is automatically closed by drawing a line connecting  the first coordinate to the last if they are different.

Parameters:

 xPoints - an array of x points

 yPoints - an array of y points

 nPoints - the total number of points

See Also:

drawPolyline, fillPolygon

 drawPolygon

  public void drawPolygon(Polygon p)

 Draws the outline of a polygon defined by the specified Polygon  object using the current color.

Parameters:

 p - the Polygon object to outline

See Also:

fillPolygon

 fillPolygon

  public abstract void fillPolygon(int xPoints[],
                                   int yPoints[],
                                   int nPoints)

 Fills a polygon defined by arrays of x coordinates and y  coordinates with the current color using an even-odd fill  rule (otherwise known as an alternating rule).

Parameters:

 xPoints - an array of x points

 yPoints - an array of y points

 nPoints - the total number of points

See Also:

drawPolygon

 fillPolygon

  public void fillPolygon(Polygon p)

 Fills the polygon defined by the specified Polygon object with  the current color using an even-odd fill rule (otherwise known  as an alternating rule).

Parameters:

 p - the Polygon object to fill

See Also:

drawPolygon

 drawString

  public abstract void drawString(String str,
                                  int x,
                                  int y)

 Draws the specified String using the current font and color.  The x,y position is the starting point of the baseline of the String.

Parameters:

 str - the String to be drawn

 x - the x coordinate of the baseline of the text

 y - the y coordinate of the baseline of the text

See Also:

drawChars, drawBytes

 drawChars

  public void drawChars(char data[],
                        int offset,
                        int length,
                        int x,
                        int y)

 Draws the specified characters using the current font and color.

Parameters:

 data - the array of characters to be drawn

 offset - the start offset in the data

 length - the number of characters to be drawn

 x - the x coordinate of the baseline of the text

 y - the y coordinate of the baseline of the text

See Also:

drawString, drawBytes

 drawBytes

  public void drawBytes(byte data[],
                        int offset,
                        int length,
                        int x,
                        int y)

 Draws the specified bytes using the current font and color.

Parameters:

 data - the data to be drawn

 offset - the start offset in the data

 length - the number of bytes that are drawn

 x - the x coordinate of the baseline of the text

 y - the y coordinate of the baseline of the text

See Also:

drawString, drawChars

 drawImage

  public abstract boolean drawImage(Image img,
                                    int x,
                                    int y,
                                    ImageObserver observer)

 Draws as much of the specified image as is currently available at  the specified coordinate (x, y).  This method will return immediately in all cases, even if the  entire image has not yet been scaled, dithered and converted  for the current output device.  If the current output representation is not yet complete then  the method will return false and the indicated ImageObserver  object will be notified as the conversion process progresses.

Parameters:

 img - the specified image to be drawn

 x - the x coordinate

 y - the y coordinate

 observer - object to be notified as more of the image is  converted

See Also:

Image, ImageObserver

 drawImage

  public abstract boolean drawImage(Image img,
                                    int x,
                                    int y,
                                    int width,
                                    int height,
                                    ImageObserver observer)

 Draws as much of the specified image as has already been scaled  to fit inside the specified rectangle.  This method will return immediately in all cases, even if the  entire image has not yet been scaled, dithered and converted  for the current output device.  If the current output representation is not yet complete then  the method will return false and the indicated ImageObserver  object will be notified as the conversion process progresses.

 Note that a scaled version of an image will not necessarily be  immediately available just because an unscaled version of the  image has been constructed for this output device. Each size of  the image may be cached separately and generated from the original  data in a separate image production sequence.

Parameters:

 img - the specified image to be drawn

 x - the x coordinate

 y - the y coordinate

 width - the width of the rectangle

 height - the height of the rectangle

 observer - object to be notified as more of the image is  scaled and converted

See Also:

Image, ImageObserver

 drawImage

  public abstract boolean drawImage(Image img,
                                    int x,
                                    int y,
                                    Color bgcolor,
                                    ImageObserver observer)

 Draws as much of the specified image as is currently available at  the specified coordinate (x, y) with the given solid background color.  This operation should be equivalent to filling a rectangle of the  width and height of the specified image with the given color and then  drawing the image on top of it, but possibly more efficient.  This method will return immediately in all cases, even if the  entire image has not yet been scaled, dithered and converted  for the current output device.  If the current output representation is not yet complete then  the method will return false and the indicated ImageObserver  object will be notified as the conversion process progresses.

Parameters:

 img - the specified image to be drawn

 x - the x coordinate

 y - the y coordinate

 bgcolor - the background color to paint under the  non-opaque portions of the image

 observer - object to be notified as more of the image is  converted

See Also:

Image, ImageObserver

 drawImage

  public abstract boolean drawImage(Image img,
                                    int x,
                                    int y,
                                    int width,
                                    int height,
                                    Color bgcolor,
                                    ImageObserver observer)

 Draws as much of the specified image as has already been scaled  to fit inside the specified rectangle with the given solid  background color.  This operation should be equivalent to filling a rectangle of the  specified width and height with the given color and then  drawing the image on top of it, but possibly more efficient.  This method will return immediately in all cases, even if the  entire image has not yet been scaled, dithered and converted  for the current output device.  If the current output representation is not yet complete then  the method will return false and the indicated ImageObserver  object will be notified as the conversion process progresses.

 Note that a scaled version of an image will not necessarily be  immediately available just because an unscaled version of the  image has been constructed for this output device. Each size of  the image may be cached separately and generated from the original  data in a separate image production sequence.

Parameters:

 img - the specified image to be drawn

 x - the x coordinate

 y - the y coordinate

 width - the width of the rectangle

 height - the height of the rectangle

 bgcolor - the background color to paint under the  non-opaque portions of the image

 observer - object to be notified as more of the image is  scaled and converted

See Also:

Image, ImageObserver

 drawImage

  public abstract boolean drawImage(Image img,
                                    int dx1,
                                    int dy1,
                                    int dx2,
                                    int dy2,
                                    int sx1,
                                    int sy1,
                                    int sx2,
                                    int sy2,
                                    ImageObserver observer)

 Draws as much of the specified area of the specified image as is  currently available, scaling it on the fly to fit inside the  specified area of the destination drawable surface.  This method will return immediately in all cases, even if the  entire area of the specified image has not yet been scaled,  dithered and converted for the current output device.  If the current output representation is not yet complete then  the method will return false and the indicated ImageObserver  object will be notified as the conversion process progresses.

 This method will always use the unscaled version of the image  to render the scaled rectangle and will perform the required  scaling on the fly. It will not use a cached scaled version  of the image for this operation. The scaling from source  to destination is performed such that the first coordinate  of the source rectangle is mapped to the first coordinate of  the destination rectangle and the second source coordinate is  mapped to the second destination coordinate. The subimage is  scaled and flipped as needed to preserve those mappings.

Parameters:

 img - the specified image to be drawn

 dx1 - the x coordinate of the first corner of the  destination rectangle

 dy1 - the y coordinate of the first corner of the  destination rectangle

 dx2 - the x coordinate of the second corner of the  destination rectangle

 dy2 - the y coordinate of the second corner of the  destination rectangle

 sx1 - the x coordinate of the first corner of the  source rectangle

 sy1 - the y coordinate of the first corner of the  source rectangle

 sx2 - the x coordinate of the second corner of the  source rectangle

 sy2 - the y coordinate of the second corner of the  source rectangle

 observer - object to be notified as more of the image is  scaled and converted

See Also:

Image, ImageObserver

 drawImage

  public abstract boolean drawImage(Image img,
                                    int dx1,
                                    int dy1,
                                    int dx2,
                                    int dy2,
                                    int sx1,
                                    int sy1,
                                    int sx2,
                                    int sy2,
                                    Color bgcolor,
                                    ImageObserver observer)

 Draws as much of the specified area of the specified image as is  currently available, scaling it on the fly to fit inside the  specified area of the destination drawable surface with the  given solid background color.  This operation should be equivalent to filling a rectangle of the  specified width and height with the given color and then  drawing the image on top of it, but possibly more efficient.  This method will return immediately in all cases, even if the  entire area of the specified image has not yet been scaled,  dithered and converted for the current output device.  If the current output representation is not yet complete then  the method will return false and the indicated ImageObserver  object will be notified as the conversion process progresses.

 This method will always use the unscaled version of the image  to render the scaled rectangle and will perform the required  scaling on the fly. It will not use a cached scaled version  of the image for this operation. The scaling from source  to destination is performed such that the first coordinate  of the source rectangle is mapped to the first coordinate of  the destination rectangle and the second source coordinate is  mapped to the second destination coordinate. The subimage is  scaled and flipped as needed to preserve those mappings.

Parameters:

 img - the specified image to be drawn

 dx1 - the x coordinate of the first corner of the  destination rectangle

 dy1 - the y coordinate of the first corner of the  destination rectangle

 dx2 - the x coordinate of the second corner of the  destination rectangle

 dy2 - the y coordinate of the second corner of the  destination rectangle

 sx1 - the x coordinate of the first corner of the  source rectangle

 sy1 - the y coordinate of the first corner of the  source rectangle

 sx2 - the x coordinate of the second corner of the  source rectangle

 sy2 - the y coordinate of the second corner of the  source rectangle

 bgcolor - the background color to paint under the  non-opaque portions of the image

 observer - object to be notified as more of the image is  scaled and converted

See Also:

Image, ImageObserver

 dispose

  public abstract void dispose()

 Dispose of the system resources used by this graphics context.  The Graphics context cannot be used after being disposed of.  While the finalization process of the garbage collector will  also dispose of the same system resources, due to the number  of Graphics objects that can be created in short time frames  it is preferable to manually free the associated resources  using this method rather than to rely on a finalization  process which may not happen for a long period of time.

 Graphics objects which are provided as arguments to the paint  and update methods of Components are automatically disposed  by the system when those methods return. Programmers should,  for efficiency, call the dispose method when finished using  a Graphics object only if it was created directly from a  Component or another Graphics object.

See Also:

finalize, paint, update, getGraphics, create

 finalize

  public void finalize()

 Disposes of this graphics context once it is no longer referenced.

Overrides:

finalize in class Object

See Also:

dispose

 toString

  public String toString()

 Returns a String object representing this Graphics object's value.

Overrides:

toString in class Object

 getClipRect

  public Rectangle getClipRect()

 Note: getClipRect() is deprecated. As of JDK version 1.1,  replaced by getClipBounds().

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.GridBagConstraints

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.GridBagConstraints

java.lang.Object
   |
   +----java.awt.GridBagConstraints

______________________________________________________________________________

 public class GridBagConstraints

 extends Object

 implements Cloneable, Serializable

GridBagConstraints is used to specify constraints for components  laid out using the GridBagLayout class.

See Also:

GridBagLayout

______________________________________________________________________________

 	anchor

  	BOTH

  	CENTER

  	EAST

  	fill

  	gridheight

  	gridwidth

  	gridx

  	gridy

  	HORIZONTAL

  	insets

  	ipadx

  	ipady

  	NONE

  	NORTH

  	NORTHEAST

  	NORTHWEST

  	RELATIVE

  	REMAINDER

  	SOUTH

  	SOUTHEAST

  	SOUTHWEST

  	VERTICAL

  	weightx

  	weighty

  	WEST

 	GridBagConstraints()

 	clone()

 Creates a new object of the same class as this object.

 RELATIVE

  public final static int RELATIVE

 REMAINDER

  public final static int REMAINDER

 NONE

  public final static int NONE

 BOTH

  public final static int BOTH

 HORIZONTAL

  public final static int HORIZONTAL

 VERTICAL

  public final static int VERTICAL

 CENTER

  public final static int CENTER

 NORTH

  public final static int NORTH

 NORTHEAST

  public final static int NORTHEAST

 EAST

  public final static int EAST

 SOUTHEAST

  public final static int SOUTHEAST

 SOUTH

  public final static int SOUTH

 SOUTHWEST

  public final static int SOUTHWEST

 WEST

  public final static int WEST

 NORTHWEST

  public final static int NORTHWEST

 gridx

  public int gridx

 gridy

  public int gridy

 gridwidth

  public int gridwidth

 gridheight

  public int gridheight

 weightx

  public double weightx

 weighty

  public double weighty

 anchor

  public int anchor

 fill

  public int fill

 insets

  public Insets insets

 ipadx

  public int ipadx

 ipady

  public int ipady

 GridBagConstraints

  public GridBagConstraints()

 clone

  public Object clone()

 Creates a new object of the same class as this object.

Overrides:

clone in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.GridBagLayout

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.GridBagLayout

java.lang.Object
   |
   +----java.awt.GridBagLayout

______________________________________________________________________________

 public class GridBagLayout

 extends Object

 implements LayoutManager2, Serializable

GridBagLayout is a flexible layout manager that aligns components vertically and horizontally, without requiring that the components be the same size. Each GridBagLayout uses a dynamic rectangular grid of cells, with each component occupying one or more cells (called its display area). Each component managed by a GridBagLayout is associated with a GridBagConstraints instance that specifies how the component is laid out within its display area. How a GridBagLayout places a set of components depends on each component's GridBagConstraints and minimum size, as well as the preferred size of the components' container.

To use a GridBagLayout effectively, you must customize one or more of its components' GridBagConstraints. You customize a GridBagConstraints object by setting one or more of its instance variables:

 gridx, gridy

 Specifies the cell at the upper left of the component's display area, where the upper-left-most cell has address gridx=0, gridy=0. Use GridBagConstraints.RELATIVE (the default value) to specify that the component be just placed just to the right of (for gridx) or just below (for gridy) the component that was added to the container just before this component was added.

gridwidth, gridheight

 Specifies the number of cells in a row (for gridwidth) or column (for gridheight) in the component's display area. The default value is 1. Use GridBagConstraints.REMAINDER to specify that the component be the last one in its row (for gridwidth) or column (for gridheight). Use GridBagConstraints.RELATIVE to specify that the component be the next to last one in its row (for gridwidth) or column (for gridheight).

fill

 Used when the component's display area is larger than the component's requested size to determine whether (and how) to resize the component. Valid values are GridBagConstraints.NONE (the default), GridBagConstraints.HORIZONTAL (make the component wide enough to fill its display area horizontally, but don't change its height), GridBagConstraints.VERTICAL (make the component tall enough to fill its display area vertically, but don't change its width), and GridBagConstraints.BOTH (make the component fill its display area entirely).

ipadx, ipady

 Specifies the internal padding: how much to add to the minimum size of the component. The width of the component will be at least its minimum width plus ipadx*2 pixels (since the padding applies to both sides of the component). Similarly, the height of the component will be at least the minimum height plus ipady*2 pixels.

insets

 Specifies the external padding of the component -- the minimum amount of space between the component and the edges of its display area.

anchor

 Used when the component is smaller than its display area to determine where (within the area) to place the component. Valid values are GridBagConstraints.CENTER (the default), GridBagConstraints.NORTH, GridBagConstraints.NORTHEAST, GridBagConstraints.EAST, GridBagConstraints.SOUTHEAST, GridBagConstraints.SOUTH, GridBagConstraints.SOUTHWEST, GridBagConstraints.WEST, and GridBagConstraints.NORTHWEST.

weightx, weighty

 Used to determine how to distribute space; this is important for specifying resizing behavior. Unless you specify a weight for at least one component in a row (weightx) and column (weighty), all the components clump together in the center of their container. This is because when the weight is zero (the default), the GridBagLayout puts any extra space between its grid of cells and the edges of the container.

The following figure shows ten components (all buttons) managed by a GridBagLayout:

All the components have fill=GridBagConstraints.BOTH. In addition, the components have the following non-default constraints:

• Button1, Button2, Button3: weightx=1.0

• Button4: weightx=1.0, gridwidth=GridBagConstraints.REMAINDER

• Button5: gridwidth=GridBagConstraints.REMAINDER

• Button6: gridwidth=GridBagConstraints.RELATIVE

• Button7: gridwidth=GridBagConstraints.REMAINDER

• Button8: gridheight=2, weighty=1.0,

• Button9, Button 10: gridwidth=GridBagConstraints.REMAINDER

Here is the code that implements the example shown above:

import java.awt.*;
import java.util.*;
import java.applet.Applet;
public class GridBagEx1 extends Applet {
protected void makebutton(String name,
GridBagLayout gridbag,
GridBagConstraints c) {
Button button = new Button(name);
gridbag.setConstraints(button, c);
add(button);
}
public void init() {
GridBagLayout gridbag = new GridBagLayout();
GridBagConstraints c = new GridBagConstraints();
setFont(new Font("Helvetica", Font.PLAIN, 14));
setLayout(gridbag);
c.fill = GridBagConstraints.BOTH;
c.weightx = 1.0;
makebutton("Button1", gridbag, c);
makebutton("Button2", gridbag, c);
makebutton("Button3", gridbag, c);
c.gridwidth = GridBagConstraints.REMAINDER; //end row
makebutton("Button4", gridbag, c);
c.weightx = 0.0;                   //reset to the default
makebutton("Button5", gridbag, c); //another row
c.gridwidth = GridBagConstraints.RELATIVE; //next-to-last in row
makebutton("Button6", gridbag, c);
c.gridwidth = GridBagConstraints.REMAINDER; //end row
makebutton("Button7", gridbag, c);
c.gridwidth = 1;                   //reset to the default
c.gridheight = 2;
c.weighty = 1.0;
makebutton("Button8", gridbag, c);
c.weighty = 0.0;                   //reset to the default
c.gridwidth = GridBagConstraints.REMAINDER; //end row
c.gridheight = 1;                  //reset to the default
makebutton("Button9", gridbag, c);
makebutton("Button10", gridbag, c);
setSize(300, 100);
}
public static void main(String args[]) {
Frame f = new Frame("GridBag Layout Example");
GridBagEx1 ex1 = new GridBagEx1();
ex1.init();
f.add("Center", ex1);
f.pack();
f.setSize(f.getPreferredSize());
f.show();
}
}

______________________________________________________________________________

 	columnWeights

  	columnWidths

  	comptable

  	defaultConstraints

  	layoutInfo

  	MAXGRIDSIZE

  	MINSIZE

  	PREFERREDSIZE

  	rowHeights

  	rowWeights

 	GridBagLayout()

 Creates a gridbag layout.

 	addLayoutComponent(Component, Object)

 Adds the specified component to the layout, using the specified  constraint object.

 	addLayoutComponent(String, Component)

 Adds the specified component with the specified name to the layout.

 	AdjustForGravity(GridBagConstraints, Rectangle)

  	ArrangeGrid(Container)

  	getConstraints(Component)

 Retrieves the constraints for the specified component.

 	getLayoutAlignmentX(Container)

 Returns the alignment along the x axis.

 	getLayoutAlignmentY(Container)

 Returns the alignment along the y axis.

 	getLayoutDimensions()

  	GetLayoutInfo (Container, int)

 Print the layout constraints.

 	getLayoutOrigin()

  	getLayoutWeights()

  	GetMinSize (Container, GridBagLayoutInfo)

  	invalidateLayout(Container)

 Invalidates the layout, indicating that if the layout manager  has cached information it should be discarded.

 	layoutContainer(Container)

 Lays out the container in the specified panel.

 	location(int, int)

  	lookupConstraints (Component)

 Retrieves the constraints for the specified component.

 	maximumLayoutSize(Container)

 Returns the maximum dimensions for this layout given the components  in the specified target container.

 	minimumLayoutSize(Container)

 Returns the minimum dimensions needed to layout the components  contained in the specified panel.

 	preferredLayoutSize(Container)

 Returns the preferred dimensions for this layout given the components  in the specified panel.

 	removeLayoutComponent(Component)

 Removes the specified component from the layout.

 	setConstraints(Component, GridBagConstraints)

 Sets the constraints for the specified component.

 	toString()

 Returns the String representation of this GridLayout's values.

 MAXGRIDSIZE

  protected final static int MAXGRIDSIZE

 MINSIZE

  protected final static int MINSIZE

 PREFERREDSIZE

  protected final static int PREFERREDSIZE

 comptable

  protected Hashtable comptable

 defaultConstraints

  protected GridBagConstraints defaultConstraints

 layoutInfo

  protected GridBagLayoutInfo layoutInfo

 columnWidths

  public int columnWidths[]

 rowHeights

  public int rowHeights[]

 columnWeights

  public double columnWeights[]

 rowWeights

  public double rowWeights[]

 GridBagLayout

  public GridBagLayout()

 Creates a gridbag layout.

 setConstraints

  public void setConstraints(Component comp,
                             GridBagConstraints constraints)

 Sets the constraints for the specified component.

Parameters:

 comp - the component to be modified

 constraints - the constraints to be applied

 getConstraints

  public GridBagConstraints getConstraints(Component comp)

 Retrieves the constraints for the specified component. A copy of  the constraints is returned.

Parameters:

 comp - the component to be queried

 lookupConstraints

  protected GridBagConstraints lookupConstraints(Component comp)

 Retrieves the constraints for the specified component. The return  value is not a copy, but is the actual constraints class used by the  layout mechanism.

Parameters:

 comp - the component to be queried

 getLayoutOrigin

  public Point getLayoutOrigin()

 getLayoutDimensions

  public int[][] getLayoutDimensions()

 getLayoutWeights

  public double[][] getLayoutWeights()

 location

  public Point location(int x,
                        int y)

 addLayoutComponent

  public void addLayoutComponent(String name,
                                 Component comp)

 Adds the specified component with the specified name to the layout.

Parameters:

 name - the name of the component

 comp - the component to be added

 addLayoutComponent

  public void addLayoutComponent(Component comp,
                                 Object constraints)

 Adds the specified component to the layout, using the specified  constraint object.

Parameters:

 comp - the component to be added

 constraints - where/how the component is added to the layout.

 removeLayoutComponent

  public void removeLayoutComponent(Component comp)

 Removes the specified component from the layout. Does not apply.

Parameters:

 comp - the component to be removed

 preferredLayoutSize

  public Dimension preferredLayoutSize(Container parent)

 Returns the preferred dimensions for this layout given the components  in the specified panel.

Parameters:

 parent - the component which needs to be laid out

See Also:

minimumLayoutSize

 minimumLayoutSize

  public Dimension minimumLayoutSize(Container parent)

 Returns the minimum dimensions needed to layout the components  contained in the specified panel.

Parameters:

 parent - the component which needs to be laid out

See Also:

preferredLayoutSize

 maximumLayoutSize

  public Dimension maximumLayoutSize(Container target)

 Returns the maximum dimensions for this layout given the components  in the specified target container.

Parameters:

 target - the component which needs to be laid out

See Also:

Container, minimumLayoutSize, preferredLayoutSize

 getLayoutAlignmentX

  public float getLayoutAlignmentX(Container parent)

 Returns the alignment along the x axis. This specifies how  the component would like to be aligned relative to other  components. The value should be a number between 0 and 1  where 0 represents alignment along the origin, 1 is aligned  the furthest away from the origin, 0.5 is centered, etc.

 getLayoutAlignmentY

  public float getLayoutAlignmentY(Container parent)

 Returns the alignment along the y axis. This specifies how  the component would like to be aligned relative to other  components. The value should be a number between 0 and 1  where 0 represents alignment along the origin, 1 is aligned  the furthest away from the origin, 0.5 is centered, etc.

 invalidateLayout

  public void invalidateLayout(Container target)

 Invalidates the layout, indicating that if the layout manager  has cached information it should be discarded.

 layoutContainer

  public void layoutContainer(Container parent)

 Lays out the container in the specified panel.

Parameters:

 parent - the specified component being laid out

See Also:

Container

 toString

  public String toString()

 Returns the String representation of this GridLayout's values.

Overrides:

toString in class Object

 GetLayoutInfo

  protected GridBagLayoutInfo GetLayoutInfo(Container parent,
                                            int sizeflag)

 Print the layout constraints. Useful for debugging.

 AdjustForGravity

  protected void AdjustForGravity(GridBagConstraints constraints,
                                  Rectangle r)

 GetMinSize

  protected Dimension GetMinSize(Container parent,
                                 GridBagLayoutInfo info)

 ArrangeGrid

  protected void ArrangeGrid(Container parent)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.GridLayout

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.GridLayout

java.lang.Object
   |
   +----java.awt.GridLayout

______________________________________________________________________________

 public class GridLayout

 extends Object

 implements LayoutManager, Serializable

A layout manager for a container that lays out grids.

______________________________________________________________________________

 	GridLayout()

 Creates a grid layout with a default of one column per component,  in a single row.

 	GridLayout(int, int)

 Creates a grid layout with the specified rows and columns.

 	GridLayout(int, int, int, int)

 Creates a grid layout with the specified rows, columns,  horizontal gap, and vertical gap.

 	addLayoutComponent(String, Component)

 Adds the specified component with the specified name to the layout.

 	getColumns()

 Returns the number of columns in this layout.

 	getHgap()

 Returns the horizontal gap between components.

 	getRows()

 Returns the number of rows in this layout.

 	getVgap()

 Returns the vertical gap between components.

 	layoutContainer(Container)

 Lays out the container in the specified panel.

 	minimumLayoutSize(Container)

 Returns the minimum dimensions needed to layout the components  contained in the specified panel.

 	preferredLayoutSize(Container)

 Returns the preferred dimensions for this layout given the components  int the specified panel.

 	removeLayoutComponent(Component)

 Removes the specified component from the layout.

 	setColumns(int)

 Sets the number of columns in this layout.

 	setHgap(int)

 Sets the horizontal gap between components.

 	setRows(int)

 Sets the number of rows in this layout.

 	setVgap(int)

 Sets the vertical gap between components.

 	toString()

 Returns the String representation of this GridLayout's values.

 GridLayout

  public GridLayout()

 Creates a grid layout with a default of one column per component,  in a single row.

 GridLayout

  public GridLayout(int rows,
                    int cols)

 Creates a grid layout with the specified rows and columns.

Parameters:

 rows - the rows

 cols - the columns

 GridLayout

  public GridLayout(int rows,
                    int cols,
                    int hgap,
                    int vgap)

 Creates a grid layout with the specified rows, columns,  horizontal gap, and vertical gap.

Parameters:

 rows - the rows; zero means 'any number.'

 cols - the columns; zero means 'any number.' Only one of 'rows'  and 'cols' can be zero, not both.

 hgap - the horizontal gap variable

 vgap - the vertical gap variable

Throws: IllegalArgumentException

 If the rows and columns are invalid.

 getRows

  public int getRows()

 Returns the number of rows in this layout.

 setRows

  public void setRows(int rows)

 Sets the number of rows in this layout.

Parameters:

 rows - number of rows in this layout

 getColumns

  public int getColumns()

 Returns the number of columns in this layout.

 setColumns

  public void setColumns(int cols)

 Sets the number of columns in this layout.

Parameters:

 cols - number of columns in this layout

 getHgap

  public int getHgap()

 Returns the horizontal gap between components.

 setHgap

  public void setHgap(int hgap)

 Sets the horizontal gap between components.

Parameters:

 hgap - the horizontal gap between components

 getVgap

  public int getVgap()

 Returns the vertical gap between components.

 setVgap

  public void setVgap(int vgap)

 Sets the vertical gap between components.

Parameters:

 vgap - the vertical gap between components

 addLayoutComponent

  public void addLayoutComponent(String name,
                                 Component comp)

 Adds the specified component with the specified name to the layout.

Parameters:

 name - the name of the component

 comp - the component to be added

 removeLayoutComponent

  public void removeLayoutComponent(Component comp)

 Removes the specified component from the layout. Does not apply.

Parameters:

 comp - the component to be removed

 preferredLayoutSize

  public Dimension preferredLayoutSize(Container parent)

 Returns the preferred dimensions for this layout given the components  int the specified panel.

Parameters:

 parent - the component which needs to be laid out

See Also:

minimumLayoutSize

 minimumLayoutSize

  public Dimension minimumLayoutSize(Container parent)

 Returns the minimum dimensions needed to layout the components  contained in the specified panel.

Parameters:

 parent - the component which needs to be laid out

See Also:

preferredLayoutSize

 layoutContainer

  public void layoutContainer(Container parent)

 Lays out the container in the specified panel.

Parameters:

 parent - the specified component being laid out

See Also:

Container

 toString

  public String toString()

 Returns the String representation of this GridLayout's values.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.IllegalComponentStateException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.IllegalComponentStateException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.RuntimeException
                           |
                           +----java.lang.IllegalStateException
                                   |
                                   +----java.awt.IllegalComponentStateException

______________________________________________________________________________

 public class IllegalComponentStateException

 extends IllegalStateException

Signals that an AWT component is not in an appropriate state for  the requested operation.

______________________________________________________________________________

 	IllegalComponentStateException()

 Constructs an IllegalComponentStateException with no detail message.

 	IllegalComponentStateException(String)

 Constructs an IllegalComponentStateException with the specified detail  message.

 IllegalComponentStateException

  public IllegalComponentStateException()

 Constructs an IllegalComponentStateException with no detail message.  A detail message is a String that describes this particular exception.

 IllegalComponentStateException

  public IllegalComponentStateException(String s)

 Constructs an IllegalComponentStateException with the specified detail  message. A detail message is a String that describes this particular  exception.

Parameters:

 s - the String that contains a detailed message

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.image.AreaAveragingScaleFilter

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.image.AreaAveragingScaleFilter

java.lang.Object
   |
   +----java.awt.image.ImageFilter
           |
           +----java.awt.image.ReplicateScaleFilter
                   |
                   +----java.awt.image.AreaAveragingScaleFilter

______________________________________________________________________________

 public class AreaAveragingScaleFilter

 extends ReplicateScaleFilter

An ImageFilter class for scaling images using a simple area averaging  algorithm that produces smoother results than the nearest neighbor  algorithm.  This class extends the basic ImageFilter Class to scale an existing  image and provide a source for a new image containing the resampled  image. The pixels in the source image are blended to produce pixels  for an image of the specified size. The blending process is analogous  to scaling up the source image to a multiple of the destination size  using pixel replication and then scaling it back down to the destination  size by simply averaging all the pixels in the supersized image that  fall within a given pixel of the destination image. If the data from  the source is not delivered in TopDownLeftRight order then the filter  will back off to a simple pixel replication behavior and utilize the  requestTopDownLeftRightResend() method to refilter the pixels in a  better way at the end.  It is meant to be used in conjunction with a FilteredImageSource  object to produce scaled versions of existing images.

See Also:

FilteredImageSource, ReplicateImageFilter, ImageFilter

______________________________________________________________________________

 	AreaAveragingScaleFilter(int, int)

 Constructs an AreaAveragingScaleFilter that scales the pixels from  its source Image as specified by the width and height parameters.

 	setHints(int)

 Detect if the data is being delivered with the necessary hints  to allow the averaging algorithm to do its work.

 	setPixels (int, int, int, int, ColorModel, byte[], int, int)

 Combine the components for the delivered byte pixels into the  accumulation arrays and send on any averaged data for rows of  pixels that are complete.

 	setPixels (int, int, int, int, ColorModel, int[], int, int)

 Combine the components for the delivered int pixels into the  accumulation arrays and send on any averaged data for rows of  pixels that are complete.

 AreaAveragingScaleFilter

  public AreaAveragingScaleFilter(int width,
                                  int height)

 Constructs an AreaAveragingScaleFilter that scales the pixels from  its source Image as specified by the width and height parameters.

Parameters:

 width - the target width to scale the image

 height - the target height to scale the image

 setHints

  public void setHints(int hints)

 Detect if the data is being delivered with the necessary hints  to allow the averaging algorithm to do its work.

Overrides:

setHints in class ImageFilter

See Also:

setHints

 setPixels

  public void setPixels(int x,
                        int y,
                        int w,
                        int h,
                        ColorModel model,
                        byte pixels[],
                        int off,
                        int scansize)

 Combine the components for the delivered byte pixels into the  accumulation arrays and send on any averaged data for rows of  pixels that are complete. If the correct hints were not  specified in the setHints call then relay the work to our  superclass which is capable of scaling pixels regardless of  the delivery hints.

Overrides:

setPixels in class ReplicateScaleFilter

See Also:

ReplicateScaleFilter

 setPixels

  public void setPixels(int x,
                        int y,
                        int w,
                        int h,
                        ColorModel model,
                        int pixels[],
                        int off,
                        int scansize)

 Combine the components for the delivered int pixels into the  accumulation arrays and send on any averaged data for rows of  pixels that are complete. If the correct hints were not  specified in the setHints call then relay the work to our  superclass which is capable of scaling pixels regardless of  the delivery hints.

Overrides:

setPixels in class ReplicateScaleFilter

See Also:

ReplicateScaleFilter

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.image.ColorModel

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.image.ColorModel

java.lang.Object
   |
   +----java.awt.image.ColorModel

______________________________________________________________________________

 public class ColorModel

 extends Object

A class that encapsulates the methods for translating from pixel values  to alpha, red, green, and blue color components for an image. This  class is abstract.

See Also:

IndexColorModel, DirectColorModel

______________________________________________________________________________

 	pixel_bits

 	ColorModel(int)

 Constructs a ColorModel which describes a pixel of the specified  number of bits.

 	finalize()

 Called by the garbage collector on an object when garbage collection  determines that there are no more references to the object.

 	getAlpha(int)

 The subclass must provide a function which provides the alpha  color compoment for the specified pixel.

 	getBlue(int)

 The subclass must provide a function which provides the blue  color compoment for the specified pixel.

 	getGreen(int)

 The subclass must provide a function which provides the green  color compoment for the specified pixel.

 	getPixelSize()

 Returns the number of bits per pixel described by this ColorModel.

 	getRed(int)

 The subclass must provide a function which provides the red  color compoment for the specified pixel.

 	getRGB(int)

 Returns the color of the pixel in the default RGB color model.

 	getRGBdefault()

 Return a ColorModel which describes the default format for  integer RGB values used throughout the AWT image interfaces.

 pixel_bits

  protected int pixel_bits

 ColorModel

  public ColorModel(int bits)

 Constructs a ColorModel which describes a pixel of the specified  number of bits.

 getRGBdefault

  public static ColorModel getRGBdefault()

 Return a ColorModel which describes the default format for  integer RGB values used throughout the AWT image interfaces.  The format for the RGB values is an integer with 8 bits  each of alpha, red, green, and blue color components ordered  correspondingly from the most significant byte to the least  significant byte, as in: 0xAARRGGBB

 getPixelSize

  public int getPixelSize()

 Returns the number of bits per pixel described by this ColorModel.

 getRed

  public abstract int getRed(int pixel)

 The subclass must provide a function which provides the red  color compoment for the specified pixel.

Returns:

 The red color component ranging from 0 to 255

 getGreen

  public abstract int getGreen(int pixel)

 The subclass must provide a function which provides the green  color compoment for the specified pixel.

Returns:

 The green color component ranging from 0 to 255

 getBlue

  public abstract int getBlue(int pixel)

 The subclass must provide a function which provides the blue  color compoment for the specified pixel.

Returns:

 The blue color component ranging from 0 to 255

 getAlpha

  public abstract int getAlpha(int pixel)

 The subclass must provide a function which provides the alpha  color compoment for the specified pixel.

Returns:

 The alpha transparency value ranging from 0 to 255

 getRGB

  public int getRGB(int pixel)

 Returns the color of the pixel in the default RGB color model.

See Also:

getRGBdefault

 finalize

  public void finalize()

 Called by the garbage collector on an object when garbage collection  determines that there are no more references to the object.

Overrides:

finalize in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.image.CropImageFilter

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.image.CropImageFilter

java.lang.Object
   |
   +----java.awt.image.ImageFilter
           |
           +----java.awt.image.CropImageFilter

______________________________________________________________________________

 public class CropImageFilter

 extends ImageFilter

An ImageFilter class for cropping images.  This class extends the basic ImageFilter Class to extract a given  rectangular region of an existing Image and provide a source for a  new image containing just the extracted region. It is meant to  be used in conjunction with a FilteredImageSource object to produce  cropped versions of existing images.

See Also:

FilteredImageSource, ImageFilter

______________________________________________________________________________

 	CropImageFilter(int, int, int, int)

 Constructs a CropImageFilter that extracts the absolute rectangular  region of pixels from its source Image as specified by the x, y,  w, and h parameters.

 	setDimensions(int, int)

 Override the source image's dimensions and pass the dimensions  of the rectangular cropped region to the ImageConsumer.

 	setPixels (int, int, int, int, ColorModel, byte[], int, int)

 Determine whether the delivered byte pixels intersect the region to  be extracted and passes through only that subset of pixels that  appear in the output region.

 	setPixels (int, int, int, int, ColorModel, int[], int, int)

 Determine if the delivered int pixels intersect the region to  be extracted and pass through only that subset of pixels that  appear in the output region.

 	setProperties(Hashtable)

 Passes along the properties from the source object after adding a  property indicating the cropped region.

 CropImageFilter

  public CropImageFilter(int x,
                         int y,
                         int w,
                         int h)

 Constructs a CropImageFilter that extracts the absolute rectangular  region of pixels from its source Image as specified by the x, y,  w, and h parameters.

Parameters:

 x - the x location of the top of the rectangle to be extracted

 y - the y location of the top of the rectangle to be extracted

 w - the width of the rectangle to be extracted

 h - the height of the rectangle to be extracted

 setProperties

  public void setProperties(Hashtable props)

 Passes along the properties from the source object after adding a  property indicating the cropped region.

Overrides:

setProperties in class ImageFilter

 setDimensions

  public void setDimensions(int w,
                            int h)

 Override the source image's dimensions and pass the dimensions  of the rectangular cropped region to the ImageConsumer.

Overrides:

setDimensions in class ImageFilter

See Also:

ImageConsumer

 setPixels

  public void setPixels(int x,
                        int y,
                        int w,
                        int h,
                        ColorModel model,
                        byte pixels[],
                        int off,
                        int scansize)

 Determine whether the delivered byte pixels intersect the region to  be extracted and passes through only that subset of pixels that  appear in the output region.

Overrides:

setPixels in class ImageFilter

 setPixels

  public void setPixels(int x,
                        int y,
                        int w,
                        int h,
                        ColorModel model,
                        int pixels[],
                        int off,
                        int scansize)

 Determine if the delivered int pixels intersect the region to  be extracted and pass through only that subset of pixels that  appear in the output region.

Overrides:

setPixels in class ImageFilter

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.image.DirectColorModel

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.image.DirectColorModel

java.lang.Object
   |
   +----java.awt.image.ColorModel
           |
           +----java.awt.image.DirectColorModel

______________________________________________________________________________

 public class DirectColorModel

 extends ColorModel

A ColorModel class that specifies a translation from pixel values  to alpha, red, green, and blue color components for pixels which  have the color components embedded directly in the bits of the  pixel itself. This color model is similar to an X11 TrueColor  visual.

Many of the methods in this class are final. This is because the  underlying native graphics code makes assumptions about the layout  and operation of this class and those assumptions are reflected in  the implementations of the methods here that are marked final. You  can subclass this class for other reaons, but you cannot override  or modify the behaviour of those methods.

See Also:

ColorModel

______________________________________________________________________________

 	DirectColorModel(int, int, int, int)

 Constructs a DirectColorModel from the given masks specifying  which bits in the pixel contain the red, green and blue color  components.

 	DirectColorModel(int, int, int, int, int)

 Constructs a DirectColorModel from the given masks specifying  which bits in the pixel contain the alhpa, red, green and blue  color components.

 	getAlpha(int)

 Return the alpha transparency value for the specified pixel in the  range 0-255.

 	getAlphaMask()

 Returns the mask indicating which bits in a pixel contain the alpha  transparency component.

 	getBlue(int)

 Returns the blue color compoment for the specified pixel in the  range 0-255.

 	getBlueMask()

 Returns the mask indicating which bits in a pixel contain the blue  color component.

 	getGreen(int)

 Returns the green color compoment for the specified pixel in the  range 0-255.

 	getGreenMask()

 Returns the mask indicating which bits in a pixel contain the green  color component.

 	getRed(int)

 Returns the red color compoment for the specified pixel in the  range 0-255.

 	getRedMask()

 Returns the mask indicating which bits in a pixel contain the red  color component.

 	getRGB(int)

 Returns the color of the pixel in the default RGB color model.

 DirectColorModel

  public DirectColorModel(int bits,
                          int rmask,
                          int gmask,
                          int bmask)

 Constructs a DirectColorModel from the given masks specifying  which bits in the pixel contain the red, green and blue color  components. Pixels described by this color model will all  have alpha components of 255 (fully opaque). All of the bits  in each mask must be contiguous and fit in the specified number  of least significant bits of the integer.

 DirectColorModel

  public DirectColorModel(int bits,
                          int rmask,
                          int gmask,
                          int bmask,
                          int amask)

 Constructs a DirectColorModel from the given masks specifying  which bits in the pixel contain the alhpa, red, green and blue  color components. All of the bits in each mask must be contiguous  and fit in the specified number of least significant bits of the  integer.

 getRedMask

  public final int getRedMask()

 Returns the mask indicating which bits in a pixel contain the red  color component.

 getGreenMask

  public final int getGreenMask()

 Returns the mask indicating which bits in a pixel contain the green  color component.

 getBlueMask

  public final int getBlueMask()

 Returns the mask indicating which bits in a pixel contain the blue  color component.

 getAlphaMask

  public final int getAlphaMask()

 Returns the mask indicating which bits in a pixel contain the alpha  transparency component.

 getRed

  public final int getRed(int pixel)

 Returns the red color compoment for the specified pixel in the  range 0-255.

Overrides:

getRed in class ColorModel

 getGreen

  public final int getGreen(int pixel)

 Returns the green color compoment for the specified pixel in the  range 0-255.

Overrides:

getGreen in class ColorModel

 getBlue

  public final int getBlue(int pixel)

 Returns the blue color compoment for the specified pixel in the  range 0-255.

Overrides:

getBlue in class ColorModel

 getAlpha

  public final int getAlpha(int pixel)

 Return the alpha transparency value for the specified pixel in the  range 0-255.

Overrides:

getAlpha in class ColorModel

 getRGB

  public final int getRGB(int pixel)

 Returns the color of the pixel in the default RGB color model.

Overrides:

getRGB in class ColorModel

See Also:

getRGBdefault

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.image.FilteredImageSource

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.image.FilteredImageSource

java.lang.Object
   |
   +----java.awt.image.FilteredImageSource

______________________________________________________________________________

 public class FilteredImageSource

 extends Object

 implements ImageProducer

This class is an implementation of the ImageProducer interface which  takes an existing image and a filter object and uses them to produce  image data for a new filtered version of the original image.  Here is an example which filters an image by swapping the red and  blue compents:

        Image src = getImage("doc:///demo/images/duke/T1.gif");
        ImageFilter colorfilter = new RedBlueSwapFilter();
        Image img = createImage(new FilteredImageSource(src.getSource(),
                                                        colorfilter));

See Also:

ImageProducer

______________________________________________________________________________

 	FilteredImageSource(ImageProducer, ImageFilter)

 Constructs an ImageProducer object from an existing ImageProducer  and a filter object.

 	addConsumer(ImageConsumer)

 Adds an ImageConsumer to the list of consumers interested in  data for this image.

 	isConsumer(ImageConsumer)

 Determines whether an ImageConsumer is on the list of consumers  currently interested in data for this image.

 	removeConsumer(ImageConsumer)

 Removes an ImageConsumer from the list of consumers interested in  data for this image.

 	requestTopDownLeftRightResend(ImageConsumer)

 Requests that a given ImageConsumer have the image data delivered  one more time in top-down, left-right order.

 	startProduction(ImageConsumer)

 Adds an ImageConsumer to the list of consumers interested in  data for this image, and immediately starts delivery of the  image data through the ImageConsumer interface.

 FilteredImageSource

  public FilteredImageSource(ImageProducer orig,
                             ImageFilter imgf)

 Constructs an ImageProducer object from an existing ImageProducer  and a filter object.

See Also:

ImageFilter, createImage

 addConsumer

  public synchronized void addConsumer(ImageConsumer ic)

 Adds an ImageConsumer to the list of consumers interested in  data for this image.

See Also:

ImageConsumer

 isConsumer

  public synchronized boolean isConsumer(ImageConsumer ic)

 Determines whether an ImageConsumer is on the list of consumers  currently interested in data for this image.

Returns:

 true if the ImageConsumer is on the list; false otherwise

See Also:

ImageConsumer

 removeConsumer

  public synchronized void removeConsumer(ImageConsumer ic)

 Removes an ImageConsumer from the list of consumers interested in  data for this image.

See Also:

ImageConsumer

 startProduction

  public void startProduction(ImageConsumer ic)

 Adds an ImageConsumer to the list of consumers interested in  data for this image, and immediately starts delivery of the  image data through the ImageConsumer interface.

See Also:

ImageConsumer

 requestTopDownLeftRightResend

  public void requestTopDownLeftRightResend(ImageConsumer ic)

 Requests that a given ImageConsumer have the image data delivered  one more time in top-down, left-right order. The request is  handed to the ImageFilter for further processing, since the  ability to preserve the pixel ordering depends on the filter.

See Also:

ImageConsumer

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Image

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Image

java.lang.Object
   |
   +----java.awt.Image

______________________________________________________________________________

 public class Image

 extends Object

The image class is an abstract class. The image must be obtained in a  platform specific way.

______________________________________________________________________________

 	SCALE_AREA_AVERAGING

 Use the Area Averaging image scaling algorithm.

 	SCALE_DEFAULT

 Use the default image scaling algorithm.

 	SCALE_FAST

 Choose an image scaling algorithm that gives higher priority  to scaling speed than smoothness of the scaled image.

 	SCALE_REPLICATE

 Use the ReplicateScaleFilter image scaling algorithm.

 	SCALE_SMOOTH

 Choose an image scaling algorithm that gives higher priority  to image smoothness than scaling speed.

 	UndefinedProperty

 The UndefinedProperty object should be returned whenever a  property which was not defined for a particular image is  fetched.

 	Image()

 	flush()

 Flushes all resources being used by this Image object.

 	getGraphics()

 Gets a graphics object to draw into this image.

 	getHeight(ImageObserver)

 Gets the actual height of the image.

 	getProperty(String, ImageObserver)

 Gets a property of the image by name.

 	getScaledInstance(int, int, int)

 Returns a scaled version of this image.

 	getSource()

 Gets the object that produces the pixels for the image.

 	getWidth(ImageObserver)

 Gets the actual width of the image.

 UndefinedProperty

  public final static Object UndefinedProperty

 The UndefinedProperty object should be returned whenever a  property which was not defined for a particular image is  fetched.

 SCALE_DEFAULT

  public final static int SCALE_DEFAULT

 Use the default image scaling algorithm.

 SCALE_FAST

  public final static int SCALE_FAST

 Choose an image scaling algorithm that gives higher priority  to scaling speed than smoothness of the scaled image.

 SCALE_SMOOTH

  public final static int SCALE_SMOOTH

 Choose an image scaling algorithm that gives higher priority  to image smoothness than scaling speed.

 SCALE_REPLICATE

  public final static int SCALE_REPLICATE

 Use the ReplicateScaleFilter image scaling algorithm. The  image object is free to substitute a different filter that  performs the same algorithm yet integrates more efficiently  into the image infrastructure supplied by the toolkit.

See Also:

ReplicateScaleFilter

 SCALE_AREA_AVERAGING

  public final static int SCALE_AREA_AVERAGING

 Use the Area Averaging image scaling algorithm. The  image object is free to substitute a different filter that  performs the same algorithm yet integrates more efficiently  into the image infrastructure supplied by the toolkit.

See Also:

AreaAveragingScaleFilter

 Image

  public Image()

 getWidth

  public abstract int getWidth(ImageObserver observer)

 Gets the actual width of the image. If the width is not known  yet then the ImageObserver will be notified later and -1 will  be returned.

See Also:

getHeight, ImageObserver

 getHeight

  public abstract int getHeight(ImageObserver observer)

 Gets the actual height of the image. If the height is not known  yet then the ImageObserver will be notified later and -1 will  be returned.

See Also:

getWidth, ImageObserver

 getSource

  public abstract ImageProducer getSource()

 Gets the object that produces the pixels for the image.  This is used by the Image filtering classes and by the  image conversion and scaling code.

See Also:

ImageProducer

 getGraphics

  public abstract Graphics getGraphics()

 Gets a graphics object to draw into this image.  This will only work for off-screen images.

See Also:

Graphics

 getProperty

  public abstract Object getProperty(String name,
                                     ImageObserver observer)

 Gets a property of the image by name. Individual property names  are defined by the various image formats. If a property is not  defined for a particular image, this method will return the  UndefinedProperty object. If the properties for this image are  not yet known, then this method will return null and the ImageObserver  object will be notified later. The property name "comment" should  be used to store an optional comment which can be presented to  the user as a description of the image, its source, or its author.

See Also:

ImageObserver, UndefinedProperty

 getScaledInstance

  public Image getScaledInstance(int width,
                                 int height,
                                 int hints)

 Returns a scaled version of this image.  A new Image object is returned which will render the image at  the specified width and height by default. The new Image object  may be loaded asynchronously even if the original source image  has already been loaded completely. If either the width or  height is a negative number then a value is substituted to  maintain the aspect ratio of the original image dimensions.

Parameters:

 width - the width to stretch the image to

 height - the height to stretch the image to

 hints - flags to indicate the type of algorithm to use  for image resampling

 flush

  public abstract void flush()

 Flushes all resources being used by this Image object. This  includes any pixel data that is being cached for rendering to  the screen as well as any system resources that are being used  to store data or pixels for the image. The image is reset to  a state similar to when it was first created so that if it is  again rendered, the image data will have to be recreated or  fetched again from its source.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.image.ImageConsumer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.image.ImageConsumer

 public interface ImageConsumer

The interface for objects expressing interest in image data through  the ImageProducer interfaces. When a consumer is added to an image  producer, the producer delivers all of the data about the image  using the method calls defined in this interface.

See Also:

ImageProducer

______________________________________________________________________________

 	COMPLETESCANLINES

 The pixels will be delivered in (multiples of) complete scanlines  at a time.

 	IMAGEABORTED

 The image creation process was deliberately aborted.

 	IMAGEERROR

 An error was encountered while producing the image.

 	RANDOMPIXELORDER

 The pixels will be delivered in a random order.

 	SINGLEFRAME

 The image contain a single static image.

 	SINGLEFRAMEDONE

 One frame of the image is complete but there are more frames  to be delivered.

 	SINGLEPASS

 The pixels will be delivered in a single pass.

 	STATICIMAGEDONE

 The image is complete and there are no more pixels or frames  to be delivered.

 	TOPDOWNLEFTRIGHT

 The pixels will be delivered in top-down, left-to-right order.

 	imageComplete(int)

 The imageComplete method is called when the ImageProducer is  finished delivering all of the pixels that the source image  contains, or when a single frame of a multi-frame animation has  been completed, or when an error in loading or producing the  image has occured.

 	setColorModel(ColorModel)

 The ColorModel object used for the majority of  the pixels reported using the setPixels method  calls.

 	setDimensions(int, int)

 The dimensions of the source image are reported using the  setDimensions method call.

 	setHints(int)

 The ImageProducer can deliver the pixels in any order, but  the ImageConsumer may be able to scale or convert the pixels  to the destination ColorModel more efficiently or with higher  quality if it knows some information about how the pixels will  be delivered up front.

 	setPixels (int, int, int, int, ColorModel, byte[], int, int)

 The pixels of the image are delivered using one or more calls  to the setPixels method.

 	setPixels (int, int, int, int, ColorModel, int[], int, int)

 The pixels of the image are delivered using one or more calls  to the setPixels method.

 	setProperties(Hashtable)

 Sets the extensible list of properties associated with this image.

 RANDOMPIXELORDER

  public final static int RANDOMPIXELORDER

 The pixels will be delivered in a random order. This tells the  ImageConsumer not to use any optimizations that depend on the  order of pixel delivery, which should be the default assumption  in the absence of any call to the setHints method.

See Also:

setHints

 TOPDOWNLEFTRIGHT

  public final static int TOPDOWNLEFTRIGHT

 The pixels will be delivered in top-down, left-to-right order.

See Also:

setHints

 COMPLETESCANLINES

  public final static int COMPLETESCANLINES

 The pixels will be delivered in (multiples of) complete scanlines  at a time.

See Also:

setHints

 SINGLEPASS

  public final static int SINGLEPASS

 The pixels will be delivered in a single pass. Each pixel will  appear in only one call to any of the setPixels methods. An  example of an image format which does not meet this criterion  is a progressive JPEG image which defines pixels in multiple  passes, each more refined than the previous.

See Also:

setHints

 SINGLEFRAME

  public final static int SINGLEFRAME

 The image contain a single static image. The pixels will be defined  in calls to the setPixels methods and then the imageComplete method  will be called with the STATICIMAGEDONE flag after which no more  image data will be delivered. An example of an image type which  would not meet these criteria would be the output of a video feed,  or the representation of a 3D rendering being manipulated  by the user. The end of each frame in those types of images will  be indicated by calling imageComplete with the SINGLEFRAMEDONE flag.

See Also:

setHints, imageComplete

 IMAGEERROR

  public final static int IMAGEERROR

 An error was encountered while producing the image.

See Also:

imageComplete

 SINGLEFRAMEDONE

  public final static int SINGLEFRAMEDONE

 One frame of the image is complete but there are more frames  to be delivered.

See Also:

imageComplete

 STATICIMAGEDONE

  public final static int STATICIMAGEDONE

 The image is complete and there are no more pixels or frames  to be delivered.

See Also:

imageComplete

 IMAGEABORTED

  public final static int IMAGEABORTED

 The image creation process was deliberately aborted.

See Also:

imageComplete

 setDimensions

  public abstract void setDimensions(int width,
                                     int height)

 The dimensions of the source image are reported using the  setDimensions method call.

 setProperties

  public abstract void setProperties(Hashtable props)

 Sets the extensible list of properties associated with this image.

 setColorModel

  public abstract void setColorModel(ColorModel model)

 The ColorModel object used for the majority of  the pixels reported using the setPixels method  calls. Note that each set of pixels delivered using setPixels  contains its own ColorModel object, so no assumption should  be made that this model will be the only one used in delivering  pixel values. A notable case where multiple ColorModel objects  may be seen is a filtered image when for each set of pixels  that it filters, the filter  determines whether the  pixels can be sent on untouched, using the original ColorModel,  or whether the pixels should be modified (filtered) and passed  on using a ColorModel more convenient for the filtering process.

See Also:

ColorModel

 setHints

  public abstract void setHints(int hintflags)

 The ImageProducer can deliver the pixels in any order, but  the ImageConsumer may be able to scale or convert the pixels  to the destination ColorModel more efficiently or with higher  quality if it knows some information about how the pixels will  be delivered up front. The setHints method should be called  before any calls to any of the setPixels methods with a bit mask  of hints about the manner in which the pixels will be delivered.  If the ImageProducer does not follow the guidelines for the  indicated hint, the results are undefined.

 setPixels

  public abstract void setPixels(int x,
                                 int y,
                                 int w,
                                 int h,
                                 ColorModel model,
                                 byte pixels[],
                                 int off,
                                 int scansize)

 The pixels of the image are delivered using one or more calls  to the setPixels method. Each call specifies the location and  size of the rectangle of source pixels that are contained in  the array of pixels. The specified ColorModel object should  be used to convert the pixels into their corresponding color  and alpha components. Pixel (m,n) is stored in the pixels array  at index (n * scansize + m + off). The pixels delivered using  this method are all stored as bytes.

See Also:

ColorModel

 setPixels

  public abstract void setPixels(int x,
                                 int y,
                                 int w,
                                 int h,
                                 ColorModel model,
                                 int pixels[],
                                 int off,
                                 int scansize)

 The pixels of the image are delivered using one or more calls  to the setPixels method. Each call specifies the location and  size of the rectangle of source pixels that are contained in  the array of pixels. The specified ColorModel object should  be used to convert the pixels into their corresponding color  and alpha components. Pixel (m,n) is stored in the pixels array  at index (n * scansize + m + off). The pixels delivered using  this method are all stored as ints.

See Also:

ColorModel

 imageComplete

  public abstract void imageComplete(int status)

 The imageComplete method is called when the ImageProducer is  finished delivering all of the pixels that the source image  contains, or when a single frame of a multi-frame animation has  been completed, or when an error in loading or producing the  image has occured. The ImageConsumer should remove itself from the  list of consumers registered with the ImageProducer at this time,  unless it is interested in successive frames.

See Also:

removeConsumer

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.image.ImageFilter

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.image.ImageFilter

java.lang.Object
   |
   +----java.awt.image.ImageFilter

______________________________________________________________________________

 public class ImageFilter

 extends Object

 implements ImageConsumer, Cloneable

This class implements a filter for the set of interface methods that  are used to deliver data from an ImageProducer to an ImageConsumer.  It is meant to be used in conjunction with a FilteredImageSource  object to produce filtered versions of existing images. It is a  base class that provides the calls needed to implement a "Null filter"  which has no effect on the data being passed through. Filters should  subclass this class and override the methods which deal with the  data that needs to be filtered and modify it as necessary.

See Also:

FilteredImageSource, ImageConsumer

______________________________________________________________________________

 	consumer

 The consumer of the particular image data stream for which this  instance of the ImageFilter is filtering data.

 	ImageFilter()

 	clone()

 Clones this object.

 	getFilterInstance(ImageConsumer)

 Returns a unique instance of an ImageFilter object which will  actually perform the filtering for the specified ImageConsumer.

 	imageComplete(int)

 Filters the information provided in the imageComplete method of  the ImageConsumer interface.

 	resendTopDownLeftRight(ImageProducer)

 Responds to a request for a TopDownLeftRight (TDLR) ordered resend  of the pixel data from an ImageConsumer.

 	setColorModel(ColorModel)

 Filter the information provided in the setColorModel method  of the ImageConsumer interface.

 	setDimensions(int, int)

 Filters the information provided in the setDimensions method  of the ImageConsumer interface.

 	setHints(int)

 Filters the information provided in the setHints method  of the ImageConsumer interface.

 	setPixels (int, int, int, int, ColorModel, byte[], int, int)

 Filters the information provided in the setPixels method of the  ImageConsumer interface which takes an array of bytes.

 	setPixels (int, int, int, int, ColorModel, int[], int, int)

 Filters the information provided in the setPixels method of the  ImageConsumer interface which takes an array of integers.

 	setProperties(Hashtable)

 Passes the properties from the source object along after adding a  property indicating the stream of filters it has been run through.

 consumer

  protected ImageConsumer consumer

 The consumer of the particular image data stream for which this  instance of the ImageFilter is filtering data. It is not  initialized during the constructor, but rather during the  getFilterInstance() method call when the FilteredImageSource  is creating a unique instance of this object for a particular  image data stream.

See Also:

getFilterInstance, ImageConsumer

 ImageFilter

  public ImageFilter()

 getFilterInstance

  public ImageFilter getFilterInstance(ImageConsumer ic)

 Returns a unique instance of an ImageFilter object which will  actually perform the filtering for the specified ImageConsumer.  The default implementation just clones this object.

 setDimensions

  public void setDimensions(int width,
                            int height)

 Filters the information provided in the setDimensions method  of the ImageConsumer interface.

See Also:

setDimensions

 setProperties

  public void setProperties(Hashtable props)

 Passes the properties from the source object along after adding a  property indicating the stream of filters it has been run through.

 setColorModel

  public void setColorModel(ColorModel model)

 Filter the information provided in the setColorModel method  of the ImageConsumer interface.

See Also:

setColorModel

 setHints

  public void setHints(int hints)

 Filters the information provided in the setHints method  of the ImageConsumer interface.

See Also:

setHints

 setPixels

  public void setPixels(int x,
                        int y,
                        int w,
                        int h,
                        ColorModel model,
                        byte pixels[],
                        int off,
                        int scansize)

 Filters the information provided in the setPixels method of the  ImageConsumer interface which takes an array of bytes.

See Also:

setPixels

 setPixels

  public void setPixels(int x,
                        int y,
                        int w,
                        int h,
                        ColorModel model,
                        int pixels[],
                        int off,
                        int scansize)

 Filters the information provided in the setPixels method of the  ImageConsumer interface which takes an array of integers.

See Also:

setPixels

 imageComplete

  public void imageComplete(int status)

 Filters the information provided in the imageComplete method of  the ImageConsumer interface.

See Also:

imageComplete

 resendTopDownLeftRight

  public void resendTopDownLeftRight(ImageProducer ip)

 Responds to a request for a TopDownLeftRight (TDLR) ordered resend  of the pixel data from an ImageConsumer.  The ImageFilter can respond to this request in one of three ways.

1. If the filter can determine that it will forward the pixels in  TDLR order if its upstream producer object sends them  in TDLR order, then the request is automatically forwarded by  default to the indicated ImageProducer using this filter as the  requesting ImageConsumer, so no override is necessary.

2. If the filter can resend the pixels in the right order on its  own (presumably because the generated pixels have been saved in  some sort of buffer), then it can override this method and  simply resend the pixels in TDLR order as specified in the  ImageProducer API.

3. If the filter simply returns from this  method then the request will be ignored and no resend will  occur.

Parameters:

 ip - The ImageProducer that is feeding this instance of  the filter - also the ImageProducer that the request should be  forwarded to if necessary.

See Also:

requestTopDownLeftRightResend

 clone

  public Object clone()

 Clones this object.

Overrides:

clone in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.image.ImageObserver

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.image.ImageObserver

 public interface ImageObserver

An asynchronous update interface for receiving notifications about  Image information as the Image is constructed.

______________________________________________________________________________

 	ABORT

 An image which was being tracked asynchronously was aborted before  production was complete.

 	ALLBITS

 A static image which was previously drawn is now complete and can  be drawn again in its final form.

 	ERROR

 An image which was being tracked asynchronously has encountered  an error.

 	FRAMEBITS

 Another complete frame of a multi-frame image which was previously  drawn is now available to be drawn again.

 	HEIGHT

 The height of the base image is now available and can be taken  from the height argument to the imageUpdate callback method.

 	PROPERTIES

 The properties of the image are now available.

 	SOMEBITS

 More pixels needed for drawing a scaled variation of the image  are available.

 	WIDTH

 The width of the base image is now available and can be taken  from the width argument to the imageUpdate callback method.

 	imageUpdate(Image, int, int, int, int, int)

 This method is called when information about an image which was  previously requested using an asynchronous interface becomes  available.

 WIDTH

  public final static int WIDTH

 The width of the base image is now available and can be taken  from the width argument to the imageUpdate callback method.

See Also:

getWidth, imageUpdate

 HEIGHT

  public final static int HEIGHT

 The height of the base image is now available and can be taken  from the height argument to the imageUpdate callback method.

See Also:

getHeight, imageUpdate

 PROPERTIES

  public final static int PROPERTIES

 The properties of the image are now available.

See Also:

getProperty, imageUpdate

 SOMEBITS

  public final static int SOMEBITS

 More pixels needed for drawing a scaled variation of the image  are available. The bounding box of the new pixels can be taken  from the x, y, width, and height arguments to the imageUpdate  callback method.

See Also:

drawImage, imageUpdate

 FRAMEBITS

  public final static int FRAMEBITS

 Another complete frame of a multi-frame image which was previously  drawn is now available to be drawn again. The x, y, width, and height  arguments to the imageUpdate callback method should be ignored.

See Also:

drawImage, imageUpdate

 ALLBITS

  public final static int ALLBITS

 A static image which was previously drawn is now complete and can  be drawn again in its final form. The x, y, width, and height  arguments to the imageUpdate callback method should be ignored.

See Also:

drawImage, imageUpdate

 ERROR

  public final static int ERROR

 An image which was being tracked asynchronously has encountered  an error. No further information will become available and  drawing the image will fail.  As a convenience, the ABORT flag will be indicated at the same  time to indicate that the image production was aborted.

See Also:

imageUpdate

 ABORT

  public final static int ABORT

 An image which was being tracked asynchronously was aborted before  production was complete. No more information will become available  without further action to trigger another image production sequence.  If the ERROR flag was not also set in this image update, then  accessing any of the data in the image will restart the production  again, probably from the beginning.

See Also:

imageUpdate

 imageUpdate

  public abstract boolean imageUpdate(Image img,
                                      int infoflags,
                                      int x,
                                      int y,
                                      int width,
                                      int height)

 This method is called when information about an image which was  previously requested using an asynchronous interface becomes  available. Asynchronous interfaces are method calls such as  getWidth(ImageObserver) and drawImage(img, x, y, ImageObserver)  which take an ImageObserver object as an argument. Those methods  register the caller as interested either in information about  the overall image itself (in the case of getWidth(ImageObserver))  or about an output version of an image (in the case of the  drawImage(img, x, y, [w, h,] ImageObserver) call).

This method  should return true if further updates are needed or false if the  required information has been acquired. The image which was being  tracked is passed in using the img argument. Various constants  are combined to form the infoflags argument which indicates what  information about the image is now available. The interpretation  of the x, y, width, and height arguments depends on the contents  of the infoflags argument.

See Also:

getWidth, getHeight, drawImage

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.image.ImageProducer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.image.ImageProducer

 public interface ImageProducer

The interface for objects which can produce the image data for Images.  Each image contains an ImageProducer which is used to reconstruct  the image whenever it is needed, for example, when a new size of the  Image is scaled, or when the width or height of the Image is being  requested.

See Also:

ImageConsumer

______________________________________________________________________________

 	addConsumer(ImageConsumer)

 This method is used to register an ImageConsumer with the  ImageProducer for access to the image data during a later  reconstruction of the Image.

 	isConsumer(ImageConsumer)

 This method determines if a given ImageConsumer object  is currently registered with this ImageProducer as one  of its consumers.

 	removeConsumer(ImageConsumer)

 This method removes the given ImageConsumer object  from the list of consumers currently registered to  receive image data.

 	requestTopDownLeftRightResend(ImageConsumer)

 This method is used by an ImageConsumer to request that  the ImageProducer attempt to resend the image data one  more time in TOPDOWNLEFTRIGHT order so that higher  quality conversion algorithms which depend on receiving  pixels in order can be used to produce a better output  version of the image.

 	startProduction(ImageConsumer)

 This method both registers the given ImageConsumer object  as a consumer and starts an immediate reconstruction of  the image data which will then be delivered to this  consumer and any other consumer which may have already  been registered with the producer.

 addConsumer

  public abstract void addConsumer(ImageConsumer ic)

 This method is used to register an ImageConsumer with the  ImageProducer for access to the image data during a later  reconstruction of the Image. The ImageProducer may, at its  discretion, start delivering the image data to the consumer  using the ImageConsumer interface immediately, or when the  next available image reconstruction is triggered by a call  to the startProduction method.

See Also:

startProduction

 isConsumer

  public abstract boolean isConsumer(ImageConsumer ic)

 This method determines if a given ImageConsumer object  is currently registered with this ImageProducer as one  of its consumers.

 removeConsumer

  public abstract void removeConsumer(ImageConsumer ic)

 This method removes the given ImageConsumer object  from the list of consumers currently registered to  receive image data. It is not considered an error  to remove a consumer that is not currently registered.  The ImageProducer should stop sending data to this  consumer as soon as is feasible.

 startProduction

  public abstract void startProduction(ImageConsumer ic)

 This method both registers the given ImageConsumer object  as a consumer and starts an immediate reconstruction of  the image data which will then be delivered to this  consumer and any other consumer which may have already  been registered with the producer. This method differs  from the addConsumer method in that a reproduction of  the image data should be triggered as soon as possible.

See Also:

addConsumer

 requestTopDownLeftRightResend

  public abstract void requestTopDownLeftRightResend(ImageConsumer ic)

 This method is used by an ImageConsumer to request that  the ImageProducer attempt to resend the image data one  more time in TOPDOWNLEFTRIGHT order so that higher  quality conversion algorithms which depend on receiving  pixels in order can be used to produce a better output  version of the image. The ImageProducer is free to  ignore this call if it cannot resend the data in that  order. If the data can be resent, then the ImageProducer  should respond by executing the following minimum set of  ImageConsumer method calls:

        ic.setHints(TOPDOWNLEFTRIGHT | );
        ic.setPixels(...);      // As many times as needed
        ic.imageComplete();

See Also:

setHints

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.image.IndexColorModel

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.image.IndexColorModel

java.lang.Object
   |
   +----java.awt.image.ColorModel
           |
           +----java.awt.image.IndexColorModel

______________________________________________________________________________

 public class IndexColorModel

 extends ColorModel

A ColorModel class that specifies a translation from pixel values  to alpha, red, green, and blue color components for pixels which  represent indices into a fixed colormap. An optional transparent  pixel value can be supplied which indicates a completely transparent  pixel, regardless of any alpha value recorded for that pixel value.  This color model is similar to an X11 PseudoColor visual.

Many of the methods in this class are final. The reason for  this is that the underlying native graphics code makes assumptions  about the layout and operation of this class and those assumptions  are reflected in the implementations of the methods here that are  marked final. You can subclass this class for other reaons, but  you cannot override or modify the behaviour of those methods.

See Also:

ColorModel

______________________________________________________________________________

 	IndexColorModel (int, int, byte[], byte[], byte[])

 Constructs an IndexColorModel from the given arrays of red,  green, and blue components.

 	IndexColorModel (int, int, byte[], byte[], byte[], byte[])

 Constructs an IndexColorModel from the given arrays of red,  green, blue and alpha components.

 	IndexColorModel (int, int, byte[], byte[], byte[], int)

 Constructs an IndexColorModel from the given arrays of red,  green, and blue components.

 	IndexColorModel(int, int, byte[], int, boolean)

 Constructs an IndexColorModel from a single arrays of packed  red, green, blue and optional alpha components.

 	IndexColorModel (int, int, byte[], int, boolean, int)

 Constructs an IndexColorModel from a single arrays of packed  red, green, blue and optional alpha components.

 	getAlpha(int)

 Returns the alpha transparency value for the specified pixel in the  range 0-255.

 	getAlphas(byte[])

 Copies the array of alpha transparency values into the given array.

 	getBlue(int)

 Returns the blue color compoment for the specified pixel in the  range 0-255.

 	getBlues(byte[])

 Copies the array of blue color components into the given array.

 	getGreen(int)

 Returns the green color compoment for the specified pixel in the  range 0-255.

 	getGreens(byte[])

 Copies the array of green color components into the given array.

 	getMapSize()

 Returns the size of the color component arrays in this IndexColorModel.

 	getRed(int)

 Returns the red color compoment for the specified pixel in the  range 0-255.

 	getReds(byte[])

 Copies the array of red color components into the given array.

 	getRGB(int)

 Returns the color of the pixel in the default RGB color model.

 	getTransparentPixel()

 Returns the index of the transparent pixel in this IndexColorModel  or -1 if there is no transparent pixel.

 IndexColorModel

  public IndexColorModel(int bits,
                         int size,
                         byte r[],
                         byte g[],
                         byte b[])

 Constructs an IndexColorModel from the given arrays of red,  green, and blue components. Pixels described by this color  model will all have alpha components of 255 (fully opaque).  All of the arrays specifying the color components must have  at least the specified number of entries.

Parameters:

 bits - The number of bits each pixel occupies.

 size - The size of the color component arrays.

 r - The array of red color components.

 g - The array of green color components.

 b - The array of blue color components.

 IndexColorModel

  public IndexColorModel(int bits,
                         int size,
                         byte r[],
                         byte g[],
                         byte b[],
                         int trans)

 Constructs an IndexColorModel from the given arrays of red,  green, and blue components. Pixels described by this color  model will all have alpha components of 255 (fully opaque),  except for the indicated transparent pixel. All of the arrays  specifying the color components must have at least the specified  number of entries.

Parameters:

 bits - The number of bits each pixel occupies.

 size - The size of the color component arrays.

 r - The array of red color components.

 g - The array of green color components.

 b - The array of blue color components.

 trans - The index of the transparent pixel.

 IndexColorModel

  public IndexColorModel(int bits,
                         int size,
                         byte r[],
                         byte g[],
                         byte b[],
                         byte a[])

 Constructs an IndexColorModel from the given arrays of red,  green, blue and alpha components. All of the arrays specifying  the color components must have at least the specified number  of entries.

Parameters:

 bits - The number of bits each pixel occupies.

 size - The size of the color component arrays.

 r - The array of red color components.

 g - The array of green color components.

 b - The array of blue color components.

 a - The array of alpha value components.

 IndexColorModel

  public IndexColorModel(int bits,
                         int size,
                         byte cmap[],
                         int start,
                         boolean hasalpha)

 Constructs an IndexColorModel from a single arrays of packed  red, green, blue and optional alpha components. The array  must have enough values in it to fill all of the needed  component arrays of the specified size.

Parameters:

 bits - The number of bits each pixel occupies.

 size - The size of the color component arrays.

 cmap - The array of color components.

 start - The starting offset of the first color component.

 hasalpha - Indicates whether alpha values are contained in 	the cmap array.

 IndexColorModel

  public IndexColorModel(int bits,
                         int size,
                         byte cmap[],
                         int start,
                         boolean hasalpha,
                         int trans)

 Constructs an IndexColorModel from a single arrays of packed  red, green, blue and optional alpha components. The specified  transparent index represents a pixel which will be considered  entirely transparent regardless of any alpha value specified  for it. The array must have enough values in it to fill all  of the needed component arrays of the specified size.

Parameters:

 bits - The number of bits each pixel occupies.

 size - The size of the color component arrays.

 cmap - The array of color components.

 start - The starting offset of the first color component.

 hasalpha - Indicates whether alpha values are contained in 	the cmap array.

 trans - The index of the fully transparent pixel.

 getMapSize

  public final int getMapSize()

 Returns the size of the color component arrays in this IndexColorModel.

 getTransparentPixel

  public final int getTransparentPixel()

 Returns the index of the transparent pixel in this IndexColorModel  or -1 if there is no transparent pixel.

 getReds

  public final void getReds(byte r[])

 Copies the array of red color components into the given array. Only  the initial entries of the array as specified by getMapSize() are  written.

 getGreens

  public final void getGreens(byte g[])

 Copies the array of green color components into the given array. Only  the initial entries of the array as specified by getMapSize() are  written.

 getBlues

  public final void getBlues(byte b[])

 Copies the array of blue color components into the given array. Only  the initial entries of the array as specified by getMapSize() will  be written.

 getAlphas

  public final void getAlphas(byte a[])

 Copies the array of alpha transparency values into the given array. Only  the initial entries of the array as specified by getMapSize() will  be written.

 getRed

  public final int getRed(int pixel)

 Returns the red color compoment for the specified pixel in the  range 0-255.

Overrides:

getRed in class ColorModel

 getGreen

  public final int getGreen(int pixel)

 Returns the green color compoment for the specified pixel in the  range 0-255.

Overrides:

getGreen in class ColorModel

 getBlue

  public final int getBlue(int pixel)

 Returns the blue color compoment for the specified pixel in the  range 0-255.

Overrides:

getBlue in class ColorModel

 getAlpha

  public final int getAlpha(int pixel)

 Returns the alpha transparency value for the specified pixel in the  range 0-255.

Overrides:

getAlpha in class ColorModel

 getRGB

  public final int getRGB(int pixel)

 Returns the color of the pixel in the default RGB color model.

Overrides:

getRGB in class ColorModel

See Also:

getRGBdefault

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.image.MemoryImageSource

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.image.MemoryImageSource

java.lang.Object
   |
   +----java.awt.image.MemoryImageSource

______________________________________________________________________________

 public class MemoryImageSource

 extends Object

 implements ImageProducer

This class is an implementation of the ImageProducer interface which  uses an array to produce pixel values for an Image. Here is an example  which calculates a 100x100 image representing a fade from black to blue  along the X axis and a fade from black to red along the Y axis:

        int w = 100;
        int h = 100;
        int pix[] = new int[w * h];
        int index = 0;
        for (int y = 0; y
 The MemoryImageSource is also capable of managing a memory image which
 varies over time to allow animation or custom rendering.  Here is an
 example showing how to set up the animation source and signal changes
 in the data (adapted from the MemoryAnimationSourceDemo by Garth Dickie):

        int pixels[];
        MemoryImageSource source;
        public void init() {
            int width = 50;
            int height = 50;
            int size = width * height;
            pixels = new int[size];
            int value = getBackground().getRGB();
            for (int i = 0; i

 See Also:

 ImageProducer

______________________________________________________________________________

        MemoryImageSource(int, int, ColorModel, byte[], int, int)

  Constructs an ImageProducer object which uses an array of bytes
 to produce data for an Image object.

        MemoryImageSource(int, int, ColorModel, byte[], int, int, Hashtable)

  Constructs an ImageProducer object which uses an array of bytes
 to produce data for an Image object.

        MemoryImageSource(int, int, ColorModel, int[], int, int)

  Constructs an ImageProducer object which uses an array of integers
 to produce data for an Image object.

        MemoryImageSource(int, int, ColorModel, int[], int, int, Hashtable)

  Constructs an ImageProducer object which uses an array of integers
 to produce data for an Image object.

        MemoryImageSource(int, int, int[], int, int)

  Constructs an ImageProducer object which uses an array of integers
 in the default RGB ColorModel to produce data for an Image object.

        MemoryImageSource(int, int, int[], int, int, Hashtable)

  Constructs an ImageProducer object which uses an array of integers
 in the default RGB ColorModel to produce data for an Image object.

        addConsumer(ImageConsumer)

  Adds an ImageConsumer to the list of consumers interested in
 data for this image.

        isConsumer(ImageConsumer)

  Determine if an ImageConsumer is on the list of consumers currently
 interested in data for this image.

        newPixels()

  Send a whole new buffer of pixels to any ImageConsumers that
 are currently interested in the data for this image and notify
 them that an animation frame is complete.

        newPixels(byte[], ColorModel, int, int)

  Change to a new byte array to hold the pixels for this image.

        newPixels(int, int, int, int)

  Send a rectangular region of the buffer of pixels to any
 ImageConsumers that are currently interested in the data for
 this image and notify them that an animation frame is complete.

        newPixels(int, int, int, int, boolean)

  Send a rectangular region of the buffer of pixels to any
 ImageConsumers that are currently interested in the data for
 this image.

        newPixels(int[], ColorModel, int, int)

  Change to a new int array to hold the pixels for this image.

        removeConsumer(ImageConsumer)

  Remove an ImageConsumer from the list of consumers interested in
 data for this image.

        requestTopDownLeftRightResend(ImageConsumer)

  Requests that a given ImageConsumer have the image data delivered
 one more time in top-down, left-right order.

        setAnimated(boolean)

  Change this memory image into a multi-frame animation or a
 single-frame static image depending on the animated parameter.

        setFullBufferUpdates(boolean)

  Specify whether this animated memory image should always be
 updated by sending the complete buffer of pixels whenever
 there is a change.

        startProduction(ImageConsumer)

  Adds an ImageConsumer to the list of consumers interested in
 data for this image, and immediately start delivery of the
 image data through the ImageConsumer interface.

MemoryImageSource

  public MemoryImageSource(int w,
                           int h,
                           ColorModel cm,
                           byte pix[],
                           int off,
                           int scan)

 Constructs an ImageProducer object which uses an array of bytes
 to produce data for an Image object.

 See Also:

 createImage

MemoryImageSource

  public MemoryImageSource(int w,
                           int h,
                           ColorModel cm,
                           byte pix[],
                           int off,
                           int scan,
                           Hashtable props)

 Constructs an ImageProducer object which uses an array of bytes
 to produce data for an Image object.

 See Also:

 createImage

MemoryImageSource

  public MemoryImageSource(int w,
                           int h,
                           ColorModel cm,
                           int pix[],
                           int off,
                           int scan)

 Constructs an ImageProducer object which uses an array of integers
 to produce data for an Image object.

 See Also:

 createImage

MemoryImageSource

  public MemoryImageSource(int w,
                           int h,
                           ColorModel cm,
                           int pix[],
                           int off,
                           int scan,
                           Hashtable props)

 Constructs an ImageProducer object which uses an array of integers
 to produce data for an Image object.

 See Also:

 createImage

MemoryImageSource

  public MemoryImageSource(int w,
                           int h,
                           int pix[],
                           int off,
                           int scan)

 Constructs an ImageProducer object which uses an array of integers
 in the default RGB ColorModel to produce data for an Image object.

 See Also:

 createImage, getRGBdefault

MemoryImageSource

  public MemoryImageSource(int w,
                           int h,
                           int pix[],
                           int off,
                           int scan,
                           Hashtable props)

 Constructs an ImageProducer object which uses an array of integers
 in the default RGB ColorModel to produce data for an Image object.

 See Also:

 createImage, getRGBdefault

addConsumer

  public synchronized void addConsumer(ImageConsumer ic)

 Adds an ImageConsumer to the list of consumers interested in
 data for this image.

 See Also:

 ImageConsumer

isConsumer

  public synchronized boolean isConsumer(ImageConsumer ic)

 Determine if an ImageConsumer is on the list of consumers currently
 interested in data for this image.

 Returns:

 true if the ImageConsumer is on the list; false otherwise

 See Also:

 ImageConsumer

removeConsumer

  public synchronized void removeConsumer(ImageConsumer ic)

 Remove an ImageConsumer from the list of consumers interested in
 data for this image.

 See Also:

 ImageConsumer

startProduction

  public void startProduction(ImageConsumer ic)

 Adds an ImageConsumer to the list of consumers interested in
 data for this image, and immediately start delivery of the
 image data through the ImageConsumer interface.

 See Also:

 ImageConsumer

requestTopDownLeftRightResend

  public void requestTopDownLeftRightResend(ImageConsumer ic)

 Requests that a given ImageConsumer have the image data delivered
 one more time in top-down, left-right order.

 See Also:

 ImageConsumer

setAnimated

  public synchronized void setAnimated(boolean animated)

 Change this memory image into a multi-frame animation or a
 single-frame static image depending on the animated parameter.

This method should be called immediately after the
 MemoryImageSource is constructed and before an image is
 created with it to ensure that all ImageConsumers will
 receive the correct multi-frame data.  If an ImageConsumer
 is added to this ImageProducer before this flag is set then
 that ImageConsumer will see only a snapshot of the pixel
 data that was available when it connected.

 Parameters:

 animated - true if the image is a multi-frame animation

setFullBufferUpdates

  public synchronized void setFullBufferUpdates(boolean fullbuffers)

 Specify whether this animated memory image should always be
 updated by sending the complete buffer of pixels whenever
 there is a change.
 This flag is ignored if the animation flag is not turned on
 through the setAnimated() method.

This method should be called immediately after the
 MemoryImageSource is constructed and before an image is
 created with it to ensure that all ImageConsumers will
 receive the correct pixel delivery hints.

 Parameters:

 fullbuffers - true if the complete pixel buffer should always
 be sent

 See Also:

 setAnimated

newPixels

  public void newPixels()

 Send a whole new buffer of pixels to any ImageConsumers that
 are currently interested in the data for this image and notify
 them that an animation frame is complete.
 This method only has effect if the animation flag has been
 turned on through the setAnimated() method.

 See Also:

 ImageConsumer, setAnimated

newPixels

  public synchronized void newPixels(int x,
                                     int y,
                                     int w,
                                     int h)

 Send a rectangular region of the buffer of pixels to any
 ImageConsumers that are currently interested in the data for
 this image and notify them that an animation frame is complete.
 This method only has effect if the animation flag has been
 turned on through the setAnimated() method.
 If the full buffer update flag was turned on with the
 setFullBufferUpdates() method then the rectangle parameters
 will be ignored and the entire buffer will always be sent.

 Parameters:

 x - the x coordinate of the upper left corner of the rectangle
 of pixels to be sent

 y - the y coordinate of the upper left corner of the rectangle
 of pixels to be sent

 w - the width of the rectangle of pixels to be sent

 h - the height of the rectangle of pixels to be sent

 See Also:

 ImageConsumer, setAnimated, setFullBufferUpdates

newPixels

  public synchronized void newPixels(int x,
                                     int y,
                                     int w,
                                     int h,
                                     boolean framenotify)

 Send a rectangular region of the buffer of pixels to any
 ImageConsumers that are currently interested in the data for
 this image.
 If the framenotify parameter is true then the consumers are
 also notified that an animation frame is complete.
 This method only has effect if the animation flag has been
 turned on through the setAnimated() method.
 If the full buffer update flag was turned on with the
 setFullBufferUpdates() method then the rectangle parameters
 will be ignored and the entire buffer will always be sent.

 Parameters:

 x - the x coordinate of the upper left corner of the rectangle
 of pixels to be sent

 y - the y coordinate of the upper left corner of the rectangle
 of pixels to be sent

 w - the width of the rectangle of pixels to be sent

 h - the height of the rectangle of pixels to be sent

 framenotify - true if the consumers should be sent a
 SINGLEFRAMEDONE notification

 See Also:

 ImageConsumer, setAnimated, setFullBufferUpdates

newPixels

  public synchronized void newPixels(byte newpix[],
                                     ColorModel newmodel,
                                     int offset,
                                     int scansize)

 Change to a new byte array to hold the pixels for this image.
 If the animation flag has been turned on through the setAnimated()
 method, then the new pixels will be immediately delivered to any
 ImageConsumers that are currently interested in the data for
 this image.

 See Also:

 setAnimated

newPixels

  public synchronized void newPixels(int newpix[],
                                     ColorModel newmodel,
                                     int offset,
                                     int scansize)

 Change to a new int array to hold the pixels for this image.
 If the animation flag has been turned on through the setAnimated()
 method, then the new pixels will be immediately delivered to any
 ImageConsumers that are currently interested in the data for
 this image.

 See Also:

 setAnimated

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.image.PixelGrabber

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.image.PixelGrabber

java.lang.Object
   |
   +----java.awt.image.PixelGrabber

______________________________________________________________________________

 public class PixelGrabber

 extends Object

 implements ImageConsumer

The PixelGrabber class implements an ImageConsumer which can be attached  to an Image or ImageProducer object to retrieve a subset of the pixels  in that image. Here is an example:

 public void handlesinglepixel(int x, int y, int pixel) {
        int alpha = (pixel >> 24) & 0xff;
        int red   = (pixel >> 16) & 0xff;
        int green = (pixel >>  8) & 0xff;
        int blue  = (pixel      ) & 0xff;
        // Deal with the pixel as necessary...
 }
 public void handlepixels(Image img, int x, int y, int w, int h) {
        int[] pixels = new int[w * h];
        PixelGrabber pg = new PixelGrabber(img, x, y, w, h, pixels, 0, w);
        try {
            pg.grabPixels();
        } catch (InterruptedException e) {
            System.err.println("interrupted waiting for pixels!");
            return;
        }
        if ((pg.getStatus() & ImageObserver.ABORT) != 0) {
            System.err.println("image fetch aborted or errored");
            return;
        }
        for (int j = 0; j

 See Also:

 getRGBdefault

______________________________________________________________________________

        PixelGrabber(Image, int, int, int, int, boolean)

  Create a PixelGrabber object to grab the (x, y, w, h) rectangular
 section of pixels from the specified image.

        PixelGrabber(Image, int, int, int, int, int[], int, int)

  Create a PixelGrabber object to grab the (x, y, w, h) rectangular
 section of pixels from the specified image into the given array.

        PixelGrabber(ImageProducer, int, int, int, int, int[], int, int)

  Create a PixelGrabber object to grab the (x, y, w, h) rectangular
 section of pixels from the image produced by the specified
 ImageProducer into the given array.

        abortGrabbing()

  Request the PixelGrabber to abort the image fetch.

        getColorModel()

  Get the ColorModel for the pixels stored in the array.

        getHeight()

  Get the height of the pixel buffer (after adjusting for image height).

        getPixels()

  Get the pixel buffer.

        getStatus()

  Return the status of the pixels.

        getWidth()

  Get the width of the pixel buffer (after adjusting for image width).

        grabPixels()

  Request the Image or ImageProducer to start delivering pixels and
 wait for all of the pixels in the rectangle of interest to be
 delivered.

        grabPixels(long)

  Request the Image or ImageProducer to start delivering pixels and
 wait for all of the pixels in the rectangle of interest to be
 delivered or until the specified timeout has elapsed.

        imageComplete(int)

  The imageComplete method is part of the ImageConsumer API which
 this class must implement to retrieve the pixels.

        setColorModel(ColorModel)

  The setColorModel method is part of the ImageConsumer API which
 this class must implement to retrieve the pixels.

        setDimensions(int, int)

  The setDimensions method is part of the ImageConsumer API which
 this class must implement to retrieve the pixels.

        setHints(int)

  The setHints method is part of the ImageConsumer API which
 this class must implement to retrieve the pixels.

        setPixels(int, int, int, int, ColorModel, byte[], int, int)

  The setPixels method is part of the ImageConsumer API which
 this class must implement to retrieve the pixels.

        setPixels(int, int, int, int, ColorModel, int[], int, int)

  The setPixels method is part of the ImageConsumer API which
 this class must implement to retrieve the pixels.

        setProperties(Hashtable)

  The setProperties method is part of the ImageConsumer API which
 this class must implement to retrieve the pixels.

        startGrabbing()

  Request the PixelGrabber to start fetching the pixels.

        status()

  DEPRECATED:  Replaced by getStatus().

PixelGrabber

  public PixelGrabber(Image img,
                      int x,
                      int y,
                      int w,
                      int h,
                      int pix[],
                      int off,
                      int scansize)

 Create a PixelGrabber object to grab the (x, y, w, h) rectangular
 section of pixels from the specified image into the given array.
 The pixels are stored into the array in the default RGB ColorModel.
 The RGB data for pixel (i, j) where (i, j) is inside the rectangle
 (x, y, w, h) is stored in the array at
 pix[(j - y) * scansize + (i - x) + off].

 Parameters:

 img - the image to retrieve pixels from

 x - the x coordinate of the upper left corner of the rectangle
 of pixels to retrieve from the image, relative to the default
 (unscaled) size of the image

 y - the y coordinate of the upper left corner of the rectangle
 of pixels to retrieve from the image

 w - the width of the rectangle of pixels to retrieve

 h - the height of the rectangle of pixels to retrieve

 pix - the array of integers which are to be used to hold the
 RGB pixels retrieved from the image

 off - the offset into the array of where to store the first pixel

 scansize - the distance from one row of pixels to the next in
 the array

 See Also:

 getRGBdefault

PixelGrabber

  public PixelGrabber(ImageProducer ip,
                      int x,
                      int y,
                      int w,
                      int h,
                      int pix[],
                      int off,
                      int scansize)

 Create a PixelGrabber object to grab the (x, y, w, h) rectangular
 section of pixels from the image produced by the specified
 ImageProducer into the given array.
 The pixels are stored into the array in the default RGB ColorModel.
 The RGB data for pixel (i, j) where (i, j) is inside the rectangle
 (x, y, w, h) is stored in the array at
 pix[(j - y) * scansize + (i - x) + off].

 Parameters:

 img - the image to retrieve pixels from

 x - the x coordinate of the upper left corner of the rectangle
 of pixels to retrieve from the image, relative to the default
 (unscaled) size of the image

 y - the y coordinate of the upper left corner of the rectangle
 of pixels to retrieve from the image

 w - the width of the rectangle of pixels to retrieve

 h - the height of the rectangle of pixels to retrieve

 pix - the array of integers which are to be used to hold the
 RGB pixels retrieved from the image

 off - the offset into the array of where to store the first pixel

 scansize - the distance from one row of pixels to the next in
 the array

 See Also:

 getRGBdefault

PixelGrabber

  public PixelGrabber(Image img,
                      int x,
                      int y,
                      int w,
                      int h,
                      boolean forceRGB)

 Create a PixelGrabber object to grab the (x, y, w, h) rectangular
 section of pixels from the specified image.  The pixels are
 accumulated in the original ColorModel if the same ColorModel
 is used for every call to setPixels, otherwise the pixels are
 accumulated in the default RGB ColorModel.  If the forceRGB
 parameter is true, then the pixels will be accumulated in the
 default RGB ColorModel anywya.  A buffer is allocated by the
 PixelGrabber to hold the pixels in either case.  If (w

 Parameters:

 img - the image to retrieve the image data from

 x - the x coordinate of the upper left corner of the rectangle
 of pixels to retrieve from the image, relative to the default
 (unscaled) size of the image

 y - the y coordinate of the upper left corner of the rectangle
 of pixels to retrieve from the image

 w - the width of the rectangle of pixels to retrieve

 h - the height of the rectangle of pixels to retrieve

 forceRGB - true if the pixels should always be converted to
 the default RGB ColorModel

startGrabbing

  public synchronized void startGrabbing()

 Request the PixelGrabber to start fetching the pixels.

abortGrabbing

  public synchronized void abortGrabbing()

 Request the PixelGrabber to abort the image fetch.

grabPixels

  public boolean grabPixels() throws InterruptedException

 Request the Image or ImageProducer to start delivering pixels and
 wait for all of the pixels in the rectangle of interest to be
 delivered.

 Returns:

 true if the pixels were successfully grabbed, false on
 abort, error or timeout

 Throws: InterruptedException

 Another thread has interrupted this thread.

grabPixels

  public synchronized boolean grabPixels(long ms) throws InterruptedException

 Request the Image or ImageProducer to start delivering pixels and
 wait for all of the pixels in the rectangle of interest to be
 delivered or until the specified timeout has elapsed.

 Parameters:

 ms - the number of milliseconds to wait for the image pixels
 to arrive before timing out

 Returns:

 true if the pixels were successfully grabbed, false on
 abort, error or timeout

 Throws: InterruptedException

 Another thread has interrupted this thread.

getStatus

  public synchronized int getStatus()

 Return the status of the pixels.  The ImageObserver flags
 representing the available pixel information are returned.

 Returns:

 the bitwise OR of all relevant ImageObserver flags

 See Also:

 ImageObserver

getWidth

  public synchronized int getWidth()

 Get the width of the pixel buffer (after adjusting for image width).
 If no width was specified for the rectangle of pixels to grab then
 then this information will only be available after the image has
 delivered the dimensions.

 Returns:

 the final width used for the pixel buffer or -1 if the width
 is not yet known

 See Also:

 getStatus

getHeight

  public synchronized int getHeight()

 Get the height of the pixel buffer (after adjusting for image height).
 If no width was specified for the rectangle of pixels to grab then
 then this information will only be available after the image has
 delivered the dimensions.

 Returns:

 the final height used for the pixel buffer or -1 if the height
 is not yet known

 See Also:

 getStatus

getPixels

  public synchronized Object getPixels()

 Get the pixel buffer.  If the PixelGrabber was not constructed
 with an explicit pixel buffer to hold the pixels then this method
 will return null until the size and format of the image data is
 known.
 Since the PixelGrabber may fall back on accumulating the data
 in the default RGB ColorModel at any time if the source image
 uses more than one ColorModel to deliver the data, the array
 object returned by this method may change over time until the
 image grab is complete.

 Returns:

 either a byte array or an int array

 See Also:

 getStatus

getColorModel

  public synchronized ColorModel getColorModel()

 Get the ColorModel for the pixels stored in the array.  If the
 PixelGrabber was constructed with an explicit pixel buffer then
 this method will always return the default RGB ColorModel,
 otherwise it may return null until the ColorModel used by the
 ImageProducer is known.
 Since the PixelGrabber may fall back on accumulating the data
 in the default RGB ColorModel at any time if the source image
 uses more than one ColorModel to deliver the data, the ColorModel
 object returned by this method may change over time until the
 image grab is complete.

 Returns:

 the ColorModel object used for storing the pixels

 See Also:

 getStatus, getRGBdefault

setDimensions

  public void setDimensions(int width,
                            int height)

 The setDimensions method is part of the ImageConsumer API which
 this class must implement to retrieve the pixels.

setHints

  public void setHints(int hints)

 The setHints method is part of the ImageConsumer API which
 this class must implement to retrieve the pixels.

setProperties

  public void setProperties(Hashtable props)

 The setProperties method is part of the ImageConsumer API which
 this class must implement to retrieve the pixels.

setColorModel

  public void setColorModel(ColorModel model)

 The setColorModel method is part of the ImageConsumer API which
 this class must implement to retrieve the pixels.

setPixels

  public void setPixels(int srcX,
                        int srcY,
                        int srcW,
                        int srcH,
                        ColorModel model,
                        byte pixels[],
                        int srcOff,
                        int srcScan)

 The setPixels method is part of the ImageConsumer API which
 this class must implement to retrieve the pixels.

setPixels

  public void setPixels(int srcX,
                        int srcY,
                        int srcW,
                        int srcH,
                        ColorModel model,
                        int pixels[],
                        int srcOff,
                        int srcScan)

 The setPixels method is part of the ImageConsumer API which
 this class must implement to retrieve the pixels.

imageComplete

  public synchronized void imageComplete(int status)

 The imageComplete method is part of the ImageConsumer API which
 this class must implement to retrieve the pixels.

status

  public synchronized int status()

 DEPRECATED:  Replaced by getStatus().

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.image.ReplicateScaleFilter

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.image.ReplicateScaleFilter

java.lang.Object
   |
   +----java.awt.image.ImageFilter
           |
           +----java.awt.image.ReplicateScaleFilter

______________________________________________________________________________

 public class ReplicateScaleFilter

 extends ImageFilter

An ImageFilter class for scaling images using the simplest algorithm.  This class extends the basic ImageFilter Class to scale an existing  image and provide a source for a new image containing the resampled  image. The pixels in the source image are sampled to produce pixels  for an image of the specified size by replicating rows and columns of  pixels to scale up or omitting rows and columns of pixels to scale  down.  It is meant to be used in conjunction with a FilteredImageSource  object to produce scaled versions of existing images.

See Also:

FilteredImageSource, ImageFilter

______________________________________________________________________________

 	destHeight

  	destWidth

  	outpixbuf

  	srccols

  	srcHeight

  	srcrows

  	srcWidth

 	ReplicateScaleFilter(int, int)

 Constructs a ReplicateScaleFilter that scales the pixels from  its source Image as specified by the width and height parameters.

 	setDimensions(int, int)

 Override the dimensions of the source image and pass the dimensions  of the new scaled size to the ImageConsumer.

 	setPixels (int, int, int, int, ColorModel, byte[], int, int)

 Choose which rows and columns of the delivered byte pixels are  needed for the destination scaled image and pass through just  those rows and columns that are needed, replicated as necessary.

 	setPixels (int, int, int, int, ColorModel, int[], int, int)

 Choose which rows and columns of the delivered int pixels are  needed for the destination scaled image and pass through just  those rows and columns that are needed, replicated as necessary.

 	setProperties(Hashtable)

 Passes along the properties from the source object after adding a  property indicating the scale applied.

 srcWidth

  protected int srcWidth

 srcHeight

  protected int srcHeight

 destWidth

  protected int destWidth

 destHeight

  protected int destHeight

 srcrows

  protected int srcrows[]

 srccols

  protected int srccols[]

 outpixbuf

  protected Object outpixbuf

 ReplicateScaleFilter

  public ReplicateScaleFilter(int width,
                              int height)

 Constructs a ReplicateScaleFilter that scales the pixels from  its source Image as specified by the width and height parameters.

Parameters:

 width - the target width to scale the image

 height - the target height to scale the image

 setProperties

  public void setProperties(Hashtable props)

 Passes along the properties from the source object after adding a  property indicating the scale applied.

Overrides:

setProperties in class ImageFilter

 setDimensions

  public void setDimensions(int w,
                            int h)

 Override the dimensions of the source image and pass the dimensions  of the new scaled size to the ImageConsumer.

Overrides:

setDimensions in class ImageFilter

See Also:

ImageConsumer

 setPixels

  public void setPixels(int x,
                        int y,
                        int w,
                        int h,
                        ColorModel model,
                        byte pixels[],
                        int off,
                        int scansize)

 Choose which rows and columns of the delivered byte pixels are  needed for the destination scaled image and pass through just  those rows and columns that are needed, replicated as necessary.

Overrides:

setPixels in class ImageFilter

 setPixels

  public void setPixels(int x,
                        int y,
                        int w,
                        int h,
                        ColorModel model,
                        int pixels[],
                        int off,
                        int scansize)

 Choose which rows and columns of the delivered int pixels are  needed for the destination scaled image and pass through just  those rows and columns that are needed, replicated as necessary.

Overrides:

setPixels in class ImageFilter

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.image.RGBImageFilter

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.image.RGBImageFilter

java.lang.Object
   |
   +----java.awt.image.ImageFilter
           |
           +----java.awt.image.RGBImageFilter

______________________________________________________________________________

 public class RGBImageFilter

 extends ImageFilter

This class provides an easy way to create an ImageFilter which modifies  the pixels of an image in the default RGB ColorModel. It is meant to  be used in conjunction with a FilteredImageSource object to produce  filtered versions of existing images. It is an abstract class that  provides the calls needed to channel all of the pixel data through a  single method which converts pixels one at a time in the default RGB  ColorModel regardless of the ColorModel being used by the ImageProducer.  The only method which needs to be defined to create a useable image  filter is the filterRGB method. Here is an example of a definition  of a filter which swaps the red and blue components of an image:

        class RedBlueSwapFilter extends RGBImageFilter {
            public RedBlueSwapFilter() {
                // The filter's operation does not depend on the
                // pixel's location, so IndexColorModels can be
                // filtered directly.
                canFilterIndexColorModel = true;
            }
            public int filterRGB(int x, int y, int rgb) {
                return ((rgb & 0xff00ff00)
                        | ((rgb & 0xff0000) >> 16)
                        | ((rgb & 0xff)

 See Also:

 FilteredImageSource, ImageFilter, getRGBdefault

______________________________________________________________________________

        canFilterIndexColorModel

  This boolean indicates whether or not it is acceptable to apply
 the color filtering of the filterRGB method to the color table
 entries of an IndexColorModel object in lieu of pixel by pixel
 filtering.

        newmodel

        origmodel

        RGBImageFilter()

        filterIndexColorModel(IndexColorModel)

  Filters an IndexColorModel object by running each entry in its
 color tables through the filterRGB function that RGBImageFilter
 subclasses must provide.

        filterRGB(int, int, int)

  Subclasses must specify a method to convert a single input pixel
 in the default RGB ColorModel to a single output pixel.

        filterRGBPixels(int, int, int, int, int[], int, int)

  Filters a buffer of pixels in the default RGB ColorModel by passing
 them one by one through the filterRGB method.

        setColorModel(ColorModel)

  If the ColorModel is an IndexColorModel, and the subclass has
 set the canFilterIndexColorModel flag to true, we substitute
 a filtered version of the color model here and wherever
 that original ColorModel object appears in the setPixels methods.

        setPixels(int, int, int, int, ColorModel, byte[], int, int)

  If the ColorModel object is the same one that has already
 been converted, then simply passes the pixels through with the
 converted ColorModel.

        setPixels(int, int, int, int, ColorModel, int[], int, int)

  If the ColorModel object is the same one that has already
 been converted, then simply passes the pixels through with the
 converted ColorModel, otherwise converts the buffer of integer
 pixels to the default RGB ColorModel and passes the converted
 buffer to the filterRGBPixels method to be converted one by one.

        substituteColorModel(ColorModel, ColorModel)

  Registers two ColorModel objects for substitution.

origmodel

  protected ColorModel origmodel

newmodel

  protected ColorModel newmodel

canFilterIndexColorModel

  protected boolean canFilterIndexColorModel

 This boolean indicates whether or not it is acceptable to apply
 the color filtering of the filterRGB method to the color table
 entries of an IndexColorModel object in lieu of pixel by pixel
 filtering.  Subclasses should set this variable to true in their
 constructor if their filterRGB method does not depend on the
 coordinate of the pixel being filtered.

 See Also:

 substituteColorModel, filterRGB, IndexColorModel

RGBImageFilter

  public RGBImageFilter()

setColorModel

  public void setColorModel(ColorModel model)

 If the ColorModel is an IndexColorModel, and the subclass has
 set the canFilterIndexColorModel flag to true, we substitute
 a filtered version of the color model here and wherever
 that original ColorModel object appears in the setPixels methods. Otherwise
 overrides the default ColorModel used by the ImageProducer and
 specifies the default RGB ColorModel instead.

 Overrides:

 setColorModel in class ImageFilter

 See Also:

 ImageConsumer, getRGBdefault

substituteColorModel

  public void substituteColorModel(ColorModel oldcm,
                                   ColorModel newcm)

 Registers two ColorModel objects for substitution.  If the oldcm
 is encountered during any of the setPixels methods, the newcm
 is substituted and the pixels passed through
 untouched (but with the new ColorModel object).

 Parameters:

 oldcm - the ColorModel object to be replaced on the fly

 newcm - the ColorModel object to replace oldcm on the fly

filterIndexColorModel

  public IndexColorModel filterIndexColorModel(IndexColorModel icm)

 Filters an IndexColorModel object by running each entry in its
 color tables through the filterRGB function that RGBImageFilter
 subclasses must provide.  Uses coordinates of -1 to indicate that
 a color table entry is being filtered rather than an actual
 pixel value.

 Parameters:

 icm - the IndexColorModel object to be filtered

 Returns:

 a new IndexColorModel representing the filtered colors

filterRGBPixels

  public void filterRGBPixels(int x,
                              int y,
                              int w,
                              int h,
                              int pixels[],
                              int off,
                              int scansize)

 Filters a buffer of pixels in the default RGB ColorModel by passing
 them one by one through the filterRGB method.

 See Also:

 getRGBdefault, filterRGB

setPixels

  public void setPixels(int x,
                        int y,
                        int w,
                        int h,
                        ColorModel model,
                        byte pixels[],
                        int off,
                        int scansize)

 If the ColorModel object is the same one that has already
 been converted, then simply passes the pixels through with the
 converted ColorModel. Otherwise converts the buffer of byte
 pixels to the default RGB ColorModel and passes the converted
 buffer to the filterRGBPixels method to be converted one by one.

 Overrides:

 setPixels in class ImageFilter

 See Also:

 getRGBdefault, filterRGBPixels

setPixels

  public void setPixels(int x,
                        int y,
                        int w,
                        int h,
                        ColorModel model,
                        int pixels[],
                        int off,
                        int scansize)

 If the ColorModel object is the same one that has already
 been converted, then simply passes the pixels through with the
 converted ColorModel, otherwise converts the buffer of integer
 pixels to the default RGB ColorModel and passes the converted
 buffer to the filterRGBPixels method to be converted one by one.
 Converts a buffer of integer pixels to the default RGB ColorModel
 and passes the converted buffer to the filterRGBPixels method.

 Overrides:

 setPixels in class ImageFilter

 See Also:

 getRGBdefault, filterRGBPixels

filterRGB

  public abstract int filterRGB(int x,
                                int y,
                                int rgb)

 Subclasses must specify a method to convert a single input pixel
 in the default RGB ColorModel to a single output pixel.

 See Also:

 getRGBdefault, filterRGBPixels

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Insets

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Insets

java.lang.Object
   |
   +----java.awt.Insets

______________________________________________________________________________

 public class Insets

 extends Object

 implements Cloneable, Serializable

The insets of a container.  This class is used to layout containers.

See Also:

LayoutManager, Container

______________________________________________________________________________

 	bottom

 The inset from the bottom.

 	left

 The inset from the left.

 	right

 The inset from the right.

 	top

 The inset from the top.

 	Insets(int, int, int, int)

 Constructs and initializes a new Inset with the specified top,  left, bottom, and right insets.

 	clone()

 Creates a new object of the same class as this object.

 	equals(Object)

 Checks whether two insets objects are equal.

 	toString()

 Returns a String object representing this Inset's values.

 top

  public int top

 The inset from the top.

 left

  public int left

 The inset from the left.

 bottom

  public int bottom

 The inset from the bottom.

 right

  public int right

 The inset from the right.

 Insets

  public Insets(int top,
                int left,
                int bottom,
                int right)

 Constructs and initializes a new Inset with the specified top,  left, bottom, and right insets.

Parameters:

 top - the inset from the top

 left - the inset from the left

 bottom - the inset from the bottom

 right - the inset from the right

 equals

  public boolean equals(Object obj)

 Checks whether two insets objects are equal.

Overrides:

equals in class Object

 toString

  public String toString()

 Returns a String object representing this Inset's values.

Overrides:

toString in class Object

 clone

  public Object clone()

 Creates a new object of the same class as this object.

Overrides:

clone in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.ItemSelectable

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.ItemSelectable

 public interface ItemSelectable

The interface for objects which contain a set of items for  which zero or more can be selected.

______________________________________________________________________________

 	addItemListener(ItemListener)

 Add a listener to recieve item events when the state of  an item changes.

 	getSelectedObjects()

 Returns the selected items or null if no items are selected.

 	removeItemListener(ItemListener)

 Removes an item listener.

 getSelectedObjects

  public abstract Object[] getSelectedObjects()

 Returns the selected items or null if no items are selected.

 addItemListener

  public abstract void addItemListener(ItemListener l)

 Add a listener to recieve item events when the state of  an item changes.

Parameters:

 l - the listener to recieve events

See Also:

ItemEvent

 removeItemListener

  public abstract void removeItemListener(ItemListener l)

 Removes an item listener.

Parameters:

 l - the listener being removed

See Also:

ItemEvent

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Label

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Label

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Label

______________________________________________________________________________

 public class Label

 extends Component

A component that displays a single line of read-only text.

______________________________________________________________________________

 	CENTER

 The center alignment.

 	LEFT

 The left alignment.

 	RIGHT

 The right alignment.

 	Label()

 Constructs an empty label.

 	Label(String)

 Constructs a new label with the specified String of text.

 	Label(String, int)

 Constructs a new label with the specified String of  text and the specified alignment.

 	addNotify()

 Creates the peer for this label.

 	getAlignment()

 Gets the current alignment of this label.

 	getText()

 Gets the text of this label.

 	paramString()

 Returns the parameter String of this label.

 	setAlignment(int)

 Sets the alignment for this label to the specified  alignment.

 	setText(String)

 Sets the text for this label to the specified text.

 LEFT

  public final static int LEFT

 The left alignment.

 CENTER

  public final static int CENTER

 The center alignment.

 RIGHT

  public final static int RIGHT

 The right alignment.

 Label

  public Label()

 Constructs an empty label.

 Label

  public Label(String text)

 Constructs a new label with the specified String of text.

Parameters:

 text - the text that makes up the label

 Label

  public Label(String text,
               int alignment)

 Constructs a new label with the specified String of  text and the specified alignment.

Parameters:

 text - the String that makes up the label

 alignment - the alignment value

 addNotify

  public void addNotify()

 Creates the peer for this label. The peer allows us to  modify the appearance of the label without changing its  functionality.

Overrides:

addNotify in class Component

 getAlignment

  public int getAlignment()

 Gets the current alignment of this label.

See Also:

setAlignment

 setAlignment

  public synchronized void setAlignment(int alignment)

 Sets the alignment for this label to the specified  alignment.

Parameters:

 alignment - the alignment value

Throws: IllegalArgumentException

 If an improper alignment was given.

See Also:

getAlignment

 getText

  public String getText()

 Gets the text of this label.

See Also:

setText

 setText

  public synchronized void setText(String text)

 Sets the text for this label to the specified text.

Parameters:

 text - the text that makes up the label

See Also:

getText

 paramString

  protected String paramString()

 Returns the parameter String of this label.

Overrides:

paramString in class Component

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.LayoutManager

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.LayoutManager

 public interface LayoutManager

Defines the interface for classes that know how to layout Containers.

See Also:

Container

______________________________________________________________________________

 	addLayoutComponent(String, Component)

 Adds the specified component with the specified name to  the layout.

 	layoutContainer(Container)

 Lays out the container in the specified panel.

 	minimumLayoutSize(Container)

 Calculates the minimum size dimensions for the specified  panel given the components in the specified parent container.

 	preferredLayoutSize(Container)

 Calculates the preferred size dimensions for the specified  panel given the components in the specified parent container.

 	removeLayoutComponent(Component)

 Removes the specified component from the layout.

 addLayoutComponent

  public abstract void addLayoutComponent(String name,
                                          Component comp)

 Adds the specified component with the specified name to  the layout.

Parameters:

 name - the component name

 comp - the component to be added

 removeLayoutComponent

  public abstract void removeLayoutComponent(Component comp)

 Removes the specified component from the layout.

Parameters:

 comp - the component ot be removed

 preferredLayoutSize

  public abstract Dimension preferredLayoutSize(Container parent)

 Calculates the preferred size dimensions for the specified  panel given the components in the specified parent container.

Parameters:

 parent - the component to be laid out

See Also:

minimumLayoutSize

 minimumLayoutSize

  public abstract Dimension minimumLayoutSize(Container parent)

 Calculates the minimum size dimensions for the specified  panel given the components in the specified parent container.

Parameters:

 parent - the component to be laid out

See Also:

preferredLayoutSize

 layoutContainer

  public abstract void layoutContainer(Container parent)

 Lays out the container in the specified panel.

Parameters:

 parent - the component which needs to be laid out

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.LayoutManager2

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.LayoutManager2

 public interface LayoutManager2

 extends LayoutManager

Defines an interface for classes that know how to layout Containers  based on a layout constraints object.  This interface extends the LayoutManager interface to deal with layouts  explicitly in terms of constraint objects that specify how and where  components should be added to the layout.

 This minimal extension to LayoutManager is intended for tool  providers who wish to the creation of constraint-based layouts.  It does not yet provide full, general support for custom  constraint-based layout managers.

See Also:

LayoutManager, Container

______________________________________________________________________________

 	addLayoutComponent(Component, Object)

 Adds the specified component to the layout, using the specified  constraint object.

 	getLayoutAlignmentX(Container)

 Returns the alignment along the x axis.

 	getLayoutAlignmentY(Container)

 Returns the alignment along the y axis.

 	invalidateLayout(Container)

 Invalidates the layout, indicating that if the layout manager  has cached information it should be discarded.

 	maximumLayoutSize(Container)

 Returns the maximum size of this component.

 addLayoutComponent

  public abstract void addLayoutComponent(Component comp,
                                          Object constraints)

 Adds the specified component to the layout, using the specified  constraint object.

Parameters:

 comp - the component to be added

 constraints - where/how the component is added to the layout.

 maximumLayoutSize

  public abstract Dimension maximumLayoutSize(Container target)

 Returns the maximum size of this component.

See Also:

getMinimumSize, getPreferredSize, LayoutManager

 getLayoutAlignmentX

  public abstract float getLayoutAlignmentX(Container target)

 Returns the alignment along the x axis. This specifies how  the component would like to be aligned relative to other  components. The value should be a number between 0 and 1  where 0 represents alignment along the origin, 1 is aligned  the furthest away from the origin, 0.5 is centered, etc.

 getLayoutAlignmentY

  public abstract float getLayoutAlignmentY(Container target)

 Returns the alignment along the y axis. This specifies how  the component would like to be aligned relative to other  components. The value should be a number between 0 and 1  where 0 represents alignment along the origin, 1 is aligned  the furthest away from the origin, 0.5 is centered, etc.

 invalidateLayout

  public abstract void invalidateLayout(Container target)

 Invalidates the layout, indicating that if the layout manager  has cached information it should be discarded.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.List

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.List

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.List

______________________________________________________________________________

 public class List

 extends Component

 implements ItemSelectable

A scrolling list of text items.

______________________________________________________________________________

 	List()

 Creates a new scrolling list initialized with no visible Lines  or multiple selections.

 	List(int)

 Creates a new scrolling list initialized with the specified  number of visible lines and a boolean stating whether multiple  selections are allowed or not.

 	List(int, boolean)

 Creates a new scrolling list initialized with the specified  number of visible lines and a boolean stating whether multiple  selections are allowed or not.

 	add(String)

 Adds the specified item to the end of scrolling list.

 	add(String, int)

 Adds the specified item to the scrolling list at the specified  position.

 	addActionListener(ActionListener)

 Adds the specified action listener to receive action events  from this list.

 	addItem(String)

 Adds the specified item to the end of scrolling list.

 	addItem(String, int)

 Adds the specified item to the scrolling list at the specified  position.

 	addItemListener(ItemListener)

 Adds the specified item listener to recieve item events from  this list.

 	addNotify()

 Creates the peer for the list.

 	allowsMultipleSelections()

Deprecated.

 	clear()

Deprecated.

 	countItems()

Deprecated.

 	delItem(int)

 Removes an item from the list.

 	delItems(int, int)

Deprecated.

 	deselect(int)

 Deselects the item at the specified index.

 	getItem(int)

 Gets the item associated with the specified index.

 	getItemCount()

 Returns the number of items in the list.

 	getItems()

 Returns the items in the list.

 	getMinimumSize()

 Returns the minimum dimensions needed for the list.

 	getMinimumSize(int)

 Returns the minimum dimensions needed for the amount of rows in the  list.

 	getPreferredSize()

 Returns the preferred dimensions needed for the list.

 	getPreferredSize(int)

 Returns the preferred dimensions needed for the list with the specified  amount of rows.

 	getRows()

 Returns the number of visible lines in this list.

 	getSelectedIndex()

 Get the selected item on the list or -1 if no item is selected.

 	getSelectedIndexes()

 Returns the selected indexes on the list.

 	getSelectedItem()

 Returns the selected item on the list or null if no item is selected.

 	getSelectedItems()

 Returns the selected items on the list in an array of Strings.

 	getSelectedObjects()

 Returns the selected items on the list in an array of Objects.

 	getVisibleIndex()

 Gets the index of the item that was last made visible by the method  makeVisible.

 	isIndexSelected(int)

 Returns true if the item at the specified index has been selected;  false otherwise.

 	isMultipleMode()

 Returns true if this list allows multiple selections.

 	isSelected(int)

Deprecated.

 	makeVisible(int)

 Forces the item at the specified index to be visible.

 	minimumSize()

Deprecated.

 	minimumSize(int)

Deprecated.

 	paramString()

 Returns the parameter String of this list.

 	preferredSize()

Deprecated.

 	preferredSize(int)

Deprecated.

 	processActionEvent(ActionEvent)

 Processes action events occurring on this component by  dispatching them to any registered ActionListener objects.

 	processEvent(AWTEvent)

 Processes events on this list.

 	processItemEvent(ItemEvent)

 Processes item events occurring on this list by  dispatching them to any registered ItemListener objects.

 	remove(int)

 Removes an item from the list.

 	remove(String)

 Remove the first occurrence of item from the list.

 	removeActionListener(ActionListener)

 Removes the specified action listener so it no longer receives  action events from this list.

 	removeAll()

 Removes all items from the list.

 	removeItemListener(ItemListener)

 Removes the specified item listener so it no longer receives  item events from this list.

 	removeNotify()

 Removes the peer for this list.

 	replaceItem(String, int)

 Replaces the item at the given index.

 	select(int)

 Selects the item at the specified index.

 	setMultipleMode(boolean)

 Sets whether this list should allow multiple selections or not.

 	setMultipleSelections(boolean)

Deprecated.

 List

  public List()

 Creates a new scrolling list initialized with no visible Lines  or multiple selections.

 List

  public List(int rows)

 Creates a new scrolling list initialized with the specified  number of visible lines and a boolean stating whether multiple  selections are allowed or not.

Parameters:

 rows - the number of items to show.

 multipleMode - if true then multiple selections are allowed.

 List

  public List(int rows,
              boolean multipleMode)

 Creates a new scrolling list initialized with the specified  number of visible lines and a boolean stating whether multiple  selections are allowed or not.

Parameters:

 rows - the number of items to show.

 multipleMode - if true then multiple selections are allowed.

 addNotify

  public void addNotify()

 Creates the peer for the list. The peer allows us to modify the  list's appearance without changing its functionality.

Overrides:

addNotify in class Component

 removeNotify

  public void removeNotify()

 Removes the peer for this list. The peer allows us to modify the  list's appearance without changing its functionality.

Overrides:

removeNotify in class Component

 getItemCount

  public int getItemCount()

 Returns the number of items in the list.

See Also:

getItem

 countItems

  public int countItems()

 Note: countItems() is deprecated. As of JDK version 1.1,  replaced by getItemCount().

 getItem

  public String getItem(int index)

 Gets the item associated with the specified index.

Parameters:

 index - the position of the item

See Also:

getItemCount

 getItems

  public synchronized String[] getItems()

 Returns the items in the list.

See Also:

select, deselect, isIndexSelected

 add

  public void add(String item)

 Adds the specified item to the end of scrolling list.

Parameters:

 item - the item to be added

 addItem

  public void addItem(String item)

 Adds the specified item to the end of scrolling list.

Parameters:

 item - the item to be added

 add

  public synchronized void add(String item,
                               int index)

 Adds the specified item to the scrolling list at the specified  position.

Parameters:

 item - the item to be added

 index - the position at which to put in the item. The  index is zero-based. If index is -1 then the item is added to  the end. If index is greater than the number of items in the  list, the item gets added at the end.

 addItem

  public synchronized void addItem(String item,
                                   int index)

 Adds the specified item to the scrolling list at the specified  position.

Parameters:

 item - the item to be added

 index - the position at which to put in the item. The  index is zero-based. If index is -1 then the item is added to  the end. If index is greater than the number of items in the  list, the item gets added at the end.

 replaceItem

  public synchronized void replaceItem(String newValue,
                                       int index)

 Replaces the item at the given index.

Parameters:

 newValue - the new value to replace the existing item

 index - the position of the item to replace

 removeAll

  public synchronized void removeAll()

 Removes all items from the list.

See Also:

remove, delItems

 clear

  public synchronized void clear()

 Note: clear() is deprecated. As of JDK version 1.1,  replaced by removeAll().

 remove

  public synchronized void remove(String item)

 Remove the first occurrence of item from the list.

Parameters:

 item - the item to remove from the list

Throws: IllegalArgumentException

 If the item doesn't exist in the list.

 remove

  public synchronized void remove(int position)

 Removes an item from the list.

 delItem

  public synchronized void delItem(int position)

 Removes an item from the list.

 getSelectedIndex

  public synchronized int getSelectedIndex()

 Get the selected item on the list or -1 if no item is selected.

See Also:

select, deselect, isIndexSelected

 getSelectedIndexes

  public synchronized int[] getSelectedIndexes()

 Returns the selected indexes on the list.

See Also:

select, deselect, isIndexSelected

 getSelectedItem

  public synchronized String getSelectedItem()

 Returns the selected item on the list or null if no item is selected.

See Also:

select, deselect, isIndexSelected

 getSelectedItems

  public synchronized String[] getSelectedItems()

 Returns the selected items on the list in an array of Strings.

See Also:

select, deselect, isIndexSelected

 getSelectedObjects

  public Object[] getSelectedObjects()

 Returns the selected items on the list in an array of Objects.

See Also:

ItemSelectable

 select

  public synchronized void select(int index)

 Selects the item at the specified index.

Parameters:

 index - the position of the item to select

See Also:

getSelectedItem, deselect, isIndexSelected

 deselect

  public synchronized void deselect(int index)

 Deselects the item at the specified index.

Parameters:

 index - the position of the item to deselect

See Also:

select, getSelectedItem, isIndexSelected

 isIndexSelected

  public boolean isIndexSelected(int index)

 Returns true if the item at the specified index has been selected;  false otherwise.

Parameters:

 index - the item to be checked

See Also:

select, deselect

 isSelected

  public boolean isSelected(int index)

 Note: isSelected() is deprecated. As of JDK version 1.1,  replaced by isIndexSelected(int).

 getRows

  public int getRows()

 Returns the number of visible lines in this list.

 isMultipleMode

  public boolean isMultipleMode()

 Returns true if this list allows multiple selections.

See Also:

setMultipleMode

 allowsMultipleSelections

  public boolean allowsMultipleSelections()

 Note: allowsMultipleSelections() is deprecated. As of JDK version 1.1,  replaced by isMultipleMode().

 setMultipleMode

  public synchronized void setMultipleMode(boolean b)

 Sets whether this list should allow multiple selections or not.

Parameters:

 v - the boolean to allow multiple selections

See Also:

isMultipleMode

 setMultipleSelections

  public synchronized void setMultipleSelections(boolean b)

 Note: setMultipleSelections() is deprecated. As of JDK version 1.1,  replaced by setMultipleMode(boolean).

 getVisibleIndex

  public int getVisibleIndex()

 Gets the index of the item that was last made visible by the method  makeVisible.

 makeVisible

  public synchronized void makeVisible(int index)

 Forces the item at the specified index to be visible.

Parameters:

 index - the position of the item

See Also:

getVisibleIndex

 getPreferredSize

  public Dimension getPreferredSize(int rows)

 Returns the preferred dimensions needed for the list with the specified   amount of rows.

Parameters:

 rows - amount of rows in list.

 preferredSize

  public Dimension preferredSize(int rows)

 Note: preferredSize() is deprecated. As of JDK version 1.1,  replaced by getPreferredSize(int).

 getPreferredSize

  public Dimension getPreferredSize()

 Returns the preferred dimensions needed for the list.

Returns:

 the preferred size with the specified number of rows if the  row size is greater than 0.

Overrides:

getPreferredSize in class Component

 preferredSize

  public Dimension preferredSize()

 Note: preferredSize() is deprecated. As of JDK version 1.1,  replaced by getPreferredSize().

Overrides:

preferredSize in class Component

 getMinimumSize

  public Dimension getMinimumSize(int rows)

 Returns the minimum dimensions needed for the amount of rows in the  list.

Parameters:

 rows - minimum amount of rows in the list

 minimumSize

  public Dimension minimumSize(int rows)

 Note: minimumSize() is deprecated. As of JDK version 1.1,  replaced by getMinimumSize(int).

 getMinimumSize

  public Dimension getMinimumSize()

 Returns the minimum dimensions needed for the list.

Returns:

 the preferred size with the specified number of rows if  the row size is greater than zero.

Overrides:

getMinimumSize in class Component

 minimumSize

  public Dimension minimumSize()

 Note: minimumSize() is deprecated. As of JDK version 1.1,  replaced by getMinimumSize().

Overrides:

minimumSize in class Component

 addItemListener

  public void addItemListener(ItemListener l)

 Adds the specified item listener to recieve item events from  this list.

Parameters:

 l - the item listener

 removeItemListener

  public void removeItemListener(ItemListener l)

 Removes the specified item listener so it no longer receives  item events from this list.

Parameters:

 l - the item listener

 addActionListener

  public void addActionListener(ActionListener l)

 Adds the specified action listener to receive action events  from this list. Action events occur when a list item is  double-clicked.

Parameters:

 l - the action listener

 removeActionListener

  public void removeActionListener(ActionListener l)

 Removes the specified action listener so it no longer receives  action events from this list.

Parameters:

 l - the action listener

 processEvent

  protected void processEvent(AWTEvent e)

 Processes events on this list. If the event is an ItemEvent,  it invokes the processItemEvent method, else if the event is an  ActionEvent, it invokes the processActionEvent method, else it  invokes the superclass's processEvent.

Parameters:

 e - the event

Overrides:

processEvent in class Component

 processItemEvent

  protected void processItemEvent(ItemEvent e)

 Processes item events occurring on this list by  dispatching them to any registered ItemListener objects.  NOTE: This method will not be called unless item events  are enabled for this component; this happens when one of the  following occurs:  a) An ItemListener object is registered via addItemListener()  b) Item events are enabled via enableEvents()

Parameters:

 e - the item event

See Also:

enableEvents

 processActionEvent

  protected void processActionEvent(ActionEvent e)

 Processes action events occurring on this component by  dispatching them to any registered ActionListener objects.  NOTE: This method will not be called unless action events  are enabled for this component; this happens when one of the  following occurs:  a) An ActionListener object is registered via addActionListener()  b) Action events are enabled via enableEvents()

Parameters:

 e - the action event

See Also:

enableEvents

 paramString

  protected String paramString()

 Returns the parameter String of this list.

Overrides:

paramString in class Component

 delItems

  public synchronized void delItems(int start,
                                    int end)

 Note: delItems() is deprecated. As of JDK version 1.1,  Not for public use in the future.  This method is expected to be retained only as a package  private method.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.MediaTracker

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.MediaTracker

java.lang.Object
   |
   +----java.awt.MediaTracker

______________________________________________________________________________

 public class MediaTracker

 extends Object

 implements Serializable

A utility class to track the status of a number of media objects.  Media objects could include images as well as audio clips, though  currently only images are supported. To use it, simply create an  instance and then call addImage() for each image to be tracked.  Each image can be assigned a unique ID for indentification purposes.  The IDs control the priority order in which the images are fetched  as well as identifying unique subsets of the images that can be  waited on independently. Here is an example:

 import java.applet.Applet;
 import java.awt.Color;
 import java.awt.Image;
 import java.awt.Graphics;
 import java.awt.MediaTracker;
 public class ImageBlaster extends Applet implements Runnable {
        MediaTracker tracker;
        Image bg;
        Image anim[] = new Image[5];
        int index;
        Thread animator;
        // Get the images for the background (id == 0) and the animation
        // frames (id == 1) and add them to the MediaTracker
        public void init() {
            tracker = new MediaTracker(this);
            bg = getImage(getDocumentBase(), "images/background.gif");
            tracker.addImage(bg, 0);
            for (int i = 0; i = anim.length) {
                        index = 0;
                    }
                }
                repaint();
            }
        }
        // The background image fills our frame so we don't need to clear
        // the applet on repaints, just call the paint method.
        public void update(Graphics g) {
            paint(g);
        }
        // Paint a large red rectangle if there are any errors loading the
        // images.  Otherwise always paint the background so that it appears
        // incrementally as it is loading.  Finally, only paint the current
        // animation frame if all of the frames (id == 1) are done loading
        // so that we don't get partial animations.
        public void paint(Graphics g) {
            if ((tracker.statusAll(false) & MediaTracker.ERRORED) != 0) {
                g.setColor(Color.red);
                g.fillRect(0, 0, size().width, size().height);
                return;
            }
            g.drawImage(bg, 0, 0, this);
            if (tracker.statusID(1, false) == MediaTracker.COMPLETE) {
                g.drawImage(anim[index], 10, 10, this);
            }
        }
 }

______________________________________________________________________________

 	ABORTED

 Flag indicating the download of some media was aborted.

 	COMPLETE

 Flag indicating the download of media completed successfully.

 	ERRORED

 Flag indicating the download of some media encountered an error.

 	LOADING

 Flag indicating some media is currently being loaded.

 	MediaTracker(Component)

 Creates a Media tracker to track images for a given Component.

 	addImage(Image, int)

 Adds an image to the list of images being tracked.

 	addImage(Image, int, int, int)

 Adds a scaled image to the list of images being tracked.

 	checkAll()

 Checks to see if all images have finished loading but does not start  loading the images if they are not already loading.

 	checkAll(boolean)

 Checks to see if all images have finished loading.

 	checkID(int)

 Checks to see if all images tagged with the indicated ID have  finished loading, but does not start loading the images if they  are not already loading.

 	checkID(int, boolean)

 Checks to see if all images tagged with the indicated ID have  finished loading.

 	getErrorsAny()

 Returns a list of all media that have encountered an error.

 	getErrorsID(int)

 Returns a list of media with the specified ID that have encountered  an error.

 	isErrorAny()

 Checks the error status of all of the images.

 	isErrorID(int)

 Checks the error status of all of the images with the specified ID.

 	removeImage(Image)

 Remove the specified Image from this MediaTracker.

 	removeImage(Image, int)

 Remove the specified Image from the specified ID of this MediaTracker.

 	removeImage(Image, int, int, int)

 Remove the specified image with the specified size and ID from  this MediaTracker.

 	statusAll(boolean)

 Returns the boolean OR of the status of all of the media being  tracked.

 	statusID(int, boolean)

 Returns the boolean OR of the status of all of the media with  a given ID.

 	waitForAll()

 Starts loading all images.

 	waitForAll(long)

 Starts loading all images.

 	waitForID(int)

 Starts loading all images with the specified ID and waits until they  have finished loading or receive an error.

 	waitForID(int, long)

 Starts loading all images with the specified ID.

 LOADING

  public final static int LOADING

 Flag indicating some media is currently being loaded.

See Also:

statusAll, statusID

 ABORTED

  public final static int ABORTED

 Flag indicating the download of some media was aborted.

See Also:

statusAll, statusID

 ERRORED

  public final static int ERRORED

 Flag indicating the download of some media encountered an error.

See Also:

statusAll, statusID

 COMPLETE

  public final static int COMPLETE

 Flag indicating the download of media completed successfully.

See Also:

statusAll, statusID

 MediaTracker

  public MediaTracker(Component comp)

 Creates a Media tracker to track images for a given Component.

Parameters:

 comp - the component on which the images will eventually be drawn

 addImage

  public void addImage(Image image,
                       int id)

 Adds an image to the list of images being tracked. The image  will eventually be rendered at its default (unscaled) size.

Parameters:

 image - the image to be tracked

 id - the identifier used to later track this image

 addImage

  public synchronized void addImage(Image image,
                                    int id,
                                    int w,
                                    int h)

 Adds a scaled image to the list of images being tracked. The  image will eventually be rendered at the indicated size.

Parameters:

 image - the image to be tracked

 id - the identifier used to later track this image

 w - the width that the image will be rendered at

 h - the height that the image will be rendered at

 checkAll

  public boolean checkAll()

 Checks to see if all images have finished loading but does not start  loading the images if they are not already loading.  If there is an error while loading or scaling an image then that  image is considered "complete."  Use isErrorAny() or isErrorID() to check for errors.

Returns:

 true if all images have finished loading, were aborted or  encountered an error

See Also:

checkAll, checkID, isErrorAny, isErrorID

 checkAll

  public synchronized boolean checkAll(boolean load)

 Checks to see if all images have finished loading. If load is  true, starts loading any images that are not yet being loaded.  If there is an error while loading or scaling an image then  that image is considered "complete." Use isErrorAny() or  isErrorID() to check for errors.

Parameters:

 load - start loading the images if this parameter is true

Returns:

 true if all images have finished loading, were aborted or  encountered an error

See Also:

isErrorAny, isErrorID, checkID, checkAll

 isErrorAny

  public synchronized boolean isErrorAny()

 Checks the error status of all of the images.

Returns:

 true if any of the images had an error during loading

See Also:

isErrorID, getErrorsAny

 getErrorsAny

  public synchronized Object[] getErrorsAny()

 Returns a list of all media that have encountered an error.

Returns:

 an array of media objects or null if there are no errors

See Also:

isErrorAny, getErrorsID

 waitForAll

  public void waitForAll() throws InterruptedException

 Starts loading all images. Waits until they have finished loading,  are aborted, or it receives an error.  If there is an error while loading or scaling an image then that  image is considered "complete."  Use isErrorAny() or statusAll() to check for errors.

Throws: InterruptedException

 Another thread has interrupted this thread.

See Also:

waitForID, waitForAll, isErrorAny, isErrorID

 waitForAll

  public synchronized boolean waitForAll(long ms) throws InterruptedException

 Starts loading all images. Waits until they have finished loading,  are aborted, it receives an error, or until the specified timeout has  elapsed.  If there is an error while loading or scaling an image then that  image is considered "complete."  Use isErrorAny() or statusAll() to check for errors.

Parameters:

 ms - the length of time to wait for the loading to complete

Returns:

 true if all images were successfully loaded

Throws: InterruptedException

 Another thread has interrupted this thread.

See Also:

waitForID, waitForAll, isErrorAny, isErrorID

 statusAll

  public synchronized int statusAll(boolean load)

 Returns the boolean OR of the status of all of the media being  tracked.

Parameters:

 load - specifies whether to start the media loading

See Also:

statusID, LOADING, ABORTED, ERRORED, COMPLETE

 checkID

  public boolean checkID(int id)

 Checks to see if all images tagged with the indicated ID have  finished loading, but does not start loading the images if they  are not already loading.  If there is an error while loading or scaling an image then that  image is considered "complete."  Use isErrorAny() or isErrorID() to check for errors.

Parameters:

 id - the identifier used to determine which images to check

Returns:

 true if all tagged images have finished loading, were  aborted, or an error occurred.

See Also:

checkID, checkAll, isErrorAny, isErrorID

 checkID

  public synchronized boolean checkID(int id,
                                      boolean load)

 Checks to see if all images tagged with the indicated ID have  finished loading. If load is true, starts loading any images  with that ID that are not yet being loaded. If there is an  error while loading or scaling an image then that image is  considered "complete." Use isErrorAny() or isErrorID() to  check for errors.

Parameters:

 id - the identifier used to determine which images to check

 load - start loading the images if this parameter is true

Returns:

 true if all tagged images have finished loading, were  aborted, or an error occurred

See Also:

checkID, checkAll, isErrorAny, isErrorID

 isErrorID

  public synchronized boolean isErrorID(int id)

 Checks the error status of all of the images with the specified ID.

Parameters:

 id - the identifier used to determine which images to check

Returns:

 true if any of the tagged images had an error during loading

See Also:

isErrorAny, getErrorsID

 getErrorsID

  public synchronized Object[] getErrorsID(int id)

 Returns a list of media with the specified ID that have encountered  an error.

Parameters:

 id - the identifier used to determine which images to return

Returns:

 an array of media objects or null if there are no errors

See Also:

isErrorID, getErrorsAny

 waitForID

  public void waitForID(int id) throws InterruptedException

 Starts loading all images with the specified ID and waits until they  have finished loading or receive an error.  If there is an error while loading or scaling an image then that  image is considered "complete."  Use statusID() or isErrorID() to check for errors.

Parameters:

 id - the identifier used to determine which images to wait for

Throws: InterruptedException

 Another thread has interrupted this thread.

See Also:

waitForAll, waitForID, isErrorAny, isErrorID

 waitForID

  public synchronized boolean waitForID(int id,
                                        long ms) throws InterruptedException

 Starts loading all images with the specified ID. Waits until they  have finished loading, an error occurs, or the specified  timeout has elapsed.  If there is an error while loading or scaling an image then that  image is considered "complete."  Use statusID or isErrorID to check for errors.

Parameters:

 id - the identifier used to determine which images to wait for

 ms - the length of time to wait for the loading to complete

Throws: InterruptedException

 Another thread has interrupted this thread.

See Also:

waitForAll, waitForID, isErrorAny, isErrorID

 statusID

  public synchronized int statusID(int id,
                                   boolean load)

 Returns the boolean OR of the status of all of the media with  a given ID.

Parameters:

 id - the identifier used to determine which images to check

 load - specifies whether to start the media loading

See Also:

statusAll, LOADING, ABORTED, ERRORED, COMPLETE

 removeImage

  public synchronized void removeImage(Image image)

 Remove the specified Image from this MediaTracker.  All instances of the image are removed regardless of scale or ID.

Parameters:

 image - the image to be removed

See Also:

removeImage, removeImage

 removeImage

  public synchronized void removeImage(Image image,
                                       int id)

 Remove the specified Image from the specified ID of this MediaTracker.  All instances of the image being tracked under the given ID are  removed regardless of scale.

Parameters:

 image - the image to be removed

 id - the tracking ID to remove the image from

See Also:

removeImage, removeImage

 removeImage

  public synchronized void removeImage(Image image,
                                       int id,
                                       int width,
                                       int height)

 Remove the specified image with the specified size and ID from  this MediaTracker.  Only the specific instance (with any duplicates) is removed.

Parameters:

 image - the image to be removed

 id - the tracking ID to remove the image from

 width - the width to remove (-1 for unscaled)

 height - the height to remove (-1 for unscaled)

See Also:

removeImage, removeImage

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Menu

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Menu

java.lang.Object
   |
   +----java.awt.MenuComponent
           |
           +----java.awt.MenuItem
                   |
                   +----java.awt.Menu

______________________________________________________________________________

 public class Menu

 extends MenuItem

 implements MenuContainer

A Menu that is a component of a menu bar.

______________________________________________________________________________

 	Menu()

 Constructs a new Menu with an empty label.

 	Menu(String)

 Constructs a new Menu with the specified label.

 	Menu(String, boolean)

 Constructs a new Menu with the specified label.

 	add(MenuItem)

 Adds the specified item to this menu.

 	add(String)

 Adds an item with with the specified label to this menu.

 	addNotify()

 Creates the menu's peer.

 	addSeparator()

 Adds a separator line, or a hypen, to the menu at the current position.

 	countItems()

Deprecated.

 	getItem(int)

 Returns the item located at the specified index of this menu.

 	getItemCount()

 Returns the number of elements in this menu.

 	insert(MenuItem, int)

 Inserts the MenuItem to this menu at the specified position.

 	insert(String, int)

 Inserts an item with the specified label to this menu  at the specified position.

 	insertSeparator(int)

 Inserts a separator at the specified position

 	isTearOff()

 Returns true if this is a tear-off menu.

 	paramString()

 Returns the String parameter of the menu.

 	remove(int)

 Deletes the item from this menu at the specified index.

 	remove(MenuComponent)

 Deletes the specified item from this menu.

 	removeAll()

 Deletes all items from this menu.

 	removeNotify()

 Removes the menu's peer.

 Menu

  public Menu()

 Constructs a new Menu with an empty label. This menu can  not be torn off - the menu will still appear on screen after  the the mouse button has been released.

 Menu

  public Menu(String label)

 Constructs a new Menu with the specified label. This menu can  not be torn off - the menu will still appear on screen after  the the mouse button has been released.

Parameters:

 label - the label to be added to this menu

 Menu

  public Menu(String label,
              boolean tearOff)

 Constructs a new Menu with the specified label. If tearOff is  true, the menu can be torn off - the menu will still appear on  screen after the the mouse button has been released.  NOTE: tear-off functionality may not be supported by all AWT  implementations. If a particular implementation doesn't support  tear-offs, this value will be silently ignored.

Parameters:

 label - the label to be added to this menu

 tearOff - the boolean indicating whether or not the menu will be  able to be torn off.

 addNotify

  public void addNotify()

 Creates the menu's peer. The peer allows us to modify the  appearance of the menu without changing its functionality.

Overrides:

addNotify in class MenuItem

 removeNotify

  public void removeNotify()

 Removes the menu's peer. The peer allows us to modify the appearance  of the menu without changing its functionality.

Overrides:

removeNotify in class MenuComponent

 isTearOff

  public boolean isTearOff()

 Returns true if this is a tear-off menu.  NOTE: tear-off functionality may not be supported by all AWT  implementations. If a particular implementation doesn't support  tear-offs, this value will be silently ignored.

 getItemCount

  public int getItemCount()

 Returns the number of elements in this menu.

 countItems

  public int countItems()

 Note: countItems() is deprecated. As of JDK version 1.1,  replaced by getItemCount().

 getItem

  public MenuItem getItem(int index)

 Returns the item located at the specified index of this menu.

Parameters:

 index - the position of the item to be returned

 add

  public synchronized MenuItem add(MenuItem mi)

 Adds the specified item to this menu.

Parameters:

 mi - the item to be added

 add

  public void add(String label)

 Adds an item with with the specified label to this menu.

Parameters:

 label - the text on the item

 insert

  public synchronized void insert(MenuItem menuitem,
                                  int index)

 Inserts the MenuItem to this menu at the specified position.

Parameters:

 menuitem - the menu item to be inserted

 index - the position at which the menu item should be inserted

Throws: IllegalArgumentException

 if index is less than 0.

 insert

  public void insert(String label,
                     int index)

 Inserts an item with the specified label to this menu  at the specified position.

Parameters:

 label - the text on the item

 index - the position at which the menu item should be inserted

 addSeparator

  public void addSeparator()

 Adds a separator line, or a hypen, to the menu at the current position.

 insertSeparator

  public void insertSeparator(int index)

 Inserts a separator at the specified position

Parameters:

 index - the position at which the menu separator should be inserted

Throws: IllegalArgumentException

 if index is less than 0.

 remove

  public synchronized void remove(int index)

 Deletes the item from this menu at the specified index.

Parameters:

 index - the position of the item to be removed

 remove

  public synchronized void remove(MenuComponent item)

 Deletes the specified item from this menu.

Parameters:

 item - the item to be removed from the menu

 removeAll

  public synchronized void removeAll()

 Deletes all items from this menu.

 paramString

  public String paramString()

 Returns the String parameter of the menu.

Overrides:

paramString in class MenuItem

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.MenuBar

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.MenuBar

java.lang.Object
   |
   +----java.awt.MenuComponent
           |
           +----java.awt.MenuBar

______________________________________________________________________________

 public class MenuBar

 extends MenuComponent

 implements MenuContainer

A class that encapsulates the platform's concept of a menu bar bound  to a Frame. In order to associate the MenuBar with an actual Frame,  the Frame.setMenuBar() method should be called.

See Also:

setMenuBar

______________________________________________________________________________

 	MenuBar()

 Creates a new menu bar.

 	add(Menu)

 Adds the specified menu to the menu bar.

 	addNotify()

 Creates the menu bar's peer.

 	countMenus()

Deprecated.

 	deleteShortcut(MenuShortcut)

 Delete the specified MenuShortcut.

 	getHelpMenu()

 Gets the help menu on the menu bar.

 	getMenu(int)

 Gets the specified menu.

 	getMenuCount()

 Counts the number of menus on the menu bar.

 	getShortcutMenuItem(MenuShortcut)

 Return the MenuItem associated with a MenuShortcut,  or null if none has been specified.

 	remove(int)

 Removes the menu located at the specified index from the menu bar.

 	remove(MenuComponent)

 Removes the specified menu from the menu bar.

 	removeNotify()

 Removes the menu bar's peer.

 	setHelpMenu(Menu)

 Sets the help menu to the specified menu on the menu bar.

 	shortcuts()

 Get an Enumeration of all MenuShortcuts this MenuBar manages.

 MenuBar

  public MenuBar()

 Creates a new menu bar.

 addNotify

  public void addNotify()

 Creates the menu bar's peer. The peer allows us to change the  appearance of the menu bar without changing any of the menu bar's  functionality.

 removeNotify

  public void removeNotify()

 Removes the menu bar's peer. The peer allows us to change the  appearance of the menu bar without changing any of the menu bar's  functionality.

Overrides:

removeNotify in class MenuComponent

 getHelpMenu

  public Menu getHelpMenu()

 Gets the help menu on the menu bar.

 setHelpMenu

  public synchronized void setHelpMenu(Menu m)

 Sets the help menu to the specified menu on the menu bar.

Parameters:

 m - the menu to be set

 add

  public synchronized Menu add(Menu m)

 Adds the specified menu to the menu bar.

Parameters:

 m - the menu to be added to the menu bar

 remove

  public synchronized void remove(int index)

 Removes the menu located at the specified index from the menu bar.

Parameters:

 index - the position of the menu to be removed

 remove

  public synchronized void remove(MenuComponent m)

 Removes the specified menu from the menu bar.

Parameters:

 m - the menu to be removed

 getMenuCount

  public int getMenuCount()

 Counts the number of menus on the menu bar.

 countMenus

  public int countMenus()

 Note: countMenus() is deprecated. As of JDK version 1.1,  replaced by getMenuCount().

 getMenu

  public Menu getMenu(int i)

 Gets the specified menu.

Parameters:

 i - the menu to be returned

 shortcuts

  public synchronized Enumeration shortcuts()

 Get an Enumeration of all MenuShortcuts this MenuBar manages.

 getShortcutMenuItem

  public MenuItem getShortcutMenuItem(MenuShortcut s)

 Return the MenuItem associated with a MenuShortcut,  or null if none has been specified.

Parameters:

 s - the MenuShortcut to search for

 deleteShortcut

  public void deleteShortcut(MenuShortcut s)

 Delete the specified MenuShortcut.

Parameters:

 s - the MenuShortcut to delete

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.MenuComponent

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.MenuComponent

java.lang.Object
   |
   +----java.awt.MenuComponent

______________________________________________________________________________

 public class MenuComponent

 extends Object

 implements Serializable

The super class of all menu related components.

______________________________________________________________________________

 	MenuComponent()

 	dispatchEvent(AWTEvent)

  	getFont()

 Gets the font used for this MenuItem.

 	getName()

 Gets the name of the menu component.

 	getParent()

 Returns the parent container.

 	getPeer()

Deprecated.

 	paramString()

 Returns the String parameter of this MenuComponent.

 	postEvent(Event)

 Posts the specified event to the menu.

 	processEvent(AWTEvent)

 Processes events occurring on this menu component.

 	removeNotify()

 Removes the menu component's peer.

 	setFont(Font)

 Sets the font to be used for this MenuItem to the specified font.

 	setName(String)

 Sets the name of the component to the specified string.

 	toString()

 Returns the String representation of this MenuComponent's values.

 MenuComponent

  public MenuComponent()

 getName

  public String getName()

 Gets the name of the menu component.

 setName

  public void setName(String name)

 Sets the name of the component to the specified string.

Parameters:

 name - the name of the component.

 getParent

  public MenuContainer getParent()

 Returns the parent container.

 getPeer

  public MenuComponentPeer getPeer()

 Note: getPeer() is deprecated. As of JDK version 1.1,  programs should not directly manipulate peers.

 getFont

  public Font getFont()

 Gets the font used for this MenuItem.

Returns:

 the font if one is used; null otherwise.

 setFont

  public void setFont(Font f)

 Sets the font to be used for this MenuItem to the specified font.

Parameters:

 f - the font to be set

 removeNotify

  public void removeNotify()

 Removes the menu component's peer. The peer allows us to modify the  appearance of the menu component without changing the functionality of  the menu component.

 postEvent

  public boolean postEvent(Event evt)

 Posts the specified event to the menu.

Parameters:

 evt - the event which is to take place

 dispatchEvent

  public final void dispatchEvent(AWTEvent e)

 processEvent

  protected void processEvent(AWTEvent e)

 Processes events occurring on this menu component.

Parameters:

 e - the event

 paramString

  protected String paramString()

 Returns the String parameter of this MenuComponent.

 toString

  public String toString()

 Returns the String representation of this MenuComponent's values.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.MenuContainer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.MenuContainer

 public interface MenuContainer

The super class of all menu related containers.

______________________________________________________________________________

 	getFont()

  	postEvent(Event)

  	remove(MenuComponent)

 getFont

  public abstract Font getFont()

 postEvent

  public abstract boolean postEvent(Event evt)

 remove

  public abstract void remove(MenuComponent comp)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.MenuItem

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.MenuItem

java.lang.Object
   |
   +----java.awt.MenuComponent
           |
           +----java.awt.MenuItem

______________________________________________________________________________

 public class MenuItem

 extends MenuComponent

A String item that represents a choice in a menu.

______________________________________________________________________________

 	MenuItem()

 Constructs a new MenuItem with an empty label and no keyboard  shortcut.

 	MenuItem(String)

 Constructs a new MenuItem with the specified label and no  keyboard shortcut.

 	MenuItem(String, MenuShortcut)

 Create a MenuItem with an associated keyboard shortcut.

 	addActionListener(ActionListener)

 Adds the specified action listener to receive action events  from this menu item.

 	addNotify()

 Creates the menu item's peer.

 	deleteShortcut()

 Delete any MenuShortcut associated with this MenuItem.

 	disable()

Deprecated.

 	disableEvents(long)

 Disables the events defined by the specified event mask parameter  from being delivered to this menu item.

 	enable()

Deprecated.

 	enable(boolean)

Deprecated.

 	enableEvents(long)

 Enables the events defined by the specified event mask parameter  to be delivered to this menu item.

 	getActionCommand()

 Returns the command name of the action event fired by this menu item.

 	getLabel()

 Gets the label for this menu item.

 	getShortcut()

 Return the MenuShortcut associated with this MenuItem,  or null if none has been specified.

 	isEnabled()

 Checks whether the menu item is enabled.

 	paramString()

 Returns the String parameter of the menu item.

 	processActionEvent(ActionEvent)

 Processes action events occurring on this menu item by  dispatching them to any registered ActionListener objects.

 	processEvent(AWTEvent)

 Processes events on this menu item.

 	removeActionListener(ActionListener)

 Removes the specified action listener so it no longer receives  action events from this menu item.

 	setActionCommand(String)

 Sets the command name of the action event fired by this menu item.

 	setEnabled(boolean)

 Sets whether or not this menu item can be chosen.

 	setLabel(String)

 Sets the label to be the specified label.

 	setShortcut(MenuShortcut)

 Set this MenuItem's MenuShortcut.

 MenuItem

  public MenuItem()

 Constructs a new MenuItem with an empty label and no keyboard  shortcut.

 MenuItem

  public MenuItem(String label)

 Constructs a new MenuItem with the specified label and no  keyboard shortcut.

Parameters:

 label - the label for this menu item. Note that "-" is  reserved to mean a separator between menu items.

 MenuItem

  public MenuItem(String label,
                  MenuShortcut s)

 Create a MenuItem with an associated keyboard shortcut.

Parameters:

 label - the label for this menu item. Note that "-" is  reserved to mean a separator between menu items.

 s - the MenuShortcut associated with this MenuItem.

 addNotify

  public void addNotify()

 Creates the menu item's peer. The peer allows us to modify the  appearance of the menu item without changing its functionality.

 getLabel

  public String getLabel()

 Gets the label for this menu item.

 setLabel

  public synchronized void setLabel(String label)

 Sets the label to be the specified label.

Parameters:

 label - the label for this menu item

 isEnabled

  public boolean isEnabled()

 Checks whether the menu item is enabled.

 setEnabled

  public synchronized void setEnabled(boolean b)

 Sets whether or not this menu item can be chosen.

Parameters:

 b - if true, enables this menu item; otherwise, disables it

 enable

  public synchronized void enable()

 Note: enable() is deprecated. As of JDK version 1.1,  replaced by setEnabled(boolean).

 enable

  public void enable(boolean b)

 Note: enable() is deprecated. As of JDK version 1.1,  replaced by setEnabled(boolean).

 disable

  public synchronized void disable()

 Note: disable() is deprecated. As of JDK version 1.1,  replaced by setEnabled(boolean).

 getShortcut

  public MenuShortcut getShortcut()

 Return the MenuShortcut associated with this MenuItem,  or null if none has been specified.

 setShortcut

  public void setShortcut(MenuShortcut s)

 Set this MenuItem's MenuShortcut. If a MenuShortcut is already  associated with this MenuItem, it will be replaced.

Parameters:

 s - the MenuShortcut to associate with this MenuItem.

 deleteShortcut

  public void deleteShortcut()

 Delete any MenuShortcut associated with this MenuItem.

 enableEvents

  protected final void enableEvents(long eventsToEnable)

 Enables the events defined by the specified event mask parameter  to be delivered to this menu item. Event types are automatically  enabled when a listener for that type is added to the menu item,  therefore this method only needs to be invoked by subclasses of  a menu item which desire to have the specified event types  delivered to processEvent regardless of whether a listener is  registered.

Parameters:

 eventsToEnable - the event mask defining the event types

 disableEvents

  protected final void disableEvents(long eventsToDisable)

 Disables the events defined by the specified event mask parameter  from being delivered to this menu item.

Parameters:

 eventsToDisable - the event mask defining the event types

 setActionCommand

  public void setActionCommand(String command)

 Sets the command name of the action event fired by this menu item.  By default this will be set to the label of the menu item.

 getActionCommand

  public String getActionCommand()

 Returns the command name of the action event fired by this menu item.

 addActionListener

  public void addActionListener(ActionListener l)

 Adds the specified action listener to receive action events  from this menu item.

Parameters:

 l - the action listener

 removeActionListener

  public void removeActionListener(ActionListener l)

 Removes the specified action listener so it no longer receives  action events from this menu item.

Parameters:

 l - the action listener

 processEvent

  protected void processEvent(AWTEvent e)

 Processes events on this menu item. If the event is an ActionEvent,  it invokes the handleActionEvent method.  NOTE: Menu items currently only support action events.

Parameters:

 e - the event

Overrides:

processEvent in class MenuComponent

 processActionEvent

  protected void processActionEvent(ActionEvent e)

 Processes action events occurring on this menu item by  dispatching them to any registered ActionListener objects.  NOTE: This method will not be called unless action events  are enabled for this component; this happens when one of the  following occurs:  a) An ActionListener object is registered via addActionListener()  b) Action events are enabled via enableEvents()

Parameters:

 e - the action event

See Also:

enableEvents

 paramString

  public String paramString()

 Returns the String parameter of the menu item.

Overrides:

paramString in class MenuComponent

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.MenuShortcut

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.MenuShortcut

java.lang.Object
   |
   +----java.awt.MenuShortcut

______________________________________________________________________________

 public class MenuShortcut

 extends Object

 implements Serializable

A class which represents a keyboard accelerator for a MenuItem.

______________________________________________________________________________

 	MenuShortcut(int)

 Constructs a new MenuShortcut for the specified key.

 	MenuShortcut(int, boolean)

 Constructs a new MenuShortcut for the specified key.

 	equals(MenuShortcut)

 Returns whether this MenuShortcut is the same as another:  equality is defined to mean that both MenuShortcuts use the same key  and both either use or don't use the SHIFT key.

 	getKey()

 Return the raw keycode of this MenuShortcut.

 	paramString()

  	toString()

 Returns an internationalized description of the MenuShortcut.

 	usesShiftModifier()

 Return whether this MenuShortcut must be invoked using the SHIFT key.

 MenuShortcut

  public MenuShortcut(int key)

 Constructs a new MenuShortcut for the specified key.

Parameters:

 key - the raw keycode for this MenuShortcut, as would be returned  in the keyCode field of a KeyEvent if this key were pressed.

 MenuShortcut

  public MenuShortcut(int key,
                      boolean useShiftModifier)

 Constructs a new MenuShortcut for the specified key.

Parameters:

 key - the raw keycode for this MenuShortcut, as would be returned  in the keyCode field of a KeyEvent if this key were pressed.

 useShiftModifier - indicates whether this MenuShortcut is invoked  with the SHIFT key down.

 getKey

  public int getKey()

 Return the raw keycode of this MenuShortcut.

 usesShiftModifier

  public boolean usesShiftModifier()

 Return whether this MenuShortcut must be invoked using the SHIFT key.

 equals

  public boolean equals(MenuShortcut s)

 Returns whether this MenuShortcut is the same as another:  equality is defined to mean that both MenuShortcuts use the same key  and both either use or don't use the SHIFT key.

Parameters:

 s - the MenuShortcut to compare with this.

 toString

  public String toString()

 Returns an internationalized description of the MenuShortcut.

Overrides:

toString in class Object

 paramString

  protected String paramString()

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Panel

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Panel

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Panel

______________________________________________________________________________

 public class Panel

 extends Container

A Panel Container class. This produces a generic container.

______________________________________________________________________________

 	Panel()

 Creates a new panel.

 	Panel(LayoutManager)

 Creates a new panel with the specified layout manager.

 	addNotify()

 Creates the Panel's peer.

 Panel

  public Panel()

 Creates a new panel. The default layout for all panels is  FlowLayout.

 Panel

  public Panel(LayoutManager layout)

 Creates a new panel with the specified layout manager.

Parameters:

 layout - the layout manager for this panel

 addNotify

  public void addNotify()

 Creates the Panel's peer. The peer allows you to modify the  appearance of the panel without changing its functionality.

Overrides:

addNotify in class Container

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.ButtonPeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.ButtonPeer

 public interface ButtonPeer

 extends ComponentPeer

______________________________________________________________________________

 	setLabel(String)

 setLabel

  public abstract void setLabel(String label)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.CanvasPeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.CanvasPeer

 public interface CanvasPeer

 extends ComponentPeer

______________________________________________________________________________
______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.CheckboxMenuItemPeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.CheckboxMenuItemPeer

 public interface CheckboxMenuItemPeer

 extends MenuItemPeer

______________________________________________________________________________

 	setState(boolean)

 setState

  public abstract void setState(boolean t)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.CheckboxPeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.CheckboxPeer

 public interface CheckboxPeer

 extends ComponentPeer

______________________________________________________________________________

 	setCheckboxGroup(CheckboxGroup)

  	setLabel(String)

  	setState(boolean)

 setState

  public abstract void setState(boolean state)

 setCheckboxGroup

  public abstract void setCheckboxGroup(CheckboxGroup g)

 setLabel

  public abstract void setLabel(String label)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.ChoicePeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.ChoicePeer

 public interface ChoicePeer

 extends ComponentPeer

______________________________________________________________________________

 	add(String, int)

  	addItem(String, int)

  	remove(int)

  	select(int)

 add

  public abstract void add(String item,
                           int index)

 remove

  public abstract void remove(int index)

 select

  public abstract void select(int index)

 addItem

  public abstract void addItem(String item,
                               int index)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.ComponentPeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.ComponentPeer

 public interface ComponentPeer

______________________________________________________________________________

 	checkImage(Image, int, int, ImageObserver)

  	createImage(ImageProducer)

  	createImage(int, int)

  	disable()

 DEPRECATED: Replaced by setEnabled(boolean).

 	dispose()

  	enable()

 DEPRECATED: Replaced by setEnabled(boolean).

 	getColorModel()

  	getFontMetrics(Font)

  	getGraphics()

  	getLocationOnScreen()

  	getMinimumSize()

  	getPreferredSize()

  	getToolkit()

  	handleEvent(AWTEvent)

  	hide()

 DEPRECATED: Replaced by setVisible(boolean).

 	isFocusTraversable()

  	minimumSize()

 DEPRECATED: Replaced by getMinimumSize().

 	paint(Graphics)

  	preferredSize()

 DEPRECATED: Replaced by getPreferredSize().

 	prepareImage(Image, int, int, ImageObserver)

  	print(Graphics)

  	repaint (long, int, int, int, int)

  	requestFocus()

  	reshape(int, int, int, int)

 DEPRECATED: Replaced by setBounds(int, int, int, int).

 	setBackground(Color)

  	setBounds (int, int, int, int)

  	setCursor(Cursor)

  	setEnabled(boolean)

  	setFont(Font)

  	setForeground(Color)

  	setVisible(boolean)

  	show()

 DEPRECATED: Replaced by setVisible(boolean).

 setVisible

  public abstract void setVisible(boolean b)

 setEnabled

  public abstract void setEnabled(boolean b)

 paint

  public abstract void paint(Graphics g)

 repaint

  public abstract void repaint(long tm,
                               int x,
                               int y,
                               int width,
                               int height)

 print

  public abstract void print(Graphics g)

 setBounds

  public abstract void setBounds(int x,
                                 int y,
                                 int width,
                                 int height)

 handleEvent

  public abstract void handleEvent(AWTEvent e)

 getLocationOnScreen

  public abstract Point getLocationOnScreen()

 getPreferredSize

  public abstract Dimension getPreferredSize()

 getMinimumSize

  public abstract Dimension getMinimumSize()

 getColorModel

  public abstract ColorModel getColorModel()

 getToolkit

  public abstract Toolkit getToolkit()

 getGraphics

  public abstract Graphics getGraphics()

 getFontMetrics

  public abstract FontMetrics getFontMetrics(Font font)

 dispose

  public abstract void dispose()

 setForeground

  public abstract void setForeground(Color c)

 setBackground

  public abstract void setBackground(Color c)

 setFont

  public abstract void setFont(Font f)

 setCursor

  public abstract void setCursor(Cursor cursor)

 requestFocus

  public abstract void requestFocus()

 isFocusTraversable

  public abstract boolean isFocusTraversable()

 createImage

  public abstract Image createImage(ImageProducer producer)

 createImage

  public abstract Image createImage(int width,
                                    int height)

 prepareImage

  public abstract boolean prepareImage(Image img,
                                       int w,
                                       int h,
                                       ImageObserver o)

 checkImage

  public abstract int checkImage(Image img,
                                 int w,
                                 int h,
                                 ImageObserver o)

 preferredSize

  public abstract Dimension preferredSize()

 DEPRECATED: Replaced by getPreferredSize().

 minimumSize

  public abstract Dimension minimumSize()

 DEPRECATED: Replaced by getMinimumSize().

 show

  public abstract void show()

 DEPRECATED: Replaced by setVisible(boolean).

 hide

  public abstract void hide()

 DEPRECATED: Replaced by setVisible(boolean).

 enable

  public abstract void enable()

 DEPRECATED: Replaced by setEnabled(boolean).

 disable

  public abstract void disable()

 DEPRECATED: Replaced by setEnabled(boolean).

 reshape

  public abstract void reshape(int x,
                               int y,
                               int width,
                               int height)

 DEPRECATED: Replaced by setBounds(int, int, int, int).

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.ContainerPeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.ContainerPeer

 public interface ContainerPeer

 extends ComponentPeer

______________________________________________________________________________

 	beginValidate()

  	endValidate()

  	getInsets()

  	insets()

 DEPRECATED: Replaced by getInsets().

 getInsets

  public abstract Insets getInsets()

 beginValidate

  public abstract void beginValidate()

 endValidate

  public abstract void endValidate()

 insets

  public abstract Insets insets()

 DEPRECATED: Replaced by getInsets().

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.DialogPeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.DialogPeer

 public interface DialogPeer

 extends WindowPeer

______________________________________________________________________________

 	setResizable(boolean)

  	setTitle(String)

 setTitle

  public abstract void setTitle(String title)

 setResizable

  public abstract void setResizable(boolean resizeable)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.FileDialogPeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.FileDialogPeer

 public interface FileDialogPeer

 extends DialogPeer

______________________________________________________________________________

 	setDirectory(String)

  	setFile(String)

  	setFilenameFilter (FilenameFilter)

 setFile

  public abstract void setFile(String file)

 setDirectory

  public abstract void setDirectory(String dir)

 setFilenameFilter

  public abstract void setFilenameFilter(FilenameFilter filter)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.FontPeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.FontPeer

 public interface FontPeer

______________________________________________________________________________
______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.FramePeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.FramePeer

 public interface FramePeer

 extends WindowPeer

______________________________________________________________________________

 	setIconImage(Image)

  	setMenuBar(MenuBar)

  	setResizable(boolean)

  	setTitle(String)

 setTitle

  public abstract void setTitle(String title)

 setIconImage

  public abstract void setIconImage(Image im)

 setMenuBar

  public abstract void setMenuBar(MenuBar mb)

 setResizable

  public abstract void setResizable(boolean resizeable)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.LabelPeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.LabelPeer

 public interface LabelPeer

 extends ComponentPeer

______________________________________________________________________________

 	setAlignment(int)

  	setText(String)

 setText

  public abstract void setText(String label)

 setAlignment

  public abstract void setAlignment(int alignment)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.LightweightPeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.LightweightPeer

 public interface LightweightPeer

 extends ComponentPeer

The LightweightPeer interface marks a component as depending upon  a native container so window related events can be routed to the  component. Since this only applies to components and their  extensions, this interface extends ComponentPeer.

______________________________________________________________________________
______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.ListPeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.ListPeer

 public interface ListPeer

 extends ComponentPeer

______________________________________________________________________________

 	add(String, int)

  	addItem(String, int)

 DEPRECATED: Replaced by add(String, int).

 	clear()

 DEPRECATED: Replaced by removeAll().

 	delItems(int, int)

  	deselect(int)

  	getMinimumSize(int)

  	getPreferredSize(int)

  	getSelectedIndexes()

  	makeVisible(int)

  	minimumSize(int)

 DEPRECATED: Replaced by getMinimumSize(int).

 	preferredSize(int)

 DEPRECATED: Replaced by getPreferredSize(int).

 	removeAll()

  	select(int)

  	setMultipleMode(boolean)

  	setMultipleSelections (boolean)

 DEPRECATED: Replaced by setMultipleMode(boolean).

 getSelectedIndexes

  public abstract int[] getSelectedIndexes()

 add

  public abstract void add(String item,
                           int index)

 delItems

  public abstract void delItems(int start,
                                int end)

 removeAll

  public abstract void removeAll()

 select

  public abstract void select(int index)

 deselect

  public abstract void deselect(int index)

 makeVisible

  public abstract void makeVisible(int index)

 setMultipleMode

  public abstract void setMultipleMode(boolean b)

 getPreferredSize

  public abstract Dimension getPreferredSize(int rows)

 getMinimumSize

  public abstract Dimension getMinimumSize(int rows)

 addItem

  public abstract void addItem(String item,
                               int index)

 DEPRECATED: Replaced by add(String, int).

 clear

  public abstract void clear()

 DEPRECATED: Replaced by removeAll().

 setMultipleSelections

  public abstract void setMultipleSelections(boolean v)

 DEPRECATED: Replaced by setMultipleMode(boolean).

 preferredSize

  public abstract Dimension preferredSize(int v)

 DEPRECATED: Replaced by getPreferredSize(int).

 minimumSize

  public abstract Dimension minimumSize(int v)

 DEPRECATED: Replaced by getMinimumSize(int).

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.MenuBarPeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.MenuBarPeer

 public interface MenuBarPeer

 extends MenuComponentPeer

______________________________________________________________________________

 	addHelpMenu(Menu)

  	addMenu(Menu)

  	delMenu(int)

 addMenu

  public abstract void addMenu(Menu m)

 delMenu

  public abstract void delMenu(int index)

 addHelpMenu

  public abstract void addHelpMenu(Menu m)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.MenuComponentPeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.MenuComponentPeer

 public interface MenuComponentPeer

______________________________________________________________________________

 	dispose()

 dispose

  public abstract void dispose()

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.MenuItemPeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.MenuItemPeer

 public interface MenuItemPeer

 extends MenuComponentPeer

______________________________________________________________________________

 	disable()

 DEPRECATED: Replaced by setEnabled(boolean).

 	enable()

 DEPRECATED: Replaced by setEnabled(boolean).

 	setEnabled(boolean)

  	setLabel(String)

 setLabel

  public abstract void setLabel(String label)

 setEnabled

  public abstract void setEnabled(boolean b)

 enable

  public abstract void enable()

 DEPRECATED: Replaced by setEnabled(boolean).

 disable

  public abstract void disable()

 DEPRECATED: Replaced by setEnabled(boolean).

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.MenuPeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.MenuPeer

 public interface MenuPeer

 extends MenuItemPeer

______________________________________________________________________________

 	addItem(MenuItem)

  	addSeparator()

  	delItem(int)

 addSeparator

  public abstract void addSeparator()

 addItem

  public abstract void addItem(MenuItem item)

 delItem

  public abstract void delItem(int index)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.PanelPeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.PanelPeer

 public interface PanelPeer

 extends ContainerPeer

______________________________________________________________________________
______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.PopupMenuPeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.PopupMenuPeer

 public interface PopupMenuPeer

 extends MenuPeer

______________________________________________________________________________

 	show(Event)

 show

  public abstract void show(Event e)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.ScrollbarPeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.ScrollbarPeer

 public interface ScrollbarPeer

 extends ComponentPeer

______________________________________________________________________________

 	setLineIncrement(int)

  	setPageIncrement(int)

  	setValues (int, int, int, int)

 setValues

  public abstract void setValues(int value,
                                 int visible,
                                 int minimum,
                                 int maximum)

 setLineIncrement

  public abstract void setLineIncrement(int l)

 setPageIncrement

  public abstract void setPageIncrement(int l)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.ScrollPanePeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.ScrollPanePeer

 public interface ScrollPanePeer

 extends ContainerPeer

______________________________________________________________________________

 	childResized(int, int)

  	getHScrollbarHeight()

  	getVScrollbarWidth()

  	setScrollPosition(int, int)

  	setUnitIncrement (Adjustable, int)

  	setValue(Adjustable, int)

 getHScrollbarHeight

  public abstract int getHScrollbarHeight()

 getVScrollbarWidth

  public abstract int getVScrollbarWidth()

 setScrollPosition

  public abstract void setScrollPosition(int x,
                                         int y)

 childResized

  public abstract void childResized(int w,
                                    int h)

 setUnitIncrement

  public abstract void setUnitIncrement(Adjustable adj,
                                        int u)

 setValue

  public abstract void setValue(Adjustable adj,
                                int v)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.TextAreaPeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.TextAreaPeer

 public interface TextAreaPeer

 extends TextComponentPeer

______________________________________________________________________________

 	getMinimumSize(int, int)

  	getPreferredSize(int, int)

  	insert(String, int)

  	insertText(String, int)

 DEPRECATED: Replaced by insert(String, int).

 	minimumSize(int, int)

 DEPRECATED: Replaced by getMinimumSize(int, int).

 	preferredSize(int, int)

 DEPRECATED: Replaced by getPreferredSize(int, int).

 	replaceRange(String, int, int)

  	replaceText (String, int, int)

 DEPRECATED: Replaced by ReplaceRange(String, int, int).

 insert

  public abstract void insert(String text,
                              int pos)

 replaceRange

  public abstract void replaceRange(String text,
                                    int start,
                                    int end)

 getPreferredSize

  public abstract Dimension getPreferredSize(int rows,
                                             int columns)

 getMinimumSize

  public abstract Dimension getMinimumSize(int rows,
                                           int columns)

 insertText

  public abstract void insertText(String txt,
                                  int pos)

 DEPRECATED: Replaced by insert(String, int).

 replaceText

  public abstract void replaceText(String txt,
                                   int start,
                                   int end)

 DEPRECATED: Replaced by ReplaceRange(String, int, int).

 preferredSize

  public abstract Dimension preferredSize(int rows,
                                          int cols)

 DEPRECATED: Replaced by getPreferredSize(int, int).

 minimumSize

  public abstract Dimension minimumSize(int rows,
                                        int cols)

 DEPRECATED: Replaced by getMinimumSize(int, int).

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.TextComponentPeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.TextComponentPeer

 public interface TextComponentPeer

 extends ComponentPeer

______________________________________________________________________________

 	getCaretPosition()

  	getSelectionEnd()

  	getSelectionStart()

  	getText()

  	select(int, int)

  	setCaretPosition(int)

  	setEditable(boolean)

  	setText(String)

 setEditable

  public abstract void setEditable(boolean editable)

 getText

  public abstract String getText()

 setText

  public abstract void setText(String l)

 getSelectionStart

  public abstract int getSelectionStart()

 getSelectionEnd

  public abstract int getSelectionEnd()

 select

  public abstract void select(int selStart,
                              int selEnd)

 setCaretPosition

  public abstract void setCaretPosition(int pos)

 getCaretPosition

  public abstract int getCaretPosition()

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.TextFieldPeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.TextFieldPeer

 public interface TextFieldPeer

 extends TextComponentPeer

______________________________________________________________________________

 	getMinimumSize(int)

  	getPreferredSize(int)

  	minimumSize(int)

 DEPRECATED: Replaced by getMinimumSize(int).

 	preferredSize(int)

 DEPRECATED: Replaced by getPreferredSize(int).

 	setEchoChar(char)

  	setEchoCharacter(char)

 DEPRECATED: Replaced by setEchoChar(char echoChar).

 setEchoChar

  public abstract void setEchoChar(char echoChar)

 getPreferredSize

  public abstract Dimension getPreferredSize(int columns)

 getMinimumSize

  public abstract Dimension getMinimumSize(int columns)

 setEchoCharacter

  public abstract void setEchoCharacter(char c)

 DEPRECATED: Replaced by setEchoChar(char echoChar).

 preferredSize

  public abstract Dimension preferredSize(int cols)

 DEPRECATED: Replaced by getPreferredSize(int).

 minimumSize

  public abstract Dimension minimumSize(int cols)

 DEPRECATED: Replaced by getMinimumSize(int).

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.peer.WindowPeer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.peer.WindowPeer

 public interface WindowPeer

 extends ContainerPeer

______________________________________________________________________________

 	toBack()

  	toFront()

 toFront

  public abstract void toFront()

 toBack

  public abstract void toBack()

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Point

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Point

java.lang.Object
   |
   +----java.awt.Point

______________________________________________________________________________

 public class Point

 extends Object

 implements Serializable

A point representing a location in (x, y) coordinate space.

______________________________________________________________________________

 	x

 The x coordinate.

 	y

 The y coordinate.

 	Point()

 Constructs and initializes a Point initialized with (0, 0).

 	Point(int, int)

 Constructs and initializes a Point from the specified x and y  coordinates.

 	Point(Point)

 Constructs and initializes a Point with the same location as  the specified Point.

 	equals(Object)

 Checks whether two pointers are equal.

 	getLocation()

 Returns the location of this point.

 	hashCode()

 Returns the hashcode for this Point.

 	move(int, int)

 Changes the point to have the specified location.

 	setLocation(int, int)

 Changes the point to have the specificed location.

 	setLocation(Point)

 Changes the point to have the specificed location.

 	toString()

 Returns the String representation of this Point's coordinates.

 	translate(int, int)

 Translates the point.

 x

  public int x

 The x coordinate.

 y

  public int y

 The y coordinate.

 Point

  public Point()

 Constructs and initializes a Point initialized with (0, 0).

 Point

  public Point(Point p)

 Constructs and initializes a Point with the same location as  the specified Point.

Parameters:

 p - a point

 Point

  public Point(int x,
               int y)

 Constructs and initializes a Point from the specified x and y  coordinates.

Parameters:

 x - the x coordinate

 y - the y coordinate

 getLocation

  public Point getLocation()

 Returns the location of this point.  This method is included for completeness, to parallel the  getLocation method of Component.

 setLocation

  public void setLocation(Point p)

 Changes the point to have the specificed location.  This method is included for completeness, to parallel the  setLocation method of Component.

Parameters:

 p - the new location for the point

 setLocation

  public void setLocation(int x,
                          int y)

 Changes the point to have the specificed location.  This method is included for completeness, to parallel the  setLocation method of Component.

Parameters:

 x - the x coordinate of the new location

 y - the y coordinate of the new location

 move

  public void move(int x,
                   int y)

 Changes the point to have the specified location.

Parameters:

 x - the x coordinate of the new location

 y - the y coordinate of the new location

 translate

  public void translate(int x,
                        int y)

 Translates the point.

 hashCode

  public int hashCode()

 Returns the hashcode for this Point.

Overrides:

hashCode in class Object

 equals

  public boolean equals(Object obj)

 Checks whether two pointers are equal.

Overrides:

equals in class Object

 toString

  public String toString()

 Returns the String representation of this Point's coordinates.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Polygon

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Polygon

java.lang.Object
   |
   +----java.awt.Polygon

______________________________________________________________________________

 public class Polygon

 extends Object

 implements Shape, Serializable

A polygon consists of a list of x and y coordinates.

______________________________________________________________________________

 	bounds

  	npoints

 The total number of points.

 	xpoints

 The array of x coordinates.

 	ypoints

 The array of y coordinates.

 	Polygon()

 Creates an empty polygon.

 	Polygon(int[], int[], int)

 Constructs and initializes a Polygon from the specified parameters.

 	addPoint(int, int)

 Appends a point to a polygon.

 	contains(int, int)

 Determines whether the point (x,y) is inside the Polygon.

 	contains(Point)

 Determines whether the specified point is inside the Polygon.

 	getBoundingBox()

Deprecated.

 	getBounds()

 Returns the bounding box of the shape.

 	inside(int, int)

Deprecated.

 	translate(int, int)

 Translates the vertices by deltaX, deltaY.

 npoints

  public int npoints

 The total number of points.

 xpoints

  public int xpoints[]

 The array of x coordinates.

 ypoints

  public int ypoints[]

 The array of y coordinates.

 bounds

  protected Rectangle bounds

 Polygon

  public Polygon()

 Creates an empty polygon.

 Polygon

  public Polygon(int xpoints[],
                 int ypoints[],
                 int npoints)

 Constructs and initializes a Polygon from the specified parameters.

Parameters:

 xpoints - the array of x coordinates

 ypoints - the array of y coordinates

 npoints - the total number of points in the Polygon

 translate

  public void translate(int deltaX,
                        int deltaY)

 Translates the vertices by deltaX, deltaY.

Parameters:

 deltaX - the amount to move the X coords

 deltaY - the amount to move the Y coords

 addPoint

  public void addPoint(int x,
                       int y)

 Appends a point to a polygon. If inside(x, y) or another  operation that calculates the bounding box has already been  performed, this method updates the bounds accordingly.

Parameters:

 x - the x coordinate of the point

 y - the y coordinate of the point

 getBounds

  public Rectangle getBounds()

 Returns the bounding box of the shape.

Returns:

 a Rectangle defining the bounds of the Polygon.

 getBoundingBox

  public Rectangle getBoundingBox()

 Note: getBoundingBox() is deprecated. As of JDK version 1.1,  replaced by getBounds().

 contains

  public boolean contains(Point p)

 Determines whether the specified point is inside the Polygon.  Uses an even-odd insideness rule (also known as an alternating  rule).

Parameters:

 p - the point to be tested

 contains

  public boolean contains(int x,
                          int y)

 Determines whether the point (x,y) is inside the Polygon. Uses  an even-odd insideness rule (also known as an alternating  rule).

Parameters:

 x - the X coordinate of the point to be tested

 y - the Y coordinate of the point to be tested

Kindly donated by Hanpeter van Vliet .

 inside

  public boolean inside(int x,
                        int y)

 Note: inside() is deprecated. As of JDK version 1.1,  replaced by contains(int, int).

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.PopupMenu

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.PopupMenu

java.lang.Object
   |
   +----java.awt.MenuComponent
           |
           +----java.awt.MenuItem
                   |
                   +----java.awt.Menu
                           |
                           +----java.awt.PopupMenu

______________________________________________________________________________

 public class PopupMenu

 extends Menu

A class that implements a menu which can be dynamically popped up  at a specified position within a component.

______________________________________________________________________________

 	PopupMenu()

 Creates a new popup menu.

 	PopupMenu(String)

 Creates a new popup menu with the specified name.

 	addNotify()

 Creates the popup menu's peer.

 	show(Component, int, int)

 Shows the popup menu at the x, y position relative to an origin component.

 PopupMenu

  public PopupMenu()

 Creates a new popup menu.

 PopupMenu

  public PopupMenu(String label)

 Creates a new popup menu with the specified name.

Parameters:

 title - the title string for the popup menu

 addNotify

  public synchronized void addNotify()

 Creates the popup menu's peer. The peer allows us to change the  appearance of the popup menu without changing any of the popup menu's  functionality.

Overrides:

addNotify in class Menu

 show

  public void show(Component origin,
                   int x,
                   int y)

 Shows the popup menu at the x, y position relative to an origin component.  The origin component must be contained within the component hierarchy  of the popup menu's parent. Both the origin and the parent must be  showing on the screen for this method to be valid.

Parameters:

 origin - the component which defines the coordinate space

 x - the x coordinate position to popup the menu

 y - the y coordinate position to popup the menu

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.PrintGraphics

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.PrintGraphics

 public interface PrintGraphics

An abstract class which provides a print graphics context for a page.

______________________________________________________________________________

 	getPrintJob()

 Returns the PrintJob object from which this PrintGraphics  object originated.

 getPrintJob

  public abstract PrintJob getPrintJob()

 Returns the PrintJob object from which this PrintGraphics  object originated.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.PrintJob

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.PrintJob

java.lang.Object
   |
   +----java.awt.PrintJob

______________________________________________________________________________

 public class PrintJob

 extends Object

An abstract class which initiates and executes a print job.  It provides access to a print graphics object which renders  to an appropriate print device.

See Also:

getPrintJob

______________________________________________________________________________

 	PrintJob()

 	end()

 Ends the print job and does any necessary cleanup.

 	finalize()

 Ends this print job once it is no longer referenced.

 	getGraphics()

 Gets a Graphics object that will draw to the next page.

 	getPageDimension()

 Returns the dimensions of the page in pixels.

 	getPageResolution()

 Returns the resolution of the page in pixels per inch.

 	lastPageFirst()

 Returns true if the last page will be printed first.

 PrintJob

  public PrintJob()

 getGraphics

  public abstract Graphics getGraphics()

 Gets a Graphics object that will draw to the next page.  The page is sent to the printer when the graphics  object is disposed. This graphics object will also implement  the PrintGraphics interface.

See Also:

PrintGraphics

 getPageDimension

  public abstract Dimension getPageDimension()

 Returns the dimensions of the page in pixels.  The resolution of the page is chosen so that it  is similar to the screen resolution.

 getPageResolution

  public abstract int getPageResolution()

 Returns the resolution of the page in pixels per inch.  Note that this doesn't have to correspond to the physical  resolution of the printer.

 lastPageFirst

  public abstract boolean lastPageFirst()

 Returns true if the last page will be printed first.

 end

  public abstract void end()

 Ends the print job and does any necessary cleanup.

 finalize

  public void finalize()

 Ends this print job once it is no longer referenced.

Overrides:

finalize in class Object

See Also:

end

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Rectangle

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Rectangle

java.lang.Object
   |
   +----java.awt.Rectangle

______________________________________________________________________________

 public class Rectangle

 extends Object

 implements Shape, Serializable

A rectangle defined by x, y, width and height.

______________________________________________________________________________

 	height

 The height of the rectangle.

 	width

 The width of the rectangle.

 	x

 The x coordinate of the rectangle.

 	y

 The y coordinate of the rectangle.

 	Rectangle()

 Constructs a new rectangle, initialized to location (0, 0) and  size (0, 0).

 	Rectangle(Dimension)

 Constructs a rectangle and initializes it to the specified width and  height.

 	Rectangle(int, int)

 Constructs a rectangle and initializes it with the specified width and  height parameters.

 	Rectangle(int, int, int, int)

 Constructs and initializes a rectangle with the specified parameters.

 	Rectangle(Point)

 Constructs a rectangle and initializes it to the specified point.

 	Rectangle(Point, Dimension)

 Constructs a rectangle and initializes it to a specified point and  dimension.

 	Rectangle(Rectangle)

 Constructs a new rectangle, initialized to match the values of  the specificed rectangle.

 	add(int, int)

 Adds a point to a rectangle.

 	add(Point)

 Adds a point to a rectangle.

 	add(Rectangle)

 Adds a rectangle to a rectangle.

 	contains(int, int)

 Checks whether this rectangle contains the specified point.

 	contains(Point)

 Checks whether this rectangle contains the specified point.

 	equals(Object)

 Checks whether two rectangles are equal.

 	getBounds()

 Returns the bounds of this rectangle.

 	getLocation()

 Returns the location of this rectangle.

 	getSize()

 Returns the size (width by height) of this rectangle.

 	grow(int, int)

 Grows the rectangle horizontally and vertically.

 	hashCode()

 Returns the hashcode for this Rectangle.

 	inside(int, int)

Deprecated.

 	intersection(Rectangle)

 Computes the intersection of two rectangles.

 	intersects(Rectangle)

 Checks if two rectangles intersect.

 	isEmpty()

 Determines whether the rectangle is empty.

 	move(int, int)

Deprecated.

 	reshape(int, int, int, int)

Deprecated.

 	resize(int, int)

Deprecated.

 	setBounds(int, int, int, int)

 Set the bounds of this rectangle to the specified x, y, width,  and height.

 	setBounds(Rectangle)

 Set the bounds of this rectangle to match the specified rectangle.

 	setLocation(int, int)

 Moves the rectangle to have the specificed location.

 	setLocation(Point)

 Moves the rectangle to have the specificed location.

 	setSize(Dimension)

 Set the size of this rectangle to match the specified size.

 	setSize(int, int)

 Set the size of this rectangle to the specified width and height.

 	toString()

 Returns the String representation of this Rectangle's values.

 	translate(int, int)

 Translates the rectangle.

 	union(Rectangle)

 Computes the union of two rectangles.

 x

  public int x

 The x coordinate of the rectangle.

 y

  public int y

 The y coordinate of the rectangle.

 width

  public int width

 The width of the rectangle.

 height

  public int height

 The height of the rectangle.

 Rectangle

  public Rectangle()

 Constructs a new rectangle, initialized to location (0, 0) and  size (0, 0).

 Rectangle

  public Rectangle(Rectangle r)

 Constructs a new rectangle, initialized to match the values of  the specificed rectangle.

Parameters:

 r - a rectangle from which to copy initial values

 Rectangle

  public Rectangle(int x,
                   int y,
                   int width,
                   int height)

 Constructs and initializes a rectangle with the specified parameters.

Parameters:

 x - the x coordinate

 y - the y coordinate

 width - the width of the rectangle

 height - the height of the rectangle

 Rectangle

  public Rectangle(int width,
                   int height)

 Constructs a rectangle and initializes it with the specified width and  height parameters.

Parameters:

 width - the width of the rectangle

 height - the height of the rectangle

 Rectangle

  public Rectangle(Point p,
                   Dimension d)

 Constructs a rectangle and initializes it to a specified point and  dimension.

Parameters:

 p - the point

 d - dimension

 Rectangle

  public Rectangle(Point p)

 Constructs a rectangle and initializes it to the specified point.

Parameters:

 p - the value of the x and y coordinate

 Rectangle

  public Rectangle(Dimension d)

 Constructs a rectangle and initializes it to the specified width and  height.

Parameters:

 d - the value of the width and height

 getBounds

  public Rectangle getBounds()

 Returns the bounds of this rectangle.  This method is included for completeness, to parallel the  getBounds method of Component.

 setBounds

  public void setBounds(Rectangle r)

 Set the bounds of this rectangle to match the specified rectangle.  This method is included for completeness, to parallel the  setBounds method of Component.

Parameters:

 d - the new size for the Dimension object

 setBounds

  public void setBounds(int x,
                        int y,
                        int width,
                        int height)

 Set the bounds of this rectangle to the specified x, y, width,  and height.  This method is included for completeness, to parallel the  setBounds method of Component.

Parameters:

 width - the new width for the Dimension object

 height - the new height for the Dimension object

 reshape

  public void reshape(int x,
                      int y,
                      int width,
                      int height)

 Note: reshape() is deprecated. As of JDK version 1.1,  replaced by setBounds(int, int, int, int).

 getLocation

  public Point getLocation()

 Returns the location of this rectangle.  This method is included for completeness, to parallel the  getLocation method of Component.

 setLocation

  public void setLocation(Point p)

 Moves the rectangle to have the specificed location.  This method is included for completeness, to parallel the  setLocation method of Component.

Parameters:

 p - the new location for the point

 setLocation

  public void setLocation(int x,
                          int y)

 Moves the rectangle to have the specificed location.  This method is included for completeness, to parallel the  setLocation method of Component.

Parameters:

 x - the x coordinate of the new location

 y - the y coordinate of the new location

 move

  public void move(int x,
                   int y)

 Note: move() is deprecated. As of JDK version 1.1,   replaced by setLocation(int, int).

 translate

  public void translate(int x,
                        int y)

 Translates the rectangle.

 getSize

  public Dimension getSize()

 Returns the size (width by height) of this rectangle.  This method is included for completeness, to parallel the  getSize method of Component.

 setSize

  public void setSize(Dimension d)

 Set the size of this rectangle to match the specified size.  This method is included for completeness, to parallel the  setSize method of Component.

Parameters:

 d - the new size for the Dimension object

 setSize

  public void setSize(int width,
                      int height)

 Set the size of this rectangle to the specified width and height.  This method is included for completeness, to parallel the  setSize method of Component.

Parameters:

 width - the new width for the Dimension object

 height - the new height for the Dimension object

 resize

  public void resize(int width,
                     int height)

 Note: resize() is deprecated. As of JDK version 1.1,  replaced by setSize(int, int).

 contains

  public boolean contains(Point p)

 Checks whether this rectangle contains the specified point.

Parameters:

 p - the point (location) to test

 contains

  public boolean contains(int x,
                          int y)

 Checks whether this rectangle contains the specified point.

Parameters:

 x - the x coordinate

 y - the y coordinate

 inside

  public boolean inside(int x,
                        int y)

 Note: inside() is deprecated. As of JDK version 1.1,  replaced by contains(int, int).

 intersects

  public boolean intersects(Rectangle r)

 Checks if two rectangles intersect.

 intersection

  public Rectangle intersection(Rectangle r)

 Computes the intersection of two rectangles.

 union

  public Rectangle union(Rectangle r)

 Computes the union of two rectangles.

 add

  public void add(int newx,
                  int newy)

 Adds a point to a rectangle. This results in the smallest  rectangle that contains both the rectangle and the point.

 add

  public void add(Point pt)

 Adds a point to a rectangle. This results in the smallest  rectangle that contains both the rectangle and the point.

 add

  public void add(Rectangle r)

 Adds a rectangle to a rectangle. This results in the union  of the two rectangles.

 grow

  public void grow(int h,
                   int v)

 Grows the rectangle horizontally and vertically.

 isEmpty

  public boolean isEmpty()

 Determines whether the rectangle is empty.

 hashCode

  public int hashCode()

 Returns the hashcode for this Rectangle.

Overrides:

hashCode in class Object

 equals

  public boolean equals(Object obj)

 Checks whether two rectangles are equal.

Overrides:

equals in class Object

 toString

  public String toString()

 Returns the String representation of this Rectangle's values.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Scrollbar

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Scrollbar

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Scrollbar

______________________________________________________________________________

 public class Scrollbar

 extends Component

 implements Adjustable

A Scrollbar component which implements the Adjustable interface.

______________________________________________________________________________

 	HORIZONTAL

 The horizontal Scrollbar variable.

 	VERTICAL

 The vertical Scrollbar variable.

 	Scrollbar()

 Constructs a new vertical Scrollbar.

 	Scrollbar(int)

 Constructs a new Scrollbar with the specified orientation.

 	Scrollbar(int, int, int, int, int)

 Constructs a new Scrollbar with the specified orientation,  value, page size, and minumum and maximum values.

 	addAdjustmentListener(AdjustmentListener)

 Adds the specified adjustment listener to recieve adjustment events  from this scrollbar.

 	addNotify()

 Creates the Scrollbar's peer.

 	getBlockIncrement()

 Gets the block increment for this scrollbar.

 	getLineIncrement()

Deprecated.

 	getMaximum()

 Returns the maximum value of this Scrollbar.

 	getMinimum()

 Returns the minimum value of this Scrollbar.

 	getOrientation()

 Returns the orientation for this Scrollbar.

 	getPageIncrement()

Deprecated.

 	getUnitIncrement()

 Gets the unit increment for this scrollbar.

 	getValue()

 Returns the current value of this Scrollbar.

 	getVisible()

Deprecated.

 	getVisibleAmount()

 Returns the visible amount of this Scrollbar.

 	paramString()

 Returns the String parameters for this Scrollbar.

 	processAdjustmentEvent(AdjustmentEvent)

 Processes adjustment events occurring on this scrollbar by  dispatching them to any registered AdjustmentListener objects.

 	processEvent(AWTEvent)

 Processes events on this scrollbar.

 	removeAdjustmentListener(AdjustmentListener)

 Removes the specified adjustment listener so that it no longer  receives adjustment events from this scrollbar..

 	setBlockIncrement(int)

 Sets the block increment for this scrollbar.

 	setLineIncrement(int)

Deprecated.

 	setMaximum(int)

 Sets the maximum value for this Scrollbar.

 	setMinimum(int)

 Sets the minimum value for this Scrollbar.

 	setOrientation(int)

 Sets the orientation for this Scrollbar.

 	setPageIncrement(int)

Deprecated.

 	setUnitIncrement(int)

 Sets the unit increment for this scrollbar.

 	setValue(int)

 Sets the value of this Scrollbar to the specified value.

 	setValues(int, int, int, int)

 Sets the values for this Scrollbar.

 	setVisibleAmount(int)

 Sets the visible amount of this Scrollbar, which is the range  of values represented by the width of the scroll bar's bubble.

 HORIZONTAL

  public final static int HORIZONTAL

 The horizontal Scrollbar variable.

 VERTICAL

  public final static int VERTICAL

 The vertical Scrollbar variable.

 Scrollbar

  public Scrollbar()

 Constructs a new vertical Scrollbar.

 Scrollbar

  public Scrollbar(int orientation)

 Constructs a new Scrollbar with the specified orientation.

Parameters:

 orientation - either Scrollbar.HORIZONTAL or Scrollbar.VERTICAL

Throws: IllegalArgumentException

 When an illegal scrollbar orientation is given.

 Scrollbar

  public Scrollbar(int orientation,
                   int value,
                   int visible,
                   int minimum,
                   int maximum)

 Constructs a new Scrollbar with the specified orientation,  value, page size, and minumum and maximum values.

Parameters:

 orientation - either Scrollbar.HORIZONTAL or Scrollbar.VERTICAL

 value - the scrollbar's value

 visible - the size of the visible portion of the  scrollable area. The scrollbar will use this value when paging up  or down by a page.

 minimum - the minimum value of the scrollbar

 maximum - the maximum value of the scrollbar

 addNotify

  public void addNotify()

 Creates the Scrollbar's peer. The peer allows you to modify  the appearance of the Scrollbar without changing any of its  functionality.

Overrides:

addNotify in class Component

 getOrientation

  public int getOrientation()

 Returns the orientation for this Scrollbar.

 setOrientation

  public synchronized void setOrientation(int orientation)

 Sets the orientation for this Scrollbar.

Parameters:

 orientation - the orientation (HORIZONTAL or VERTICAL) of  this scrollbar.

 getValue

  public int getValue()

 Returns the current value of this Scrollbar.

See Also:

getMinimum, getMaximum

 setValue

  public synchronized void setValue(int newValue)

 Sets the value of this Scrollbar to the specified value.

Parameters:

 value - the new value of the Scrollbar. If this value is  below the current minimum or above the current maximum minus  the visible amount, it becomes the new one of those values,  respectively.

See Also:

getValue

 getMinimum

  public int getMinimum()

 Returns the minimum value of this Scrollbar.

See Also:

getMaximum, getValue

 setMinimum

  public synchronized void setMinimum(int newMinimum)

 Sets the minimum value for this Scrollbar.

Parameters:

 minimum - the minimum value of the scrollbar

 getMaximum

  public int getMaximum()

 Returns the maximum value of this Scrollbar.

See Also:

getMinimum, getValue

 setMaximum

  public synchronized void setMaximum(int newMaximum)

 Sets the maximum value for this Scrollbar.

Parameters:

 maximum - the maximum value of the scrollbar

 getVisibleAmount

  public int getVisibleAmount()

 Returns the visible amount of this Scrollbar.

 getVisible

  public int getVisible()

 Note: getVisible() is deprecated. As of JDK version 1.1,  replaced by getVisibleAmount().

 setVisibleAmount

  public synchronized void setVisibleAmount(int newAmount)

 Sets the visible amount of this Scrollbar, which is the range  of values represented by the width of the scroll bar's bubble.

Parameters:

 visible - the amount visible per page

 setUnitIncrement

  public synchronized void setUnitIncrement(int v)

 Sets the unit increment for this scrollbar. This is the value  that will be added (subtracted) when the user hits the unit down  (up) gadgets.

 setLineIncrement

  public void setLineIncrement(int v)

 Note: setLineIncrement() is deprecated. As of JDK version 1.1,  replaced by setUnitIncrement(int).

 getUnitIncrement

  public int getUnitIncrement()

 Gets the unit increment for this scrollbar.

 getLineIncrement

  public int getLineIncrement()

 Note: getLineIncrement() is deprecated. As of JDK version 1.1,  replaced by getUnitIncrement().

 setBlockIncrement

  public synchronized void setBlockIncrement(int v)

 Sets the block increment for this scrollbar. This is the value  that will be added (subtracted) when the user hits the block down  (up) gadgets.

 setPageIncrement

  public void setPageIncrement(int v)

 Note: setPageIncrement() is deprecated. As of JDK version 1.1,  replaced by setBlockIncrement().

 getBlockIncrement

  public int getBlockIncrement()

 Gets the block increment for this scrollbar.

 getPageIncrement

  public int getPageIncrement()

 Note: getPageIncrement() is deprecated. As of JDK version 1.1,  replaced by getBlockIncrement().

 setValues

  public synchronized void setValues(int value,
                                     int visible,
                                     int minimum,
                                     int maximum)

 Sets the values for this Scrollbar.  This method enforces the following constraints:

•  The maximum must be greater than the minimum

•  The value must be greater than or equal to the minumum  and less than or equal to the maximum minus the  visible amount

•  The visible amount must be greater than 1 and less than or equal  to the difference between the maximum and minimum values.

 Values which do not meet these criteria are quietly coerced to the  appropriate boundary value.

Parameters:

 value - is the position in the current window.

 visible - is the amount visible per page

 minimum - is the minimum value of the scrollbar

 maximum - is the maximum value of the scrollbar

 addAdjustmentListener

  public void addAdjustmentListener(AdjustmentListener l)

 Adds the specified adjustment listener to recieve adjustment events  from this scrollbar.

Parameters:

 l - the adjustment listener

 removeAdjustmentListener

  public void removeAdjustmentListener(AdjustmentListener l)

 Removes the specified adjustment listener so that it no longer  receives adjustment events from this scrollbar..

 processEvent

  protected void processEvent(AWTEvent e)

 Processes events on this scrollbar. If the event is an  AdjustmentEvent, it invokes the processAdjustmentEvent method,  else it invokes its superclass's processEvent.

Parameters:

 e - the event

Overrides:

processEvent in class Component

 processAdjustmentEvent

  protected void processAdjustmentEvent(AdjustmentEvent e)

 Processes adjustment events occurring on this scrollbar by  dispatching them to any registered AdjustmentListener objects.  NOTE: This method will not be called unless adjustment events  are enabled for this component; this happens when one of the  following occurs:  a) An AdjustmentListener object is registered via addAdjustmentListener()  b) Adjustment events are enabled via enableEvents()

Parameters:

 e - the adjustment event

See Also:

enableEvents

 paramString

  protected String paramString()

 Returns the String parameters for this Scrollbar.

Overrides:

paramString in class Component

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.ScrollPane

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.ScrollPane

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.ScrollPane

______________________________________________________________________________

 public class ScrollPane

 extends Container

A container class which implements automatic horizontal and/or  vertical scrolling for a single child component. The display  policy for the scrollbars can be set to:

1. as needed: scrollbars created and shown only when needed by scrollpane

2. always: scrollbars created and always shown by the scrollpane

3. never: scrollbars never created or shown by the scrollpane

 The state of the positioning of the child component is represented  by two objects (one for each dimension) which implement the  Adjustable interface. The API provides methods to access those  objects such that the attributes on the Adjustable object (such as unitIncrement,  value, etc.) can be manipulated.

 Certain adjustable properties (minimum, maximum, and visibleAmount)  are set internally by the scrollpane in accordance with the geometry  of the scrollpane and its child and these should not be set by programs  using the scrollpane.

 If the scrollbar display policy is defined as "never", then the  scrollpane can still be programmatically scrolled using the  setScrollPosition() method and the scrollpane will move and clip  the child's contents appropriately. This policy is useful if the  program needs to create and manage its own adjustable controls.

 The placement of the scrollbars is controlled by platform-specific  properties set by the user outside of the program.

 The initial size of this container is set to 100x100, but can  be reset using setSize().

 Insets are used to define any space used by scrollbars and any  borders created by the scroll pane. getInsets() can be used  to get the current value for the insets. If the value of  scrollbarsAlwaysVisible is false, then the value of the insets  will change dynamically depending on whether the scrollbars are  currently visible or not.

______________________________________________________________________________

 	SCROLLBARS_ALWAYS

 Specifies that horizontal/vertical scrollbars should always be  shown regardless of the respective sizes of the scrollpane and child.

 	SCROLLBARS_AS_NEEDED

 Specifies that horizontal/vertical scrollbar should be shown  only when the size of the child exceeds the size of the scrollpane  in the horizontal/vertical dimension.

 	SCROLLBARS_NEVER

 Specifies that horizontal/vertical scrollbars should never be shown  regardless of the respective sizes of the scrollpane and child.

 	ScrollPane()

 Create a new scrollpane container with a scrollbar display policy of  "as needed".

 	ScrollPane(int)

 Create a new scrollpane container.

 	addImpl(Component, Object, int)

 Adds the specified component to this scroll pane container.

 	addNotify()

 Creates the scroll pane's peer.

 	doLayout()

 Lays out this container by resizing its child to its preferred size.

 	getHAdjustable()

 Returns the Adjustable object which represents the state of  the horizontal scrollbar.

 	getHScrollbarHeight()

 Returns the height that would be occupied by a horizontal  scrollbar, which is independent of whether it is currently  displayed by the scroll pane or not.

 	getScrollbarDisplayPolicy()

 Returns the display policy for the scrollbars.

 	getScrollPosition()

 Returns the current x,y position within the child which is displayed  at the 0,0 location of the scrolled panel's view port.

 	getVAdjustable()

 Returns the Adjustable object which represents the state of  the vertical scrollbar.

 	getViewportSize()

 Returns the current size of the scroll pane's view port.

 	getVScrollbarWidth()

 Returns the width that would be occupied by a vertical  scrollbar, which is independent of whether it is currently  displayed by the scroll pane or not.

 	layout()

Deprecated.

 	paramString()

 Returns the parameter String of this Container.

 	printComponents(Graphics)

 Prints the component in this scroll pane.

 	setLayout(LayoutManager)

 Sets the layout manager for this container.

 	setScrollPosition(int, int)

 Scrolls to the specified position within the child component.

 	setScrollPosition(Point)

 Scrolls to the specified position within the child component.

 SCROLLBARS_AS_NEEDED

  public final static int SCROLLBARS_AS_NEEDED

 Specifies that horizontal/vertical scrollbar should be shown  only when the size of the child exceeds the size of the scrollpane  in the horizontal/vertical dimension.

 SCROLLBARS_ALWAYS

  public final static int SCROLLBARS_ALWAYS

 Specifies that horizontal/vertical scrollbars should always be  shown regardless of the respective sizes of the scrollpane and child.

 SCROLLBARS_NEVER

  public final static int SCROLLBARS_NEVER

 Specifies that horizontal/vertical scrollbars should never be shown  regardless of the respective sizes of the scrollpane and child.

 ScrollPane

  public ScrollPane()

 Create a new scrollpane container with a scrollbar display policy of  "as needed".

 ScrollPane

  public ScrollPane(int scrollbarDisplayPolicy)

 Create a new scrollpane container.

Parameters:

 scrollbarDisplayPolicy - policy for when scrollbars should be shown

 addImpl

  protected final void addImpl(Component comp,
                               Object constraints,
                               int index)

 Adds the specified component to this scroll pane container.  If the scroll pane has an existing child component, that  component is removed and the new one is added.

Parameters:

 comp - the component to be added

 constraints - not applicable

 index - position of child component (must be  Overrides:

addImpl in class Container

 getScrollbarDisplayPolicy

  public int getScrollbarDisplayPolicy()

 Returns the display policy for the scrollbars.

Returns:

 the display policy for the scrollbars

 getViewportSize

  public Dimension getViewportSize()

 Returns the current size of the scroll pane's view port.

Returns:

 the size of the view port in pixels

 getHScrollbarHeight

  public int getHScrollbarHeight()

 Returns the height that would be occupied by a horizontal  scrollbar, which is independent of whether it is currently  displayed by the scroll pane or not.

Returns:

 the height of a horizontal scrollbar in pixels

 getVScrollbarWidth

  public int getVScrollbarWidth()

 Returns the width that would be occupied by a vertical  scrollbar, which is independent of whether it is currently  displayed by the scroll pane or not.

Returns:

 the width of a vertical scrollbar in pixels

 getVAdjustable

  public Adjustable getVAdjustable()

 Returns the Adjustable object which represents the state of  the vertical scrollbar. If the scrollbar display policy is "never",  this method returns null.

 getHAdjustable

  public Adjustable getHAdjustable()

 Returns the Adjustable object which represents the state of  the horizontal scrollbar. If the scrollbar display policy is "never",  this method returns null.

 setScrollPosition

  public void setScrollPosition(int x,
                                int y)

 Scrolls to the specified position within the child component.  A call to this method is only valid if the scroll pane contains  a child. Specifying a position outside of the legal scrolling bounds  of the child will scroll to the closest legal position.  Legal bounds are defined to be the rectangle:  x = 0, y = 0, width = (child width - view port width),  height = (child height - view port height).  This is a convenience method which interfaces with the Adjustable  objects which respresent the state of the scrollbars.

Parameters:

 x - the x position to scroll to

 y - the y position to scroll to

 setScrollPosition

  public void setScrollPosition(Point p)

 Scrolls to the specified position within the child component.  A call to this method is only valid if the scroll pane contains  a child and the specified position is within legal scrolling bounds  of the child. Legal bounds are defined to be the rectangle:  x = 0, y = 0, width = (child width - view port width),  height = (child height - view port height).  This is a convenience method which interfaces with the Adjustable  objects which respresent the state of the scrollbars.

Parameters:

 p - the Point representing the position to scroll to

 getScrollPosition

  public Point getScrollPosition()

 Returns the current x,y position within the child which is displayed  at the 0,0 location of the scrolled panel's view port.  This is a convenience method which interfaces with the adjustable  objects which respresent the state of the scrollbars.

Returns:

 the coordinate position for the current scroll position

 setLayout

  public final void setLayout(LayoutManager mgr)

 Sets the layout manager for this container. This method is  overridden to prevent the layout mgr from being set.

Parameters:

 mgr - the specified layout manager

Overrides:

setLayout in class Container

 doLayout

  public void doLayout()

 Lays out this container by resizing its child to its preferred size.  If the new preferred size of the child causes the current scroll  position to be invalid, the scroll position is set to the closest  valid position.

Overrides:

doLayout in class Container

See Also:

validate

 layout

  public void layout()

 Note: layout() is deprecated. As of JDK version 1.1,  replaced by doLayout().

Overrides:

layout in class Container

 printComponents

  public void printComponents(Graphics g)

 Prints the component in this scroll pane.

Parameters:

 g - the specified Graphics window

Overrides:

printComponents in class Container

See Also:

print, printAll

 addNotify

  public void addNotify()

 Creates the scroll pane's peer.

Overrides:

addNotify in class Container

 paramString

  public String paramString()

 Returns the parameter String of this Container.

Overrides:

paramString in class Container

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.awt.Shape

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.awt.Shape

 public interface Shape

The interface for objects which represent some form of geometric  shape.

 This interface will be revised in the upcoming Java2D project.  It is meant to provide a common interface for various existing  geometric AWT classes and methods which operate on them. Since  it may be superseded or expanded in the future, developers should  avoid implementing this interface in their own classes until it  is completed in a later release.

______________________________________________________________________________

 	getBounds()

 Return the bounding box of the shape.

 getBounds

  public abstract Rectangle getBounds()

 Return the bounding box of the shape.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.SystemColor

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.SystemColor

java.lang.Object
   |
   +----java.awt.Color
           |
           +----java.awt.SystemColor

______________________________________________________________________________

 public final class SystemColor

 extends Color

 implements Serializable

A class to encapsulate symbolic colors representing the color  of GUI objects on a system. For systems which support the dynamic  update of the system colors (when the user changes the colors)  the actual RGB values of these symbolic colors will also change  dynamically. In order to compare the "current" RGB value of a SystemColor  object with a non-symbolic Color object, getRGB() should be used  rather than equals().

______________________________________________________________________________

 	ACTIVE_CAPTION

 The array index for the active caption background color.

 	ACTIVE_CAPTION_BORDER

 The array index for the active caption border color.

 	ACTIVE_CAPTION_TEXT

 The array index for the action caption text color.

 	activeCaption

 The background color for captions in window borders.

 	activeCaptionBorder

 The border color for captions in window borders.

 	activeCaptionText

 The text color for captions in window borders.

 	CONTROL

 The array index for the control background color.

 	control

 The background color for control objects.

 	CONTROL_DK_SHADOW

 The array index for the control dark shadow color.

 	CONTROL_HIGHLIGHT

 The array index for the control highlight color.

 	CONTROL_LT_HIGHLIGHT

 The array index for the control light highlight color.

 	CONTROL_SHADOW

 The array index for the control shadow color.

 	CONTROL_TEXT

 The array index for the control text color.

 	controlDkShadow

 The dark shadow color for control objects.

 	controlHighlight

 The light highlight color for control objects.

 	controlLtHighlight

 The regular highlight color for control objects.

 	controlShadow

 The regular shadow color for control objects.

 	controlText

 The text color for control objects.

 	desktop

 The color of the desktop background.

 	DESKTOP

 The array index for the desktop background color.

 	INACTIVE_CAPTION

 The array index for the inactive caption background color.

 	INACTIVE_CAPTION_BORDER

 The array index for the inactive caption border color.

 	INACTIVE_CAPTION_TEXT

 The array index for the inactive caption text color.

 	inactiveCaption

 The background color for inactive captions in window borders.

 	inactiveCaptionBorder

 The border color for inactive captios in window borders.

 	inactiveCaptionText

 The text color for inactive captions in window borders.

 	INFO

 The array index for the info background color.

 	info

 The background color for info(help) text.

 	INFO_TEXT

 The array index for the info text color.

 	infoText

 The text color for info(help) text.

 	menu

 The background color for menus.

 	MENU

 The array index for the menu background color.

 	MENU_TEXT

 The array index for the menu text color.

 	menuText

 The text color for menus.

 	NUM_COLORS

 The number of system colors in the array.

 	scrollbar

 The background color for scrollbars.

 	SCROLLBAR

 The array index for the scrollbar background color.

 	TEXT

 The array index for the text background color.

 	text

 The background color for text components.

 	TEXT_HIGHLIGHT

 The array index for the text highlight color.

 	TEXT_HIGHLIGHT_TEXT

 The array index for the text highlight text color.

 	TEXT_INACTIVE_TEXT

 The array index for the text inactive text color.

 	TEXT_TEXT

 The array index for the text text color.

 	textHighlight

 The background color for highlighted text.

 	textHighlightText

 The text color for highlighted text.

 	textInactiveText

 The text color for inactive text.

 	textText

 The text color for text components.

 	WINDOW

 The array index for the window background color.

 	window

 The background color for windows.

 	WINDOW_BORDER

 The array index for the window border color.

 	WINDOW_TEXT

 The array index for the window text color.

 	windowBorder

 The border color for windows.

 	windowText

 The text color for windows.

 	getRGB()

 Gets the "current" RGB value representing the symbolic color.

 	toString()

 Returns the String representation of this Color's values.

 DESKTOP

  public final static int DESKTOP

 The array index for the desktop background color.

 ACTIVE_CAPTION

  public final static int ACTIVE_CAPTION

 The array index for the active caption background color.

 ACTIVE_CAPTION_TEXT

  public final static int ACTIVE_CAPTION_TEXT

 The array index for the action caption text color.

 ACTIVE_CAPTION_BORDER

  public final static int ACTIVE_CAPTION_BORDER

 The array index for the active caption border color.

 INACTIVE_CAPTION

  public final static int INACTIVE_CAPTION

 The array index for the inactive caption background color.

 INACTIVE_CAPTION_TEXT

  public final static int INACTIVE_CAPTION_TEXT

 The array index for the inactive caption text color.

 INACTIVE_CAPTION_BORDER

  public final static int INACTIVE_CAPTION_BORDER

 The array index for the inactive caption border color.

 WINDOW

  public final static int WINDOW

 The array index for the window background color.

 WINDOW_BORDER

  public final static int WINDOW_BORDER

 The array index for the window border color.

 WINDOW_TEXT

  public final static int WINDOW_TEXT

 The array index for the window text color.

 MENU

  public final static int MENU

 The array index for the menu background color.

 MENU_TEXT

  public final static int MENU_TEXT

 The array index for the menu text color.

 TEXT

  public final static int TEXT

 The array index for the text background color.

 TEXT_TEXT

  public final static int TEXT_TEXT

 The array index for the text text color.

 TEXT_HIGHLIGHT

  public final static int TEXT_HIGHLIGHT

 The array index for the text highlight color.

 TEXT_HIGHLIGHT_TEXT

  public final static int TEXT_HIGHLIGHT_TEXT

 The array index for the text highlight text color.

 TEXT_INACTIVE_TEXT

  public final static int TEXT_INACTIVE_TEXT

 The array index for the text inactive text color.

 CONTROL

  public final static int CONTROL

 The array index for the control background color.

 CONTROL_TEXT

  public final static int CONTROL_TEXT

 The array index for the control text color.

 CONTROL_HIGHLIGHT

  public final static int CONTROL_HIGHLIGHT

 The array index for the control highlight color.

 CONTROL_LT_HIGHLIGHT

  public final static int CONTROL_LT_HIGHLIGHT

 The array index for the control light highlight color.

 CONTROL_SHADOW

  public final static int CONTROL_SHADOW

 The array index for the control shadow color.

 CONTROL_DK_SHADOW

  public final static int CONTROL_DK_SHADOW

 The array index for the control dark shadow color.

 SCROLLBAR

  public final static int SCROLLBAR

 The array index for the scrollbar background color.

 INFO

  public final static int INFO

 The array index for the info background color.

 INFO_TEXT

  public final static int INFO_TEXT

 The array index for the info text color.

 NUM_COLORS

  public final static int NUM_COLORS

 The number of system colors in the array.

 desktop

  public final static SystemColor desktop

 The color of the desktop background.

 activeCaption

  public final static SystemColor activeCaption

 The background color for captions in window borders.

 activeCaptionText

  public final static SystemColor activeCaptionText

 The text color for captions in window borders.

 activeCaptionBorder

  public final static SystemColor activeCaptionBorder

 The border color for captions in window borders.

 inactiveCaption

  public final static SystemColor inactiveCaption

 The background color for inactive captions in window borders.

 inactiveCaptionText

  public final static SystemColor inactiveCaptionText

 The text color for inactive captions in window borders.

 inactiveCaptionBorder

  public final static SystemColor inactiveCaptionBorder

 The border color for inactive captios in window borders.

 window

  public final static SystemColor window

 The background color for windows.

 windowBorder

  public final static SystemColor windowBorder

 The border color for windows.

 windowText

  public final static SystemColor windowText

 The text color for windows.

 menu

  public final static SystemColor menu

 The background color for menus.

 menuText

  public final static SystemColor menuText

 The text color for menus.

 text

  public final static SystemColor text

 The background color for text components.

 textText

  public final static SystemColor textText

 The text color for text components.

 textHighlight

  public final static SystemColor textHighlight

 The background color for highlighted text.

 textHighlightText

  public final static SystemColor textHighlightText

 The text color for highlighted text.

 textInactiveText

  public final static SystemColor textInactiveText

 The text color for inactive text.

 control

  public final static SystemColor control

 The background color for control objects.

 controlText

  public final static SystemColor controlText

 The text color for control objects.

 controlHighlight

  public final static SystemColor controlHighlight

 The light highlight color for control objects.

 controlLtHighlight

  public final static SystemColor controlLtHighlight

 The regular highlight color for control objects.

 controlShadow

  public final static SystemColor controlShadow

 The regular shadow color for control objects.

 controlDkShadow

  public final static SystemColor controlDkShadow

 The dark shadow color for control objects.

 scrollbar

  public final static SystemColor scrollbar

 The background color for scrollbars.

 info

  public final static SystemColor info

 The background color for info(help) text.

 infoText

  public final static SystemColor infoText

 The text color for info(help) text.

 getRGB

  public int getRGB()

 Gets the "current" RGB value representing the symbolic color.  (Bits 24-31 are 0xff, 16-23 are red, 8-15 are green, 0-7 are blue).

Overrides:

getRGB in class Color

See Also:

getRGBdefault, getBlue, getGreen, getRed

 toString

  public String toString()

 Returns the String representation of this Color's values.

Overrides:

toString in class Color

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.TextArea

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.TextArea

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.TextComponent
                   |
                   +----java.awt.TextArea

______________________________________________________________________________

 public class TextArea

 extends TextComponent

A TextArea object is a multi-line area that displays text. It can  be set to allow editing or read-only modes.

______________________________________________________________________________

 	SCROLLBARS_BOTH

 Create and display both vertical and horizontal scrollbars.

 	SCROLLBARS_HORIZONTAL_ONLY

 Create and display horizontal scrollbar only.

 	SCROLLBARS_NONE

 Do not create or display any scrollbars for the text area.

 	SCROLLBARS_VERTICAL_ONLY

 Create and display vertical scrollbar only.

 	TextArea()

 Constructs a new TextArea.

 	TextArea(int, int)

 Constructs a new empty TextArea with the specified number of  rows and columns.

 	TextArea(String)

 Constructs a new TextArea with the specified text displayed.

 	TextArea(String, int, int)

 Constructs a new TextArea with the specified text and number  of rows and columns.

 	TextArea(String, int, int, int)

 Constructs a new TextArea with the specified text and number  of rows, columns, and scrollbar visibility.

 	addNotify()

 Creates the TextArea's peer.

 	append(String)

 Appends the given text to the end.

 	appendText(String)

Deprecated.

 	getColumns()

 Returns the number of columns in the TextArea.

 	getMinimumSize()

 Returns the minimum size Dimensions of the TextArea.

 	getMinimumSize(int, int)

 Returns the specified minimum size Dimensions of the TextArea.

 	getPreferredSize()

 Returns the preferred size Dimensions of the TextArea.

 	getPreferredSize(int, int)

 Returns the specified row and column Dimensions of the TextArea.

 	getRows()

 Returns the number of rows in the TextArea.

 	getScrollbarVisibility()

 Returns the enumerated value describing which scrollbars  the text area has.

 	insert(String, int)

 Inserts the specified text at the specified position.

 	insertText(String, int)

Deprecated.

 	minimumSize()

Deprecated.

 	minimumSize(int, int)

Deprecated.

 	paramString()

 Returns the String of parameters for this TextArea.

 	preferredSize()

Deprecated.

 	preferredSize(int, int)

Deprecated.

 	replaceRange(String, int, int)

 Replaces text from the indicated start to end position with the  new text specified.

 	replaceText(String, int, int)

Deprecated.

 	setColumns(int)

 Sets the number of columns for this TextArea.

 	setRows(int)

 Sets the number of rows for this TextArea.

 SCROLLBARS_BOTH

  public final static int SCROLLBARS_BOTH

 Create and display both vertical and horizontal scrollbars.

 SCROLLBARS_VERTICAL_ONLY

  public final static int SCROLLBARS_VERTICAL_ONLY

 Create and display vertical scrollbar only.

 SCROLLBARS_HORIZONTAL_ONLY

  public final static int SCROLLBARS_HORIZONTAL_ONLY

 Create and display horizontal scrollbar only.

 SCROLLBARS_NONE

  public final static int SCROLLBARS_NONE

 Do not create or display any scrollbars for the text area.

 TextArea

  public TextArea()

 Constructs a new TextArea.

 TextArea

  public TextArea(String text)

 Constructs a new TextArea with the specified text displayed.

Parameters:

 text - the text to be displayed

 TextArea

  public TextArea(int rows,
                  int columns)

 Constructs a new empty TextArea with the specified number of  rows and columns.

Parameters:

 rows - the number of rows

 columns - the number of columns

 TextArea

  public TextArea(String text,
                  int rows,
                  int columns)

 Constructs a new TextArea with the specified text and number  of rows and columns.

Parameters:

 text - the text to be displayed

 rows - the number of rows

 columns - the number of columns

 TextArea

  public TextArea(String text,
                  int rows,
                  int columns,
                  int scrollbars)

 Constructs a new TextArea with the specified text and number  of rows, columns, and scrollbar visibility.

Parameters:

 text - the text to be displayed

 rows - the number of rows

 columns - the number of columns

 scrollbars - the visibility of scrollbars

 addNotify

  public void addNotify()

 Creates the TextArea's peer. The peer allows us to modify  the appearance of the TextArea without changing any of its  functionality.

Overrides:

addNotify in class Component

 insert

  public synchronized void insert(String str,
                                  int pos)

 Inserts the specified text at the specified position.

Parameters:

 str - the text to insert.

 pos - the position at which to insert.

See Also:

setText, replaceRange

 insertText

  public void insertText(String str,
                         int pos)

 Note: insertText() is deprecated. As of JDK version 1.1,  replaced by insert(String, int).

 append

  public synchronized void append(String str)

 Appends the given text to the end.

Parameters:

 str - the text to insert

See Also:

insert

 appendText

  public void appendText(String str)

 Note: appendText() is deprecated. As of JDK version 1.1,  replaced by append(String).

 replaceRange

  public synchronized void replaceRange(String str,
                                        int start,
                                        int end)

 Replaces text from the indicated start to end position with the  new text specified.

Parameters:

 str - the text to use as the replacement.

 start - the start position.

 end - the end position.

See Also:

insert, replaceRange

 replaceText

  public void replaceText(String str,
                          int start,
                          int end)

 Note: replaceText() is deprecated. As of JDK version 1.1,  replaced by replaceRange(String, int, int).

 getRows

  public int getRows()

 Returns the number of rows in the TextArea.

 setRows

  public void setRows(int rows)

 Sets the number of rows for this TextArea.

Parameters:

 rows - the number of rows

Throws: IllegalArgumentException

 If rows is less than 0.

 getColumns

  public int getColumns()

 Returns the number of columns in the TextArea.

 setColumns

  public void setColumns(int columns)

 Sets the number of columns for this TextArea.

Parameters:

 columns - the number of columns

Throws: IllegalArgumentException

 If columns is less than 0.

 getScrollbarVisibility

  public int getScrollbarVisibility()

 Returns the enumerated value describing which scrollbars  the text area has.

Returns:

 the display policy for the scrollbars

 getPreferredSize

  public Dimension getPreferredSize(int rows,
                                    int columns)

 Returns the specified row and column Dimensions of the TextArea.

Parameters:

 rows - the preferred rows amount

 columns - the preferred columns amount

 preferredSize

  public Dimension preferredSize(int rows,
                                 int columns)

 Note: preferredSize() is deprecated. As of JDK version 1.1,  replaced by getPreferredSize(int, int).

 getPreferredSize

  public Dimension getPreferredSize()

 Returns the preferred size Dimensions of the TextArea.

Overrides:

getPreferredSize in class Component

 preferredSize

  public Dimension preferredSize()

 Note: preferredSize() is deprecated. As of JDK version 1.1,  replaced by getPreferredSize().

Overrides:

preferredSize in class Component

 getMinimumSize

  public Dimension getMinimumSize(int rows,
                                  int columns)

 Returns the specified minimum size Dimensions of the TextArea.

Parameters:

 rows - the minimum row size

 columns - the minimum column size

 minimumSize

  public Dimension minimumSize(int rows,
                               int columns)

 Note: minimumSize() is deprecated. As of JDK version 1.1,  replaced by getMinimumSize(int, int).

 getMinimumSize

  public Dimension getMinimumSize()

 Returns the minimum size Dimensions of the TextArea.

Overrides:

getMinimumSize in class Component

 minimumSize

  public Dimension minimumSize()

 Note: minimumSize() is deprecated. As of JDK version 1.1,  replaced by getMinimumSize().

Overrides:

minimumSize in class Component

 paramString

  protected String paramString()

 Returns the String of parameters for this TextArea.

Overrides:

paramString in class TextComponent

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.TextComponent

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.TextComponent

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.TextComponent

______________________________________________________________________________

 public class TextComponent

 extends Component

A TextComponent is a component that allows the editing of some text.

______________________________________________________________________________

 	textListener

 	addTextListener(TextListener)

 Adds the specified text event listener to recieve text events  from this textcomponent.

 	getCaretPosition()

 Returns the position of the text insertion caret for the  text component.

 	getSelectedText()

 Returns the selected text contained in this TextComponent.

 	getSelectionEnd()

 Returns the selected text's end position.

 	getSelectionStart()

 Returns the selected text's start position.

 	getText()

 Returns the text contained in this TextComponent.

 	isEditable()

 Returns the boolean indicating whether this TextComponent is  editable or not.

 	paramString()

 Returns the String of parameters for this TextComponent.

 	processEvent(AWTEvent)

 Processes events on this textcomponent.

 	processTextEvent(TextEvent)

 Processes text events occurring on this text component by  dispatching them to any registered TextListener objects.

 	removeNotify()

 Removes the TextComponent's peer.

 	removeTextListener(TextListener)

 Removes the specified text event listener so that it no longer  receives text events from this textcomponent

 	select(int, int)

 Selects the text found between the specified start and end locations.

 	selectAll()

 Selects all the text in the TextComponent.

 	setCaretPosition(int)

 Sets the position of the text insertion caret for the TextComponent

 	setEditable(boolean)

 Sets the specified boolean to indicate whether or not this  TextComponent should be editable.

 	setSelectionEnd(int)

 Sets the selection end to the specified position.

 	setSelectionStart(int)

 Sets the selection start to the specified position.

 	setText(String)

 Sets the text of this TextComponent to the specified text.

 textListener

  protected transient TextListener textListener

 removeNotify

  public void removeNotify()

 Removes the TextComponent's peer. The peer allows us to modify  the appearance of the TextComponent without changing its  functionality.

Overrides:

removeNotify in class Component

 setText

  public synchronized void setText(String t)

 Sets the text of this TextComponent to the specified text.

Parameters:

 t - the new text to be set

See Also:

getText

 getText

  public synchronized String getText()

 Returns the text contained in this TextComponent.

See Also:

setText

 getSelectedText

  public synchronized String getSelectedText()

 Returns the selected text contained in this TextComponent.

See Also:

setText

 isEditable

  public boolean isEditable()

 Returns the boolean indicating whether this TextComponent is  editable or not.

See Also:

setEditable

 setEditable

  public synchronized void setEditable(boolean b)

 Sets the specified boolean to indicate whether or not this  TextComponent should be editable.

Parameters:

 b - the boolean to be set

See Also:

isEditable

 getSelectionStart

  public synchronized int getSelectionStart()

 Returns the selected text's start position.

 setSelectionStart

  public synchronized void setSelectionStart(int selectionStart)

 Sets the selection start to the specified position. The new  starting point is constrained to be before or at the current  selection end.

Parameters:

 selectionStart - the start position of the text

 getSelectionEnd

  public synchronized int getSelectionEnd()

 Returns the selected text's end position.

 setSelectionEnd

  public synchronized void setSelectionEnd(int selectionEnd)

 Sets the selection end to the specified position. The new  end point is constrained to be at or after the current  selection start.

Parameters:

 selectionEnd - the start position of the text

 select

  public synchronized void select(int selectionStart,
                                  int selectionEnd)

 Selects the text found between the specified start and end locations.

Parameters:

 selectionStart - the start position of the text

 selectionEnd - the end position of the text

 selectAll

  public synchronized void selectAll()

 Selects all the text in the TextComponent.

 setCaretPosition

  public void setCaretPosition(int position)

 Sets the position of the text insertion caret for the TextComponent

Parameters:

 position - the position

Throws: IllegalArgumentException

 If position is less than 0.

 getCaretPosition

  public int getCaretPosition()

 Returns the position of the text insertion caret for the  text component.

Returns:

 the position of the text insertion caret for the text component.

 addTextListener

  public void addTextListener(TextListener l)

 Adds the specified text event listener to recieve text events  from this textcomponent.

Parameters:

 l - the text event listener

 removeTextListener

  public void removeTextListener(TextListener l)

 Removes the specified text event listener so that it no longer  receives text events from this textcomponent

 processEvent

  protected void processEvent(AWTEvent e)

 Processes events on this textcomponent. If the event is a  TextEvent, it invokes the processTextEvent method,  else it invokes its superclass's processEvent.

Parameters:

 e - the event

Overrides:

processEvent in class Component

 processTextEvent

  protected void processTextEvent(TextEvent e)

 Processes text events occurring on this text component by  dispatching them to any registered TextListener objects.  NOTE: This method will not be called unless text events  are enabled for this component; this happens when one of the  following occurs:  a) A TextListener object is registered via addTextListener()  b) Text events are enabled via enableEvents()

Parameters:

 e - the text event

See Also:

enableEvents

 paramString

  protected String paramString()

 Returns the String of parameters for this TextComponent.

Overrides:

paramString in class Component

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.TextField

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.TextField

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.TextComponent
                   |
                   +----java.awt.TextField

______________________________________________________________________________

 public class TextField

 extends TextComponent

TextField is a component that allows the editing of a single line of text.

______________________________________________________________________________

 	TextField()

 Constructs a new TextField.

 	TextField(int)

 Constructs a new empty TextField with the specified number of columns.

 	TextField(String)

 Constructs a new TextField initialized with the specified text.

 	TextField(String, int)

 Constructs a new TextField initialized with the specified text  and columns.

 	addActionListener(ActionListener)

 Adds the specified action listener to recieve  action events from this textfield.

 	addNotify()

 Creates the TextField's peer.

 	echoCharIsSet()

 Returns true if this TextField has a character set for  echoing.

 	getColumns()

 Returns the number of columns in this TextField.

 	getEchoChar()

 Returns the character to be used for echoing.

 	getMinimumSize()

 Returns the minimum size Dimensions needed for this TextField.

 	getMinimumSize(int)

 Returns the minimum size Dimensions needed for this TextField  with the specified amount of columns.

 	getPreferredSize()

 Returns the preferred size Dimensions needed for this TextField.

 	getPreferredSize(int)

 Returns the preferred size Dimensions needed for this TextField  with the specified amount of columns.

 	minimumSize()

Deprecated.

 	minimumSize(int)

Deprecated.

 	paramString()

 Returns the String of parameters for this TextField.

 	preferredSize()

Deprecated.

 	preferredSize(int)

Deprecated.

 	processActionEvent(ActionEvent)

 Processes action events occurring on this textfield by  dispatching them to any registered ActionListener objects.

 	processEvent(AWTEvent)

 Processes events on this textfield.

 	removeActionListener(ActionListener)

 Removes the specified action listener so that it no longer  receives action events from this textfield.

 	setColumns(int)

 Sets the number of columns in this TextField.

 	setEchoChar(char)

 Sets the echo character for this TextField.

 	setEchoCharacter(char)

Deprecated.

 TextField

  public TextField()

 Constructs a new TextField.

 TextField

  public TextField(String text)

 Constructs a new TextField initialized with the specified text.

Parameters:

 text - the text to be displayed

 TextField

  public TextField(int columns)

 Constructs a new empty TextField with the specified number of columns.

Parameters:

 columns - the number of columns

 TextField

  public TextField(String text,
                   int columns)

 Constructs a new TextField initialized with the specified text  and columns.

Parameters:

 text - the text to be displayed

 columns - the number of columns

 addNotify

  public void addNotify()

 Creates the TextField's peer. The peer allows us to modify the  appearance of the TextField without changing its functionality.

Overrides:

addNotify in class Component

 getEchoChar

  public char getEchoChar()

 Returns the character to be used for echoing.

See Also:

setEchoChar, echoCharIsSet

 setEchoChar

  public void setEchoChar(char c)

 Sets the echo character for this TextField. This is useful for  fields where the user input shouldn't be echoed to the screen,  as in the case of a TextField that represents a password.

Parameters:

 c - the echo character for this TextField

See Also:

echoCharIsSet, getEchoChar

 setEchoCharacter

  public void setEchoCharacter(char c)

 Note: setEchoCharacter() is deprecated. As of JDK version 1.1,  replaced by setEchoChar(char).

 echoCharIsSet

  public boolean echoCharIsSet()

 Returns true if this TextField has a character set for  echoing.

See Also:

setEchoChar, getEchoChar

 getColumns

  public int getColumns()

 Returns the number of columns in this TextField.

 setColumns

  public void setColumns(int columns)

 Sets the number of columns in this TextField.

Parameters:

 columns - the number of columns

Throws: IllegalArgumentException

 If columns is less than 0.

 getPreferredSize

  public Dimension getPreferredSize(int columns)

 Returns the preferred size Dimensions needed for this TextField  with the specified amount of columns.

Parameters:

 columns - the number of columns in this TextField

 preferredSize

  public Dimension preferredSize(int columns)

 Note: preferredSize() is deprecated. As of JDK version 1.1,  replaced by getPreferredSize(int).

 getPreferredSize

  public Dimension getPreferredSize()

 Returns the preferred size Dimensions needed for this TextField.

Overrides:

getPreferredSize in class Component

 preferredSize

  public Dimension preferredSize()

 Note: preferredSize() is deprecated. As of JDK version 1.1,  replaced by getPreferredSize().

Overrides:

preferredSize in class Component

 getMinimumSize

  public Dimension getMinimumSize(int columns)

 Returns the minimum size Dimensions needed for this TextField  with the specified amount of columns.

Parameters:

 columns - the number of columns in this TextField

 minimumSize

  public Dimension minimumSize(int columns)

 Note: minimumSize() is deprecated. As of JDK version 1.1,  replaced by getMinimumSize(int).

 getMinimumSize

  public Dimension getMinimumSize()

 Returns the minimum size Dimensions needed for this TextField.

Overrides:

getMinimumSize in class Component

 minimumSize

  public Dimension minimumSize()

 Note: minimumSize() is deprecated. As of JDK version 1.1,  replaced by getMinimumSize().

Overrides:

minimumSize in class Component

 addActionListener

  public void addActionListener(ActionListener l)

 Adds the specified action listener to recieve  action events from this textfield.

Parameters:

 l - the action listener

 removeActionListener

  public void removeActionListener(ActionListener l)

 Removes the specified action listener so that it no longer  receives action events from this textfield.

Parameters:

 l - the action listener

 processEvent

  protected void processEvent(AWTEvent e)

 Processes events on this textfield. If the event is an ActionEvent,  it invokes the processActionEvent method, else it invokes its  superclass's processEvent.

Parameters:

 e - the event

Overrides:

processEvent in class TextComponent

 processActionEvent

  protected void processActionEvent(ActionEvent e)

 Processes action events occurring on this textfield by  dispatching them to any registered ActionListener objects.  NOTE: This method will not be called unless action events  are enabled for this component; this happens when one of the  following occurs:  a) An ActionListener object is registered via addActionListener()  b) Action events are enabled via enableEvents()

Parameters:

 e - the action event

See Also:

enableEvents

 paramString

  protected String paramString()

 Returns the String of parameters for this TextField.

Overrides:

paramString in class TextComponent

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Toolkit

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Toolkit

java.lang.Object
   |
   +----java.awt.Toolkit

______________________________________________________________________________

 public class Toolkit

 extends Object

An AWT toolkit. It is used to bind the abstract AWT classes  to a particular native toolkit implementation.

______________________________________________________________________________

 	Toolkit()

 	beep()

 Emits an audio beep.

 	checkImage(Image, int, int, ImageObserver)

 Returns the status of the construction of the indicated method  at the indicated width and height for the default screen.

 	createButton(Button)

 Uses the specified Peer interface to create a new Button.

 	createCanvas(Canvas)

 Uses the specified Peer interface to create a new Canvas.

 	createCheckbox(Checkbox)

 Uses the specified Peer interface to create a new Checkbox.

 	createCheckboxMenuItem(CheckboxMenuItem)

 Uses the specified Peer interface to create a new CheckboxMenuItem.

 	createChoice(Choice)

 Uses the specified Peer interface to create a new Choice.

 	createComponent(Component)

 Creates a peer for a component or container.

 	createDialog(Dialog)

 Uses the specified Peer interface to create a new Dialog.

 	createFileDialog(FileDialog)

 Uses the specified Peer interface to create a new FileDialog.

 	createFrame(Frame)

 Uses the specified Peer interface to create a new Frame.

 	createImage(byte[])

 Creates an image which decodes the image stored in the specified  byte array.

 	createImage(byte[], int, int)

 Creates an image which decodes the image stored in the specified  byte array at the specified offset and length.

 	createImage(ImageProducer)

 Creates an image with the specified image producer.

 	createLabel(Label)

 Uses the specified Peer interface to create a new Label.

 	createList(List)

 Uses the specified Peer interface to create a new List.

 	createMenu(Menu)

 Uses the specified Peer interface to create a new Menu.

 	createMenuBar(MenuBar)

 Uses the specified Peer interface to create a new MenuBar.

 	createMenuItem(MenuItem)

 Uses the specified Peer interface to create a new MenuItem.

 	createPanel(Panel)

 Uses the specified Peer interface to create a new Panel.

 	createPopupMenu(PopupMenu)

 Uses the specified Peer interface to create a new PopupMenu.

 	createScrollbar(Scrollbar)

 Uses the specified Peer interface to create a new Scrollbar.

 	createScrollPane(ScrollPane)

 Uses the specified Peer interface to create a new scrolling container.

 	createTextArea(TextArea)

 Uses the specified Peer interface to create a new TextArea.

 	createTextField(TextField)

 Uses the specified Peer interface to create a new TextField.

 	createWindow(Window)

 Uses the specified Peer interface to create a new Window.

 	getColorModel()

 Returns the ColorModel of the screen.

 	getDefaultToolkit()

 Returns the default toolkit.

 	getFontList()

 Returns the names of the available fonts.

 For 1.1, the following font names are deprecated (the replacement  name follows):

• TimesRoman (use Serif)

• Helvetica (use SansSerif)

• Courier (use Monospaced)

 The ZapfDingbats font is also deprecated in 1.1, but only as a  separate fontname.

 	getFontMetrics(Font)

 Returns the screen metrics of the font.

 	getFontPeer(String, int)

 Uses the specified Peer interface to create a new Font.

 	getImage(String)

 Returns an image which gets pixel data from the specified file.

 	getImage(URL)

 Returns an image which gets pixel data from the specified URL.

 	getMenuShortcutKeyMask()

 Return the Event modifier mask appropriate for shortcuts.

 	getNativeContainer(Component)

 Give native peers the ability to query the native container  given a native component (eg the direct parent may be lightweight).

 	getPrintJob(Frame, String, Properties)

 Returns a PrintJob object which is the result of initiating  a print operation on the toolkit's platform.

 	getProperty(String, String)

 Gets a property with the specified key and default.

 	getScreenResolution()

 Returns the screen resolution in dots-per-inch.

 	getScreenSize()

 Gets the size of the screen.

 	getSystemClipboard()

 Returns an instance of the "system" clipboard which interfaces with  the clipboard facilities on the native platform.

 	getSystemEventQueue()

 Get the application's or applet's EventQueue instance.

 	getSystemEventQueueImpl()

  	loadSystemColors(int[])

 Fills in the provided int array with the current system color values

 	prepareImage(Image, int, int, ImageObserver)

 Prepares an image for rendering on the default screen at the  specified width and height.

 	sync()

 Syncs the graphics state; useful when doing animation.

 Toolkit

  public Toolkit()

 createButton

  protected abstract ButtonPeer createButton(Button target)

 Uses the specified Peer interface to create a new Button.

Parameters:

 target - the Button to be created

 createTextField

  protected abstract TextFieldPeer createTextField(TextField target)

 Uses the specified Peer interface to create a new TextField.

Parameters:

 target - the TextField to be created

 createLabel

  protected abstract LabelPeer createLabel(Label target)

 Uses the specified Peer interface to create a new Label.

Parameters:

 target - the Label to be created

 createList

  protected abstract ListPeer createList(List target)

 Uses the specified Peer interface to create a new List.

Parameters:

 target - the List to be created

 createCheckbox

  protected abstract CheckboxPeer createCheckbox(Checkbox target)

 Uses the specified Peer interface to create a new Checkbox.

Parameters:

 target - the Checkbox to be created

 createScrollbar

  protected abstract ScrollbarPeer createScrollbar(Scrollbar target)

 Uses the specified Peer interface to create a new Scrollbar.

Parameters:

 target - the Scrollbar to be created

 createScrollPane

  protected abstract ScrollPanePeer createScrollPane(ScrollPane target)

 Uses the specified Peer interface to create a new scrolling container.

Parameters:

 target - the ScrollPane to be created

 createTextArea

  protected abstract TextAreaPeer createTextArea(TextArea target)

 Uses the specified Peer interface to create a new TextArea.

Parameters:

 target - the TextArea to be created

 createChoice

  protected abstract ChoicePeer createChoice(Choice target)

 Uses the specified Peer interface to create a new Choice.

Parameters:

 target - the Choice to be created

 createFrame

  protected abstract FramePeer createFrame(Frame target)

 Uses the specified Peer interface to create a new Frame.

Parameters:

 target - the Frame to be created

 createCanvas

  protected abstract CanvasPeer createCanvas(Canvas target)

 Uses the specified Peer interface to create a new Canvas.

Parameters:

 target - the Canvas to be created

 createPanel

  protected abstract PanelPeer createPanel(Panel target)

 Uses the specified Peer interface to create a new Panel.

Parameters:

 target - the Panel to be created

 createWindow

  protected abstract WindowPeer createWindow(Window target)

 Uses the specified Peer interface to create a new Window.

Parameters:

 target - the Window to be created

 createDialog

  protected abstract DialogPeer createDialog(Dialog target)

 Uses the specified Peer interface to create a new Dialog.

Parameters:

 target - the Dialog to be created

 createMenuBar

  protected abstract MenuBarPeer createMenuBar(MenuBar target)

 Uses the specified Peer interface to create a new MenuBar.

Parameters:

 target - the MenuBar to be created

 createMenu

  protected abstract MenuPeer createMenu(Menu target)

 Uses the specified Peer interface to create a new Menu.

Parameters:

 target - the Menu to be created

 createPopupMenu

  protected abstract PopupMenuPeer createPopupMenu(PopupMenu target)

 Uses the specified Peer interface to create a new PopupMenu.

Parameters:

 target - the PopupMenu to be created

 createMenuItem

  protected abstract MenuItemPeer createMenuItem(MenuItem target)

 Uses the specified Peer interface to create a new MenuItem.

Parameters:

 target - the MenuItem to be created

 createFileDialog

  protected abstract FileDialogPeer createFileDialog(FileDialog target)

 Uses the specified Peer interface to create a new FileDialog.

Parameters:

 target - the FileDialog to be created

 createCheckboxMenuItem

  protected abstract CheckboxMenuItemPeer createCheckboxMenuItem(CheckboxMenuItem  target)

 Uses the specified Peer interface to create a new CheckboxMenuItem.

Parameters:

 target - the CheckboxMenuItem to be created

 createComponent

  protected LightweightPeer createComponent(Component target)

 Creates a peer for a component or container. This peer is windowless  and allows the Component and Container classes to be extended directly  to create windowless components that are defined entirely in java.

Parameters:

 target - The Component to be created.

 getFontPeer

  protected abstract FontPeer getFontPeer(String name,
                                          int style)

 Uses the specified Peer interface to create a new Font.

Parameters:

 name - the font name

 style - style the constant style used

 loadSystemColors

  protected void loadSystemColors(int systemColors[])

 Fills in the provided int array with the current system color values

 getScreenSize

  public abstract Dimension getScreenSize()

 Gets the size of the screen.

 getScreenResolution

  public abstract int getScreenResolution()

 Returns the screen resolution in dots-per-inch.

 getColorModel

  public abstract ColorModel getColorModel()

 Returns the ColorModel of the screen.

 getFontList

  public abstract String[] getFontList()

 Returns the names of the available fonts.

 For 1.1, the following font names are deprecated (the replacement  name follows):

• TimesRoman (use Serif)

• Helvetica (use SansSerif)

• Courier (use Monospaced)

 The ZapfDingbats font is also deprecated in 1.1, but only as a  separate fontname. Unicode defines the ZapfDingbat characters  starting at ?, and as of 1.1 Java supports those characters.

 getFontMetrics

  public abstract FontMetrics getFontMetrics(Font font)

 Returns the screen metrics of the font.

 sync

  public abstract void sync()

 Syncs the graphics state; useful when doing animation.

 getDefaultToolkit

  public static synchronized Toolkit getDefaultToolkit()

 Returns the default toolkit. This is controlled by the  "awt.toolkit" property.

Throws: AWTError

 Toolkit not found or could not be instantiated.

 getImage

  public abstract Image getImage(String filename)

 Returns an image which gets pixel data from the specified file.

Parameters:

 filename - the file containing the pixel data in one of  the recognized file formats

 getImage

  public abstract Image getImage(URL url)

 Returns an image which gets pixel data from the specified URL.

Parameters:

 url - the URL to use in fetching the pixel data

 prepareImage

  public abstract boolean prepareImage(Image image,
                                       int width,
                                       int height,
                                       ImageObserver observer)

 Prepares an image for rendering on the default screen at the  specified width and height.

 checkImage

  public abstract int checkImage(Image image,
                                 int width,
                                 int height,
                                 ImageObserver observer)

 Returns the status of the construction of the indicated method  at the indicated width and height for the default screen.

 createImage

  public abstract Image createImage(ImageProducer producer)

 Creates an image with the specified image producer.

Parameters:

 producer - the image producer to be used

 createImage

  public Image createImage(byte imagedata[])

 Creates an image which decodes the image stored in the specified  byte array.  The data must be in some image format supported by the toolkit  (such as GIF or JPEG).

Parameters:

 imagedata - the array of image data in a supported image format

 createImage

  public abstract Image createImage(byte imagedata[],
                                    int imageoffset,
                                    int imagelength)

 Creates an image which decodes the image stored in the specified  byte array at the specified offset and length.  The data must be in some image format supported by the toolkit  (such as GIF or JPEG).

Parameters:

 imagedata - the array of image data in a supported image format

 imageoffset - the offset of the start of the data in the array

 imagelength - the length of the data in the array

 getPrintJob

  public abstract PrintJob getPrintJob(Frame frame,
                                       String jobtitle,
                                       Properties props)

 Returns a PrintJob object which is the result of initiating  a print operation on the toolkit's platform. Returns null if  the user cancelled print job.

 beep

  public abstract void beep()

 Emits an audio beep.

 getSystemClipboard

  public abstract Clipboard getSystemClipboard()

 Returns an instance of the "system" clipboard which interfaces with  the clipboard facilities on the native platform. This clipboard enables  data transfer between java programs and native platform applications  which use these native clipboard facilities.

 getMenuShortcutKeyMask

  public int getMenuShortcutKeyMask()

 Return the Event modifier mask appropriate for shortcuts.  Toolkit implementation should override this method if the  CONTROL key isn't the correct key for accelerators.

 getNativeContainer

  protected static Container getNativeContainer(Component c)

 Give native peers the ability to query the native container  given a native component (eg the direct parent may be lightweight).

 getProperty

  public static String getProperty(String key,
                                   String defaultValue)

 Gets a property with the specified key and default.  This method returns defaultValue if the property is not found.

 getSystemEventQueue

  public final EventQueue getSystemEventQueue()

 Get the application's or applet's EventQueue instance.  Depending on the Toolkit implementation, different EventQueues  may be returned for different applets. Applets should  therefore not assume that the EventQueue instance returned  by this method will be shared by other applets or the system.

 getSystemEventQueueImpl

  protected abstract EventQueue getSystemEventQueueImpl()

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.awt.Window

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.awt.Window

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Window

______________________________________________________________________________

 public class Window

 extends Container

A Window is a top-level window with no borders and no  menubar. It could be used to implement a pop-up menu.  The default layout for a window is BorderLayout.  Windows are capable of generating the following window events:  WindowOpened, WindowClosed.

See Also:

WindowEvent, addWindowListener

______________________________________________________________________________

 	Window(Frame)

 Constructs a new Window initialized to an invisible state.

 	addNotify()

 Creates the Window's peer.

 	addWindowListener(WindowListener)

 Adds the specified window listener to receive window events from  this window.

 	dispose()

 Disposes of the Window.

 	getFocusOwner()

 Returns the child component of this Window which has focus if and  only if this Window is active.

 	getLocale()

 Gets the Locale for the window, if it has been set.

 	getToolkit()

 Returns the toolkit of this frame.

 	getWarningString()

 Gets the warning string for this window.

 	isShowing()

 Checks if this Window is showing on screen.

 	pack()

 Packs the components of the Window.

 	postEvent(Event)

Deprecated.

 	processEvent(AWTEvent)

 Processes events on this window.

 	processWindowEvent(WindowEvent)

 Processes window events occurring on this window by  dispatching them to any registered WindowListener objects.

 	removeWindowListener(WindowListener)

 Removes the specified window listener so that it no longer  receives window events from this window.

 	show()

 Shows the Window.

 	toBack()

 Places this window at the bottom of the stacking order and  makes the corresponding adjustment to other visible windows.

 	toFront()

 Places this window at the top of the stacking order and  shows it in front of any other windows.

 Window

  public Window(Frame parent)

 Constructs a new Window initialized to an invisible state. It  behaves as a modal dialog in that it will block input to other  windows when shown.

Parameters:

 parent - the owner of the dialog

See Also:

setSize, show

 addNotify

  public void addNotify()

 Creates the Window's peer. The peer allows us to modify the  appearance of the Window without changing its functionality.

Overrides:

addNotify in class Container

 pack

  public void pack()

 Packs the components of the Window.

 show

  public void show()

 Shows the Window. This will bring the window to the  front if the window is already visible.

Overrides:

show in class Component

See Also:

hide

 dispose

  public void dispose()

 Disposes of the Window. This method must  be called to release the resources that  are used for the window.

 toFront

  public void toFront()

 Places this window at the top of the stacking order and  shows it in front of any other windows.

 toBack

  public void toBack()

 Places this window at the bottom of the stacking order and  makes the corresponding adjustment to other visible windows.

 getToolkit

  public Toolkit getToolkit()

 Returns the toolkit of this frame.

Overrides:

getToolkit in class Component

See Also:

Toolkit

 getWarningString

  public final String getWarningString()

 Gets the warning string for this window. This is  a string that will be displayed somewhere in the  visible area of windows that are not secure.

 getLocale

  public Locale getLocale()

 Gets the Locale for the window, if it has been set.  If no Locale has been set, then the default Locale  is returned.

Overrides:

getLocale in class Component

 addWindowListener

  public synchronized void addWindowListener(WindowListener l)

 Adds the specified window listener to receive window events from  this window.

Parameters:

 l - the window listener

 removeWindowListener

  public synchronized void removeWindowListener(WindowListener l)

 Removes the specified window listener so that it no longer  receives window events from this window.

Parameters:

 l - the window listener

 processEvent

  protected void processEvent(AWTEvent e)

 Processes events on this window. If the event is an WindowEvent,  it invokes the processWindowEvent method, else it invokes its  superclass's processEvent.

Parameters:

 e - the event

Overrides:

processEvent in class Container

 processWindowEvent

  protected void processWindowEvent(WindowEvent e)

 Processes window events occurring on this window by  dispatching them to any registered WindowListener objects.  NOTE: This method will not be called unless window events  are enabled for this component; this happens when one of the  following occurs:  a) A WindowListener object is registered via addWindowListener()  b) Window events are enabled via enableEvents()

Parameters:

 e - the window event

See Also:

enableEvents

 getFocusOwner

  public Component getFocusOwner()

 Returns the child component of this Window which has focus if and  only if this Window is active.

Returns:

 the component with focus, or null if no children have focus  assigned to them.

 postEvent

  public boolean postEvent(Event e)

 Note: postEvent() is deprecated. As of JDK version 1.1  replaced by dispatchEvent(AWTEvent).

Overrides:

postEvent in class Component

 isShowing

  public boolean isShowing()

 Checks if this Window is showing on screen.

Overrides:

isShowing in class Component

See Also:

setVisible

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.BeanDescriptor

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.beans.BeanDescriptor

java.lang.Object
   |
   +----java.beans.FeatureDescriptor
           |
           +----java.beans.BeanDescriptor

______________________________________________________________________________

 public class BeanDescriptor

 extends FeatureDescriptor

A BeanDescriptor provides global information about a "bean",  including its Java class, its displayName, etc.

 This is one of the kinds of descriptor returned by a BeanInfo object,  which also returns descriptors for properties, method, and events.

______________________________________________________________________________

 	BeanDescriptor(Class)

 Create a BeanDescriptor for a bean that doesn't have a customizer.

 	BeanDescriptor(Class, Class)

 Create a BeanDescriptor for a bean that has a customizer.

 	getBeanClass()

  	getCustomizerClass()

 BeanDescriptor

  public BeanDescriptor(Class beanClass)

 Create a BeanDescriptor for a bean that doesn't have a customizer.

Parameters:

 beanClass - The Class object of the Java class that implements 	the bean. For example sun.beans.OurButton.class.

 BeanDescriptor

  public BeanDescriptor(Class beanClass,
                        Class customizerClass)

 Create a BeanDescriptor for a bean that has a customizer.

Parameters:

 beanClass - The Class object of the Java class that implements 	the bean. For example sun.beans.OurButton.class.

 customizerClass - The Class object of the Java class that implements 	the bean's Customizer. For example sun.beans.OurButtonCustomizer.class.

 getBeanClass

  public Class getBeanClass()

Returns:

 The Class object for the bean.

 getCustomizerClass

  public Class getCustomizerClass()

Returns:

 The Class object for the bean's customizer. This may  be null if the bean doesn't have a customizer.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.beans.BeanInfo

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.beans.BeanInfo

 public interface BeanInfo

A bean implementor who wishes to provide explicit information about  their bean may provide a BeanInfo class that implements this BeanInfo  interface and provides explicit information about the methods,  properties, events, etc, of their bean.

 A bean implementor doesn't need to provide a complete set of  explicit information. You can pick and choose which information  you want to provide and the rest will be obtained by automatic  analysis using low-level reflection of the bean classes' methods  and applying standard design patterns.

 You get the opportunity to provide lots and lots of different  information as part of the various XyZDescriptor classes. But  don't panic, you only really need to provide the minimal core  information required by the various constructors.

 See also the SimpleBeanInfo class which provides a convenient  "noop" base class for BeanInfo classes, which you can override  for those specific places where you want to return explicit info.

 To learn about all the behaviour of a bean see the Introspector class.

______________________________________________________________________________

 	ICON_COLOR_16x16

 Constant to indicate a 16 x 16 color icon.

 	ICON_COLOR_32x32

 Constant to indicate a 32 x 32 color icon.

 	ICON_MONO_16x16

 Constant to indicate a 16 x 16 monochrome icon.

 	ICON_MONO_32x32

 Constant to indicate a 32 x 32 monochrome icon.

 	getAdditionalBeanInfo()

 This method allows a BeanInfo object to return an arbitrary collection  of other BeanInfo objects that provide additional information on the  current bean.

 	getBeanDescriptor()

  	getDefaultEventIndex()

 A bean may have a "default" event that is the event that will  mostly commonly be used by human's when using the bean.

 	getDefaultPropertyIndex()

 A bean may have a "default" property that is the property that will  mostly commonly be initially chosen for update by human's who are  customizing the bean.

 	getEventSetDescriptors()

  	getIcon(int)

 This method returns an image object that can be used to  represent the bean in toolboxes, toolbars, etc.

 	getMethodDescriptors()

  	getPropertyDescriptors()

 ICON_COLOR_16x16

  public final static int ICON_COLOR_16x16

 Constant to indicate a 16 x 16 color icon.

 ICON_COLOR_32x32

  public final static int ICON_COLOR_32x32

 Constant to indicate a 32 x 32 color icon.

 ICON_MONO_16x16

  public final static int ICON_MONO_16x16

 Constant to indicate a 16 x 16 monochrome icon.

 ICON_MONO_32x32

  public final static int ICON_MONO_32x32

 Constant to indicate a 32 x 32 monochrome icon.

 getBeanDescriptor

  public abstract BeanDescriptor getBeanDescriptor()

Returns:

 A BeanDescriptor providing overall information about  the bean, such as its displayName, its customizer, etc. May  return null if the information should be obtained by automatic  analysis.

 getEventSetDescriptors

  public abstract EventSetDescriptor[] getEventSetDescriptors()

Returns:

 An array of EventSetDescriptors describing the kinds of  events fired by this bean. May return null if the information  should be obtained by automatic analysis.

 getDefaultEventIndex

  public abstract int getDefaultEventIndex()

 A bean may have a "default" event that is the event that will  mostly commonly be used by human's when using the bean.

Returns:

 Index of default event in the EventSetDescriptor array 	returned by getEventSetDescriptors.

Returns -1 if there is no default event.

 getPropertyDescriptors

  public abstract PropertyDescriptor[] getPropertyDescriptors()

Returns:

 An array of PropertyDescriptors describing the editable  properties supported by this bean. May return null if the  information should be obtained by automatic analysis.

 If a property is indexed, then its entry in the result array will  belong to the IndexedPropertyDescriptor subclass of PropertyDescriptor.  A client of getPropertyDescriptors can use "instanceof" to check  if a given PropertyDescriptor is an IndexedPropertyDescriptor.

 getDefaultPropertyIndex

  public abstract int getDefaultPropertyIndex()

 A bean may have a "default" property that is the property that will  mostly commonly be initially chosen for update by human's who are  customizing the bean.

Returns:

 Index of default property in the PropertyDescriptor array  returned by getPropertyDescriptors.

Returns -1 if there is no default property.

 getMethodDescriptors

  public abstract MethodDescriptor[] getMethodDescriptors()

Returns:

 An array of MethodDescriptors describing the externally  visible methods supported by this bean. May return null if  the information should be obtained by automatic analysis.

 getAdditionalBeanInfo

  public abstract BeanInfo[] getAdditionalBeanInfo()

 This method allows a BeanInfo object to return an arbitrary collection  of other BeanInfo objects that provide additional information on the  current bean.

 If there are conflicts or overlaps between the information provided  by different BeanInfo objects, then the current BeanInfo takes precedence  over the getAdditionalBeanInfo objects, and later elements in the array  take precedence over earlier ones.

Returns:

 an array of BeanInfo objects. May return null.

 getIcon

  public abstract Image getIcon(int iconKind)

 This method returns an image object that can be used to  represent the bean in toolboxes, toolbars, etc. Icon images  will typically be GIFs, but may in future include other formats.

 Beans aren't required to provide icons and may return null from  this method.

 There are four possible flavors of icons (16x16 color,  32x32 color, 16x16 mono, 32x32 mono). If a bean choses to only  support a single icon we recommend supporting 16x16 color.

 We recommend that icons have a "transparent" background  so they can be rendered onto an existing background.

Parameters:

 iconKind - The kind of icon requested. This should be  one of the constant values ICON_COLOR_16x16, ICON_COLOR_32x32,  ICON_MONO_16x16, or ICON_MONO_32x32.

Returns:

 An image object representing the requested icon. May  return null if no suitable icon is available.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.Beans

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.beans.Beans

java.lang.Object
   |
   +----java.beans.Beans

______________________________________________________________________________

 public class Beans

 extends Object

This class provides some general purpose beans control methods.

______________________________________________________________________________

 	Beans()

 	getInstanceOf(Object, Class)

 From a given bean, obtain an object representing a specified  type view of that source object.

 	instantiate(ClassLoader, String)

 Instantiate a bean.

 	isDesignTime()

 Test if we are in design-mode.

 	isGuiAvailable()

  	isInstanceOf(Object, Class)

 Check if a bean can be viewed as a given target type.

 	setDesignTime(boolean)

 Used to indicate whether of not we are running in an application  builder environment.

 	setGuiAvailable(boolean)

 Used to indicate whether of not we are running in an environment  where GUI interaction is available.

 Beans

  public Beans()

 instantiate

  public static Object instantiate(ClassLoader cls,
                                   String beanName) throws IOException, ClassNotFoundException

 Instantiate a bean.

 The bean is created based on a name relative to a class-loader.  This name should be a dot-separated name such as "a.b.c".

 In Beans 1.0 the given name can indicate either a serialized object  or a class. Other mechanisms may be added in the future. In  beans 1.0 we first try to treat the beanName as a serialized object  name then as a class name.

 When using the beanName as a serialized object name we convert the  given beanName to a resource pathname and add a trailing ".ser" suffix.  We then try to load a serialized object from that resource.

 For example, given a beanName of "x.y", Beans.instantiate would first  try to read a serialized object from the resource "x/y.ser" and if  that failed it would try to load the class "x.y" and create an  instance of that class.

 If the bean is a subtype of java.applet.Applet, then it is given  some special initialization. First, it is supplied with a default  AppletStub and AppletContext. Second, if it was instantiated from  a classname the applet's "init" method is called. (If the bean was  deserialized this step is skipped.)

 Note that for beans which are applets, it is the caller's responsiblity  to call "start" on the applet. For correct behaviour, this should be done  after the applet has been added into a visible AWT container.

 Note that applets created via beans.instantiate run in a slightly  different environment than applets running inside browsers. In  particular, bean applets have no access to "parameters", so they may  wish to provide property get/set methods to set parameter values. We  advise bean-applet developers to test their bean-applets against both  the JDK appletviewer (for a reference browser environment) and the  BDK BeanBox (for a reference bean container).

Parameters:

 classLoader - the class-loader from which we should create  the bean. If this is null, then the system  class-loader is used.

 beanName - the name of the bean within the class-loader.  For example "sun.beanbox.foobah"

Throws: ClassNotFoundException

 if the class of a serialized  object could not be found.

Throws: IOException

 if an I/O error occurs.

 getInstanceOf

  public static Object getInstanceOf(Object bean,
                                     Class targetType)

 From a given bean, obtain an object representing a specified  type view of that source object.

 The result may be the same object or a different object. If  the requested target view isn't available then the given  bean is returned.

 This method is provided in Beans 1.0 as a hook to allow the  addition of more flexible bean behaviour in the future.

Parameters:

 obj - Object from which we want to obtain a view.

 targetType - The type of view we'd like to get.

 isInstanceOf

  public static boolean isInstanceOf(Object bean,
                                     Class targetType)

 Check if a bean can be viewed as a given target type.  The result will be true if the Beans.getInstanceof method  can be used on the given bean to obtain an object that  represents the specified targetType type view.

Parameters:

 bean - Bean from which we want to obtain a view.

 targetType - The type of view we'd like to get.

Returns:

 "true" if the given bean supports the given targetType.

 isDesignTime

  public static boolean isDesignTime()

 Test if we are in design-mode.

Returns:

 True if we are running in an application construction 	environment.

 isGuiAvailable

  public static boolean isGuiAvailable()

Returns:

 True if we are running in an environment where beans 	can assume that an interactive GUI is available, so they 	can pop up dialog boxes, etc. This will normally return 	true in a windowing environment, and will normally return 	false in a server environment or if an application is 	running as part of a batch job.

 setDesignTime

  public static void setDesignTime(boolean isDesignTime) throws SecurityException

 Used to indicate whether of not we are running in an application  builder environment. Note that this method is security checked  and is not available to (for example) untrusted applets.

Parameters:

 isDesignTime - True if we're in an application builder tool.

 setGuiAvailable

  public static void setGuiAvailable(boolean isGuiAvailable) throws SecurityException

 Used to indicate whether of not we are running in an environment  where GUI interaction is available. Note that this method is  security checked and is not available to (for example) untrusted  applets.

Parameters:

 isGuiAvailable - True if GUI interaction is available.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.beans.Customizer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.beans.Customizer

 public interface Customizer

A customizer class provides a complete custom GUI for customizing  a target Java Bean.

 Each customizer should inherit from the java.awt.Component class so  it can be instantiated inside an AWT dialog or panel.

 Each customizer should have a null constructor.

______________________________________________________________________________

 	addPropertyChangeListener(PropertyChangeListener)

 Register a listener for the PropertyChange event.

 	removePropertyChangeListener(PropertyChangeListener)

 Remove a listener for the PropertyChange event.

 	setObject(Object)

 Set the object to be customized.

 setObject

  public abstract void setObject(Object bean)

 Set the object to be customized. This method should be called only  once, before the Customizer has been added to any parent AWT container.

Parameters:

 bean - The object to be customized.

 addPropertyChangeListener

  public abstract void addPropertyChangeListener(PropertyChangeListener listener)

 Register a listener for the PropertyChange event. The customizer  should fire a PropertyChange event whenever it changes the target  bean in a way that might require the displayed properties to be  refreshed.

Parameters:

 listener - An object to be invoked when a PropertyChange 	event is fired.

 removePropertyChangeListener

  public abstract void removePropertyChangeListener(PropertyChangeListener listener)

 Remove a listener for the PropertyChange event.

Parameters:

 listener - The PropertyChange listener to be removed.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.EventSetDescriptor

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.beans.EventSetDescriptor

java.lang.Object
   |
   +----java.beans.FeatureDescriptor
           |
           +----java.beans.EventSetDescriptor

______________________________________________________________________________

 public class EventSetDescriptor

 extends FeatureDescriptor

An EventSetDescriptor describes a group of events that a given Java  bean fires.

 The given group of events are all delivered as method calls on a single  event listener interface, and an event listener object can be registered  via a call on a registration method supplied by the event source.

______________________________________________________________________________

 	EventSetDescriptor(Class, String, Class, String)

 This constructor creates an EventSetDescriptor assuming that you are  following the most simple standard design pattern where a named  event "fred" is (1) delivered as a call on the single method of  interface FredListener, (2) has a single argument of type FredEvent,  and (3) where the FredListener may be registered with a call on an  addFredListener method of the source component and removed with a  call on a removeFredListener method.

 	EventSetDescriptor (Class, String, Class, String[], String, String)

 This constructor creates an EventSetDescriptor from scratch using  string names.

 	EventSetDescriptor (String, Class, Method[], Method, Method)

 This constructor creates an EventSetDescriptor from scratch using  java.lang.reflect.Method and java.lang.Class objects.

 	EventSetDescriptor (String, Class, MethodDescriptor[], Method, Method)

 This constructor creates an EventSetDescriptor from scratch using  java.lang.reflect.MethodDescriptor and java.lang.Class objects.

 	getAddListenerMethod()

  	getListenerMethodDescriptors ()

  	getListenerMethods()

  	getListenerType()

  	getRemoveListenerMethod()

  	isInDefaultEventSet()

 Report if an event set is in the "default set".

 	isUnicast()

 Normally event sources are multicast.

 	setInDefaultEventSet(boolean)

 Mark an event set as being in the "default" set (or not).

 	setUnicast(boolean)

 Mark an event set as unicast (or not).

 EventSetDescriptor

  public EventSetDescriptor(Class sourceClass,
                            String eventSetName,
                            Class listenerType,
                            String listenerMethodName) throws IntrospectionException

 This constructor creates an EventSetDescriptor assuming that you are  following the most simple standard design pattern where a named  event "fred" is (1) delivered as a call on the single method of  interface FredListener, (2) has a single argument of type FredEvent,  and (3) where the FredListener may be registered with a call on an  addFredListener method of the source component and removed with a  call on a removeFredListener method.

Parameters:

 sourceClass - The class firing the event.

 eventSetName - The programmatic name of the event. E.g. "fred". 	Note that this should normally start with a lower-case character.

 listenerType - The target interface that events 	will get delivered to.

 listenerMethodName - The method that will get called when the event gets 	delivered to its target listener interface.

Throws: IntrospectionException

 if an exception occurs during  introspection.

 EventSetDescriptor

  public EventSetDescriptor(Class sourceClass,
                            String eventSetName,
                            Class listenerType,
                            String listenerMethodNames[],
                            String addListenerMethodName,
                            String removeListenerMethodName) throws IntrospectionException

 This constructor creates an EventSetDescriptor from scratch using  string names.

Parameters:

 sourceClass - The class firing the event.

 eventSetName - The programmatic name of the event set. 	Note that this should normally start with a lower-case character.

 listenerType - The Class of the target interface that events 	will get delivered to.

 listenerMethodNames - The names of the methods that will get called 	when the event gets delivered to its target listener interface.

 addListenerMethodName - The name of the method on the event source 	that can be used to register an event listener object.

 removeListenerMethodName - The name of the method on the event source 	that can be used to de-register an event listener object.

Throws: IntrospectionException

 if an exception occurs during  introspection.

 EventSetDescriptor

  public EventSetDescriptor(String eventSetName,
                            Class listenerType,
                            Method listenerMethods[],
                            Method addListenerMethod,
                            Method removeListenerMethod) throws IntrospectionException

 This constructor creates an EventSetDescriptor from scratch using  java.lang.reflect.Method and java.lang.Class objects.

Parameters:

 eventSetName - The programmatic name of the event set.

 listenerType - The Class for the listener interface.

 listenerMethods - An array of Method objects describing each 	of the event handling methods in the target listener.

 addListenerMethod - The method on the event source 	that can be used to register an event listener object.

 removeListenerMethod - The method on the event source 	that can be used to de-register an event listener object.

Throws: IntrospectionException

 if an exception occurs during  introspection.

 EventSetDescriptor

  public EventSetDescriptor(String eventSetName,
                            Class listenerType,
                            MethodDescriptor listenerMethodDescriptors[],
                            Method addListenerMethod,
                            Method removeListenerMethod) throws IntrospectionException

 This constructor creates an EventSetDescriptor from scratch using  java.lang.reflect.MethodDescriptor and java.lang.Class objects.

Parameters:

 eventSetName - The programmatic name of the event set.

 listenerType - The Class for the listener interface.

 listenerMethodDescriptors - An array of MethodDescriptor objects 	describing each of the event handling methods in the  target listener.

 addListenerMethod - The method on the event source 	that can be used to register an event listener object.

 removeListenerMethod - The method on the event source 	that can be used to de-register an event listener object.

Throws: IntrospectionException

 if an exception occurs during  introspection.

 getListenerType

  public Class getListenerType()

Returns:

 The Class object for the target interface that will  get invoked when the event is fired.

 getListenerMethods

  public Method[] getListenerMethods()

Returns:

 An array of Method objects for the target methods  within the target listener interface that will get called when  events are fired.

 getListenerMethodDescriptors

  public MethodDescriptor[] getListenerMethodDescriptors()

Returns:

 An array of MethodDescriptor objects for the target methods  within the target listener interface that will get called when  events are fired.

 getAddListenerMethod

  public Method getAddListenerMethod()

Returns:

 The method used to register a listener at the event source.

 getRemoveListenerMethod

  public Method getRemoveListenerMethod()

Returns:

 The method used to register a listener at the event source.

 setUnicast

  public void setUnicast(boolean unicast)

 Mark an event set as unicast (or not).

Parameters:

 unicast - True if the event set is unicast.

 isUnicast

  public boolean isUnicast()

 Normally event sources are multicast. However there are some  exceptions that are strictly unicast.

Returns:

 True if the event set is unicast. Defaults to "false".

 setInDefaultEventSet

  public void setInDefaultEventSet(boolean inDefaultEventSet)

 Mark an event set as being in the "default" set (or not).  By default this is true.

Parameters:

 unicast - True if the event set is unicast.

 isInDefaultEventSet

  public boolean isInDefaultEventSet()

 Report if an event set is in the "default set".

Returns:

 True if the event set is in the "default set". Defaults to "true".

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.FeatureDescriptor

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.beans.FeatureDescriptor

java.lang.Object
   |
   +----java.beans.FeatureDescriptor

______________________________________________________________________________

 public class FeatureDescriptor

 extends Object

The FeatureDescriptor class is the common baseclass for PropertyDescriptor,  EventSetDescriptor, and MethodDescriptor, etc.

 It supports some common information that can be set and retrieved for  any of the introspection descriptors.

 In addition it provides an extension mechanism so that arbitrary  attribute/value pairs can be associated with a design feature.

______________________________________________________________________________

 	FeatureDescriptor()

 	attributeNames()

  	getDisplayName()

  	getName()

  	getShortDescription()

  	getValue(String)

 Retrieve a named attribute with this feature.

 	isExpert()

 The "expert" flag is used to distinguish between those features that are  intended for expert users from those that are intended for normal users.

 	isHidden()

 The "hidden" flag is used to identify features that are intended only  for tool use, and which should not be exposed to humans.

 	setDisplayName(String)

  	setExpert(boolean)

 The "expert" flag is used to distinguish between features that are  intended for expert users from those that are intended for normal users.

 	setHidden(boolean)

 The "hidden" flag is used to identify features that are intended only  for tool use, and which should not be exposed to humans.

 	setName(String)

  	setShortDescription(String)

 You can associate a short descriptive string with a feature.

 	setValue(String, Object)

 Associate a named attribute with this feature.

 FeatureDescriptor

  public FeatureDescriptor()

 getName

  public String getName()

Returns:

 The programmatic name of the property/method/event

 setName

  public void setName(String name)

Parameters:

 name - The programmatic name of the property/method/event

 getDisplayName

  public String getDisplayName()

Returns:

 The localized display name for the property/method/event. 	This defaults to the same as its programmatic name from getName.

 setDisplayName

  public void setDisplayName(String displayName)

Parameters:

 displayName - The localized display name for the 	property/method/event.

 isExpert

  public boolean isExpert()

 The "expert" flag is used to distinguish between those features that are  intended for expert users from those that are intended for normal users.

Returns:

 True if this feature is intended for use by experts only.

 setExpert

  public void setExpert(boolean expert)

 The "expert" flag is used to distinguish between features that are  intended for expert users from those that are intended for normal users.

Parameters:

 expert - True if this feature is intended for use by experts only.

 isHidden

  public boolean isHidden()

 The "hidden" flag is used to identify features that are intended only  for tool use, and which should not be exposed to humans.

Returns:

 True if this feature should be hidden from human users.

 setHidden

  public void setHidden(boolean hidden)

 The "hidden" flag is used to identify features that are intended only  for tool use, and which should not be exposed to humans.

Parameters:

 hidden - True if this feature should be hidden from human users.

 getShortDescription

  public String getShortDescription()

Returns:

 A localized short description associated with this  property/method/event. This defaults to be the display name.

 setShortDescription

  public void setShortDescription(String text)

 You can associate a short descriptive string with a feature. Normally  these descriptive strings should be less than about 40 characters.

Parameters:

 text - A (localized) short description to be associated with  this property/method/event.

 setValue

  public void setValue(String attributeName,
                       Object value)

 Associate a named attribute with this feature.

Parameters:

 attributeName - The locale-independent name of the attribute

 value - The value.

 getValue

  public Object getValue(String attributeName)

 Retrieve a named attribute with this feature.

Parameters:

 attributeName - The locale-independent name of the attribute

Returns:

 The value of the attribute. May be null if 	the attribute is unknown.

 attributeNames

  public Enumeration attributeNames()

Returns:

 An enumeration of the locale-independent names of any  attributes that have been registered with setValue.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.IndexedPropertyDescriptor

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.beans.IndexedPropertyDescriptor

java.lang.Object
   |
   +----java.beans.FeatureDescriptor
           |
           +----java.beans.PropertyDescriptor
                   |
                   +----java.beans.IndexedPropertyDescriptor

______________________________________________________________________________

 public class IndexedPropertyDescriptor

 extends PropertyDescriptor

An IndexedPropertyDescriptor describes a property that acts like an  array and has an indexed read and/or indexed write method to access  specific elements of the array.

 An indexed property may also provide simple non-indexed read and write  methods. If these are present, they read and write arrays of the type  returned by the indexed read method.

______________________________________________________________________________

 	IndexedPropertyDescriptor(String, Class)

 This constructor constructs an IndexedPropertyDescriptor for a property  that follows the standard Java conventions by having getFoo and setFoo  accessor methods, for both indexed access and array access.

 	IndexedPropertyDescriptor (String, Class, String, String, String, String)

 This constructor takes the name of a simple property, and method  names for reading and writing the property, both indexed  and non-indexed.

 	IndexedPropertyDescriptor (String, Method, Method, Method, Method)

 This constructor takes the name of a simple property, and Method  objects for reading and writing the property.

 	getIndexedPropertyType()

  	getIndexedReadMethod()

  	getIndexedWriteMethod()

 IndexedPropertyDescriptor

  public IndexedPropertyDescriptor(String propertyName,
                                   Class beanClass) throws IntrospectionException

 This constructor constructs an IndexedPropertyDescriptor for a property   that follows the standard Java conventions by having getFoo and setFoo  accessor methods, for both indexed access and array access.

 Thus if the argument name is "fred", it will assume that there  is an indexed reader method "getFred", a non-indexed (array) reader  method also called "getFred", an indexed writer method "setFred",  and finally a non-indexed writer method "setFred".

Parameters:

 propertyName - The programmatic name of the property.

 beanClass - The Class object for the target bean.

Throws: IntrospectionException

 if an exception occurs during  introspection.

 IndexedPropertyDescriptor

  public IndexedPropertyDescriptor(String propertyName,
                                   Class beanClass,
                                   String getterName,
                                   String setterName,
                                   String indexedGetterName,
                                   String indexedSetterName) throws IntrospectionException

 This constructor takes the name of a simple property, and method  names for reading and writing the property, both indexed  and non-indexed.

Parameters:

 propertyName - The programmatic name of the property.

 beanClass - The Class object for the target bean.

 getterName - The name of the method used for reading the property 	values as an array. May be null if the property is write-only 	or must be indexed.

 setterName - The name of the method used for writing the property 	values as an array. May be null if the property is read-only 	or must be indexed.

 indexedGetterName - The name of the method used for reading 	an indexed property value. 	May be null if the property is write-only.

 indexedSetterName - The name of the method used for writing 	an indexed property value. 	May be null if the property is read-only.

Throws: IntrospectionException

 if an exception occurs during  introspection.

 IndexedPropertyDescriptor

  public IndexedPropertyDescriptor(String propertyName,
                                   Method getter,
                                   Method setter,
                                   Method indexedGetter,
                                   Method indexedSetter) throws IntrospectionException

 This constructor takes the name of a simple property, and Method  objects for reading and writing the property.

Parameters:

 propertyName - The programmatic name of the property.

 getter - The method used for reading the property values as an array. 	May be null if the property is write-only or must be indexed.

 setter - The method used for writing the property values as an array. 	May be null if the property is read-only or must be indexed.

 indexedGetter - The method used for reading an indexed property value. 	May be null if the property is write-only.

 indexedSetter - The method used for writing an indexed property value. 	May be null if the property is read-only.

Throws: IntrospectionException

 if an exception occurs during  introspection.

 getIndexedReadMethod

  public Method getIndexedReadMethod()

Returns:

 The method that should be used to read an indexed  property value.  May return null if the property isn't indexed or is write-only.

 getIndexedWriteMethod

  public Method getIndexedWriteMethod()

Returns:

 The method that should be used to write an indexed  property value.  May return null if the property isn't indexed or is read-only.

 getIndexedPropertyType

  public Class getIndexedPropertyType()

Returns:

 The Java Class for the indexed properties type. Note that  the Class may describe a primitive Java type such as "int".

 This is the type that will be returned by the indexedReadMethod.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.IntrospectionException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.beans.IntrospectionException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.beans.IntrospectionException

______________________________________________________________________________

 public class IntrospectionException

 extends Exception

Thrown when an exception happens during Introspection.

 Typical causes include not being able to map a string class name  to a Class object, not being able to resolve a string method name,  or specifying a method name that has the wrong type signature for  its intended use.

______________________________________________________________________________

 	IntrospectionException(String)

 IntrospectionException

  public IntrospectionException(String mess)

Parameters:

 mess - Descriptive message

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.Introspector

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.beans.Introspector

java.lang.Object
   |
   +----java.beans.Introspector

______________________________________________________________________________

 public class Introspector

 extends Object

The Introspector class provides a standard way for tools to learn about  the properties, events, and methods supported by a target Java Bean.

 For each of those three kinds of information, the Introspector will  separately analyze the bean's class and superclasses looking for  either explicit or implicit information and use that information to  build a BeanInfo object that comprehensively describes the target bean.

 For each class "Foo", explicit information may be available if there exists  a corresponding "FooBeanInfo" class that provides a non-null value when  queried for the information. We first look for the BeanInfo class by  taking the full package-qualified name of the target bean class and  appending "BeanInfo" to form a new class name. If this fails, then  we take the final classname component of this name, and look for that  class in each of the packages specified in the BeanInfo package search  path.

 Thus for a class such as "sun.xyz.OurButton" we would first look for a  BeanInfo class called "sun.xyz.OurButtonBeanInfo" and if that failed we'd  look in each package in the BeanInfo search path for an OurButtonBeanInfo  class. With the default search path, this would mean looking for  "sun.beans.infos.OurButtonBeanInfo".

 If a class provides explicit BeanInfo about itself then we add that to  the BeanInfo information we obtained from analyzing any derived classes,  but we regard the explicit information as being definitive for the current  class and its base classes, and do not proceed any further up the superclass  chain.

 If we don't find explicit BeanInfo on a class, we use low-level  reflection to study the methods of the class and apply standard design  patterns to identify property accessors, event sources, or public  methods. We then proceed to analyze the class's superclass and add  in the information from it (and possibly on up the superclass chain).

______________________________________________________________________________

 	decapitalize(String)

 Utility method to take a string and convert it to normal Java variable  name capitalization.

 	getBeanInfo(Class)

 Introspect on a Java bean and learn about all its properties, exposed  methods, and events.

 	getBeanInfo(Class, Class)

 Introspect on a Java bean and learn all about its properties, exposed  methods, below a given "stop" point.

 	getBeanInfoSearchPath()

  	setBeanInfoSearchPath (String[])

 Change the list of package names that will be used for 	finding BeanInfo classes.

 getBeanInfo

  public static BeanInfo getBeanInfo(Class beanClass) throws IntrospectionException

 Introspect on a Java bean and learn about all its properties, exposed  methods, and events.

Parameters:

 beanClass - The bean class to be analyzed.

Returns:

 A BeanInfo object describing the target bean.

Throws: IntrospectionException

 if an exception occurs during  introspection.

 getBeanInfo

  public static BeanInfo getBeanInfo(Class beanClass,
                                     Class stopClass) throws IntrospectionException

 Introspect on a Java bean and learn all about its properties, exposed  methods, below a given "stop" point.

Parameters:

 bean - The bean class to be analyzed.

 stopClass - The baseclass at which to stop the analysis. Any  methods/properties/events in the stopClass or in its baseclasses  will be ignored in the analysis.

Throws: IntrospectionException

 if an exception occurs during  introspection.

 decapitalize

  public static String decapitalize(String name)

 Utility method to take a string and convert it to normal Java variable  name capitalization. This normally means converting the first  character from upper case to lower case, but in the (unusual) special  case when there is more than one character and both the first and  second characters are upper case, we leave it alone.

 Thus "FooBah" becomes "fooBah" and "X" becomes "x", but "URL" stays  as "URL".

Parameters:

 name - The string to be decapitalized.

Returns:

 The decapitalized version of the string.

 getBeanInfoSearchPath

  public static String[] getBeanInfoSearchPath()

Returns:

 The array of package names that will be searched in 	order to find BeanInfo classes.

 This is initially set to {"sun.beans.infos"}.

 setBeanInfoSearchPath

  public static void setBeanInfoSearchPath(String path[])

 Change the list of package names that will be used for 	finding BeanInfo classes.

Parameters:

 path - Array of package names.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.MethodDescriptor

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.beans.MethodDescriptor

java.lang.Object
   |
   +----java.beans.FeatureDescriptor
           |
           +----java.beans.MethodDescriptor

______________________________________________________________________________

 public class MethodDescriptor

 extends FeatureDescriptor

A MethodDescriptor describes a particular method that a Java Bean  supports for external access from other components.

______________________________________________________________________________

 	MethodDescriptor(Method)

  	MethodDescriptor (Method, ParameterDescriptor[])

 	getMethod()

  	getParameterDescriptors()

 MethodDescriptor

  public MethodDescriptor(Method method)

Parameters:

 method - The low-level method information.

 MethodDescriptor

  public MethodDescriptor(Method method,
                          ParameterDescriptor parameterDescriptors[])

Parameters:

 method - The low-level method information.

 parameterDescriptors - Descriptive information for each of the 	method's parameters.

 getMethod

  public Method getMethod()

Returns:

 The low-level description of the method

 getParameterDescriptors

  public ParameterDescriptor[] getParameterDescriptors()

Returns:

 The locale-independent names of the parameters. May return 	a null array if the parameter names aren't known.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.ParameterDescriptor

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.beans.ParameterDescriptor

java.lang.Object
   |
   +----java.beans.FeatureDescriptor
           |
           +----java.beans.ParameterDescriptor

______________________________________________________________________________

 public class ParameterDescriptor

 extends FeatureDescriptor

The ParameterDescriptor class allows bean implementors to provide  additional information on each of their parameters, beyond the  low level type information provided by the java.lang.reflect.Method  class.

 Currently all our state comes from the FeatureDescriptor base class.

______________________________________________________________________________

 	ParameterDescriptor()

 ParameterDescriptor

  public ParameterDescriptor()

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.PropertyChangeEvent

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.beans.PropertyChangeEvent

java.lang.Object
   |
   +----java.util.EventObject
           |
           +----java.beans.PropertyChangeEvent

______________________________________________________________________________

 public class PropertyChangeEvent

 extends EventObject

A "PropertyChange" event gets delivered whenever a bean changes a "bound"  or "constrained" property. A PropertyChangeEvent object is sent as an  argument to the PropertyChangeListener and VetoableChangeListener methods.

 Normally PropertyChangeEvents are accompanied by the name and the old  and new value of the changed property. If the new value is a builtin  type (such as int or boolean) it must be wrapped as the  corresponding java.lang.* Object type (such as Integer or Boolean).

 Null values may be provided for the old and the new values if their  true values are not known.

 An event source may send a null object as the name to indicate that an  arbitrary set of if its properties have changed. In this case the  old and new values should also be null.

______________________________________________________________________________

 	PropertyChangeEvent(Object, String, Object, Object)

 	getNewValue()

  	getOldValue()

  	getPropagationId()

 The "propagationId" field is reserved for future use.

 	getPropertyName()

  	setPropagationId(Object)

 PropertyChangeEvent

  public PropertyChangeEvent(Object source,
                             String propertyName,
                             Object oldValue,
                             Object newValue)

Parameters:

 source - The bean that fired the event.

 propertyName - The programmatic name of the property 	that was changed.

 oldValue - The old value of the property.

 newValue - The new value of the property.

 getPropertyName

  public String getPropertyName()

Returns:

 The programmatic name of the property that was changed. 	May be null if multiple properties have changed.

 getNewValue

  public Object getNewValue()

Returns:

 The new value for the property, expressed as an Object. 	May be null if multiple properties have changed.

 getOldValue

  public Object getOldValue()

Returns:

 The old value for the property, expressed as an Object. 	May be null if multiple properties have changed.

 setPropagationId

  public void setPropagationId(Object propagationId)

Parameters:

 propagationId - The propagationId object for the event.

 getPropagationId

  public Object getPropagationId()

 The "propagationId" field is reserved for future use. In Beans 1.0  the sole requirement is that if a listener catches a PropertyChangeEvent  and then fires a PropertyChangeEvent of its own, then it should  make sure that it propagates the propagationId field from its  incoming event to its outgoing event.

Returns:

 the propagationId object associated with a bound/constrained 	property update.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.beans.PropertyChangeListener

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.beans.PropertyChangeListener

 public interface PropertyChangeListener

 extends EventListener

A "PropertyChange" event gets fired whenever a bean changes a "bound"  property. You can register a PropertyChangeListener with a source  bean so as to be notified of any bound property updates.

______________________________________________________________________________

 	propertyChange(PropertyChangeEvent)

 This method gets called when a bound property is changed.

 propertyChange

  public abstract void propertyChange(PropertyChangeEvent evt)

 This method gets called when a bound property is changed.

Parameters:

 evt - A PropertyChangeEvent object describing the event source  and the property that has changed.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.PropertyChangeSupport

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.beans.PropertyChangeSupport

java.lang.Object
   |
   +----java.beans.PropertyChangeSupport

______________________________________________________________________________

 public class PropertyChangeSupport

 extends Object

 implements Serializable

This is a utility class that can be used by beans that support bound  properties. You can either inherit from this class or you can use  an instance of this class as a member field of your bean and delegate  various work to it.

______________________________________________________________________________

 	PropertyChangeSupport(Object)

 	addPropertyChangeListener(PropertyChangeListener)

 Add a PropertyChangeListener to the listener list.

 	firePropertyChange(String, Object, Object)

 Report a bound property update to any registered listeners.

 	removePropertyChangeListener(PropertyChangeListener)

 Remove a PropertyChangeListener from the listener list.

 PropertyChangeSupport

  public PropertyChangeSupport(Object sourceBean)

 addPropertyChangeListener

  public synchronized void addPropertyChangeListener(PropertyChangeListener listener)

 Add a PropertyChangeListener to the listener list.

Parameters:

 listener - The PropertyChangeListener to be added

 removePropertyChangeListener

  public synchronized void removePropertyChangeListener(PropertyChangeListener listener)

 Remove a PropertyChangeListener from the listener list.

Parameters:

 listener - The PropertyChangeListener to be removed

 firePropertyChange

  public void firePropertyChange(String propertyName,
                                 Object oldValue,
                                 Object newValue)

 Report a bound property update to any registered listeners.  No event is fired if old and new are equal and non-null.

Parameters:

 propertyName - The programmatic name of the property 	that was changed.

 oldValue - The old value of the property.

 newValue - The new value of the property.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.PropertyDescriptor

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.beans.PropertyDescriptor

java.lang.Object
   |
   +----java.beans.FeatureDescriptor
           |
           +----java.beans.PropertyDescriptor

______________________________________________________________________________

 public class PropertyDescriptor

 extends FeatureDescriptor

A PropertyDescriptor describes one property that a Java Bean  exports via a pair of accessor methods.

______________________________________________________________________________

 	PropertyDescriptor(String, Class)

 Constructs a PropertyDescriptor for a property that follows  the standard Java convention by having getFoo and setFoo  accessor methods.

 	PropertyDescriptor(String, Class, String, String)

 This constructor takes the name of a simple property, and method  names for reading and writing the property.

 	PropertyDescriptor(String, Method, Method)

 This constructor takes the name of a simple property, and Method  objects for reading and writing the property.

 	getPropertyEditorClass()

  	getPropertyType()

  	getReadMethod()

  	getWriteMethod()

  	isBound()

 Updates to "bound" properties will cause a "PropertyChange" event to  get fired when the property is changed.

 	isConstrained()

 Attempted updates to "Constrained" properties will cause a "VetoableChange"  event to get fired when the property is changed.

 	setBound(boolean)

 Updates to "bound" properties will cause a "PropertyChange" event to  get fired when the property is changed.

 	setConstrained(boolean)

 Attempted updates to "Constrained" properties will cause a "VetoableChange"  event to get fired when the property is changed.

 	setPropertyEditorClass(Class)

 Normally PropertyEditors will be found using the PropertyEditorManager.

 PropertyDescriptor

  public PropertyDescriptor(String propertyName,
                            Class beanClass) throws IntrospectionException

 Constructs a PropertyDescriptor for a property that follows  the standard Java convention by having getFoo and setFoo  accessor methods. Thus if the argument name is "fred", it will  assume that the reader method is "getFred" and the writer method  is "setFred". Note that the property name should start with a lower  case character, which will be capitalized in the method names.

Parameters:

 propertyName - The programmatic name of the property.

 beanClass - The Class object for the target bean. For 	example sun.beans.OurButton.class.

Throws: IntrospectionException

 if an exception occurs during  introspection.

 PropertyDescriptor

  public PropertyDescriptor(String propertyName,
                            Class beanClass,
                            String getterName,
                            String setterName) throws IntrospectionException

 This constructor takes the name of a simple property, and method  names for reading and writing the property.

Parameters:

 propertyName - The programmatic name of the property.

 beanClass - The Class object for the target bean. For 	example sun.beans.OurButton.class.

 getterName - The name of the method used for reading the property 	value. May be null if the property is write-only.

 setterName - The name of the method used for writing the property 	value. May be null if the property is read-only.

Throws: IntrospectionException

 if an exception occurs during  introspection.

 PropertyDescriptor

  public PropertyDescriptor(String propertyName,
                            Method getter,
                            Method setter) throws IntrospectionException

 This constructor takes the name of a simple property, and Method  objects for reading and writing the property.

Parameters:

 propertyName - The programmatic name of the property.

 getter - The method used for reading the property value. 	May be null if the property is write-only.

 setter - The method used for writing the property value. 	May be null if the property is read-only.

Throws: IntrospectionException

 if an exception occurs during  introspection.

 getPropertyType

  public Class getPropertyType()

Returns:

 The Java type info for the property. Note that  the "Class" object may describe a built-in Java type such as "int".  The result may be "null" if this is an indexed property that  does not support non-indexed access.

 This is the type that will be returned by the ReadMethod.

 getReadMethod

  public Method getReadMethod()

Returns:

 The method that should be used to read the property value.  May return null if the property can't be read.

 getWriteMethod

  public Method getWriteMethod()

Returns:

 The method that should be used to write the property value.  May return null if the property can't be written.

 isBound

  public boolean isBound()

 Updates to "bound" properties will cause a "PropertyChange" event to  get fired when the property is changed.

Returns:

 True if this is a bound property.

 setBound

  public void setBound(boolean bound)

 Updates to "bound" properties will cause a "PropertyChange" event to  get fired when the property is changed.

Parameters:

 bound - True if this is a bound property.

 isConstrained

  public boolean isConstrained()

 Attempted updates to "Constrained" properties will cause a "VetoableChange"  event to get fired when the property is changed.

Returns:

 True if this is a constrained property.

 setConstrained

  public void setConstrained(boolean constrained)

 Attempted updates to "Constrained" properties will cause a "VetoableChange"  event to get fired when the property is changed.

Parameters:

 constrained - True if this is a constrained property.

 setPropertyEditorClass

  public void setPropertyEditorClass(Class propertyEditorClass)

 Normally PropertyEditors will be found using the PropertyEditorManager.   However if for some reason you want to associate a particular  PropertyEditor with a given property, then you can do it with  this method.

Parameters:

 propertyEditorClass - The Class for the desired PropertyEditor.

 getPropertyEditorClass

  public Class getPropertyEditorClass()

Returns:

 Any explicit PropertyEditor Class that has been registered 	for this property. Normally this will return "null", 	indicating that no special editor has been registered, 	so the PropertyEditorManager should be used to locate 	a suitable PropertyEditor.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.beans.PropertyEditor

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.beans.PropertyEditor

 public interface PropertyEditor

A PropertyEditor class provides support for GUIs that want to  allow users to edit a property value of a given type.

 PropertyEditor supports a variety of different kinds of ways of  displaying and updating property values. Most PropertyEditors will  only need to support a subset of the different options available in  this API.

 Simple PropertyEditors may only support the getAsText and setAsText  methods and need not support (say) paintValue or getCustomEditor. More  complex types may be unable to support getAsText and setAsText but will  instead support paintValue and getCustomEditor.

 Every propertyEditor must support one or more of the three simple  display styles. Thus it can either (1) support isPaintable or (2)  both return a non-null String[] from getTags() and return a non-null  value from getAsText or (3) simply return a non-null String from  getAsText().

 Every property editor must support a call on setValue when the argument  object is of the type for which this is the corresponding propertyEditor.  In addition, each property editor must either support a custom editor,  or support setAsText.

 Each PropertyEditor should have a null constructor.

______________________________________________________________________________

 	addPropertyChangeListener(PropertyChangeListener)

 Register a listener for the PropertyChange event.

 	getAsText()

  	getCustomEditor()

 A PropertyEditor may choose to make available a full custom Component  that edits its property value.

 	getJavaInitializationString()

 This method is intended for use when generating Java code to set  the value of the property.

 	getTags()

 If the property value must be one of a set of known tagged values,  then this method should return an array of the tags.

 	getValue()

  	isPaintable()

  	paintValue (Graphics, Rectangle)

 Paint a representation of the value into a given area of screen  real estate.

 	removePropertyChangeListener(PropertyChangeListener)

 Remove a listener for the PropertyChange event.

 	setAsText(String)

 Set the property value by parsing a given String.

 	setValue(Object)

 Set (or change) the object that is to be edited.

 	supportsCustomEditor()

 setValue

  public abstract void setValue(Object value)

 Set (or change) the object that is to be edited. Builtin types such  as "int" must be wrapped as the corresponding object type such as  "java.lang.Integer".

Parameters:

 value - The new target object to be edited. Note that this  object should not be modified by the PropertyEditor, rather  the PropertyEditor should create a new object to hold any  modified value.

 getValue

  public abstract Object getValue()

Returns:

 The value of the property. Builtin types such as "int" will  be wrapped as the corresponding object type such as "java.lang.Integer".

 isPaintable

  public abstract boolean isPaintable()

Returns:

 True if the class will honor the paintValue method.

 paintValue

  public abstract void paintValue(Graphics gfx,
                                  Rectangle box)

 Paint a representation of the value into a given area of screen  real estate. Note that the propertyEditor is responsible for doing  its own clipping so that it fits into the given rectangle.

 If the PropertyEditor doesn't honor paint requests (see isPaintable)  this method should be a silent noop.

Parameters:

 gfx - Graphics object to paint into.

 box - Rectangle within graphics object into which we should paint.

 getJavaInitializationString

  public abstract String getJavaInitializationString()

 This method is intended for use when generating Java code to set  the value of the property. It should return a fragment of Java code  that can be used to initialize a variable with the current property  value.

 Example results are "2", "new Color(127,127,34)", "Color.orange", etc.

Returns:

 A fragment of Java code representing an initializer for the  current value.

 getAsText

  public abstract String getAsText()

Returns:

 The property value as a human editable string.

 Returns null if the value can't be expressed as an editable string.

 If a non-null value is returned, then the PropertyEditor should 	be prepared to parse that string back in setAsText().

 setAsText

  public abstract void setAsText(String text) throws IllegalArgumentException

 Set the property value by parsing a given String. May raise  java.lang.IllegalArgumentException if either the String is  badly formatted or if this kind of property can't be expressed  as text.

Parameters:

 text - The string to be parsed.

 getTags

  public abstract String[] getTags()

 If the property value must be one of a set of known tagged values,  then this method should return an array of the tags. This can  be used to represent (for example) enum values. If a PropertyEditor  supports tags, then it should support the use of setAsText with  a tag value as a way of setting the value and the use of getAsText  to identify the current value.

Returns:

 The tag values for this property. May be null if this  property cannot be represented as a tagged value.

 getCustomEditor

  public abstract Component getCustomEditor()

 A PropertyEditor may choose to make available a full custom Component  that edits its property value. It is the responsibility of the  PropertyEditor to hook itself up to its editor Component itself and  to report property value changes by firing a PropertyChange event.

 The higher-level code that calls getCustomEditor may either embed  the Component in some larger property sheet, or it may put it in  its own individual dialog, or ...

Returns:

 A java.awt.Component that will allow a human to directly  edit the current property value. May be null if this is 	not supported.

 supportsCustomEditor

  public abstract boolean supportsCustomEditor()

Returns:

 True if the propertyEditor can provide a custom editor.

 addPropertyChangeListener

  public abstract void addPropertyChangeListener(PropertyChangeListener listener)

 Register a listener for the PropertyChange event. When a  PropertyEditor changes its value it should fire a PropertyChange  event on all registered PropertyChangeListeners, specifying the  null value for the property name and itself as the source.

Parameters:

 listener - An object to be invoked when a PropertyChange 	event is fired.

 removePropertyChangeListener

  public abstract void removePropertyChangeListener(PropertyChangeListener listener)

 Remove a listener for the PropertyChange event.

Parameters:

 listener - The PropertyChange listener to be removed.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.PropertyEditorManager

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.beans.PropertyEditorManager

java.lang.Object
   |
   +----java.beans.PropertyEditorManager

______________________________________________________________________________

 public class PropertyEditorManager

 extends Object

The PropertyEditorManager can be used to locate a property editor for  any given type name. This property editor must support the  java.beans.PropertyEditor interface for editing a given object.

 The PropertyEditorManager uses three techniques for locating an editor  for a given type. First, it provides a registerEditor method to allow  an editor to be specifically registered for a given type. Second it  tries to locate a suitable class by adding "Editor" to the full  qualified classname of the given type (e.g. "foo.bah.FozEditor").  Finally it takes the simple classname (without the package name) adds  "Editor" to it and looks in a search-path of packages for a matching  class.

 So for an input class foo.bah.Fred, the PropertyEditorManager would  first look in its tables to see if an editor had been registered for  foo.bah.Fred and if so use that. Then it will look for a  foo.bah.FredEditor class. Then it will look for (say)  standardEditorsPackage.FredEditor class.

 Default PropertyEditors will be provided for the Java builtin types  "boolean", "byte", "short", "int", "long", "float", and "double"; and  for the classes java.lang.String. java.awt.Color, and java.awt.Font.

______________________________________________________________________________

 	PropertyEditorManager()

 	findEditor(Class)

 Locate a value editor for a given target type.

 	getEditorSearchPath()

  	registerEditor(Class, Class)

 Register an editor class to be used to editor values of  a given target class.

 	setEditorSearchPath(String[])

 Change the list of package names that will be used for 	finding property editors.

 PropertyEditorManager

  public PropertyEditorManager()

 registerEditor

  public static void registerEditor(Class targetType,
                                    Class editorClass)

 Register an editor class to be used to editor values of  a given target class.

Parameters:

 targetType - the Class object of the type to be edited

 editorClass - the Class object of the editor class. If 	this is null, then any existing definition will be removed.

 findEditor

  public static PropertyEditor findEditor(Class targetType)

 Locate a value editor for a given target type.

Parameters:

 targetType - The Class object for the type to be edited

Returns:

 An editor object for the given target class.  The result is null if no suitable editor can be found.

 getEditorSearchPath

  public static String[] getEditorSearchPath()

Returns:

 The array of package names that will be searched in 	order to find property editors.

 This is initially set to {"sun.beans.editors"}.

 setEditorSearchPath

  public static void setEditorSearchPath(String path[])

 Change the list of package names that will be used for 	finding property editors.

Parameters:

 path - Array of package names.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.PropertyEditorSupport

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.beans.PropertyEditorSupport

java.lang.Object
   |
   +----java.beans.PropertyEditorSupport

______________________________________________________________________________

 public class PropertyEditorSupport

 extends Object

 implements PropertyEditor

______________________________________________________________________________

 	PropertyEditorSupport()

 Constructor for use by derived PropertyEditor classes.

 	PropertyEditorSupport(Object)

 Constructor for use when a PropertyEditor is delegating to us.

 	addPropertyChangeListener(PropertyChangeListener)

 Register a listener for the PropertyChange event.

 	firePropertyChange()

 Report that we have been modified to any interested listeners.

 	getAsText()

  	getCustomEditor()

 A PropertyEditor may chose to make available a full custom Component  that edits its property value.

 	getJavaInitializationString()

 This method is intended for use when generating Java code to set  the value of the property.

 	getTags()

 If the property value must be one of a set of known tagged values,  then this method should return an array of the tag values.

 	getValue()

  	isPaintable()

  	paintValue (Graphics, Rectangle)

 Paint a representation of the value into a given area of screen  real estate.

 	removePropertyChangeListener(PropertyChangeListener)

 Remove a listener for the PropertyChange event.

 	setAsText(String)

 Set the property value by parsing a given String.

 	setValue(Object)

 Set (or change) the object that is to be edited.

 	supportsCustomEditor()

 PropertyEditorSupport

  protected PropertyEditorSupport()

 Constructor for use by derived PropertyEditor classes.

 PropertyEditorSupport

  protected PropertyEditorSupport(Object source)

 Constructor for use when a PropertyEditor is delegating to us.

Parameters:

 source - The source to use for any events we fire.

 setValue

  public void setValue(Object value)

 Set (or change) the object that is to be edited.

Parameters:

 value - The new target object to be edited. Note that this  object should not be modified by the PropertyEditor, rather  the PropertyEditor should create a new object to hold any  modified value.

 getValue

  public Object getValue()

Returns:

 The value of the property.

 isPaintable

  public boolean isPaintable()

Returns:

 True if the class will honor the paintValue method.

 paintValue

  public void paintValue(Graphics gfx,
                         Rectangle box)

 Paint a representation of the value into a given area of screen  real estate. Note that the propertyEditor is responsible for doing  its own clipping so that it fits into the given rectangle.

 If the PropertyEditor doesn't honor paint requests (see isPaintable)  this method should be a silent noop.

Parameters:

 gfx - Graphics object to paint into.

 box - Rectangle within graphics object into which we should paint.

 getJavaInitializationString

  public String getJavaInitializationString()

 This method is intended for use when generating Java code to set  the value of the property. It should return a fragment of Java code  that can be used to initialize a variable with the current property  value.

 Example results are "2", "new Color(127,127,34)", "Color.orange", etc.

Returns:

 A fragment of Java code representing an initializer for the  current value.

 getAsText

  public String getAsText()

Returns:

 The property value as a string suitable for presentation  to a human to edit.

 Returns "null" is the value can't be expressed as a string.

 If a non-null value is returned, then the PropertyEditor should 	be prepared to parse that string back in setAsText().

 setAsText

  public void setAsText(String text) throws IllegalArgumentException

 Set the property value by parsing a given String. May raise  java.lang.IllegalArgumentException if either the String is  badly formatted or if this kind of property can't be expressed  as text.

Parameters:

 text - The string to be parsed.

 getTags

  public String[] getTags()

 If the property value must be one of a set of known tagged values,  then this method should return an array of the tag values. This can  be used to represent (for example) enum values. If a PropertyEditor  supports tags, then it should support the use of setAsText with  a tag value as a way of setting the value.

Returns:

 The tag values for this property. May be null if this  property cannot be represented as a tagged value.

 getCustomEditor

  public Component getCustomEditor()

 A PropertyEditor may chose to make available a full custom Component  that edits its property value. It is the responsibility of the  PropertyEditor to hook itself up to its editor Component itself and  to report property value changes by firing a PropertyChange event.

 The higher-level code that calls getCustomEditor may either embed  the Component in some larger property sheet, or it may put it in  its own individual dialog, or ...

Returns:

 A java.awt.Component that will allow a human to directly  edit the current property value. May be null if this is 	not supported.

 supportsCustomEditor

  public boolean supportsCustomEditor()

Returns:

 True if the propertyEditor can provide a custom editor.

 addPropertyChangeListener

  public synchronized void addPropertyChangeListener(PropertyChangeListener listener)

 Register a listener for the PropertyChange event. The class will  fire a PropertyChange value whenever the value is updated.

Parameters:

 listener - An object to be invoked when a PropertyChange 	event is fired.

 removePropertyChangeListener

  public synchronized void removePropertyChangeListener(PropertyChangeListener listener)

 Remove a listener for the PropertyChange event.

Parameters:

 listener - The PropertyChange listener to be removed.

 firePropertyChange

  public void firePropertyChange()

 Report that we have been modified to any interested listeners.

Parameters:

 source - The PropertyEditor that caused the event.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.PropertyVetoException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.beans.PropertyVetoException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.beans.PropertyVetoException

______________________________________________________________________________

 public class PropertyVetoException

 extends Exception

A PropertyVetoException is thrown when a proposed change to a  property represents an unacceptable value.

______________________________________________________________________________

 	PropertyVetoException(String, PropertyChangeEvent)

 	getPropertyChangeEvent()

 PropertyVetoException

  public PropertyVetoException(String mess,
                               PropertyChangeEvent evt)

Parameters:

 mess - Descriptive message

 evt - A PropertyChangeEvent describing the vetoed change.

 getPropertyChangeEvent

  public PropertyChangeEvent getPropertyChangeEvent()

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.SimpleBeanInfo

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.beans.SimpleBeanInfo

java.lang.Object
   |
   +----java.beans.SimpleBeanInfo

______________________________________________________________________________

 public class SimpleBeanInfo

 extends Object

 implements BeanInfo

This is a support class to make it easier for people to provide  BeanInfo classes.

 It defaults to providing "noop" information, and can be selectively  overriden to provide more explicit information on chosen topics.  When the introspector sees the "noop" values, it will apply low  level introspection and design patterns to automatically analyze  the target bean.

______________________________________________________________________________

 	SimpleBeanInfo()

 	getAdditionalBeanInfo()

 Claim there are no other relevant BeanInfo objects.

 	getBeanDescriptor()

 Deny knowledge about the class and customizer of the bean.

 	getDefaultEventIndex()

 Deny knowledge of a default event.

 	getDefaultPropertyIndex()

 Deny knowledge of a default property.

 	getEventSetDescriptors()

 Deny knowledge of event sets.

 	getIcon(int)

 Claim there are no icons available.

 	getMethodDescriptors()

 Deny knowledge of methods.

 	getPropertyDescriptors()

 Deny knowledge of properties.

 	loadImage(String)

 This is a utility method to help in loading icon images.

 SimpleBeanInfo

  public SimpleBeanInfo()

 getBeanDescriptor

  public BeanDescriptor getBeanDescriptor()

 Deny knowledge about the class and customizer of the bean.  You can override this if you wish to provide explicit info.

 getPropertyDescriptors

  public PropertyDescriptor[] getPropertyDescriptors()

 Deny knowledge of properties. You can override this  if you wish to provide explicit property info.

 getDefaultPropertyIndex

  public int getDefaultPropertyIndex()

 Deny knowledge of a default property. You can override this  if you wish to define a default property for the bean.

 getEventSetDescriptors

  public EventSetDescriptor[] getEventSetDescriptors()

 Deny knowledge of event sets. You can override this  if you wish to provide explicit event set info.

 getDefaultEventIndex

  public int getDefaultEventIndex()

 Deny knowledge of a default event. You can override this  if you wish to define a default event for the bean.

 getMethodDescriptors

  public MethodDescriptor[] getMethodDescriptors()

 Deny knowledge of methods. You can override this  if you wish to provide explicit method info.

 getAdditionalBeanInfo

  public BeanInfo[] getAdditionalBeanInfo()

 Claim there are no other relevant BeanInfo objects. You  may override this if you want to (for example) return a  BeanInfo for a base class.

 getIcon

  public Image getIcon(int iconKind)

 Claim there are no icons available. You can override  this if you want to provide icons for your bean.

 loadImage

  public Image loadImage(String resourceName)

 This is a utility method to help in loading icon images.  It takes the name of a resource file associated with the  current object's class file and loads an image object  from that file. Typically images will be GIFs.

Parameters:

 resourceName - A pathname relative to the directory 	holding the class file of the current class. For example, 	"wombat.gif".

Returns:

 an image object. May be null if the load failed.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.beans.VetoableChangeListener

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.beans.VetoableChangeListener

 public interface VetoableChangeListener

 extends EventListener

A VetoableChange event gets fired whenever a bean changes a "constrained"  property. You can register a VetoableChangeListener with a source bean  so as to be notified of any constrained property updates.

______________________________________________________________________________

 	vetoableChange(PropertyChangeEvent)

 This method gets called when a constrained property is changed.

 vetoableChange

  public abstract void vetoableChange(PropertyChangeEvent evt) throws PropertyVetoException

 This method gets called when a constrained property is changed.

Parameters:

 evt - a PropertyChangeEvent object describing the  event source and the property that has changed.

Throws: PropertyVetoException

 if the recipient wishes the property  change to be rolled back.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.beans.VetoableChangeSupport

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.beans.VetoableChangeSupport

java.lang.Object
   |
   +----java.beans.VetoableChangeSupport

______________________________________________________________________________

 public class VetoableChangeSupport

 extends Object

 implements Serializable

This is a utility class that can be used by beans that support constrained  properties. Your can either inherit from this class or you can use  an instance of this class as a member field of your bean and delegate  various work to it.

______________________________________________________________________________

 	VetoableChangeSupport(Object)

 	addVetoableChangeListener(VetoableChangeListener)

 Add a VetoableListener to the listener list.

 	fireVetoableChange(String, Object, Object)

 Report a vetoable property update to any registered listeners.

 	removeVetoableChangeListener(VetoableChangeListener)

 Remove a VetoableChangeListener from the listener list.

 VetoableChangeSupport

  public VetoableChangeSupport(Object sourceBean)

 addVetoableChangeListener

  public synchronized void addVetoableChangeListener(VetoableChangeListener listener)

 Add a VetoableListener to the listener list.

Parameters:

 listener - The VetoableChangeListener to be added

 removeVetoableChangeListener

  public synchronized void removeVetoableChangeListener(VetoableChangeListener listener)

 Remove a VetoableChangeListener from the listener list.

Parameters:

 listener - The VetoableChangeListener to be removed

 fireVetoableChange

  public void fireVetoableChange(String propertyName,
                                 Object oldValue,
                                 Object newValue) throws PropertyVetoException

 Report a vetoable property update to any registered listeners. If  anyone vetos the change, then fire a new event reverting everyone to  the old value and then rethrow the PropertyVetoException.

 No event is fired if old and new are equal and non-null.

Parameters:

 propertyName - The programmatic name of the property 	that was changed.

 oldValue - The old value of the property.

 newValue - The new value of the property.

Throws: PropertyVetoException

 if the proposed property change  represents an unacceptable value.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.beans.Visibility

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.beans.Visibility

 public interface Visibility

Under some circumstances a bean may be run on servers where a GUI  is not available. This interface can be used to query a bean to  determine whether it absolutely needs a gui, and to advise the  bean whether a GUI is available.

 This interface is for expert developers, and is not needed  for normal simple beans. To avoid confusing end-users we  avoid using getXXX setXXX design patterns for these methods.

______________________________________________________________________________

 	avoidingGui()

  	dontUseGui()

 This method instructs the bean that it should not use the Gui.

 	needsGui()

  	okToUseGui()

 This method instructs the bean that it is OK to use the Gui.

 needsGui

  public abstract boolean needsGui()

Returns:

 True if the bean absolutely needs a GUI available in 	order to get its work done.

 dontUseGui

  public abstract void dontUseGui()

 This method instructs the bean that it should not use the Gui.

 okToUseGui

  public abstract void okToUseGui()

 This method instructs the bean that it is OK to use the Gui.

 avoidingGui

  public abstract boolean avoidingGui()

Returns:

 true if the bean is currently avoiding use of the Gui.  e.g. due to a call on dontUseGui().

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.BufferedInputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.BufferedInputStream

java.lang.Object
   |
   +----java.io.InputStream
           |
           +----java.io.FilterInputStream
                   |
                   +----java.io.BufferedInputStream

______________________________________________________________________________

 public class BufferedInputStream

 extends FilterInputStream

The class implements a buffered input stream. By setting up such  an input stream, an application can read bytes from a stream  without necessarily causing a call to the underlying system for  each byte read. The data is read by blocks into a buffer;  subsequent reads can access the data directly from the buffer.

______________________________________________________________________________

 	buf

 The buffer where data is stored.

 	count

 The index one greater than the index of the last valid byte in  the buffer.

 	marklimit

 The maximum read ahead allowed after a call to the  mark  method before subsequent calls to the  reset method fail.

 	markpos

 The value of the pos field at the time the last  mark method was called.

 	pos

 The current position in the buffer.

 	BufferedInputStream(InputStream)

 Creates a new buffered input stream to read data from the  specified input stream with a default 512-byte buffer size.

 	BufferedInputStream(InputStream, int)

 Creates a new buffered input stream to read data from the  specified input stream with the specified buffer size.

 	available()

 Returns the number of bytes that can be read from this input  stream without blocking.

 	mark(int)

 Marks the current position in this input stream.

 	markSupported()

 Tests if this input stream supports the mark  and reset methods.

 	read()

 Reads the next byte of data from this buffered input stream.

 	read(byte[], int, int)

 Reads up to len bytes of data from this buffered  input stream into an array of bytes.

 	reset()

 Repositions this stream to the position at the time the  mark  method was last called on this input stream.

 	skip(long)

 Skips over and discards n bytes of data from the  input stream.

 buf

  protected byte buf[]

 The buffer where data is stored.

 count

  protected int count

 The index one greater than the index of the last valid byte in  the buffer.

 pos

  protected int pos

 The current position in the buffer. This is the index of the next  character to be read from the buf array.

See Also:

buf

 markpos

  protected int markpos

 The value of the pos field at the time the last  mark method was called. The value of this field is  -1  if there is no current mark.

See Also:

mark, pos

 marklimit

  protected int marklimit

 The maximum read ahead allowed after a call to the  mark  method before subsequent calls to the  reset method fail.

See Also:

mark, reset

 BufferedInputStream

  public BufferedInputStream(InputStream in)

 Creates a new buffered input stream to read data from the  specified input stream with a default 512-byte buffer size.

Parameters:

 in - the underlying input stream.

 BufferedInputStream

  public BufferedInputStream(InputStream in,
                             int size)

 Creates a new buffered input stream to read data from the  specified input stream with the specified buffer size.

Parameters:

 in - the underlying input stream.

 size - the buffer size.

 read

  public synchronized int read() throws IOException

 Reads the next byte of data from this buffered input stream. The  value byte is returned as an int in the range  0 to 255 . If no byte is available  because the end of the stream has been reached, the value  -1  is returned. This method blocks until input data  is available, the end of the stream is detected, or an exception  is thrown.

 The read method of BufferedInputStream  returns the next byte of data from its buffer if the buffer is not  empty. Otherwise, it refills the buffer from the underlying input  stream and returns the next character, if the underlying stream  has not returned an end-of-stream indicator.

Returns:

 the next byte of data, or -1 if the end of the  stream is reached.

Throws: IOException

 if an I/O error occurs.

Overrides:

read in class FilterInputStream

See Also:

in

 read

  public synchronized int read(byte b[],
                               int off,
                               int len) throws IOException

 Reads up to len bytes of data from this buffered  input stream into an array of bytes. This method blocks until some  input is available.

 The read method of BufferedInputStream  copies bytes from its buffer into the array argument if the buffer  is not empty. Otherwise, it refills the buffer from the underlying  input stream and unless the underlying stream returns an  end-of-stream indicator, it fills the array argument with  characters from the newly filled buffer.

Parameters:

 b - the buffer into which the data is read.

 off - the start offset of the data.

 len - the maximum number of bytes read.

Returns:

 the total number of bytes read into the buffer,  or -1  if there is no more data because the end  of the stream has been reached.

Throws: IOException

 if an I/O error occurs.

Overrides:

read in class FilterInputStream

See Also:

in

 skip

  public synchronized long skip(long n) throws IOException

 Skips over and discards n bytes of data from the  input stream. The skip method may, for a variety of  reasons, end up skipping over some smaller number of bytes,  possibly zero. The actual number of bytes skipped is returned.

 The skip method of BufferedInputStream  compares the number of bytes it has available in its buffer,  k, where k  = count - pos,  with n. If n &le; k,  then the pos field is incremented by n.  Otherwise, the pos  field is incremented to have the  value count, and the remaining bytes are skipped by  calling the skip method on the underlying input  stream, supplying the argument n - k.

Parameters:

 n - the number of bytes to be skipped.

Returns:

 the actual number of bytes skipped.

Throws: IOException

 if an I/O error occurs.

Overrides:

skip in class FilterInputStream

 available

  public synchronized int available() throws IOException

 Returns the number of bytes that can be read from this input  stream without blocking.

 The available method of  BufferedInputStream  returns the sum of the the number  of bytes remaining to be read in the buffer  (count - pos)  and the result of calling the available method of the  underlying input stream.

Returns:

 the number of bytes that can be read from this input  stream without blocking.

Throws: IOException

 if an I/O error occurs.

Overrides:

available in class FilterInputStream

See Also:

in

 mark

  public synchronized void mark(int readlimit)

 Marks the current position in this input stream. A subsequent  call to the reset method repositions the stream at  the last marked position so that subsequent reads re-read the same  bytes.

 The readlimit argument tells the input stream to  allow that many bytes to be read before the mark position gets  invalidated.

Parameters:

 readlimit - the maximum limit of bytes that can be read before  the mark position becomes invalid.

Overrides:

mark in class FilterInputStream

See Also:

reset

 reset

  public synchronized void reset() throws IOException

 Repositions this stream to the position at the time the  mark method was last called on this input stream.

 If the stream has not been marked, or if the mark has been invalidated,  an IOException is thrown. Stream marks are intended to be used in  situations where you need to read ahead a little to see what's in  the stream. Often this is most easily done by invoking some  general parser. If the stream is of the type handled by the  parser, it just chugs along happily. If the stream is not of  that type, the parser should toss an exception when it fails. If an  exception gets tossed within readlimit bytes, the parser will allow the  outer code to reset the stream and to try another parser.

Throws: IOException

 if this stream has not been marked or  if the mark has been invalidated.

Overrides:

reset in class FilterInputStream

See Also:

mark

 markSupported

  public boolean markSupported()

 Tests if this input stream supports the mark  and reset methods. The markSupported  method of BufferedInputStream  returns  true.

Returns:

 a boolean indicating if this stream type supports  the mark and reset methods.

Overrides:

markSupported in class FilterInputStream

See Also:

mark, reset

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.BufferedOutputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.BufferedOutputStream

java.lang.Object
   |
   +----java.io.OutputStream
           |
           +----java.io.FilterOutputStream
                   |
                   +----java.io.BufferedOutputStream

______________________________________________________________________________

 public class BufferedOutputStream

 extends FilterOutputStream

The class implements a buffered output stream. By setting up such  an output stream, an application can write bytes to the underlying  output stream without necessarily causing a call to the underlying  system for each byte written. The data is written into a buffer,  and then written to the underlying stream if the buffer reaches  its capacity, the buffer output stream is closed, or the buffer  output stream is explicity flushed.

______________________________________________________________________________

 	buf

 The buffer where data is stored.

 	count

 The number of valid bytes in the buffer.

 	BufferedOutputStream(OutputStream)

 Creates a new buffered output stream to write data to the  specified underlying output stream with a default 512-byte buffer size.

 	BufferedOutputStream(OutputStream, int)

 Creates a new buffered output stream to write data to the  specified underlying output stream with the specified buffer size.

 	flush()

 Flushes this buffered output stream.

 	write(byte[], int, int)

 Writes len bytes from the specified byte array  starting at offset off  to this buffered output stream.

 	write(int)

 Writes the specified byte to this buffered output stream.

 buf

  protected byte buf[]

 The buffer where data is stored.

 count

  protected int count

 The number of valid bytes in the buffer.

 BufferedOutputStream

  public BufferedOutputStream(OutputStream out)

 Creates a new buffered output stream to write data to the  specified underlying output stream with a default 512-byte buffer size.

Parameters:

 out - the underlying output stream.

 BufferedOutputStream

  public BufferedOutputStream(OutputStream out,
                              int size)

 Creates a new buffered output stream to write data to the  specified underlying output stream with the specified buffer size.

Parameters:

 out - the underlying output stream.

 size - the buffer size.

 write

  public synchronized void write(int b) throws IOException

 Writes the specified byte to this buffered output stream.

Parameters:

 b - the byte to be written.

Throws: IOException

 if an I/O error occurs.

Overrides:

write in class FilterOutputStream

 write

  public synchronized void write(byte b[],
                                 int off,
                                 int len) throws IOException

 Writes len bytes from the specified byte array  starting at offset off to this buffered output stream.

Parameters:

 b - the data.

 off - the start offset in the data.

 len - the number of bytes to write.

Throws: IOException

 if an I/O error occurs.

Overrides:

write in class FilterOutputStream

 flush

  public synchronized void flush() throws IOException

 Flushes this buffered output stream. This forces any buffered  output bytes to be written out to the underlying output stream.

Throws: IOException

 if an I/O error occurs.

Overrides:

flush in class FilterOutputStream

See Also:

out

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.BufferedReader

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.BufferedReader

java.lang.Object
   |
   +----java.io.Reader
           |
           +----java.io.BufferedReader

______________________________________________________________________________

 public class BufferedReader

 extends Reader

Read text from a character-input stream, buffering characters so as to  provide for the efficient reading of characters, arrays, and lines.

 The buffer size may be specified, or the default size may be used. The  default is large enough for most purposes.

 In general, each read request made of a Reader causes a corresponding  read request to be made of the underlying character or byte stream. It is  therefore advisable to wrap a BufferedReader around any Reader whose read()  operations may be costly, such as FileReaders and InputStreamReaders. For  example,

 BufferedReader in
   = new BufferedReader(new FileReader("foo.in"));

 will buffer the input from the specified file. Without buffering, each  invocation of read() or readLine() could cause bytes to be read from the  file, converted into characters, and then returned, which can be very  inefficient.

 Programs that use DataInputStreams for textual input can be localized by  replacing each DataInputStream with an appropriate BufferedReader.

See Also:

FileReader, InputStreamReader

______________________________________________________________________________

 	BufferedReader(Reader)

 Create a buffering character-input stream that uses a default-sized  input buffer.

 	BufferedReader(Reader, int)

 Create a buffering character-input stream that uses an input buffer of  the specified size.

 	close()

 Close the stream.

 	mark(int)

 Mark the present position in the stream.

 	markSupported()

 Tell whether this stream supports the mark() operation, which it does.

 	read()

 Read a single character.

 	read(char[], int, int)

 Read characters into a portion of an array.

 	readLine()

 Read a line of text.

 	ready()

 Tell whether this stream is ready to be read.

 	reset()

 Reset the stream to the most recent mark.

 	skip(long)

 Skip characters.

 BufferedReader

  public BufferedReader(Reader in,
                        int sz)

 Create a buffering character-input stream that uses an input buffer of  the specified size.

Parameters:

 in - A Reader

 sz - Input-buffer size

Throws: IllegalArgumentException

 If sz is

 BufferedReader

  public BufferedReader(Reader in)

 Create a buffering character-input stream that uses a default-sized  input buffer.

Parameters:

 in - A Reader

 read

  public int read() throws IOException

 Read a single character.

Throws: IOException

 If an I/O error occurs

Overrides:

read in class Reader

 read

  public int read(char cbuf[],
                  int off,
                  int len) throws IOException

 Read characters into a portion of an array.

Parameters:

 cbuf - Destination buffer

 off - Offset at which to start storing characters

 len - Maximum number of characters to read

Returns:

 The number of bytes read, or -1 if the end of the stream has  been reached

Throws: IOException

 If an I/O error occurs

Overrides:

read in class Reader

 readLine

  public String readLine() throws IOException

 Read a line of text. A line is considered to be terminated by any one  of a line feed ('\n'), a carriage return ('\r'), or a carriage return  followed immediately by a linefeed.

Returns:

 A String containing the contents of the line, not including  any line-termination characters, or null if the end of the  stream has been reached

Throws: IOException

 If an I/O error occurs

 skip

  public long skip(long n) throws IOException

 Skip characters.

Parameters:

 n - The number of characters to skip

Returns:

 The number of characters actually skipped

Throws: IOException

 If an I/O error occurs

Overrides:

skip in class Reader

 ready

  public boolean ready() throws IOException

 Tell whether this stream is ready to be read. A buffered character  stream is ready if the buffer is not empty, or if the underlying  character stream is ready.

Throws: IOException

 If an I/O error occurs

Overrides:

ready in class Reader

 markSupported

  public boolean markSupported()

 Tell whether this stream supports the mark() operation, which it does.

Overrides:

markSupported in class Reader

 mark

  public void mark(int readAheadLimit) throws IOException

 Mark the present position in the stream. Subsequent calls to reset()  will attempt to reposition the stream to this point.

Parameters:

 readAheadLimit - Limit on the number of characters that may be  read while still preserving the mark. After  reading this many characters, attempting to  reset the stream may fail.

Throws: IOException

 If an I/O error occurs

Overrides:

mark in class Reader

 reset

  public void reset() throws IOException

 Reset the stream to the most recent mark.

Throws: IOException

 If the stream has never been marked,  or if the mark has been invalidated

Overrides:

reset in class Reader

 close

  public void close() throws IOException

 Close the stream.

Throws: IOException

 If an I/O error occurs

Overrides:

close in class Reader

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.BufferedWriter

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.BufferedWriter

java.lang.Object
   |
   +----java.io.Writer
           |
           +----java.io.BufferedWriter

______________________________________________________________________________

 public class BufferedWriter

 extends Writer

Write text to a character-output stream, buffering characters so as to  provide for the efficient writing of single characters, arrays, and strings.

 The buffer size may be specified, or the default size may be accepted.  The default is large enough for most purposes.

 A newLine() method is provided, which uses the platform's own notion of  line separator as defined by the system property line.separator.  Not all platforms use the newline character ('\n') to terminate lines.  Calling this method to terminate each output line is therefore preferred to  writing a newline character directly.

 In general, a Writer sends its output immediately to the underlying  character or byte stream. Unless prompt output is required, it is advisable  to wrap a BufferedWriter around any Writer whose write() operations may be  costly, such as FileWriters and OutputStreamWriters. For example,

 PrintWriter out
   = new PrintWriter(new BufferedWriter(new FileWriter("foo.out")));

 will buffer the PrintWriter's output to the file. Without buffering, each  invocation of a print() method would cause characters to be converted into  bytes that would then be written immediately to the file, which can be very  inefficient.

See Also:

PrintWriter, FileWriter, OutputStreamWriter

______________________________________________________________________________

 	BufferedWriter(Writer)

 Create a buffered character-output stream that uses a default-sized  output buffer.

 	BufferedWriter(Writer, int)

 Create a new buffered character-output stream that uses an output  buffer of the given size.

 	close()

 Close the stream.

 	flush()

 Flush the stream.

 	newLine()

 Write a line separator.

 	write(char[], int, int)

 Write a portion of an array of characters.

 	write(int)

 Write a single character.

 	write(String, int, int)

 Write a portion of a String.

 BufferedWriter

  public BufferedWriter(Writer out)

 Create a buffered character-output stream that uses a default-sized  output buffer.

Parameters:

 out - A Writer

 BufferedWriter

  public BufferedWriter(Writer out,
                        int sz)

 Create a new buffered character-output stream that uses an output  buffer of the given size.

Parameters:

 out - A Writer

 sz - Output-buffer size, a positive integer

Throws: IllegalArgumentException

 If sz is

 write

  public void write(int c) throws IOException

 Write a single character.

Throws: IOException

 If an I/O error occurs

Overrides:

write in class Writer

 write

  public void write(char cbuf[],
                    int off,
                    int len) throws IOException

 Write a portion of an array of characters.

Parameters:

 cbuf - A character array

 off - Offset from which to start reading characters

 len - Number of characters to write

Throws: IOException

 If an I/O error occurs

Overrides:

write in class Writer

 write

  public void write(String s,
                    int off,
                    int len) throws IOException

 Write a portion of a String.

Parameters:

 s - String to be written

 off - Offset from which to start reading characters

 len - Number of characters to be written

Throws: IOException

 If an I/O error occurs

Overrides:

write in class Writer

 newLine

  public void newLine() throws IOException

 Write a line separator. The line separator string is defined by the  system property line.separator, and is not necessarily a single  newline ('\n') character.

Throws: IOException

 If an I/O error occurs

 flush

  public void flush() throws IOException

 Flush the stream.

Throws: IOException

 If an I/O error occurs

Overrides:

flush in class Writer

 close

  public void close() throws IOException

 Close the stream.

Throws: IOException

 If an I/O error occurs

Overrides:

close in class Writer

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.ByteArrayInputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.ByteArrayInputStream

java.lang.Object
   |
   +----java.io.InputStream
           |
           +----java.io.ByteArrayInputStream

______________________________________________________________________________

 public class ByteArrayInputStream

 extends InputStream

This class allows an application to create an input stream in  which the bytes read are supplied by the contents of a byte array.  Applications can also read bytes from a string by using a  StringBufferInputStream.

See Also:

StringBufferInputStream

______________________________________________________________________________

 	buf

 The byte array containing the data.

 	count

 The index one greater than the last valid character in the input  stream buffer.

 	mark

 The currently marked position in the stream.

 	pos

 The index of the next character to read from the input stream buffer.

 	ByteArrayInputStream(byte[])

 Creates a new byte array input stream that reads data from the  specified byte array.

 	ByteArrayInputStream(byte[], int, int)

 Creates a new byte array input stream that reads data from the  specified byte array.

 	available()

 Returns the number of bytes that can be read from this input  stream without blocking.

 	mark(int)

 Set the current marked position in the stream.

 	markSupported()

 Tests if ByteArrayInputStream supports mark/reset.

 	read()

 Reads the next byte of data from this input stream.

 	read(byte[], int, int)

 Reads up to len bytes of data into an array of bytes  from this input stream.

 	reset()

 Resets the buffer to the marked position.

 	skip(long)

 Skips n bytes of input from this input stream.

 buf

  protected byte buf[]

 The byte array containing the data.

 pos

  protected int pos

 The index of the next character to read from the input stream buffer.

 mark

  protected int mark

 The currently marked position in the stream.  ByteArrayInputStreams are marked at position zero by  default when constructed. They may be marked at another  position within the buffer by the mark() method.  The current buffer position is set to this point by the  reset() method.

 count

  protected int count

 The index one greater than the last valid character in the input  stream buffer.

 ByteArrayInputStream

  public ByteArrayInputStream(byte buf[])

 Creates a new byte array input stream that reads data from the  specified byte array. The byte array is not copied.

Parameters:

 buf - the input buffer.

 ByteArrayInputStream

  public ByteArrayInputStream(byte buf[],
                              int offset,
                              int length)

 Creates a new byte array input stream that reads data from the  specified byte array. Up to length characters are to  be read from the byte array, starting at the indicated offset.

 The byte array is not copied.

Parameters:

 buf - the input buffer.

 offset - the offset in the buffer of the first byte to read.

 length - the maximum number of bytes to read from the buffer.

 read

  public synchronized int read()

 Reads the next byte of data from this input stream. The value  byte is returned as an int in the range  0 to 255 . If no byte is available  because the end of the stream has been reached, the value  -1  is returned.

 The read method of ByteArrayInputStream  cannot block.

Returns:

 the next byte of data, or -1 if the end of the  stream has been reached.

Overrides:

read in class InputStream

 read

  public synchronized int read(byte b[],
                               int off,
                               int len)

 Reads up to len bytes of data into an array of bytes  from this input stream. This read method cannot block.

Parameters:

 b - the buffer into which the data is read.

 off - the start offset of the data.

 len - the maximum number of bytes read.

Returns:

 the total number of bytes read into the buffer, or  -1  if there is no more data because the end of  the stream has been reached.

Overrides:

read in class InputStream

 skip

  public synchronized long skip(long n)

 Skips n bytes of input from this input stream. Fewer  bytes might be skipped if the end of the input stream is reached.

Parameters:

 n - the number of bytes to be skipped.

Returns:

 the actual number of bytes skipped.

Overrides:

skip in class InputStream

 available

  public synchronized int available()

 Returns the number of bytes that can be read from this input  stream without blocking.

 The available method of  ByteArrayInputStream returns the value of  count - pos,  which is the number of bytes remaining to be read from the input buffer.

Returns:

 the number of bytes that can be read from the input stream  without blocking.

Overrides:

available in class InputStream

 markSupported

  public boolean markSupported()

 Tests if ByteArrayInputStream supports mark/reset.

Overrides:

markSupported in class InputStream

 mark

  public void mark(int markpos)

 Set the current marked position in the stream.  ByteArrayInputStreams are marked at position zero by  default when constructed. They may be marked at another  position within the buffer by this method.

Overrides:

mark in class InputStream

 reset

  public synchronized void reset()

 Resets the buffer to the marked position. The marked position  is the beginning unless another position was marked.

Overrides:

reset in class InputStream

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.ByteArrayOutputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.ByteArrayOutputStream

java.lang.Object
   |
   +----java.io.OutputStream
           |
           +----java.io.ByteArrayOutputStream

______________________________________________________________________________

 public class ByteArrayOutputStream

 extends OutputStream

This class implements an output stream in which the data is  written into a byte array. The buffer automatically grows as data  is written to it.  The data can be retrieved using toByteArray() and  toString().

______________________________________________________________________________

 	buf

 The buffer where data is stored.

 	count

 The number of valid bytes in the buffer.

 	ByteArrayOutputStream()

 Creates a new byte array output stream.

 	ByteArrayOutputStream(int)

 Creates a new byte array output stream, with a buffer capacity of  the specified size, in bytes.

 	reset()

 Resets the count field of this byte array output  stream to zero, so that all currently accumulated output in the  ouput stream is discarded.

 	size()

 Returns the current size of the buffer.

 	toByteArray()

 Creates a newly allocated byte array.

 	toString()

 Creates a newly allocated string.

 	toString(int)

 Creates a newly allocated string. Deprecated.

 	toString(String)

 Converts input data to a string, using the specified character encoding.

 	write(byte[], int, int)

 Writes len bytes from the specified byte array  starting at offset off  to this byte array output stream.

 	write(int)

 Writes the specified byte to this byte array output stream.

 	writeTo(OutputStream)

 Writes the complete contents of this byte array output stream to  the specified output stream argument, as if by calling the output  stream's write method using out.write(buf, 0, count).

 buf

  protected byte buf[]

 The buffer where data is stored.

 count

  protected int count

 The number of valid bytes in the buffer.

 ByteArrayOutputStream

  public ByteArrayOutputStream()

 Creates a new byte array output stream. The buffer capacity is  initially 32 bytes, though its size increases if necessary.

 ByteArrayOutputStream

  public ByteArrayOutputStream(int size)

 Creates a new byte array output stream, with a buffer capacity of  the specified size, in bytes.

Parameters:

 size - the initial size.

 write

  public synchronized void write(int b)

 Writes the specified byte to this byte array output stream.

Parameters:

 b - the byte to be written.

Overrides:

write in class OutputStream

 write

  public synchronized void write(byte b[],
                                 int off,
                                 int len)

 Writes len bytes from the specified byte array  starting at offset off to this byte array output stream.

Parameters:

 b - the data.

 off - the start offset in the data.

 len - the number of bytes to write.

Overrides:

write in class OutputStream

 writeTo

  public synchronized void writeTo(OutputStream out) throws IOException

 Writes the complete contents of this byte array output stream to  the specified output stream argument, as if by calling the output  stream's write method using out.write(buf, 0, count).

Parameters:

 out - the output stream to which to write the data.

Throws: IOException

 if an I/O error occurs.

 reset

  public synchronized void reset()

 Resets the count field of this byte array output  stream to zero, so that all currently accumulated output in the  ouput stream is discarded. The output stream can be used again,  reusing the already allocated buffer space.

See Also:

count

 toByteArray

  public synchronized byte[] toByteArray()

 Creates a newly allocated byte array. Its size is the current  size of this output stream and the valid contents of the buffer  have been copied into it.

Returns:

 the current contents of this output stream, as a byte array.

See Also:

size

 size

  public int size()

 Returns the current size of the buffer.

Returns:

 the value of the count field, which is the number  of valid bytes in this output stream.

See Also:

count

 toString

  public String toString()

 Creates a newly allocated string. Its size is the current size of  this output stream and the valid contents of the buffer have been  copied into it. Each character c in the resulting string is  constructed from the corresponding element b  in the byte  array such that:

  c == (char)(b & 0xff)

Returns:

 the current contents of this output stream, as a string.

Overrides:

toString in class Object

See Also:

size

 toString

  public String toString(String enc) throws UnsupportedEncodingException

 Converts input data to a string, using the specified character encoding.

Parameters:

 enc - a character-encoding name.

 toString

  public String toString(int hibyte)

 Note: toString() is deprecated. This method does not properly convert bytes into characters.  As of JDK 1.1, the preferred way to do this is using  the toString  method that takes an encoding-name  argument, or that uses the platform's default character  encoding.

 Creates a newly allocated string. Its size is the current size of  the output stream and the valid contents of the buffer have been  copied into it. Each character c in the resulting string is  constructed from the corresponding element b  in the byte  array such that:

  c == (char)(((hibyte & 0xff) << 8) | (b & 0xff))

Parameters:

 hibyte - the bits set.

Returns:

 the current contents of the output stream, as a string.

See Also:

size

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.CharArrayReader

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.CharArrayReader

java.lang.Object
   |
   +----java.io.Reader
           |
           +----java.io.CharArrayReader

______________________________________________________________________________

 public class CharArrayReader

 extends Reader

This class implements a character buffer that can be used as a  character-input stream.

______________________________________________________________________________

 	buf

 Character buffer

 	count

 Number of valid characters in buffer

 	markedPos

 Position of mark in buffer

 	pos

 Current buffer position

 	CharArrayReader(char[])

 Create an CharArrayReader from the specified array of chars.

 	CharArrayReader(char[], int, int)

 Create an CharArrayReader from the specified array of chars.

 	close()

 Close the stream.

 	mark(int)

 Mark the present position in the stream.

 	markSupported()

 Tell whether this stream supports the mark() operation, which it does.

 	read()

 Read a single character.

 	read(char[], int, int)

 Read characters into a portion of an array.

 	ready()

 Tell whether this stream is ready to be read.

 	reset()

 Reset the stream to the most recent mark, or to the beginning if it has  never been marked.

 	skip(long)

 Skip characters.

 buf

  protected char buf[]

 Character buffer

 pos

  protected int pos

 Current buffer position

 markedPos

  protected int markedPos

 Position of mark in buffer

 count

  protected int count

 Number of valid characters in buffer

 CharArrayReader

  public CharArrayReader(char buf[])

 Create an CharArrayReader from the specified array of chars.

Parameters:

 buf - Input buffer (not copied)

 CharArrayReader

  public CharArrayReader(char buf[],
                         int offset,
                         int length)

 Create an CharArrayReader from the specified array of chars.

Parameters:

 buf - Input buffer (not copied)

 offset - Offset of the first char to read

 length - Number of chars to read

 read

  public int read() throws IOException

 Read a single character.

Throws: IOException

 If an I/O error occurs

Overrides:

read in class Reader

 read

  public int read(char b[],
                  int off,
                  int len) throws IOException

 Read characters into a portion of an array.

Parameters:

 b - Destination buffer

 off - Offset at which to start storing characters

 len - Maximum number of characters to read

Returns:

 The actual number of characters read, or -1 if  the end of the stream has been reached

Throws: IOException

 If an I/O error occurs

Overrides:

read in class Reader

 skip

  public long skip(long n) throws IOException

 Skip characters.

Parameters:

 n - The number of characters to skip

Returns:

 The number of characters actually skipped

Throws: IOException

 If an I/O error occurs

Overrides:

skip in class Reader

 ready

  public boolean ready() throws IOException

 Tell whether this stream is ready to be read. Character-array readers  are always ready to be read.

Throws: IOException

 If an I/O error occurs

Overrides:

ready in class Reader

 markSupported

  public boolean markSupported()

 Tell whether this stream supports the mark() operation, which it does.

Overrides:

markSupported in class Reader

 mark

  public void mark(int readAheadLimit) throws IOException

 Mark the present position in the stream. Subsequent calls to reset()  will reposition the stream to this point.

Parameters:

 readAheadLimit - Limit on the number of characters that may be  read while still preserving the mark. Because  the stream's input comes from a character array,  there is no actual limit; hence this argument is  ignored.

Throws: IOException

 If an I/O error occurs

Overrides:

mark in class Reader

 reset

  public void reset() throws IOException

 Reset the stream to the most recent mark, or to the beginning if it has   never been marked.

Throws: IOException

 If an I/O error occurs

Overrides:

reset in class Reader

 close

  public void close()

 Close the stream.

Overrides:

close in class Reader

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.CharArrayWriter

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.CharArrayWriter

java.lang.Object
   |
   +----java.io.Writer
           |
           +----java.io.CharArrayWriter

______________________________________________________________________________

 public class CharArrayWriter

 extends Writer

This class implements a character buffer that can be used as an Writer.  The buffer automatically grows when data is written to the stream. The data  can be retrieved using toCharArray() and toString().

______________________________________________________________________________

 	buf

 The buffer where data is stored.

 	count

 The number of chars in the buffer.

 	CharArrayWriter()

 Creates a new CharArrayWriter.

 	CharArrayWriter(int)

 Creates a new CharArrayWriter with the specified initial size.

 	close()

 Close the stream.

 	flush()

 Flush the stream.

 	reset()

 Resets the buffer so that you can use it again without  throwing away the already allocated buffer.

 	size()

 Returns the current size of the buffer.

 	toCharArray()

 Returns a copy of the input data.

 	toString()

 Converts input data to a string.

 	write(char[], int, int)

 Writes characters to the buffer.

 	write(int)

 Writes a character to the buffer.

 	write(String, int, int)

 Write a portion of a string to the buffer.

 	writeTo(Writer)

 Writes the contents of the buffer to another character stream.

 buf

  protected char buf[]

 The buffer where data is stored.

 count

  protected int count

 The number of chars in the buffer.

 CharArrayWriter

  public CharArrayWriter()

 Creates a new CharArrayWriter.

 CharArrayWriter

  public CharArrayWriter(int initialSize)

 Creates a new CharArrayWriter with the specified initial size.

 write

  public void write(int c)

 Writes a character to the buffer.

Overrides:

write in class Writer

 write

  public void write(char c[],
                    int off,
                    int len)

 Writes characters to the buffer.

Parameters:

 c - the data to be written

 off - the start offset in the data

 len - the number of chars that are written

Overrides:

write in class Writer

 write

  public void write(String str,
                    int off,
                    int len)

 Write a portion of a string to the buffer.

Parameters:

 str - String to be written from

 off - Offset from which to start reading characters

 len - Number of characters to be written

Overrides:

write in class Writer

 writeTo

  public void writeTo(Writer out) throws IOException

 Writes the contents of the buffer to another character stream.

Parameters:

 out - the output stream to write to

 reset

  public void reset()

 Resets the buffer so that you can use it again without  throwing away the already allocated buffer.

 toCharArray

  public char[] toCharArray()

 Returns a copy of the input data.

 size

  public int size()

 Returns the current size of the buffer.

 toString

  public String toString()

 Converts input data to a string.

Returns:

 the string.

Overrides:

toString in class Object

 flush

  public void flush()

 Flush the stream.

Overrides:

flush in class Writer

 close

  public void close()

 Close the stream. This method does not release the buffer, since its  contents might still be required.

Overrides:

close in class Writer

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.CharConversionException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.CharConversionException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.io.CharConversionException

______________________________________________________________________________

 public class CharConversionException

 extends IOException

base class for character conversion exceptions

______________________________________________________________________________

 	CharConversionException()

 provides no detailed message

 	CharConversionException(String)

 provides a detailed message

 CharConversionException

  public CharConversionException()

 provides no detailed message

 CharConversionException

  public CharConversionException(String s)

 provides a detailed message

Parameters:

 s - detailed message

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.io.DataInput

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.io.DataInput

 public interface DataInput

The data input interface is implemented by streams that can read  primitive Java data types from a stream in a machine-independent  manner.

See Also:

DataInputStream, DataOutput

______________________________________________________________________________

 	readBoolean()

 Reads a boolean value from the input stream.

 	readByte()

 Reads a signed 8-bit value from the input stream.

 	readChar()

 Reads a Unicode char value from the input stream.

 	readDouble()

 Reads a double value from the input stream.

 	readFloat()

 Reads a float value from the input stream.

 	readFully(byte[])

 Reads b.length bytes into the byte array.

 	readFully(byte[], int, int)

 Reads b.length bytes into the byte array.

 	readInt()

 Reads an int value from the input stream.

 	readLine()

 Reads the next line of text from the input stream.

 	readLong()

 Reads a long value from the input stream.

 	readShort()

 Reads a 16-bit value from the input stream.

 	readUnsignedByte()

 Reads an unsigned 8-bit value from the input stream.

 	readUnsignedShort()

 Reads an unsigned 16-bit value from the input stream.

 	readUTF()

 Reads in a string that has been encoded using a modified UTF-8 format.

 	skipBytes(int)

 Skips exactly n bytes of input.

 readFully

  public abstract void readFully(byte b[]) throws IOException

 Reads b.length bytes into the byte array. This  method blocks until all the bytes are read.

Parameters:

 b - the buffer into which the data is read.

Throws: EOFException

 if this stream reaches the end before reading  all the bytes.

Throws: IOException

 if an I/O error occurs.

 readFully

  public abstract void readFully(byte b[],
                                 int off,
                                 int len) throws IOException

 Reads b.length bytes into the byte array. This  method blocks until all the bytes are read.

Parameters:

 b - the buffer into which the data is read.

Throws: EOFException

 if this stream reaches the end before reading  all the bytes.

Throws: IOException

 if an I/O error occurs.

 skipBytes

  public abstract int skipBytes(int n) throws IOException

 Skips exactly n bytes of input.

Parameters:

 n - the number of bytes to be skipped.

Returns:

 the number of bytes skipped, which is always n.

Throws: EOFException

 if this stream reaches the end before skipping  all the bytes.

Throws: IOException

 if an I/O error occurs.

 readBoolean

  public abstract boolean readBoolean() throws IOException

 Reads a boolean value from the input stream.

Returns:

 the boolean value read.

Throws: EOFException

 if this stream reaches the end before reading  all the bytes.

Throws: IOException

 if an I/O error occurs.

 readByte

  public abstract byte readByte() throws IOException

 Reads a signed 8-bit value from the input stream.

Returns:

 the 8-bit value read.

Throws: EOFException

 if this stream reaches the end before reading  all the bytes.

Throws: IOException

 if an I/O error occurs.

 readUnsignedByte

  public abstract int readUnsignedByte() throws IOException

 Reads an unsigned 8-bit value from the input stream.

Returns:

 the unsigned 8-bit value read.

Throws: EOFException

 if this stream reaches the end before reading  all the bytes.

Throws: IOException

 if an I/O error occurs.

 readShort

  public abstract short readShort() throws IOException

 Reads a 16-bit value from the input stream.

Returns:

 the 16-bit value read.

Throws: EOFException

 if this stream reaches the end before reading  all the bytes.

Throws: IOException

 if an I/O error occurs.

 readUnsignedShort

  public abstract int readUnsignedShort() throws IOException

 Reads an unsigned 16-bit value from the input stream.

Returns:

 the unsigned 16-bit value read.

Throws: EOFException

 if this stream reaches the end before reading  all the bytes.

Throws: IOException

 if an I/O error occurs.

 readChar

  public abstract char readChar() throws IOException

 Reads a Unicode char value from the input stream.

Returns:

 the Unicode char read.

Throws: EOFException

 if this stream reaches the end before reading  all the bytes.

Throws: IOException

 if an I/O error occurs.

 readInt

  public abstract int readInt() throws IOException

 Reads an int value from the input stream.

Returns:

 the int value read.

Throws: EOFException

 if this stream reaches the end before reading  all the bytes.

Throws: IOException

 if an I/O error occurs.

 readLong

  public abstract long readLong() throws IOException

 Reads a long value from the input stream.

Returns:

 the long value read.

Throws: EOFException

 if this stream reaches the end before reading  all the bytes.

Throws: IOException

 if an I/O error occurs.

 readFloat

  public abstract float readFloat() throws IOException

 Reads a float value from the input stream.

Returns:

 the float value read.

Throws: EOFException

 if this stream reaches the end before reading  all the bytes.

Throws: IOException

 if an I/O error occurs.

 readDouble

  public abstract double readDouble() throws IOException

 Reads a double value from the input stream.

Returns:

 the double value read.

Throws: EOFException

 if this stream reaches the end before reading  all the bytes.

Throws: IOException

 if an I/O error occurs.

 readLine

  public abstract String readLine() throws IOException

 Reads the next line of text from the input stream.

Returns:

 if this stream reaches the end before reading all the bytes.

Throws: IOException

 if an I/O error occurs.

 readUTF

  public abstract String readUTF() throws IOException

 Reads in a string that has been encoded using a modified UTF-8 format.

 For an exact description of this method, see the discussion in  Gosling, Joy, and Steele, The Java Language Specification.

Returns:

 a Unicode string.

Throws: EOFException

 if this stream reaches the end  before reading all the bytes.

Throws: IOException

 if an I/O error occurs.

Throws: UTFDataFormatException

 if the bytes do not represent a  valid UTF-8 encoding of a string.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.DataInputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.DataInputStream

java.lang.Object
   |
   +----java.io.InputStream
           |
           +----java.io.FilterInputStream
                   |
                   +----java.io.DataInputStream

______________________________________________________________________________

 public class DataInputStream

 extends FilterInputStream

 implements DataInput

A data input stream lets an application read primitive Java data  types from an underlying input stream in a machine-independent  way. An application uses a data output stream to write data that  can later be read by a data input stream.

 Data input streams and data output streams represent Unicode  strings in a format that is a slight modification of UTF-8. (For  more information, see X/Open Company Ltd., "File System Safe  UCS Transformation Format (FSS_UTF)", X/Open Preliminary  Specification, Document Number: P316. This information also  appears in ISO/IEC 10646, Annex P.)

 All characters in the range '\u0001' to  '\u007F'  are represented by a single byte:

0
bits 0-7

 The null character '\u0000' and characters in the  range '\u0080' to '\u07FF' are  represented by a pair of bytes:

1
1
0
bits 6-10
1
0
bits 0-5

 Characters in the range '\u0800' to  '\uFFFF'  are represented by three bytes:

1
1
1
0
bits 12-15
1
0
bits 6-11
1
0
bits 0-5

 The two differences between this format and the  "standard" UTF-8 format are the following:

• The null byte '\u0000'  is encoded in 2-byte format  rather than 1-byte, so that the encoded strings never have  embedded nulls.

• Only the 1-byte, 2-byte, and 3-byte formats are used.

See Also:

DataOutputStream

______________________________________________________________________________

 	DataInputStream(InputStream)

 Creates a new data input stream to read data from the specified  input stream.

 	read(byte[])

 Reads up to byte.length bytes of data from this data  input stream into an array of bytes.

 	read(byte[], int, int)

 Reads up to len bytes of data from this data input  stream into an array of bytes.

 	readBoolean()

 Reads a boolean from this data input stream.

 	readByte()

 Reads a signed 8-bit value from this data input stream.

 	readChar()

 Reads a Unicode character from this data input stream.

 	readDouble()

 Reads a double from this data input stream.

 	readFloat()

 Reads a float from this data input stream.

 	readFully(byte[])

 Reads b.length bytes from this data input stream  into the byte array.

 	readFully(byte[], int, int)

 Reads exactly len bytes from this data input stream  into the byte array.

 	readInt()

 Reads a signed 32-bit integer from this data input stream.

 	readLine()

 Reads the next line of text from this data input stream. Deprecated.

 	readLong()

 Reads a signed 64-bit integer from this data input stream.

 	readShort()

 Reads a signed 16-bit number from this data input stream.

 	readUnsignedByte()

 Reads an unsigned 8-bit number from this data input stream.

 	readUnsignedShort()

 Reads an unsigned 16-bit number from this data input stream.

 	readUTF()

 Reads in a string that has been encoded using a modified UTF-8  format from this data input stream.

 	readUTF(DataInput)

 Reads in a string from the specified data input stream.

 	skipBytes(int)

 Skips exactly n bytes of input in the underlying  input stream.

 DataInputStream

  public DataInputStream(InputStream in)

 Creates a new data input stream to read data from the specified  input stream.

Parameters:

 in - the input stream.

 read

  public final int read(byte b[]) throws IOException

 Reads up to byte.length bytes of data from this data  input stream into an array of bytes. This method blocks until some  input is available.

 The read method of DataInputStream  calls the read  method of its underlying input stream  with the three arguments b, 0, and  b.length and returns whatever value that method returns.

Parameters:

 b - the buffer into which the data is read.

Returns:

 the total number of bytes read into the buffer, or  -1  if there is no more data because the end  of the stream has been reached.

Throws: IOException

 if an I/O error occurs.

Overrides:

read in class FilterInputStream

See Also:

in, read

 read

  public final int read(byte b[],
                        int off,
                        int len) throws IOException

 Reads up to len bytes of data from this data input  stream into an array of bytes. This method blocks until some input  is available.

 The read method of DataInputStream  calls the read  method of its underlying input stream  with the same arguments and returns whatever value that method returns.

Parameters:

 b - the buffer into which the data is read.

 off - the start offset of the data.

 len - the maximum number of bytes read.

Returns:

 the total number of bytes read into the buffer, or  -1  if there is no more data because the end  of the stream has been reached.

Throws: IOException

 if an I/O error occurs.

Overrides:

read in class FilterInputStream

See Also:

in, read

 readFully

  public final void readFully(byte b[]) throws IOException

 Reads b.length bytes from this data input stream  into the byte array. This method reads repeatedly from the  underlying stream until all the bytes are read. This method blocks  until all the bytes are read, the end of the stream is detected,  or an exception is thrown.

Parameters:

 b - the buffer into which the data is read.

Throws: EOFException

 if this input stream reaches the end before  reading all the bytes.

Throws: IOException

 if an I/O error occurs.

See Also:

in

 readFully

  public final void readFully(byte b[],
                              int off,
                              int len) throws IOException

 Reads exactly len bytes from this data input stream  into the byte array. This method reads repeatedly from the  underlying stream until all the bytes are read. This method blocks  until all the bytes are read, the end of the stream is detected,  or an exception is thrown.

Parameters:

 b - the buffer into which the data is read.

 off - the start offset of the data.

 len - the number of bytes to read.

Throws: EOFException

 if this input stream reaches the end before  reading all the bytes.

Throws: IOException

 if an I/O error occurs.

See Also:

in

 skipBytes

  public final int skipBytes(int n) throws IOException

 Skips exactly n bytes of input in the underlying  input stream. This method blocks until all the bytes are skipped,  the end of the stream is detected, or an exception is thrown.

Parameters:

 n - the number of bytes to be skipped.

Returns:

 the number of bytes skipped, which is always n.

Throws: EOFException

 if this input stream reaches the end before  skipping all the bytes.

Throws: IOException

 if an I/O error occurs.

 readBoolean

  public final boolean readBoolean() throws IOException

 Reads a boolean from this data input stream. This  method reads a single byte from the underlying input stream. A  value of 0 represents false. Any other  value represents true. This method blocks until  either the byte is read, the end of the stream is detected, or an  exception is thrown.

Returns:

 the boolean value read.

Throws: EOFException

 if this input stream has reached the end.

Throws: IOException

 if an I/O error occurs.

See Also:

in

 readByte

  public final byte readByte() throws IOException

 Reads a signed 8-bit value from this data input stream. This  method reads a byte from the underlying input stream. If the byte  read is b, where  0 <= b <= 255, then the  result is:

  (byte)(b)

 This method blocks until either the byte is read, the end of the  stream is detected, or an exception is thrown.

Returns:

 the next byte of this input stream as a signed 8-bit  byte.

Throws: EOFException

 if this input stream has reached the end.

Throws: IOException

 if an I/O error occurs.

See Also:

in

 readUnsignedByte

  public final int readUnsignedByte() throws IOException

 Reads an unsigned 8-bit number from this data input stream. This  method reads a byte from this data input stream's underlying input  stream and returns that byte. This method blocks until the byte is  read, the end of the stream is detected, or an exception is thrown.

Returns:

 the next byte of this input stream, interpreted as an  unsigned 8-bit number.

Throws: EOFException

 if this input stream has reached the end.

Throws: IOException

 if an I/O error occurs.

See Also:

in

 readShort

  public final short readShort() throws IOException

 Reads a signed 16-bit number from this data input stream. The  method reads two bytes from the underlying input stream. If the two  bytes read, in order, are b1 and b2,  where each of the two values is between 0 and  255, inclusive, then the result is equal to:

  (short)((b1 << 8) | b2)

 This method blocks until the two bytes are read, the end of the  stream is detected, or an exception is thrown.

Returns:

 the next two bytes of this input stream, interpreted as a  signed 16-bit number.

Throws: EOFException

 if this input stream reaches the end before  reading two bytes.

Throws: IOException

 if an I/O error occurs.

See Also:

in

 readUnsignedShort

  public final int readUnsignedShort() throws IOException

 Reads an unsigned 16-bit number from this data input stream. This  method reads two bytes from the underlying input stream. If the  bytes read, in order, are b1 and b2,  where 0 <= b1,  b2 <= 255 , then the result is equal to:

  (b1 << 8) | b2

 This method blocks until the two bytes are read, the end of the  stream is detected, or an exception is thrown.

Returns:

 the next two bytes of this input stream, interpreted as an  unsigned 16-bit integer.

Throws: EOFException

 if this input stream reaches the end before  reading two bytes.

Throws: IOException

 if an I/O error occurs.

See Also:

in

 readChar

  public final char readChar() throws IOException

 Reads a Unicode character from this data input stream. This  method reads two bytes from the underlying input stream. If the  bytes read, in order, are b1 and b2,  where 0 <= b1,  b1  <= 255, then the result is equal to:

  (char)((b1 << 8) | b2)

 This method blocks until either the two bytes are read, the end of  the stream is detected, or an exception is thrown.

Returns:

 the next two bytes of this input stream as a Unicode  character.

Throws: EOFException

 if this input stream reaches the end before  reading two bytes.

Throws: IOException

 if an I/O error occurs.

See Also:

in

 readInt

  public final int readInt() throws IOException

 Reads a signed 32-bit integer from this data input stream. This  method reads four bytes from the underlying input stream. If the  bytes read, in order, are b1, b2,  b3, and b4, where  0 <= b1, b2,  b3, b4 <= 255, then the  result is equal to:

  (b1 << 24) | (b2 << 16) + (b3 << 8) +b4

 This method blocks until the four bytes are read, the end of the  stream is detected, or an exception is thrown.

Returns:

 the next four bytes of this input stream, interpreted as an  int.

Throws: EOFException

 if this input stream reaches the end before  reading four bytes.

Throws: IOException

 if an I/O error occurs.

See Also:

in

 readLong

  public final long readLong() throws IOException

 Reads a signed 64-bit integer from this data input stream. This  method reads eight bytes from the underlying input stream. If the  bytes read, in order, are b1, b2,  b3, b4, b5,  b6, b7, and b8, where

  0 <= b1, b2, b3, b4, b5, b6, b7, b8 <= 255,

 then the result is equal to:

     ((long)b1 << 56) + ((long)b2 << 48) +
        ((long)b3 << 40) + ((long)b4 << 32) +
        ((long)b5 << 24) + (b6 << 16) +
        (b7 << 8) + b8

 This method blocks until the eight bytes are read, the end of the  stream is detected, or an exception is thrown.

Returns:

 the next eight bytes of this input stream, interpreted as a  long.

Throws: EOFException

 if this input stream reaches the end before  reading eight bytes.

Throws: IOException

 if an I/O error occurs.

See Also:

in

 readFloat

  public final float readFloat() throws IOException

 Reads a float from this data input stream. This  method reads an int value as if by the  readInt  method and then converts that  int to a float using the  intBitsToFloat method in class Float.  This method blocks until the four bytes are read, the end of the  stream is detected, or an exception is thrown.

Returns:

 the next four bytes of this input stream, interpreted as a  float.

Throws: EOFException

 if this input stream reaches the end before  reading four bytes.

Throws: IOException

 if an I/O error occurs.

See Also:

readInt, intBitsToFloat

 readDouble

  public final double readDouble() throws IOException

 Reads a double from this data input stream. This  method reads a long value as if by the  readLong  method and then converts that  long to a double using the  longBitsToDouble method in class Double.

 This method blocks until the eight bytes are read, the end of the  stream is detected, or an exception is thrown.

Returns:

 the next eight bytes of this input stream, interpreted as a  double.

Throws: EOFException

 if this input stream reaches the end before  reading eight bytes.

Throws: IOException

 if an I/O error occurs.

See Also:

readLong, longBitsToDouble

 readLine

  public final String readLine() throws IOException

 Note: readLine() is deprecated. This method does not properly convert bytes to characters.  As of JDK 1.1, the preferred way to read lines of text  is using the BufferedReader.readLine() method. .

 Reads the next line of text from this data input stream. This  method successively reads bytes from the underlying input stream  until it reaches the end of a line of text.

 A line of text is terminated by a carriage return character  ('\r' ), a newline character ('\n'), a  carriage return character immediately followed by a newline  character, or the end of the input stream. The line-terminating  character(s), if any, are not returned as part of the string that  is returned.

 This method blocks until a newline character is read, a carriage  return and the byte following it are read (to see if it is a  newline), the end of the stream is detected, or an exception is  thrown.

Returns:

 the next line of text from this input stream.

Throws: IOException

 if an I/O error occurs.

See Also:

readLine, in

 readUTF

  public final String readUTF() throws IOException

 Reads in a string that has been encoded using a modified UTF-8  format from this data input stream. This method calls  readUTF(this).  See readUTF(java.io.DataInput) for a more  complete description of the format.

 This method blocks until all the bytes are read, the end of the  stream is detected, or an exception is thrown.

Returns:

 a Unicode string.

Throws: EOFException

 if this input stream reaches the end before  reading all the bytes.

Throws: IOException

 if an I/O error occurs.

See Also:

readUTF

 readUTF

  public final static String readUTF(DataInput in) throws IOException

 Reads in a string from the specified data input stream. The  string has been encoded using a modified UTF-8 format.

 The first two bytes are read as if by  readUnsignedShort . This value gives the number of  following bytes that are in the encoded string, not  the length of the resulting string. The following bytes are then  interpreted as bytes encoding characters in the UTF-8 format  and are converted into characters.

 This method blocks until all the bytes are read, the end of the  stream is detected, or an exception is thrown.

Parameters:

 in - a data input stream.

Returns:

 a Unicode string.

Throws: EOFException

 if the input stream reaches the end  before all the bytes.

Throws: IOException

 if an I/O error occurs.

Throws: UTFDataFormatException

 if the bytes do not represent a  valid UTF-8 encoding of a Unicode string.

See Also:

readUnsignedShort

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.io.DataOutput

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.io.DataOutput

 public interface DataOutput

The data output interface is implemented by streams that can  write primitive Java data types to an output stream in a  machine-independent manner.

See Also:

DataInput, DataOutputStream

______________________________________________________________________________

 	write(byte[])

 Writes b.length bytes from the specified byte array  to this output stream.

 	write(byte[], int, int)

 Writes len bytes from the specified byte array  starting at offset off  to this output stream.

 	write(int)

 Writes the specified byte to this data output stream.

 	writeBoolean(boolean)

 Writes a boolean value to this output stream.

 	writeByte(int)

 Writes an 8-bit value to this output stream.

 	writeBytes(String)

 Writes a string to this output stream.

 	writeChar(int)

 Writes a char value to this output stream.

 	writeChars(String)

 Writes a string to this output stream.

 	writeDouble(double)

 Writes a double value to this output stream.

 	writeFloat(float)

 Writes a float value to this output stream.

 	writeInt(int)

 Writes an int value to this output stream.

 	writeLong(long)

 Writes a long value to this output stream.

 	writeShort(int)

 Writes a 16-bit value to this output stream.

 	writeUTF(String)

 Writes a Unicode string by encoding it using modified UTF-8 format.

 write

  public abstract void write(int b) throws IOException

 Writes the specified byte to this data output stream.

Parameters:

 b - the byte to be written.

Throws: IOException

 if an I/O error occurs.

 write

  public abstract void write(byte b[]) throws IOException

 Writes b.length bytes from the specified byte array  to this output stream.

Parameters:

 b - the data.

Throws: IOException

 if an I/O error occurs.

 write

  public abstract void write(byte b[],
                             int off,
                             int len) throws IOException

 Writes len bytes from the specified byte array  starting at offset off to this output stream.

Parameters:

 b - the data.

 off - the start offset in the data.

 len - the number of bytes to write.

Throws: IOException

 if an I/O error occurs.

 writeBoolean

  public abstract void writeBoolean(boolean v) throws IOException

 Writes a boolean value to this output stream.

Parameters:

 v - the boolean to be written.

Throws: IOException

 if an I/O error occurs.

 writeByte

  public abstract void writeByte(int v) throws IOException

 Writes an 8-bit value to this output stream.

Parameters:

 v - the byte value to be written.

Throws: IOException

 if an I/O error occurs.

 writeShort

  public abstract void writeShort(int v) throws IOException

 Writes a 16-bit value to this output stream.

Parameters:

 v - the short value to be written.

Throws: IOException

 if an I/O error occurs.

 writeChar

  public abstract void writeChar(int v) throws IOException

 Writes a char value to this output stream.

Parameters:

 v - the char value to be written.

Throws: IOException

 if an I/O error occurs.

 writeInt

  public abstract void writeInt(int v) throws IOException

 Writes an int value to this output stream.

Parameters:

 v - the int value to be written.

Throws: IOException

 if an I/O error occurs.

 writeLong

  public abstract void writeLong(long v) throws IOException

 Writes a long value to this output stream.

Parameters:

 v - the long value to be written.

Throws: IOException

 if an I/O error occurs.

 writeFloat

  public abstract void writeFloat(float v) throws IOException

 Writes a float value to this output stream.

Parameters:

 v - the float value to be written.

Throws: IOException

 if an I/O error occurs.

 writeDouble

  public abstract void writeDouble(double v) throws IOException

 Writes a double value to this output stream.

Parameters:

 v - the double value to be written.

Throws: IOException

 if an I/O error occurs.

 writeBytes

  public abstract void writeBytes(String s) throws IOException

 Writes a string to this output stream.

Parameters:

 s - the string of bytes to be written.

Throws: IOException

 if an I/O error occurs.

 writeChars

  public abstract void writeChars(String s) throws IOException

 Writes a string to this output stream.

Parameters:

 s - the string value to be written.

Throws: IOException

 if an I/O error occurs.

 writeUTF

  public abstract void writeUTF(String str) throws IOException

 Writes a Unicode string by encoding it using modified UTF-8 format.

Parameters:

 str - the string value to be written.

Throws: IOException

 if an I/O error occurs.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.DataOutputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.DataOutputStream

java.lang.Object
   |
   +----java.io.OutputStream
           |
           +----java.io.FilterOutputStream
                   |
                   +----java.io.DataOutputStream

______________________________________________________________________________

 public class DataOutputStream

 extends FilterOutputStream

 implements DataOutput

A data input stream lets an application write primitive Java data  types to an output stream in a portable way. An application can  then use a data input stream to read the data back in.

See Also:

DataInputStream

______________________________________________________________________________

 	written

 The number of bytes written to the data output stream.

 	DataOutputStream(OutputStream)

 Creates a new data output stream to write data to the specified  underlying output stream.

 	flush()

 Flushes this data output stream.

 	size()

 Returns the number of bytes written to this data output stream.

 	write(byte[], int, int)

 Writes len bytes from the specified byte array  starting at offset off  to the underlying output stream.

 	write(int)

 Writes the specified byte to the underlying output stream.

 	writeBoolean(boolean)

 Writes a boolean to the underlying output stream as  a 1-byte value.

 	writeByte(int)

 Writes out a byte to the underlying output stream as  a 1-byte value.

 	writeBytes(String)

 Writes out the string to the underlying output stream as a  sequence of bytes.

 	writeChar(int)

 Writes a char to the underlying output stream as a  2-byte value, high byte first.

 	writeChars(String)

 Writes a string to the underlying output stream as a sequence of  characters.

 	writeDouble(double)

 Converts the double argument to a long using the  doubleToLongBits  method in class Double,  and then writes that long  value to the underlying  output stream as an 8-byte quantity, high byte first.

 	writeFloat(float)

 Converts the float argument to an int using the  floatToIntBits  method in class Float,  and then writes that int value to the underlying  output stream as a 4-byte quantity, high byte first.

 	writeInt(int)

 Writes an int to the underlying output stream as four  bytes, high byte first.

 	writeLong(long)

 Writes a long to the underlying output stream as eight  bytes, high byte first.

 	writeShort(int)

 Writes a short to the underlying output stream as two  bytes, high byte first.

 	writeUTF(String)

 Writes a string to the underlying output stream using UTF-8  encoding in a machine-independent manner.

 written

  protected int written

 The number of bytes written to the data output stream.

 DataOutputStream

  public DataOutputStream(OutputStream out)

 Creates a new data output stream to write data to the specified  underlying output stream.

Parameters:

 out - the underlying output stream.

See Also:

out

 write

  public synchronized void write(int b) throws IOException

 Writes the specified byte to the underlying output stream.

Parameters:

 b - the byte to be written.

Throws: IOException

 if an I/O error occurs.

Overrides:

write in class FilterOutputStream

See Also:

out

 write

  public synchronized void write(byte b[],
                                 int off,
                                 int len) throws IOException

 Writes len bytes from the specified byte array  starting at offset off to the underlying output stream.

Parameters:

 b - the data.

 off - the start offset in the data.

 len - the number of bytes to write.

Throws: IOException

 if an I/O error occurs.

Overrides:

write in class FilterOutputStream

See Also:

out

 flush

  public void flush() throws IOException

 Flushes this data output stream. This forces any buffered output  bytes to be written out to the stream.

 The flush method of DataOuputStream  calls the flush  method of its underlying output stream.

Throws: IOException

 if an I/O error occurs.

Overrides:

flush in class FilterOutputStream

See Also:

out, flush

 writeBoolean

  public final void writeBoolean(boolean v) throws IOException

 Writes a boolean to the underlying output stream as  a 1-byte value. The value true is written out as the  value (byte)1 ; the value false is  written out as the value (byte)0.

Parameters:

 v - a boolean value to be written.

Throws: IOException

 if an I/O error occurs.

See Also:

out

 writeByte

  public final void writeByte(int v) throws IOException

 Writes out a byte to the underlying output stream as  a 1-byte value.

Parameters:

 v - a byte value to be written.

Throws: IOException

 if an I/O error occurs.

See Also:

out

 writeShort

  public final void writeShort(int v) throws IOException

 Writes a short to the underlying output stream as two  bytes, high byte first.

Parameters:

 v - a short to be written.

Throws: IOException

 if an I/O error occurs.

See Also:

out

 writeChar

  public final void writeChar(int v) throws IOException

 Writes a char to the underlying output stream as a  2-byte value, high byte first.

Parameters:

 v - a char value to be written.

Throws: IOException

 if an I/O error occurs.

See Also:

out

 writeInt

  public final void writeInt(int v) throws IOException

 Writes an int to the underlying output stream as four  bytes, high byte first.

Parameters:

 v - an int to be written.

Throws: IOException

 if an I/O error occurs.

See Also:

out

 writeLong

  public final void writeLong(long v) throws IOException

 Writes a long to the underlying output stream as eight  bytes, high byte first.

Parameters:

 v - a long to be written.

Throws: IOException

 if an I/O error occurs.

See Also:

out

 writeFloat

  public final void writeFloat(float v) throws IOException

 Converts the float argument to an int using the  floatToIntBits method in class Float,  and then writes that int  value to the underlying  output stream as a 4-byte quantity, high byte first.

Parameters:

 v - a float value to be written.

Throws: IOException

 if an I/O error occurs.

See Also:

out, floatToIntBits

 writeDouble

  public final void writeDouble(double v) throws IOException

 Converts the double argument to a long using the  doubleToLongBits method in class Double,  and then writes that long value to the underlying  output stream as an 8-byte quantity, high byte first.

Parameters:

 v - a double value to be written.

Throws: IOException

 if an I/O error occurs.

See Also:

out, doubleToLongBits

 writeBytes

  public final void writeBytes(String s) throws IOException

 Writes out the string to the underlying output stream as a  sequence of bytes. Each character in the string is written out, in  sequence, by discarding its high eight bits.

Parameters:

 s - a string of bytes to be written.

Throws: IOException

 if an I/O error occurs.

See Also:

out

 writeChars

  public final void writeChars(String s) throws IOException

 Writes a string to the underlying output stream as a sequence of  characters. Each character is written to the data output stream as  if by the writeChar  method.

Parameters:

 s - a String value to be written.

Throws: IOException

 if an I/O error occurs.

See Also:

writeChar, out

 writeUTF

  public final void writeUTF(String str) throws IOException

 Writes a string to the underlying output stream using UTF-8  encoding in a machine-independent manner.

 First, two bytes are written to the output stream as if by the  writeShort  method giving the number of bytes to  follow. This value is the number of bytes actually written out,  not the length of the string. Following the length, each character  of the string is output, in sequence, using the UTF-8 encoding  for the character.

Parameters:

 str - a string to be written.

Throws: IOException

 if an I/O error occurs.

 size

  public final int size()

 Returns the number of bytes written to this data output stream.

Returns:

 the value of the written field.

See Also:

written

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.EOFException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.EOFException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.io.EOFException

______________________________________________________________________________

 public class EOFException

 extends IOException

Signals that an end of file or end of stream has been reached  unexpectedly during input.

 This exception is mainly used by data input streams, which  generally expect a binary file in a specific format, and for which  an end of stream is an unusual condition. Most other input streams  return a special value on end of stream.

See Also:

DataInputStream, IOException

______________________________________________________________________________

 	EOFException()

 Constructs an EOFException with no detail message.

 	EOFException(String)

 Constructs an EOFException with the specified detail  message.

 EOFException

  public EOFException()

 Constructs an EOFException with no detail message.

 EOFException

  public EOFException(String s)

 Constructs an EOFException with the specified detail  message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.io.Externalizable

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.io.Externalizable

 public interface Externalizable

 extends Serializable

Externalization allows a class to specify the methods to be used to  write the object's contents to a stream and to read them back. The  Externalizable interface's writeExternal and readExternal methods  are implemented by a class to  give the class complete control over the format and contents of the  stream for an object and its supertypes. These methods must explicitly  coordinate with the supertype to save its state.
 Object Serialization uses the Serializable and Externalizable  interfaces. Object persistence mechanisms may use them also. Each  object to be stored is tested for the Externalizable interface. If  the object supports it, the writeExternal method is called. If the  object does not support Externalizable and does implement  Serializable the object should be saved using  ObjectOutputStream.
 When an Externalizable object is to be  reconstructed, an instance is created using the public no-arg  constructor and the readExternal method called. Serializable  objects are restored by reading them from an ObjectInputStream.

See Also:

ObjectOutputStream, ObjectInputStream, ObjectOutput, ObjectInput , Serializable

______________________________________________________________________________

 	readExternal(ObjectInput)

 The object implements the readExternal method to restore its  contents by calling the methods of DataInput for primitive  types and readObject for objects, strings and arrays.

 	writeExternal(ObjectOutput)

 The object implements the writeExternal method to save its contents  by calling the methods of DataOutput for its primitive values or  calling the writeObject method of ObjectOutput for objects, strings  and arrays.

 writeExternal

  public abstract void writeExternal(ObjectOutput out) throws IOException

 The object implements the writeExternal method to save its contents  by calling the methods of DataOutput for its primitive values or  calling the writeObject method of ObjectOutput for objects, strings  and arrays.

Throws: IOException

 Includes any I/O exceptions that may occur

 readExternal

  public abstract void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

 The object implements the readExternal method to restore its  contents by calling the methods of DataInput for primitive  types and readObject for objects, strings and arrays. The  readExternal method must read the values in the same sequence  and with the same types as were written by writeExternal.

Throws: ClassNotFoundException

 If the class for an object being  restored cannot be found.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.File

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.File

java.lang.Object
   |
   +----java.io.File

______________________________________________________________________________

 public class File

 extends Object

 implements Serializable

Instances of this class represent the name of a file or directory  on the host file system. A file is specified by a pathname, which  can either be an absolute pathname or a pathname relative to the  current working directory. The pathname must follow the naming  conventions of the host platform.

 The File class is intended to provide an abstraction  that deals with most of the machine dependent complexities of  files and pathnames in a machine-independent fashion.

 Note that whenever a filename or path is used it is  assumed that the host's file naming conventions are used.

______________________________________________________________________________

 	pathSeparator

 The system-dependent path separator string.

 	pathSeparatorChar

 The system-dependent path separator character.

 	separator

 The system-dependent path separator character.

 	separatorChar

 The system-dependent path separator string.

 	File(File, String)

 Creates a File instance that represents the file  with the specified name in the specified directory.

 	File(String)

 Creates a File instance that represents the file  whose pathname is the given path argument.

 	File(String, String)

 Creates a File instance whose pathname is the  pathname of the specified directory, followed by the separator  character, followed by the name argument.

 	canRead()

 Tests if the application can read from the specified file.

 	canWrite()

 Tests if the application can write to this file.

 	delete()

 Deletes the file specified by this object.

 	equals(Object)

 Compares this object against the specified object.

 	exists()

 Tests if this File exists.

 	getAbsolutePath()

 Returns the absolute pathname of the file represented by this object.

 	getCanonicalPath()

 Gets the official, canonical path of the File.

 	getName()

 Returns the name of the file represented by this object.

 	getParent()

 Returns the parent directory of the file represented by this  object.

 	getPath()

 Returns the pathname of the file represented by this object.

 	hashCode()

 Computes a hashcode for the file.

 	isAbsolute()

 Tests if the file represented by this File object is an  absolute pathname.

 	isDirectory()

 Tests if the file represented by this File  object is a directory.

 	isFile()

 Tests if the file represented by this File  object is a "normal" file.

 	lastModified()

 Returns the time that the file represented by this  File object was last modified.

 	length()

 Returns the length of the file represented by this  File object.

 	list()

 Returns a list of the files in the directory specified by this  File object.

 	list(FilenameFilter)

 Returns a list of the files in the directory specified by this  File  that satisfy the specified filter.

 	mkdir()

 Creates a directory whose pathname is specified by this  File object.

 	mkdirs()

 Creates a directory whose pathname is specified by this  File  object, including any necessary parent directories.

 	renameTo(File)

 Renames the file specified by this File object to  have the pathname given by the File argument.

 	toString()

 Returns a string representation of this object.

 separator

  public final static String separator

 The system-dependent path separator character. This field is  initialized to contain the value of the system property  file.separator.

See Also:

getProperty

 separatorChar

  public final static char separatorChar

 The system-dependent path separator string. This field is  initialized to contain the first character of the value of the  system property file.separator. This character  separates the directory and file components in a filename.

See Also:

getProperty

 pathSeparator

  public final static String pathSeparator

 The system-dependent path separator string. This field is  initialized to contain the value of the system property  path.separator.

See Also:

getProperty

 pathSeparatorChar

  public final static char pathSeparatorChar

 The system-dependent path separator character. This field is  initialized to contain the first character of the value of the  system property path.separator. This character is  often used to separate filenames in a sequence of files given as a  "path list".

See Also:

getProperty

 File

  public File(String path)

 Creates a File instance that represents the file  whose pathname is the given path argument.

Parameters:

 path - the file pathname.

Throws: NullPointerException

 if the file path is equal to  null.

See Also:

getPath

 File

  public File(String path,
              String name)

 Creates a File instance whose pathname is the  pathname of the specified directory, followed by the separator  character, followed by the name argument.

Parameters:

 path - the directory pathname.

 name - the file pathname.

See Also:

getPath, separator

 File

  public File(File dir,
              String name)

 Creates a File instance that represents the file  with the specified name in the specified directory.

 If the directory argument is null, the resulting  File  instance represents a file in the  (system-dependent) current directory whose pathname is the  name argument. Otherwise, the File  instance represents a file whose pathname is the pathname of the  directory, followed by the separator character, followed by the  name argument.

Parameters:

 dir - the directory.

 name - the file pathname.

See Also:

getPath, separator

 getName

  public String getName()

 Returns the name of the file represented by this object. The name  is everything in the pathame after the last occurrence of the  separator character.

Returns:

 the name of the file (without any directory components)  represented by this File  object.

See Also:

getPath, separator

 getPath

  public String getPath()

 Returns the pathname of the file represented by this object.

Returns:

 the pathname represented by this File object.

 getAbsolutePath

  public String getAbsolutePath()

 Returns the absolute pathname of the file represented by this object.  If this object represents an absolute pathname, then return the  pathname. Otherwise, return a pathname that is a concatenation of  the current user directory, the separator character, and the  pathname of this file object.

 The system property user.dir contains the current  user directory.

Returns:

 a system-dependent absolute pathname for this File.

See Also:

getPath, isAbsolute, getProperty

 getCanonicalPath

  public String getCanonicalPath() throws IOException

 Gets the official, canonical path of the File.

Returns:

 canonical path

 getParent

  public String getParent()

 Returns the parent directory of the file represented by this  object. The parent directory is everything in the pathname before  the last occurrence of the separator character, or  null  if the separator character does not appear in  the pathname.

Returns:

 the name of the directory of the file represented by this  File object.

See Also:

getPath, separator

 exists

  public boolean exists()

 Tests if this File exists.

Returns:

true if the file specified by this object  exists; false otherwise.

Throws: SecurityException

 if a security manager exists, its  checkRead method is called with the pathname  of this File to see if the application is  allowed read access to the file.

See Also:

getPath, checkRead

 canWrite

  public boolean canWrite()

 Tests if the application can write to this file.

Returns:

true if the application is allowed to write to  a file whose name is specified by this object;  false otherwise.

Throws: SecurityException

 if a security manager exists, its  checkWrite method is called with the pathname  of this File to see if the application is  allowed write access to the file.

See Also:

getPath, checkWrite

 canRead

  public boolean canRead()

 Tests if the application can read from the specified file.

Returns:

true if the file specified by this object exists  and the application can read the file;  false otherwise.

Throws: SecurityException

 if a security manager exists, its  checkRead method is called with the pathname  of this File to see if the application is  allowed read access to the file.

See Also:

getPath, checkRead

 isFile

  public boolean isFile()

 Tests if the file represented by this File  object is a "normal" file.

 A file is "normal" if it is not a directory and, in  addition, satisfies other system-dependent criteria. Any  non-directory file created by a Java application is guaranteed to  be a normal file.

Returns:

true if the file specified by this object  exists and is a "normal" file; false otherwise.

Throws: SecurityException

 If a security manager exists, its  checkRead method is called with the pathname  of this File to see if the application is  allowed read access to the file.

See Also:

getPath, checkRead

 isDirectory

  public boolean isDirectory()

 Tests if the file represented by this File  object is a directory.

Returns:

true if this File exists and is a  directory; false otherwise.

Throws: SecurityException

 if a security manager exists, its  checkRead method is called with the pathname  of this File to see if the application is  allowed read access to the file.

See Also:

getPath, checkRead

 isAbsolute

  public boolean isAbsolute()

 Tests if the file represented by this File object is an  absolute pathname. The definition of an absolute pathname is system  dependent. For example, on UNIX, a pathname is absolute if its  first character is the separator character. On Windows platforms,  a pathname is absolute if its first character is an ASCII '\' or  '/', or if it begins with a letter followed by a colon.

Returns:

true if the pathname indicated by the  File object is an absolute pathname;   false otherwise.

See Also:

getPath, separator

 lastModified

  public long lastModified()

 Returns the time that the file represented by this  File  object was last modified.

 The return value is system dependent and should only be used to  compare with other values returned by last modified. It should not  be interpreted as an absolute time.

Returns:

 the time the file specified by this object was last modified,  or 0L  if the specified file does not exist.

Throws: SecurityException

 if a security manager exists, its  checkRead method is called with the pathname  of this File to see if the application is  allowed read access to the file.

See Also:

getPath, checkRead

 length

  public long length()

 Returns the length of the file represented by this  File  object.

Returns:

 the length, in bytes, of the file specified by this object,  or 0L  if the specified file does not exist.

Throws: SecurityException

 if a security manager exists, its  checkRead method is called with the pathname  of this File to see if the application is  allowed read access to the file.

See Also:

getPath, checkRead

 mkdir

  public boolean mkdir()

 Creates a directory whose pathname is specified by this  File object.

Returns:

true if the directory could be created;  false otherwise.

Throws: SecurityException

 if a security manager exists, its  checkWrite method is called with the pathname  of this File to see if the application is  allowed write access to the file.

See Also:

getPath, checkWrite

 renameTo

  public boolean renameTo(File dest)

 Renames the file specified by this File object to  have the pathname given by the File argument.

Parameters:

 dest - the new filename.

Returns:

true if the renaming succeeds;  false otherwise.

Throws: SecurityException

 if a security manager exists, its  checkWrite method is called both with the  pathname of this file object and with the pathname of the  destination target object to see if the application is  allowed to write to both files.

See Also:

getPath, checkWrite

 mkdirs

  public boolean mkdirs()

 Creates a directory whose pathname is specified by this  File object, including any necessary parent directories.

Returns:

true if the directory (or directories) could be  created; false otherwise.

Throws: SecurityException

 if a security manager exists, its  checkWrite method is called with the pathname  of each of the directories that is to be created, before  any of the directories are created.

See Also:

getPath, checkWrite

 list

  public String[] list()

 Returns a list of the files in the directory specified by this  File object.

Returns:

 an array of file names in the specified directory.  This list does not include the current directory or the  parent directory ("." and " .."  on Unix systems).

Throws: SecurityException

 If a security manager exists, its  checkRead method is called with the pathname  of this File to see if the application is  allowed read access to the file.

See Also:

getPath, checkRead

 list

  public String[] list(FilenameFilter filter)

 Returns a list of the files in the directory specified by this  File that satisfy the specified filter.

Parameters:

 filter - a filename filter.

Returns:

 an array of file names in the specified directory.  This list does not include the current directory or the  parent directory ("." and " .."  on Unix systems).

Throws: SecurityException

 If a security manager exists, its  checkRead method is called with the pathname  of this File to see if the application is  allowed read access to the file.

See Also:

getPath, FilenameFilter, checkRead

 delete

  public boolean delete()

 Deletes the file specified by this object.

Returns:

true if the file is successfully deleted;  false otherwise.

Throws: SecurityException

 if a security manager exists, its  checkDelete method is called with the  pathname of this File to see if the  application is allowed to delete the file.

See Also:

getPath, checkDelete

 hashCode

  public int hashCode()

 Computes a hashcode for the file.

Returns:

 a hash code value for this File object.

Overrides:

hashCode in class Object

 equals

  public boolean equals(Object obj)

 Compares this object against the specified object.  Returns true if and only if the argument is  not null and is a File object whose  pathname is equal to the pathname of this object.

Parameters:

 obj - the object to compare with.

Returns:

true if the objects are the same;  false otherwise.

Overrides:

equals in class Object

 toString

  public String toString()

 Returns a string representation of this object.

Returns:

 a string giving the pathname of this object.

Overrides:

toString in class Object

See Also:

getPath

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.FileDescriptor

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.FileDescriptor

java.lang.Object
   |
   +----java.io.FileDescriptor

______________________________________________________________________________

 public final class FileDescriptor

 extends Object

Instances of the file descriptor class serve as an opaque handle  to the underlying machine-specific structure representing an open  file or an open socket.

 Applications should not create their own file descriptors.

See Also:

FileInputStream, FileOutputStream, SocketInputStream, SocketOutputStream

______________________________________________________________________________

 	err

 A handle to the standard error stream.

 	in

 A handle to the standard input stream.

 	out

 A handle to the standard output stream.

 	FileDescriptor()

 	sync()

 Force all system buffers to synchronize with the underlying  device.

 	valid()

 Tests if this file descriptor object is valid.

 in

  public final static FileDescriptor in

 A handle to the standard input stream.

 out

  public final static FileDescriptor out

 A handle to the standard output stream.

 err

  public final static FileDescriptor err

 A handle to the standard error stream.

 FileDescriptor

  public FileDescriptor()

 valid

  public boolean valid()

 Tests if this file descriptor object is valid.

Returns:

true if the file descriptor object represents a  valid, open file or socket; false otherwise.

 sync

  public void sync() throws SyncFailedException

 Force all system buffers to synchronize with the underlying  device. This method returns after all modified data and  attributes of this FileDescriptor have been written to the  relevant device(s). In particular, if this FileDescriptor  refers to a physical storage medium, such as a file in a file  system, sync will not return until all in-memory modified copies  of buffers associated with this FileDesecriptor have been  written to the physical medium.  sync is meant to be used by code that requires physical  storage (such as a file) to be in a known state For  example, a class that provided a simple transaction facility  might use sync to ensure that all changes to a file caused  by a given transaction were recorded on a storage medium.  sync only affects buffers downstream of this FileDescriptor. If  any in-memory buffering is being done by the application (for  example, by a BufferedOutputStream object), those buffers must  be flushed into the FileDescriptor (for example, by invoking  OutputStream.flush) before that data will be affected by sync.

Throws: SyncFailedException

 Thrown when the buffers cannot be flushed, 	or because the system cannot guarantee that all the 	buffers have been synchronized with physical media.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.FileInputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.FileInputStream

java.lang.Object
   |
   +----java.io.InputStream
           |
           +----java.io.FileInputStream

______________________________________________________________________________

 public class FileInputStream

 extends InputStream

A file input stream is an input stream for reading data from a  File or from a FileDescriptor.

See Also:

File, FileDescriptor, FileOutputStream

______________________________________________________________________________

 	FileInputStream(File)

 Creates an input file stream to read from the specified  File object.

 	FileInputStream(FileDescriptor)

 Creates an input file stream to read from the specified file descriptor.

 	FileInputStream(String)

 Creates an input file stream to read from a file with the  specified name.

 	available()

 Returns the number of bytes that can be read from this file input  stream without blocking.

 	close()

 Closes this file input stream and releases any system resources  associated with the stream.

 	finalize()

 Ensures that the close method of this file input stream is  called when there are no more references to it.

 	getFD()

 Returns the opaque file descriptor object associated with this stream.

 	read()

 Reads a byte of data from this input stream.

 	read(byte[])

 Reads up to b.length bytes of data from this input  stream into an array of bytes.

 	read(byte[], int, int)

 Reads up to len bytes of data from this input stream  into an array of bytes.

 	skip(long)

 Skips over and discards n bytes of data from the  input stream.

 FileInputStream

  public FileInputStream(String name) throws FileNotFoundException

 Creates an input file stream to read from a file with the  specified name.

Parameters:

 name - the system-dependent file name.

Throws: FileNotFoundException

 if the file is not found.

Throws: SecurityException

 if a security manager exists, its  checkRead method is called with the name  argument to see if the application is allowed read access  to the file.

See Also:

checkRead

 FileInputStream

  public FileInputStream(File file) throws FileNotFoundException

 Creates an input file stream to read from the specified  File object.

Parameters:

 file - the file to be opened for reading.

Throws: FileNotFoundException

 if the file is not found.

Throws: SecurityException

 if a security manager exists, its  checkRead method is called with the pathname  of this File argument to see if the  application is allowed read access to the file.

See Also:

getPath, checkRead

 FileInputStream

  public FileInputStream(FileDescriptor fdObj)

 Creates an input file stream to read from the specified file descriptor.

Parameters:

 fdObj - the file descriptor to be opened for reading.

Throws: SecurityException

 if a security manager exists, its  checkRead method is called with the file  descriptor to see if the application is allowed to read  from the specified file descriptor.

See Also:

checkRead

 read

  public int read() throws IOException

 Reads a byte of data from this input stream. This method blocks  if no input is yet available.

Returns:

 the next byte of data, or -1 if the end of the  file is reached.

Throws: IOException

 if an I/O error occurs.

Overrides:

read in class InputStream

 read

  public int read(byte b[]) throws IOException

 Reads up to b.length bytes of data from this input  stream into an array of bytes. This method blocks until some input  is available.

Parameters:

 b - the buffer into which the data is read.

Returns:

 the total number of bytes read into the buffer, or  -1  if there is no more data because the end of  the file has been reached.

Throws: IOException

 if an I/O error occurs.

Overrides:

read in class InputStream

 read

  public int read(byte b[],
                  int off,
                  int len) throws IOException

 Reads up to len bytes of data from this input stream  into an array of bytes. This method blocks until some input is  available.

Parameters:

 b - the buffer into which the data is read.

 off - the start offset of the data.

 len - the maximum number of bytes read.

Returns:

 the total number of bytes read into the buffer, or  -1  if there is no more data because the end of  the file has been reached.

Throws: IOException

 if an I/O error occurs.

Overrides:

read in class InputStream

 skip

  public long skip(long n) throws IOException

 Skips over and discards n bytes of data from the  input stream. The skip method may, for a variety of  reasons, end up skipping over some smaller number of bytes,  possibly 0 . The actual number of bytes skipped is returned.

Parameters:

 n - the number of bytes to be skipped.

Returns:

 the actual number of bytes skipped.

Throws: IOException

 if an I/O error occurs.

Overrides:

skip in class InputStream

 available

  public int available() throws IOException

 Returns the number of bytes that can be read from this file input  stream without blocking.

Returns:

 the number of bytes that can be read from this file input  stream without blocking.

Throws: IOException

 if an I/O error occurs.

Overrides:

available in class InputStream

 close

  public void close() throws IOException

 Closes this file input stream and releases any system resources  associated with the stream.

Throws: IOException

 if an I/O error occurs.

Overrides:

close in class InputStream

 getFD

  public final FileDescriptor getFD() throws IOException

 Returns the opaque file descriptor object associated with this stream.

Returns:

 the file descriptor object associated with this stream.

Throws: IOException

 if an I/O error occurs.

See Also:

FileDescriptor

 finalize

  protected void finalize() throws IOException

 Ensures that the close method of this file input stream is  called when there are no more references to it.

Throws: IOException

 if an I/O error occurs.

Overrides:

finalize in class Object

See Also:

close

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.io.FilenameFilter

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.io.FilenameFilter

 public interface FilenameFilter

Instances of classes that implement this interface are used to  filter filenames. These instances are used to filter directory  listings in the list  method of class  File, and by the Abstract Window Toolkit's file  dialog component.

See Also:

setFilenameFilter, File, list

______________________________________________________________________________

 	accept(File, String)

 Tests if a specified file should be included in a file list.

 accept

  public abstract boolean accept(File dir,
                                 String name)

 Tests if a specified file should be included in a file list.

Parameters:

 dir - the directory in which the file was found.

 name - the name of the file.

Returns:

true if the name should be included in the file  list; false otherwise.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.FileNotFoundException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.FileNotFoundException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.io.FileNotFoundException

______________________________________________________________________________

 public class FileNotFoundException

 extends IOException

Signals that a file could not be found.

______________________________________________________________________________

 	FileNotFoundException()

 Constructs a FileNotFoundException with no detail message.

 	FileNotFoundException(String)

 Constructs a FileNotFoundException with the  specified detail message.

 FileNotFoundException

  public FileNotFoundException()

 Constructs a FileNotFoundException with no detail message.

 FileNotFoundException

  public FileNotFoundException(String s)

 Constructs a FileNotFoundException with the  specified detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.FileOutputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.FileOutputStream

java.lang.Object
   |
   +----java.io.OutputStream
           |
           +----java.io.FileOutputStream

______________________________________________________________________________

 public class FileOutputStream

 extends OutputStream

A file output stream is an output stream for writing data to a  File or to a FileDescriptor.

See Also:

File, FileDescriptor, FileInputStream

______________________________________________________________________________

 	FileOutputStream(File)

 Creates a file output stream to write to the specified  File object.

 	FileOutputStream(FileDescriptor)

 Creates an output file stream to write to the specified file descriptor.

 	FileOutputStream(String)

 Creates an output file stream to write to the file with the  specified name.

 	FileOutputStream(String, boolean)

 Creates an output file with the specified system dependent  file name.

 	close()

 Closes this file output stream and releases any system resources  associated with this stream.

 	finalize()

 Ensures that the close method of this file output stream is  called when there are no more references to this stream.

 	getFD()

 Returns the file descriptor associated with this stream.

 	write(byte[])

 Writes b.length bytes from the specified byte array  to this file output stream.

 	write(byte[], int, int)

 Writes len bytes from the specified byte array  starting at offset off  to this file output stream.

 	write(int)

 Writes the specified byte to this file output stream.

 FileOutputStream

  public FileOutputStream(String name) throws IOException

 Creates an output file stream to write to the file with the  specified name.

Parameters:

 name - the system-dependent filename.

Throws: IOException

 if the file could not be opened for writing.

Throws: SecurityException

 if a security manager exists, its  checkWrite method is called with the name  argument to see if the application is allowed write access  to the file.

See Also:

checkWrite

 FileOutputStream

  public FileOutputStream(String name,
                          boolean append) throws IOException

 Creates an output file with the specified system dependent  file name.

Parameters:

 name - the system dependent file name

Throws: IOException

 If the file is not found.

 FileOutputStream

  public FileOutputStream(File file) throws IOException

 Creates a file output stream to write to the specified  File  object.

Parameters:

 file - the file to be opened for writing.

Throws: IOException

 if the file could not be opened for  writing.

Throws: SecurityException

 if a security manager exists, its  checkWrite method is called with the pathname  of the File argument to see if the  application is allowed write access to the file. This may  result in a security exception.

See Also:

getPath, SecurityException, checkWrite

 FileOutputStream

  public FileOutputStream(FileDescriptor fdObj)

 Creates an output file stream to write to the specified file descriptor.

Parameters:

 fdObj - the file descriptor to be opened for writing.

Throws: SecurityException

 if a security manager exists, its  checkWrite method is called with the file  descriptor to see if the application is allowed to write  to the specified file descriptor.

See Also:

checkWrite

 write

  public void write(int b) throws IOException

 Writes the specified byte to this file output stream.

Parameters:

 b - the byte to be written.

Throws: IOException

 if an I/O error occurs.

Overrides:

write in class OutputStream

 write

  public void write(byte b[]) throws IOException

 Writes b.length bytes from the specified byte array  to this file output stream.

Parameters:

 b - the data.

Throws: IOException

 if an I/O error occurs.

Overrides:

write in class OutputStream

 write

  public void write(byte b[],
                    int off,
                    int len) throws IOException

 Writes len bytes from the specified byte array  starting at offset off to this file output stream.

Parameters:

 b - the data.

 off - the start offset in the data.

 len - the number of bytes to write.

Throws: IOException

 if an I/O error occurs.

Overrides:

write in class OutputStream

 close

  public void close() throws IOException

 Closes this file output stream and releases any system resources  associated with this stream.

Throws: IOException

 if an I/O error occurs.

Overrides:

close in class OutputStream

 getFD

  public final FileDescriptor getFD() throws IOException

 Returns the file descriptor associated with this stream.

Returns:

 the file descriptor object associated with this stream.

Throws: IOException

 if an I/O error occurs.

See Also:

FileDescriptor

 finalize

  protected void finalize() throws IOException

 Ensures that the close method of this file output stream is   called when there are no more references to this stream.

Throws: IOException

 if an I/O error occurs.

Overrides:

finalize in class Object

See Also:

close

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.FileReader

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.FileReader

java.lang.Object
   |
   +----java.io.Reader
           |
           +----java.io.InputStreamReader
                   |
                   +----java.io.FileReader

______________________________________________________________________________

 public class FileReader

 extends InputStreamReader

Convenience class for reading character files. The constructors of this  class assume that the default character encoding and the default byte-buffer  size are appropriate. To specify these values yourself, construct an  InputStreamReader on a FileInputStream.

See Also:

InputStreamReader, FileInputStream

______________________________________________________________________________

 	FileReader(File)

  	FileReader(FileDescriptor)

  	FileReader(String)

 FileReader

  public FileReader(String fileName) throws FileNotFoundException

 FileReader

  public FileReader(File file) throws FileNotFoundException

 FileReader

  public FileReader(FileDescriptor fd)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.FileWriter

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.FileWriter

java.lang.Object
   |
   +----java.io.Writer
           |
           +----java.io.OutputStreamWriter
                   |
                   +----java.io.FileWriter

______________________________________________________________________________

 public class FileWriter

 extends OutputStreamWriter

Convenience class for writing character files. The constructors of this  class assume that the default character encoding and the default byte-buffer  size are acceptable. To specify these values yourself, construct an  OutputStreamWriter on a FileOutputStream.

See Also:

OutputStreamWriter, FileOutputStream

______________________________________________________________________________

 	FileWriter(File)

  	FileWriter(FileDescriptor)

  	FileWriter(String)

  	FileWriter(String, boolean)

 FileWriter

  public FileWriter(String fileName) throws IOException

 FileWriter

  public FileWriter(String fileName,
                    boolean append) throws IOException

 FileWriter

  public FileWriter(File file) throws IOException

 FileWriter

  public FileWriter(FileDescriptor fd)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.FilterInputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.FilterInputStream

java.lang.Object
   |
   +----java.io.InputStream
           |
           +----java.io.FilterInputStream

______________________________________________________________________________

 public class FilterInputStream

 extends InputStream

This class is the superclass of all classes that filter input  streams. These streams sit on top of an already existing input  stream (the underlying  input stream), but provide  additional functionality.

 The class FilterInputStream itself simply overrides  all methods of InputStream with versions that pass  all requests to the underlying input stream. Subclasses of  FilterInputStream may further override some of these  methods as well as provide additional methods and fields.

______________________________________________________________________________

 	in

 The underlying input stream.

 	FilterInputStream(InputStream)

 Creates an input stream filter built on top of the specified  input stream.

 	available()

 Returns the number of bytes that can be read from this input  stream without blocking.

 	close()

 Closes this input stream and releases any system resources  associated with the stream.

 	mark(int)

 Marks the current position in this input stream.

 	markSupported()

 Tests if this input stream supports the mark  and reset methods.

 	read()

 Reads the next byte of data from this input stream.

 	read(byte[])

 Reads up to byte.length bytes of data from this  input stream into an array of bytes.

 	read(byte[], int, int)

 Reads up to len bytes of data from this input stream  into an array of bytes.

 	reset()

 Repositions this stream to the position at the time the  mark  method was last called on this input stream.

 	skip(long)

 Skips over and discards n bytes of data from the  input stream.

 in

  protected InputStream in

 The underlying input stream.

 FilterInputStream

  protected FilterInputStream(InputStream in)

 Creates an input stream filter built on top of the specified  input stream.

Parameters:

 in - the underlying input stream.

 read

  public int read() throws IOException

 Reads the next byte of data from this input stream. The value  byte is returned as an int in the range  0 to 255 . If no byte is available  because the end of the stream has been reached, the value  -1  is returned. This method blocks until input data  is available, the end of the stream is detected, or an exception  is thrown.

 The read method of FilterInputStream  calls the read  method of its underlying input stream  and returns whatever value that method returns.

Returns:

 the next byte of data, or -1 if the end of the  stream is reached.

Throws: IOException

 if an I/O error occurs.

Overrides:

read in class InputStream

See Also:

in

 read

  public int read(byte b[]) throws IOException

 Reads up to byte.length bytes of data from this  input stream into an array of bytes. This method blocks until some  input is available.

 The read method of FilterInputStream  calls the read  method of three arguments with the  arguments b, 0, and  b.length, and returns whatever value that method returns.

 Note that this method does not call the one-argument  read  method of its underlying stream with the single  argument b. Subclasses of  FilterInputStream do not need to override this method  if they have overridden the three-argument read method.

Parameters:

 b - the buffer into which the data is read.

Returns:

 the total number of bytes read into the buffer, or  -1  if there is no more data because the end of  the stream has been reached.

Throws: IOException

 if an I/O error occurs.

Overrides:

read in class InputStream

See Also:

read

 read

  public int read(byte b[],
                  int off,
                  int len) throws IOException

 Reads up to len bytes of data from this input stream  into an array of bytes. This method blocks until some input is  available.

 The read method of FilterInputStream  calls the read  method of its underlying input stream  with the same arguments and returns whatever value that method returns.

Parameters:

 b - the buffer into which the data is read.

 off - the start offset of the data.

 len - the maximum number of bytes read.

Returns:

 the total number of bytes read into the buffer, or  -1  if there is no more data because the end of  the stream has been reached.

Throws: IOException

 if an I/O error occurs.

Overrides:

read in class InputStream

See Also:

in

 skip

  public long skip(long n) throws IOException

 Skips over and discards n bytes of data from the  input stream. The skip method may, for a variety of  reasons, end up skipping over some smaller number of bytes,  possibly 0 . The actual number of bytes skipped is  returned.

 The skip method of FilterInputStream  calls the skip  method of its underlying input stream  with the same argument, and returns whatever value that method does.

Parameters:

 n - the number of bytes to be skipped.

Returns:

 the actual number of bytes skipped.

Throws: IOException

 if an I/O error occurs.

Overrides:

skip in class InputStream

 available

  public int available() throws IOException

 Returns the number of bytes that can be read from this input  stream without blocking.

 The available method of  FilterInputStream calls the available   method of its underlying input stream and returns whatever value  that method returns.

Returns:

 the number of bytes that can be read from the input stream  without blocking.

Throws: IOException

 if an I/O error occurs.

Overrides:

available in class InputStream

See Also:

in

 close

  public void close() throws IOException

 Closes this input stream and releases any system resources  associated with the stream. The close method of  FilterInputStream  calls the close method  of its underlying input stream.

Throws: IOException

 if an I/O error occurs.

Overrides:

close in class InputStream

See Also:

in

 mark

  public synchronized void mark(int readlimit)

 Marks the current position in this input stream. A subsequent  call to the reset method repositions this stream at  the last marked position so that subsequent reads re-read the same bytes.

 The readlimit argument tells this input stream to  allow that many bytes to be read before the mark position gets  invalidated.

 The mark method of FilterInputStream  calls the mark  method of its underlying input stream  with the readlimit argument.

Parameters:

 readlimit - the maximum limit of bytes that can be read before  the mark position becomes invalid.

Overrides:

mark in class InputStream

See Also:

in, reset

 reset

  public synchronized void reset() throws IOException

 Repositions this stream to the position at the time the  mark method was last called on this input stream.

 The reset method of FilterInputStream  calls the reset  method of its underlying input stream.

 Stream marks are intended to be used in  situations where you need to read ahead a little to see what's in  the stream. Often this is most easily done by invoking some  general parser. If the stream is of the type handled by the  parse, it just chugs along happily. If the stream is not of  that type, the parser should toss an exception when it fails.  If this happens within readlimit bytes, it allows the outer  code to reset the stream and try another parser.

Throws: IOException

 if the stream has not been marked or if the  mark has been invalidated.

Overrides:

reset in class InputStream

See Also:

in, mark

 markSupported

  public boolean markSupported()

 Tests if this input stream supports the mark  and reset methods. The markSupported  method of FilterInputStream  calls the  markSupported method of its underlying input stream  and returns whatever value that method returns.

Returns:

true if this stream type supports the  mark and reset method;  false otherwise.

Overrides:

markSupported in class InputStream

See Also:

in, mark, reset

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.FilterOutputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.FilterOutputStream

java.lang.Object
   |
   +----java.io.OutputStream
           |
           +----java.io.FilterOutputStream

______________________________________________________________________________

 public class FilterOutputStream

 extends OutputStream

This class is the superclass of all classes that filter output  streams. These streams sit on top of an already existing output  stream (the underlying  output stream), but provide  additional functionality.

 The class FilterOutputStream itself simply overrides  all methods of OutputStream with versions that pass  all requests to the underlying output stream. Subclasses of  FilterOutputStream may further override some of these  methods as well as provide additional methods and fields.

______________________________________________________________________________

 	out

 The underlying output stream.

 	FilterOutputStream(OutputStream)

 Creates an output stream filter built on top of the specified  underlying output stream.

 	close()

 Closes this output stream and releases any system resources  associated with the stream.

 	flush()

 Flushes this output stream and forces any buffered output bytes  to be written out to the stream.

 	write(byte[])

 Writes b.length bytes to this output stream.

 	write(byte[], int, int)

 Writes len bytes from the specified  byte array starting at offset off to  this output stream.

 	write(int)

 Writes the specified byte to this output stream.

 out

  protected OutputStream out

 The underlying output stream.

 FilterOutputStream

  public FilterOutputStream(OutputStream out)

 Creates an output stream filter built on top of the specified  underlying output stream.

Parameters:

 out - the underlying output stream.

 write

  public void write(int b) throws IOException

 Writes the specified byte to this output stream.

 The write method of FilterOutputStream  calls the write  method of its underlying output stream.

Parameters:

 b - the byte.

Throws: IOException

 if an I/O error occurs.

Overrides:

write in class OutputStream

 write

  public void write(byte b[]) throws IOException

 Writes b.length bytes to this output stream.

 The write method of FilterOutputStream  calls its write  method of three arguments with the  arguments b, 0, and  b.length.

 Note that this method does not call the one-argument  write  method of its underlying stream with the single  argument b.

Parameters:

 b - the data to be written.

Throws: IOException

 if an I/O error occurs.

Overrides:

write in class OutputStream

See Also:

write

 write

  public void write(byte b[],
                    int off,
                    int len) throws IOException

 Writes len bytes from the specified  byte  array starting at offset off to  this output stream.

 The write method of FilterOutputStream  calls the write  method of one argument on each  byte to output.

 Note that this method does not call the write method  of its underlying input stream with the same arguments. Subclasses  of FilterOutputStream should provide a more efficient  implementation of this method.

Parameters:

 b - the data.

 off - the start offset in the data.

 len - the number of bytes to write.

Throws: IOException

 if an I/O error occurs.

Overrides:

write in class OutputStream

See Also:

write

 flush

  public void flush() throws IOException

 Flushes this output stream and forces any buffered output bytes  to be written out to the stream.

 The flush method of FilterOutputStream  calls the flush  method of its underlying output stream.

Throws: IOException

 if an I/O error occurs.

Overrides:

flush in class OutputStream

See Also:

out

 close

  public void close() throws IOException

 Closes this output stream and releases any system resources  associated with the stream.

 The close method of FilterOutputStream  calls its flush  method, and then calls the  close method of its underlying output stream.

Throws: IOException

 if an I/O error occurs.

Overrides:

close in class OutputStream

See Also:

flush, out

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.FilterReader

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.FilterReader

java.lang.Object
   |
   +----java.io.Reader
           |
           +----java.io.FilterReader

______________________________________________________________________________

 public class FilterReader

 extends Reader

Abstract class for reading filtered character streams.

______________________________________________________________________________

 	in

 The underlying character-input stream, or null if the stream has been  closed

 	FilterReader(Reader)

 Create a new filtered reader.

 	close()

 Close the stream.

 	mark(int)

 Mark the present position in the stream.

 	markSupported()

 Tell whether this stream supports the mark() operation.

 	read()

 Read a single character.

 	read(char[], int, int)

 Read characters into a portion of an array.

 	ready()

 Tell whether this stream is ready to be read.

 	reset()

 Reset the stream.

 	skip(long)

 Skip characters.

 in

  protected Reader in

 The underlying character-input stream, or null if the stream has been  closed

 FilterReader

  protected FilterReader(Reader in)

 Create a new filtered reader.

 read

  public int read() throws IOException

 Read a single character.

Throws: IOException

 If an I/O error occurs

Overrides:

read in class Reader

 read

  public int read(char cbuf[],
                  int off,
                  int len) throws IOException

 Read characters into a portion of an array.

Throws: IOException

 If an I/O error occurs

Overrides:

read in class Reader

 skip

  public long skip(long n) throws IOException

 Skip characters.

Throws: IOException

 If an I/O error occurs

Overrides:

skip in class Reader

 ready

  public boolean ready() throws IOException

 Tell whether this stream is ready to be read.

Throws: IOException

 If an I/O error occurs

Overrides:

ready in class Reader

 markSupported

  public boolean markSupported()

 Tell whether this stream supports the mark() operation.

Overrides:

markSupported in class Reader

 mark

  public void mark(int readAheadLimit) throws IOException

 Mark the present position in the stream.

Throws: IOException

 If an I/O error occurs

Overrides:

mark in class Reader

 reset

  public void reset() throws IOException

 Reset the stream.

Throws: IOException

 If an I/O error occurs

Overrides:

reset in class Reader

 close

  public void close() throws IOException

 Close the stream.

Throws: IOException

 If an I/O error occurs

Overrides:

close in class Reader

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.FilterWriter

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.FilterWriter

java.lang.Object
   |
   +----java.io.Writer
           |
           +----java.io.FilterWriter

______________________________________________________________________________

 public class FilterWriter

 extends Writer

Abstract class for writing filtered character streams.

______________________________________________________________________________

 	out

 The underlying character-output stream.

 	FilterWriter(Writer)

 Create a new filtered writer.

 	close()

 Close the stream.

 	flush()

 Flush the stream.

 	write(char[], int, int)

 Write a portion of an array of characters.

 	write(int)

 Write a single character.

 	write(String, int, int)

 Write a portion of a string.

 out

  protected Writer out

 The underlying character-output stream.

 FilterWriter

  protected FilterWriter(Writer out)

 Create a new filtered writer.

 write

  public void write(int c) throws IOException

 Write a single character.

Throws: IOException

 If an I/O error occurs

Overrides:

write in class Writer

 write

  public void write(char cbuf[],
                    int off,
                    int len) throws IOException

 Write a portion of an array of characters.

Parameters:

 cbuf - Buffer of characters to be written

 off - Offset from which to start reading characters

 len - Number of characters to be written

Throws: IOException

 If an I/O error occurs

Overrides:

write in class Writer

 write

  public void write(String str,
                    int off,
                    int len) throws IOException

 Write a portion of a string.

Parameters:

 str - String to be written

 off - Offset from which to start reading characters

 len - Number of characters to be written

Throws: IOException

 If an I/O error occurs

Overrides:

write in class Writer

 flush

  public void flush() throws IOException

 Flush the stream.

Throws: IOException

 If an I/O error occurs

Overrides:

flush in class Writer

 close

  public void close() throws IOException

 Close the stream.

Throws: IOException

 If an I/O error occurs

Overrides:

close in class Writer

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.InputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.InputStream

java.lang.Object
   |
   +----java.io.InputStream

______________________________________________________________________________

 public class InputStream

 extends Object

This abstract class is the superclass of all classes representing  an input stream of bytes.

 Applications that need to define a subclass of  InputStream  must always provide a method that returns  the next byte of input.

See Also:

BufferedInputStream, ByteArrayInputStream, DataInputStream, FilterInputStream, read, OutputStream, PushbackInputStream

______________________________________________________________________________

 	InputStream()

 	available()

 Returns the number of bytes that can be read from this input  stream without blocking.

 	close()

 Closes this input stream and releases any system resources  associated with the stream.

 	mark(int)

 Marks the current position in this input stream.

 	markSupported()

 Tests if this input stream supports the mark  and reset methods.

 	read()

 Reads the next byte of data from this input stream.

 	read(byte[])

 Reads up to b.length bytes of data from this input  stream into an array of bytes.

 	read(byte[], int, int)

 Reads up to len bytes of data from this input stream  into an array of bytes.

 	reset()

 Repositions this stream to the position at the time the  mark  method was last called on this input stream.

 	skip(long)

 Skips over and discards n bytes of data from this  input stream.

 InputStream

  public InputStream()

 read

  public abstract int read() throws IOException

 Reads the next byte of data from this input stream. The value  byte is returned as an int in the range  0 to 255 . If no byte is available  because the end of the stream has been reached, the value  -1  is returned. This method blocks until input data  is available, the end of the stream is detected, or an exception  is thrown.

 A subclass must provide an implementation of this method.

Returns:

 the next byte of data, or -1 if the end of the  stream is reached.

Throws: IOException

 if an I/O error occurs.

 read

  public int read(byte b[]) throws IOException

 Reads up to b.length bytes of data from this input  stream into an array of bytes.

 The read method of InputStream calls  the read  method of three arguments with the arguments  b, 0, and b.length.

Parameters:

 b - the buffer into which the data is read.

Returns:

 the total number of bytes read into the buffer, or  -1  is there is no more data because the end of  the stream has been reached.

Throws: IOException

 if an I/O error occurs.

See Also:

read

 read

  public int read(byte b[],
                  int off,
                  int len) throws IOException

 Reads up to len bytes of data from this input stream  into an array of bytes. This method blocks until some input is  available. If the first argument is null, up to  len  bytes are read and discarded.

 The read method of InputStream reads a  single byte at a time using the read method of zero arguments to  fill in the array. Subclasses are encouraged to provide a more  efficient implementation of this method.

Parameters:

 b - the buffer into which the data is read.

 off - the start offset of the data.

 len - the maximum number of bytes read.

Returns:

 the total number of bytes read into the buffer, or  -1  if there is no more data because the end of  the stream has been reached.

Throws: IOException

 if an I/O error occurs.

See Also:

read

 skip

  public long skip(long n) throws IOException

 Skips over and discards n bytes of data from this  input stream. The skip method may, for a variety of  reasons, end up skipping over some smaller number of bytes,  possibly 0 . The actual number of bytes skipped is  returned.

 The skip method of InputStream creates  a byte array of length n and then reads into it until  n bytes have been read or the end of the stream has  been reached. Subclasses are encouraged to provide a more  efficient implementation of this method.

Parameters:

 n - the number of bytes to be skipped.

Returns:

 the actual number of bytes skipped.

Throws: IOException

 if an I/O error occurs.

 available

  public int available() throws IOException

 Returns the number of bytes that can be read from this input  stream without blocking. The available method of  InputStream returns 0 . This method  should be overridden by subclasses.

Returns:

 the number of bytes that can be read from this input stream  without blocking.

Throws: IOException

 if an I/O error occurs.

 close

  public void close() throws IOException

 Closes this input stream and releases any system resources  associated with the stream.

 The close method of InputStream does nothing.

Throws: IOException

 if an I/O error occurs.

 mark

  public synchronized void mark(int readlimit)

 Marks the current position in this input stream. A subsequent  call to the reset method repositions this stream at  the last marked position so that subsequent reads re-read the same  bytes.

 The readlimit arguments tells this input stream to  allow that many bytes to be read before the mark position gets  invalidated.

 The mark method of InputStream does nothing.

Parameters:

 readlimit - the maximum limit of bytes that can be read before  the mark position becomes invalid.

See Also:

reset

 reset

  public synchronized void reset() throws IOException

 Repositions this stream to the position at the time the  mark method was last called on this input stream.

 The reset method of InputStream throws  an IOException , because input streams, by default, do  not support mark and reset.

 Stream marks are intended to be used in  situations where you need to read ahead a little to see what's in  the stream. Often this is most easily done by invoking some  general parser. If the stream is of the type handled by the  parser, it just chugs along happily. If the stream is not of  that type, the parser should toss an exception when it fails,  which, if it happens within readlimit bytes, allows the outer  code to reset the stream and try another parser.

Throws: IOException

 if this stream has not been marked or if the  mark has been invalidated.

See Also:

mark, IOException

 markSupported

  public boolean markSupported()

 Tests if this input stream supports the mark  and reset methods. The markSupported  method of InputStream  returns false.

Returns:

true if this true type supports the mark and reset  method; false  otherwise.

See Also:

mark, reset

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.InputStreamReader

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.InputStreamReader

java.lang.Object
   |
   +----java.io.Reader
           |
           +----java.io.InputStreamReader

______________________________________________________________________________

 public class InputStreamReader

 extends Reader

An InputStreamReader is a bridge from byte streams to character streams: It  reads bytes and translates them into characters according to a specified  character encoding. The encoding that it uses may be specified by name, or  the platform's default encoding may be accepted.

 Each invocation of one of an InputStreamReader's read() methods may  cause one or more bytes to be read from the underlying byte-input stream.  For top efficiency, consider wrapping an InputStreamReader within a  BufferedReader; for example,

 BufferedReader in
   = new BufferedReader(new InputStreamReader(System.in));

See Also:

BufferedReader, InputStream

______________________________________________________________________________

 	InputStreamReader(InputStream)

 Create an InputStreamReader that uses the default character encoding.

 	InputStreamReader(InputStream, String)

 Create an InputStreamReader that uses the named character encoding.

 	close()

 Close the stream.

 	getEncoding()

 Return the name of the encoding being used by this stream.

 	read()

 Read a single character.

 	read(char[], int, int)

 Read characters into a portion of an array.

 	ready()

 Tell whether this stream is ready to be read.

 InputStreamReader

  public InputStreamReader(InputStream in)

 Create an InputStreamReader that uses the default character encoding.

Parameters:

 in - An InputStream

 InputStreamReader

  public InputStreamReader(InputStream in,
                           String enc) throws UnsupportedEncodingException

 Create an InputStreamReader that uses the named character encoding.

Parameters:

 in - An InputStream

 enc - Name of encoding to be used

Throws: UnsupportedEncodingException

 If the named encoding is not supported

 getEncoding

  public String getEncoding()

 Return the name of the encoding being used by this stream. May return  null if the stream has been closed.

 read

  public int read() throws IOException

 Read a single character.

Returns:

 The character read, or -1 if the end of the stream has been  reached

Throws: IOException

 If an I/O error occurs

Overrides:

read in class Reader

 read

  public int read(char cbuf[],
                  int off,
                  int len) throws IOException

 Read characters into a portion of an array.

Parameters:

 cbuf - Destination buffer

 off - Offset at which to start storing characters

 len - Maximum number of characters to read

Returns:

 The number of characters read, or -1 if the end of the stream  has been reached

Throws: IOException

 If an I/O error occurs

Overrides:

read in class Reader

 ready

  public boolean ready() throws IOException

 Tell whether this stream is ready to be read. An InputStreamReader is  ready if its input buffer is not empty, or if bytes are available to be  read from the underlying byte stream.

Throws: IOException

 If an I/O error occurs

Overrides:

ready in class Reader

 close

  public void close() throws IOException

 Close the stream.

Throws: IOException

 If an I/O error occurs

Overrides:

close in class Reader

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.InterruptedIOException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.InterruptedIOException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.io.InterruptedIOException

______________________________________________________________________________

 public class InterruptedIOException

 extends IOException

Signals that an I/O operation has been interrupted.

See Also:

InputStream, OutputStream, interrupt

______________________________________________________________________________

 	bytesTransferred

 Reports how many bytes had been transferred as part of the I/O  operation before it was interrupted.

 	InterruptedIOException()

 Constructs an InterruptedIOException with no detail  message.

 	InterruptedIOException(String)

 Constructs an InterruptedIOException with the  specified detail message.

 bytesTransferred

  public int bytesTransferred

 Reports how many bytes had been transferred as part of the I/O  operation before it was interrupted.

 InterruptedIOException

  public InterruptedIOException()

 Constructs an InterruptedIOException with no detail  message.

 InterruptedIOException

  public InterruptedIOException(String s)

 Constructs an InterruptedIOException with the  specified detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.InvalidClassException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.InvalidClassException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.io.ObjectStreamException
                                   |
                                   +----java.io.InvalidClassException

______________________________________________________________________________

 public class InvalidClassException

 extends ObjectStreamException

Raised when the Serialization runtime detects a problem with a Class.  The class may:

•  not match the serial version of the class in the stream

•  the class contains unknown datatypes

•  the class implements only one of writeObject or readObject methods

•  the class is not public

•  the class does not have an accessible no-arg constructor

______________________________________________________________________________

 	classname

 	InvalidClassException(String)

 Report a InvalidClassException for the specified reason.

 	InvalidClassException(String, String)

 	getMessage()

 Produce the message, include the classname if present.

 classname

  public String classname

 InvalidClassException

  public InvalidClassException(String reason)

 Report a InvalidClassException for the specified reason.

 InvalidClassException

  public InvalidClassException(String cname,
                               String reason)

 getMessage

  public String getMessage()

 Produce the message, include the classname if present.

Overrides:

getMessage in class Throwable

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.InvalidObjectException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.InvalidObjectException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.io.ObjectStreamException
                                   |
                                   +----java.io.InvalidObjectException

______________________________________________________________________________

 public class InvalidObjectException

 extends ObjectStreamException

______________________________________________________________________________

 	InvalidObjectException(String)

 Raised by a class when it is explicitly disallowing itself to  be serialized.

 InvalidObjectException

  public InvalidObjectException(String reason)

 Raised by a class when it is explicitly disallowing itself to  be serialized. The argument should be the name of the class  being disallowed.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.IOException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.IOException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException

______________________________________________________________________________

 public class IOException

 extends Exception

Signals that an I/O exception of some sort has occurred.

See Also:

InputStream, OutputStream

______________________________________________________________________________

 	IOException()

 Constructs an IOException with no detail message.

 	IOException(String)

 Constructs an IOException with the specified detail  message.

 IOException

  public IOException()

 Constructs an IOException with no detail message.

 IOException

  public IOException(String s)

 Constructs an IOException with the specified detail  message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.LineNumberInputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.LineNumberInputStream

java.lang.Object
   |
   +----java.io.InputStream
           |
           +----java.io.FilterInputStream
                   |
                   +----java.io.LineNumberInputStream

______________________________________________________________________________

 public class LineNumberInputStream

 extends FilterInputStream

 Note: LineNumberInputStream is deprecated. This class incorrectly assumes that bytes adequately represent  characters. As of JDK 1.1, the preferred way to operate on  character streams is via the new character-stream classes, which  include a class for counting line numbers.

This class is an input stream filter that provides the added  functionality of keeping track of the current line number.

 A line is a sequence of bytes ending with a carriage return  character ('\r' ), a newline character  ('\n'), or a carriage return character followed  immediately by a linefeed character. In all three cases, the line  terminating character(s) are returned as a single newline character.

 The line number begins at 0, and is incremented by  1 when a read returns a newline character.

See Also:

LineNumberReader

______________________________________________________________________________

 	LineNumberInputStream(InputStream)

 Constructs a newline number input stream that reads its input  from the specified input stream.

 	available()

 Returns the number of bytes that can be read from this input  stream without blocking.

 	getLineNumber()

 Returns the current line number.

 	mark(int)

 Marks the current position in this input stream.

 	read()

 Reads the next byte of data from this input stream.

 	read(byte[], int, int)

 Reads up to len bytes of data from this input stream  into an array of bytes.

 	reset()

 Repositions this stream to the position at the time the  mark  method was last called on this input stream.

 	setLineNumber(int)

 Sets the line number to the specified argument.

 	skip(long)

 Skips over and discards n bytes of data from the  input stream.

 LineNumberInputStream

  public LineNumberInputStream(InputStream in)

 Constructs a newline number input stream that reads its input  from the specified input stream.

Parameters:

 in - the underlying input stream.

 read

  public int read() throws IOException

 Reads the next byte of data from this input stream. The value  byte is returned as an int in the range  0 to 255 . If no byte is available  because the end of the stream has been reached, the value  -1  is returned. This method blocks until input data  is available, the end of the stream is detected, or an exception  is thrown.

 The read method of  LineNumberInputStream calls the read  method of the underlying input stream. It checks for carriage  returns and newline characters in the input, and modifies the  current line number as appropriate. A carriage-return character or  a carriage return followed by a newline character are both  converted into a single newline character.

Returns:

 the next byte of data, or -1 if the end of this  stream is reached.

Throws: IOException

 if an I/O error occurs.

Overrides:

read in class FilterInputStream

See Also:

in, getLineNumber

 read

  public int read(byte b[],
                  int off,
                  int len) throws IOException

 Reads up to len bytes of data from this input stream  into an array of bytes. This method blocks until some input is available.

 The read method of  LineNumberInputStream repeatedly calls the  read method of zero arguments to fill in the byte array.

Parameters:

 b - the buffer into which the data is read.

 off - the start offset of the data.

 len - the maximum number of bytes read.

Returns:

 the total number of bytes read into the buffer, or  -1  if there is no more data because the end of  this stream has been reached.

Throws: IOException

 if an I/O error occurs.

Overrides:

read in class FilterInputStream

See Also:

read

 setLineNumber

  public void setLineNumber(int lineNumber)

 Sets the line number to the specified argument.

Parameters:

 lineNumber - the new line number.

 getLineNumber

  public int getLineNumber()

 Returns the current line number.

Returns:

 the current line number.

 skip

  public long skip(long n) throws IOException

 Skips over and discards n bytes of data from the  input stream. The skip method may, for a variety of  reasons, end up skipping over some smaller number of bytes,  possibly 0 . The actual number of bytes skipped is returned.

 The skip method of  LineNumberInputStream creates a byte array of length  n and then reads into it until n bytes  have been read or the end of the stream has been reached.

Parameters:

 n - the number of bytes to be skipped.

Returns:

 the actual number of bytes skipped.

Throws: IOException

 if an I/O error occurs.

Overrides:

skip in class FilterInputStream

 available

  public int available() throws IOException

 Returns the number of bytes that can be read from this input  stream without blocking.

 Note that if the underlying input stream is able to supply  k  input characters without blocking, the  LineNumberInputStream  can guarantee only to provide  k/2 characters without blocking, because the  k characters from the underlyhing input stream might  consist of k /2 pairs of '\r' and  '\n', which are converted to just  k/2 '\n' characters.

Returns:

 the number of bytes that can be read from this input stream  without blocking.

Throws: IOException

 if an I/O error occurs.

Overrides:

available in class FilterInputStream

See Also:

in

 mark

  public void mark(int readlimit)

 Marks the current position in this input stream. A subsequent  call to the reset method repositions this stream at  the last marked position so that subsequent reads re-read the same bytes.

 The mark method of  LineNumberInputStream remembers the current line  number in a private variable, and then calls the mark  method of the underlying input stream.

Parameters:

 readlimit - the maximum limit of bytes that can be read before  the mark position becomes invalid.

Overrides:

mark in class FilterInputStream

See Also:

in, reset

 reset

  public void reset() throws IOException

 Repositions this stream to the position at the time the  mark method was last called on this input stream.

 The reset method of  LineNumberInputStream resets the line number to be  the line number at the time the mark method was  called, and then calls the reset method of the  underlying input stream.

 Stream marks are intended to be used in  situations where you need to read ahead a little to see what's in  the stream. Often this is most easily done by invoking some  general parser. If the stream is of the type handled by the  parser, it just chugs along happily. If the stream is not of  that type, the parser should toss an exception when it fails,  which, if it happens within readlimit bytes, allows the outer  code to reset the stream and try another parser.

Throws: IOException

 if an I/O error occurs.

Overrides:

reset in class FilterInputStream

See Also:

in, mark

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.LineNumberReader

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.LineNumberReader

java.lang.Object
   |
   +----java.io.Reader
           |
           +----java.io.BufferedReader
                   |
                   +----java.io.LineNumberReader

______________________________________________________________________________

 public class LineNumberReader

 extends BufferedReader

A buffered character-input stream that keeps track of line numbers. A line  is considered to be terminated by any one of a line feed ('\n'), a carriage  return ('\r'), or a carriage return followed immediately by a linefeed.

______________________________________________________________________________

 	LineNumberReader(Reader)

 Create a new line-numbering reader, using the default input-buffer  size.

 	LineNumberReader(Reader, int)

 Create a new line-numbering reader, reading characters into a buffer of  the given size.

 	getLineNumber()

 Get the current line number.

 	mark(int)

 Mark the present position in the stream.

 	read()

 Read a single character.

 	read(char[], int, int)

 Read characters into a portion of an array.

 	readLine()

 Read a line of text.

 	reset()

 Reset the stream to the most recent mark.

 	setLineNumber(int)

 Set the current line number.

 	skip(long)

 Skip characters.

 LineNumberReader

  public LineNumberReader(Reader in)

 Create a new line-numbering reader, using the default input-buffer  size.

 LineNumberReader

  public LineNumberReader(Reader in,
                          int sz)

 Create a new line-numbering reader, reading characters into a buffer of   the given size.

 setLineNumber

  public void setLineNumber(int lineNumber)

 Set the current line number.

 getLineNumber

  public int getLineNumber()

 Get the current line number.

 read

  public int read() throws IOException

 Read a single character. Line terminators are compressed into single  newline ('\n') characters.

Returns:

 The character read, or -1 if the end of the stream has been  reached

Throws: IOException

 If an I/O error occurs

Overrides:

read in class BufferedReader

 read

  public int read(char cbuf[],
                  int off,
                  int len) throws IOException

 Read characters into a portion of an array.

Parameters:

 cbuf - Destination buffer

 off - Offset at which to start storing characters

 len - Maximum number of characters to read

Returns:

 The number of bytes read, or -1 if the end of the stream has  already been reached

Throws: IOException

 If an I/O error occurs

Overrides:

read in class BufferedReader

 readLine

  public String readLine() throws IOException

 Read a line of text. A line is considered to be terminated by any one  of a line feed ('\n'), a carriage return ('\r'), or a carriage return  followed immediately by a linefeed.

Returns:

 A String containing the contents of the line, not including  any line-termination characters, or null if the end of the  stream has been reached

Throws: IOException

 If an I/O error occurs

Overrides:

readLine in class BufferedReader

 skip

  public long skip(long n) throws IOException

 Skip characters.

Parameters:

 n - The number of characters to skip

Returns:

 The number of characters actually skipped

Throws: IOException

 If an I/O error occurs

Overrides:

skip in class BufferedReader

 mark

  public void mark(int readAheadLimit) throws IOException

 Mark the present position in the stream. Subsequent calls to reset()  will attempt to reposition the stream to this point, and will also reset  the line number appropriately.

Parameters:

 readAheadLimit - Limit on the number of characters that may be  read while still preserving the mark. After  reading this many characters, attempting to  reset the stream may fail.

Throws: IOException

 If an I/O error occurs

Overrides:

mark in class BufferedReader

 reset

  public void reset() throws IOException

 Reset the stream to the most recent mark.

Throws: IOException

 If the stream has not been marked,  or if the mark has been invalidated

Overrides:

reset in class BufferedReader

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.NotActiveException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.NotActiveException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.io.ObjectStreamException
                                   |
                                   +----java.io.NotActiveException

______________________________________________________________________________

 public class NotActiveException

 extends ObjectStreamException

The NotActiveException is thrown when serialization or deserialization  is not active.

______________________________________________________________________________

 	NotActiveException()

 Constructor to create a new NotActiveException with no reason.

 	NotActiveException(String)

 Constructor to create a new NotActiveException with the reason given.

 NotActiveException

  public NotActiveException(String reason)

 Constructor to create a new NotActiveException with the reason given.

 NotActiveException

  public NotActiveException()

 Constructor to create a new NotActiveException with no reason.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.NotSerializableException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.NotSerializableException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.io.ObjectStreamException
                                   |
                                   +----java.io.NotSerializableException

______________________________________________________________________________

 public class NotSerializableException

 extends ObjectStreamException

Raised by a class or the serialization runtime when a class  may not be serialized. The argument should be the name of the class.

______________________________________________________________________________

 	NotSerializableException()

  	NotSerializableException (String)

 NotSerializableException

  public NotSerializableException(String classname)

 NotSerializableException

  public NotSerializableException()

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.io.ObjectInput

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.io.ObjectInput

 public interface ObjectInput

 extends DataInput

ObjectInput extends the DataInput interface to include the writing of  objects. DataInput includes methods for the input of primitive types,  ObjectInput extends that interface to include objects, arrays, and Strings.

See Also:

InputStream, ObjectOutputStream, ObjectInputStream

______________________________________________________________________________

 	available()

 Returns the number of bytes that can be read  without blocking.

 	close()

 Closes the input stream.

 	read()

 Reads a byte of data.

 	read(byte[])

 Reads into an array of bytes.

 	read(byte[], int, int)

 Reads into an array of bytes.

 	readObject()

 Read and return an object.

 	skip(long)

 Skips n bytes of input.

 readObject

  public abstract Object readObject() throws ClassNotFoundException, IOException

 Read and return an object. The class that implements this interface  defines where the object is "read" from.

Throws: ClassNotFoundException

 If the class of a serialized  object cannot be found.

Throws: IOException

 If any of the usual Input/Output  related exceptions occur.

 read

  public abstract int read() throws IOException

 Reads a byte of data. This method will block if no input is  available.

Returns:

 the byte read, or -1 if the end of the 	stream is reached.

Throws: IOException

 If an I/O error has occurred.

 read

  public abstract int read(byte b[]) throws IOException

 Reads into an array of bytes. This method will  block until some input is available.

Parameters:

 b - the buffer into which the data is read

Returns:

 the actual number of bytes read, -1 is  returned when the end of the stream is reached.

Throws: IOException

 If an I/O error has occurred.

 read

  public abstract int read(byte b[],
                           int off,
                           int len) throws IOException

 Reads into an array of bytes. This method will  block until some input is available.

Parameters:

 b - the buffer into which the data is read

 off - the start offset of the data

 len - the maximum number of bytes read

Returns:

 the actual number of bytes read, -1 is  returned when the end of the stream is reached.

Throws: IOException

 If an I/O error has occurred.

 skip

  public abstract long skip(long n) throws IOException

 Skips n bytes of input.

Parameters:

 n - the number of bytes to be skipped

Returns:

 the actual number of bytes skipped.

Throws: IOException

 If an I/O error has occurred.

 available

  public abstract int available() throws IOException

 Returns the number of bytes that can be read  without blocking.

Returns:

 the number of available bytes.

 close

  public abstract void close() throws IOException

 Closes the input stream. Must be called  to release any resources associated with  the stream.

Throws: IOException

 If an I/O error has occurred.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.ObjectInputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.ObjectInputStream

java.lang.Object
   |
   +----java.io.InputStream
           |
           +----java.io.ObjectInputStream

______________________________________________________________________________

 public class ObjectInputStream

 extends InputStream

 implements ObjectInput, ObjectStreamConstants

An ObjectInputStream deserializes primitive data and objects previously  written using an ObjectOutputStream.  ObjectOutputStream and ObjectInputStream can provide an application  with persistent storage for graphs of objects when used with a  FileOutputStream and FileInputStream respectively.  ObjectInputStream is used to recover those objects previously  serialized. Other uses include passing objects between hosts using  a socket stream or for marshaling and unmarshaling arguments and  parameters in a remote communication system.

 ObjectInputStream ensures that the types of all objects in the  graph created from the stream match the classes present in the  Java Virtual Machine. Classes are loaded as required using the  standard mechanisms.

 Only objects that support the java.io.Serializable or  java.io.Externalizable interface can be read from streams.  The method readObject  is used to read an object  from the stream. Java's safe casting should be used to get the  desired type. In Java, strings and arrays are objects and are  treated as objects during serialization. When read they need to be  cast to the expected type.

 Primitive data types can be read from the stream using the appropriate  method on DataInput.

 The default deserialization mechanism for objects restores the  contents of each field to the value and type it had when it was written.  Fields declared as transient or static are ignored by the  deserialization process. References to other objects cause those  objects to be read from the stream as necessary. Graphs of objects  are restored correctly using a reference sharing mechanism. New  objects are always allocated when deserializing, which prevents  existing objects from being overwritten.

 Reading an object is analogous to running the constructors of a new  object. Memory is allocated for the object and initialized to zero  (NULL). No-arg constructors are invoked for the non-serializable  classes and then the fields of the serializable classes are  restored from the stream starting with the serializable class closest to  java.lang.object and finishing with the object's most specifiec  class.

 For example to read from a stream as written by the example in  ObjectOutputStream:

        FileInputStream istream = new FileInputStream("t.tmp");
        ObjectInputStream p = new ObjectInputStream(istream);
        int i = p.readInt();
        String today = (String)p.readObject();
        Date date = (Date)p.readObject();
        istream.close();

 Classes control how they are serialized by implementing either the  java.io.Serializable or java.io.Externalizable interfaces.

 Implementing the Serializable interface allows object serialization  to save and restore the entire state of the object and it allows  classes to evolve between the time the stream is written and the time it is  read. It automatically traverses references between objects,  saving and restoring entire graphs.  Serializable classes that require special handling during the  serialization and deserialization process should implement both  of these methods:

 private void writeObject(java.io.ObjectOutputStream stream)
     throws IOException;
 private void readObject(java.io.ObjectInputStream stream)
     throws IOException, ClassNotFoundException;

 The readObject method is responsible for reading and restoring the  state of the object for its particular class using data written to  the stream by the corresponding writeObject method. The method  does not need to concern itself with the state belonging to its  superclasses or subclasses. State is restored by reading data from  the ObjectInputStream for the individual fields and making  assignments to the appropriate fields of the object. Reading  primitive data types is supported by DataInput.

 Serialization does not read or assign values to the fields of any  object that does not implement the java.io.Serializable interface.  Subclasses of Objects that are not serializable can be  serializable. In this case the non-serializable class must have a  no-arg constructor to allow its fields to be initialized. In this  case it is the responsibility of the subclass to save and restore  the state of the non-serializable class. It is frequently the case that  the fields of that class are accessible (public, package, or  protected) or that there are get and set methods that can be used  to restore the state.

 Any exception that occurs while deserializing an object will be  caught by the ObjectInputStream and abort the reading process.

 Implementing the Externalizable interface allows the object to  assume complete control over the contents and format of the object's  serialized form. The methods of the Externalizable interface,  writeExternal and readExternal, are called to save and restore the  objects state. When implemented by a class they can write and read  their own state using all of the methods of ObjectOutput and  ObjectInput. It is the responsibility of the objects to handle any  versioning that occurs.

See Also:

DataInput, ObjectOutputStream, Serializable

______________________________________________________________________________

 	ObjectInputStream(InputStream)

 Create an ObjectInputStream that reads from the specified InputStream.

 	available()

 Returns the number of bytes that can be read without blocking.

 	close()

 Closes the input stream.

 	defaultReadObject()

 Read the non-static and non-transient fields of the current class  from this stream.

 	enableResolveObject(boolean)

 Enable the stream to allow objects read from the stream to be replaced.

 	read()

 Reads a byte of data.

 	read(byte[], int, int)

 Reads into an array of bytes.

 	readBoolean()

 Reads in a boolean.

 	readByte()

 Reads an 8 bit byte.

 	readChar()

 Reads a 16 bit char.

 	readDouble()

 Reads a 64 bit double.

 	readFloat()

 Reads a 32 bit float.

 	readFully(byte[])

 Reads bytes, blocking until all bytes are read.

 	readFully(byte[], int, int)

 Reads bytes, blocking until all bytes are read.

 	readInt()

 Reads a 32 bit int.

 	readLine()

 Reads in a line that has been terminated by a \n, \r,  \r\n or EOF.

 	readLong()

 Reads a 64 bit long.

 	readObject()

 Read an object from the ObjectInputStream.

 	readShort()

 Reads a 16 bit short.

 	readStreamHeader()

 The readStreamHeader method is provided to allow subclasses to  read and verify their own stream headers.

 	readUnsignedByte()

 Reads an unsigned 8 bit byte.

 	readUnsignedShort()

 Reads an unsigned 16 bit short.

 	readUTF()

 Reads a UTF format String.

 	registerValidation(ObjectInputValidation, int)

 Register an object to be validated before the graph is  returned.

 	resolveClass(ObjectStreamClass)

 Subclasses may implement this method to allow classes to be  fetched from an alternate source.

 	resolveObject(Object)

 This method will allow trusted subclasses of ObjectInputStream  to substitute one object for another during  deserialization.

 	skipBytes(int)

 Skips bytes, block until all bytes are skipped.

 ObjectInputStream

  public ObjectInputStream(InputStream in) throws IOException, StreamCorruptedException

 Create an ObjectInputStream that reads from the specified InputStream.  The stream header containing the magic number and version number  are read from the stream and verified. This method will block  until the corresponding ObjectOutputStream has written and flushed the header.

Throws: StreamCorruptedException

 The version or magic number are incorrect.

Throws: IOException

 An exception occurred in the underlying stream.

 readObject

  public final Object readObject() throws OptionalDataException, ClassNotFoundException, IOException

 Read an object from the ObjectInputStream.  The class of the object, the signature of the class, and the values  of the non-transient and non-static fields of the class and all  of its supertypes are read. Default deserializing for a class can be  overriden using the writeObject and readObject methods.  Objects referenced by this object are read transitively so  that a complete equivalent graph of objects is reconstructed by readObject.

 The root object is completly restored when all of its fields  and the objects it references are completely restored. At this  point the object validation callbacks are executed in order  based on their registered priorities. The callbacks are  registered by objects (in the readObject special methods)  as they are individually restored.  Exceptions are thrown for problems with the InputStream and for classes  that should not be deserialized. All exceptions are fatal to the  InputStream and leave it in an indeterminate state; it is up to the caller  to ignore or recover the stream state.

Throws: ClassNotFoundException

 Class of a serialized object  cannot be found.

Throws: InvalidClassException

 Something is wrong with a class used by  serialization.

Throws: StreamCorruptedException

 Control information in the  stream is inconsistent.

Throws: OptionalDataException

 Primitive data was found in the  stream instead of objects.

Throws: IOException

 Any of the usual Input/Output related exceptions.

 defaultReadObject

  public final void defaultReadObject() throws IOException, ClassNotFoundException , NotActiveException

 Read the non-static and non-transient fields of the current class  from this stream. This may only be called from the readObject method  of the class being deserialized. It will throw the NotActiveException  if it is called otherwise.

Throws: ClassNotFoundException

 if the class of a serialized  object could not be found.

Throws: IOException

 if an I/O error occurs.

Throws: NotActiveException

 if the stream is not currently reading  objects.

 registerValidation

  public synchronized void registerValidation(ObjectInputValidation obj,
                                              int prio) throws NotActiveException, InvalidObjectException

 Register an object to be validated before the graph is  returned. While similar to resolveObject these validations are  called after the entire graph has been reconstituted.  Typically, a readObject method will register the object with  the stream so that when all of the objects are restored a final  set of validations can be performed.

Parameters:

 obj - the object to receive the validation callback.

 prio - controls the order of callbacks;zero is a good default.  Use higher numbers to be called back earlier, lower numbers for later  callbacks. Within a priority, callbacks are processed in no  particular order.

Throws: NotActiveException

 The stream is not currently reading objects  so it is invalid to register a callback.

Throws: InvalidObjectException

 The validation object is null.

 resolveClass

  protected Class resolveClass(ObjectStreamClass v) throws IOException , ClassNotFoundException

 Subclasses may implement this method to allow classes to be  fetched from an alternate source.  The corresponding method in ObjectOutputStream is  annotateClass. This method will be invoked only once for each  unique class in the stream. This method can be implemented by  subclasses to use an alternate loading mechanism but must  return a Class object. Once returned, the serialVersionUID of the  class is compared to the serialVersionUID of the serialized class.  If there is a mismatch, the deserialization fails and an exception  is raised.

 By default the class name is resolved relative to the class  that called readObject.

Throws: ClassNotFoundException

 If class of  a serialized object cannot be found.

 resolveObject

  protected Object resolveObject(Object obj) throws IOException

 This method will allow trusted subclasses of ObjectInputStream  to substitute one object for another during  deserialization. Replacing objects is disabled until  enableResolveObject is called. The enableResolveObject method  checks that the stream requesting to resolve object can be  trusted. Every reference to serializable objects is passed to  resolveObject. To insure that the private state of objects is  not unintentionally exposed only trusted streams may use  resolveObject.

 This method is called after an object has been read but before it is  returned from readObject. The default resolveObject method  just returns the new object.

 When a subclass is replacing objects it must insure that the  substituted object is compatible with every field where the  reference will be stored. Objects whose type is not a subclass  of the type of the field or array element abort the  serialization by raising an exception and the object is not be  stored.

 This method is called only once when each object is first encountered.  All subsequent references to the object will be redirected to the  new object.

Throws: IOException

 Any of the usual Input/Output exceptions.

 enableResolveObject

  protected final boolean enableResolveObject(boolean enable) throws SecurityException

 Enable the stream to allow objects read from the stream to be replaced.   If the stream is a trusted class it is allowed to enable replacment.  Trusted classes are those classes with a classLoader equals null.

 When enabled the resolveObject method is called for every object  being deserialized.

Throws: SecurityException

 The classloader of this stream object is non-null.

 readStreamHeader

  protected void readStreamHeader() throws IOException, StreamCorruptedException

 The readStreamHeader method is provided to allow subclasses to  read and verify their own stream headers. It reads and  verifies the magic number and version number.

 read

  public int read() throws IOException

 Reads a byte of data. This method will block if no input is  available.

Returns:

 the byte read, or -1 if the end of the 	stream is reached.

Throws: IOException

 If an I/O error has occurred.

Overrides:

read in class InputStream

 read

  public int read(byte data[],
                  int offset,
                  int length) throws IOException

 Reads into an array of bytes. This method will  block until some input is available.

Parameters:

 b - the buffer into which the data is read

 off - the start offset of the data

 len - the maximum number of bytes read

Returns:

 the actual number of bytes read, -1 is  returned when the end of the stream is reached.

Throws: IOException

 If an I/O error has occurred.

Overrides:

read in class InputStream

 available

  public int available() throws IOException

 Returns the number of bytes that can be read without blocking.

Returns:

 the number of available bytes.

Overrides:

available in class InputStream

 close

  public void close() throws IOException

 Closes the input stream. Must be called  to release any resources associated with  the stream.

Throws: IOException

 If an I/O error has occurred.

Overrides:

close in class InputStream

 readBoolean

  public boolean readBoolean() throws IOException

 Reads in a boolean.

Returns:

 the boolean read.

Throws: EOFException

 If end of file is reached.

Throws: IOException

 If other I/O error has occurred.

 readByte

  public byte readByte() throws IOException

 Reads an 8 bit byte.

Returns:

 the 8 bit byte read.

Throws: EOFException

 If end of file is reached.

Throws: IOException

 If other I/O error has occurred.

 readUnsignedByte

  public int readUnsignedByte() throws IOException

 Reads an unsigned 8 bit byte.

Returns:

 the 8 bit byte read.

Throws: EOFException

 If end of file is reached.

Throws: IOException

 If other I/O error has occurred.

 readShort

  public short readShort() throws IOException

 Reads a 16 bit short.

Returns:

 the 16 bit short read.

Throws: EOFException

 If end of file is reached.

Throws: IOException

 If other I/O error has occurred.

 readUnsignedShort

  public int readUnsignedShort() throws IOException

 Reads an unsigned 16 bit short.

Returns:

 the 16 bit short read.

Throws: EOFException

 If end of file is reached.

Throws: IOException

 If other I/O error has occurred.

 readChar

  public char readChar() throws IOException

 Reads a 16 bit char.

Returns:

 the 16 bit char read.

Throws: EOFException

 If end of file is reached.

Throws: IOException

 If other I/O error has occurred.

 readInt

  public int readInt() throws IOException

 Reads a 32 bit int.

Returns:

 the 32 bit integer read.

Throws: EOFException

 If end of file is reached.

Throws: IOException

 If other I/O error has occurred.

 readLong

  public long readLong() throws IOException

 Reads a 64 bit long.

Returns:

 the read 64 bit long.

Throws: EOFException

 If end of file is reached.

Throws: IOException

 If other I/O error has occurred.

 readFloat

  public float readFloat() throws IOException

 Reads a 32 bit float.

Returns:

 the 32 bit float read.

Throws: EOFException

 If end of file is reached.

Throws: IOException

 If other I/O error has occurred.

 readDouble

  public double readDouble() throws IOException

 Reads a 64 bit double.

Returns:

 the 64 bit double read.

Throws: EOFException

 If end of file is reached.

Throws: IOException

 If other I/O error has occurred.

 readFully

  public void readFully(byte data[]) throws IOException

 Reads bytes, blocking until all bytes are read.

Parameters:

 b - the buffer into which the data is read

Throws: EOFException

 If end of file is reached.

Throws: IOException

 If other I/O error has occurred.

 readFully

  public void readFully(byte data[],
                        int offset,
                        int size) throws IOException

 Reads bytes, blocking until all bytes are read.

Parameters:

 b - the buffer into which the data is read

 off - the start offset of the data

 len - the maximum number of bytes to read

Throws: EOFException

 If end of file is reached.

Throws: IOException

 If other I/O error has occurred.

 skipBytes

  public int skipBytes(int len) throws IOException

 Skips bytes, block until all bytes are skipped.

Parameters:

 n - the number of bytes to be skipped

Returns:

 the actual number of bytes skipped.

Throws: EOFException

 If end of file is reached.

Throws: IOException

 If other I/O error has occurred.

 readLine

  public String readLine() throws IOException

 Reads in a line that has been terminated by a \n, \r,  \r\n or EOF.

Returns:

 a String copy of the line.

 readUTF

  public String readUTF() throws IOException

 Reads a UTF format String.

Returns:

 the String.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.io.ObjectInputValidation

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.io.ObjectInputValidation

 public interface ObjectInputValidation

Callback interface to allow validation of objects within a graph.  Allows an object to be called when a complete graph of objects has  been deserialized.

See Also:

ObjectInputStream, registerValidation

______________________________________________________________________________

 	validateObject()

 Validates the object

 validateObject

  public abstract void validateObject() throws InvalidObjectException

 Validates the object

Throws: InvalidObjectException

 If the object cannot validate itself.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.io.ObjectOutput

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.io.ObjectOutput

 public interface ObjectOutput

 extends DataOutput

ObjectOutput extends the DataOutput interface to include writing of objects.  DataOutput includes methods for output of primitive types, ObjectOutput  extends that interface to include objects, arrays, and Strings.

See Also:

InputStream, ObjectOutputStream, ObjectInputStream

______________________________________________________________________________

 	close()

 Closes the stream.

 	flush()

 Flushes the stream.

 	write(byte[])

 Writes an array of bytes.

 	write(byte[], int, int)

 Writes a sub array of bytes.

 	write(int)

 Writes a byte.

 	writeObject(Object)

 Write an object to the underlying storage or stream.

 writeObject

  public abstract void writeObject(Object obj) throws IOException

 Write an object to the underlying storage or stream. The  class that implements this interface defines how the object is  written.

Throws: IOException

 Any of the usual Input/Output related exceptions.

 write

  public abstract void write(int b) throws IOException

 Writes a byte. This method will block until the byte is actually  written.

Parameters:

 b - the byte

Throws: IOException

 If an I/O error has occurred.

 write

  public abstract void write(byte b[]) throws IOException

 Writes an array of bytes. This method will block until the bytes  are actually written.

Parameters:

 b - the data to be written

Throws: IOException

 If an I/O error has occurred.

 write

  public abstract void write(byte b[],
                             int off,
                             int len) throws IOException

 Writes a sub array of bytes.

Parameters:

 b - the data to be written

 off - the start offset in the data

 len - the number of bytes that are written

Throws: IOException

 If an I/O error has occurred.

 flush

  public abstract void flush() throws IOException

 Flushes the stream. This will write any buffered  output bytes.

Throws: IOException

 If an I/O error has occurred.

 close

  public abstract void close() throws IOException

 Closes the stream. This method must be called  to release any resources associated with the  stream.

Throws: IOException

 If an I/O error has occurred.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.ObjectOutputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.ObjectOutputStream

java.lang.Object
   |
   +----java.io.OutputStream
           |
           +----java.io.ObjectOutputStream

______________________________________________________________________________

 public class ObjectOutputStream

 extends OutputStream

 implements ObjectOutput, ObjectStreamConstants

An ObjectOutputStream writes primitive data types and graphs of  Java objects to an OutputStream. The objects can be read  (reconstituted) using an ObjectInputStream.  Persistent storage of objects can be accomplished by using a file for  the stream.  If the stream is a network socket stream, the objects can be reconsituted  on another host or in another process.

 Only objects that support the java.io.Serializable interface can be  written to streams.  The class of each serializable object is encoded including the class  name and signature of the class, the values of the  object's fields and arrays, and the closure of any other objects  referenced from the initial objects.

 The method writeObject is used to write an object  to the stream. Any object, including Strings and arrays, is  written with writeObject. Multiple objects or primitives can be  written to the stream. The objects must be read back from the  corresponding ObjectInputstream with the same types and in the same  order as they were written.

 Primitive data types can also be written to the stream using the  appropriate methods from DataOutput. Strings can also be written  using the writeUTF method.

 The default serialization mechanism for an object writes the class  of the object, the class signature, and the values of all  non-transient and non-static fields. References to other objects  (except in transient or static fields) cause those objects to be  written also. Multiple references to a single object are encoded  using a reference sharing mechanism so that graphs of objects can  be restored to the same shape as when the original was written.

 For example to write an object that can be read by the example in ObjectInputStream:

        FileOutputStream ostream = new FileOutputStream("t.tmp");
        ObjectOutputStream p = new ObjectOutputStream(ostream);
        p.writeInt(12345);
        p.writeObject("Today");
        p.writeObject(new Date());
        p.flush();
        ostream.close();

 Classes that require special handling during the serialization and deserialization  process must implement special methods with these exact signatures:

 private void readObject(java.io.ObjectInputStream stream)
     throws IOException, ClassNotFoundException;
 private void writeObject(java.io.ObjectOutputStream stream)
     throws IOException

 The writeObject method is responsible for writing the state of  the object for its particular class so that the corresponding  readObject method can restore it.  The method does not need to concern itself with the  state belonging to the object's superclasses or subclasses.  State is saved by writing the individual fields to the ObjectOutputStream  using the writeObject method or by using the methods for  primitive data types supported by DataOutput.

 Serialization does not write out the fields of any object that does  not implement the java.io.Serializable interface. Subclasses of  Objects that are not serializable can be serializable. In this case  the non-serializable class must have a no-arg constructor to allow  its fields to be initialized. In this case it is the  responsibility of the subclass to save and restore the state of the  non-serializable class. It is frequently the case that the fields  of that class are accessible (public, package, or protected) or  that there are get and set methods that can be used to restore the  state.

 Serialization of an object can be prevented by implementing writeObject  and readObject methods that throw the NotSerializableException.  The exception will be caught by the ObjectOutputStream and abort the  serialization process.  Implementing the Externalizable interface allows the object to  assume complete control over the contents and format of the object's  serialized form. The methods of the Externalizable interface,  writeExternal and readExternal, are called to save and restore the  objects state. When implemented by a class they can write and read  their own state using all of the methods of ObjectOutput and  ObjectInput. It is the responsibility of the objects to handle any  versioning that occurs.

See Also:

DataOutput, ObjectInputStream, Serializable, Externalizable

______________________________________________________________________________

 	ObjectOutputStream(OutputStream)

 Creates an ObjectOutputStream that writes to the specified OutputStream.

 	annotateClass(Class)

 Subclasses may implement this method to allow class data to be stored  in the stream.

 	close()

 Closes the stream.

 	defaultWriteObject()

 Write the non-static and non-transient fields of the current class  to this stream.

 	drain()

 Drain any buffered data in ObjectOutputStream.

 	enableReplaceObject(boolean)

 Enable the stream to do replacement of objects in the stream.

 	flush()

 Flushes the stream.

 	replaceObject(Object)

 This method will allow trusted subclasses of ObjectOutputStream  to substitute one object for another during  serialization.

 	reset()

 Reset will disregard the state of any objects already written  to the stream.

 	write(byte[])

 Writes an array of bytes.

 	write(byte[], int, int)

 Writes a sub array of bytes.

 	write(int)

 Writes a byte.

 	writeBoolean(boolean)

 Writes a boolean.

 	writeByte(int)

 Writes an 8 bit byte.

 	writeBytes(String)

 Writes a String as a sequence of bytes.

 	writeChar(int)

 Writes a 16 bit char.

 	writeChars(String)

 Writes a String as a sequence of chars.

 	writeDouble(double)

 Writes a 64 bit double.

 	writeFloat(float)

 Writes a 32 bit float.

 	writeInt(int)

 Writes a 32 bit int.

 	writeLong(long)

 Writes a 64 bit long.

 	writeObject(Object)

 Write the specified object to the ObjectOutputStream.

 	writeShort(int)

 Writes a 16 bit short.

 	writeStreamHeader()

 The writeStreamHeader method is provided so subclasses can  append or prepend their own header to the stream.

 	writeUTF(String)

 Writes a String in UTF format.

 ObjectOutputStream

  public ObjectOutputStream(OutputStream out) throws IOException

 Creates an ObjectOutputStream that writes to the specified OutputStream.  The stream header is written to the stream. The caller may want to call  flush immediately so that the corresponding ObjectInputStream can read  the header immediately.

Throws: IOException

 Any exception thrown by the underlying OutputStream.

 writeObject

  public final void writeObject(Object obj) throws IOException

 Write the specified object to the ObjectOutputStream.  The class of the object, the signature of the class, and the values  of the non-transient and non-static fields of the class and all  of its supertypes are written. Default serialization for a class can be  overridden using the writeObject and the readObject methods.  Objects referenced by this object are written transitively so  that a complete equivalent graph of objects can be  reconstructed by an ObjectInputStream.

 Exceptions are thrown for  problems with the OutputStream and for classes that should not be  serialized. All exceptions are fatal to the OutputStream, which  is left in an indeterminate state, and it is up to the caller  to ignore or recover the stream state.

Throws: InvalidClassException

 Something is wrong with a class used by 	serialization.

Throws: NotSerializableException

 Some object to be serialized does not 	implement the java.io.Serializable interface.

Throws: IOException

 Any exception thrown by the underlying OutputStream.

 defaultWriteObject

  public final void defaultWriteObject() throws IOException

 Write the non-static and non-transient fields of the current class  to this stream. This may only be called from the writeObject method  of the class being serialized. It will throw the NotActiveException  if it is called otherwise.

 reset

  public void reset() throws IOException

 Reset will disregard the state of any objects already written  to the stream. The state is reset to be the same as a new  ObjectOutputStream. The current point in the stream is marked  as reset so the corresponding ObjectInputStream will be reset  at the same point. Objects previously written to the stream  will not be refered to as already being in the stream. They  will be written to the stream again.

 annotateClass

  protected void annotateClass(Class cl) throws IOException

 Subclasses may implement this method to allow class data to be stored  in the stream. By default this method does nothing.  The corresponding method in ObjectInputStream is resolveClass.  This method is called exactly once for each unique class in the stream.  The class name and signature will have already been written to the stream.  This method may make free use of the ObjectOutputStream to save  any representation of the class it deems suitable (for example,  the bytes of the class file). The resolveClass method in the corresponding  subclass of ObjectInputStream must read and use any data or objects  written by annotateClass.  annotateClass is called only for normal classes. Arrays are not normal classes.

Throws: IOException

 Any exception thrown by the underlying OutputStream.

 replaceObject

  protected Object replaceObject(Object obj) throws IOException

 This method will allow trusted subclasses of ObjectOutputStream  to substitute one object for another during  serialization. Replacing objects is disabled until  enableReplaceObject is called. The enableReplaceObject method  checks that the stream requesting to do replacment can be  trusted. Every reference to serializable objects is passed to  replaceObject. To insure that the private state of objects is  not unintentionally exposed only trusted streams may use  replaceObject.

 When a subclass is replacing objects it must insure that either  a complementary substitution must be made during  deserialization or that the substituted object is compatible  with every field where the reference will be stored. Objects  whose type is not a subclass of the type of the field or array  element abort the serialization by raising an exception and the  object is not be stored.

 This method is called only once when each object is first encountered.  All subsequent references to the object will be redirected to the  new object. This method should return the object to be substituted or  the original object.

 Null can be returned as the object to be substituted, but may  cause NullReferenceException in classes that contain references  to the original object since they may be expecting an object  instead of null.

Throws: IOException

 Any exception thrown by the underlying  OutputStream.

 enableReplaceObject

  protected final boolean enableReplaceObject(boolean enable) throws SecurityException

 Enable the stream to do replacement of objects in the stream.  If the stream is a trusted class it is allowed to enable replacement.  Trusted classes are those classes with a classLoader equals null.

 When enabled the replaceObject method is called for every object  being serialized.

Throws: SecurityException

 The classloader of this stream object is non-null.

 writeStreamHeader

  protected void writeStreamHeader() throws IOException

 The writeStreamHeader method is provided so subclasses can  append or prepend their own header to the stream.  It writes the magic number and version to the stream.

 write

  public void write(int data) throws IOException

 Writes a byte. This method will block until the byte is actually  written.

Parameters:

 b - the byte

Throws: IOException

 If an I/O error has occurred.

Overrides:

write in class OutputStream

 write

  public void write(byte b[]) throws IOException

 Writes an array of bytes. This method will block until the bytes  are actually written.

Parameters:

 b - the data to be written

Throws: IOException

 If an I/O error has occurred.

Overrides:

write in class OutputStream

 write

  public void write(byte b[],
                    int off,
                    int len) throws IOException

 Writes a sub array of bytes.

Parameters:

 b - the data to be written

 off - the start offset in the data

 len - the number of bytes that are written

Throws: IOException

 If an I/O error has occurred.

Overrides:

write in class OutputStream

 flush

  public void flush() throws IOException

 Flushes the stream. This will write any buffered  output bytes and flush through to the underlying stream.

Throws: IOException

 If an I/O error has occurred.

Overrides:

flush in class OutputStream

 drain

  protected void drain() throws IOException

 Drain any buffered data in ObjectOutputStream. Similar to flush  but does not propagate the flush to the underlaying stream.

 close

  public void close() throws IOException

 Closes the stream. This method must be called  to release any resources associated with the  stream.

Throws: IOException

 If an I/O error has occurred.

Overrides:

close in class OutputStream

 writeBoolean

  public void writeBoolean(boolean data) throws IOException

 Writes a boolean.

Parameters:

 v - the boolean to be written

 writeByte

  public void writeByte(int data) throws IOException

 Writes an 8 bit byte.

Parameters:

 v - the byte value to be written

 writeShort

  public void writeShort(int data) throws IOException

 Writes a 16 bit short.

Parameters:

 v - the short value to be written

 writeChar

  public void writeChar(int data) throws IOException

 Writes a 16 bit char.

Parameters:

 v - the char value to be written

 writeInt

  public void writeInt(int data) throws IOException

 Writes a 32 bit int.

Parameters:

 v - the integer value to be written

 writeLong

  public void writeLong(long data) throws IOException

 Writes a 64 bit long.

Parameters:

 v - the long value to be written

 writeFloat

  public void writeFloat(float data) throws IOException

 Writes a 32 bit float.

Parameters:

 v - the float value to be written

 writeDouble

  public void writeDouble(double data) throws IOException

 Writes a 64 bit double.

Parameters:

 v - the double value to be written

 writeBytes

  public void writeBytes(String data) throws IOException

 Writes a String as a sequence of bytes.

Parameters:

 s - the String of bytes to be written

 writeChars

  public void writeChars(String data) throws IOException

 Writes a String as a sequence of chars.

Parameters:

 s - the String of chars to be written

 writeUTF

  public void writeUTF(String data) throws IOException

 Writes a String in UTF format.

Parameters:

 str - the String in UTF format

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.ObjectStreamClass

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.ObjectStreamClass

java.lang.Object
   |
   +----java.io.ObjectStreamClass

______________________________________________________________________________

 public class ObjectStreamClass

 extends Object

 implements Serializable

A ObjectStreamClass describes a class that can be serialized to a stream  or a class that was serialized to a stream. It contains the name  and the serialVersionUID of the class.
 The ObjectStreamClass for a specific class loaded in this Java VM can  be found using the lookup method.

______________________________________________________________________________

 	forClass()

 Return the class in the local VM that this version is mapped to.

 	getName()

 The name of the class described by this descriptor.

 	getSerialVersionUID()

 Return the serialVersionUID for this class.

 	lookup(Class)

 Find the descriptor for a class that can be serialized.

 	toString()

 Return a string describing this ObjectStreamClass.

 lookup

  public static ObjectStreamClass lookup(Class cl)

 Find the descriptor for a class that can be serialized. Null  is returned if the specified class does not implement  java.io.Serializable or java.io.Externalizable.

 getName

  public String getName()

 The name of the class described by this descriptor.

 getSerialVersionUID

  public long getSerialVersionUID()

 Return the serialVersionUID for this class.  The serialVersionUID defines a set of classes all with the same name  that have evolved from a common root class and agree to be serialized  and deserialized using a common format.

 forClass

  public Class forClass()

 Return the class in the local VM that this version is mapped to.  Null is returned if there is no corresponding local class.

 toString

  public String toString()

 Return a string describing this ObjectStreamClass.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.ObjectStreamException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.ObjectStreamException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.io.ObjectStreamException

______________________________________________________________________________

 public class ObjectStreamException

 extends IOException

Superclass of all exceptions specific to Object Stream classes.

______________________________________________________________________________

 	ObjectStreamException()

 Create an ObjectStreamException.

 	ObjectStreamException(String)

 Create an ObjectStreamException with the specified argument.

 ObjectStreamException

  protected ObjectStreamException(String classname)

 Create an ObjectStreamException with the specified argument.

 ObjectStreamException

  protected ObjectStreamException()

 Create an ObjectStreamException.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.OptionalDataException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.OptionalDataException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.io.ObjectStreamException
                                   |
                                   +----java.io.OptionalDataException

______________________________________________________________________________

 public class OptionalDataException

 extends ObjectStreamException

This exception is thrown if readObject has optional data.  Either the eof flag will be true  or the length will be the number of bytes available to read.

______________________________________________________________________________

 	eof

 True if there is not more data in the buffered part of the stream.

 	length

 The number of bytes available to be read in the current buffer.

 length

  public int length

 The number of bytes available to be read in the current buffer.

 eof

  public boolean eof

 True if there is not more data in the buffered part of the stream.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.OutputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.OutputStream

java.lang.Object
   |
   +----java.io.OutputStream

______________________________________________________________________________

 public class OutputStream

 extends Object

This abstract class is the superclass of all classes representing  an output stream of bytes.

 Applications that need to define a subclass of  OutputStream  must always provide at least a method  that writes one byte of output.

See Also:

BufferedOutputStream, ByteArrayOutputStream, DataOutputStream, FilterOutputStream, InputStream, write

______________________________________________________________________________

 	OutputStream()

 	close()

 Closes this output stream and releases any system resources  associated with this stream.

 	flush()

 Flushes this output stream and forces any buffered output bytes  to be written out.

 	write(byte[])

 Writes b.length bytes from the specified byte array  to this output stream.

 	write(byte[], int, int)

 Writes len bytes from the specified byte array  starting at offset off  to this output stream.

 	write(int)

 Writes the specified byte to this output stream.

 OutputStream

  public OutputStream()

 write

  public abstract void write(int b) throws IOException

 Writes the specified byte to this output stream.

 Subclasses of OutputStream must provide an  implementation for this method.

Parameters:

 b - the byte.

Throws: IOException

 if an I/O error occurs.

 write

  public void write(byte b[]) throws IOException

 Writes b.length bytes from the specified byte array  to this output stream.

 The write method of OutputStream calls  the write  method of three arguments with the three  arguments b, 0, and  b.length.

Parameters:

 b - the data.

Throws: IOException

 if an I/O error occurs.

See Also:

write

 write

  public void write(byte b[],
                    int off,
                    int len) throws IOException

 Writes len bytes from the specified byte array  starting at offset off to this output stream.

 The write method of OutputStream calls  the write method of one argument on each of the bytes to be  written out. Subclasses are encouraged to override this method and  provide a more efficient implementation.

Parameters:

 b - the data.

 off - the start offset in the data.

 len - the number of bytes to write.

Throws: IOException

 if an I/O error occurs.

 flush

  public void flush() throws IOException

 Flushes this output stream and forces any buffered output bytes  to be written out.

 The flush method of OutputStream does nothing.

Throws: IOException

 if an I/O error occurs.

 close

  public void close() throws IOException

 Closes this output stream and releases any system resources  associated with this stream.

 The close method of OutputStream does nothing.

Throws: IOException

 if an I/O error occurs.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.OutputStreamWriter

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.OutputStreamWriter

java.lang.Object
   |
   +----java.io.Writer
           |
           +----java.io.OutputStreamWriter

______________________________________________________________________________

 public class OutputStreamWriter

 extends Writer

Write characters to an output stream, translating characters into bytes  according to a specified character encoding. Each OutputStreamWriter  incorporates its own CharToByteConverter, and is thus a bridge from  character streams to byte streams.

 The encoding used by an OutputStreamWriter may be specified by name, by  providing a CharToByteConverter, or by accepting the default encoding, which  is defined by the system property file.encoding.

 Each invocation of a write() method causes the encoding converter to be  invoked on the given character(s). The resulting bytes are accumulated in a  buffer before being written to the underlying output stream. The size of  this buffer may be specified, but by default it is large enough for most  purposes. Note that the characters passed to the write() methods are not  buffered. For top efficiency, consider wrapping an OutputStreamWriter  within a BufferedWriter so as to avoid frequent converter invocations. For  example,

 Writer out
   = new BufferedWriter(new OutputStreamWriter(System.out));

See Also:

BufferedWriter, OutputStream

______________________________________________________________________________

 	OutputStreamWriter(OutputStream)

 Create an OutputStreamWriter that uses the default character encoding.

 	OutputStreamWriter(OutputStream, String)

 Create an OutputStreamWriter that uses the named character encoding.

 	close()

 Close the stream.

 	flush()

 Flush the stream.

 	getEncoding()

 Return the name of the encoding being used by this stream.

 	write(char[], int, int)

 Write a portion of an array of characters.

 	write(int)

 Write a single character.

 	write(String, int, int)

 Write a portion of a string.

 OutputStreamWriter

  public OutputStreamWriter(OutputStream out,
                            String enc) throws UnsupportedEncodingException

 Create an OutputStreamWriter that uses the named character encoding.

Parameters:

 out - An OutputStream

 enc - Name of the encoding to be used

Throws: UnsupportedEncodingException

 If the named encoding is not supported

 OutputStreamWriter

  public OutputStreamWriter(OutputStream out)

 Create an OutputStreamWriter that uses the default character encoding.

Parameters:

 out - An OutputStream

 getEncoding

  public String getEncoding()

 Return the name of the encoding being used by this stream. May return  null if the stream has been closed.

 write

  public void write(int c) throws IOException

 Write a single character.

Throws: IOException

 If an I/O error occurs

Overrides:

write in class Writer

 write

  public void write(char cbuf[],
                    int off,
                    int len) throws IOException

 Write a portion of an array of characters.

Parameters:

 cbuf - Buffer of characters

 off - Offset from which to start writing characters

 len - Number of characters to write

Throws: IOException

 If an I/O error occurs

Overrides:

write in class Writer

 write

  public void write(String str,
                    int off,
                    int len) throws IOException

 Write a portion of a string.

Parameters:

 str - A String

 off - Offset from which to start writing characters

 len - Number of characters to write

Throws: IOException

 If an I/O error occurs

Overrides:

write in class Writer

 flush

  public void flush() throws IOException

 Flush the stream.

Throws: IOException

 If an I/O error occurs

Overrides:

flush in class Writer

 close

  public void close() throws IOException

 Close the stream.

Throws: IOException

 If an I/O error occurs

Overrides:

close in class Writer

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.PipedInputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.PipedInputStream

java.lang.Object
   |
   +----java.io.InputStream
           |
           +----java.io.PipedInputStream

______________________________________________________________________________

 public class PipedInputStream

 extends InputStream

A piped input stream is the receiving end of a communications  pipe. Two threads can communicate by having one thread send data  through a piped output stream and having the other thread read the  data through a piped input stream.

See Also:

PipedOutputStream

______________________________________________________________________________

 	buffer

 The circular buffer into which incoming data is placed.

 	in

  	out

  	PIPE_SIZE

 	PipedInputStream()

 Creates a piped input stream that is not yet connected to a piped  output stream.

 	PipedInputStream(PipedOutputStream)

 Creates a piped input stream connected to the specified piped  output stream.

 	available()

 Returns the number of bytes that can be read from this input  stream without blocking.

 	close()

 Closes this piped input stream and releases any system resources  associated with the stream.

 	connect(PipedOutputStream)

 Connects this piped input stream to a sender.

 	read()

 Reads the next byte of data from this piped input stream.

 	read(byte[], int, int)

 Reads up to len bytes of data from this piped input  stream into an array of bytes.

 	receive(int)

 Receives a byte of data.

 PIPE_SIZE

  protected final static int PIPE_SIZE

 buffer

  protected byte buffer[]

 The circular buffer into which incoming data is placed.

 in

  protected int in

 out

  protected int out

 PipedInputStream

  public PipedInputStream(PipedOutputStream src) throws IOException

 Creates a piped input stream connected to the specified piped  output stream.

Parameters:

 src - the stream to connect to.

Throws: IOException

 if an I/O error occurs.

 PipedInputStream

  public PipedInputStream()

 Creates a piped input stream that is not yet connected to a piped  output stream. It must be connected to a piped output stream,  either by the receiver or the sender, before being used.

See Also:

connect, connect

 connect

  public void connect(PipedOutputStream src) throws IOException

 Connects this piped input stream to a sender.

Parameters:

 src - The piped output stream to connect to.

Throws: IOException

 if an I/O error occurs.

 receive

  protected synchronized void receive(int b) throws IOException

 Receives a byte of data. This method will block if no input is  available.

Parameters:

 b - the byte being received

Throws: IOException

 If the pipe is broken.

 read

  public synchronized int read() throws IOException

 Reads the next byte of data from this piped input stream. The  value byte is returned as an int in the range  0 to 255 . If no byte is available  because this end of the stream has been reached, the value  -1 is returned. This method blocks until input data  is available, the end of the stream is detected, or an exception  is thrown.

Returns:

 the next byte of data, or -1 if the end of the  stream is reached.

Throws: IOException

 if the pipe is broken.

Overrides:

read in class InputStream

 read

  public synchronized int read(byte b[],
                               int off,
                               int len) throws IOException

 Reads up to len bytes of data from this piped input  stream into an array of bytes. This method blocks until at least one  byte of input is available.

Parameters:

 b - the buffer into which the data is read.

 off - the start offset of the data.

 len - the maximum number of bytes read.

Returns:

 the total number of bytes read into the buffer, or  -1  if there is no more data because the end of  the stream has been reached.

Throws: IOException

 if an I/O error occurs.

Overrides:

read in class InputStream

 available

  public synchronized int available() throws IOException

 Returns the number of bytes that can be read from this input  stream without blocking. This method overrides the available  method of the parent class.

Returns:

 the number of bytes that can be read from this input stream  without blocking.

Throws: IOException

 if an I/O error occurs.

Overrides:

available in class InputStream

 close

  public void close() throws IOException

 Closes this piped input stream and releases any system resources  associated with the stream.

Throws: IOException

 if an I/O error occurs.

Overrides:

close in class InputStream

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.PipedOutputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.PipedOutputStream

java.lang.Object
   |
   +----java.io.OutputStream
           |
           +----java.io.PipedOutputStream

______________________________________________________________________________

 public class PipedOutputStream

 extends OutputStream

A piped output stream is the sending end of a communications  pipe. Two threads can communicate by having one thread send data  through a piped output stream and having the other thread read the  data through a piped input stream.

See Also:

PipedInputStream

______________________________________________________________________________

 	PipedOutputStream()

 Creates a piped output stream that is not yet connected to a  piped input stream.

 	PipedOutputStream(PipedInputStream)

 Creates a piped output stream connected to the specified piped  input stream.

 	close()

 Closes this piped output stream and releases any system resources  associated with this stream.

 	connect(PipedInputStream)

 Connects this piped output stream to a receiver.

 	flush()

 Flushes this output stream and forces any buffered output bytes  to be written out.

 	write(byte[], int, int)

 Writes len bytes from the specified byte array  starting at offset off  to this piped output stream.

 	write(int)

 Writes the specified byte to the piped output stream.

 PipedOutputStream

  public PipedOutputStream(PipedInputStream snk) throws IOException

 Creates a piped output stream connected to the specified piped  input stream.

Parameters:

 snk - The piped input stream to connect to.

Throws: IOException

 if an I/O error occurs.

 PipedOutputStream

  public PipedOutputStream()

 Creates a piped output stream that is not yet connected to a  piped input stream. It must be connected to a piped input stream,  either by the receiver or the sender, before being used.

See Also:

connect, connect

 connect

  public void connect(PipedInputStream snk) throws IOException

 Connects this piped output stream to a receiver.

Parameters:

 snk - the piped output stream to connect to.

Throws: IOException

 if an I/O error occurs.

 write

  public void write(int b) throws IOException

 Writes the specified byte to the piped output stream.

Parameters:

 b - the byte to be written.

Throws: IOException

 if an I/O error occurs.

Overrides:

write in class OutputStream

 write

  public void write(byte b[],
                    int off,
                    int len) throws IOException

 Writes len bytes from the specified byte array  starting at offset off to this piped output stream.

Parameters:

 b - the data.

 off - the start offset in the data.

 len - the number of bytes to write.

Throws: IOException

 if an I/O error occurs.

Overrides:

write in class OutputStream

 flush

  public synchronized void flush() throws IOException

 Flushes this output stream and forces any buffered output bytes  to be written out.  This will notify any readers that bytes are waiting in the pipe.

Throws: IOException

 if an I/O error occurs.

Overrides:

flush in class OutputStream

 close

  public void close() throws IOException

 Closes this piped output stream and releases any system resources  associated with this stream.

Throws: IOException

 if an I/O error occurs.

Overrides:

close in class OutputStream

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.PipedReader

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.PipedReader

java.lang.Object
   |
   +----java.io.Reader
           |
           +----java.io.PipedReader

______________________________________________________________________________

 public class PipedReader

 extends Reader

Piped character-input streams.

______________________________________________________________________________

 	PipedReader()

 Create a reader that is not yet connected to a piped writer.

 	PipedReader(PipedWriter)

 Create a reader for the specified piped character-output stream.

 	close()

 Close the stream.

 	connect(PipedWriter)

 Connect the specified piped writer to this reader.

 	read(char[], int, int)

 Read characters into a portion of an array.

 PipedReader

  public PipedReader()

 Create a reader that is not yet connected to a piped writer.

 PipedReader

  public PipedReader(PipedWriter src) throws IOException

 Create a reader for the specified piped character-output stream.

 connect

  public void connect(PipedWriter src) throws IOException

 Connect the specified piped writer to this reader.

Throws: IOException

 If this reader is already connected

 read

  public int read(char cbuf[],
                  int off,
                  int len) throws IOException

 Read characters into a portion of an array.

Parameters:

 cbuf - Destination buffer

 off - Offset at which to start storing characters

 len - Maximum number of characters to read

Returns:

 The number of characters read, or -1 if the end of the  stream has been reached

Throws: IOException

 If an I/O error occurs

Overrides:

read in class Reader

 close

  public void close() throws IOException

 Close the stream.

Throws: IOException

 If an I/O error occurs

Overrides:

close in class Reader

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.PipedWriter

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.PipedWriter

java.lang.Object
   |
   +----java.io.Writer
           |
           +----java.io.PipedWriter

______________________________________________________________________________

 public class PipedWriter

 extends Writer

Piped character-output streams.

______________________________________________________________________________

 	PipedWriter()

 Create a writer that is not yet connected to a piped reader.

 	PipedWriter(PipedReader)

 Create a writer for the specified piped character-input stream.

 	close()

 Close the stream.

 	connect(PipedReader)

 Connect the specified piped reader to this writer.

 	flush()

 Flush the stream.

 	write(char[], int, int)

 Write a portion of an array of characters.

 PipedWriter

  public PipedWriter()

 Create a writer that is not yet connected to a piped reader.

 PipedWriter

  public PipedWriter(PipedReader sink) throws IOException

 Create a writer for the specified piped character-input stream.

 connect

  public void connect(PipedReader sink) throws IOException

 Connect the specified piped reader to this writer.

 write

  public void write(char cbuf[],
                    int off,
                    int len) throws IOException

 Write a portion of an array of characters.

Parameters:

 cbuf - Array of characters

 off - Offset from which to start writing characters

 len - Number of characters to write

Throws: IOException

 If an I/O error occurs

Overrides:

write in class Writer

 flush

  public void flush() throws IOException

 Flush the stream.

Throws: IOException

 If an I/O error occurs

Overrides:

flush in class Writer

 close

  public void close() throws IOException

 Close the stream.

Throws: IOException

 If an I/O error occurs

Overrides:

close in class Writer

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.PrintStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.PrintStream

java.lang.Object
   |
   +----java.io.OutputStream
           |
           +----java.io.FilterOutputStream
                   |
                   +----java.io.PrintStream

______________________________________________________________________________

 public class PrintStream

 extends FilterOutputStream

A print stream implements an output stream filter that provides  convenient methods for printing types other than bytes and arrays of bytes.

 In addition, the print stream overrides many of the  InputStream  methods so as not to throw an  IOException. Instead, an I/O exception causes an  internal flag to be set, which the application can check by a call  to the checkError  method.

 Only the lower eight bits of any 16-bit quantity are printed to the stream.

 An application can specify at creation time whether a print  stream should be flushed every time a newline character is written.

 Here are some examples of the use of a print stream:

     System.out.println("Hello world!");
     System.out.print("x = ");
     System.out.println(x);
     System.out.println("y = " + y);

Note: This class is provided primarily for use in debugging,  and for compatibility with existing code.  New code should use the PrintWriter class.

See Also:

checkError, PrintWriter

______________________________________________________________________________

 	PrintStream(OutputStream)

 Constructs a new print stream that writes its output to the  specified underlying output stream. Deprecated.

 	PrintStream(OutputStream, boolean)

 Constructs a new print stream that writes its output to the  specified underlying output stream. Deprecated.

 	checkError()

 Flushes this print stream's underlying output stream, and tests  if there has been an error on the underlying output stream.

 	close()

 Closes this print stream and releases any resources associated  with the underlying output stream.

 	flush()

 Flushes this print stream.

 	print(boolean)

 Prints the string "true" to the underlying output  stream if the value of the boolean argument is  true; otherwise, prints the string  "false"  to the underlying output stream.

 	print(char)

 Prints the low eight bits of the character argument to this print  stream's underlying output stream.

 	print(char[])

 Prints the low eight bits of each of the characters in the character  array to this print stream's underlying output stream.

 	print(double)

 Prints the string representation of the double to  this print stream's underlying output stream.

 	print(float)

 Prints the string representation of the float to  this print stream's underlying output stream.

 	print(int)

 Prints the string representation of the int to this  print stream's underlying output stream.

 	print(long)

 Prints the string representation of the long to this  print stream's underlying output stream.

 	print(Object)

 Prints the string representation of the Object to  this print stream's underlying output stream.

 	print(String)

 If the string argument is null, the string  "null"  is printed to this print stream's underlying  output stream.

 	println()

 Prints a newline character to this print stream's underlying  output stream.

 	println(boolean)

 Prints the string "true" followed by a newline  character to this print stream's underlying output stream if the  value of the boolean  argument is true;  otherwise prints the string "false" followed by a  newline character to the underlying output stream.

 	println(char)

 Prints the low eight bits of the character argument followed by a  newline character to this print stream's underlying output stream.

 	println(char[])

 Prints the low eight bits of each of the characters in the character  array, followed by a newline character, to this print stream's  underlying output stream.

 	println(double)

 Prints the string representation of the double  followed by a newline to this print stream's underlying output  stream.

 	println(float)

 Prints the string representation of the float  followed by a newline to this print stream's underlying output  stream.

 	println(int)

 Prints the string representation of the int followed  by a newline to this print stream's underlying output stream.

 	println(long)

 Prints the string representation of the long  followed by a newline to this print stream's underlying output  stream.

 	println(Object)

 Prints the string representation of the Object  followed by a newline to this print stream's underlying output  stream.

 	println(String)

 If the string argument is null, the string  "null"  followed by a newline character is printed to  this print stream's underlying output stream.

 	setError()

 Indicates that an error has occurred.

 	write(byte[], int, int)

 Writes a portion of the specified byte array, blocking if necessary.

 	write(int)

 Writes the specified byte to this print stream.

 PrintStream

  public PrintStream(OutputStream out)

 Note: PrintStream() is deprecated. As of JDK 1.1, the preferred way to print text is  using the PrintWriter  class. Consider replacing  code of the form:

  PrintStream p = new PrintStream(out);

 with code of the form:

  PrintWriter p = new PrintWriter(out);

 Constructs a new print stream that writes its output to the  specified underlying output stream.

Parameters:

 out - the underlying output stream.

See Also:

out, PrintWriter

 PrintStream

  public PrintStream(OutputStream out,
                     boolean autoFlush)

 Note: PrintStream() is deprecated. As of JDK 1.1, the preferred way to print text is  using the PrintWriter  class. Consider replacing  code of the form:

  PrintStream p = new PrintStream(out, autoFlush);

 with code of the form:

  PrintWriter p = new PrintWriter(out, autoFlush);

 Constructs a new print stream that writes its output to the  specified underlying output stream. In addition, if the  autoflush flag is true, then the  underlying output stream's flush method is called any  time a newline character is printed.

Parameters:

 out - the underlying output stream.

 autoflush - if true, the stream automatically  flushes its output when a newline character is  printed.

See Also:

out, PrintWriter

 flush

  public void flush()

 Flushes this print stream. This forces any buffered output bytes  to be written to the underlying stream.

 The flush method of PrintStream calls  the flush  method of its underlying output stream.  However, if that flush method throws an  IOException, this method catches that exception and  indicates, instead, that the underlying stream has gotten an error

Overrides:

flush in class FilterOutputStream

See Also:

out, flush, checkError

 close

  public void close()

 Closes this print stream and releases any resources associated  with the underlying output stream.

 The close method of PrintStream calls the  close  method of its underlying output stream.  However, if that close method throws an  IOException, this method catches that exception and  indicates, instead, that the underlying stream has gotten an error,

Overrides:

close in class FilterOutputStream

See Also:

out, close, checkError

 checkError

  public boolean checkError()

 Flushes this print stream's underlying output stream, and tests  if there has been an error on the underlying output stream.

 Errors are cumulative; once the print stream has encounted an  error, this method will continue to return true on  all successive calls.

Returns:

true if the print stream has ever encountered an  error on the output stream or during a format conversion;  false otherwise.

 setError

  protected void setError()

 Indicates that an error has occurred.

 write

  public void write(int b)

 Writes the specified byte to this print stream.

 The write method of PrintStream calls  the write  method of its underlying stream. In  addition, if the character is a newline character and autoflush is  turned on, then the print stream's flush method is called.

 If any IOException is thrown while writing the byte,  the exception is caught, and instead an internal error flag is  set; the value of the flag can be checked by a call to the  checkError method.

 Note that the byte is written as given. To write a character that  will be translated according to the platform's default character  encoding, use the print or println methods.

Parameters:

 b - the byte.

Overrides:

write in class FilterOutputStream

See Also:

print, println

 write

  public void write(byte buf[],
                    int off,
                    int len)

 Writes a portion of the specified byte array, blocking if necessary.  Writes len bytes from the specified byte array  starting at offset off  to this print stream's  underlying output stream.

Parameters:

 buf - the data.

 off - the start offset in the data.

 len - the number of bytes to write.

Overrides:

write in class FilterOutputStream

See Also:

out

 print

  public void print(boolean b)

 Prints the string "true" to the underlying output  stream if the value of the boolean argument is  true ; otherwise, prints the string  "false" to the underlying output stream.

Parameters:

 b - a boolean to be printed.

See Also:

out

 print

  public void print(char c)

 Prints the low eight bits of the character argument to this print  stream's underlying output stream.

Parameters:

 c - a char to be printed.

See Also:

out

 print

  public void print(int i)

 Prints the string representation of the int to this  print stream's underlying output stream. The string representation  is identical to the one returned by the toString  method of class Integer  with the argument  i.

Parameters:

 i - an int to be printed.

See Also:

out, toString

 print

  public void print(long l)

 Prints the string representation of the long to this  print stream's underlying output stream. The string representation  is identical to the one returned by the toString  method of class Long  with the argument  l.

Parameters:

 l - a long to be printed.

See Also:

out, toString

 print

  public void print(float f)

 Prints the string representation of the float to  this print stream's underlying output stream. The string  representation is identical to the one returned by the  toString method of class Float with the  argument f.

Parameters:

 f - a float to be printed.

See Also:

out, toString

 print

  public void print(double d)

 Prints the string representation of the double to  this print stream's underlying output stream. The string  representation is identical to the one returned by the  toString method of class Double with the  argument d.

Parameters:

 d - a double to be printed.

See Also:

out, toString

 print

  public void print(char s[])

 Prints the low eight bits of each of the characters in the character  array to this print stream's underlying output stream.

Parameters:

 s - an array of chars to be printed.

See Also:

out

 print

  public void print(String s)

 If the string argument is null, the string  "null" is printed to this print stream's underlying  output stream. Otherwise, the low eight bits of each of the characters  in the string is printed to the underlying output stream.

Parameters:

 s - a string to be printed.

See Also:

out

 print

  public void print(Object obj)

 Prints the string representation of the Object to  this print stream's underlying output stream. The string  representation is identical to the one returned by calling the  Object argument's toString method.

Parameters:

 obj - an Object to be printed.

See Also:

out, toString

 println

  public void println()

 Prints a newline character to this print stream's underlying  output stream.  The line-separator string is defined by the system property  line.separator, and is not necessarily a single newline  ('\n') character.

See Also:

out

 println

  public void println(boolean x)

 Prints the string "true" followed by a newline  character to this print stream's underlying output stream if the  value of the boolean  argument is true;  otherwise prints the string "false" followed by a  newline character to the underlying output stream.

Parameters:

 x - a boolean to be printed.

See Also:

out, print

 println

  public void println(char x)

 Prints the low eight bits of the character argument followed by a  newline character to this print stream's underlying output stream.

Parameters:

 x - a char to be printed.

See Also:

out, print

 println

  public void println(int x)

 Prints the string representation of the int followed  by a newline to this print stream's underlying output stream. The  string representation is identical to the one returned by the  toString  method of class Integer with  the argument i.

Parameters:

 x - an int to be printed.

See Also:

out, print, toString

 println

  public void println(long x)

 Prints the string representation of the long  followed by a newline to this print stream's underlying output  stream. The string representation is identical to the one returned  by the toString  method of class Long  with the argument l.

Parameters:

 x - a long to be printed.

See Also:

out, print, toString

 println

  public void println(float x)

 Prints the string representation of the float  followed by a newline to this print stream's underlying output  stream. The string representation is identical to the one returned  by the toString  method of class Integer  with the argument f.

Parameters:

 x - a float to be printed.

See Also:

out, print, toString

 println

  public void println(double x)

 Prints the string representation of the double  followed by a newline to this print stream's underlying output  stream. The string representation is identical to the one returned  by the toString  method of class Double  with the argument d.

Parameters:

 x - a double to be printed.

See Also:

out, print, toString

 println

  public void println(char x[])

 Prints the low eight bits of each of the characters in the character  array, followed by a newline character, to this print stream's  underlying output stream.

Parameters:

 x - an array of characters to be printed.

See Also:

out, print

 println

  public void println(String x)

 If the string argument is null, the string  "null" followed by a newline character is printed to  this print stream's underlying output stream. Otherwise, the low 8  bits of each of the characters in the string, followed by a  newline character, is printed to the underlying output stream.

Parameters:

 x - a string to be printed.

See Also:

out, print

 println

  public void println(Object x)

 Prints the string representation of the Object  followed by a newline to this print stream's underlying output  stream. The string representation is identical to the one returned  by calling the Object argument's  toString method.

Parameters:

 x - an Object to be printed.

See Also:

out, print, toString

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.PrintWriter

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.PrintWriter

java.lang.Object
   |
   +----java.io.Writer
           |
           +----java.io.PrintWriter

______________________________________________________________________________

 public class PrintWriter

 extends Writer

Print formatted representations of objects to a text-output stream. This  class implements all of the print methods found in PrintStream. It does not  contain methods for writing raw bytes, for which a program should use  unencoded byte streams.

 Unlike the PrintStream class, if automatic flushing is enabled it will  be done only when one of the println() methods is invoked, rather than  whenever a newline character happens to be output. The println() methods  use the platform's own notion of line separator rather than the newline  character.

 Methods in this class never throw I/O exceptions. The client may  inquire as to whether any errors have occurred by invoking checkError().

______________________________________________________________________________

 	PrintWriter(OutputStream)

 Create a new PrintWriter, without automatic line flushing, from an  existing OutputStream.

 	PrintWriter(OutputStream, boolean)

 Create a new PrintWriter from an existing OutputStream.

 	PrintWriter(Writer)

 Create a new PrintWriter, without automatic line flushing.

 	PrintWriter(Writer, boolean)

 Create a new PrintWriter.

 	checkError()

 Flush the stream and check its error state.

 	close()

 Close the stream.

 	flush()

 Flush the stream.

 	print(boolean)

 Print a boolean.

 	print(char)

 Print a character.

 	print(char[])

 Print an array of chracters.

 	print(double)

 Print a double.

 	print(float)

 Print a float.

 	print(int)

 Print an integer.

 	print(long)

 Print a long.

 	print(Object)

 Print an object.

 	print(String)

 Print a String.

 	println()

 Finish the line.

 	println(boolean)

 Print a boolean, and then finish the line.

 	println(char)

 Print a character, and then finish the line.

 	println(char[])

 Print an array of characters, and then finish the line.

 	println(double)

 Print a double, and then finish the line.

 	println(float)

 Print a float, and then finish the line.

 	println(int)

 Print an integer, and then finish the line.

 	println(long)

 Print a long, and then finish the line.

 	println(Object)

 Print an Object, and then finish the line.

 	println(String)

 Print a String, and then finish the line.

 	setError()

 Indicate that an error has occurred.

 	write(char[])

 Write an array of characters.

 	write(char[], int, int)

 Write a portion of an array of characters.

 	write(int)

 Write a single character.

 	write(String)

 Write a string.

 	write(String, int, int)

 Write a portion of a string.

 PrintWriter

  public PrintWriter(Writer out)

 Create a new PrintWriter, without automatic line flushing.

Parameters:

 out - A character-output stream

 PrintWriter

  public PrintWriter(Writer out,
                     boolean autoFlush)

 Create a new PrintWriter.

Parameters:

 out - A character-output stream

 autoFlush - A boolean; if true, the println() methods will flush  the output buffer

 PrintWriter

  public PrintWriter(OutputStream out)

 Create a new PrintWriter, without automatic line flushing, from an  existing OutputStream. This convenience constructor creates the  necessary intermediate OutputStreamWriter, which will convert characters  into bytes using the default character encoding.

Parameters:

 out - An output stream

See Also:

OutputStreamWriter

 PrintWriter

  public PrintWriter(OutputStream out,
                     boolean autoFlush)

 Create a new PrintWriter from an existing OutputStream. This  convenience constructor creates the necessary intermediate  OutputStreamWriter, which will convert characters into bytes using the  default character encoding.

Parameters:

 out - An output stream

 autoFlush - A boolean; if true, the println() methods will flush  the output buffer

See Also:

OutputStreamWriter

 flush

  public void flush()

 Flush the stream.

Overrides:

flush in class Writer

 close

  public void close()

 Close the stream.

Overrides:

close in class Writer

 checkError

  public boolean checkError()

 Flush the stream and check its error state. Errors are cumulative;  once the stream encounters an error, this routine will return true on  all successive calls.

Returns:

 True if the print stream has encountered an error, either on the  underlying output stream or during a format conversion.

 setError

  protected void setError()

 Indicate that an error has occurred.

 write

  public void write(int c)

 Write a single character.

Overrides:

write in class Writer

 write

  public void write(char buf[],
                    int off,
                    int len)

 Write a portion of an array of characters.

Overrides:

write in class Writer

 write

  public void write(char buf[])

 Write an array of characters. This method cannot be inherited from the  Writer class because it must suppress I/O exceptions.

Overrides:

write in class Writer

 write

  public void write(String s,
                    int off,
                    int len)

 Write a portion of a string.

Overrides:

write in class Writer

 write

  public void write(String s)

 Write a string. This method cannot be inherited from the Writer class  because it must suppress I/O exceptions.

Overrides:

write in class Writer

 print

  public void print(boolean b)

 Print a boolean.

 print

  public void print(char c)

 Print a character.

 print

  public void print(int i)

 Print an integer.

 print

  public void print(long l)

 Print a long.

 print

  public void print(float f)

 Print a float.

 print

  public void print(double d)

 Print a double.

 print

  public void print(char s[])

 Print an array of chracters.

 print

  public void print(String s)

 Print a String.

 print

  public void print(Object obj)

 Print an object.

 println

  public void println()

 Finish the line.

 println

  public void println(boolean x)

 Print a boolean, and then finish the line.

 println

  public void println(char x)

 Print a character, and then finish the line.

 println

  public void println(int x)

 Print an integer, and then finish the line.

 println

  public void println(long x)

 Print a long, and then finish the line.

 println

  public void println(float x)

 Print a float, and then finish the line.

 println

  public void println(double x)

 Print a double, and then finish the line.

 println

  public void println(char x[])

 Print an array of characters, and then finish the line.

 println

  public void println(String x)

 Print a String, and then finish the line.

 println

  public void println(Object x)

 Print an Object, and then finish the line.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.PushbackInputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.PushbackInputStream

java.lang.Object
   |
   +----java.io.InputStream
           |
           +----java.io.FilterInputStream
                   |
                   +----java.io.PushbackInputStream

______________________________________________________________________________

 public class PushbackInputStream

 extends FilterInputStream

This class is an input stream filter that provides a 1-byte  pushback buffer. This feature allows an application to  "unread" the last character that it read. The next  time that a read is performed on the input stream filter, the  "unread" character is re-read.

 This functionality is useful when a fragment of code should read  an indefinite number of data bytes that are delimited by  particular byte values. After reading the terminating byte, the  code fragment can "unread" it, so that the next read  operation on the input stream will re-read the byte that was pushed back.

______________________________________________________________________________

 	buf

 The push back buffer.

 	pos

 The current position within the buffer.

 	PushbackInputStream(InputStream)

 Constructs a new pushback input stream that reads its input from  the specified input stream.

 	PushbackInputStream(InputStream, int)

 Creates a new input stream with a push back buffer of specified size.

 	available()

 Returns the number of bytes that can be read from this input  stream without blocking.

 	markSupported()

 Tests if the input stream supports the mark and  reset methods.

 	read()

 Reads the next byte of data from this input stream.

 	read(byte[], int, int)

 Reads up to len bytes of data from this input stream  into an array of bytes.

 	unread(byte[])

 Pushes back an array of bytes.

 	unread(byte[], int, int)

 Pushes back an array of bytes.

 	unread(int)

 Pushes back a character so that it is read again by the next call  to the read  method on this input stream.

 buf

  protected byte buf[]

 The push back buffer.

 pos

  protected int pos

 The current position within the buffer.

 PushbackInputStream

  public PushbackInputStream(InputStream in,
                             int size)

 Creates a new input stream with a push back buffer of specified size.

Parameters:

 size - the size of the push back buffer

 PushbackInputStream

  public PushbackInputStream(InputStream in)

 Constructs a new pushback input stream that reads its input from  the specified input stream.

Parameters:

 in - the underlying input stream.

 read

  public int read() throws IOException

 Reads the next byte of data from this input stream. The value  byte is returned as an int in the range  0 to 255 . If no byte is available  because the end of the stream has been reached, the value  -1  is returned. This method blocks until input data  is available, the end of the stream is detected, or an exception  is thrown.

 The read method of PushbackInputStream  returns the just pushed-back character, if there is one, and  otherwise calls the read  method of its underlying  input stream and returns whatever value that method returns.

Returns:

 the next byte of data, or -1 if the end of the  stream is reached.

Throws: IOException

 if an I/O error occurs.

Overrides:

read in class FilterInputStream

See Also:

read

 read

  public int read(byte b[],
                  int off,
                  int len) throws IOException

 Reads up to len bytes of data from this input stream  into an array of bytes. This method blocks until at least 1 byte  of input is available.

Parameters:

 b - the buffer into which the data is read.

 off - the start offset of the data.

 len - the maximum number of bytes read.

Returns:

 the total number of bytes read into the buffer, or  -1  if there is no more data because the end of  the stream has been reached.

Throws: IOException

 if an I/O error occurs.

Overrides:

read in class FilterInputStream

 unread

  public void unread(int b) throws IOException

 Pushes back a character so that it is read again by the next call  to the read method on this input stream.

Parameters:

 b - the character to push back.

Throws: IOException

 if the application attempts to push back a  character before the previously pushed-back character has  been read.

 unread

  public void unread(byte b[],
                     int off,
                     int len) throws IOException

 Pushes back an array of bytes.

Parameters:

 b - the bytes to push back

 off - the start offset of the data

 len - the number of bytes to push back.

Throws: IOException

 If there is not enough room in the push back 	buffer for the specified number of bytes.

 unread

  public void unread(byte b[]) throws IOException

 Pushes back an array of bytes.

Parameters:

 b - the bytes to push back

Throws: IOException

 If there is not enough room in the push back 	buffer for the specified number of bytes.

 available

  public int available() throws IOException

 Returns the number of bytes that can be read from this input  stream without blocking.

 The available method of  PushbackInputStream calls the available  method of its underlying input stream; it returns that value if  there is no character that has been pushed back, or that value  plus 1  if there is a character that has been pushed back.

Returns:

 the number of bytes that can be read from the input stream  without blocking.

Throws: IOException

 if an I/O error occurs.

Overrides:

available in class FilterInputStream

See Also:

in

 markSupported

  public boolean markSupported()

 Tests if the input stream supports the mark and  reset methods. The markSupported method  of PushbackInputStream  always returns false.

Returns:

true if this stream type supports the  mark and reset methods;  false otherwise.

Overrides:

markSupported in class FilterInputStream

See Also:

mark, reset

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.PushbackReader

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.PushbackReader

java.lang.Object
   |
   +----java.io.Reader
           |
           +----java.io.FilterReader
                   |
                   +----java.io.PushbackReader

______________________________________________________________________________

 public class PushbackReader

 extends FilterReader

A character-stream reader that allows characters to be pushed back into the  stream.

______________________________________________________________________________

 	PushbackReader(Reader)

 Create a new pushback reader with a one-character pushback buffer.

 	PushbackReader(Reader, int)

 Create a new pushback reader with a pushback buffer of the given size.

 	close()

 Close the stream.

 	markSupported()

 Tell whether this stream supports the mark() operation, which it does  not.

 	read()

 Read a single character.

 	read(char[], int, int)

 Read characters into a portion of an array.

 	ready()

 Tell whether this stream is ready to be read.

 	unread(char[])

 Push back an entire array of characters.

 	unread(char[], int, int)

 Push back from an array of characters.

 	unread(int)

 Push back a single character.

 PushbackReader

  public PushbackReader(Reader in,
                        int size)

 Create a new pushback reader with a pushback buffer of the given size.

 PushbackReader

  public PushbackReader(Reader in)

 Create a new pushback reader with a one-character pushback buffer.

 read

  public int read() throws IOException

 Read a single character.

Returns:

 The character read, or -1 if the end of the stream has been  reached

Throws: IOException

 If an I/O error occurs

Overrides:

read in class FilterReader

 read

  public int read(char cbuf[],
                  int off,
                  int len) throws IOException

 Read characters into a portion of an array.

Parameters:

 cbuf - Destination buffer

 off - Offset at which to start writing characters

 len - Maximum number of characters to read

Returns:

 The number of characters read, or -1 if the end of the  stream has been reached

Throws: IOException

 If an I/O error occurs

Overrides:

read in class FilterReader

 unread

  public void unread(int c) throws IOException

 Push back a single character.

Parameters:

 c - The character to push back

Throws: IOException

 If the pushback buffer is full,  or if some other I/O error occurs

 unread

  public void unread(char cbuf[],
                     int off,
                     int len) throws IOException

 Push back from an array of characters.

Parameters:

 cbuf - Character array

 off - Offset of first character to push back

 len - Number of characters to push back

Throws: IOException

 If there is insufficient room in the pushback  buffer, or if some other I/O error occurs

 unread

  public void unread(char cbuf[]) throws IOException

 Push back an entire array of characters.

Parameters:

 cbuf - Character array

 off - Offset of first character to push back

 len - Number of characters to push back

Throws: IOException

 If there is insufficient room in the pushback  buffer, or if some other I/O error occurs

 ready

  public boolean ready() throws IOException

 Tell whether this stream is ready to be read.

Throws: IOException

 If an I/O error occurs

Overrides:

ready in class FilterReader

 markSupported

  public boolean markSupported()

 Tell whether this stream supports the mark() operation, which it does  not.

Overrides:

markSupported in class FilterReader

 close

  public void close() throws IOException

 Close the stream.

Throws: IOException

 If an I/O error occurs

Overrides:

close in class FilterReader

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.RandomAccessFile

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.RandomAccessFile

java.lang.Object
   |
   +----java.io.RandomAccessFile

______________________________________________________________________________

 public class RandomAccessFile

 extends Object

 implements DataOutput, DataInput

Instances of this class support both reading and writing to a  random access file. An application can modify the position in the  file at which the next read or write occurs.  This class provides a sense of security  by offering methods that allow specified mode accesses of  read-only or read-write to files.

______________________________________________________________________________

 	RandomAccessFile(File, String)

 Creates a random access file stream to read from, and optionally  to write to, the file specified by the File argument.

 	RandomAccessFile(String, String)

 Creates a random access file stream to read from, and optionally  to write to, a file with the specified name.

 	close()

 Closes this random access file stream and releases any system  resources associated with the stream.

 	getFD()

 Returns the opaque file descriptor object associated with this stream.

 	getFilePointer()

 Returns the current offset in this file.

 	length()

 Returns the length of this file.

 	read()

 Reads a byte of data from this file.

 	read(byte[])

 Reads up to b.length bytes of data from this file  into an array of bytes.

 	read(byte[], int, int)

 Reads up to len bytes of data from this file into an  array of bytes.

 	readBoolean()

 Reads a boolean from this file.

 	readByte()

 Reads a signed 8-bit value from this file.

 	readChar()

 Reads a Unicode character from this file.

 	readDouble()

 Reads a double from this file.

 	readFloat()

 Reads a float from this file.

 	readFully(byte[])

 Reads b.length bytes from this file into the byte  array.

 	readFully(byte[], int, int)

 Reads exactly len bytes from this file into the byte  array.

 	readInt()

 Reads a signed 32-bit integer from this file.

 	readLine()

 Reads the next line of text from this file.

 	readLong()

 Reads a signed 64-bit integer from this file.

 	readShort()

 Reads a signed 16-bit number from this file.

 	readUnsignedByte()

 Reads an unsigned 8-bit number from this file.

 	readUnsignedShort()

 Reads an unsigned 16-bit number from this file.

 	readUTF()

 Reads in a string from this file.

 	seek(long)

 Sets the offset from the beginning of this file at which the next  read or write occurs.

 	skipBytes(int)

 Skips exactly n bytes of input.

 	write(byte[])

 Writes b.length bytes from the specified byte array  starting at offset off  to this file.

 	write(byte[], int, int)

 Writes len bytes from the specified byte array  starting at offset off  to this file.

 	write(int)

 Writes the specified byte to this file.

 	writeBoolean(boolean)

 Writes a boolean to the file as a 1-byte value.

 	writeByte(int)

 Writes a byte to the file as a 1-byte value.

 	writeBytes(String)

 Writes the string to the file as a sequence of bytes.

 	writeChar(int)

 Writes a char to the file as a 2-byte value, high  byte first.

 	writeChars(String)

 Writes a string to the file as a sequence of characters.

 	writeDouble(double)

 Converts the double argument to a long using the  doubleToLongBits  method in class Double,  and then writes that long  value to the file as an  8-byte quantity, high byte first.

 	writeFloat(float)

 Converts the float argument to an int using the  floatToIntBits  method in class Float,  and then writes that int value to the file as a  4-byte quantity, high byte first.

 	writeInt(int)

 Writes an int to the file as four bytes, high byte first.

 	writeLong(long)

 Writes a long to the file as eight bytes, high byte first.

 	writeShort(int)

 Writes a short to the file as two bytes, high byte first.

 	writeUTF(String)

 Writes a string to the file using UTF-8 encoding in a  machine-independent manner.

 RandomAccessFile

  public RandomAccessFile(String name,
                          String mode) throws IOException

 Creates a random access file stream to read from, and optionally  to write to, a file with the specified name.

 The mode argument must either be equal to "r" or  "rw" , indicating either to open the file for input or  for both input and output.

Parameters:

 name - the system-dependent filename.

 mode - the access mode.

Throws: IllegalArgumentException

 if the mode argument is not equal  to "r" or to "rw".

Throws: IOException

 if an I/O error occurs.

Throws: SecurityException

 if a security manager exists, its  checkRead method is called with the name  argument to see if the application is allowed read access  to the file. If the mode argument is equal to  "rw", its checkWrite  method also  is called with the name argument to see if the application  is allowed write access to the file. Either of these may  result in a security exception.

See Also:

SecurityException, checkRead

 RandomAccessFile

  public RandomAccessFile(File file,
                          String mode) throws IOException

 Creates a random access file stream to read from, and optionally  to write to, the file specified by the File argument.

 The mode argument must either be equal to "r" or to  "rw" , indicating either to open the file for input,  or for both input and output, respectively.

Parameters:

 file - the file object.

 mode - the access mode.

Throws: IllegalArgumentException

 if the mode argument is not equal  to "r" or to "rw".

Throws: IOException

 if an I/O error occurs.

Throws: SecurityException

 if a security manager exists, its  checkRead method is called with the pathname  of the File argument to see if the  application is allowed read access to the file. If the  mode argument is equal to "rw" , its  checkWrite method also is called with the  pathname to see if the application is allowed write access  to the file.

See Also:

getPath, checkRead

 getFD

  public final FileDescriptor getFD() throws IOException

 Returns the opaque file descriptor object associated with this stream.

Returns:

 the file descriptor object associated with this stream.

Throws: IOException

 if an I/O error occurs.

See Also:

FileDescriptor

 read

  public int read() throws IOException

 Reads a byte of data from this file. This method blocks if no  input is yet available.

Returns:

 the next byte of data, or -1 if the end of the  file is reached.

Throws: IOException

 if an I/O error occurs.

 read

  public int read(byte b[],
                  int off,
                  int len) throws IOException

 Reads up to len bytes of data from this file into an  array of bytes. This method blocks until at least one byte of input  is available.

Parameters:

 b - the buffer into which the data is read.

 off - the start offset of the data.

 len - the maximum number of bytes read.

Returns:

 the total number of bytes read into the buffer, or  -1  if there is no more data because the end of  the file has been reached.

Throws: IOException

 if an I/O error occurs.

 read

  public int read(byte b[]) throws IOException

 Reads up to b.length bytes of data from this file  into an array of bytes. This method blocks until at least one byte  of input is available.

Parameters:

 b - the buffer into which the data is read.

Returns:

 the total number of bytes read into the buffer, or  -1  if there is no more data because the end of  this file has been reached.

Throws: IOException

 if an I/O error occurs.

 readFully

  public final void readFully(byte b[]) throws IOException

 Reads b.length bytes from this file into the byte  array. This method reads repeatedly from the file until all the  bytes are read. This method blocks until all the bytes are read,  the end of the stream is detected, or an exception is thrown.

Parameters:

 b - the buffer into which the data is read.

Throws: EOFException

 if this file reaches the end before reading  all the bytes.

Throws: IOException

 if an I/O error occurs.

 readFully

  public final void readFully(byte b[],
                              int off,
                              int len) throws IOException

 Reads exactly len bytes from this file into the byte  array. This method reads repeatedly from the file until all the  bytes are read. This method blocks until all the bytes are read,  the end of the stream is detected, or an exception is thrown.

Parameters:

 b - the buffer into which the data is read.

 off - the start offset of the data.

 len - the number of bytes to read.

Throws: EOFException

 if this file reaches the end before reading  all the bytes.

Throws: IOException

 if an I/O error occurs.

 skipBytes

  public int skipBytes(int n) throws IOException

 Skips exactly n bytes of input.

 This method blocks until all the bytes are skipped, the end of  the stream is detected, or an exception is thrown.

Parameters:

 n - the number of bytes to be skipped.

Returns:

 the number of bytes skipped, which is always n.

Throws: EOFException

 if this file reaches the end before skipping  all the bytes.

Throws: IOException

 if an I/O error occurs.

 write

  public void write(int b) throws IOException

 Writes the specified byte to this file.

Parameters:

 b - the byte to be written.

Throws: IOException

 if an I/O error occurs.

 write

  public void write(byte b[]) throws IOException

 Writes b.length bytes from the specified byte array  starting at offset off to this file.

Parameters:

 b - the data.

Throws: IOException

 if an I/O error occurs.

 write

  public void write(byte b[],
                    int off,
                    int len) throws IOException

 Writes len bytes from the specified byte array  starting at offset off to this file.

Parameters:

 b - the data.

 off - the start offset in the data.

 len - the number of bytes to write.

Throws: IOException

 if an I/O error occurs.

 getFilePointer

  public long getFilePointer() throws IOException

 Returns the current offset in this file.

Returns:

 the offset from the beginning of the file, in bytes,  at which the next read or write occurs.

Throws: IOException

 if an I/O error occurs.

 seek

  public void seek(long pos) throws IOException

 Sets the offset from the beginning of this file at which the next  read or write occurs.

Parameters:

 pos - the absolute position.

Throws: IOException

 if an I/O error occurs.

 length

  public long length() throws IOException

 Returns the length of this file.

Returns:

 the length of this file.

Throws: IOException

 if an I/O error occurs.

 close

  public void close() throws IOException

 Closes this random access file stream and releases any system  resources associated with the stream.

Throws: IOException

 if an I/O error occurs.

 readBoolean

  public final boolean readBoolean() throws IOException

 Reads a boolean from this file. This method reads a  single byte from the file. A value of 0 represents  false . Any other value represents true.  This method blocks until the byte is read, the end of the stream  is detected, or an exception is thrown.

Returns:

 the boolean value read.

Throws: EOFException

 if this file has reached the end.

Throws: IOException

 if an I/O error occurs.

 readByte

  public final byte readByte() throws IOException

 Reads a signed 8-bit value from this file. This method reads a  byte from the file. If the byte read is b, where  0 <= b <= 255,  then the result is:

  (byte)(b)

 This method blocks until the byte is read, the end of the stream  is detected, or an exception is thrown.

Returns:

 the next byte of this file as a signed 8-bit  byte.

Throws: EOFException

 if this file has reached the end.

Throws: IOException

 if an I/O error occurs.

 readUnsignedByte

  public final int readUnsignedByte() throws IOException

 Reads an unsigned 8-bit number from this file. This method reads  a byte from this file and returns that byte.

 This method blocks until the byte is read, the end of the stream  is detected, or an exception is thrown.

Returns:

 the next byte of this file, interpreted as an unsigned  8-bit number.

Throws: EOFException

 if this file has reached the end.

Throws: IOException

 if an I/O error occurs.

 readShort

  public final short readShort() throws IOException

 Reads a signed 16-bit number from this file. The method reads 2  bytes from this file. If the two bytes read, in order, are  b1 and b2 , where each of the two values is  between 0 and 255, inclusive, then the  result is equal to:

  (short)((b1 << 8) | b2)

 This method blocks until the two bytes are read, the end of the  stream is detected, or an exception is thrown.

Returns:

 the next two bytes of this file, interpreted as a signed  16-bit number.

Throws: EOFException

 if this file reaches the end before reading  two bytes.

Throws: IOException

 if an I/O error occurs.

 readUnsignedShort

  public final int readUnsignedShort() throws IOException

 Reads an unsigned 16-bit number from this file. This method reads  two bytes from the file. If the bytes read, in order, are  b1 and b2 , where  0 <= b1, b2 <= 255,  then the result is equal to:

  (b1 << 8) | b2

 This method blocks until the two bytes are read, the end of the  stream is detected, or an exception is thrown.

Returns:

 the next two bytes of this file, interpreted as an unsigned  16-bit integer.

Throws: EOFException

 if this file reaches the end before reading  two bytes.

Throws: IOException

 if an I/O error occurs.

 readChar

  public final char readChar() throws IOException

 Reads a Unicode character from this file. This method reads two  bytes from the file. If the bytes read, in order, are  b1 and b2, where  0 <= b1, b2 <= 255,  then the result is equal to:

  (char)((b1 << 8) | b2)

 This method blocks until the two bytes are read, the end of the  stream is detected, or an exception is thrown.

Returns:

 the next two bytes of this file as a Unicode character.

Throws: EOFException

 if this file reaches the end before reading  two bytes.

Throws: IOException

 if an I/O error occurs.

 readInt

  public final int readInt() throws IOException

 Reads a signed 32-bit integer from this file. This method reads 4  bytes from the file. If the bytes read, in order, are b1,  b2, b3, and b4, where  0 <= b1, b2, b3, b4 <= 255,  then the result is equal to:

  (b1 << 24) | (b2 << 16) + (b3 << 8) + b4

 This method blocks until the four bytes are read, the end of the  stream is detected, or an exception is thrown.

Returns:

 the next four bytes of this file, interpreted as an  int.

Throws: EOFException

 if this file reaches the end before reading  four bytes.

Throws: IOException

 if an I/O error occurs.

 readLong

  public final long readLong() throws IOException

 Reads a signed 64-bit integer from this file. This method reads eight  bytes from the file. If the bytes read, in order, are  b1, b2, b3,  b4, b5, b6,  b7, and b8, where:

  0 <= b1, b2, b3, b4, b5, b6, b7, b8 <=255,

 then the result is equal to:

     ((long)b1 << 56) + ((long)b2 << 48)
     + ((long)b3 << 40) + ((long)b4 << 32)
     + ((long)b5 << 24) + ((long)b6 << 16)
     + ((long)b7 << 8) + b8

 This method blocks until the eight bytes are read, the end of the  stream is detected, or an exception is thrown.

Returns:

 the next eight bytes of this file, interpreted as a  long.

Throws: EOFException

 if this file reaches the end before reading  eight bytes.

Throws: IOException

 if an I/O error occurs.

 readFloat

  public final float readFloat() throws IOException

 Reads a float from this file. This method reads an  int value as if by the readInt method  and then converts that int to a float  using the intBitsToFloat method in class  Float .

 This method blocks until the four bytes are read, the end of the  stream is detected, or an exception is thrown.

Returns:

 the next four bytes of this file, interpreted as a  float.

Throws: EOFException

 if this file reaches the end before reading  four bytes.

Throws: IOException

 if an I/O error occurs.

See Also:

readInt, intBitsToFloat

 readDouble

  public final double readDouble() throws IOException

 Reads a double from this file. This method reads a  long value as if by the readLong method  and then converts that long to a double  using the longBitsToDouble method in  class Double.

 This method blocks until the eight bytes are read, the end of the  stream is detected, or an exception is thrown.

Returns:

 the next eight bytes of this file, interpreted as a  double.

Throws: EOFException

 if this file reaches the end before reading  eight bytes.

Throws: IOException

 if an I/O error occurs.

See Also:

readLong, longBitsToDouble

 readLine

  public final String readLine() throws IOException

 Reads the next line of text from this file. This method  successively reads bytes from the file until it reaches the end of  a line of text.

 A line of text is terminated by a carriage-return character  ('\r' ), a newline character ('\n'), a  carriage-return character immediately followed by a newline  character, or the end of the input stream. The line-terminating  character(s), if any, are included as part of the string returned.

 This method blocks until a newline character is read, a carriage  return and the byte following it are read (to see if it is a  newline), the end of the stream is detected, or an exception is thrown.

Returns:

 the next line of text from this file.

Throws: IOException

 if an I/O error occurs.

 readUTF

  public final String readUTF() throws IOException

 Reads in a string from this file. The string has been encoded  using a modified UTF-8 format.

 The first two bytes are read as if by  readUnsignedShort . This value gives the number of  following bytes that are in the encoded string, not  the length of the resulting string. The following bytes are then  interpreted as bytes encoding characters in the UTF-8 format  and are converted into characters.

 This method blocks until all the bytes are read, the end of the  stream is detected, or an exception is thrown.

Returns:

 a Unicode string.

Throws: EOFException

 if this file reaches the end before  reading all the bytes.

Throws: IOException

 if an I/O error occurs.

Throws: UTFDataFormatException

 if the bytes do not represent  valid UTF-8 encoding of a Unicode string.

See Also:

readUnsignedShort

 writeBoolean

  public final void writeBoolean(boolean v) throws IOException

 Writes a boolean to the file as a 1-byte value. The  value true is written out as the value  (byte)1; the value false  is written out  as the value (byte)0.

Parameters:

 v - a boolean value to be written.

Throws: IOException

 if an I/O error occurs.

 writeByte

  public final void writeByte(int v) throws IOException

 Writes a byte to the file as a 1-byte value.

Parameters:

 v - a byte value to be written.

Throws: IOException

 if an I/O error occurs.

 writeShort

  public final void writeShort(int v) throws IOException

 Writes a short to the file as two bytes, high byte first.

Parameters:

 v - a short to be written.

Throws: IOException

 if an I/O error occurs.

 writeChar

  public final void writeChar(int v) throws IOException

 Writes a char to the file as a 2-byte value, high  byte first.

Parameters:

 v - a char value to be written.

Throws: IOException

 if an I/O error occurs.

 writeInt

  public final void writeInt(int v) throws IOException

 Writes an int to the file as four bytes, high byte first.

Parameters:

 v - an int to be written.

Throws: IOException

 if an I/O error occurs.

 writeLong

  public final void writeLong(long v) throws IOException

 Writes a long to the file as eight bytes, high byte first.

Parameters:

 v - a long to be written.

Throws: IOException

 if an I/O error occurs.

 writeFloat

  public final void writeFloat(float v) throws IOException

 Converts the float argument to an int using the  floatToIntBits method in class Float,  and then writes that int  value to the file as a  4-byte quantity, high byte first.

Parameters:

 v - a float value to be written.

Throws: IOException

 if an I/O error occurs.

See Also:

floatToIntBits

 writeDouble

  public final void writeDouble(double v) throws IOException

 Converts the double argument to a long using the  doubleToLongBits method in class Double,  and then writes that long value to the file as an  8-byte quantity, high byte first.

Parameters:

 v - a double value to be written.

Throws: IOException

 if an I/O error occurs.

See Also:

doubleToLongBits

 writeBytes

  public final void writeBytes(String s) throws IOException

 Writes the string to the file as a sequence of bytes. Each  character in the string is written out, in sequence, by discarding  its high eight bits.

Parameters:

 s - a string of bytes to be written.

Throws: IOException

 if an I/O error occurs.

 writeChars

  public final void writeChars(String s) throws IOException

 Writes a string to the file as a sequence of characters. Each  character is written to the data output stream as if by the  writeChar method.

Parameters:

 s - a String value to be written.

Throws: IOException

 if an I/O error occurs.

See Also:

writeChar

 writeUTF

  public final void writeUTF(String str) throws IOException

 Writes a string to the file using UTF-8 encoding in a  machine-independent manner.

 First, two bytes are written to the file as if by the  writeShort  method giving the number of bytes to  follow. This value is the number of bytes actually written out,  not the length of the string. Following the length, each character  of the string is output, in sequence, using the UTF-8 encoding  for each character.

Parameters:

 str - a string to be written.

Throws: IOException

 if an I/O error occurs.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.Reader

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.Reader

java.lang.Object
   |
   +----java.io.Reader

______________________________________________________________________________

 public class Reader

 extends Object

Abstract class for reading character streams. The only methods that a  subclass must implement are read(char[], int, int) and close(). Most  subclasses, however, will override some of the methods defined here in order  to provide higher efficiency, additional functionality, or both.

See Also:

BufferedReader, LineNumberReader, CharArrayReader, InputStreamReader , FileReader, FilterReader, PushbackReader, PipedReader, StringReader, Writer

______________________________________________________________________________

 	lock

 The object used to synchronize operations on this stream.

 	Reader()

 Create a new character-stream reader whose critical sections will  synchronize on the reader itself.

 	Reader(Object)

 Create a new character-stream reader whose critical sections will  synchronize on the given object.

 	close()

 Close the stream.

 	mark(int)

 Mark the present position in the stream.

 	markSupported()

 Tell whether this stream supports the mark() operation.

 	read()

 Read a single character.

 	read(char[])

 Read characters into an array.

 	read(char[], int, int)

 Read characters into a portion of an array.

 	ready()

 Tell whether this stream is ready to be read.

 	reset()

 Reset the stream.

 	skip(long)

 Skip characters.

 lock

  protected Object lock

 The object used to synchronize operations on this stream. For  efficiency, a character-stream object may use an object other than  itself to protect critical sections. A subclass should therefore use  the object in this field rather than this or a synchronized  method.

 Reader

  protected Reader()

 Create a new character-stream reader whose critical sections will  synchronize on the reader itself.

 Reader

  protected Reader(Object lock)

 Create a new character-stream reader whose critical sections will  synchronize on the given object.

 read

  public int read() throws IOException

 Read a single character. This method will block until a character is  available, an I/O error occurs, or the end of the stream is reached.

 Subclasses that intend to support efficient single-character input  should override this method.

Returns:

 The character read, as an integer in the range 0 to 16383  (0x00-0xffff ), or -1 if the end of the stream has  been reached

Throws: IOException

 If an I/O error occurs

 read

  public int read(char cbuf[]) throws IOException

 Read characters into an array. This method will block until some input  is available, an I/O error occurs, or the end of the stream is reached.

Parameters:

 cbuf - Destination buffer

Returns:

 The number of bytes read, or -1 if the end of the stream  has been reached

Throws: IOException

 If an I/O error occurs

 read

  public abstract int read(char cbuf[],
                           int off,
                           int len) throws IOException

 Read characters into a portion of an array. This method will block  until some input is available, an I/O error occurs, or the end of the  stream is reached.

Parameters:

 cbuf - Destination buffer

 off - Offset at which to start storing characters

 len - Maximum number of characters to read

Returns:

 The number of characters read, or -1 if the end of the  stream has been reached

Throws: IOException

 If an I/O error occurs

 skip

  public long skip(long n) throws IOException

 Skip characters. This method will block until some characters are  available, an I/O error occurs, or the end of the stream is reached.

Parameters:

 n - The number of characters to skip

Returns:

 The number of characters actually skipped

Throws: IOException

 If an I/O error occurs

 ready

  public boolean ready() throws IOException

 Tell whether this stream is ready to be read.

Returns:

 True if the next read() is guaranteed not to block for input,  false otherwise. Note that returning false does not guarantee that the  next read will block.

Throws: IOException

 If an I/O error occurs

 markSupported

  public boolean markSupported()

 Tell whether this stream supports the mark() operation.

 mark

  public void mark(int readAheadLimit) throws IOException

 Mark the present position in the stream. Subsequent calls to reset()  will attempt to reposition the stream to this point. Not all  character-input streams support the mark() operation.

Parameters:

 readAheadLimit - Limit on the number of characters that may be  read while still preserving the mark. After  reading this many characters, attempting to  reset the stream may fail.

Throws: IOException

 If the stream does not support mark(),  or if some other I/O error occurs

 reset

  public void reset() throws IOException

 Reset the stream. If the stream has been marked, then attempt to  reposition it at the mark. If the stream has not been marked, then  attempt to reset it in some way appropriate to the particular stream,  for example by repositioning it to its starting point. Not all  character-input streams support the reset() operation, and some support  reset() without supporting mark().

Throws: IOException

 If the stream has not been marked,  or if the mark has been invalidated,  or if the stream does not support reset(),  or if some other I/O error occurs

 close

  public abstract void close() throws IOException

 Close the stream. Once a stream has been closed, further read(),  ready(), mark(), or reset() invocations will throw an IOException.  Closing a previously-closed stream, however, has no effect.

Throws: IOException

 If an I/O error occurs

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.SequenceInputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.SequenceInputStream

java.lang.Object
   |
   +----java.io.InputStream
           |
           +----java.io.SequenceInputStream

______________________________________________________________________________

 public class SequenceInputStream

 extends InputStream

The sequence input stream class allows an application to combine  several input streams serially and make them appear as if they  were a single input stream. Each input stream is read from, in  turn, until it reaches the end of the stream. The sequence input  stream class then closes that stream and automatically switches to  the next input stream.

______________________________________________________________________________

 	SequenceInputStream(Enumeration)

 Constructs a new sequence input stream initialized to the  specified enumeration of input streams.

 	SequenceInputStream(InputStream, InputStream)

 Constructs a new sequence input stream initialized to read first  from the input stream s1, and then from the input  stream s2.

 	available()

 Returns the number of bytes available on the current stream.

 	close()

 Closes this input stream and releases any system resources  associated with the stream.

 	read()

 Reads the next byte of data from this input stream.

 	read(byte[], int, int)

 Reads up to len bytes of data from this input stream  into an array of bytes.

 SequenceInputStream

  public SequenceInputStream(Enumeration e)

 Constructs a new sequence input stream initialized to the  specified enumeration of input streams. Each object in the  enumeration must be an InputStream.

Parameters:

 e - an enumeration of input streams.

See Also:

Enumeration

 SequenceInputStream

  public SequenceInputStream(InputStream s1,
                             InputStream s2)

 Constructs a new sequence input stream initialized to read first  from the input stream s1, and then from the input  stream s2.

Parameters:

 s1 - the first input stream to read.

 s2 - the second input stream to read.

 available

  public int available() throws IOException

 Returns the number of bytes available on the current stream.

Overrides:

available in class InputStream

 read

  public int read() throws IOException

 Reads the next byte of data from this input stream. The byte is  returned as an int in the range 0 to  255 . If no byte is available because the end of the  stream has been reached, the value -1  is returned.  This method blocks until input data is available, the end of the  stream is detected, or an exception is thrown.

 The read method of SequenceInputStream  tries to read one character from the current substream. If it  reaches the end of the stream, it calls the close  method of the current substream and begins reading from the next  substream.

Returns:

 the next byte of data, or -1 if the end of the  stream is reached.

Throws: IOException

 if an I/O error occurs.

Overrides:

read in class InputStream

 read

  public int read(byte buf[],
                  int pos,
                  int len) throws IOException

 Reads up to len bytes of data from this input stream  into an array of bytes. This method blocks until at least 1 byte  of input is available. If the first argument is null,  up to len  bytes are read and discarded.

 The read method of SequenceInputStream  tries to read the data from the current substream. If it fails to  read any characters because the substream has reached the end of  the stream, it calls the close method of the current  substream and begins reading from the next substream.

Parameters:

 b - the buffer into which the data is read.

 off - the start offset of the data.

 len - the maximum number of bytes read.

Throws: IOException

 if an I/O error occurs.

Overrides:

read in class InputStream

 close

  public void close() throws IOException

 Closes this input stream and releases any system resources  associated with the stream.

 The close method of SequenceInputStream  calls the close  method of both the substream from  which it is currently reading and the close  method of  all the substreams that it has not yet begun to read from.

Throws: IOException

 if an I/O error occurs.

Overrides:

close in class InputStream

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.io.Serializable

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.io.Serializable

 public interface Serializable

Serializability of a class is enabled by the class implementing the  java.io.Serializable interface. Classes that do not implement this  interface will not have any of their state serialized or  deserialized. All subtypes of a serializable class are themselves  serializable. The serialization interface has no methods or fields  and serves only to identify the semantics of being serializable.

 To allow subtypes of non-serializable classes to be serialized, the  subtype may assume responsibility for saving and restoring the  state of the supertype's public, protected, and (if accessible)  package fields. The subtype may assume this responsibility only if  the class it extends has an accessible no-arg constructor to  initialize the class's state. It is an error to declare a class  Serializable in this case. The error will be detected at runtime.

 During deserialization, the fields of non-serializable classes will  be initialized using the public or protected no-arg constructor of  the class. A no-arg constructor must be accessible to the subclass  that is serializable. The fields of serializable subclasses will  be restored from the stream.

 When traversing a graph, an object may be encountered that does not  support the Serializable interface. In this case the  NotSerializableException will be thrown and will identify the class  of the non-serializable object.

 Classes that require special handling during the serialization and deserialization  process must implement special methods with these exact signatures:

 private void writeObject(java.io.ObjectOutputStream out)
     throws IOException
 private void readObject(java.io.ObjectInputStream in)
     throws IOException, ClassNotFoundException;

 The writeObject method is responsible for writing the state of the  object for its particular class so that the corresponding  readObject method can restore it. The default mechanism for saving  the Object's fields can be invoked by calling  out.defaultWriteObject. The method does not need to concern  itself with the state belonging to its superclasses or subclasses.  State is saved by writing the individual fields to the  ObjectOutputStream using the writeObject method or by using the  methods for primitive data types supported by DataOutput.

 The readObject method is responsible for reading from the stream and restoring  the classes fields. It may call in.defaultReadObject to invoke  the default mechanism for restoring the object's non-static and non-transient  fields. The defaultReadObject method uses information in the stream to  assign the fields of the object saved in the stream with the correspondingly  named fields in the current object. This handles the case when the class  has evolved to add new fields. The method does not need to concern  itself with the state belonging to its superclasses or subclasses.  State is saved by writing the individual fields to the  ObjectOutputStream using the writeObject method or by using the  methods for primitive data types supported by DataOutput.

See Also:

ObjectOutputStream, ObjectInputStream, ObjectOutput, ObjectInput , Externalizable

______________________________________________________________________________
______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.StreamCorruptedException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.StreamCorruptedException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.io.ObjectStreamException
                                   |
                                   +----java.io.StreamCorruptedException

______________________________________________________________________________

 public class StreamCorruptedException

 extends ObjectStreamException

Raised when control information read from an object stream  violates internal consistency checks.

______________________________________________________________________________

 	StreamCorruptedException()

 Create a StreamCorruptedException with no reason.

 	StreamCorruptedException(String)

 Create a StreamCorruptedException with a reason.

 StreamCorruptedException

  public StreamCorruptedException(String reason)

 Create a StreamCorruptedException with a reason.

 StreamCorruptedException

  public StreamCorruptedException()

 Create a StreamCorruptedException with no reason.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.StreamTokenizer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.StreamTokenizer

java.lang.Object
   |
   +----java.io.StreamTokenizer

______________________________________________________________________________

 public class StreamTokenizer

 extends Object

The StreamTokenizer class takes an input stream and  parses it into "tokens", allowing the tokens to be  read one at a time. The parsing process is controlled by a table  and a number of flags that can be set to various states. The  stream tokenizer can recognize identifiers, numbers, quoted  strings, and various comment styles.

 Each byte read from the input stream is regarded as a character  in the range '\u0000'  through '\u00FF'.  The character value is used to look up five possible attributes of  the character: white space, alphabetic,  numeric, string quote, and comment character.  Each character can have zero or more of these attributes.

 In addition, an instance has four flags. These flags indicate:

• Whether line terminators are to be returned as tokens or treated  as white space that merely separates tokens.

• Whether C-style comments are to be recognized and skipped.

• Whether C++-style comments are to be recognized and skipped.

• Whether the characters of identifiers are converted to lowercase.

 A typical application first constructs an instance of this class,  sets up the syntax tables, and then repeatedly loops calling the  nextToken  method in each iteration of the loop until  it returns the value TT_EOF.

See Also:

nextToken, TT_EOF

______________________________________________________________________________

 	nval

 If the current token is a number, this field contains the value  of that number.

 	sval

 If the current token is a word token, this field contains a  string giving the characters of the word token.

 	TT_EOF

 A constant indicating that the end of the stream has been read.

 	TT_EOL

 A constant indicating that the end of the line has been read.

 	TT_NUMBER

 A constant indicating that a number token has been read.

 	TT_WORD

 A constant indicating that a word token has been read.

 	ttype

 After a call to the nextToken method, this field  contains the type of the token just read.

 	StreamTokenizer(InputStream)

 Creates a stream tokenizer that parses the specified input  stream. Deprecated.

 	StreamTokenizer(Reader)

 Create a tokenizer that parses the given character stream.

 	commentChar(int)

 Specified that the character argument starts a single-line  comment.

 	eolIsSignificant(boolean)

 Determines whether or not ends of line are treated as tokens.

 	lineno()

 Return the current line number.

 	lowerCaseMode(boolean)

 Determines whether or not word token are automatically lowercased.

 	nextToken()

 Parses the next token from the input stream of this tokenizer.

 	ordinaryChar(int)

 Specifies that the character argument is "ordinary"  in this tokenizer.

 	ordinaryChars(int, int)

 Specifies that all characters c in the range  low <= c <= high   are "ordinary" in this tokenizer.

 	parseNumbers()

 Specifies that numbers should be parsed by this tokenizer.

 	pushBack()

 Causes the next call to the nextToken method of this  tokenizer to return the current value in the ttype  field, and not to modify the value in the nval or  sval field.

 	quoteChar(int)

 Specifies that matching pairs of this character delimit string  constants in this tokenizer.

 	resetSyntax()

 Resets this tokenizer's syntax table so that all characters are  "ordinary." See the ordinaryChar method  for more information on a character being ordinary.

 	slashSlashComments(boolean)

 Determines whether or not the tokenizer recognizes C++-style comments.

 	slashStarComments(boolean)

 Determines whether or not the tokenizer recognizes C-style comments.

 	toString()

 Returns the string representation of the current stream token.

 	whitespaceChars(int, int)

 Specifies that all characters c in the range  low <= c <= high   are white space characters.

 	wordChars(int, int)

 Specifies that all characters c in the range  low <= c <= high   are word constituents.

 ttype

  public int ttype

 After a call to the nextToken method, this field  contains the type of the token just read. For a single character  token, its value is the single character, converted to an integer.  For a quoted string token (see , its value is the quote character.  Otherwise, its value is one of the following:

• TT_WORD indicates that the token is a word.

• TT_NUMBER indicates that the token is a number.

• TT_EOL indicates that the end of line has been read.  The field can only have this value if the  eolIsSignificant  method has been called with the  argument true.

• TT_EOF indicates that the end of the input stream  has been reached.

See Also:

eolIsSignificant, nextToken, quoteChar, TT_EOF, TT_EOL , TT_NUMBER, TT_WORD

 TT_EOF

  public final static int TT_EOF

 A constant indicating that the end of the stream has been read.

 TT_EOL

  public final static int TT_EOL

 A constant indicating that the end of the line has been read.

 TT_NUMBER

  public final static int TT_NUMBER

 A constant indicating that a number token has been read.

 TT_WORD

  public final static int TT_WORD

 A constant indicating that a word token has been read.

 sval

  public String sval

 If the current token is a word token, this field contains a  string giving the characters of the word token. When the current  token is a quoted string token, this field contains the body of  the string.

 The current token is a word when the value of the  ttype field is TT_WORD . The current token is  a quoted string token when the value of the ttype field is  a quote character.

See Also:

quoteChar, TT_WORD, ttype

 nval

  public double nval

 If the current token is a number, this field contains the value  of that number. The current token is a number when the value of  the ttype field is TT_NUMBER.

See Also:

TT_NUMBER, ttype

 StreamTokenizer

  public StreamTokenizer(InputStream is)

 Note: StreamTokenizer() is deprecated. This method does not properly convert bytes into characters.  As of JDK 1.1, the preferred way to tokenize an input  stream is to convert it into a character stream, for example:

                 Reader r = new BufferedReader(new InputStreamReader(is));
                 StreamTokenizer st = new StreamTokenizer(r);

 Creates a stream tokenizer that parses the specified input  stream. The stream tokenizer is initialized to the following  default state:

• All byte values 'A' through 'Z',  'a' through 'z', and  '\u00A0' through '\u00FF' are   considered to be alphabetic.

• All byte values '\u0000' through  '\u0020'  are considered to be white space.

• '/' is a comment character.

• Single quote '\'' and double quote '"'  are string quote characters.

• Numbers are parsed.

• Ends of lines are treated as white space, not as separate tokens.

• C-style and C++-style comments are not recognized.

Parameters:

 is - an input stream.

See Also:

BufferedReader, InputStreamReader, StreamTokenizer

 StreamTokenizer

  public StreamTokenizer(Reader r)

 Create a tokenizer that parses the given character stream.

 resetSyntax

  public void resetSyntax()

 Resets this tokenizer's syntax table so that all characters are  "ordinary." See the ordinaryChar method  for more information on a character being ordinary.

See Also:

ordinaryChar

 wordChars

  public void wordChars(int low,
                        int hi)

 Specifies that all characters c in the range  low <= c <= high  are word constituents. A word token consists of a word constituent  followed by zero or more word constituents or number constituents.

Parameters:

 low - the low end of the range.

 hi - the high end of the range.

 whitespaceChars

  public void whitespaceChars(int low,
                              int hi)

 Specifies that all characters c in the range  low <= c <= high  are white space characters. White space characters serve only to  separate tokens in the input stream.

Parameters:

 low - the low end of the range.

 hi - the high end of the range.

 ordinaryChars

  public void ordinaryChars(int low,
                            int hi)

 Specifies that all characters c in the range  low <= c <= high  are "ordinary" in this tokenizer. See the  ordinaryChar  method for more information on a  character being ordinary.

Parameters:

 low - the low end of the range.

 hi - the high end of the range.

See Also:

ordinaryChar

 ordinaryChar

  public void ordinaryChar(int ch)

 Specifies that the character argument is "ordinary"  in this tokenizer. It removes any special significance the  character has as a comment character, word component, string  delimiter, white space, or number character. When such a character  is encountered by the parser, the parser treates it as a  single-character token and sets ttype field to the  character value.

Parameters:

 ch - the character.

See Also:

ttype

 commentChar

  public void commentChar(int ch)

 Specified that the character argument starts a single-line  comment. All characters from the comment character to the end of  the line are ignored by this stream tokenizer.

Parameters:

 ch - the character.

 quoteChar

  public void quoteChar(int ch)

 Specifies that matching pairs of this character delimit string  constants in this tokenizer.

 When the nextToken method encounters a string  constant, the ttype  field is set to the string  delimiter and the sval field is set to the body of  the string.

 If a string quote character is encountered, then a string is  recognized, consisting of all characters after (but not including)  the string quote character, up to (but not including) the next  occurrence of that same string quote character, or a line  terminator, or end of file. The usual escape sequences such as  "\n" and "\t" are recognized and  converted to single characters as the string is parsed.

Parameters:

 ch - the character.

See Also:

nextToken, sval, ttype

 parseNumbers

  public void parseNumbers()

 Specifies that numbers should be parsed by this tokenizer. The  syntax table of this tokenizer is modified so that each of the twelve  characters:

  0 1 2 3 4 5 6 7 8 9 . -

 has the "numeric" attribute.

 When the parser encounters a word token that has the format of a  double precision floating-point number, it treats the token as a  number rather than a word, by setting the the ttype  field to the value TT_NUMBER and putting the numeric  value of the token into the nval field.

See Also:

nval, TT_NUMBER, ttype

 eolIsSignificant

  public void eolIsSignificant(boolean flag)

 Determines whether or not ends of line are treated as tokens.  If the flag argument is true, this tokenizer treats end of lines  as tokens; the nextToken method returns  TT_EOL and also sets the ttype field to  this value when an end of line is read.

 A line is a sequence of characters ending with either a  carriage-return character ('\r') or a newline  character ('\n'). In addition, a carriage-return  character followed immediately by a newline character is treated  as a single end-of-line token.

 If the flag is false, end-of-line characters are  treated as white space and serve only to separate tokens.

Parameters:

 flag - true indicates that end-of-line characters  are separate tokens; false indicates that  end-of-line characters are white space.

See Also:

nextToken, ttype, TT_EOL

 slashStarComments

  public void slashStarComments(boolean flag)

 Determines whether or not the tokenizer recognizes C-style comments.  If the flag argument is true, this stream tokenizer  recognizes C-style comments. All text between successive  occurrences of /* and */ are discarded.

 If the flag argument is false, then C-style comments  are not treated specially.

Parameters:

 flag - true indicates to recognize and ignore  C-style comments.

 slashSlashComments

  public void slashSlashComments(boolean flag)

 Determines whether or not the tokenizer recognizes C++-style comments.  If the flag argument is true, this stream tokenizer  recognizes C++-style comments. Any occurrence of two consecutive  slash characters ('/' ) is treated as the beginning of  a comment that extends to the end of the line.

 If the flag argument is false, then C++-style  comments are not treated specially.

Parameters:

 flag - true indicates to recognize and ignore  C++-style comments.

 lowerCaseMode

  public void lowerCaseMode(boolean fl)

 Determines whether or not word token are automatically lowercased.  If the flag argument is true, then the value in the  sval  field is lowercased whenever a word token is  returned (the ttype field has the  value TT_WORD by the nextToken method  of this tokenizer.

 If the flag argument is false, then the  sval field is not modified.

Parameters:

 fl - true indicates that all word tokens should  be lowercased.

See Also:

nextToken, ttype, TT_WORD

 nextToken

  public int nextToken() throws IOException

 Parses the next token from the input stream of this tokenizer.  The type of the next token is returned in the ttype  field. Additional information about the token may be in the  nval field or the sval field of this  tokenizer.

 Typical clients of this  class first set up the syntax tables and then sit in a loop  calling nextToken to parse successive tokens until TT_EOF  is returned.

Returns:

 the value of the ttype field.

Throws: IOException

 if an I/O error occurs.

See Also:

nval, sval, ttype

 pushBack

  public void pushBack()

 Causes the next call to the nextToken method of this  tokenizer to return the current value in the ttype  field, and not to modify the value in the nval or  sval field.

See Also:

nextToken, nval, sval, ttype

 lineno

  public int lineno()

 Return the current line number.

Returns:

 the current line number of this stream tokenizer.

 toString

  public String toString()

 Returns the string representation of the current stream token.

Returns:

 a string representation of the token specified by the  ttype, nval, and sval  fields.

Overrides:

toString in class Object

See Also:

nval, sval, ttype

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.StringBufferInputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.StringBufferInputStream

java.lang.Object
   |
   +----java.io.InputStream
           |
           +----java.io.StringBufferInputStream

______________________________________________________________________________

 public class StringBufferInputStream

 extends InputStream

 Note: StringBufferInputStream is deprecated. This class does not properly convert characters into bytes. As  of JDK 1.1, the preferred way to create a stream from a  string is via the StringReader  class.

This class allows an application to create an input stream in  which the bytes read are supplied by the contents of a string.  Applications can also read bytes from a byte array by using a  ByteArrayInputStream.

 Only the low eight bits of each character in the string are used by  this class.

See Also:

ByteArrayInputStream, StringReader

______________________________________________________________________________

 	buffer

 The string from which bytes are read.

 	count

 The number of valid characters in the input stream buffer.

 	pos

 The index of the next character to read from the input stream buffer.

 	StringBufferInputStream(String)

 Creates a string input stream to read data from the specified string.

 	available()

 Returns the number of bytes that can be read from the input  stream without blocking.

 	read()

 Reads the next byte of data from this input stream.

 	read(byte[], int, int)

 Reads up to len bytes of data from this input stream  into an array of bytes.

 	reset()

 Resets the input stream to begin reading from the first character  of this input stream's underlying buffer.

 	skip(long)

 Skips n bytes of input from this input stream.

 buffer

  protected String buffer

 The string from which bytes are read.

 pos

  protected int pos

 The index of the next character to read from the input stream buffer.

See Also:

buffer

 count

  protected int count

 The number of valid characters in the input stream buffer.

See Also:

buffer

 StringBufferInputStream

  public StringBufferInputStream(String s)

 Creates a string input stream to read data from the specified string.

Parameters:

 s - the underlying input buffer.

 read

  public synchronized int read()

 Reads the next byte of data from this input stream. The value  byte is returned as an int in the range  0 to 255 . If no byte is available  because the end of the stream has been reached, the value  -1  is returned.

 The read method of  StringBufferInputStream cannot block. It returns the  low eight bits of the next character in this input stream's buffer.

Returns:

 the next byte of data, or -1 if the end of the  stream is reached.

Overrides:

read in class InputStream

 read

  public synchronized int read(byte b[],
                               int off,
                               int len)

 Reads up to len bytes of data from this input stream  into an array of bytes.

 The read method of  StringBufferInputStream cannot block. It copies the  low eight bits from the characters in this input stream's buffer into  the byte array argument.

Parameters:

 b - the buffer into which the data is read.

 off - the start offset of the data.

 len - the maximum number of bytes read.

Returns:

 the total number of bytes read into the buffer, or  -1  if there is no more data because the end of  the stream has been reached.

Overrides:

read in class InputStream

 skip

  public synchronized long skip(long n)

 Skips n bytes of input from this input stream. Fewer  bytes might be skipped if the end of the input stream is reached.

Parameters:

 n - the number of bytes to be skipped.

Returns:

 the actual number of bytes skipped.

Overrides:

skip in class InputStream

 available

  public synchronized int available()

 Returns the number of bytes that can be read from the input  stream without blocking.

Returns:

 the value of count - pos, which is the  number of bytes remaining to be read from the input buffer.

Overrides:

available in class InputStream

 reset

  public synchronized void reset()

 Resets the input stream to begin reading from the first character  of this input stream's underlying buffer.

Overrides:

reset in class InputStream

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.StringReader

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.StringReader

java.lang.Object
   |
   +----java.io.Reader
           |
           +----java.io.StringReader

______________________________________________________________________________

 public class StringReader

 extends Reader

A character stream whose source is a string.

______________________________________________________________________________

 	StringReader(String)

 Create a new string reader.

 	close()

 Close the stream.

 	mark(int)

 Mark the present position in the stream.

 	markSupported()

 Tell whether this stream supports the mark() operation, which it does.

 	read()

 Read a single character.

 	read(char[], int, int)

 Read characters into a portion of an array.

 	ready()

 Tell whether this stream is ready to be read.

 	reset()

 Reset the stream to the most recent mark, or to the beginning of the  string if it has never been marked.

 	skip(long)

 Skip characters.

 StringReader

  public StringReader(String s)

 Create a new string reader.

 read

  public int read() throws IOException

 Read a single character.

Returns:

 The character read, or -1 if the end of the stream has been  reached

Throws: IOException

 If an I/O error occurs

Overrides:

read in class Reader

 read

  public int read(char cbuf[],
                  int off,
                  int len) throws IOException

 Read characters into a portion of an array.

Parameters:

 cbuf - Destination buffer

 off - Offset at which to start writing characters

 len - Maximum number of characters to read

Returns:

 The number of characters read, or -1 if the end of the  stream has been reached

Throws: IOException

 If an I/O error occurs

Overrides:

read in class Reader

 skip

  public long skip(long ns) throws IOException

 Skip characters.

Throws: IOException

 If an I/O error occurs

Overrides:

skip in class Reader

 ready

  public boolean ready()

 Tell whether this stream is ready to be read. String readers are  always ready to be read.

Overrides:

ready in class Reader

 markSupported

  public boolean markSupported()

 Tell whether this stream supports the mark() operation, which it does.

Overrides:

markSupported in class Reader

 mark

  public void mark(int readAheadLimit) throws IOException

 Mark the present position in the stream. Subsequent calls to reset()  will reposition the stream to this point.

Parameters:

 readAheadLimit - Limit on the number of characters that may be  read while still preserving the mark. Because  the stream's input comes from a string, there  is no actual limit, so this argument is ignored.

Throws: IOException

 If an I/O error occurs

Overrides:

mark in class Reader

 reset

  public void reset() throws IOException

 Reset the stream to the most recent mark, or to the beginning of the  string if it has never been marked.

Throws: IOException

 If an I/O error occurs

Overrides:

reset in class Reader

 close

  public void close()

 Close the stream.

Overrides:

close in class Reader

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.StringWriter

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.StringWriter

java.lang.Object
   |
   +----java.io.Writer
           |
           +----java.io.StringWriter

______________________________________________________________________________

 public class StringWriter

 extends Writer

A character stream that collects its output in a string buffer, which can  then be used to construct a string.

______________________________________________________________________________

 	StringWriter()

 Create a new string writer, using the default initial string-buffer  size.

 	StringWriter(int)

 Create a new string writer, using the specified initial string-buffer  size.

 	close()

 Close the stream.

 	flush()

 Flush the stream.

 	getBuffer()

 Return the string buffer itself.

 	toString()

 Return the buffer's current value as a string.

 	write(char[], int, int)

 Write a portion of an array of characters.

 	write(int)

 Write a single character.

 	write(String)

 Write a string.

 	write(String, int, int)

 Write a portion of a string.

 StringWriter

  public StringWriter()

 Create a new string writer, using the default initial string-buffer  size.

 StringWriter

  protected StringWriter(int initialSize)

 Create a new string writer, using the specified initial string-buffer  size.

 write

  public void write(int c)

 Write a single character.

Overrides:

write in class Writer

 write

  public void write(char cbuf[],
                    int off,
                    int len)

 Write a portion of an array of characters.

Parameters:

 cbuf - Array of characters

 off - Offset from which to start writing characters

 len - Number of characters to write

Overrides:

write in class Writer

 write

  public void write(String str)

 Write a string.

Overrides:

write in class Writer

 write

  public void write(String str,
                    int off,
                    int len)

 Write a portion of a string.

Parameters:

 str - String to be written

 off - Offset from which to start writing characters

 len - Number of characters to write

Overrides:

write in class Writer

 toString

  public String toString()

 Return the buffer's current value as a string.

Overrides:

toString in class Object

 getBuffer

  public StringBuffer getBuffer()

 Return the string buffer itself.

 flush

  public void flush()

 Flush the stream.

Overrides:

flush in class Writer

 close

  public void close()

 Close the stream. This method does not release the buffer, since its  contents might still be required.

Overrides:

close in class Writer

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.SyncFailedException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.SyncFailedException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.io.SyncFailedException

______________________________________________________________________________

 public class SyncFailedException

 extends IOException

______________________________________________________________________________

 	SyncFailedException(String)

 Constructs an SyncFailedException with a detail message.

 SyncFailedException

  public SyncFailedException(String desc)

 Constructs an SyncFailedException with a detail message.  A detail message is a String that describes this particular exception.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.UnsupportedEncodingException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.UnsupportedEncodingException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.io.UnsupportedEncodingException

______________________________________________________________________________

 public class UnsupportedEncodingException

 extends IOException

The Character Encoding is not supported

______________________________________________________________________________

 	UnsupportedEncodingException()

 no detailed message

 	UnsupportedEncodingException(String)

 detailed message

 UnsupportedEncodingException

  public UnsupportedEncodingException()

 no detailed message

 UnsupportedEncodingException

  public UnsupportedEncodingException(String s)

 detailed message

Parameters:

 s - - detailed message

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.UTFDataFormatException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.UTFDataFormatException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.io.UTFDataFormatException

______________________________________________________________________________

 public class UTFDataFormatException

 extends IOException

Signals that a malformed UTF-8 string has been read in a data  input stream or by any class that implements the data input  interface. See the writeUTF method for the format in  which UTF-8 strings are read and written.

See Also:

DataInput, readUTF, IOException

______________________________________________________________________________

 	UTFDataFormatException()

 Constructs a UTFDataFormatException with no detail  message.

 	UTFDataFormatException(String)

 Constructs a UTFDataFormatException with the  specified detail message.

 UTFDataFormatException

  public UTFDataFormatException()

 Constructs a UTFDataFormatException with no detail  message.

 UTFDataFormatException

  public UTFDataFormatException(String s)

 Constructs a UTFDataFormatException with the  specified detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.WriteAbortedException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.WriteAbortedException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.io.ObjectStreamException
                                   |
                                   +----java.io.WriteAbortedException

______________________________________________________________________________

 public class WriteAbortedException

 extends ObjectStreamException

______________________________________________________________________________

 	detail

 	WriteAbortedException(String, Exception)

 A WriteAbortedException is thrown during a read when one of the  ObjectStreamExceptions was thrown during writing.

 	getMessage()

 Produce the message, include the message from the nested  exception if there is one.

 detail

  public Exception detail

 WriteAbortedException

  public WriteAbortedException(String s,
                               Exception ex)

 A WriteAbortedException is thrown during a read when one of the  ObjectStreamExceptions was thrown during writing. The exception  that terminated the write can be found in the detail field.  The stream is reset to it's initial state, all references to  objects already deserialized are discarded.

 getMessage

  public String getMessage()

 Produce the message, include the message from the nested  exception if there is one.

Overrides:

getMessage in class Throwable

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.io.Writer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.io.Writer

java.lang.Object
   |
   +----java.io.Writer

______________________________________________________________________________

 public class Writer

 extends Object

Abstract class for writing to character streams. The only methods that a  subclass must implement are write(char[], int, int), flush(), and close().  Most subclasses, however, will override some of the methods defined here in  order to provide higher efficiency, additional functionality, or both.

See Also:

Writer, BufferedWriter, CharArrayWriter, FilterWriter, OutputStreamWriter, FileWriter, PipedWriter, PrintWriter, StringWriter, Reader

______________________________________________________________________________

 	lock

 The object used to synchronize operations on this stream.

 	Writer()

 Create a new character-stream writer whose critical sections will  synchronize on the writer itself.

 	Writer(Object)

 Create a new character-stream writer whose critical sections will  synchronize on the given object.

 	close()

 Close the stream, flushing it first.

 	flush()

 Flush the stream.

 	write(char[])

 Write an array of characters.

 	write(char[], int, int)

 Write a portion of an array of characters.

 	write(int)

 Write a single character.

 	write(String)

 Write a string.

 	write(String, int, int)

 Write a portion of a string.

 lock

  protected Object lock

 The object used to synchronize operations on this stream. For  efficiency, a character-stream object may use an object other than  itself to protect critical sections. A subclass should therefore use  the object in this field rather than this or a synchronized  method.

 Writer

  protected Writer()

 Create a new character-stream writer whose critical sections will  synchronize on the writer itself.

 Writer

  protected Writer(Object lock)

 Create a new character-stream writer whose critical sections will  synchronize on the given object.

 write

  public void write(int c) throws IOException

 Write a single character. The character to be written is contained in  the 16 low-order bits of the given integer value; the 16 high-order bits  are ignored.

 Subclasses that intend to support efficient single-character output  should override this method.

Throws: IOException

 If an I/O error occurs

 write

  public void write(char cbuf[]) throws IOException

 Write an array of characters.

Parameters:

 cbuf - Array of characters to be written

Throws: IOException

 If an I/O error occurs

 write

  public abstract void write(char cbuf[],
                             int off,
                             int len) throws IOException

 Write a portion of an array of characters.

Parameters:

 cbuf - Array of characters

 off - Offset from which to start writing characters

 len - Number of characters to write

Throws: IOException

 If an I/O error occurs

 write

  public void write(String str) throws IOException

 Write a string.

Parameters:

 str - String to be written

Throws: IOException

 If an I/O error occurs

 write

  public void write(String str,
                    int off,
                    int len) throws IOException

 Write a portion of a string.

Parameters:

 str - A String

 off - Offset from which to start writing characters

 len - Number of characters to write

Throws: IOException

 If an I/O error occurs

 flush

  public abstract void flush() throws IOException

 Flush the stream. If the stream has saved any characters from the  various write() methods in a buffer, write them immediately to their  intended destination. Then, if that destination is another character or  byte stream, flush it. Thus one flush() invocation will flush all the  buffers in a chain of Writers and OutputStreams.

Throws: IOException

 If an I/O error occurs

 close

  public abstract void close() throws IOException

 Close the stream, flushing it first. Once a stream has been closed,  further write() or flush() invocations will cause an IOException to be  thrown. Closing a previously-closed stream, however, has no effect.

Throws: IOException

 If an I/O error occurs

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.AbstractMethodError

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.AbstractMethodError

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Error
                   |
                   +----java.lang.LinkageError
                           |
                           +----java.lang.IncompatibleClassChangeError
                                   |
                                   +----java.lang.AbstractMethodError

______________________________________________________________________________

 public class AbstractMethodError

 extends IncompatibleClassChangeError

Thrown when an application tries to call an abstract method.  Normally, this error is caught by the compiler; this error can  only occur at run time if the definition of some class has  incompatibly changed since the currently executing method was last  compiled.

______________________________________________________________________________

 	AbstractMethodError()

 Constructs an AbstractMethodError with no detail message.

 	AbstractMethodError(String)

 Constructs an AbstractMethodError with the specified  detail message.

 AbstractMethodError

  public AbstractMethodError()

 Constructs an AbstractMethodError with no detail message.

 AbstractMethodError

  public AbstractMethodError(String s)

 Constructs an AbstractMethodError with the specified  detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.ArithmeticException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.ArithmeticException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.RuntimeException
                           |
                           +----java.lang.ArithmeticException

______________________________________________________________________________

 public class ArithmeticException

 extends RuntimeException

Thrown when an exceptional arithmetic condition has occurred. For  example, an integer "divide by zero" throws an  instance of this class.

______________________________________________________________________________

 	ArithmeticException()

 Constructs an ArithmeticException with no detail  message.

 	ArithmeticException(String)

 Constructs an ArithmeticException with the specified  detail message.

 ArithmeticException

  public ArithmeticException()

 Constructs an ArithmeticException with no detail  message.

 ArithmeticException

  public ArithmeticException(String s)

 Constructs an ArithmeticException with the specified  detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.ArrayIndexOutOfBoundsException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.ArrayIndexOutOfBoundsException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.RuntimeException
                           |
                           +----java.lang.IndexOutOfBoundsException
                                   |
                                   +----java.lang.ArrayIndexOutOfBoundsException

______________________________________________________________________________

 public class ArrayIndexOutOfBoundsException

 extends IndexOutOfBoundsException

Thrown to indicate that an array has been accessed with an  illegal index. The index is either negative or greater than or  equal to the size of the array.

______________________________________________________________________________

 	ArrayIndexOutOfBoundsException()

 Constructs an ArrayIndexOutOfBoundsException with no  detail message.

 	ArrayIndexOutOfBoundsException(int)

 Constructs a new ArrayIndexOutOfBoundsException  class with an argument indicating the illegal index.

 	ArrayIndexOutOfBoundsException(String)

 Constructs an ArrayIndexOutOfBoundsException class  with the specified detail message.

 ArrayIndexOutOfBoundsException

  public ArrayIndexOutOfBoundsException()

 Constructs an ArrayIndexOutOfBoundsException with no  detail message.

 ArrayIndexOutOfBoundsException

  public ArrayIndexOutOfBoundsException(int index)

 Constructs a new ArrayIndexOutOfBoundsException  class with an argument indicating the illegal index.

Parameters:

 index - the illegal index.

 ArrayIndexOutOfBoundsException

  public ArrayIndexOutOfBoundsException(String s)

 Constructs an ArrayIndexOutOfBoundsException class  with the specified detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.ArrayStoreException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.ArrayStoreException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.RuntimeException
                           |
                           +----java.lang.ArrayStoreException

______________________________________________________________________________

 public class ArrayStoreException

 extends RuntimeException

Thrown to indicate that an attempt has been made to store the  wrong type of object into an array of objects. For example, the  following code generates an ArrayStoreException:

     Object x[] = new String[3];
     x[0] = new Integer(0);

______________________________________________________________________________

 	ArrayStoreException()

 Constructs an ArrayStoreException with no detail message.

 	ArrayStoreException(String)

 Constructs an ArrayStoreException with the specified  detail message.

 ArrayStoreException

  public ArrayStoreException()

 Constructs an ArrayStoreException with no detail message.

 ArrayStoreException

  public ArrayStoreException(String s)

 Constructs an ArrayStoreException with the specified  detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.Boolean

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.Boolean

java.lang.Object
   |
   +----java.lang.Boolean

______________________________________________________________________________

 public final class Boolean

 extends Object

 implements Serializable

The Boolean class wraps a value of the primitive type  boolean  in an object. An object of type  Boolean contains a single field whose type is  boolean.

 In addition, this class provides many methods for  converting a boolean to a String and a  String to a boolean, as well as other  constants and methods useful when dealing with a  boolean.

______________________________________________________________________________

 	FALSE

 The Boolean object corresponding to the primitive  value false.

 	TRUE

 The Boolean object corresponding to the primitive  value true.

 	TYPE

 The Class object representing the primitive type boolean.

 	Boolean(boolean)

 Allocates a Boolean object representing the  value argument.

 	Boolean(String)

 Allocates a Boolean object representing the value  true  if the string argument is not null  and is equal, ignoring case, to the string "true".

 	booleanValue()

 Returns the value of this Boolean object as a boolean.

 	equals(Object)

 Returns true if and only if the argument is not  null and is a Boolean object that  contains the same boolean value as this object.

 	getBoolean(String)

 Returns is true if and only if the system property  named by the argument exists and is equal to the string  "true".

 	hashCode()

 Returns a hash code for this Boolean.

 	toString()

 Returns a String object representing this Boolean's value.

 	valueOf(String)

 Returns the boolean value represented by the specified String.

 TRUE

  public final static Boolean TRUE

 The Boolean object corresponding to the primitive  value true.

 FALSE

  public final static Boolean FALSE

 The Boolean object corresponding to the primitive  value false.

 TYPE

  public final static Class TYPE

 The Class object representing the primitive type boolean.

 Boolean

  public Boolean(boolean value)

 Allocates a Boolean object representing the  value argument.

Parameters:

 value - the value of the Boolean.

 Boolean

  public Boolean(String s)

 Allocates a Boolean object representing the value  true if the string argument is not null  and is equal, ignoring case, to the string "true".  Otherwise, allocate a Boolean object representing the  value false.

Parameters:

 s - the string to be converted to a Boolean.

 booleanValue

  public boolean booleanValue()

 Returns the value of this Boolean object as a boolean.

Returns:

 the primitive boolean value of this object.

 valueOf

  public static Boolean valueOf(String s)

 Returns the boolean value represented by the specified String.  A new Boolean object is constructed. This  Boolean contains the value true if the  string argument is not null and is equal, ignoring  case, to the string "true".

Parameters:

 s - a string.

Returns:

 the Boolean value represented by the string.

 toString

  public String toString()

 Returns a String object representing this Boolean's value.  If this object contains the value true, a string equal  to "true"  is returned. Otherwise, a string equal to  "false" is returned.

Returns:

 a string representation of this object.

Overrides:

toString in class Object

 hashCode

  public int hashCode()

 Returns a hash code for this Boolean.

Returns:

 a hash code value for this object.

Overrides:

hashCode in class Object

 equals

  public boolean equals(Object obj)

 Returns true if and only if the argument is not  null and is a Boolean object that  contains the same boolean  value as this object.

Parameters:

 obj - the object to compare with.

Returns:

true if the objects are the same;  false otherwise.

Overrides:

equals in class Object

 getBoolean

  public static boolean getBoolean(String name)

 Returns is true if and only if the system property  named by the argument exists and is equal to the string  "true" . (Beginning with Java 1.0.2, the test of  this string is case insensitive.) A system property is accessible  through getProperty , a method defined by the  System class.

Parameters:

 name - the system property name.

Returns:

 the boolean value of the system property.

See Also:

getProperty, getProperty

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.Byte

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.Byte

java.lang.Object
   |
   +----java.lang.Number
           |
           +----java.lang.Byte

______________________________________________________________________________

 public final class Byte

 extends Number

The Byte class is the standard wrapper for byte values.

See Also:

Number

______________________________________________________________________________

 	MAX_VALUE

 The maximum value a Byte can have.

 	MIN_VALUE

 The minimum value a Byte can have.

 	TYPE

 The Class object representing the primitive type byte.

 	Byte(byte)

 Constructs a Byte object initialized to the specified byte value.

 	Byte(String)

 Constructs a Byte object initialized to the value specified by the  String parameter.

 	byteValue()

 Returns the value of this Byte as a byte.

 	decode(String)

 Decodes a String into a Byte.

 	doubleValue()

 Returns the value of this Byte as a double.

 	equals(Object)

 Compares this object to the specified object.

 	floatValue()

 Returns the value of this Byte as a float.

 	hashCode()

 Returns a hashcode for this Byte.

 	intValue()

 Returns the value of this Byte as an int.

 	longValue()

 Returns the value of this Byte as a long.

 	parseByte(String)

 Assuming the specified String represents a byte, returns  that byte's value.

 	parseByte(String, int)

 Assuming the specified String represents a byte, returns  that byte's value.

 	shortValue()

 Returns the value of this Byte as a short.

 	toString()

 Returns a String object representing this Byte's value.

 	toString(byte)

 Returns a new String object representing the specified Byte.

 	valueOf(String)

 Assuming the specified String represents a byte, returns a  new Byte object initialized to that value.

 	valueOf(String, int)

 Assuming the specified String represents a byte, returns a  new Byte object initialized to that value.

 MIN_VALUE

  public final static byte MIN_VALUE

 The minimum value a Byte can have.

 MAX_VALUE

  public final static byte MAX_VALUE

 The maximum value a Byte can have.

 TYPE

  public final static Class TYPE

 The Class object representing the primitive type byte.

 Byte

  public Byte(byte value)

 Constructs a Byte object initialized to the specified byte value.

Parameters:

 value - the initial value of the Byte

 Byte

  public Byte(String s) throws NumberFormatException

 Constructs a Byte object initialized to the value specified by the  String parameter. The radix is assumed to be 10.

Parameters:

 s - the String to be converted to a Byte

Throws: NumberFormatException

 If the String does not 	contain a parsable byte.

 toString

  public static String toString(byte b)

 Returns a new String object representing the specified Byte. The radix  is assumed to be 10.

Parameters:

 b - the byte to be converted

 parseByte

  public static byte parseByte(String s) throws NumberFormatException

 Assuming the specified String represents a byte, returns  that byte's value. Throws an exception if the String cannot  be parsed as a byte. The radix is assumed to be 10.

Parameters:

 s - the String containing the byte

Throws: NumberFormatException

 If the string does not 	contain a parsable byte.

 parseByte

  public static byte parseByte(String s,
                               int radix) throws NumberFormatException

 Assuming the specified String represents a byte, returns  that byte's value. Throws an exception if the String cannot  be parsed as a byte.

Parameters:

 s - the String containing the byte

 radix - the radix to be used

Throws: NumberFormatException

 If the String does not 	contain a parsable byte.

 valueOf

  public static Byte valueOf(String s,
                             int radix) throws NumberFormatException

 Assuming the specified String represents a byte, returns a  new Byte object initialized to that value. Throws an  exception if the String cannot be parsed as a byte.

Parameters:

 s - the String containing the integer

 radix - the radix to be used

Throws: NumberFormatException

 If the String does not 	contain a parsable byte.

 valueOf

  public static Byte valueOf(String s) throws NumberFormatException

 Assuming the specified String represents a byte, returns a  new Byte object initialized to that value. Throws an  exception if the String cannot be parsed as a byte.  The radix is assumed to be 10.

Parameters:

 s - the String containing the integer

Throws: NumberFormatException

 If the String does not 	contain a parsable byte.

 decode

  public static Byte decode(String nm) throws NumberFormatException

 Decodes a String into a Byte. The String may represent  decimal, hexadecimal, and octal numbers.

Parameters:

 nm - the string to decode

 byteValue

  public byte byteValue()

 Returns the value of this Byte as a byte.

Overrides:

byteValue in class Number

 shortValue

  public short shortValue()

 Returns the value of this Byte as a short.

Overrides:

shortValue in class Number

 intValue

  public int intValue()

 Returns the value of this Byte as an int.

Overrides:

intValue in class Number

 longValue

  public long longValue()

 Returns the value of this Byte as a long.

Overrides:

longValue in class Number

 floatValue

  public float floatValue()

 Returns the value of this Byte as a float.

Overrides:

floatValue in class Number

 doubleValue

  public double doubleValue()

 Returns the value of this Byte as a double.

Overrides:

doubleValue in class Number

 toString

  public String toString()

 Returns a String object representing this Byte's value.

Overrides:

toString in class Object

 hashCode

  public int hashCode()

 Returns a hashcode for this Byte.

Overrides:

hashCode in class Object

 equals

  public boolean equals(Object obj)

 Compares this object to the specified object.

Parameters:

 obj - the object to compare with

Returns:

 true if the objects are the same; false otherwise.

Overrides:

equals in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.Character

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.Character

java.lang.Object
   |
   +----java.lang.Character

______________________________________________________________________________

 public final class Character

 extends Object

 implements Serializable

The Character class wraps a value of the primitive type char  in an object. An object of type Character contains a  single field whose type is char.

 In addition, this class provides several methods for determining  the type of a character and converting characters from uppercase  to lowercase and vice versa.

 Many of the methods of class Character are defined  in terms of a "Unicode attribute table" that specifies  a name for every defined Unicode code point. The table also  includes other attributes, such as a decimal value, an uppercase  equivalent, a lowercase equivalent, and/or a titlecase equivalent.  The Unicode attribute table is available on the World Wide Web as  the file:

  ftp://unicode.org/pub/MappingTables/UnicodeData1.1.5.txt

 For a more detailed specification of the Character  class, one that encompasses the exact behavior of methods such as  isDigit, isLetter,  isLowerCase, and isUpperCase over the  full range of Unicode values, see Gosling, Joy, and Steele, The  Java Language Specification.

______________________________________________________________________________

 	COMBINING_SPACING_MARK

  	CONNECTOR_PUNCTUATION

  	CONTROL

  	CURRENCY_SYMBOL

  	DASH_PUNCTUATION

  	DECIMAL_DIGIT_NUMBER

  	ENCLOSING_MARK

  	END_PUNCTUATION

  	FORMAT

  	LETTER_NUMBER

  	LINE_SEPARATOR

  	LOWERCASE_LETTER

  	MATH_SYMBOL

  	MAX_RADIX

 The maximum radix available for conversion to and from Strings.

 	MAX_VALUE

 The constant value of this field is the largest value of type  char.

 	MIN_RADIX

 The minimum radix available for conversion to and from Strings.

 	MIN_VALUE

 The constant value of this field is the smallest value of type  char.

 	MODIFIER_LETTER

  	MODIFIER_SYMBOL

  	NON_SPACING_MARK

  	OTHER_LETTER

  	OTHER_NUMBER

  	OTHER_PUNCTUATION

  	OTHER_SYMBOL

  	PARAGRAPH_SEPARATOR

  	PRIVATE_USE

  	SPACE_SEPARATOR

  	START_PUNCTUATION

  	SURROGATE

  	TITLECASE_LETTER

  	TYPE

 The Class object representing the primitive type char.

 	UNASSIGNED

  	UPPERCASE_LETTER

 	Character(char)

 Constructs a Character object and initializes it so  that it represents the primitive value argument.

 	charValue()

 Returns the value of this Character object.

 	digit(char, int)

 Returns the numeric value of the character ch in the  specified radix.

 	equals(Object)

 Compares this object against the specified object.

 	forDigit(int, int)

 Determines the character representation for a specific digit in  the specified radix.

 	getNumericValue(char)

 Returns the Unicode numeric value of the character as a  nonnegative integer.

 	getType(char)

 Returns a value indicating a character category.

 	hashCode()

 Returns a hash code for this Character.

 	isDefined(char)

 Determines if a character has a defined meaning in Unicode.

 	isDigit(char)

 Determines if the specified character is a digit.

 	isIdentifierIgnorable(char)

 Determines if the specified character should be regarded as  an ignorable character in a Java identifier or a Unicode identifier.

 	isISOControl(char)

 Determines if the specified character is an ISO control character.

 	isJavaIdentifierPart(char)

 Determines if the specified character may be part of a Java  identifier as other than the first character.

 	isJavaIdentifierStart(char)

 Determines if the specified character is  permissible as the first character in a Java identifier.

 	isJavaLetter(char)

 Determines if the specified character is a  "Java" letter, that is, the character is permissible  as the first character in an identifier in the Java language. Deprecated.

 	isJavaLetterOrDigit(char)

 Determines if the specified character is a  "Java" letter or digit, that is, the character is  permissible as a non-initial character in an identifier in the  Java language. Deprecated.

 	isLetter(char)

 Determines if the specified character is a letter.

 	isLetterOrDigit(char)

 Determines if the specified character is a letter or digit.

 	isLowerCase(char)

 Determines if the specified character is a lowercase character.

 	isSpace(char)

 Determines if the specified character is ISO-LATIN-1 white space. Deprecated.

 	isSpaceChar(char)

 Determines if the specified character is a Unicode space character.

 	isTitleCase(char)

 Determines if the specified character is a titlecase character.

 	isUnicodeIdentifierPart(char)

 Determines if the specified character may be part of a Unicode  identifier as other than the first character.

 	isUnicodeIdentifierStart(char)

 Determines if the specified character is  permissible as the first character in a Unicode identifier.

 	isUpperCase(char)

 Determines if the specified character is an uppercase character.

 	isWhitespace(char)

 Determines if the specified character is white space according to Java.

 	toLowerCase(char)

 The given character is mapped to its lowercase equivalent; if the  character has no lowercase equivalent, the character itself is  returned.

 	toString()

 Returns a String object representing this character's value.

 	toTitleCase(char)

 Converts the character argument to titlecase.

 	toUpperCase(char)

 Converts the character argument to uppercase.

 MIN_RADIX

  public final static int MIN_RADIX

 The minimum radix available for conversion to and from Strings.  The constant value of this field is the smallest value permitted  for the radix argument in radix-conversion methods such as the  digit method, the forDigit  method, and the toString method of class  Integer.

See Also:

digit, forDigit, toString, valueOf

 MAX_RADIX

  public final static int MAX_RADIX

 The maximum radix available for conversion to and from Strings.  The constant value of this field is the largest value permitted  for the radix argument in radix-conversion methods such as the  digit method, the forDigit  method, and the toString method of class  Integer.

See Also:

digit, forDigit, toString, valueOf

 MIN_VALUE

  public final static char MIN_VALUE

 The constant value of this field is the smallest value of type  char.

 MAX_VALUE

  public final static char MAX_VALUE

 The constant value of this field is the largest value of type  char.

 TYPE

  public final static Class TYPE

 The Class object representing the primitive type char.

 UNASSIGNED

  public final static byte UNASSIGNED

 UPPERCASE_LETTER

  public final static byte UPPERCASE_LETTER

 LOWERCASE_LETTER

  public final static byte LOWERCASE_LETTER

 TITLECASE_LETTER

  public final static byte TITLECASE_LETTER

 MODIFIER_LETTER

  public final static byte MODIFIER_LETTER

 OTHER_LETTER

  public final static byte OTHER_LETTER

 NON_SPACING_MARK

  public final static byte NON_SPACING_MARK

 ENCLOSING_MARK

  public final static byte ENCLOSING_MARK

 COMBINING_SPACING_MARK

  public final static byte COMBINING_SPACING_MARK

 DECIMAL_DIGIT_NUMBER

  public final static byte DECIMAL_DIGIT_NUMBER

 LETTER_NUMBER

  public final static byte LETTER_NUMBER

 OTHER_NUMBER

  public final static byte OTHER_NUMBER

 SPACE_SEPARATOR

  public final static byte SPACE_SEPARATOR

 LINE_SEPARATOR

  public final static byte LINE_SEPARATOR

 PARAGRAPH_SEPARATOR

  public final static byte PARAGRAPH_SEPARATOR

 CONTROL

  public final static byte CONTROL

 FORMAT

  public final static byte FORMAT

 PRIVATE_USE

  public final static byte PRIVATE_USE

 SURROGATE

  public final static byte SURROGATE

 DASH_PUNCTUATION

  public final static byte DASH_PUNCTUATION

 START_PUNCTUATION

  public final static byte START_PUNCTUATION

 END_PUNCTUATION

  public final static byte END_PUNCTUATION

 CONNECTOR_PUNCTUATION

  public final static byte CONNECTOR_PUNCTUATION

 OTHER_PUNCTUATION

  public final static byte OTHER_PUNCTUATION

 MATH_SYMBOL

  public final static byte MATH_SYMBOL

 CURRENCY_SYMBOL

  public final static byte CURRENCY_SYMBOL

 MODIFIER_SYMBOL

  public final static byte MODIFIER_SYMBOL

 OTHER_SYMBOL

  public final static byte OTHER_SYMBOL

 Character

  public Character(char value)

 Constructs a Character object and initializes it so  that it represents the primitive value argument.

Parameters:

 value - value for the new Character object.

 charValue

  public char charValue()

 Returns the value of this Character object.

Returns:

 the primitive char value represented by  this object.

 hashCode

  public int hashCode()

 Returns a hash code for this Character.

Returns:

 a hash code value for this object.

Overrides:

hashCode in class Object

 equals

  public boolean equals(Object obj)

 Compares this object against the specified object.  The result is true if and only if the argument is not  null and is a Character  object that  represents the same char value as this object.

Parameters:

 obj - the object to compare with.

Returns:

true if the objects are the same;  false otherwise.

Overrides:

equals in class Object

 toString

  public String toString()

 Returns a String object representing this character's value.  Converts this Character object to a string. The  result is a string whose length is 1. The string's  sole component is the primitive char value represented  by this object.

Returns:

 a string representation of this object.

Overrides:

toString in class Object

 isLowerCase

  public static boolean isLowerCase(char ch)

 Determines if the specified character is a lowercase character.  A character is lowercase if it is not in the range  '\u2000' through '\u2FFF', the Unicode  attribute table does not specify a mapping to lowercase for the  character, and at least one of the following is true:

• The attribute table specifies a mapping to uppercase for the  character.

• The name for the character contains the words "SMALL  LETTER".

• The name for the character contains the words "SMALL  LIGATURE".

 A character is considered to be lowercase if and only if  it is specified to be lowercase by the Unicode 2.0 standard  (category "Ll" in the Unicode specification data file).

 Of the ISO-LATIN-1 characters (character codes 0x0000 through 0x00FF),  the following are lowercase:

 a b c d e f g h i j k l m n o p q r s t u v w x y z
 \u00DF \u00E0 \u00E1 \u00E2 \u00E3 \u00E4 \u00E5 \u00E6 \u00E7
 \u00E8 \u00E9 \u00EA \u00EB \u00EC \u00ED \u00EE \u00EF \u00F0
 \u00F1 \u00F2 \u00F3 \u00F4 \u00F5 \u00F6 \u00F8 \u00F9 \u00FA
 \u00FB \u00FC \u00FD \u00FE \u00FF

 Many other Unicode characters are lowercase, too.

Parameters:

 ch - the character to be tested.

Returns:

true if the character is lowercase;  false otherwise.

See Also:

isLowerCase, isTitleCase, toLowerCase

 isUpperCase

  public static boolean isUpperCase(char ch)

 Determines if the specified character is an uppercase character.  A character is uppercase if it is not in the range  '\u2000' through '\u2FFF', the Unicode  attribute table does not specify a mapping to uppercase for the  character, and at least one of the following is true:

• The attribute table specifies a mapping to lowercase for the   character.

• The name for the character contains the words  "CAPITAL LETTER".

• The name for the character contains the words  "CAPITAL LIGATURE".

 Of the ISO-LATIN-1 characters (character codes 0x0000 through 0x00FF),  the following are uppercase:

 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
 \u00C0 \u00C1 \u00C2 \u00C3 \u00C4 \u00C5 \u00C6 \u00C7
 \u00C8 \u00C9 \u00CA \u00CB \u00CC \u00CD \u00CE \u00CF \u00D0
 \u00D1 \u00D2 \u00D3 \u00D4 \u00D5 \u00D6 \u00D8 \u00D9 \u00DA
 \u00DB \u00DC \u00DD \u00DE

 Many other Unicode characters are uppercase, too.

Parameters:

 ch - the character to be tested.

Returns:

true if the character is uppercase;  false otherwise.

See Also:

isLowerCase, isTitleCase, toUpperCase

 isTitleCase

  public static boolean isTitleCase(char ch)

 Determines if the specified character is a titlecase character.  A character is considered to be titlecase if and only if  it is specified to be titlecase by the Unicode 2.0 standard  (category "Lt" in the Unicode specification data file).

 The printed representations of four Unicode characters look like  pairs of Latin letters. For example, there is an uppercase letter  that looks like "LJ" and has a corresponding lowercase letter that  looks like "lj". A third form, which looks like "Lj",  is the appropriate form to use when rendering a word in lowercase  with initial capitals, as for a book title.

 These are the Unicode characters for which this method returns  true:

• LATIN CAPITAL LETTER D WITH SMALL LETTER Z WITH CARON

• LATIN CAPITAL LETTER L WITH SMALL LETTER J

• LATIN CAPITAL LETTER N WITH SMALL LETTER J

• LATIN CAPITAL LETTER D WITH SMALL LETTER Z

Parameters:

 ch - the character to be tested.

Returns:

true if the character is titlecase;  false otherwise.

See Also:

isLowerCase, isUpperCase, toTitleCase

 isDigit

  public static boolean isDigit(char ch)

 Determines if the specified character is a digit.  A character is considered to be a digit if it is not in the range  '\u2000' <= ch <= '\u2FFF'  and its Unicode name contains the word  "DIGIT ". For a more complete  specification that encompasses all Unicode characters that are  defined as digits, see Gosling, Joy, and Steele, The Java  Language Specification.

 These are the ranges of Unicode characters that are considered digits:

0x0030 through 0x0039
ISO-LATIN-1 digits ('0' through '9')
0x0660 through 0x0669
Arabic-Indic digits
0x06F0 through 0x06F9
Extended Arabic-Indic digits
0x0966 through 0x096F
Devanagari digits
0x09E6 through 0x09EF
Bengali digits
0x0A66 through 0x0A6F
Gurmukhi digits
0x0AE6 through 0x0AEF
Gujarati digits
0x0B66 through 0x0B6F
Oriya digits
0x0BE7 through 0x0BEF
Tamil digits
0x0C66 through 0x0C6F
Telugu digits
0x0CE6 through 0x0CEF
Kannada digits
0x0D66 through 0x0D6F
Malayalam digits
0x0E50 through 0x0E59
Thai digits
0x0ED0 through 0x0ED9
Lao digits
0x0F20 through 0x0F29
Tibetan digits
0xFF10 through 0xFF19
Fullwidth digits
Parameters:

 ch - the character to be tested.

Returns:

true if the character is a digit;  false otherwise.

See Also:

digit, forDigit

 isDefined

  public static boolean isDefined(char ch)

 Determines if a character has a defined meaning in Unicode.  A character is defined if at least one of the following is true:

• It has an entry in the Unicode attribute table.

• Its value is in the range    '\u3040' <= ch <= '\u9FA5'.

• Its value is in the range    '\uF900' <= ch <= '\uFA2D'.

Parameters:

 ch - the character to be tested

Returns:

true if the character has a defined meaning  in Unicode; false otherwise.

See Also:

isDigit, isLetter, isLetterOrDigit, isLowerCase, isTitleCase, isUpperCase

 isLetter

  public static boolean isLetter(char ch)

 Determines if the specified character is a letter. For a  more complete specification that encompasses all Unicode  characters, see Gosling, Joy, and Steele, The Java Language  Specification.

 A character is considered to be a letter if and only if  it is specified to be a letter by the Unicode 2.0 standard  (category "Lu", "Ll", "Lt", "Lm", or "Lo" in the Unicode  specification data file).

 Note that most ideographic characters are considered  to be letters (category "Lo") for this purpose.

 Note also that not all letters have case: many Unicode characters are  letters but are neither uppercase nor lowercase nor titlecase.

Parameters:

 ch - the character to be tested.

Returns:

true if the character is a letter;  false otherwise.

See Also:

isDigit, isJavaIdentifierStart, isJavaLetter, isJavaLetterOrDigit , isLetterOrDigit, isLowerCase, isTitleCase, isUnicodeIdentifierStart, isUpperCase

 isLetterOrDigit

  public static boolean isLetterOrDigit(char ch)

 Determines if the specified character is a letter or digit.  For a more complete specification that encompasses all Unicode  characters, see Gosling, Joy, and Steele, The Java Language  Specification.

 A character is considered to be a letter if and only if  it is specified to be a letter or a digit by the Unicode 2.0 standard  (category "Lu", "Ll", "Lt", "Lm", "Lo", or "Nd" in the Unicode  specification data file). In other words, isLetterOrDigit is true  of a character if and only if either isLetter is true of the character  or isDigit is true of the character.

Parameters:

 ch - the character to be tested.

Returns:

true if the character is a letter or digit;  false otherwise.

See Also:

isDigit, isJavaIdentifierPart, isJavaLetter, isJavaLetterOrDigit , isLetter, isUnicodeIdentifierPart

 isJavaLetter

  public static boolean isJavaLetter(char ch)

 Note: isJavaLetter() is deprecated. Replaced by isJavaIdentifierStart(char).

 Determines if the specified character is a  "Java" letter, that is, the character is permissible  as the first character in an identifier in the Java language.

 A character is considered to be a Java letter if and only if it  is a letter, the ASCII dollar sign character '$', or  the underscore character '_'.

Parameters:

 ch - the character to be tested.

Returns:

true if the character is a Java letter;  false otherwise.

See Also:

isJavaIdentifierStart, isJavaLetterOrDigit, isLetter, isLetterOrDigit, isUnicodeIdentifierStart

 isJavaLetterOrDigit

  public static boolean isJavaLetterOrDigit(char ch)

 Note: isJavaLetterOrDigit() is deprecated. Replaced by isJavaIdentifierPart(char).

 Determines if the specified character is a  "Java" letter or digit, that is, the character is  permissible as a non-initial character in an identifier in the  Java language.

 A character is considered to be a Java letter or digit if and  only if it is a letter, a digit, the ASCII dollar sign character  '$' , or the underscore character '_'.

Parameters:

 ch - the character to be tested.

Returns:

true if the character is a Java letter or digit;  false otherwise.

See Also:

isJavaIdentifierPart, isJavaLetter, isLetter, isLetterOrDigit , isUnicodeIdentifierPart

 isJavaIdentifierStart

  public static boolean isJavaIdentifierStart(char ch)

 Determines if the specified character is  permissible as the first character in a Java identifier.  A character may start a Java identifier if and only if  it is one of the following:

•  a letter

•  a currency symbol (such as "$")

•  a connecting punctuation character (such as "_").

Parameters:

 ch - the character to be tested.

Returns:

 true if the character may start a Java identifier;  false otherwise.

See Also:

isJavaIdentifierPart, isLetter, isUnicodeIdentifierStart

 isJavaIdentifierPart

  public static boolean isJavaIdentifierPart(char ch)

 Determines if the specified character may be part of a Java  identifier as other than the first character.  A character may be part of a Java identifier if and only if  it is one of the following:

•  a letter

•  a currency symbol (such as "$")

•  a connecting punctuation character (such as "_").

•  a digit

•  a numeric letter (such as a Roman numeral character)

•  a combining mark

•  a non-spacing mark

•  an ignorable control character

Parameters:

 ch - the character to be tested.

Returns:

 true if the character may be part of a Unicode identifier;  false otherwise.

See Also:

isIdentifierIgnorable, isJavaIdentifierStart, isLetterOrDigit, isUnicodeIdentifierPart

 isUnicodeIdentifierStart

  public static boolean isUnicodeIdentifierStart(char ch)

 Determines if the specified character is  permissible as the first character in a Unicode identifier.  A character may start a Unicode identifier if and only if  it is a letter.

Parameters:

 ch - the character to be tested.

Returns:

 true if the character may start a Unicode identifier;  false otherwise.

See Also:

isJavaIdentifierStart, isLetter, isUnicodeIdentifierPart

 isUnicodeIdentifierPart

  public static boolean isUnicodeIdentifierPart(char ch)

 Determines if the specified character may be part of a Unicode  identifier as other than the first character.  A character may be part of a Unicode identifier if and only if  it is one of the following:

•  a letter

•  a connecting punctuation character (such as "_").

•  a digit

•  a numeric letter (such as a Roman numeral character)

•  a combining mark

•  a non-spacing mark

•  an ignorable control character

Parameters:

 ch - the character to be tested.

Returns:

 true if the character may be part of a Unicode identifier;  false otherwise.

See Also:

isIdentifierIgnorable, isJavaIdentifierPart, isLetterOrDigit, isUnicodeIdentifierStart

 isIdentifierIgnorable

  public static boolean isIdentifierIgnorable(char ch)

 Determines if the specified character should be regarded as  an ignorable character in a Java identifier or a Unicode identifier.  The following Unicode characters are ignorable in a Java identifier  or a Unicode identifier:

0x0000 through 0x0008,
ISO control characters that
0x000E through 0x001B,
are not whitespace
and 0x007F through 0x009F
0x200C through 0x200F
join controls
0x200A through 0x200E
bidirectional controls
0x206A through 0x206F
format controls
0xFEFF
zero-width no-break space
Parameters:

 ch - the character to be tested.

Returns:

 true if the character may be part of a Unicode identifier;  false otherwise.

See Also:

isJavaIdentifierPart, isUnicodeIdentifierPart

 toLowerCase

  public static char toLowerCase(char ch)

 The given character is mapped to its lowercase equivalent; if the  character has no lowercase equivalent, the character itself is  returned.

 A character has a lowercase equivalent if and only if a lowercase  mapping is specified for the character in the Unicode attribute  table.

 Note that some Unicode characters in the range  '\u2000' to '\u2FFF'  have lowercase  mappings; this method does map such characters to their lowercase  equivalents even though the method isUpperCase does  not return true  for such characters.

Parameters:

 ch - the character to be converted.

Returns:

 the lowercase equivalent of the character, if any;  otherwise the character itself.

See Also:

isLowerCase, isUpperCase, toTitleCase, toUpperCase

 toUpperCase

  public static char toUpperCase(char ch)

 Converts the character argument to uppercase. A character has an  uppercase equivalent if and only if an uppercase mapping is  specified for the character in the Unicode attribute table.

 Note that some Unicode characters in the range  '\u2000' to '\u2000FFF'  have uppercase  mappings; this method does map such characters to their titlecase  equivalents even though the method isLowerCase does  not return true  for such characters.

Parameters:

 ch - the character to be converted.

Returns:

 the uppercase equivalent of the character, if any;  otherwise the character itself.

See Also:

isLowerCase, isUpperCase, toLowerCase, toTitleCase

 toTitleCase

  public static char toTitleCase(char ch)

 Converts the character argument to titlecase. A character has a  titlecase equivalent if and only if a titlecase mapping is  specified for the character in the Unicode attribute table.

 Note that some Unicode characters in the range  '\u2000' through '\u2FFF'  have titlecase  mappings; this method does map such characters to their titlecase  equivalents even though the method isTitleCase does  not return true  for such characters.

 There are only four Unicode characters that are truly titlecase forms  that are distinct from uppercase forms. As a rule, if a character has no  true titlecase equivalent but does have an uppercase mapping, then the  Unicode 2.0 attribute table specifies a titlecase mapping that is the  same as the uppercase mapping.

Parameters:

 ch - the character to be converted.

Returns:

 the titlecase equivalent of the character, if any;  otherwise the character itself.

See Also:

isTitleCase, toLowerCase, toUpperCase

 digit

  public static int digit(char ch,
                          int radix)

 Returns the numeric value of the character ch in the  specified radix.

 If the radix is not in the range MIN_RADIX <=  radix <= MAX_RADIX or if the  value of ch is not a valid digit in the specified  radix, -1 is returned. A character is a valid digit  if at least one of the following is true:

• The method isDigit is true of the character  and the Unicode decimal digit value of the character (or its  single-character decomposition) is less than the specified radix.  In this case the decimal digit value is returned.

• The character is one of the uppercase Latin letters  'A' through 'Z' and its code is less than  radix + 'A' - 10.  In this case, ch - 'A' + 10  is returned.

• The character is one of the lowercase Latin letters  'a' through 'z' and its code is less than  radix + 'a' - 10.  In this case, ch - 'a' + 10  is returned.

Parameters:

 ch - the character to be converted.

 radix - the radix.

Returns:

 the numeric value represented by the character in the  specified radix.

See Also:

forDigit, isDigit

 getNumericValue

  public static int getNumericValue(char ch)

 Returns the Unicode numeric value of the character as a  nonnegative integer.  If the character does not have a numeric value, then -1 is returned.  If the character has a numeric value that cannot be represented as a  nonnegative integer (for example, a fractional value), then -2  is returned.

Parameters:

 ch - the character to be converted.

 radix - the radix.

Returns:

 the numeric value of the character, as a nonnegative int value;  -2 if the character has a numeric value that is not a  nonnegative integer; -1 if the character has no numeric value.

See Also:

forDigit, isDigit

 isSpace

  public static boolean isSpace(char ch)

 Note: isSpace() is deprecated. Replaced by isWhitespace(char).

 Determines if the specified character is ISO-LATIN-1 white space.  This method returns true for the following five  characters only:

'\t'
\u0009
HORIZONTAL TABULATION
'\n'
\u000A
NEW LINE
'\f'
\u000C
FORM FEED
'\r'
\u000D
CARRIAGE RETURN
' '
\u0020
SPACE
Parameters:

 ch - the character to be tested.

Returns:

true if the character is ISO-LATIN-1 white  space; false otherwise.

See Also:

isSpaceChar, isWhitespace

 isSpaceChar

  public static boolean isSpaceChar(char ch)

 Determines if the specified character is a Unicode space character.  A character is considered to be a space character if and only if  it is specified to be a space character by the Unicode 2.0 standard  (category "Zs", "Zl, or "Zp" in the Unicode specification data file).

Parameters:

 ch - the character to be tested.

Returns:

 true if the character is a space character; false otherwise.

See Also:

isWhitespace

 isWhitespace

  public static boolean isWhitespace(char ch)

 Determines if the specified character is white space according to Java.   A character is considered to be a Java whitespace character if and only  if it satisfies one of the following criteria:

•  It is a Unicode space separator (category "Zs"), but is not   a no-break space (\u00A0 or \uFEFF).

•  It is a Unicode line separator (category "Zl").

•  It is a Unicode paragraph separator (category "Zp").

•  It is \u0009, HORIZONTAL TABULATION.

•  It is \u000A, LINE FEED.

•  It is \u000B, VERTICAL TABULATION.

•  It is \u000C, FORM FEED.

•  It is \u000D, CARRIAGE RETURN.

•  It is \u001C, FILE SEPARATOR.

•  It is \u001D, GROUP SEPARATOR.

•  It is \u001E, RECORD SEPARATOR.

•  It is \u001F, UNIT SEPARATOR.

Parameters:

 ch - the character to be tested.

Returns:

 true if the character is a Java whitespace character;  false otherwise.

See Also:

isSpaceChar

 isISOControl

  public static boolean isISOControl(char ch)

 Determines if the specified character is an ISO control character.  A character is considered to be an ISO control character if its  code is in the range \u0000 through \u001F or in the range  \u007F through \u009F.

Parameters:

 ch - the character to be tested.

Returns:

 true if the character is an ISO control character;  false otherwise.

See Also:

isSpaceChar, isWhitespace

 getType

  public static int getType(char ch)

 Returns a value indicating a character category.

Parameters:

 ch - the character to be tested.

Returns:

 a value of type int, the character category.

See Also:

COMBINING_SPACING_MARK, CONNECTOR_PUNCTUATION, CONTROL, CURRENCY_SYMBOL, DASH_PUNCTUATION, DECIMAL_DIGIT_NUMBER, ENCLOSING_MARK, END_PUNCTUATION, FORMAT, LETTER_NUMBER , LINE_SEPARATOR, LOWERCASE_LETTER, MATH_SYMBOL, MODIFIER_LETTER , MODIFIER_SYMBOL, NON_SPACING_MARK, OTHER_LETTER, OTHER_NUMBER , OTHER_PUNCTUATION, OTHER_SYMBOL, PARAGRAPH_SEPARATOR, PRIVATE_USE, SPACE_SEPARATOR, START_PUNCTUATION, SURROGATE , TITLECASE_LETTER, UNASSIGNED, UPPERCASE_LETTER

 forDigit

  public static char forDigit(int digit,
                              int radix)

 Determines the character representation for a specific digit in  the specified radix. If the value of radix is not a  valid radix, or the value of digit is not a valid  digit in the specified radix, the null character  ('\u0000') is returned.

 The radix argument is valid if it is greater than or  equal to MIN_RADIX  and less than or equal to  MAX_RADIX. The digit argument is valid if  0 <= digit <= radix.

 If the digit is less than 10, then  '0' + digit is returned. Otherwise, the value  'a' + digit - 10 is returned.

Parameters:

 digit - the number to convert to a character.

 radix - the radix.

Returns:

 the char representation of the specified digit  in the specified radix.

See Also:

MIN_RADIX, MAX_RADIX, digit

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.Class

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.Class

java.lang.Object
   |
   +----java.lang.Class

______________________________________________________________________________

 public final class Class

 extends Object

 implements Serializable

Instances of the class Class represent classes and  interfaces in a running Java application.  Every array also belongs to a class that is reflected as a Class  object that is shared by all arrays with the same element type and  number of dimensions. Finally, the either primitive Java types  (boolean, byte, char, short, int, long, float, and double) and  the keyword void are also represented as Class objects.

 There is no public constructor for the class Class.  Class  objects are constructed automatically by the Java  Virtual Machine as classes are loaded and by calls to the  defineClass  method in the class loader.

 The following example uses a Class object to print the Class name  of an object:

     void printClassName(Object obj) {
         System.out.println("The class of " + obj +
                            " is " + obj.getClass().getName());
     }

See Also:

defineClass

______________________________________________________________________________

 	forName(String)

 Returns the Class object associated with the class  with the given string name.

 	getClasses()

 Returns an array containing Class objects representing all the  public classes and interfaces that are members of the class  represented by this Class object.

 	getClassLoader()

 Determines the class loader for the class.

 	getComponentType()

 If this class represents an array type, returns the Class  object representing the component type of the array; otherwise  returns null.

 	getConstructor(Class[])

 Returns a Constructor object that reflects the specified public  constructor of the class represented by this Class object.

 	getConstructors()

 Returns an array containing Constructor objects reflecting  all the public constructors of the class represented by this  Class object.

 	getDeclaredClasses()

 Returns an array of Class objects reflecting all the classes  and interfaces declared as members of the class represented by  this Class object.

 	getDeclaredConstructor(Class[])

 Returns a Constructor object that reflects the specified declared  constructor of the class or interface represented by this Class  object.

 	getDeclaredConstructors()

 Returns an array of Constructor objects reflecting all the  constructors declared by the class represented by this Class  object.

 	getDeclaredField(String)

 Returns a Field object that reflects the specified declared  field of the class or interface represented by this Class  object.

 	getDeclaredFields()

 Returns an array of Field objects reflecting all the fields  declared by the class or interface represented by this Class  object.

 	getDeclaredMethod(String, Class[])

 Returns a Method object that reflects the specified declared  method of the class or interface represented by this Class  object.

 	getDeclaredMethods()

 Returns an array of Method objects reflecting all the methods  declared by the class or interface represented by this Class  object.

 	getDeclaringClass()

 If the class or interface represented by this Class object is  a member of another class, returns the Class object  representing the class of which it is a member (its  declaring class).

 	getField(String)

 Returns a Field object that reflects the specified public  member field of the class or interface represented by  this Class object.

 	getFields()

 Returns an array containing Field objects reflecting all the  accessible public fields of the class or interface represented  by this Class object.

 	getInterfaces()

 Determines the interfaces implemented by the class or interface  represented by this object.

 	getMethod(String, Class[])

 Returns a Method object that reflects the specified public  member method of the class or interface represented by this  Class object.

 	getMethods()

 Returns an array containing Method objects reflecting all the  public member  methods of the class or interface  represented by this Class object, including those declared by  the class or interface and and those inherited from  superclasses and superinterfaces.

 	getModifiers()

 Returns the Java language modifiers for this class or  interface, encoded in an integer.

 	getName()

 Returns the fully-qualified name of the type (class, interface,  array, or primitive) represented by this Class object, as a String.

 	getResource(String)

  	getResourceAsStream(String)

 Find a resource with a given name.

 	getSigners()

 Get the signers of this class.

 	getSuperclass()

 If this object represents any class other than the class  Object , then the object that represents the superclass  of that class is returned.

 	isArray()

 If this Class object represents an array type, returns true,  otherwise returns false.

 	isAssignableFrom(Class)

 Determines if the class or interface  represented by this Class object is either the same as, or is a  superclass or superinterface of, the class or interface  represented by the specified Class parameter.

 	isInstance(Object)

 This method is the dynamic equivalent of the Java language  instanceof operator.

 	isInterface()

 Determines if the specified Class object represents an interface type.

 	isPrimitive()

 Determines if the specified Class object represents a primitive Java  type.

 	newInstance()

 Creates a new instance of a class.

 	toString()

 Converts the object to a string.

 toString

  public String toString()

 Converts the object to a string. The string representation is the  string "class" or "interface" followed  by a space and then the fully qualified name of the class.  If this Class object represents a primitive type,  returns the name of the primitive type.

Returns:

 a string representation of this class object.

Overrides:

toString in class Object

 forName

  public static Class forName(String className) throws ClassNotFoundException

 Returns the Class object associated with the class  with the given string name.  Given the fully-qualified name for a class or interface, this  method attempts to locate, load and link the class. If it  succeeds, returns the Class object representing the class. If  it fails, the method throws a ClassNotFoundException.

 For example, the following code fragment returns the runtime  Class  descriptor for the class named  java.lang.Thread:

  Class t = Class.forName("java.lang.Thread")

Parameters:

 className - the fully qualified name of the desired class.

Returns:

 the Class descriptor for the class with the  specified name.

Throws: ClassNotFoundException

 if the class could not be found.

 newInstance

  public Object newInstance() throws InstantiationException, IllegalAccessException

 Creates a new instance of a class.

Returns:

 a newly allocated instance of the class represented by this  object. This is done exactly as if by a new  expression with an empty argument list.

Throws: IllegalAccessException

 if the class or initializer is  not accessible.

Throws: InstantiationException

 if an application tries to  instantiate an abstract class or an interface, or if the  instantiation fails for some other reason.

 isInstance

  public boolean isInstance(Object obj)

 This method is the dynamic equivalent of the Java language  instanceof operator. The method returns true if  the specified Object argument is non-null and can be cast to  the reference type represented by this Class object without  raising a ClassCastException. It returns false otherwise.

Specifically, if this Class object represents a declared  class, returns true if the specified Object argument is an  instance of the represented class (or of any of its  subclasses); false otherwise. If this Class object represents  an array class, returns true if the specified Object argument  can be converted to an object of the array type by an identity  conversion or by a widening reference conversion; false  otherwise. If this Class object represents an interface,  returns true if the class or any superclass of the  specified Object argument implements this interface; false  otherwise. If this Class object represents a primitive type,  returns false.

Parameters:

 obj - The object to check

 isAssignableFrom

  public boolean isAssignableFrom(Class cls)

 Determines if the class or interface  represented by this Class object is either the same as, or is a  superclass or superinterface of, the class or interface  represented by the specified Class parameter. It returns true  if so, false otherwise. If this Class object represents a  primitive type, returns true if the specified Class parameter  is exactly this Class object, false otherwise.

Specifically, this method tests whether the type represented  by the specified Class parameter can be converted to the type  represented by this Class object via an identity conversion or  via a widening reference conversion. See The Java Language  Specification , sections 5.1.1 and 5.1.4 , for details.

Throws: NullPointerException

 if the specified Class parameter is null.

 isInterface

  public boolean isInterface()

 Determines if the specified Class object represents an interface type.

Returns:

true if this object represents an interface;  false otherwise.

 isArray

  public boolean isArray()

 If this Class object represents an array type, returns true,  otherwise returns false.

 isPrimitive

  public boolean isPrimitive()

 Determines if the specified Class object represents a primitive Java  type.

There are nine predefined Class objects to represent the eight  primitive Java types and void. These are created by the Java  Virtual Machine, and have the same names as the primitive types  that they represent, namely boolean, byte, char, short, int,  long, float, and double, and void.

These objects may only be accessed via the following public  static final variables, and are the only Class objects for  which this method returns true.

See Also:

TYPE, TYPE, TYPE, TYPE, TYPE, TYPE , TYPE, TYPE, TYPE

 getName

  public String getName()

 Returns the fully-qualified name of the type (class, interface,  array, or primitive) represented by this Class object, as a String.

Returns:

 the fully qualified name of the class or interface  represented by this object.

 getClassLoader

  public ClassLoader getClassLoader()

 Determines the class loader for the class.

Returns:

 the class loader that created the class or interface  represented by this object, or null if the  class was not created by a class loader.

See Also:

ClassLoader

 getSuperclass

  public Class getSuperclass()

 If this object represents any class other than the class  Object , then the object that represents the superclass  of that class is returned.

 If this object is the one that represents the class  Object  or this object represents an interface,  null is returned.

Returns:

 the superclass of the class represented by this object.

 getInterfaces

  public Class[] getInterfaces()

 Determines the interfaces implemented by the class or interface  represented by this object.

 If this object represents a class, the return value is an array  containing objects representing all interfaces implemented by the  class. The order of the interface objects in the array corresponds  to the order of the interface names in the implements  clause of the declaration of the class represented by this object.

 If this object represents an interface, the array contains  objects representing all interfaces extended by the interface. The  order of the interface objects in the array corresponds to the  order of the interface names in the extends clause of  the declaration of the interface represented by this object.

 If the class or interface implements no interfaces, the method  returns an array of length 0.

Returns:

 an array of interfaces implemented by this class.

 getComponentType

  public Class getComponentType()

 If this class represents an array type, returns the Class  object representing the component type of the array; otherwise  returns null.

See Also:

Array

 getModifiers

  public int getModifiers()

 Returns the Java language modifiers for this class or  interface, encoded in an integer. The modifiers consist of the  Java Virtual Machine's constants for public, protected,  private, final, and interface; they should be decoded using the  methods of class Modifier.

The modifier encodings are defined in The Java Virtual  Machine Specification, table 4.1.

See Also:

Modifier

 getSigners

  public Object[] getSigners()

 Get the signers of this class.

 getDeclaringClass

  public Class getDeclaringClass()

 If the class or interface represented by this Class object is  a member of another class, returns the Class object  representing the class of which it is a member (its  declaring class ). Returns null if this class or  interface is not a member of any other class.

 getClasses

  public Class[] getClasses()

 Returns an array containing Class objects representing all the  public classes and interfaces that are members of the class  represented by this Class object. This includes public class  and interface members inherited from superclasses and public  class and interface members declared by the class. Returns an  array of length 0 if the class has no public member classes or  interfaces, or if this Class object represents a primitive  type.

 getFields

  public Field[] getFields() throws SecurityException

 Returns an array containing Field objects reflecting all the  accessible public fields of the class or interface represented  by this Class object. Returns an array of length 0 if the  class or interface has no accessible public fields, or if it  represents an array type or a primitive type.

Specifically, if this Class object represents a class,  returns the public fields of this class and of all its  superclasses. If this Class object represents an interface,  returns the fields of this interface and of all its  superinterfaces. If this Class object represents an array type  or a primitive type, returns an array of length 0.

The implicit length field for array types is not reflected  by this method. User code should use the methods of class Array  to manipulate arrays.

See The Java Language Specification, sections 8.2 and 8.3.

Throws: SecurityException

 if access to the information is denied.

See Also:

Field

 getMethods

  public Method[] getMethods() throws SecurityException

 Returns an array containing Method objects reflecting all the  public member methods of the class or interface  represented by this Class object, including those declared by  the class or interface and and those inherited from  superclasses and superinterfaces. Returns an array of length 0  if the class or interface has no public member methods.

See The Java Language Specification, sections 8.2  and 8.4.

Throws: SecurityException

 if access to the information is denied.

See Also:

Method

 getConstructors

  public Constructor[] getConstructors() throws SecurityException

 Returns an array containing Constructor objects reflecting  all the public constructors of the class represented by this  Class object. An array of length 0 is returned if the class  has no public constructors.

Throws: SecurityException

 if access to the information is denied.

See Also:

Constructor

 getField

  public Field getField(String name) throws NoSuchFieldException, SecurityException

 Returns a Field object that reflects the specified public  member field of the class or interface represented by  this Class object. The name parameter is a String specifying  the simple name of the desired field.

The field to be reflected is located by searching all the  member fields of the class or interface represented by this  Class object for a public field with the specified name.

See The Java Language Specification, sections 8.2 and 8.3.

Throws: NoSuchFieldException

 if a field with the specified name is  not found.

Throws: SecurityException

 if access to the information is denied.

See Also:

Field

 getMethod

  public Method getMethod(String name,
                          Class parameterTypes[]) throws NoSuchMethodException , SecurityException

 Returns a Method object that reflects the specified public  member method of the class or interface represented by this  Class object. The name parameter is a String specifying the  simple name the desired method, and the parameterTypes  parameter is an array of Class objects that identify the  method's formal parameter types, in declared order.

The method to reflect is located by searching all the member  methods of the class or interface represented by this Class  object for a public method with the specified name and exactly  the same formal parameter types.

See The Java Language Specification, sections 8.2  and 8.4.

Throws: NoSuchMethodException

 if a matching method is not found.

Throws: SecurityException

 if access to the information is denied.

See Also:

Method

 getConstructor

  public Constructor getConstructor(Class parameterTypes[]) throws NoSuchMethodException, SecurityException

 Returns a Constructor object that reflects the specified public  constructor of the class represented by this Class object. The  parameterTypes parameter is an array of Class objects that  identify the constructor's formal parameter types, in declared  order.

The constructor to reflect is located by searching all the  constructors of the class represented by this Class object for  a public constructor with the exactly the same formal parameter  types.

Throws: NoSuchMethodException

 if a matching method is not found.

Throws: SecurityException

 if access to the information is denied.

See Also:

Constructor

 getDeclaredClasses

  public Class[] getDeclaredClasses() throws SecurityException

 Returns an array of Class objects reflecting all the classes  and interfaces declared as members of the class represented by  this Class object. This includes public, protected, default  (package) access, and private classes and interfaces declared  by the class, but excludes inherited classes and interfaces.  Returns an array of length 0 if the class declares no classes  or interfaces as members, or if this Class object represents a  primitive type.

Throws: SecurityException

 if access to the information is denied.

 getDeclaredFields

  public Field[] getDeclaredFields() throws SecurityException

 Returns an array of Field objects reflecting all the fields  declared by the class or interface represented by this Class  object. This includes public, protected, default (package)  access, and private fields, but excludes inherited  fields. Returns an array of length 0 if the class or interface  declares no fields, or if this Class object represents a  primitive type.  See The Java Language Specification, sections 8.2 and  8.3.

Throws: SecurityException

 if access to the information is denied.

See Also:

Field

 getDeclaredMethods

  public Method[] getDeclaredMethods() throws SecurityException

 Returns an array of Method objects reflecting all the methods  declared by the class or interface represented by this Class  object. This includes public, protected, default (package)  access, and private methods, but excludes inherited  methods. Returns an array of length 0 if the class or interface  declares no methods, or if this Class object represents a  primitive type.

See The Java Language Specification, section 8.2.

Throws: SecurityException

 if access to the information is denied.

See Also:

Method

 getDeclaredConstructors

  public Constructor[] getDeclaredConstructors() throws SecurityException

 Returns an array of Constructor objects reflecting all the  constructors declared by the class represented by this Class  object. These are public, protected, default (package) access,  and private constructors. Returns an array of length 0 if this  Class object represents an interface or a primitive type.

See The Java Language Specification, section 8.2.

Throws: SecurityException

 if access to the information is denied.

See Also:

Constructor

 getDeclaredField

  public Field getDeclaredField(String name) throws NoSuchFieldException , SecurityException

 Returns a Field object that reflects the specified declared  field of the class or interface represented by this Class  object. The name parameter is a String that specifies the  simple name of the desired field.

Throws: NoSuchFieldException

 if a field with the specified name is  not found.

Throws: SecurityException

 if access to the information is denied.

See Also:

Field

 getDeclaredMethod

  public Method getDeclaredMethod(String name,
                                  Class parameterTypes[]) throws NoSuchMethodException , SecurityException

 Returns a Method object that reflects the specified declared  method of the class or interface represented by this Class  object. The name parameter is a String that specifies the  simple name of the desired method, and the parameterTypes  parameter is an array of Class objects that identify the  method's formal parameter types, in declared order.

Throws: NoSuchMethodException

 if a matching method is not found.

Throws: SecurityException

 if access to the information is denied.

See Also:

Method

 getDeclaredConstructor

  public Constructor getDeclaredConstructor(Class parameterTypes[]) throws NoSuchMethodException, SecurityException

 Returns a Constructor object that reflects the specified declared  constructor of the class or interface represented by this Class  object. The parameterTypes parameter is an array of Class  objects that identify the constructor's formal parameter types,  in declared order.

Throws: NoSuchMethodException

 if a matching method is not found.

Throws: SecurityException

 if access to the information is denied.

See Also:

Constructor

 getResourceAsStream

  public InputStream getResourceAsStream(String name)

 Find a resource with a given name. Will return null if no  resource with this name is found. The rules for searching a  resources associated with a given class are implemented by the  ClassLoader of the class.

 The Class methods delegate to ClassLoader methods, after applying  a naming convention: if the resource name starts with "/", it is used  as is. Otherwise, the name of the package is prepended, after  converting "." to "/".

See Also:

ClassLoader

 getResource

  public URL getResource(String name)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.ClassCastException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.ClassCastException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.RuntimeException
                           |
                           +----java.lang.ClassCastException

______________________________________________________________________________

 public class ClassCastException

 extends RuntimeException

Thrown to indicate that the code has attempted to cast an object  to a subclass of which it is not an instance. For example, the  following code generates a ClassCastException:

     Object x = new Integer(0);
     System.out.println((String)x);

______________________________________________________________________________

 	ClassCastException()

 Constructs a ClassCastException with no detail message.

 	ClassCastException(String)

 Constructs a ClassCastException with the specified  detail message.

 ClassCastException

  public ClassCastException()

 Constructs a ClassCastException with no detail message.

 ClassCastException

  public ClassCastException(String s)

 Constructs a ClassCastException with the specified  detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.ClassCircularityError

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.ClassCircularityError

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Error
                   |
                   +----java.lang.LinkageError
                           |
                           +----java.lang.ClassCircularityError

______________________________________________________________________________

 public class ClassCircularityError

 extends LinkageError

Thrown when a circularity has been detected while initializing a class.

______________________________________________________________________________

 	ClassCircularityError()

 Constructs a ClassCircularityError with no detail message.

 	ClassCircularityError(String)

 Constructs a ClassCircularityError with the  specified detail message.

 ClassCircularityError

  public ClassCircularityError()

 Constructs a ClassCircularityError with no detail message.

 ClassCircularityError

  public ClassCircularityError(String s)

 Constructs a ClassCircularityError with the  specified detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.ClassFormatError

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.ClassFormatError

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Error
                   |
                   +----java.lang.LinkageError
                           |
                           +----java.lang.ClassFormatError

______________________________________________________________________________

 public class ClassFormatError

 extends LinkageError

Thrown when the Java Virtual Machine attempts to read a class  file and determines that the file is malformed or otherwise cannot  be interpreted as a class file.

______________________________________________________________________________

 	ClassFormatError()

 Constructs a ClassFormatError with no detail message.

 	ClassFormatError(String)

 Constructs a ClassFormatError with the specified  detail message.

 ClassFormatError

  public ClassFormatError()

 Constructs a ClassFormatError with no detail message.

 ClassFormatError

  public ClassFormatError(String s)

 Constructs a ClassFormatError with the specified  detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.ClassLoader

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.ClassLoader

java.lang.Object
   |
   +----java.lang.ClassLoader

______________________________________________________________________________

 public class ClassLoader

 extends Object

The class ClassLoader is an abstract class.  Applications implement subclasses of ClassLoader in  order to extend the manner in which the Java Virtual Machine  dynamically loads classes.

 Normally, the Java Virtual Machine loads classes from the local  file system in a platform-dependent manner. For example, on UNIX  systems, the Virtual Machine loads classes from the directory  defined by the CLASSPATH  environment variable.

 However, some classes may not originate from a file; they may  originate from other sources, such as the network, or they could  be constructed by an application. The method  defineClass  converts an array of bytes into an  instance of class Class. Instances of this newly  defined class can be created using the newInstance  method in class Class .

 The methods and constructors of objects created by a class loader  may reference other classes. To determine the class(es) referred  to, the Java Virtual Machine calls the loadClass  method of the class loader that originally created the class. If  the Java Virtual Machine only needs to determine if the class  exists and if it does exist to know its superclass, the  resolve flag is set to false. However,  if an instance of the class is being created or any of its methods  are being called, the class must also be resolved. In this case  the resolve  flag is set to true, and the  resolveClass method should be called.

 For example, an application could create a network class loader  to download class files from a server. Sample code might look like:

  ClassLoader loader = new NetworkClassLoader(host, port);
 Object main = loader.loadClass("Main", true).newInstance();
. . .

 The network class loader subclass must define the method  loadClass  to load a class from the network. Once it  has downloaded the bytes that make up the class, it should use the  method defineClass  to create a class instance. A  sample implementation is:

______________________________________________________________________________

     class NetworkClassLoader {
         String host;
         int port;
         Hashtable cache = new Hashtable();
         private byte loadClassData(String name)[] {
         // load the class data from the connection
          . . .
         }
         public synchronized Class loadClass(String name,
                                             boolean resolve) {
             Class c = cache.get(name);
             if (c == null) {
                 byte data[] = loadClassData(name);
                 c = defineClass(data, 0, data.length);
                 cache.put(name, c);
             }
             if (resolve)
                 resolveClass(c);
             return c;
         }
     }

______________________________________________________________________________

See Also:

Class, newInstance, defineClass, loadClass, resolveClass

______________________________________________________________________________

 	ClassLoader()

 Constructs a new class loader and initializes it.

 	defineClass(byte[], int, int)

 Converts an array of bytes into an instance of class  Class. Deprecated.

 	defineClass(String, byte[], int, int)

 Converts an array of bytes to an instance of class  Class.

 	findLoadedClass(String)

  	findSystemClass(String)

 Finds the system class with the specified name, loading it in if  necessary.

 	getResource(String)

 Find a resource with a given name.

 	getResourceAsStream(String)

 Get an InputStream on a given resource.

 	getSystemResource(String)

 Find a resource with a given name.

 	getSystemResourceAsStream(String)

 Get an InputStream on a given resource..

 	loadClass(String)

 Requests the class loader to load a class with the specified  name.

 	loadClass(String, boolean)

 Resolves the specified name to a Class.

 	resolveClass(Class)

 Resolves the class so that an instance of the class can be  created, or so that one of its methods can be called.

 	setSigners(Class, Object[])

 Sets the signers of a class.

 ClassLoader

  protected ClassLoader()

 Constructs a new class loader and initializes it.

 If there is a security manager, its  checkCreateClassLoader  method is called. This may  result in a security exception.

Throws: SecurityException

 if the current thread does not have  permission to create a new class loader.

See Also:

SecurityException, checkCreateClassLoader

 loadClass

  public Class loadClass(String name) throws ClassNotFoundException

 Requests the class loader to load a class with the specified  name. The loadClass method is called by the Java  Virtual Machine when a class loaded by a class loader first  references another class. Every subclass of class  ClassLoader  must define this method.

 If the resolve flag is true, the method should call  the resolveClass  method on the resulting class object.

 Class loaders should use a hashtable or other cache to avoid  defining classes with the same name multiple times.

Parameters:

 name - the name of the desired Class.

 resolve - true if the Class  must be resolved.

Returns:

 the resulting Class, or null  if it was not found.

Throws: ClassNotFoundException

 if the class loader cannot find  a definition for the class.

 loadClass

  protected abstract Class loadClass(String name,
                                     boolean resolve) throws ClassNotFoundException

 Resolves the specified name to a Class. The method loadClass() is  called by the virtual machine.  As an abstract method, loadClass() must be defined in a subclass of  ClassLoader. By using a Hashtable, you can avoid loading the same  Class more than once.

Parameters:

 name - the name of the desired Class.

 resolve - true if the Class needs to be resolved.

Returns:

 the resulting Class, or null if it was not found.

Throws: ClassNotFoundException

 if the class loader cannot find  a definition for the class.

See Also:

Hashtable

 defineClass

  protected final Class defineClass(byte data[],
                                    int offset,
                                    int length)

 Note: defineClass() is deprecated. Replaced by defineClass(java.lang.String, byte[], int, int).

 Converts an array of bytes into an instance of class  Class .  Before the Class can be used it must be resolved. This  method is deprecated in favor of the version that takes a  "name" as a first argument, and is more secure.

Parameters:

 data - the bytes that make up the Class.

 offset - the start offset of the Class data.

 length - the length of the Class data.

Returns:

 the Class object that was created from the data.

Throws: ClassFormatError

 if the data does not contain a valid Class.

See Also:

loadClass, resolveClass

 defineClass

  protected final Class defineClass(String name,
                                    byte data[],
                                    int offset,
                                    int length)

 Converts an array of bytes to an instance of class  Class. Before the Class can be used it must be resolved.

Parameters:

 name - the expected name of the class; null if unknown;  using '.' and not '/' as separator, and without  a trailing ".class" suffix.

 data - the bytes that make up the Class.

 offset - the start offset of the Class data.

 length - the length of the Class data.

Returns:

 the Class object that was created from the data.

Throws: ClassFormatError

 if the data does not contain a valid Class.

See Also:

loadClass, resolveClass

 resolveClass

  protected final void resolveClass(Class c)

 Resolves the class so that an instance of the class can be  created, or so that one of its methods can be called. This method  should be called by loadClass if the resolve flag is  true.

Parameters:

 c - the Class instance to be resolved.

See Also:

defineClass

 findSystemClass

  protected final Class findSystemClass(String name) throws ClassNotFoundException

 Finds the system class with the specified name, loading it in if  necessary.

 A system class is a class loaded from the local file system in a  platform- dependent way. It has no class loader.

Parameters:

 name - the name of the system class.

Returns:

 a system class with the given name.

Throws: ClassNotFoundException

 if it could not find a definition  for the class.

Throws: NoClassDefFoundError

 if the class is not found.

 setSigners

  protected final void setSigners(Class cl,
                                  Object signers[])

 Sets the signers of a class. This is called after defining a class,  by signature-aware class loading code.

 findLoadedClass

  protected final Class findLoadedClass(String name)

 getSystemResourceAsStream

  public final static InputStream getSystemResourceAsStream(String name)

 Get an InputStream on a given resource.. Will return null if no  resource with this name is found.

 The resource name may be any system resource (e.g. follows CLASSPATH  order).

Parameters:

 name - the name of the resource, to be used as is.

Returns:

 an InputStream on the resource, or null if not found.

 getSystemResource

  public final static URL getSystemResource(String name)

 Find a resource with a given name. The return is a URL to the resource  Doing a getContent() on the URL may return an Image, an AudioClip, or  an InputStream.

 The resource name may be any system resource (e.g. follows CLASSPATH  order).

Parameters:

 name - the name of the resource, to be used as is.

Returns:

 the URL on the resource, or null if not found.

 getResourceAsStream

  public InputStream getResourceAsStream(String name)

 Get an InputStream on a given resource. Will return null if no  resource with this name is found.

 The class loader can choose what to do to locate the resource.

Parameters:

 name - the name of the resource, to be used as is.

Returns:

 an InputStream on the resource, or null if not found.

 getResource

  public URL getResource(String name)

 Find a resource with a given name. The return is a URL to the resource.   Doing a getContent() on the URL may return an Image, an AudioClip,  or an InputStream.

 The class loader can choose what to do to locate the resource.

Parameters:

 name - the name of the resource, to be used as is.

Returns:

 an InputStream on the resource, or null if not found.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.ClassNotFoundException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.ClassNotFoundException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.ClassNotFoundException

______________________________________________________________________________

 public class ClassNotFoundException

 extends Exception

Thrown when an application tries to load in a class through its  string name using:

• The forName method in class Class.

• The findSystemClass method in class  ClassLoader .

• The loadClass method in class ClassLoader.

 but no definition for the class with the specifed name could be found.

See Also:

forName, findSystemClass, loadClass

______________________________________________________________________________

 	ClassNotFoundException()

 Constructs a ClassNotFoundException with no detail message.

 	ClassNotFoundException(String)

 Constructs a ClassNotFoundException with the  specified detail message.

 ClassNotFoundException

  public ClassNotFoundException()

 Constructs a ClassNotFoundException with no detail message.

 ClassNotFoundException

  public ClassNotFoundException(String s)

 Constructs a ClassNotFoundException with the  specified detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.lang.Cloneable

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.lang.Cloneable

 public interface Cloneable

A class implements the Cloneable interface to  indicate to the clone  method in class  Object that it is legal for that method to make a  field-for-field copy of instances of that class.

 Attempts to clone instances that do not implement the  Cloneable  interface result in the exception  CloneNotSupportedException being thrown.

See Also:

CloneNotSupportedException

______________________________________________________________________________
______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.CloneNotSupportedException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.CloneNotSupportedException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.CloneNotSupportedException

______________________________________________________________________________

 public class CloneNotSupportedException

 extends Exception

Thrown to indicate that the clone method in class  Object  has been called to clone an object, but that  the object's class does not implement the Cloneable  interface.

 Applications that override the clone method can also  throw this exception to indicate that an object could not or  should not be cloned.

See Also:

Cloneable, clone

______________________________________________________________________________

 	CloneNotSupportedException()

 Constructs a CloneNotSupportedException with no  detail message.

 	CloneNotSupportedException(String)

 Constructs a CloneNotSupportedException with the  specified detail message.

 CloneNotSupportedException

  public CloneNotSupportedException()

 Constructs a CloneNotSupportedException with no  detail message.

 CloneNotSupportedException

  public CloneNotSupportedException(String s)

 Constructs a CloneNotSupportedException with the  specified detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.Compiler

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.Compiler

java.lang.Object
   |
   +----java.lang.Compiler

______________________________________________________________________________

 public final class Compiler

 extends Object

The Compiler class is provided to support  Java-to-native-code compilers and related services. By design, the  Compiler  class does nothing; it serves as a  placeholder for a JIT compiler implementation.

 When the Java Virtual Machine first starts, it determines if the  system property java.compiler exists. (System  properties are accessible through getProperty and ,  a method defined by the System class.) If so, it is  assumed to be the name of a library (with a platform-dependent  exact location and type); the loadLibrary method in  class System  is called to load that library. If this  loading succeeds, the function named  java_lang_Compiler_start() in that library is called.

 If no compiler is available, these methods do nothing.

See Also:

getProperty, getProperty, loadLibrary

______________________________________________________________________________

 	command(Object)

 Examines the argument type and its fields and perform some documented  operation.

 	compileClass(Class)

 Compiles the specified class.

 	compileClasses(String)

 Compiles all classes whose name matches the specified string.

 	disable()

 Cause the Compiler to cease operation.

 	enable()

 Cause the Compiler to resume operation.

 compileClass

  public static boolean compileClass(Class clazz)

 Compiles the specified class.

Parameters:

 clazz - a class.

Returns:

true if the compilation succeeded;  false  if the compilation failed or no compiler  is available.

 compileClasses

  public static boolean compileClasses(String string)

 Compiles all classes whose name matches the specified string.

Parameters:

 string - the name of the classes to compile.

Returns:

true if the compilation succeeded;  false  if the compilation failed or no compiler  is available.

 command

  public static Object command(Object any)

 Examines the argument type and its fields and perform some documented  operation. No specific operations are required.

Parameters:

 any - an argument.

Returns:

 a compiler-specific value, or null if no compiler  is available.

 enable

  public static void enable()

 Cause the Compiler to resume operation.

 disable

  public static void disable()

 Cause the Compiler to cease operation.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.Double

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.Double

java.lang.Object
   |
   +----java.lang.Number
           |
           +----java.lang.Double

______________________________________________________________________________

 public final class Double

 extends Number

The Double class wraps a value of the primitive type  double  in an object. An object of type  Double contains a single field whose type is  double.

 In addition, this class provides several methods for converting a  double to a String and a  String to a double, as well as other  constants and methods useful when dealing with a  double.

______________________________________________________________________________

 	MAX_VALUE

 The largest positive value of type double.

 	MIN_VALUE

 The smallest positive value of type double.

 	NaN

 A NaN value of type double.

 	NEGATIVE_INFINITY

 The negative infinity of type double.

 	POSITIVE_INFINITY

 The positive infinity of type double.

 	TYPE

 The Class object representing the primitive type double.

 	Double(double)

 Constructs a newly allocated Double object that  represents the primitive double argument.

 	Double(String)

 Constructs a newly allocated Double object that  represents the floating- point value of type double  represented by the string.

 	byteValue()

 Returns the value of this Double as a byte (by casting to a byte).

 	doubleToLongBits(double)

 Returns a representation of the specified floating-point value  according to the IEEE 754 floating-point "double  format" bit layout.

 	doubleValue()

 Returns the double value of this Double.

 	equals(Object)

 Compares this object against the specified object.

 	floatValue()

 Returns the float value of this Double.

 	hashCode()

 Returns a hashcode for this Double.

 	intValue()

 Returns the integer value of this Double (by casting to an int).

 	isInfinite()

 Returns true if this Double value is infinitely large in magnitude.

 	isInfinite(double)

 Returns true if the specified number is infinitely large in magnitude.

 	isNaN()

 Returns true if this Double value is the special Not-a-Number (NaN)  value.

 	isNaN(double)

 Returns true if the specified number is the special Not-a-Number (NaN)  value.

 	longBitsToDouble(long)

 Returns the double-float corresponding to a given bit represention.

 	longValue()

 Returns the long value of this Double (by casting to a long).

 	shortValue()

 Returns the value of this Double as a short (by casting to a short).

 	toString()

 Returns a String representation of this Double object.

 	toString(double)

 Creates a string representation of the double  argument.

 	valueOf(String)

 Returns a new Double value initialized to the value represented by the  specified String.

 POSITIVE_INFINITY

  public final static double POSITIVE_INFINITY

 The positive infinity of type double.

 NEGATIVE_INFINITY

  public final static double NEGATIVE_INFINITY

 The negative infinity of type double.

 NaN

  public final static double NaN

 A NaN value of type double.

 MAX_VALUE

  public final static double MAX_VALUE

 The largest positive value of type double.

 MIN_VALUE

  public final static double MIN_VALUE

 The smallest positive value of type double.

 TYPE

  public final static Class TYPE

 The Class object representing the primitive type double.

 Double

  public Double(double value)

 Constructs a newly allocated Double object that  represents the primitive double argument.

Parameters:

 value - the value to be represented by the Double.

 Double

  public Double(String s) throws NumberFormatException

 Constructs a newly allocated Double object that  represents the floating- point value of type double  represented by the string. The string is converted to a  double value as if by the valueOf method.

Parameters:

 s - a string to be converted to a Double.

Throws: NumberFormatException

 if the string does not contain a  parsable number.

See Also:

valueOf

 toString

  public static String toString(double d)

 Creates a string representation of the double  argument.

 The values NaN, NEGATIVE_INFINITY,  POSITIVE_INFINITY, -0.0, and  +0.0 are represented by the strings  "NaN", "-Infinity",  "Infinity", "-0.0", and  "0.0" , respectively.

 If d is in the range  10-3 <= |d| <=107,  then it is converted to a string in the style  [-]ddd.ddd . Otherwise, it is converted to a  string in the style [-]m.ddddE±xx.

 There is always a minimum of one digit after the decimal point.  The number of digits is the minimum needed to uniquely distinguish  the argument value from adjacent values of type  double.

Parameters:

 d - the double to be converted.

Returns:

 a string representation of the argument.

 valueOf

  public static Double valueOf(String s) throws NumberFormatException

 Returns a new Double value initialized to the value represented by the  specified String.

Parameters:

 s - the string to be parsed.

Returns:

 a newly constructed Double initialized to the  value represented by the string argument.

Throws: NumberFormatException

 if the string does not contain a  parsable number.

 isNaN

  public static boolean isNaN(double v)

 Returns true if the specified number is the special Not-a-Number (NaN)  value.

Parameters:

 v - the value to be tested.

Returns:

true if the value of the argument is NaN;  false otherwise.

 isInfinite

  public static boolean isInfinite(double v)

 Returns true if the specified number is infinitely large in magnitude.

Parameters:

 v - the value to be tested.

Returns:

true if the value of the argument is positive  infinity or negative infinity; false otherwise.

 isNaN

  public boolean isNaN()

 Returns true if this Double value is the special Not-a-Number (NaN)  value.

Returns:

true if the value represented by this object is  NaN; false otherwise.

 isInfinite

  public boolean isInfinite()

 Returns true if this Double value is infinitely large in magnitude.

Returns:

true if the value represented by this object is  positive infinity or negative infinity;  false otherwise.

 toString

  public String toString()

 Returns a String representation of this Double object.  The primitive double value represented by this  object is converted to a string exactly as if by the method  toString of one argument.

Returns:

 a String representation of this object.

Overrides:

toString in class Object

See Also:

toString

 byteValue

  public byte byteValue()

 Returns the value of this Double as a byte (by casting to a byte).

Overrides:

byteValue in class Number

 shortValue

  public short shortValue()

 Returns the value of this Double as a short (by casting to a short).

Overrides:

shortValue in class Number

 intValue

  public int intValue()

 Returns the integer value of this Double (by casting to an int).

Returns:

 the double value represented by this object is  converted to type int  and the result of the  conversion is returned.

Overrides:

intValue in class Number

 longValue

  public long longValue()

 Returns the long value of this Double (by casting to a long).

Returns:

 the double value represented by this object is  converted to type long  and the result of the  conversion is returned.

Overrides:

longValue in class Number

 floatValue

  public float floatValue()

 Returns the float value of this Double.

Returns:

 the double value represented by this object is  converted to type float  and the result of the  conversion is returned.

Overrides:

floatValue in class Number

 doubleValue

  public double doubleValue()

 Returns the double value of this Double.

Returns:

 the double value represented by this object.

Overrides:

doubleValue in class Number

 hashCode

  public int hashCode()

 Returns a hashcode for this Double.

Returns:

 a hash code value for this object.

Overrides:

hashCode in class Object

 equals

  public boolean equals(Object obj)

 Compares this object against the specified object.  The result is true if and only if the argument is  not null and is a Double  object that  represents a double that has the identical bit pattern to the bit  pattern of the double represented by this object.

 Note that in most cases, for two instances of class  Double, d1 and d2, the  value of d1.equals(d2) is true if and  only if

  d1.doubleValue() == d2.doubleValue()

 also has the value true. However, there are two  exceptions:

• If d1 and d2 both represent  Double.NaN, then the equals method  returns true, even though  Double.NaN==Double.NaN has the value  false.

• If d1 represents +0.0 while  d2 represents -0.0, or vice versa,  the equal test has the value false,  even though +0.0==-0.0 has the value true.

Parameters:

 obj - the object to compare with.

Returns:

true if the objects are the same;  false otherwise.

Overrides:

equals in class Object

 doubleToLongBits

  public static long doubleToLongBits(double value)

 Returns a representation of the specified floating-point value  according to the IEEE 754 floating-point "double  format" bit layout.

 Bit 63 represents the sign of the floating-point number. Bits  62-52 represent the exponent. Bits 51-0 represent  the significand (sometimes called the mantissa) of the  floating-point number.

 If the argument is positive infinity, the result is  0x7ff0000000000000L.

 If the argument is negative infinity, the result is  0xfff0000000000000L.

 If the argument is NaN, the result is  0x7ff8000000000000L.

Parameters:

 value - a double precision floating-point number.

Returns:

 the bits that represent the floating-point number.

 longBitsToDouble

  public static double longBitsToDouble(long bits)

 Returns the double-float corresponding to a given bit represention.  The argument is considered to be a representation of a  floating-point value according to the IEEE 754 floating-point  "double precision" bit layout. That floating-point  value is returned as the result.

 If the argument is 0x7f80000000000000L, the result  is positive infinity.

 If the argument is 0xff80000000000000L, the result  is negative infinity.

 If the argument is any value in the range  0x7ff0000000000001L through  0x7fffffffffffffffL or in the range  0xfff0000000000001L through  0xffffffffffffffffL, the result is NaN. All IEEE 754  NaN values are, in effect, lumped together by the Java language  into a single value.

Parameters:

 bits - any long integer.

Returns:

 the double floating-point value with the same  bit pattern.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.Error

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.Error

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Error

______________________________________________________________________________

 public class Error

 extends Throwable

An Error is a subclass of Throwable  that indicates serious problems that a reasonable application  should not try to catch. Most such errors are abnormal conditions.  The ThreadDeath  error, though a "normal" condition,  is also a subclass of Error  because most applications  should not try to catch it.

 A method is not required to declare in its throws  clause any subclasses of Error that might be thrown  during the execution of the method but not caught, since these  errors are abnormal conditions that should never occur.

See Also:

ThreadDeath

______________________________________________________________________________

 	Error()

 Constructs an Error with no specified detail message.

 	Error(String)

 Constructs an Error with the specified detail message.

 Error

  public Error()

 Constructs an Error with no specified detail message.

 Error

  public Error(String s)

 Constructs an Error with the specified detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.Exception

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.Exception

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception

______________________________________________________________________________

 public class Exception

 extends Throwable

The class Exception and its subclasses are a form of  Throwable  that indicates conditions that a reasonable  application might want to catch.

See Also:

Error

______________________________________________________________________________

 	Exception()

 Constructs an Exception with no specified detail message.

 	Exception(String)

 Constructs an Exception with the specified detail message.

 Exception

  public Exception()

 Constructs an Exception with no specified detail message.

 Exception

  public Exception(String s)

 Constructs an Exception with the specified detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.ExceptionInInitializerError

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.ExceptionInInitializerError

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Error
                   |
                   +----java.lang.LinkageError
                           |
                           +----java.lang.ExceptionInInitializerError

______________________________________________________________________________

 public class ExceptionInInitializerError

 extends LinkageError

Signals that an unexpected exception has occurred in a static initializer.

______________________________________________________________________________

 	ExceptionInInitializerError()

 Constructs an ExceptionInInitializerError with no detail message.

 	ExceptionInInitializerError(String)

 Constructs a ExceptionInInitializerError with the specified detail message.

 	ExceptionInInitializerError(Throwable)

 Constructs a new ExceptionInInitializerError class initialized to  the specific throwable

 	getException()

 Returns the exception that occurred during a static initialization that  caused this Error to be created.

 ExceptionInInitializerError

  public ExceptionInInitializerError()

 Constructs an ExceptionInInitializerError with no detail message.  A detail message is a String that describes this particular exception.

 ExceptionInInitializerError

  public ExceptionInInitializerError(Throwable thrown)

 Constructs a new ExceptionInInitializerError class initialized to  the specific throwable

Parameters:

 thrown - The exception thrown

 ExceptionInInitializerError

  public ExceptionInInitializerError(String s)

 Constructs a ExceptionInInitializerError with the specified detail message.  A detail message is a String that describes this particular exception.

Parameters:

 s - the detail message

 getException

  public Throwable getException()

 Returns the exception that occurred during a static initialization that   caused this Error to be created.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.Float

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.Float

java.lang.Object
   |
   +----java.lang.Number
           |
           +----java.lang.Float

______________________________________________________________________________

 public final class Float

 extends Number

The Float class wraps a value of primitive type float in  an object. An object of type Float contains a single  field whose type is float.

 In addition, this class provides several methods for converting a  float to a String and a  String to a float, as well as other  constants and methods useful when dealing with a  float.

______________________________________________________________________________

 	MAX_VALUE

 The largest positive value of type float.

 	MIN_VALUE

 The smallest positive value of type float.

 	NaN

 The NaN value of type float.

 	NEGATIVE_INFINITY

 The negative infinity of type float.

 	POSITIVE_INFINITY

 The positive infinity of type float.

 	TYPE

 The Class object representing the primitive type float.

 	Float(double)

 Constructs a newly allocated Floatobject that  represents the argument converted to type float.

 	Float(float)

 Constructs a newly allocated Float object that  represents the primitive float argument.

 	Float(String)

 Constructs a newly allocated Float object that  represents the floating- point value of type float  represented by the string.

 	byteValue()

 Returns the value of this Float as a byte (by casting to a byte).

 	doubleValue()

 Returns the double value of this Float.

 	equals(Object)

 Compares this object against some other object.

 	floatToIntBits(float)

 Returns the bit represention of a single-float value.

 	floatValue()

 Returns the float value of this Float object.

 	hashCode()

 Returns a hashcode for this Float.

 	intBitsToFloat(int)

 Returns the single-float corresponding to a given bit represention.

 	intValue()

 Returns the integer value of this Float (by casting to an int).

 	isInfinite()

 Returns true if this Float value is infinitely large in magnitude.

 	isInfinite(float)

 Returns true if the specified number is infinitely large in magnitude.

 	isNaN()

 Returns true if this Float value is Not-a-Number (NaN).

 	isNaN(float)

 Returns true if the specified number is the special Not-a-Number (NaN)  value.

 	longValue()

 Returns the long value of this Float (by casting to a long).

 	shortValue()

 Returns the value of this Float as a short (by casting to a short).

 	toString()

 Returns a String representation of this Float object.

 	toString(float)

 Returns a String representation for the specified float value.

 	valueOf(String)

 Returns the floating point value represented by the specified String.

 POSITIVE_INFINITY

  public final static float POSITIVE_INFINITY

 The positive infinity of type float.

 NEGATIVE_INFINITY

  public final static float NEGATIVE_INFINITY

 The negative infinity of type float.

 NaN

  public final static float NaN

 The NaN value of type float.

 MAX_VALUE

  public final static float MAX_VALUE

 The largest positive value of type float.

 MIN_VALUE

  public final static float MIN_VALUE

 The smallest positive value of type float.

 TYPE

  public final static Class TYPE

 The Class object representing the primitive type float.

 Float

  public Float(float value)

 Constructs a newly allocated Float object that  represents the primitive float argument.

Parameters:

 value - the value to be represented by the Float.

 Float

  public Float(double value)

 Constructs a newly allocated Floatobject that  represents the argument converted to type float.

Parameters:

 value - the value to be represented by the Float.

 Float

  public Float(String s) throws NumberFormatException

 Constructs a newly allocated Float object that  represents the floating- point value of type float  represented by the string. The string is converted to a  float value as if by the valueOf method.

Parameters:

 s - a string to be converted to a Float.

Throws: NumberFormatException

 if the string does not contain a  parsable number.

See Also:

valueOf

 toString

  public static String toString(float f)

 Returns a String representation for the specified float value.

 The values NaN, NEGATIVE_INFINITY,  POSITIVE_INFINITY, -0.0, and  +0.0 are represented by the strings  "NaN", "-Infinity",  "Infinity", "-0.0", and  "0.0" , respectively.

 If d is in the range  10-3 <=  |d| <= 107,  then it is converted to a String in the style  [-]ddd.ddd. Otherwise, it is converted to a  string in the style [-]m.ddddE±xx.

 There is always a minimum of 1 digit after the decimal point. The  number of digits is the minimum needed to uniquely distinguish the  argument value from adjacent values of type float.

Parameters:

 d - the float to be converted.

Returns:

 a string representation of the argument.

 valueOf

  public static Float valueOf(String s) throws NumberFormatException

 Returns the floating point value represented by the specified String.

Parameters:

 s - the string to be parsed.

Returns:

 a newly constructed Float initialized to the  value represented by the String argument.

Throws: NumberFormatException

 if the string does not contain a  parsable number.

 isNaN

  public static boolean isNaN(float v)

 Returns true if the specified number is the special Not-a-Number (NaN)  value.

Parameters:

 v - the value to be tested.

Returns:

true if the argument is NaN;  false otherwise.

 isInfinite

  public static boolean isInfinite(float v)

 Returns true if the specified number is infinitely large in magnitude.

Parameters:

 v - the value to be tested.

Returns:

true if the argument is positive infinity or  negative infinity; false  otherwise.

 isNaN

  public boolean isNaN()

 Returns true if this Float value is Not-a-Number (NaN).

Returns:

true if the value represented by this object is  NaN; false otherwise.

 isInfinite

  public boolean isInfinite()

 Returns true if this Float value is infinitely large in magnitude.

Returns:

true if the value represented by this object is  positive infinity or negative infinity;  false otherwise.

 toString

  public String toString()

 Returns a String representation of this Float object.  The primitive float value represented by this object  is converted to a String  exactly as if by the method  toString of one argument.

Returns:

 a String representation of this object.

Overrides:

toString in class Object

See Also:

toString

 byteValue

  public byte byteValue()

 Returns the value of this Float as a byte (by casting to a byte).

Overrides:

byteValue in class Number

 shortValue

  public short shortValue()

 Returns the value of this Float as a short (by casting to a short).

Overrides:

shortValue in class Number

 intValue

  public int intValue()

 Returns the integer value of this Float (by casting to an int).

Returns:

 the float value represented by this object  converted to type int  and the result of the  conversion is returned.

Overrides:

intValue in class Number

 longValue

  public long longValue()

 Returns the long value of this Float (by casting to a long).

Returns:

 the float value represented by this object is  converted to type long  and the result of the  conversion is returned.

Overrides:

longValue in class Number

 floatValue

  public float floatValue()

 Returns the float value of this Float object.

Returns:

 the float value represented by this object.

Overrides:

floatValue in class Number

 doubleValue

  public double doubleValue()

 Returns the double value of this Float.

Overrides:

doubleValue in class Number

 hashCode

  public int hashCode()

 Returns a hashcode for this Float.

Returns:

 a hash code value for this object.

Overrides:

hashCode in class Object

 equals

  public boolean equals(Object obj)

 Compares this object against some other object.  The result is true if and only if the argument is  not null and is a Float  object that  represents a float that has the identical bit pattern  to the bit pattern of the float represented by this  object.

 Note that in most cases, for two instances of class  Float, f1 and f2, the value  of f1.equals(f2) is true if and only if

  f1.floatValue() == f2.floatValue()

 also has the value true. However, there are two exceptions:

• If f1 and f2 both represent  Float.NaN, then the equals method returns  true, even though Float.NaN==Float.NaN  has the value false.

• If f1 represents +0.0f while  f2 represents -0.0f, or vice versa,  the equal test has the value false,  even though 0.0f==-0.0f has the value true.

Returns:

true if the objects are the same;  false otherwise.

Overrides:

equals in class Object

See Also:

floatToIntBits

 floatToIntBits

  public static int floatToIntBits(float value)

 Returns the bit represention of a single-float value.  The result is a representation of the floating-point argument  according to the IEEE 754 floating-point "single  precision" bit layout.

 Bit 31 represents the sign of the floating-point number. Bits  30-23 represent the exponent. Bits 22-0 represent  the significand (sometimes called the mantissa) of the  floating-point number.

 If the argument is positive infinity, the result is  0x7f800000.

 If the argument is negative infinity, the result is  0xff800000.

 If the argument is NaN, the result is 0x7fc00000.

Parameters:

 value - a floating-point number.

Returns:

 the bits that represent the floating-point number.

 intBitsToFloat

  public static float intBitsToFloat(int bits)

 Returns the single-float corresponding to a given bit represention.  The argument is considered to be a representation of a  floating-point value according to the IEEE 754 floating-point  "single precision" bit layout.

 If the argument is 0x7f800000, the result is positive  infinity.

 If the argument is 0xff800000, the result is negative  infinity.

 If the argument is any value in the range 0x7f800001  through 0x7f8fffff  or in the range  0xff800001 through 0xff8fffff, the result is  NaN. All IEEE 754 NaN values are, in effect, lumped together by  the Java language into a single value.

Parameters:

 bits - an integer.

Returns:

 the single-format floating-point value with the same bit  pattern.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.IllegalAccessError

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.IllegalAccessError

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Error
                   |
                   +----java.lang.LinkageError
                           |
                           +----java.lang.IncompatibleClassChangeError
                                   |
                                   +----java.lang.IllegalAccessError

______________________________________________________________________________

 public class IllegalAccessError

 extends IncompatibleClassChangeError

Thrown if an application attempts to access or modify a field, or  to call a method that it does not have access to.

 Normally, this error is caught by the compiler; this error can  only occur at run time if the definition of a class has  incompatibly changed.

______________________________________________________________________________

 	IllegalAccessError()

 Constructs an IllegalAccessError with no detail message.

 	IllegalAccessError(String)

 Constructs an IllegalAccessError with the specified  detail message.

 IllegalAccessError

  public IllegalAccessError()

 Constructs an IllegalAccessError with no detail message.

 IllegalAccessError

  public IllegalAccessError(String s)

 Constructs an IllegalAccessError with the specified  detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.IllegalAccessException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.IllegalAccessException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.IllegalAccessException

______________________________________________________________________________

 public class IllegalAccessException

 extends Exception

Thrown when an application tries to load in a class through its  string name using:

• The forName method in class Class.

• The findSystemClass method in class  ClassLoader.

• The loadClass method in class ClassLoader.

 but the currently executing method does not have access to the  definition of the specified class, because the class is not public  and in another package.

 An instance of this class can also be thrown when an application  tries to create an instance of a class using the  newInstance method in class Class, but  the current method does not have access to the appropriate  zero-argument constructor.

See Also:

forName, newInstance, findSystemClass, loadClass

______________________________________________________________________________

 	IllegalAccessException()

 Constructs an IllegalAccessException without a  detail message.

 	IllegalAccessException(String)

 Constructs an IllegalAccessException with a detail message.

 IllegalAccessException

  public IllegalAccessException()

 Constructs an IllegalAccessException without a  detail message.

 IllegalAccessException

  public IllegalAccessException(String s)

 Constructs an IllegalAccessException with a detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.IllegalArgumentException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.IllegalArgumentException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.RuntimeException
                           |
                           +----java.lang.IllegalArgumentException

______________________________________________________________________________

 public class IllegalArgumentException

 extends RuntimeException

Thrown to indicate that a method has been passed an illegal or  inappropriate argument.

See Also:

setPriority

______________________________________________________________________________

 	IllegalArgumentException()

 Constructs an IllegalArgumentException with no  detail message.

 	IllegalArgumentException(String)

 Constructs an IllegalArgumentException with the  specified detail message.

 IllegalArgumentException

  public IllegalArgumentException()

 Constructs an IllegalArgumentException with no  detail message.

 IllegalArgumentException

  public IllegalArgumentException(String s)

 Constructs an IllegalArgumentException with the  specified detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.IllegalMonitorStateException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.IllegalMonitorStateException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.RuntimeException
                           |
                           +----java.lang.IllegalMonitorStateException

______________________________________________________________________________

 public class IllegalMonitorStateException

 extends RuntimeException

Thrown to indicate that a thread has attempted to wait on an  object's monitor or to notify other threads waiting on an object's  monitor without owning the specified monitor.

See Also:

notify, notifyAll, wait, wait, wait

______________________________________________________________________________

 	IllegalMonitorStateException()

 Constructs an IllegalMonitorStateException with no  detail message.

 	IllegalMonitorStateException(String)

 Constructs an IllegalMonitorStateException with the  specified detail message.

 IllegalMonitorStateException

  public IllegalMonitorStateException()

 Constructs an IllegalMonitorStateException with no  detail message.

 IllegalMonitorStateException

  public IllegalMonitorStateException(String s)

 Constructs an IllegalMonitorStateException with the  specified detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.IllegalStateException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.IllegalStateException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.RuntimeException
                           |
                           +----java.lang.IllegalStateException

______________________________________________________________________________

 public class IllegalStateException

 extends RuntimeException

Signals that a method has been invoked at an illegal or  inappropriate time. In other words, the Java environment or  Java application is not in an appropriate state for the requested  operation.

______________________________________________________________________________

 	IllegalStateException()

 Constructs an IllegalStateException with no detail message.

 	IllegalStateException(String)

 Constructs an IllegalStateException with the specified detail  message.

 IllegalStateException

  public IllegalStateException()

 Constructs an IllegalStateException with no detail message.  A detail message is a String that describes this particular exception.

 IllegalStateException

  public IllegalStateException(String s)

 Constructs an IllegalStateException with the specified detail  message. A detail message is a String that describes this particular  exception.

Parameters:

 s - the String that contains a detailed message

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.IllegalThreadStateException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.IllegalThreadStateException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.RuntimeException
                           |
                           +----java.lang.IllegalArgumentException
                                   |
                                   +----java.lang.IllegalThreadStateException

______________________________________________________________________________

 public class IllegalThreadStateException

 extends IllegalArgumentException

Thrown to indicate that a thread is not in an appropriate state  for the requested operation. See, for example, the  suspend and resume  methods in class  Thread.

See Also:

resume, suspend

______________________________________________________________________________

 	IllegalThreadStateException()

 Constructs an IllegalThreadStateException with no  detail message.

 	IllegalThreadStateException(String)

 Constructs an IllegalThreadStateException with the  specified detail message.

 IllegalThreadStateException

  public IllegalThreadStateException()

 Constructs an IllegalThreadStateException with no  detail message.

 IllegalThreadStateException

  public IllegalThreadStateException(String s)

 Constructs an IllegalThreadStateException with the  specified detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.IncompatibleClassChangeError

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.IncompatibleClassChangeError

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Error
                   |
                   +----java.lang.LinkageError
                           |
                           +----java.lang.IncompatibleClassChangeError

______________________________________________________________________________

 public class IncompatibleClassChangeError

 extends LinkageError

Thrown when an incompatible class change has occurred to some class  definition. The definition of some class, on which the currently  executing method depends, has since changed.

______________________________________________________________________________

 	IncompatibleClassChangeError()

 Constructs an IncompatibleClassChangeError with no  detail message.

 	IncompatibleClassChangeError(String)

 Constructs an IncompatibleClassChangeError with the  specified detail message.

 IncompatibleClassChangeError

  public IncompatibleClassChangeError()

 Constructs an IncompatibleClassChangeError with no  detail message.

 IncompatibleClassChangeError

  public IncompatibleClassChangeError(String s)

 Constructs an IncompatibleClassChangeError with the  specified detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.IndexOutOfBoundsException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.IndexOutOfBoundsException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.RuntimeException
                           |
                           +----java.lang.IndexOutOfBoundsException

______________________________________________________________________________

 public class IndexOutOfBoundsException

 extends RuntimeException

Thrown to indicate that an index of some sort (such as to an array, to a  string, or to a vector) is out of range.

 Applications can subclass this class to indicate similar exceptions.

______________________________________________________________________________

 	IndexOutOfBoundsException()

 Constructs an IndexOutOfBoundsException with no  detail message.

 	IndexOutOfBoundsException(String)

 Constructs an IndexOutOfBoundsException with the  specified detail message.

 IndexOutOfBoundsException

  public IndexOutOfBoundsException()

 Constructs an IndexOutOfBoundsException with no  detail message.

 IndexOutOfBoundsException

  public IndexOutOfBoundsException(String s)

 Constructs an IndexOutOfBoundsException with the  specified detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.InstantiationError

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.InstantiationError

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Error
                   |
                   +----java.lang.LinkageError
                           |
                           +----java.lang.IncompatibleClassChangeError
                                   |
                                   +----java.lang.InstantiationError

______________________________________________________________________________

 public class InstantiationError

 extends IncompatibleClassChangeError

Thrown when an application tries to use the Java new  construct to instantiate an abstract class or an interface.

 Normally, this error is caught by the compiler; this error can  only occur at run time if the definition of a class has  incompatibly changed.

______________________________________________________________________________

 	InstantiationError()

 Constructs an InstantiationError with no detail message.

 	InstantiationError(String)

 Constructs an InstantiationError with the specified  detail message.

 InstantiationError

  public InstantiationError()

 Constructs an InstantiationError with no detail message.

 InstantiationError

  public InstantiationError(String s)

 Constructs an InstantiationError with the specified  detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.InstantiationException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.InstantiationException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.InstantiationException

______________________________________________________________________________

 public class InstantiationException

 extends Exception

Thrown when an application tries to create an instance of a class  using the newInstance  method in class  Class, but the specified class object cannot be  instantiated because it is an interface or is an abstract class.

See Also:

newInstance

______________________________________________________________________________

 	InstantiationException()

 Constructs an InstantiationException with no detail message.

 	InstantiationException(String)

 Constructs an InstantiationException with the  specified detail message.

 InstantiationException

  public InstantiationException()

 Constructs an InstantiationException  with no detail message.

 InstantiationException

  public InstantiationException(String s)

 Constructs an InstantiationException with the  specified detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.Integer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.Integer

java.lang.Object
   |
   +----java.lang.Number
           |
           +----java.lang.Integer

______________________________________________________________________________

 public final class Integer

 extends Number

The Integer class wraps a value of the primitive type int  in an object. An object of type Integer contains a  single field whose type is int.

 In addition, this class provides several methods for converting  an int to a String and a  String to an int, as well as other  constants and methods useful when dealing with an  int.

______________________________________________________________________________

 	MAX_VALUE

 The largest value of type int.

 	MIN_VALUE

 The smallest value of type int.

 	TYPE

 The Class object representing the primitive type int.

 	Integer(int)

 Constructs a newly allocated Integer object that  represents the primitive int argument.

 	Integer(String)

 Constructs a newly allocated Integer object that  represents the value represented by the string.

 	byteValue()

 Returns the value of this Integer as a byte.

 	decode(String)

 Decodes a string into an Integer.

 	doubleValue()

 Returns the value of this Integer as a double.

 	equals(Object)

 Compares this object to the specified object.

 	floatValue()

 Returns the value of this Integer as a float.

 	getInteger(String)

 Determines the integer value of the system property with the  specified name.

 	getInteger(String, int)

 Determines the integer value of the system property with the  specified name.

 	getInteger(String, Integer)

 Determines the integer value of the system property with the  specified name.

 	hashCode()

 Returns a hashcode for this Integer.

 	intValue()

 Returns the value of this Integer as an int.

 	longValue()

 Returns the value of this Integer as a long.

 	parseInt(String)

 Parses the string argument as a signed decimal integer.

 	parseInt(String, int)

 Parses the string argument as a signed integer in the radix  specified by the second argument.

 	shortValue()

 Returns the value of this Integer as a short.

 	toBinaryString(int)

 Creates a string representation of the integer argument as an  unsigned integer in base 2.

 	toHexString(int)

 Creates a string representation of the integer argument as an  unsigned integer in base 16.

 	toOctalString(int)

 Creates a string representation of the integer argument as an  unsigned integer in base 8.

 	toString()

 Returns a String object representing this Integer's value.

 	toString(int)

 Returns a new String object representing the specified integer.

 	toString(int, int)

 Creates a string representation of the first argument in the  radix specified by the second argument.

 	valueOf(String)

 Returns a new Integer object initialized to the value of the  specified String.

 	valueOf(String, int)

 Returns a new Integer object initialized to the value of the  specified String.

 MIN_VALUE

  public final static int MIN_VALUE

 The smallest value of type int.

 MAX_VALUE

  public final static int MAX_VALUE

 The largest value of type int.

 TYPE

  public final static Class TYPE

 The Class object representing the primitive type int.

 Integer

  public Integer(int value)

 Constructs a newly allocated Integer object that  represents the primitive int argument.

Parameters:

 value - the value to be represented by the Integer.

 Integer

  public Integer(String s) throws NumberFormatException

 Constructs a newly allocated Integer object that  represents the value represented by the string. The string is  converted to an int value as if by the valueOf method.

Parameters:

 s - the String to be converted to an  Integer.

Throws: NumberFormatException

 if the String does not  contain a parsable integer.

See Also:

valueOf

 toString

  public static String toString(int i,
                                int radix)

 Creates a string representation of the first argument in the  radix specified by the second argument.

 If the radix is smaller than Character.MIN_RADIX or  larger than Character.MAX_RADIX, then the radix  10 is used instead.

 If the first argument is negative, the first element of the  result is the ASCII minus character '-'. If the first  argument is not negative, no sign character appears in the result.  The following ASCII characters are used as digits:

  0123456789abcdefghijklmnopqrstuvwxyz

Parameters:

 i - an integer.

 radix - the radix.

Returns:

 a string representation of the argument in the specified radix.

See Also:

MAX_RADIX, MIN_RADIX

 toHexString

  public static String toHexString(int i)

 Creates a string representation of the integer argument as an  unsigned integer in base 16.

 The unsigned integer value is the argument plus 232 if  the argument is negative; otherwise, it is equal to the argument.  This value is converted to a string of ASCII digits in hexadecimal  (base 16) with no extra leading 0s.

Parameters:

 i - an integer.

Returns:

 the string representation of the unsigned integer value  represented by the argument in hexadecimal (base 16).

 toOctalString

  public static String toOctalString(int i)

 Creates a string representation of the integer argument as an  unsigned integer in base 8.

 The unsigned integer value is the argument plus 232 if  the argument is negative; otherwise, it is equal to the argument.  This value is converted to a string of ASCII digits in octal  (base 8) with no extra leading 0s.

Parameters:

 i - an integer

Returns:

 the string representation of the unsigned integer value  represented by the argument in octal (base&mnsp;8).

 toBinaryString

  public static String toBinaryString(int i)

 Creates a string representation of the integer argument as an  unsigned integer in base 2.

 The unsigned integer value is the argument plus 232if  the argument is negative; otherwise it is equal to the argument.  This value is converted to a string of ASCII digits in binary  (base 2) with no extra leading 0s.

Parameters:

 i - an integer.

Returns:

 the string representation of the unsigned integer value  represented by the argument in binary (base 2).

 toString

  public static String toString(int i)

 Returns a new String object representing the specified integer. The radix  is assumed to be 10.

Parameters:

 i - an integer to be converted.

Returns:

 a string representation of the argument in base 10.

 parseInt

  public static int parseInt(String s,
                             int radix) throws NumberFormatException

 Parses the string argument as a signed integer in the radix  specified by the second argument. The characters in the string  must all be digits of the specified radix (as determined by  whether Character.digit  returns a  nonnegative value), except that the first character may be an  ASCII minus sign '-' to indicate a negative value.  The resulting integer value is returned.

Parameters:

 s - the String containing the integer.

 radix - the radix to be used.

Returns:

 the integer represented by the string argument in the  specified radix.

Throws: NumberFormatException

 if the string does not contain a  parsable integer.

 parseInt

  public static int parseInt(String s) throws NumberFormatException

 Parses the string argument as a signed decimal integer. The  characters in the string must all be decimal digits, except that  the first character may be an ASCII minus sign '-' to  indicate a negative value.

Parameters:

 s - a string.

Returns:

 the integer represented by the argument in decimal.

Throws: NumberFormatException

 if the string does not contain a  parsable integer.

 valueOf

  public static Integer valueOf(String s,
                                int radix) throws NumberFormatException

 Returns a new Integer object initialized to the value of the  specified String. Throws an exception if the String cannot be  parsed as an int.

Parameters:

 s - the string to be parsed.

Returns:

 a newly constructed Integer initialized to the  value represented by the string argument in the specified  radix.

Throws: NumberFormatException

 if the String does not  contain a parsable integer.

 valueOf

  public static Integer valueOf(String s) throws NumberFormatException

 Returns a new Integer object initialized to the value of the  specified String. Throws an exception if the String cannot be  parsed as an int. The radix is assumed to be 10.

Parameters:

 s - the string to be parsed.

Returns:

 a newly constructed Integer initialized to the  value represented by the string argument.

Throws: NumberFormatException

 if the string does not contain a  parsable integer.

 byteValue

  public byte byteValue()

 Returns the value of this Integer as a byte.

Overrides:

byteValue in class Number

 shortValue

  public short shortValue()

 Returns the value of this Integer as a short.

Overrides:

shortValue in class Number

 intValue

  public int intValue()

 Returns the value of this Integer as an int.

Returns:

 the int value represented by this object.

Overrides:

intValue in class Number

 longValue

  public long longValue()

 Returns the value of this Integer as a long.

Returns:

 the int value represented by this object that is  converted to type long  and the result of the  conversion is returned.

Overrides:

longValue in class Number

 floatValue

  public float floatValue()

 Returns the value of this Integer as a float.

Returns:

 the int value represented by this object is  converted to type float  and the result of the  conversion is returned.

Overrides:

floatValue in class Number

 doubleValue

  public double doubleValue()

 Returns the value of this Integer as a double.

Returns:

 the int value represented by this object is  converted to type double  and the result of the  conversion is returned.

Overrides:

doubleValue in class Number

 toString

  public String toString()

 Returns a String object representing this Integer's value.

Returns:

 a string representation of the value of this object in  base 10.

Overrides:

toString in class Object

 hashCode

  public int hashCode()

 Returns a hashcode for this Integer.

Returns:

 a hash code value for this object.

Overrides:

hashCode in class Object

 equals

  public boolean equals(Object obj)

 Compares this object to the specified object.  The result is true if and only if the argument is not  null and is an Integer  object that contains  the same int value as this object.

Parameters:

 obj - the object to compare with.

Returns:

true if the objects are the same;  false otherwise.

Overrides:

equals in class Object

 getInteger

  public static Integer getInteger(String nm)

 Determines the integer value of the system property with the  specified name.

 The first argument is treated as the name of a system property.  System properties are accessible through getProperty  and , a method defined by the System class. The  string value of this property is then interpreted as an integer  value and an Integer object representing this value is  returned. Details of possible numeric formats can be found with  the definition of getProperty.

 If there is no property with the specified name, or if the  property does not have the correct numeric format, then  null is returned.

Parameters:

 nm - property name.

Returns:

 the Integer value of the property.

See Also:

getProperty, getProperty

 getInteger

  public static Integer getInteger(String nm,
                                   int val)

 Determines the integer value of the system property with the  specified name.

 The first argument is treated as the name of a system property.  System properties are accessible through getProperty  and , a method defined by the System class. The  string value of this property is then interpreted as an integer  value and an Integer object representing this value is  returned. Details of possible numeric formats can be found with  the definition of getProperty.

 If there is no property with the specified name, or if the  property does not have the correct numeric format, then an  Integer  object that represents the value of the  second argument is returned.

Parameters:

 nm - property name.

 val - default value.

Returns:

 the Integer value of the property.

See Also:

getProperty, getProperty

 getInteger

  public static Integer getInteger(String nm,
                                   Integer val)

 Determines the integer value of the system property with the  specified name.

 The first argument is treated as the name of a system property.  System properties are accessible through getProperty  and , a method defined by the System class. The  string value of this property is then interpreted as an integer  value and an Integer object representing this value is  returned.

 If the property value begins with "0x" or  "# ", not followed by a minus sign, the rest  of it is parsed as a hexadecimal integer exactly as for the method  Integer.valueOf  with radix 16.

 If the property value begins with "0" then  it is parsed as an octal integer exactly as for the method  Integer.valueOf  with radix 8.

 Otherwise the property value is parsed as a decimal integer  exactly as for the method Integer.valueOf with radix 10.

 The second argument is the default value. If there is no property  of the specified name, or if the property does not have the  correct numeric format, then the second argument is returned.

Parameters:

 nm - property name.

 val - default value.

Returns:

 the Integer value of the property.

See Also:

getProperty, getProperty

 decode

  public static Integer decode(String nm) throws NumberFormatException

 Decodes a string into an Integer. Deals with decimal, hexadecimal,  and octal numbers.

Parameters:

 nm - the string to decode

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.InternalError

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.InternalError

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Error
                   |
                   +----java.lang.VirtualMachineError
                           |
                           +----java.lang.InternalError

______________________________________________________________________________

 public class InternalError

 extends VirtualMachineError

Thrown to indicate some unexpected internal error has occurred in  the Java Virtual Machine.

______________________________________________________________________________

 	InternalError()

 Constructs an InternalError with no detail message.

 	InternalError(String)

 Constructs an InternalError with the specified  detail message.

 InternalError

  public InternalError()

 Constructs an InternalError with no detail message.

 InternalError

  public InternalError(String s)

 Constructs an InternalError with the specified  detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.InterruptedException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.InterruptedException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.InterruptedException

______________________________________________________________________________

 public class InterruptedException

 extends Exception

Thrown when a thread is waiting, sleeping, or otherwise paused for  a long time and another thread interrupts it using the  interrupt method in class Thread.

See Also:

wait, wait, wait, sleep, interrupt, interrupted

______________________________________________________________________________

 	InterruptedException()

 Constructs an InterruptedException with no detail message.

 	InterruptedException(String)

 Constructs an InterruptedException with the  specified detail message.

 InterruptedException

  public InterruptedException()

 Constructs an InterruptedException with no detail message.

 InterruptedException

  public InterruptedException(String s)

 Constructs an InterruptedException with the  specified detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.LinkageError

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.LinkageError

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Error
                   |
                   +----java.lang.LinkageError

______________________________________________________________________________

 public class LinkageError

 extends Error

Subclasses of LinkageError indicate that a class has  some dependency on another class; however, the latter class has  incompatibly changed after the compilation of the former class.

______________________________________________________________________________

 	LinkageError()

 Constructs a LinkageError with no detail message.

 	LinkageError(String)

 Constructs a LinkageError with the specified detail  message.

 LinkageError

  public LinkageError()

 Constructs a LinkageError with no detail message.

 LinkageError

  public LinkageError(String s)

 Constructs a LinkageError with the specified detail  message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.Long

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.Long

java.lang.Object
   |
   +----java.lang.Number
           |
           +----java.lang.Long

______________________________________________________________________________

 public final class Long

 extends Number

The Long class wraps a value of the primitive type long  in an object. An object of type Long contains a single  field whose type is long.

 In addition, this class provides several methods for converting a  long to a String and a  String to a long, as well as other  constants and methods useful when dealing with a  long.

______________________________________________________________________________

 	MAX_VALUE

 The largest value of type long.

 	MIN_VALUE

 The smallest value of type long.

 	TYPE

 The Class object representing the primitive type long.

 	Long(long)

 Constructs a newly allocated Long object that  represents the primitive long argument.

 	Long(String)

 Constructs a newly allocated Long object that  represents the value represented by the string.

 	byteValue()

 Returns the value of this Long as a byte.

 	doubleValue()

 Returns the value of this Long as a double.

 	equals(Object)

 Compares this object against the specified object.

 	floatValue()

 Returns the value of this Long as a float.

 	getLong(String)

 Determines the long value of the system property  with the specified name.

 	getLong(String, Long)

 Determines the long value of the system property  with the specified name.

 	getLong(String, long)

 Determines the long value of the system property  with the specified name.

 	hashCode()

 Computes a hashcode for this Long.

 	intValue()

 Returns the value of this Long as an int.

 	longValue()

 Returns the value of this Long as a long.

 	parseLong(String)

 Parses the string argument as a signed decimal long.

 	parseLong(String, int)

 Parses the string argument as a signed long in the  radix specified by the second argument.

 	shortValue()

 Returns the value of this Long as a short.

 	toBinaryString(long)

 Creates a string representation of the long argument as an  unsigned integer in base 2.

 	toHexString(long)

 Creates a string representation of the long argument as an  unsigned integer in base 16.

 	toOctalString(long)

 Creates a string representation of the long argument as an  unsigned integer in base 8.

 	toString()

 Returns a String object representing this Long's value.

 	toString(long)

 Returns a new String object representing the specified integer.

 	toString(long, int)

 Creates a string representation of the first argument in the  radix specified by the second argument.

 	valueOf(String)

 Returns a new long object initialized to the value of the  specified String.

 	valueOf(String, int)

 Returns a new long object initialized to the value of the  specified String.

 MIN_VALUE

  public final static long MIN_VALUE

 The smallest value of type long.

 MAX_VALUE

  public final static long MAX_VALUE

 The largest value of type long.

 TYPE

  public final static Class TYPE

 The Class object representing the primitive type long.

 Long

  public Long(long value)

 Constructs a newly allocated Long object that  represents the primitive long argument.

Parameters:

 value - the value to be represented by the Long.

 Long

  public Long(String s) throws NumberFormatException

 Constructs a newly allocated Long object that  represents the value represented by the string. The string is  converted to an long  value as if by the  valueOf method.

Parameters:

 s - the string to be converted to a Long.

Throws: NumberFormatException

 if the String does not  contain a parsable long integer.

See Also:

valueOf

 toString

  public static String toString(long i,
                                int radix)

 Creates a string representation of the first argument in the  radix specified by the second argument.

 If the radix is smaller than Character.MIN_RADIX or  larger than Character.MAX_RADIX, then the radix  10 is used instead.

 If the first argument is negative, the first element of the  result is the ASCII minus sign '-'. If the first  argument is not negative, no sign character appears in the result.  The following ASCII characters are used as digits:

  0123456789abcdefghijklmnopqrstuvwxyz

Parameters:

 i - a long.

 radix - the radix.

Returns:

 a string representation of the argument in the specified radix.

See Also:

MAX_RADIX, MIN_RADIX

 toHexString

  public static String toHexString(long i)

 Creates a string representation of the long argument as an  unsigned integer in base 16.

 The unsigned long value is the argument plus 264 if  the argument is negative; otherwise, it is equal to the argument.  This value is converted to a string of ASCII digits in hexadecimal  (base 16) with no extra leading 0s.

Parameters:

 i - a long.

Returns:

 the string representation of the unsigned long value  represented by the argument in hexadecimal (base 16).

 toOctalString

  public static String toOctalString(long i)

 Creates a string representation of the long argument as an  unsigned integer in base 8.

 The unsigned long value is the argument plus 264 if  the argument is negative; otherwise, it is equal to the argument.  This value is converted to a string of ASCII digits in octal  (base 8) with no extra leading 0s.

Parameters:

 i - a long.

Returns:

 the string representation of the unsigned long value  represented by the argument in octal (base 8).

 toBinaryString

  public static String toBinaryString(long i)

 Creates a string representation of the long argument as an  unsigned integer in base 2.

 The unsigned long value is the argument plus 264 if  the argument is negative; otherwise, it is equal to the argument.  This value is converted to a string of ASCII digits in binary  (base 2) with no extra leading 0s.

Parameters:

 i - a long.

Returns:

 the string representation of the unsigned long value  represented by the argument in binary (base 2).

 toString

  public static String toString(long i)

 Returns a new String object representing the specified integer. The radix  is assumed to be 10.

Parameters:

 i - a long to be converted.

Returns:

 a string representation of the argument in base 10.

 parseLong

  public static long parseLong(String s,
                               int radix) throws NumberFormatException

 Parses the string argument as a signed long in the  radix specified by the second argument. The characters in the  string must all be digits of the specified radix (as determined by  whether Character.digit returns a  nonnegative value), except that the first character may be an  ASCII minus sign '-' to indicate a negative value.  The resulting long  value is returned.

Parameters:

 s - the String containing the  long.

 radix - the radix to be used.

Returns:

 the long represented by the string argument in  the specified radix.

Throws: NumberFormatException

 if the string does not contain a  parsable integer.

 parseLong

  public static long parseLong(String s) throws NumberFormatException

 Parses the string argument as a signed decimal long.  The characters in the string must all be decimal digits, except  that the first character may be an ASCII minus sign  '-' to indicate a negative value.

Parameters:

 s - a string.

Returns:

 the long represented by the argument in decimal.

Throws: NumberFormatException

 if the string does not contain a  parsable long.

 valueOf

  public static Long valueOf(String s,
                             int radix) throws NumberFormatException

 Returns a new long object initialized to the value of the  specified String. Throws an exception if the String cannot be  parsed as a long.

Parameters:

 s - the String containing the  long.

 radix - the radix to be used.

Returns:

 a newly constructed Long initialized to the  value represented by the string argument in the specified  radix.

Throws: NumberFormatException

 If the String does not  contain a parsable long.

 valueOf

  public static Long valueOf(String s) throws NumberFormatException

 Returns a new long object initialized to the value of the  specified String. Throws an exception if the String cannot be  parsed as a long. The radix is assumed to be 10.

Parameters:

 s - the string to be parsed.

Returns:

 a newly constructed Long initialized to the  value represented by the string argument.

Throws: NumberFormatException

 If the String does not  contain a parsable long.

 byteValue

  public byte byteValue()

 Returns the value of this Long as a byte.

Overrides:

byteValue in class Number

 shortValue

  public short shortValue()

 Returns the value of this Long as a short.

Overrides:

shortValue in class Number

 intValue

  public int intValue()

 Returns the value of this Long as an int.

Returns:

 the long value represented by this object is  converted to type int  and the result of the  conversion is returned.

Overrides:

intValue in class Number

 longValue

  public long longValue()

 Returns the value of this Long as a long.

Returns:

 the long value represented by this object.

Overrides:

longValue in class Number

 floatValue

  public float floatValue()

 Returns the value of this Long as a float.

Returns:

 the long value represented by this object is  converted to type float  and the result of  the conversion is returned.

Overrides:

floatValue in class Number

 doubleValue

  public double doubleValue()

 Returns the value of this Long as a double.

Returns:

 the long value represented by this object that  is converted to type double  and the result of  the conversion is returned.

Overrides:

doubleValue in class Number

 toString

  public String toString()

 Returns a String object representing this Long's value.

Returns:

 a string representation of this object in base 10.

Overrides:

toString in class Object

 hashCode

  public int hashCode()

 Computes a hashcode for this Long.

Returns:

 a hash code value for this object.

Overrides:

hashCode in class Object

 equals

  public boolean equals(Object obj)

 Compares this object against the specified object.  The result is true if and only if the argument is  not null and is a Long  object that  contains the same long value as this object.

Parameters:

 obj - the object to compare with.

Returns:

true if the objects are the same;  false otherwise.

Overrides:

equals in class Object

 getLong

  public static Long getLong(String nm)

 Determines the long value of the system property  with the specified name.

 The first argument is treated as the name of a system property.  System properties are accessible through getProperty  and , a method defined by the System class. The  string value of this property is then interpreted as a long value  and a Long object representing this value is returned.  Details of possible numeric formats can be found with the  definition of getProperty.

 If there is no property with the specified name, or if the  property does not have the correct numeric format, then  null is returned.

Parameters:

 nm - property name.

Returns:

 the Long value of the property.

See Also:

getProperty, getProperty

 getLong

  public static Long getLong(String nm,
                             long val)

 Determines the long value of the system property  with the specified name.

 The first argument is treated as the name of a system property.  System properties are accessible through getProperty  and , a method defined by the System class. The  string value of this property is then interpreted as a long value  and a Long object representing this value is returned.  Details of possible numeric formats can be found with the  definition of getProperty.

 If there is no property with the specified name, or if the  property does not have the correct numeric format, then a  Long  object that represents the value of the second  argument is returned.

Parameters:

 nm - property name.

 val - default value.

Returns:

 the Long value of the property.

See Also:

getProperty, getProperty

 getLong

  public static Long getLong(String nm,
                             Long val)

 Determines the long value of the system property  with the specified name.

 The first argument is treated as the name of a system property.  System properties are accessible through getProperty  and , a method defined by the System class. The  string value of this property is then interpreted as a long value  and a Long object representing this value is returned.

 If the property value begins with "0x" or  "# ", not followed by a minus sign, the rest  of it is parsed as a hexadecimal integer exactly as for the method  Long.valueOf  with radix 16.

 If the property value begins with "0",  then it is parsed as an octal integer exactly as for the method  Long.valueOf  with radix 8.

 Otherwise the property value is parsed as a decimal integer  exactly as for the method Long.valueOf with radix 10.

 Note that, in every case, neither L nor  l  is permitted to appear at the end of the string.

 The second argument is the default value. If there is no property  of the specified name, or if the property does not have the  correct numeric format, then the second argument is returned.

Parameters:

 nm - the property name.

 val - the default Long value.

Returns:

 the long value of the property.

See Also:

valueOf, getProperty, getProperty

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.Math

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.Math

java.lang.Object
   |
   +----java.lang.Math

______________________________________________________________________________

 public final class Math

 extends Object

The class Math contains methods for performing basic  numeric operations such as the elementary exponential, logarithm,  square root, and trigonometric functions.

 To help ensure portability of Java programs, the definitions of  many of the numeric functions in this package require that they  produce the same results as certain published algorithms. These  algorithms are available from the well-known network library  netlib  as the package "Freely Distributable  Math Library" (fdlibm). These algorithms, which  are written in the C programming language, are then to be  understood as executed with all floating-point operations  following the rules of Java floating-point arithmetic.

 The network library may be found on the World Wide Web at

  http://netlib.att.com/

 then perform a keyword search for "fdlibm".

 The Java math library is defined with respect to the version of  fdlibm  dated January 4, 1995. Where  fdlibm provides more than one definition for a  function (such as acos), use the "IEEE 754 core  function" version (residing in a file whose name begins with  the letter e).

______________________________________________________________________________

 	E

 The double value that is closer than any other to  e , the base of the natural logarithms.

 	PI

 The double value that is closer than any other to  pi , the ratio of the circumference of a circle to its diameter.

 	abs(double)

 Returns the absolute value of a double value.

 	abs(float)

 Returns the absolute value of a float value.

 	abs(int)

 Returns the absolute value of an int value.

 	abs(long)

 Returns the absolute value of a long value.

 	acos(double)

 Returns the arc cosine of an angle, in the range of 0.0 through  pi.

 	asin(double)

 Returns the arc sine of an angle, in the range of -pi/2 through  pi/2.

 	atan(double)

 Returns the arc tangent of an angle, in the range of -pi/2  through pi/2.

 	atan2(double, double)

 Converts rectangular coordinates (b, a)  to polar (r, theta).

 	ceil(double)

 Returns the smallest (closest to negative infinity)  double  value that is not less than the argument and is  equal to a mathematical integer.

 	cos(double)

 Returns the trigonometric cosine of an angle.

 	exp(double)

 Returns the exponential number e (i.e., 2.718...) raised to  the power of a double value.

 	floor(double)

 Returns the largest (closest to positive infinity)  double  value that is not greater than the argument and  is equal to a mathematical integer.

 	IEEEremainder(double, double)

 Computes the remainder operation on two arguments as prescribed  by the IEEE 754 standard.

 	log(double)

 Returns the natural logarithm (base e) of a double  value.

 	max(double, double)

 Returns the greater of two double values.

 	max(float, float)

 Returns the greater of two float values.

 	max(int, int)

 Returns the greater of two int values.

 	max(long, long)

 Returns the greater of two long values.

 	min(double, double)

 Returns the smaller of two double values.

 	min(float, float)

 Returns the smaller of two float values.

 	min(int, int)

 Returns the smaller of two int values.

 	min(long, long)

 Returns the smaller of two long values.

 	pow(double, double)

 Returns of value of the first argument raised to the power of the  second argument.

 	random()

 Returns a random number between 0.0 and 1.0.

 	rint(double)

 returns the closest integer to the argument.

 	round(double)

 Returns the closest long to the argument.

 	round(float)

 Returns the closest int to the argument.

 	sin(double)

 Returns the trigonometric sine of an angle.

 	sqrt(double)

 Returns the square root of a double value.

 	tan(double)

 Returns the trigonometric tangent of an angle.

 E

  public final static double E

 The double value that is closer than any other to  e, the base of the natural logarithms.

 PI

  public final static double PI

 The double value that is closer than any other to  pi, the ratio of the circumference of a circle to its diameter.

 sin

  public static double sin(double a)

 Returns the trigonometric sine of an angle.

Parameters:

 a - an angle, in radians.

Returns:

 the sine of the argument.

 cos

  public static double cos(double a)

 Returns the trigonometric cosine of an angle.

Parameters:

 a - an angle, in radians.

Returns:

 the cosine of the argument.

 tan

  public static double tan(double a)

 Returns the trigonometric tangent of an angle.

Parameters:

 a - an angle, in radians.

Returns:

 the tangent of the argument.

 asin

  public static double asin(double a)

 Returns the arc sine of an angle, in the range of -pi /2 through  pi/2.

Parameters:

 a - an angle, in radians.

Returns:

 the arc sine of the argument.

 acos

  public static double acos(double a)

 Returns the arc cosine of an angle, in the range of 0.0 through  pi.

Parameters:

 a - an angle, in radians.

Returns:

 the arc cosine of the argument.

 atan

  public static double atan(double a)

 Returns the arc tangent of an angle, in the range of -pi/2  through pi/2.

Parameters:

 a - an angle, in radians.

Returns:

 the arc tangent of the argument.

 exp

  public static double exp(double a)

 Returns the exponential number e (i.e., 2.718...) raised to   the power of a double value.

Parameters:

 a - a double value.

Returns:

 the value ea, where e is the base of  the natural logarithms.

 log

  public static double log(double a)

 Returns the natural logarithm (base e) of a double  value.

Parameters:

 a - a number greater than 0.0.

Returns:

 the value ln a, the natural logarithm of  a.

 sqrt

  public static double sqrt(double a)

 Returns the square root of a double value.

Parameters:

 a - a double value.  a.-->

Returns:

 the square root of a.  If the argument is NaN or less than zero, the result is NaN.

 IEEEremainder

  public static double IEEEremainder(double f1,
                                     double f2)

 Computes the remainder operation on two arguments as prescribed  by the IEEE 754 standard.  The remainder value is mathematically equal to  f1 - f2  &times; n,  where n is the mathematical integer closest to the exact  mathematical value of the quotient f1/f2, and if two  mathematical integers are equally close to f1/f2,  then n  is the integer that is even. If the remainder is  zero, its sign is the same as the sign of the first argument.

Parameters:

 f1 - the dividend.

 f2 - the divisor.

Returns:

 the remainder when f1 is divided by  f2.

 ceil

  public static double ceil(double a)

 Returns the smallest (closest to negative infinity)  double  value that is not less than the argument and is  equal to a mathematical integer.

Parameters:

 a - a double value.  a &rceil;.-->

Returns:

 the smallest (closest to negative infinity)  double  value that is not less than the argument  and is equal to a mathematical integer.

 floor

  public static double floor(double a)

 Returns the largest (closest to positive infinity)  double  value that is not greater than the argument and  is equal to a mathematical integer.

Parameters:

 a - a double value.

 a - an assigned value.  a &rfloor;.-->

Returns:

 the largest (closest to positive infinity)  double  value that is not greater than the argument  and is equal to a mathematical integer.

 rint

  public static double rint(double a)

 returns the closest integer to the argument.

Parameters:

 a - a double value.

Returns:

 the closest double value to a that is  equal to a mathematical integer. If two double  values that are mathematical integers are equally close to the  value of the argument, the result is the integer value that  is even.

 atan2

  public static double atan2(double a,
                             double b)

 Converts rectangular coordinates (b, a)  to polar (r, theta).  This method computes the phase theta  by computing an arc tangent  of b/a in the range of -pi to pi.

Parameters:

 a - a double value.

 b - a double value.

Returns:

 the theta component of the point  (r, theta)  in polar coordinates that corresponds to the point  (b, a ) in Cartesian coordinates.

 pow

  public static double pow(double a,
                           double b)

 Returns of value of the first argument raised to the power of the  second argument.

 If (a == 0.0), then b must be  greater than 0.0 ; otherwise an exception is thrown.  An exception also will occur if (a <= 0.0)  and b is not equal to a whole number.

Parameters:

 a - a double value.

 b - a double value.

Returns:

 the value ab.

Throws: ArithmeticException

 if (a == 0.0) and  (b <= 0.0), or  if (a <= 0.0) and b  is not equal to a whole number.

 round

  public static int round(float a)

 Returns the closest int to the argument.

 If the argument is negative infinity or any value less than or  equal to the value of Integer.MIN_VALUE, the result is  equal to the value of Integer.MIN_VALUE.

 If the argument is positive infinity or any value greater than or  equal to the value of Integer.MAX_VALUE, the result is  equal to the value of Integer.MAX_VALUE.

Parameters:

 a - a float value.

Returns:

 the value of the argument rounded to the nearest  int value.

See Also:

MAX_VALUE, MIN_VALUE

 round

  public static long round(double a)

 Returns the closest long to the argument.

 If the argument is negative infinity or any value less than or  equal to the value of Long.MIN_VALUE, the result is  equal to the value of Long.MIN_VALUE.

 If the argument is positive infinity or any value greater than or  equal to the value of Long.MAX_VALUE, the result is  equal to the value of Long.MAX_VALUE.

Parameters:

 a - a double value.

Returns:

 the value of the argument rounded to the nearest  long value.

See Also:

MAX_VALUE, MIN_VALUE

 random

  public static synchronized double random()

 Returns a random number between 0.0 and 1.0.  Random number generators are often referred to as pseudorandom number  generators because the numbers produced tend to repeat themselves after  a period of time.

Returns:

 a pseudorandom double between 0.0  and 1.0.

See Also:

nextDouble

 abs

  public static int abs(int a)

 Returns the absolute value of an int value.  If the argument is not negative, the argument is returned.  If the argument is negative, the negation of the argument is returned.

 Note that if the argument is equal to the value of  Integer.MIN_VALUE , the most negative representable  int value, the result is that same value, which is  negative.

Parameters:

 a - an int value.

Returns:

 the absolute value of the argument.

See Also:

MIN_VALUE

 abs

  public static long abs(long a)

 Returns the absolute value of a long value.  If the argument is not negative, the argument is returned.  If the argument is negative, the negation of the argument is returned.

 Note that if the argument is equal to the value of  Long.MIN_VALUE , the most negative representable  long value, the result is that same value, which is  negative.

Parameters:

 a - a long value.

Returns:

 the absolute value of the argument.

See Also:

MIN_VALUE

 abs

  public static float abs(float a)

 Returns the absolute value of a float value.  If the argument is not negative, the argument is returned.  If the argument is negative, the negation of the argument is returned.

Parameters:

 a - a float value.

Returns:

 the absolute value of the argument.

 abs

  public static double abs(double a)

 Returns the absolute value of a double value.  If the argument is not negative, the argument is returned.  If the argument is negative, the negation of the argument is returned.

Parameters:

 a - a double value.

Returns:

 the absolute value of the argument.

 max

  public static int max(int a,
                        int b)

 Returns the greater of two int values.

Parameters:

 a - an int value.

 b - an int value.

Returns:

 the larger of a and b.

 max

  public static long max(long a,
                         long b)

 Returns the greater of two long values.

Parameters:

 a - a long value.

 b - a long value.

Returns:

 the larger of a and b.

 max

  public static float max(float a,
                          float b)

 Returns the greater of two float values.

Parameters:

 a - a float value.

 b - a float value.

Returns:

 the larger of a and b.

 max

  public static double max(double a,
                           double b)

 Returns the greater of two double values.

Parameters:

 a - a double value.

 b - a double value.

Returns:

 the larger of a and b.

 min

  public static int min(int a,
                        int b)

 Returns the smaller of two int values.

Parameters:

 a - an int value.

 b - an int value.

Returns:

 the smaller of a and b.

 min

  public static long min(long a,
                         long b)

 Returns the smaller of two long values.

Parameters:

 a - a long value.

 b - a long value.

Returns:

 the smaller of a and b.

 min

  public static float min(float a,
                          float b)

 Returns the smaller of two float values.

Parameters:

 a - a float value.

 b - a float value.

Returns:

 the smaller of a and b.

 min

  public static double min(double a,
                           double b)

 Returns the smaller of two double values.

Parameters:

 a - a double value.

 b - a double value.

Returns:

 the smaller of a and b.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.NegativeArraySizeException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.NegativeArraySizeException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.RuntimeException
                           |
                           +----java.lang.NegativeArraySizeException

______________________________________________________________________________

 public class NegativeArraySizeException

 extends RuntimeException

Thrown if an application tries to create an array with negative size.

______________________________________________________________________________

 	NegativeArraySizeException()

 Constructs a NegativeArraySizeException with no  detail message.

 	NegativeArraySizeException(String)

 Constructs a NegativeArraySizeException with the  specified detail message.

 NegativeArraySizeException

  public NegativeArraySizeException()

 Constructs a NegativeArraySizeException with no  detail message.

 NegativeArraySizeException

  public NegativeArraySizeException(String s)

 Constructs a NegativeArraySizeException with the  specified detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.NoClassDefFoundError

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.NoClassDefFoundError

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Error
                   |
                   +----java.lang.LinkageError
                           |
                           +----java.lang.NoClassDefFoundError

______________________________________________________________________________

 public class NoClassDefFoundError

 extends LinkageError

Thrown if the Java Virtual Machine or a classloader tries to load  in the definition of a class (as part of a normal method call or  as part of creating a new instance using the new  expression) and no definition of the class could be found.

 The searched-for class definition existed when the currently  executing class was compiled, but the definition can no longer be  found.

______________________________________________________________________________

 	NoClassDefFoundError()

 Constructs a NoClassDefFoundError with no detail message.

 	NoClassDefFoundError(String)

 Constructs a NoClassDefFoundError with the specified  detail message.

 NoClassDefFoundError

  public NoClassDefFoundError()

 Constructs a NoClassDefFoundError with no detail message.

 NoClassDefFoundError

  public NoClassDefFoundError(String s)

 Constructs a NoClassDefFoundError with the specified  detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.NoSuchFieldError

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.NoSuchFieldError

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Error
                   |
                   +----java.lang.LinkageError
                           |
                           +----java.lang.IncompatibleClassChangeError
                                   |
                                   +----java.lang.NoSuchFieldError

______________________________________________________________________________

 public class NoSuchFieldError

 extends IncompatibleClassChangeError

Thrown if an application tries to access or modify a specified  field of an object, and that object no longer has that field.

 Normally, this error is caught by the compiler; this error can  only occur at run time if the definition of a class has  incompatibly changed.

______________________________________________________________________________

 	NoSuchFieldError()

 Constructs a NoSuchFieldException with no detail message.

 	NoSuchFieldError(String)

 Constructs a NoSuchFieldException with the specified  detail message.

 NoSuchFieldError

  public NoSuchFieldError()

 Constructs a NoSuchFieldException with no detail message.

 NoSuchFieldError

  public NoSuchFieldError(String s)

 Constructs a NoSuchFieldException with the specified  detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.NoSuchFieldException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.NoSuchFieldException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.NoSuchFieldException

______________________________________________________________________________

 public class NoSuchFieldException

 extends Exception

Signals that the class doesn't have a field of a specified name.

______________________________________________________________________________

 	NoSuchFieldException()

 Constructor.

 	NoSuchFieldException(String)

 Constructor with a detail message.

 NoSuchFieldException

  public NoSuchFieldException()

 Constructor.

 NoSuchFieldException

  public NoSuchFieldException(String s)

 Constructor with a detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.NoSuchMethodError

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.NoSuchMethodError

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Error
                   |
                   +----java.lang.LinkageError
                           |
                           +----java.lang.IncompatibleClassChangeError
                                   |
                                   +----java.lang.NoSuchMethodError

______________________________________________________________________________

 public class NoSuchMethodError

 extends IncompatibleClassChangeError

Thrown if an application tries to call a specified method of a  class (either static or instance), and that class no longer has a  definition of that method.

 Normally, this error is caught by the compiler; this error can  only occur at run time if the definition of a class has  incompatibly changed.

______________________________________________________________________________

 	NoSuchMethodError()

  	NoSuchMethodError(String)

 Constructs a NoSuchMethodException with the  specified detail message.

 NoSuchMethodError

  public NoSuchMethodError()

 NoSuchMethodError

  public NoSuchMethodError(String s)

 Constructs a NoSuchMethodException with the  specified detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.NoSuchMethodException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.NoSuchMethodException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.NoSuchMethodException

______________________________________________________________________________

 public class NoSuchMethodException

 extends Exception

Thrown when a particular method cannot be found.

______________________________________________________________________________

 	NoSuchMethodException()

 Constructs a NoSuchMethodException without a detail message.

 	NoSuchMethodException(String)

 Constructs a NoSuchMethodException with a detail message.

 NoSuchMethodException

  public NoSuchMethodException()

 Constructs a NoSuchMethodException  without a detail message.

 NoSuchMethodException

  public NoSuchMethodException(String s)

 Constructs a NoSuchMethodException with a detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.NullPointerException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.NullPointerException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.RuntimeException
                           |
                           +----java.lang.NullPointerException

______________________________________________________________________________

 public class NullPointerException

 extends RuntimeException

Thrown when an application attempts to use null in a  case where an object is required. These include:

• Calling the instance method of a null object.

• Accessing or modifying the field of a null object.

• Taking the length of null as if it were an array.

• Accessing or modifying the slots of null as if it  were an array.

• Throwing null as if it were a Throwable  value.

 Applications should throw instances of this class to indicate  other illegal uses of the null object.

______________________________________________________________________________

 	NullPointerException()

 Constructs a NullPointerException with no detail message.

 	NullPointerException(String)

 Constructs a NullPointerException with the specified  detail message.

 NullPointerException

  public NullPointerException()

 Constructs a NullPointerException with no detail message.

 NullPointerException

  public NullPointerException(String s)

 Constructs a NullPointerException with the specified  detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.Number

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.Number

java.lang.Object
   |
   +----java.lang.Number

______________________________________________________________________________

 public class Number

 extends Object

 implements Serializable

The abstract class Number is the superclass of  classes Byte, Double, Float,  Integer, Long, and Short.

 Subclasses of Number must provide methods to convert  the represented numeric value to byte, double,  float, int, long, and  short.

See Also:

Byte, Double, Float, Integer, Long, Short

______________________________________________________________________________

 	Number()

 	byteValue()

 Returns the value of the specified number as a byte.

 	doubleValue()

 Returns the value of the specified number as a double.

 	floatValue()

 Returns the value of the specified number as a float.

 	intValue()

 Returns the value of the specified number as an int.

 	longValue()

 Returns the value of the specified number as a long.

 	shortValue()

 Returns the value of the specified number as a short.

 Number

  public Number()

 intValue

  public abstract int intValue()

 Returns the value of the specified number as an int.  This may involve rounding.

Returns:

 the numeric value represented by this object after conversion  to type int.

 longValue

  public abstract long longValue()

 Returns the value of the specified number as a long.  This may involve rounding.

Returns:

 the numeric value represented by this object after conversion  to type long.

 floatValue

  public abstract float floatValue()

 Returns the value of the specified number as a float.  This may involve rounding.

Returns:

 the numeric value represented by this object after conversion  to type float.

 doubleValue

  public abstract double doubleValue()

 Returns the value of the specified number as a double.  This may involve rounding.

Returns:

 the numeric value represented by this object after conversion  to type double.

 byteValue

  public byte byteValue()

 Returns the value of the specified number as a byte.  This may involve rounding or truncation.

Returns:

 the numeric value represented by this object after conversion  to type byte.

 shortValue

  public short shortValue()

 Returns the value of the specified number as a short.  This may involve rounding or truncation.

Returns:

 the numeric value represented by this object after conversion  to type short.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.NumberFormatException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.NumberFormatException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.RuntimeException
                           |
                           +----java.lang.IllegalArgumentException
                                   |
                                   +----java.lang.NumberFormatException

______________________________________________________________________________

 public class NumberFormatException

 extends IllegalArgumentException

Thrown to indicate that the application has attempted to convert  a string to one of the numeric types, but that the string does not  have the appropriate format.

See Also:

toString

______________________________________________________________________________

 	NumberFormatException()

 Constructs a NumberFormatException with no detail message.

 	NumberFormatException(String)

 Constructs a NumberFormatException with the  specified detail message.

 NumberFormatException

  public NumberFormatException()

 Constructs a NumberFormatException with no detail message.

 NumberFormatException

  public NumberFormatException(String s)

 Constructs a NumberFormatException with the  specified detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.Object

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.Object

java.lang.Object

______________________________________________________________________________

 public class Object

Class Object is the root of the class hierarchy.  Every class has Object  as a superclass. All objects,  including arrays, implement the methods of this class.

See Also:

Class

______________________________________________________________________________

 	Object()

 	clone()

 Creates a new object of the same class as this object.

 	equals(Object)

 Compares two Objects for equality.

 	finalize()

 Called by the garbage collector on an object when garbage collection  determines that there are no more references to the object.

 	getClass()

 Returns the runtime class of an object.

 	hashCode()

 Returns a hash code value for the object.

 	notify()

 Wakes up a single thread that is waiting on this object's  monitor.

 	notifyAll()

 Wakes up all threads that are waiting on this object's monitor.

 	toString()

 Returns a string representation of the object.

 	wait()

 Waits to be notified by another thread of a change in this object.

 	wait(long)

 Waits to be notified by another thread of a change in this object.

 	wait(long, int)

 Waits to be notified by another thread of a change in this object.

 Object

  public Object()

 getClass

  public final Class getClass()

 Returns the runtime class of an object.

Returns:

 the object of type Class that represents the  runtime class of the object.

 hashCode

  public int hashCode()

 Returns a hash code value for the object. This method is  supported for the benefit of hashtables such as those provided by  java.util.Hashtable .

 The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during  an execution of a Java application, the hashCode method  must consistently return the same integer. This integer need not  remain consistent from one execution of an application to another  execution of the same application.

• If two objects are equal according to the equals  method, then calling the hashCode method on each of the  two objects must produce the same integer result.

Returns:

 a hash code value for this object.

See Also:

equals, Hashtable

 equals

  public boolean equals(Object obj)

 Compares two Objects for equality.

 The equals method implements an equivalence relation:

• It is reflexive: for any reference value x,  x.equals(x) should return true.

• It is symmetric: for any reference values x and  y , x.equals(y) should return  true if and only if y.equals(x)  returns  true.

• It is transitive: for any reference values x,  y , and z, if x.equals(y)  returns true and y.equals(z) returns  true, then x.equals(z) should return  true .

• It is consistent: for any reference values x  and y , multiple invocations of x.equals(y)  consistently return true  or consistently return  false.

• For any reference value x, x.equals(null)  should return false.

 The equals method for class Object implements the most  discriminating possible equivalence relation on objects; that is,  for any reference values x and y, this  method returns true if and only if x  and  y refer to the same object (x==y has the  value true).

Parameters:

 obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj  argument; false otherwise.

See Also:

hashCode, Hashtable

 clone

  protected Object clone() throws CloneNotSupportedException

 Creates a new object of the same class as this object. It then  initializes each of the new object's fields by assigning it the  same value as the corresponding field in this object. No  constructor is called.

 The clone method of class Object will  only clone an object whose class indicates that it is willing for  its instances to be cloned. A class indicates that its instances  can be cloned by declaring that it implements the  Cloneable interface.

Returns:

 a clone of this instance.

Throws: CloneNotSupportedException

 if the object's class does not  support the Cloneable interface. Subclasses  that override the clone method can also  throw this exception to indicate that an instance cannot  be cloned.

Throws: OutOfMemoryError

 if there is not enough memory.

See Also:

Cloneable

 toString

  public String toString()

 Returns a string representation of the object. In general, the  toString method returns a string that  "textually represents" this object. The result should  be a concise but informative representation that is easy for a  person to read.  It is recommendedthat all subclasses override this method.

 The toString method for class Object  returns a string consisting of the name of the class of which the  object is an instance, the at-sign character `@', and  the unsigned hexadecimal representation of the hash code of the  object.

Returns:

 a string representation of the object.

 notify

  public final void notify()

 Wakes up a single thread that is waiting on this object's  monitor. A thread waits on an object's monitor by calling one of  the wait methods.

 This method should only be called by a thread that is the owner  of this object's monitor. A thread becomes the owner of the  object's monitor in one of three ways:

• By executing a synchronized instance method of that object.

• By executing the body of a synchronized statement  that synchronizes on the object.

• For objects of type Class, by executing a  synchronized static method of that class.

 Only one thread at a time can own an object's monitor.

Throws: IllegalMonitorStateException

 if the current thread is not  the owner of this object's monitor.

See Also:

notifyAll, wait

 notifyAll

  public final void notifyAll()

 Wakes up all threads that are waiting on this object's monitor. A  thread waits on an object's monitor by calling one of the  wait methods.

 This method should only be called by a thread that is the owner  of this object's monitor. See the notify method for a  description of the ways in which a thread can become the owner of  a monitor.

Throws: IllegalMonitorStateException

 if the current thread is not  the owner of this object's monitor.

See Also:

notify, wait

 wait

  public final void wait(long timeout) throws InterruptedException

 Waits to be notified by another thread of a change in this object.

 The current thread must own this object's monitor. The thread  releases ownership of this monitor and waits until either of the  following two conditions has occurred:

• Another thread notifies threads waiting on this object's monitor  to wake up either through a call to the notify method  or the notifyAll  method.

• The timeout period, specified by the timeout  argument in milliseconds, has elapsed.

 The thread then waits until it can re-obtain ownership of the  monitor and resumes execution.

 This method should only be called by a thread that is the owner  of this object's monitor. See the notify method for a  description of the ways in which a thread can become the owner of  a monitor.

Parameters:

 timeout - the maximum time to wait in milliseconds.

Throws: IllegalArgumentException

 if the value of timeout is 	negative.

Throws: IllegalMonitorStateException

 if the current thread is not  the owner of the object's monitor.

Throws: InterruptedException

 if another thread has  interrupted this thread.

See Also:

notify, notifyAll

 wait

  public final void wait(long timeout,
                         int nanos) throws InterruptedException

 Waits to be notified by another thread of a change in this object.

 This method is similar to the wait method of one  argument, but it allows finer control over the amount of time to  wait for a notification before giving up.

 The current thread must own this object's monitor. The thread  releases ownership of this monitor and waits until either of the  following two conditions has occurred:

• Another thread notifies threads waiting on this object's monitor  to wake up either through a call to the notify method  or the notifyAll  method.

• The timeout period, specified by timeout  milliseconds plus nanos nanoseconds arguments, has  elapsed.

 The thread then waits until it can re-obtain ownership of the  monitor and resumes execution

 This method should only be called by a thread that is the owner  of this object's monitor. See the notify method for a  description of the ways in which a thread can become the owner of  a monitor.

Parameters:

 timeout - the maximum time to wait in milliseconds.

 nano - additional time, in nanoseconds range  0-999999.

Throws: IllegalArgumentException

 if the value of timeout is 	negative or the value of nanos is 	not in the range 0-999999.

Throws: IllegalMonitorStateException

 if the current thread is not  the owner of this object's monitor.

Throws: InterruptedException

 if another thread has  interrupted this thread.

 wait

  public final void wait() throws InterruptedException

 Waits to be notified by another thread of a change in this object.

 The current thread must own this object's monitor. The thread  releases ownership of this monitor and waits until another thread  notifies threads waiting on this object's monitor to wake up  either through a call to the notify method or the  notifyAll method. The thread then waits until it can  re-obtain ownership of the monitor and resumes execution.

 This method should only be called by a thread that is the owner  of this object's monitor. See the notify method for a  description of the ways in which a thread can become the owner of  a monitor.

Throws: IllegalMonitorStateException

 if the current thread is not  the owner of the object's monitor.

Throws: InterruptedException

 if another thread has  interrupted this thread.

See Also:

notify, notifyAll

 finalize

  protected void finalize() throws Throwable

 Called by the garbage collector on an object when garbage collection  determines that there are no more references to the object.  A subclass overrides the finalize method to dispose of  system resources or to perform other cleanup.

 Any exception thrown by the finalize method causes  the finalization of this object to be halted, but is otherwise  ignored.

 The finalize method in Object does  nothing.

Throws: Throwable

 [Need description!]

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.OutOfMemoryError

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.OutOfMemoryError

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Error
                   |
                   +----java.lang.VirtualMachineError
                           |
                           +----java.lang.OutOfMemoryError

______________________________________________________________________________

 public class OutOfMemoryError

 extends VirtualMachineError

Thrown when the Java Virtual Machine cannot allocate an object  because it is out of memory, and no more memory could be made  available by the garbage collector.

______________________________________________________________________________

 	OutOfMemoryError()

 Constructs an OutOfMemoryError with no detail message.

 	OutOfMemoryError(String)

 Constructs an OutOfMemoryError with the specified  detail message.

 OutOfMemoryError

  public OutOfMemoryError()

 Constructs an OutOfMemoryError with no detail message.

 OutOfMemoryError

  public OutOfMemoryError(String s)

 Constructs an OutOfMemoryError with the specified  detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.Process

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.Process

java.lang.Object
   |
   +----java.lang.Process

______________________________________________________________________________

 public class Process

 extends Object

The exec methods return an  instance of a subclass of Process  that can be used to  control the process and obtain information about it.

 The subprocess is not killed when there are no more references to  the Process  object, but rather the subprocess  continues executing asynchronously.

See Also:

exec, exec, exec, exec

______________________________________________________________________________

 	Process()

 	destroy()

 Kills the subprocess.

 	exitValue()

 Returns the exit value for the subprocess.

 	getErrorStream()

 Gets the error stream of the subprocess.

 	getInputStream()

 Gets the input stream of the subprocess.

 	getOutputStream()

 Gets the output stream of the subprocess.

 	waitFor()

 Waits for the subprocess to complete.

 Process

  public Process()

 getOutputStream

  public abstract OutputStream getOutputStream()

 Gets the output stream of the subprocess.  This stream is usually buffered.

Returns:

 the output stream connected to the normal input of the  subprocess.

 getInputStream

  public abstract InputStream getInputStream()

 Gets the input stream of the subprocess.  This stream is usually buffered.

Returns:

 the input stream connected to the normal output of the  subprocess.

 getErrorStream

  public abstract InputStream getErrorStream()

 Gets the error stream of the subprocess.  This stream is usually unbuffered.

Returns:

 the input stream connected to the error stream of the  subprocess.

 waitFor

  public abstract int waitFor() throws InterruptedException

 Waits for the subprocess to complete. This method returns  immediately if the subprocess has already terminated. If the  subprocess has not yet terminated, the calling thread will be  blocked until the subprocess exits.

Returns:

 the exit value of the process.

Throws: InterruptedException

 if the waitFor was  interrupted.

 exitValue

  public abstract int exitValue()

 Returns the exit value for the subprocess.

Returns:

 the exit value of the subprocess.

Throws: IllegalThreadStateException

 if the subprocess has not yet  terminated.

 destroy

  public abstract void destroy()

 Kills the subprocess.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.reflect.Array

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.reflect.Array

java.lang.Object
   |
   +----java.lang.reflect.Array

______________________________________________________________________________

 public final class Array

 extends Object

The Array class provides static methods to dynamically create and  access Java arrays.

Array permits widening conversions to occur during a get or set  operation, but throws an IllegalArgumentException if a narrowing  conversion would occur.

______________________________________________________________________________

 	get(Object, int)

 Returns the value of the indexed component in the specified  array object.

 	getBoolean(Object, int)

 Returns the value of the indexed component in the specified  array object, as a boolean.

 	getByte(Object, int)

 Returns the value of the indexed component in the specified  array object, as a byte.

 	getChar(Object, int)

 Returns the value of the indexed component in the specified  array object, as a char.

 	getDouble(Object, int)

 Returns the value of the indexed component in the specified  array object, as a double.

 	getFloat(Object, int)

 Returns the value of the indexed component in the specified  array object, as a float.

 	getInt(Object, int)

 Returns the value of the indexed component in the specified  array object, as an int.

 	getLength(Object)

 Returns the length of the specified array object, as an int.

 	getLong(Object, int)

 Returns the value of the indexed component in the specified  array object, as a long.

 	getShort(Object, int)

 Returns the value of the indexed component in the specified  array object, as a short.

 	newInstance(Class, int)

 Creates a new array with the specified component type and  length.

 	newInstance(Class, int[])

 Creates a new array with the specified component type and  dimensions.

 	set(Object, int, Object)

 Sets the value of the indexed component of the specified array  object to the specified new value.

 	setBoolean(Object, int, boolean)

 Sets the value of the indexed component of the specified array  object to the specified boolean value.

 	setByte(Object, int, byte)

 Sets the value of the indexed component of the specified array  object to the specified boolean value.

 	setChar(Object, int, char)

 Sets the value of the indexed component of the specified array  object to the specified byte value.

 	setDouble(Object, int, double)

 Sets the value of the indexed component of the specified array  object to the specified double value.

 	setFloat(Object, int, float)

 Sets the value of the indexed component of the specified array  object to the specified float value.

 	setInt(Object, int, int)

 Sets the value of the indexed component of the specified array  object to the specified int value.

 	setLong(Object, int, long)

 Sets the value of the indexed component of the specified array  object to the specified long value.

 	setShort(Object, int, short)

 Sets the value of the indexed component of the specified array  object to the specified short value.

 newInstance

  public static Object newInstance(Class componentType,
                                   int length) throws NegativeArraySizeException

 Creates a new array with the specified component type and  length.  The effect is that of the equivalent array creation expression:

    new componentType[length]

Parameters:

 componentType - the Class object representing the  component type of the new array

 length - the length of the new array

Returns:

 the new array

Throws: NullPointerException

 if the specified  componentType parameter is null

Throws: NegativeArraySizeException

 if the specified length  is negative

 newInstance

  public static Object newInstance(Class componentType,
                                   int dimensions[]) throws IllegalArgumentException, NegativeArraySizeException

 Creates a new array with the specified component type and  dimensions.

The effect is that of the equivalent array creation expression:

    new componentType[dimensions[0]][dimensions[1]]...

Parameters:

 componentType - the Class object representing the component  type of the new array

 dimensions - an array of ints representing the dimensions of  the new array

Returns:

 the new array

Throws: NullPointerException

 if the specified  componentType argument is null

Throws: IllegalArgumentException

 if the specified dimensions  argument is a zero-dimensional array, or if the number of  requested dimensions exceeds the limit on the number of array dimensions  supported by the implementation (typically 255).

Throws: NegativeArraySizeException

 if any of the components in  the specified dimension argument is negative.

 getLength

  public static int getLength(Object array) throws IllegalArgumentException

 Returns the length of the specified array object, as an int.

Parameters:

 array - the array

Returns:

 the length of the array

Throws: IllegalArgumentException

 if the object argument is not  an array

 get

  public static Object get(Object array,
                           int index) throws IllegalArgumentException, ArrayIndexOutOfBoundsException

 Returns the value of the indexed component in the specified  array object. The value is automatically wrapped in an object  if it has a primitive type.

Parameters:

 array - the array

 index - the index

Returns:

 the (possibly wrapped) value of the indexed component in  the specified array

Throws: NullPointerException

 If the specified object is null

Throws: IllegalArgumentException

 If the specified object is not  an array

Throws: ArrayIndexOutOfBoundsException

 If the specified index  argument is negative, or if it is greater than or equal to the  length of the specified array

 getBoolean

  public static boolean getBoolean(Object array,
                                   int index) throws IllegalArgumentException, ArrayIndexOutOfBoundsException

 Returns the value of the indexed component in the specified  array object, as a boolean.

Parameters:

 array - the array

 index - the index

Returns:

 the value of the indexed component in the specified array

Throws: NullPointerException

 If the specified object is null

Throws: IllegalArgumentException

 If the specified object is not  an array, or if the indexed element cannot be converted to the  return type by an identity or widening conversion

Throws: ArrayIndexOutOfBoundsException

 If the specified index  argument is negative, or if it is greater than or equal to the  length of the specified array

See Also:

get

 getByte

  public static byte getByte(Object array,
                             int index) throws IllegalArgumentException, ArrayIndexOutOfBoundsException

 Returns the value of the indexed component in the specified  array object, as a byte.

Parameters:

 array - the array

 index - the index

Returns:

 the value of the indexed component in the specified array

Throws: NullPointerException

 If the specified object is null

Throws: IllegalArgumentException

 If the specified object is not  an array, or if the indexed element cannot be converted to the  return type by an identity or widening conversion

Throws: ArrayIndexOutOfBoundsException

 If the specified index  argument is negative, or if it is greater than or equal to the  length of the specified array

See Also:

get

 getChar

  public static char getChar(Object array,
                             int index) throws IllegalArgumentException, ArrayIndexOutOfBoundsException

 Returns the value of the indexed component in the specified  array object, as a char.

Parameters:

 array - the array

 index - the index

Returns:

 the value of the indexed component in the specified array

Throws: NullPointerException

 If the specified object is null

Throws: IllegalArgumentException

 If the specified object is not  an array, or if the indexed element cannot be converted to the  return type by an identity or widening conversion

Throws: ArrayIndexOutOfBoundsException

 If the specified index  argument is negative, or if it is greater than or equal to the  length of the specified array

See Also:

get

 getShort

  public static short getShort(Object array,
                               int index) throws IllegalArgumentException, ArrayIndexOutOfBoundsException

 Returns the value of the indexed component in the specified  array object, as a short.

Parameters:

 array - the array

 index - the index

Returns:

 the value of the indexed component in the specified array

Throws: NullPointerException

 If the specified object is null

Throws: IllegalArgumentException

 If the specified object is not  an array, or if the indexed element cannot be converted to the  return type by an identity or widening conversion

Throws: ArrayIndexOutOfBoundsException

 If the specified index  argument is negative, or if it is greater than or equal to the  length of the specified array

See Also:

get

 getInt

  public static int getInt(Object array,
                           int index) throws IllegalArgumentException, ArrayIndexOutOfBoundsException

 Returns the value of the indexed component in the specified  array object, as an int.

Parameters:

 array - the array

 index - the index

Returns:

 the value of the indexed component in the specified array

Throws: NullPointerException

 If the specified object is null

Throws: IllegalArgumentException

 If the specified object is not  an array, or if the indexed element cannot be converted to the  return type by an identity or widening conversion

Throws: ArrayIndexOutOfBoundsException

 If the specified index  argument is negative, or if it is greater than or equal to the  length of the specified array

See Also:

get

 getLong

  public static long getLong(Object array,
                             int index) throws IllegalArgumentException, ArrayIndexOutOfBoundsException

 Returns the value of the indexed component in the specified  array object, as a long.

Parameters:

 array - the array

 index - the index

Returns:

 the value of the indexed component in the specified array

Throws: NullPointerException

 If the specified object is null

Throws: IllegalArgumentException

 If the specified object is not  an array, or if the indexed element cannot be converted to the  return type by an identity or widening conversion

Throws: ArrayIndexOutOfBoundsException

 If the specified index  argument is negative, or if it is greater than or equal to the  length of the specified array

See Also:

get

 getFloat

  public static float getFloat(Object array,
                               int index) throws IllegalArgumentException, ArrayIndexOutOfBoundsException

 Returns the value of the indexed component in the specified  array object, as a float.

Parameters:

 array - the array

 index - the index

Returns:

 the value of the indexed component in the specified array

Throws: NullPointerException

 If the specified object is null

Throws: IllegalArgumentException

 If the specified object is not  an array, or if the indexed element cannot be converted to the  return type by an identity or widening conversion

Throws: ArrayIndexOutOfBoundsException

 If the specified index  argument is negative, or if it is greater than or equal to the  length of the specified array

See Also:

get

 getDouble

  public static double getDouble(Object array,
                                 int index) throws IllegalArgumentException, ArrayIndexOutOfBoundsException

 Returns the value of the indexed component in the specified  array object, as a double.

Parameters:

 array - the array

 index - the index

Returns:

 the value of the indexed component in the specified array

Throws: NullPointerException

 If the specified object is null

Throws: IllegalArgumentException

 If the specified object is not  an array, or if the indexed element cannot be converted to the  return type by an identity or widening conversion

Throws: ArrayIndexOutOfBoundsException

 If the specified index  argument is negative, or if it is greater than or equal to the  length of the specified array

See Also:

get

 set

  public static void set(Object array,
                         int index,
                         Object value) throws IllegalArgumentException, ArrayIndexOutOfBoundsException

 Sets the value of the indexed component of the specified array  object to the specified new value. The new value is first  automatically unwrapped if the array has a primitive component  type.

Parameters:

 array - the array

 index - the index into the array

 value - the new value of the indexed component

Throws: NullPointerException

 If the specified object argument  is null, or if the array component type is primitive and the specified  value is null

Throws: IllegalArgumentException

 If the specified object argument  is not an array, or if the array component type is primitive and   the specified value cannot be converted to the primitive type by  a combination of unwrapping and identity or widening conversions

Throws: ArrayIndexOutOfBoundsException

 If the specified index  argument is negative, or if it is greater than or equal to  the length of the specified array

 setBoolean

  public static void setBoolean(Object array,
                                int index,
                                boolean z) throws IllegalArgumentException, ArrayIndexOutOfBoundsException

 Sets the value of the indexed component of the specified array  object to the specified boolean value.

Parameters:

 array - the array

 index - the index into the array

 value - the new value of the indexed component

Throws: NullPointerException

 If the specified object argument  is null

Throws: IllegalArgumentException

 If the specified object argument  is not an array, or if the the specified value cannot be converted  to the underlying array's component type by an identity or a  primitive widening widening conversion

Throws: ArrayIndexOutOfBoundsException

 If the specified index  argument is negative, or if it is greater than or equal to  the length of the specified array

See Also:

set

 setByte

  public static void setByte(Object array,
                             int index,
                             byte b) throws IllegalArgumentException, ArrayIndexOutOfBoundsException

 Sets the value of the indexed component of the specified array  object to the specified boolean value.

Parameters:

 array - the array

 index - the index into the array

 value - the new value of the indexed component

Throws: NullPointerException

 If the specified object argument  is null

Throws: IllegalArgumentException

 If the specified object argument  is not an array, or if the the specified value cannot be converted  to the underlying array's component type by an identity or a  primitive widening widening conversion

Throws: ArrayIndexOutOfBoundsException

 If the specified index  argument is negative, or if it is greater than or equal to  the length of the specified array

See Also:

set

 setChar

  public static void setChar(Object array,
                             int index,
                             char c) throws IllegalArgumentException, ArrayIndexOutOfBoundsException

 Sets the value of the indexed component of the specified array  object to the specified byte value.

Parameters:

 array - the array

 index - the index into the array

 value - the new value of the indexed component

Throws: NullPointerException

 If the specified object argument  is null

Throws: IllegalArgumentException

 If the specified object argument  is not an array, or if the the specified value cannot be converted  to the underlying array's component type by an identity or a  primitive widening widening conversion

Throws: ArrayIndexOutOfBoundsException

 If the specified index  argument is negative, or if it is greater than or equal to  the length of the specified array

See Also:

set

 setShort

  public static void setShort(Object array,
                              int index,
                              short s) throws IllegalArgumentException, ArrayIndexOutOfBoundsException

 Sets the value of the indexed component of the specified array  object to the specified short value.

Parameters:

 array - the array

 index - the index into the array

 value - the new value of the indexed component

Throws: NullPointerException

 If the specified object argument  is null

Throws: IllegalArgumentException

 If the specified object argument  is not an array, or if the the specified value cannot be converted  to the underlying array's component type by an identity or a  primitive widening widening conversion

Throws: ArrayIndexOutOfBoundsException

 If the specified index  argument is negative, or if it is greater than or equal to  the length of the specified array

See Also:

set

 setInt

  public static void setInt(Object array,
                            int index,
                            int i) throws IllegalArgumentException, ArrayIndexOutOfBoundsException

 Sets the value of the indexed component of the specified array  object to the specified int value.

Parameters:

 array - the array

 index - the index into the array

 value - the new value of the indexed component

Throws: NullPointerException

 If the specified object argument  is null

Throws: IllegalArgumentException

 If the specified object argument  is not an array, or if the the specified value cannot be converted  to the underlying array's component type by an identity or a  primitive widening widening conversion

Throws: ArrayIndexOutOfBoundsException

 If the specified index  argument is negative, or if it is greater than or equal to  the length of the specified array

See Also:

set

 setLong

  public static void setLong(Object array,
                             int index,
                             long l) throws IllegalArgumentException, ArrayIndexOutOfBoundsException

 Sets the value of the indexed component of the specified array  object to the specified long value.

Parameters:

 array - the array

 index - the index into the array

 value - the new value of the indexed component

Throws: NullPointerException

 If the specified object argument  is null

Throws: IllegalArgumentException

 If the specified object argument  is not an array, or if the the specified value cannot be converted  to the underlying array's component type by an identity or a  primitive widening widening conversion

Throws: ArrayIndexOutOfBoundsException

 If the specified index  argument is negative, or if it is greater than or equal to  the length of the specified array

See Also:

set

 setFloat

  public static void setFloat(Object array,
                              int index,
                              float f) throws IllegalArgumentException, ArrayIndexOutOfBoundsException

 Sets the value of the indexed component of the specified array  object to the specified float value.

Parameters:

 array - the array

 index - the index into the array

 value - the new value of the indexed component

Throws: NullPointerException

 If the specified object argument  is null

Throws: IllegalArgumentException

 If the specified object argument  is not an array, or if the the specified value cannot be converted  to the underlying array's component type by an identity or a  primitive widening widening conversion

Throws: ArrayIndexOutOfBoundsException

 If the specified index  argument is negative, or if it is greater than or equal to  the length of the specified array

See Also:

set

 setDouble

  public static void setDouble(Object array,
                               int index,
                               double d) throws IllegalArgumentException, ArrayIndexOutOfBoundsException

 Sets the value of the indexed component of the specified array  object to the specified double value.

Parameters:

 array - the array

 index - the index into the array

 value - the new value of the indexed component

Throws: NullPointerException

 If the specified object argument  is null

Throws: IllegalArgumentException

 If the specified object argument  is not an array, or if the the specified value cannot be converted  to the underlying array's component type by an identity or a  primitive widening widening conversion

Throws: ArrayIndexOutOfBoundsException

 If the specified index  argument is negative, or if it is greater than or equal to  the length of the specified array

See Also:

set

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.reflect.Constructor

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.reflect.Constructor

java.lang.Object
   |
   +----java.lang.reflect.Constructor

______________________________________________________________________________

 public final class Constructor

 extends Object

 implements Member

Constructor provides information about, and access to, a single  constructor for a class.

Constructor permits widening conversions to occur when matching the  actual parameters to newInstance() with the underlying  constructor's formal parameters, but throws an  IllegalArgumentException if a narrowing conversion would occur.

See Also:

Member, Class, getConstructors, getConstructor, getDeclaredConstructors

______________________________________________________________________________

 	equals(Object)

 Compares this Constructor against the specified object.

 	getDeclaringClass()

 Returns the Class object representing the class that declares  the constructor represented by this Constructor object.

 	getExceptionTypes()

 Returns an array of Class objects that represent the types of  the checked exceptions thrown by the underlying constructor  represented by this Constructor object.

 	getModifiers()

 Returns the Java language modifiers for the constructor  represented by this Constructor object, as an integer.

 	getName()

 Returns the name of this constructor, as a string.

 	getParameterTypes()

 Returns an array of Class objects that represent the formal  parameter types, in declaration order, of the constructor  represented by this Constructor object.

 	hashCode()

 Returns a hashcode for this Constructor.

 	newInstance(Object[])

 Uses the constructor represented by this Constructor object to  create and initialize a new instance of the constructor's  declaring class, with the specified initialization parameters.

 	toString()

 Return a string describing this Constructor.

 getDeclaringClass

  public Class getDeclaringClass()

 Returns the Class object representing the class that declares  the constructor represented by this Constructor object.

 getName

  public String getName()

 Returns the name of this constructor, as a string. This is  always the same as the name of the constructor's declaring  class.

 getModifiers

  public int getModifiers()

 Returns the Java language modifiers for the constructor  represented by this Constructor object, as an integer. The  Modifier class should be used to decode the modifiers.

See Also:

Modifier

 getParameterTypes

  public Class[] getParameterTypes()

 Returns an array of Class objects that represent the formal  parameter types, in declaration order, of the constructor  represented by this Constructor object. Returns an array of  length 0 if the underlying constructor takes no parameters.

 getExceptionTypes

  public Class[] getExceptionTypes()

 Returns an array of Class objects that represent the types of  the checked exceptions thrown by the underlying constructor  represented by this Constructor object. Returns an array of  length 0 if the constructor throws no checked exceptions.

 equals

  public boolean equals(Object obj)

 Compares this Constructor against the specified object.  Returns true if the objects are the same. Two Constructors are  the same if they were declared by the same class and have the  same formal parameter types.

Overrides:

equals in class Object

 hashCode

  public int hashCode()

 Returns a hashcode for this Constructor. The hashcode is  the same as the hashcode for the underlying constructor's  declaring class name.

Overrides:

hashCode in class Object

 toString

  public String toString()

 Return a string describing this Constructor. The string is  formatted as the constructor access modifiers, if any,  followed by the fully-qualified name of the declaring class,  followed by a parenthesized, comma-separated list of the  constructor's formal parameter types. For example:

    public java.util.Hashtable(int,float)

The only possible modifiers for constructors are the access  modifiers public, protected or  private . Only one of these may appear, or none if the  constructor has default (package) access.

Overrides:

toString in class Object

 newInstance

  public Object newInstance(Object initargs[]) throws InstantiationException , IllegalAccessException, IllegalArgumentException, InvocationTargetException

 Uses the constructor represented by this Constructor object to  create and initialize a new instance of the constructor's  declaring class, with the specified initialization parameters.  Individual parameters are automatically unwrapped to match  primitive formal parameters, and both primitive and reference  parameters are subject to widening conversions as necessary.  Returns the newly created and initialized object.

Creation proceeds with the following steps, in order:

If the class that declares the underlying constructor  represents an abstract class, the creation throws an  InstantiationException.

If this Constructor object enforces Java language access  control and the underlying constructor is inaccessible, the  creation throws an IllegalAccessException.

If the number of actual parameters supplied via initargs is  different from the number of formal parameters required by the  underlying constructor, the creation throws an  IllegalArgumentException.

A new instance of the constructor's declaring class is  created, and its fields are initialized to their default  initial values.

For each actual parameter in the supplied initargs array:

If the corresponding formal parameter has a primitive type,  an unwrapping conversion is attempted to convert the object  value to a value of the primitive type. If this attempt fails,  the creation throws an IllegalArgumentException.

If, after possible unwrapping, the parameter value cannot be  converted to the corresponding formal parameter type by an  identity or widening conversion, the creation throws an  IllegalArgumentException.

Control transfers to the underlying constructor to  initialize the new instance. If the constructor completes  abruptly by throwing an exception, the exception is placed in  an InvocationTargetException and thrown in turn to the caller  of newInstance.

If the constructor completes normally, returns the newly  created and initialized instance.

Throws: IllegalAccessException

 if the underlying constructor  is inaccessible.

Throws: IllegalArgumentException

 if the number of actual and formal  parameters differ, or if an unwrapping conversion fails.

Throws: InstantiationException

 if the class that declares the  underlying constructor represents an abstract class.

Throws: InvocationTargetException

 if the underlying constructor  throws an exception.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.reflect.Field

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.reflect.Field

java.lang.Object
   |
   +----java.lang.reflect.Field

______________________________________________________________________________

 public final class Field

 extends Object

 implements Member

A Field provides information about, and dynamic access to, a  single field of a class or an interface. The reflected field may  be a class (static) field or an instance field.

A Field permits widening conversions to occur during a get or  set access operation, but throws an IllegalArgumentException if a  narrowing conversion would occur.

See Also:

Member, Class, getFields, getField, getDeclaredFields , getDeclaredField

______________________________________________________________________________

 	equals(Object)

 Compares this Field against the specified object.

 	get(Object)

 Returns the value of the field represented by this Field, on  the specified object.

 	getBoolean(Object)

 Get the value of a field as a boolean on specified object.

 	getByte(Object)

 Get the value of a field as a byte on specified object.

 	getChar(Object)

 Get the value of a field as a char on specified object.

 	getDeclaringClass()

 Returns the Class object representing the class or interface  that declares the field represented by this Field object.

 	getDouble(Object)

 Get the value of a field as a double on specified object.

 	getFloat(Object)

 Get the value of a field as a float on specified object.

 	getInt(Object)

 Get the value of a field as a int on specified object.

 	getLong(Object)

 Get the value of a field as a long on specified object.

 	getModifiers()

 Returns the Java language modifiers for the field represented  by this Field object, as an integer.

 	getName()

 Returns the name of the field represented by this Field object.

 	getShort(Object)

 Get the value of a field as a short on specified object.

 	getType()

 Returns a Class object that identifies the declared type for  the field represented by this Field object.

 	hashCode()

 Returns a hashcode for this Field.

 	set(Object, Object)

 Sets the field represented by this Field object on the  specified object argument to the specified new value.

 	setBoolean(Object, boolean)

 Set the value of a field as a boolean on specified object.

 	setByte(Object, byte)

 Set the value of a field as a byte on specified object.

 	setChar(Object, char)

 Set the value of a field as a char on specified object.

 	setDouble(Object, double)

 Set the value of a field as a double on specified object.

 	setFloat(Object, float)

 Set the value of a field as a float on specified object.

 	setInt(Object, int)

 Set the value of a field as an int on specified object.

 	setLong(Object, long)

 Set the value of a field as a long on specified object.

 	setShort(Object, short)

 Set the value of a field as a short on specified object.

 	toString()

 Return a string describing this Field.

 getDeclaringClass

  public Class getDeclaringClass()

 Returns the Class object representing the class or interface  that declares the field represented by this Field object.

 getName

  public String getName()

 Returns the name of the field represented by this Field object.

 getModifiers

  public int getModifiers()

 Returns the Java language modifiers for the field represented  by this Field object, as an integer. The Modifier class should  be used to decode the modifiers.

See Also:

Modifier

 getType

  public Class getType()

 Returns a Class object that identifies the declared type for  the field represented by this Field object.

 equals

  public boolean equals(Object obj)

 Compares this Field against the specified object. Returns  true if the objects are the same. Two Fields are the same if  they were declared by the same class and have the same name  and type.

Overrides:

equals in class Object

 hashCode

  public int hashCode()

 Returns a hashcode for this Field. This is computed as the  exclusive-or of the hashcodes for the underlying field's  declaring class name and its name.

Overrides:

hashCode in class Object

 toString

  public String toString()

 Return a string describing this Field. The format is  the access modifiers for the field, if any, followed  by the field type, followed by a space, followed by  the fully-qualified name of the class declaring the field,  followed by a period, followed by the name of the field.  For example:

    public static final int java.lang.Thread.MIN_PRIORITY
    private int java.io.FileDescriptor.fd

The modifiers are placed in canonical order as specified by  "The Java Language Specification". This is public,  protected  or private first, and then other  modifiers in the following order: static, final,  transient, volatile.

Overrides:

toString in class Object

 get

  public Object get(Object obj) throws IllegalArgumentException, IllegalAccessException

 Returns the value of the field represented by this Field, on  the specified object. The value is automatically wrapped in an  object if it has a primitive type.

The underlying field's value is obtained as follows:

If the underlying field is a static field, the object argument  is ignored; it may be null.

Otherwise, the underlying field is an instance field. If the  specified object argument is null, the method throws a  NullPointerException. If the specified object is not an  instance of the class or interface declaring the underlying  field, the method throws an IllegalArgumentException.

If this Field object enforces Java language access control, and  the underlying field is inaccessible, the method throws an  IllegalAccessException.

Otherwise, the value is retrieved from the underlying instance  or static field. If the field has a primitive type, the value  is wrapped in an object before being returned, otherwise it is  returned as is.

Throws: IllegalAccessException

 if the underlying constructor  is inaccessible.

Throws: IllegalArgumentException

 if the specified object is not an  instance of the class or interface declaring the underlying  field.

Throws: NullPointerException

 if the specified object is null.

 getBoolean

  public boolean getBoolean(Object obj) throws IllegalArgumentException, IllegalAccessException

 Get the value of a field as a boolean on specified object.

Throws: IllegalAccessException

 if the underlying constructor  is inaccessible.

Throws: IllegalArgumentException

 if the field value cannot be  converted to the return type by a widening conversion.

See Also:

get

 getByte

  public byte getByte(Object obj) throws IllegalArgumentException, IllegalAccessException

 Get the value of a field as a byte on specified object.

Throws: IllegalAccessException

 if the underlying constructor  is inaccessible.

Throws: IllegalArgumentException

 if the field value cannot be  converted to the return type by a widening conversion.

See Also:

get

 getChar

  public char getChar(Object obj) throws IllegalArgumentException, IllegalAccessException

 Get the value of a field as a char on specified object.

Throws: IllegalAccessException

 if the underlying constructor  is inaccessible.

Throws: IllegalArgumentException

 if the field value cannot be  converted to the return type by a widening conversion.

See Also:

get

 getShort

  public short getShort(Object obj) throws IllegalArgumentException, IllegalAccessException

 Get the value of a field as a short on specified object.

Throws: IllegalAccessException

 if the underlying constructor  is inaccessible.

Throws: IllegalArgumentException

 if the field value cannot be  converted to the return type by a widening conversion.

See Also:

get

 getInt

  public int getInt(Object obj) throws IllegalArgumentException, IllegalAccessException

 Get the value of a field as a int on specified object.

Throws: IllegalAccessException

 if the underlying constructor  is inaccessible.

Throws: IllegalArgumentException

 if the field value cannot be  converted to the return type by a widening conversion.

See Also:

get

 getLong

  public long getLong(Object obj) throws IllegalArgumentException, IllegalAccessException

 Get the value of a field as a long on specified object.

Throws: IllegalAccessException

 if the underlying constructor  is inaccessible.

Throws: IllegalArgumentException

 if the field value cannot be  converted to the return type by a widening conversion.

See Also:

get

 getFloat

  public float getFloat(Object obj) throws IllegalArgumentException, IllegalAccessException

 Get the value of a field as a float on specified object.

Throws: IllegalAccessException

 if the underlying constructor  is inaccessible.

Throws: IllegalArgumentException

 if the field value cannot be  converted to the return type by a widening conversion.

See Also:

get

 getDouble

  public double getDouble(Object obj) throws IllegalArgumentException, IllegalAccessException

 Get the value of a field as a double on specified object.

Throws: IllegalAccessException

 if the underlying constructor  is inaccessible.

Throws: IllegalArgumentException

 if the field value cannot be  converted to the return type by a widening conversion.

See Also:

get

 set

  public void set(Object obj,
                  Object value) throws IllegalArgumentException, IllegalAccessException

 Sets the field represented by this Field object on the  specified object argument to the specified new value. The new  value is automatically unwrapped if the underlying field has a  primitive type.

The operation proceeds as follows:

If the underlying field is static, the object argument is  ignored; it may be null.

Otherwise the underlying field is an instance field. If the  specified object argument is null, the method throws a  NullPointerException. If the specified object argument is not  an instance of the class or interface declaring the underlying  field, the method throws an IllegalArgumentException.

If this Field object enforces Java language access control, and  the underlying field is inaccessible, the method throws an  IllegalAccessException.

If the underlying field is final, the method throws an  IllegalAccessException.

If the underlying field is of a primitive type, an unwrapping  conversion is attempted to convert the new value to a value of  a primitive type. If this attempt fails, the method throws an  IllegalArgumentException.

If, after possible unwrapping, the new value cannot be  converted to the type of the underlying field by an identity or  widening conversion, the method throws an  IllegalArgumentException.

The field is set to the possibly unwrapped and widened new value.

Throws: IllegalAccessException

 if the underlying constructor  is inaccessible.

Throws: IllegalArgumentException

 if the specified object is not an  instance of the class or interface declaring the underlying  field, or if an unwrapping conversion fails.

Throws: NullPointerException

 if the specified object is null.

 setBoolean

  public void setBoolean(Object obj,
                         boolean z) throws IllegalArgumentException, IllegalAccessException

 Set the value of a field as a boolean on specified object.

Throws: IllegalAccessException

 if the underlying constructor  is inaccessible.

Throws: IllegalArgumentException

 if the specified object is not an  instance of the class or interface declaring the underlying  field, or if an unwrapping conversion fails.

See Also:

set

 setByte

  public void setByte(Object obj,
                      byte b) throws IllegalArgumentException, IllegalAccessException

 Set the value of a field as a byte on specified object.

Throws: IllegalAccessException

 if the underlying constructor  is inaccessible.

Throws: IllegalArgumentException

 if the specified object is not an  instance of the class or interface declaring the underlying  field, or if an unwrapping conversion fails.

See Also:

set

 setChar

  public void setChar(Object obj,
                      char c) throws IllegalArgumentException, IllegalAccessException

 Set the value of a field as a char on specified object.

Throws: IllegalAccessException

 if the underlying constructor  is inaccessible.

Throws: IllegalArgumentException

 if the specified object is not an  instance of the class or interface declaring the underlying  field, or if an unwrapping conversion fails.

See Also:

set

 setShort

  public void setShort(Object obj,
                       short s) throws IllegalArgumentException, IllegalAccessException

 Set the value of a field as a short on specified object.

Throws: IllegalAccessException

 if the underlying constructor  is inaccessible.

Throws: IllegalArgumentException

 if the specified object is not an  instance of the class or interface declaring the underlying  field, or if an unwrapping conversion fails.

See Also:

set

 setInt

  public void setInt(Object obj,
                     int i) throws IllegalArgumentException, IllegalAccessException

 Set the value of a field as an int on specified object.

Throws: IllegalAccessException

 if the underlying constructor  is inaccessible.

Throws: IllegalArgumentException

 if the specified object is not an  instance of the class or interface declaring the underlying  field, or if an unwrapping conversion fails.

See Also:

set

 setLong

  public void setLong(Object obj,
                      long l) throws IllegalArgumentException, IllegalAccessException

 Set the value of a field as a long on specified object.

Throws: IllegalAccessException

 if the underlying constructor  is inaccessible.

Throws: IllegalArgumentException

 if the specified object is not an  instance of the class or interface declaring the underlying  field, or if an unwrapping conversion fails.

See Also:

set

 setFloat

  public void setFloat(Object obj,
                       float f) throws IllegalArgumentException, IllegalAccessException

 Set the value of a field as a float on specified object.

Throws: IllegalAccessException

 if the underlying constructor  is inaccessible.

Throws: IllegalArgumentException

 if the specified object is not an  instance of the class or interface declaring the underlying  field, or if an unwrapping conversion fails.

See Also:

set

 setDouble

  public void setDouble(Object obj,
                        double d) throws IllegalArgumentException, IllegalAccessException

 Set the value of a field as a double on specified object.

Throws: IllegalAccessException

 if the underlying constructor  is inaccessible.

Throws: IllegalArgumentException

 if the specified object is not an  instance of the class or interface declaring the underlying  field, or if an unwrapping conversion fails.

See Also:

set

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.reflect.InvocationTargetException

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class java.lang.reflect.InvocationTargetException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.reflect.InvocationTargetException

______________________________________________________________________________

 public class InvocationTargetException

 extends Exception

InvocationTargetException is a checked exception that wraps  an exception thrown by an invoked method or constructor.

See Also:

Method, Constructor

______________________________________________________________________________

 	InvocationTargetException()

  	InvocationTargetException (Throwable)

 Constructs a InvocationTargetException with a target exception.

 	InvocationTargetException(Throwable, String)

 Constructs a InvocationTargetException with a target exception  and a detail message.

 	getTargetException()

 Get the thrown target exception.

 InvocationTargetException

  protected InvocationTargetException()

 InvocationTargetException

  public InvocationTargetException(Throwable target)

 Constructs a InvocationTargetException with a target exception.

 InvocationTargetException

  public InvocationTargetException(Throwable target,
                                   String s)

 Constructs a InvocationTargetException with a target exception  and a detail message.

 getTargetException

  public Throwable getTargetException()

 Get the thrown target exception.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.lang.reflect.Member

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Interface java.lang.reflect.Member

 public interface Member

Member is an interface that reflects identifying information about  a single member (a field or a method) or a constructor.

See Also:

Class, Field, Method, Constructor

______________________________________________________________________________

 	DECLARED

 Identifies the set of declared members of a class or interface.

 	PUBLIC

 Identifies the set of all public members of a class or interface,  including inherited members.

 	getDeclaringClass()

 Returns the Class object representing the class or interface  that declares the member or constructor represented by this Member.

 	getModifiers()

 Returns the Java language modifiers for the member or  constructor represented by this Member, as an integer.

 	getName()

 Returns the simple name of the underlying member or constructor  represented by this Member.

 PUBLIC

  public final static int PUBLIC

 Identifies the set of all public members of a class or interface,  including inherited members.

See Also:

checkMemberAccess

 DECLARED

  public final static int DECLARED

 Identifies the set of declared members of a class or interface.  Inherited members are not included.

See Also:

checkMemberAccess

 getDeclaringClass

  public abstract Class getDeclaringClass()

 Returns the Class object representing the class or interface  that declares the member or constructor represented by this Member.

 getName

  public abstract String getName()

 Returns the simple name of the underlying member or constructor  represented by this Member.

 getModifiers

  public abstract int getModifiers()

 Returns the Java language modifiers for the member or  constructor represented by this Member, as an integer. The  Modifier class should be used to decode the modifiers in  the integer.

See Also:

Modifier

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.reflect.Method

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.reflect.Method

java.lang.Object
   |
   +----java.lang.reflect.Method

______________________________________________________________________________

 public final class Method

 extends Object

 implements Member

A Method provides information about, and access to, a single method  on a class or interface. The reflected method may be a class method  or an instance method (including an abstract method).

A Method permits widening conversions to occur when matching the  actual parameters to invokewith the underlying method's formal  parameters, but it throws an IllegalArgumentException if a  narrowing conversion would occur.

See Also:

Member, Class, getMethods, getMethod, getDeclaredMethods , getDeclaredMethod

______________________________________________________________________________

 	equals(Object)

 Compares this Method against the specified object.

 	getDeclaringClass()

 Returns the Class object representing the class or interface  that declares the method represented by this Method object.

 	getExceptionTypes()

 Returns an array of Class objects that represent the types of  the checked exceptions thrown by the underlying method  represented by this Method object.

 	getModifiers()

 Returns the Java language modifiers for the method represented  by this Method object, as an integer.

 	getName()

 Returns the name of the method represented by this Method  object, as a String.

 	getParameterTypes()

 Returns an array of Class objects that represent the formal  parameter types, in declaration order, of the method  represented by this Method object.

 	getReturnType()

 Returns a Class object that represents the formal return type  of the method represented by this Method object.

 	hashCode()

 Returns a hashcode for this Method.

 	invoke(Object, Object[])

 Invokes the underlying method represented by this Method  object, on the specified object with the specified parameters.

 	toString()

 Returns a string describing this Method.

 getDeclaringClass

  public Class getDeclaringClass()

 Returns the Class object representing the class or interface  that declares the method represented by this Method object.

 getName

  public String getName()

 Returns the name of the method represented by this Method  object, as a String.

 getModifiers

  public int getModifiers()

 Returns the Java language modifiers for the method represented  by this Method object, as an integer. The Modifier class should  be used to decode the modifiers.

See Also:

Modifier

 getReturnType

  public Class getReturnType()

 Returns a Class object that represents the formal return type  of the method represented by this Method object.

 getParameterTypes

  public Class[] getParameterTypes()

 Returns an array of Class objects that represent the formal  parameter types, in declaration order, of the method  represented by this Method object. Returns an array of length  0 if the underlying method takes no parameters.

 getExceptionTypes

  public Class[] getExceptionTypes()

 Returns an array of Class objects that represent the types of  the checked exceptions thrown by the underlying method  represented by this Method object. Returns an array of length  0 if the method throws no checked exceptions.

 equals

  public boolean equals(Object obj)

 Compares this Method against the specified object. Returns  true if the objects are the same. Two Methods are the same if  they were declared by the same class and have the same name  and formal parameter types.

Overrides:

equals in class Object

 hashCode

  public int hashCode()

 Returns a hashcode for this Method. The hashcode is computed  as the exclusive-or of the hashcodes for the underlying  method's declaring class name and the method's name.

Overrides:

hashCode in class Object

 toString

  public String toString()

 Returns a string describing this Method. The string is  formatted as the method access modifiers, if any, followed by  the method return type, followed by a space, followed by the  class declaring the method, followed by a period, followed by  the method name, followed by a parenthesized, comma-separated  list of the method's formal parameter types. If the method  throws checked exceptions, the parameter list is followed by a  space, followed by the word throws followed by a  comma-separated list of the thrown exception types.  For example:

    public boolean java.lang.Object.equals(java.lang.Object)

The access modifiers are placed in canonical order as  specified by "The Java Language Specification". This is  public, protected or private first,  and then other modifiers in the following order:  abstract, static, final,  synchronized native.

Overrides:

toString in class Object

 invoke

  public Object invoke(Object obj,
                       Object args[]) throws IllegalAccessException, IllegalArgumentException, InvocationTargetException

 Invokes the underlying method represented by this Method  object, on the specified object with the specified parameters.  Individual parameters are automatically unwrapped to match  primitive formal parameters, and both primitive and reference  parameters are subject to widening conversions as  necessary. The value returned by the underlying method is  automatically wrapped in an object if it has a primitive type.

Method invocation proceeds with the following steps, in order:

If the underlying method is static, then the specified object  argument is ignored. It may be null.

Otherwise, the method is an instance method. If the specified  object argument is null, the invocation throws a  NullPointerException. Otherwise, if the specified object  argument is not an instance of the class or interface declaring  the underlying method, the invocation throws an  IllegalArgumentException.

If this Method object enforces Java language access control and  the underlying method is inaccessible, the invocation throws an  IllegalAccessException.

If the number of actual parameters supplied via args is  different from the number of formal parameters required by the  underlying method, the invocation throws an  IllegalArgumentException.

For each actual parameter in the supplied args array:

If the corresponding formal parameter has a primitive type, an  unwrapping conversion is attempted to convert the object value  to a value of a primitive type. If this attempt fails, the  invocation throws an IllegalArgumentException.

If, after possible unwrapping, the parameter value cannot be  converted to the corresponding formal parameter type by an  identity or widening conversion, the invocation throws an  IllegalArgumentException.

If the underlying method is an instance method, it is invoked  using dynamic method lookup as documented in The Java Language  Specification, section 15.11.4.4; in particular, overriding  based on the runtime type of the target object will occur.

If the underlying method is static, it is invoked as exactly  the method on the declaring class.

Control transfers to the underlying method. If the method  completes abruptly by throwing an exception, the exception is  placed in an InvocationTargetException and thrown in turn to  the caller of invoke.

If the method completes normally, the value it returns is  returned to the caller of invoke; if the value has a primitive  type, it is first appropriately wrapped in an object. If the  underlying method return type is void, the invocation returns  null.

Throws: IllegalAccessException

 if the underlying method  is inaccessible.

Throws: IllegalArgumentException

 if the number of actual and formal  parameters differ, or if an unwrapping conversion fails.

Throws: InvocationTargetException

 if the underlying method  throws an exception.

Throws: NullPointerException

 if the specified object is null.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.reflect.Modifier

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.reflect.Modifier

java.lang.Object
   |
   +----java.lang.reflect.Modifier

______________________________________________________________________________

 public class Modifier

 extends Object

The Modifier class provides static methods and constants to decode  class and member access modifiers.

See Also:

getModifiers, getModifiers

______________________________________________________________________________

 	ABSTRACT

  	FINAL

  	INTERFACE

  	NATIVE

  	PRIVATE

  	PROTECTED

  	PUBLIC

  	STATIC

  	SYNCHRONIZED

  	TRANSIENT

  	VOLATILE

 	Modifier()

 	isAbstract(int)

 Return true if the specifier integer includes the abstract  modifier.

 	isFinal(int)

 Return true if the specifier integer includes the final  modifier.

 	isInterface(int)

 Return true if the specifier integer includes the interface  modifier.

 	isNative(int)

 Return true if the specifier integer includes the native  modifier.

 	isPrivate(int)

 Return true if the specifier integer includes the private  modifier.

 	isProtected(int)

 Return true if the specifier integer includes the protected  modifier.

 	isPublic(int)

 Return true if the specified integer includes the public  modifier.

 	isStatic(int)

 Return true if the specifier integer includes the static  modifier.

 	isSynchronized(int)

 Return true if the specifier integer includes the final  modifier.

 	isTransient(int)

 Return true if the specifier integer includes the transient  modifier.

 	isVolatile(int)

 Return true if the specifier integer includes the volatile  modifier.

 	toString(int)

 Return a string describing the access modifier flags in  the specified modifier.

 PUBLIC

  public final static int PUBLIC

 PRIVATE

  public final static int PRIVATE

 PROTECTED

  public final static int PROTECTED

 STATIC

  public final static int STATIC

 FINAL

  public final static int FINAL

 SYNCHRONIZED

  public final static int SYNCHRONIZED

 VOLATILE

  public final static int VOLATILE

 TRANSIENT

  public final static int TRANSIENT

 NATIVE

  public final static int NATIVE

 INTERFACE

  public final static int INTERFACE

 ABSTRACT

  public final static int ABSTRACT

 Modifier

  public Modifier()

 isPublic

  public static boolean isPublic(int mod)

 Return true if the specified integer includes the public  modifier.

 isPrivate

  public static boolean isPrivate(int mod)

 Return true if the specifier integer includes the private  modifier.

 isProtected

  public static boolean isProtected(int mod)

 Return true if the specifier integer includes the protected  modifier.

 isStatic

  public static boolean isStatic(int mod)

 Return true if the specifier integer includes the static  modifier.

 isFinal

  public static boolean isFinal(int mod)

 Return true if the specifier integer includes the final  modifier.

 isSynchronized

  public static boolean isSynchronized(int mod)

 Return true if the specifier integer includes the final  modifier.

 isVolatile

  public static boolean isVolatile(int mod)

 Return true if the specifier integer includes the volatile  modifier.

 isTransient

  public static boolean isTransient(int mod)

 Return true if the specifier integer includes the transient  modifier.

 isNative

  public static boolean isNative(int mod)

 Return true if the specifier integer includes the native  modifier.

 isInterface

  public static boolean isInterface(int mod)

 Return true if the specifier integer includes the interface  modifier.

 isAbstract

  public static boolean isAbstract(int mod)

 Return true if the specifier integer includes the abstract  modifier.

 toString

  public static String toString(int mod)

 Return a string describing the access modifier flags in  the specified modifier. For example:

    public final synchronized
    private transient volatile

 The modifier names are return in canonical order, as  specified by The Java Language Specification.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.lang.Runnable

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.lang.Runnable

 public interface Runnable

The Runnable interface should be implemented by any  class whose instances are intended to be executed by a thread. The  class must define a method of no arguments called run.

 This interface is designed to provide a common protocol for objects that  wish to execute code while they are active. For example,  Runnable  is implemented by class Thread.  Being active simply means that a thread has been started and has not  yet been stopped.

 In addition, Runnable provides the means for a class to be  active while not subclassing Thread. A class that implements  Runnable  can run without subclassing Thread  by instantiating a ,code>Thread  instance and passing itself in  as the target. In most cases, the Runnable  interface should  be used if you are only planning to override the run()  method and no other Thread methods.  This is important because classes should not be subclassed  unless the programmer intends on modifying or enhancing the fundamental  behavior of the class.

See Also:

Thread

______________________________________________________________________________

 	run()

 When an object implementing interface Runnable is used  to create a thread, starting the thread causes the object's  run  method to be called in that separately executing  thread.

 run

  public abstract void run()

 When an object implementing interface Runnable is used  to create a thread, starting the thread causes the object's  run  method to be called in that separately executing  thread.

See Also:

run

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.Runtime

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.Runtime

java.lang.Object
   |
   +----java.lang.Runtime

______________________________________________________________________________

 public class Runtime

 extends Object

______________________________________________________________________________

 	exec(String)

 Executes the specified string command in a separate process.

 	exec(String, String[])

 Executes the specified string command in a separate process with the  specified environment.

 	exec(String[])

 Executes the specified command and arguments in a separate process.

 	exec(String[], String[])

 Executes the specified command and arguments in a separate process  with the specified environment.

 	exit(int)

 Terminates the currently running Java Virtual Machine.

 	freeMemory()

 Returns the amount of free memory in the system.

 	gc()

 Runs the garbage collector.

 	getLocalizedInputStream(InputStream)

 Creates a localized version of an input stream. Deprecated.

 	getLocalizedOutputStream(OutputStream)

 Creates a localized version of an output stream. Deprecated.

 	getRuntime()

 Returns the runtime object associated with the current Java application.

 	load(String)

 Loads the specified filename as a dynamic library.

 	loadLibrary(String)

 Loads the dynamic library with the specified library name.

 	runFinalization()

 Runs the finalization methods of any objects pending finalization.

 	runFinalizersOnExit(boolean)

 Enable or disable finalization on exit; doing so specifies that the  finalizers of all objects that have finalizers that have not yet been  automatically invoked are to be run before the Java runtime exits.

 	totalMemory()

 Returns the total amount of memory in the Java Virtual Machine.

 	traceInstructions(boolean)

 Enables/Disables tracing of instructions.

 	traceMethodCalls(boolean)

 Enables/Disables tracing of method calls.

 getRuntime

  public static Runtime getRuntime()

 Returns the runtime object associated with the current Java application.

Returns:

 the Runtime object associated with the current  Java application.

 exit

  public void exit(int status)

 Terminates the currently running Java Virtual Machine. This  method never returns normally.

 If there is a security manager, its checkExit method  is called with the status as its argument. This may result in a  security exception.

 The argument serves as a status code; by convention, a nonzero  status code indicates abnormal termination.

Parameters:

 status - exit status.

Throws: SecurityException

 if the current thread cannot exit with  the specified status.

See Also:

SecurityException, checkExit

 runFinalizersOnExit

  public static void runFinalizersOnExit(boolean value)

 Enable or disable finalization on exit; doing so specifies that the  finalizers of all objects that have finalizers that have not yet been  automatically invoked are to be run before the Java runtime exits.  By default, finalization on exit is disabled. An invocation of  the runFinalizersOnExit method is permitted only if the caller is  allowed to exit, and is otherwise rejected by the security manager.

See Also:

gc, exit

 exec

  public Process exec(String command) throws IOException

 Executes the specified string command in a separate process.

 The command argument is parsed into tokens and then  executed as a command in a separate process. This method has  exactly the same effect as exec(command, null).

Parameters:

 command - a specified system command.

Returns:

 a Process object for managing the subprocess.

Throws: SecurityException

 if the current thread cannot create a  subprocess.

See Also:

exec

 exec

  public Process exec(String command,
                      String envp[]) throws IOException

 Executes the specified string command in a separate process with the  specified environment.

 This method breaks the command string into tokens and  creates a new array cmdarray containing the tokens; it  then performs the call exec(cmdarray, envp).

Parameters:

 command - a specified system command.

 envp - array containing environment in format  name=value

Returns:

 a Process object for managing the subprocess.

Throws: SecurityException

 if the current thread cannot create a  subprocess.

See Also:

exec

 exec

  public Process exec(String cmdarray[]) throws IOException

 Executes the specified command and arguments in a separate process.

 The command specified by the tokens in cmdarray is  executed as a command in a separate process. This has exactly the  same effect as exec(cmdarray, null).

Parameters:

 cmdarray - array containing the command to call and  its arguments.

Returns:

 a Process object for managing the subprocess.

Throws: SecurityException

 if the current thread cannot create a  subprocess.

See Also:

exec

 exec

  public Process exec(String cmdarray[],
                      String envp[]) throws IOException

 Executes the specified command and arguments in a separate process  with the specified environment.

 If there is a security manager, its checkExec method  is called with the first component of the array  cmdarray  as its argument. This may result in a security  exception.

 Given an array of strings cmdarray, representing the  tokens of a command line, and an array of strings envp,  representing an "environment" that defines system  properties, this method creates a new process in which to execute  the specified command.

Parameters:

 cmdarray - array containing the command to call and  its arguments.

 envp - array containing environment in format  name=value.

Returns:

 a Process object for managing the subprocess.

Throws: SecurityException

 if the current thread cannot create a  subprocess.

See Also:

SecurityException, checkExec

 freeMemory

  public long freeMemory()

 Returns the amount of free memory in the system. The value returned  by this method is always less than the value returned by the  totalMemory  method. Calling the gc method may  result in increasing the value returned by freeMemory.

Returns:

 an approximation to the total amount of memory currently  available for future allocated objects, measured in bytes.

 totalMemory

  public long totalMemory()

 Returns the total amount of memory in the Java Virtual Machine.

Returns:

 the total amount of memory currently available for allocating  objects, measured in bytes.

 gc

  public void gc()

 Runs the garbage collector.  Calling this method suggests that the Java Virtual Machine expend  effort toward recycling unused objects in order to make the memory  they currently occupy available for quick reuse. When control  returns from the method call, the Java Virtual Machine has made  its best effort to recycle all unused objects.

 The name gc stands for "garbage  collector". The Java Virtual Machine performs this recycling  process automatically as needed even if the gc method  is not invoked explicitly.

 runFinalization

  public void runFinalization()

 Runs the finalization methods of any objects pending finalization.  Calling this method suggests that the Java Virtual Machine expend  effort toward running the finalize methods of objects  that have been found to be discarded but whose finalize  methods have not yet been run. When control returns from the  method call, the Java Virtual Machine has made a best effort to  complete all outstanding finalizations.

 The Java Virtual Machine performs the finalization process  automatically as needed if the runFinalization method  is not invoked explicitly.

See Also:

finalize

 traceInstructions

  public void traceInstructions(boolean on)

 Enables/Disables tracing of instructions.  If the boolean  argument is true, this  method asks the Java Virtual Machine to print out a detailed trace  of each instruction in the Java Virtual Machine as it is executed.  The virtual machine may ignore this request if it does not support  this feature. The destination of the trace output is system  dependent.

 If the boolean argument is false, this  method causes the Java Virtual Machine to stop performing the  detailed instruction trace it is performing.

Parameters:

 on - true to enable instruction tracing;  false to disable this feature.

 traceMethodCalls

  public void traceMethodCalls(boolean on)

 Enables/Disables tracing of method calls.  If the boolean  argument is true, this  method asks the Java Virtual Machine to print out a detailed trace  of each method in the Java Virtual Machine as it is called. The  virtual machine may ignore this request if it does not support  this feature. The destination of the trace output is system dependent.

 If the boolean argument is false, this  method causes the Java Virtual Machine to stop performing the  detailed method trace it is performing.

Parameters:

 on - true to enable instruction tracing;  false to disable this feature.

 load

  public synchronized void load(String filename)

 Loads the specified filename as a dynamic library. The filename  argument must be a complete pathname.  From java_g  it will automagically insert "_g" before the  ".so" (for example  Runtime.getRuntime().load("/home/avh/lib/libX11.so");).

 If there is a security manager, its checkLink method  is called with the filename as its argument. This may  result in a security exception.

Parameters:

 filename - the file to load.

Throws: SecurityException

 if the current thread cannot load the  specified dynamic library.

Throws: UnsatisfiedLinkError

 if the file does not exist.

See Also:

getRuntime, SecurityException, checkLink

 loadLibrary

  public synchronized void loadLibrary(String libname)

 Loads the dynamic library with the specified library name. The  mapping from a library name to a specific filename is done in a  system-specific manner.

 First, if there is a security manager, its checkLink  method is called with the filename as its argument.  This may result in a security exception.

 If this method is called more than once with the same library  name, the second and subsequent calls are ignored.

Parameters:

 libname - the name of the library.

Throws: SecurityException

 if the current thread cannot load the  specified dynamic library.

Throws: UnsatisfiedLinkError

 if the library does not exist.

See Also:

SecurityException, checkLink

 getLocalizedInputStream

  public InputStream getLocalizedInputStream(InputStream in)

 Note: getLocalizedInputStream() is deprecated. As of JDK 1.1, the preferred way to translate from the  local encoding to Unicode is using the new  InputStreamReader and  BufferedReader classes.

 Creates a localized version of an input stream. This method takes  an InputStream and returns an InputStream  equivalent to the argument in all respects except that it is  localized: as characters in the local character set are read from  the stream, they are automatically converted from the local  character set to Unicode.

 If the argument is already a localized stream, it may be returned  as the result.

Returns:

 a localized input stream.

See Also:

BufferedReader, InputStream, InputStreamReader

 getLocalizedOutputStream

  public OutputStream getLocalizedOutputStream(OutputStream out)

 Note: getLocalizedOutputStream() is deprecated. As of JDK 1.1, the preferred way to translate from  Unicode into the local encoding is using the new  OutputStreamWriter, BufferedWriter,  and PrintWriter classes.

 Creates a localized version of an output stream. This method  takes an OutputStream and returns an  OutputStream  equivalent to the argument in all respects  except that it is localized: as Unicode characters are written to  the stream, they are automatically converted to the local  character set.

 If the argument is already a localized stream, it may be returned  as the result.

Returns:

 a localized output stream.

See Also:

BufferedWriter, OutputStream, OutputStreamWriter, PrintWriter

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.RuntimeException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.RuntimeException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.RuntimeException

______________________________________________________________________________

 public class RuntimeException

 extends Exception

RuntimeException is the superclass of those  exceptions that can be thrown during the normal operation of the  Java Virtual Machine.

 A method is not required to declare in its throws  clause any subclasses of RuntimeException that might  be thrown during the execution of the method but not caught.

______________________________________________________________________________

 	RuntimeException()

 Constructs a RuntimeException with no detail message.

 	RuntimeException(String)

 Constructs a RuntimeException with the specified  detail message.

 RuntimeException

  public RuntimeException()

 Constructs a RuntimeException with no detail message.

 RuntimeException

  public RuntimeException(String s)

 Constructs a RuntimeException with the specified  detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.SecurityException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.SecurityException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.RuntimeException
                           |
                           +----java.lang.SecurityException

______________________________________________________________________________

 public class SecurityException

 extends RuntimeException

Thrown by the security manager to indicate a security violation.

See Also:

SecurityManager

______________________________________________________________________________

 	SecurityException()

 Constructs a SecurityException with no detail message.

 	SecurityException(String)

 Constructs a SecurityException with the specified  detail message.

 SecurityException

  public SecurityException()

 Constructs a SecurityException with no detail message.

 SecurityException

  public SecurityException(String s)

 Constructs a SecurityException with the specified  detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.SecurityManager

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.SecurityManager

java.lang.Object
   |
   +----java.lang.SecurityManager

______________________________________________________________________________

 public class SecurityManager

 extends Object

The security manager is an abstract class that allows  applications to implement a security policy. It allows an  application to determine, before performing a possibly unsafe or  sensitive operation, what the operation is and whether the  operation is being performed by a class created via a class loader  rather than installed locally. Classes loaded via a class loader  (especially if they have been downloaded over a network) may be  less trustworthy than classes from files installed locally. The  application can allow or disallow the operation.

 The SecurityManager class contains many methods with  names that begin with the word check. These methods  are called by various methods in the Java libraries before those  methods perform certain potentially sensitive operations. The  invocation of such a check method typically looks like this:

     SecurityManager security = System.getSecurityManager();
     if (security != null) {
         security.checkXXX(argument,  . . . );
     }

 The security manager is thereby given an opportunity to prevent  completion of the operation by throwing an exception. A security  manager routine simply returns if the operation is permitted, but  throws a SecurityException if the operation is not  permitted. The only exception to this convention is  checkTopLevelWindow, which returns a  boolean value.

 The current security manager is set by the  setSecurityManager method in class  System. The current security manager is obtained  by the getSecurityManager  method.

 The default implementation of each of the  checkXXX  methods is to assume that the caller  does not  have permission to perform the requested operation.

See Also:

ClassLoader, SecurityException, checkTopLevelWindow, getSecurityManager, setSecurityManager

______________________________________________________________________________

 	inCheck

 This field is true if there is a security check in  progress; false  otherwise.

 	SecurityManager()

 Constructs a new SecurityManager.

 	checkAccept(String, int)

 Throws a SecurityException if the  calling thread is not permitted to accept a socket connection from  the specified host and port number.

 	checkAccess(Thread)

 Throws a SecurityException if the  calling thread is not allowed to modify the thread argument.

 	checkAccess(ThreadGroup)

 Throws a SecurityException if the  calling thread is not allowed to modify the thread group argument.

 	checkAwtEventQueueAccess()

 Tests if a client can get access to the AWT event queue.

 	checkConnect(String, int)

 Throws a SecurityException if the  calling thread is not allowed to open a socket connection to the  specified host and port number.

 	checkConnect(String, int, Object)

 Throws a SecurityException if the  specified security context is not allowed to open a socket  connection to the specified host and port number.

 	checkCreateClassLoader()

 Throws a SecurityException if the  calling thread is not allowed to create a new class loader.

 	checkDelete(String)

 Throws a SecurityException if the  calling thread is not allowed to delete the specified file.

 	checkExec(String)

 Throws a SecurityException if the  calling thread is not allowed to create a subprocss.

 	checkExit(int)

 Throws a SecurityException if the  calling thread is not allowed to cause the Java Virtual Machine to  halt with the specified status code.

 	checkLink(String)

 Throws a SecurityException if the  calling thread is not allowed to dynamic link the library code  specified by the string argument file.

 	checkListen(int)

 Throws a SecurityException if the  calling thread is not allowed to wait for a connection request on  the specified local port number.

 	checkMemberAccess(Class, int)

 Tests if a client is allowed to access members.

 	checkMulticast(InetAddress)

 Tests if current execution context is allowed to use  (join/leave/send/receive) IP multicast.

 	checkMulticast(InetAddress, byte)

 Tests to see if current execution context is allowed to use  (join/leave/send/receive) IP multicast.

 	checkPackageAccess(String)

 Throws a SecurityException if the  calling thread is not allowed to access the package specified by  the argument.

 	checkPackageDefinition(String)

 Throws a SecurityException if the  calling thread is not allowed to define classes in the package  specified by the argument.

 	checkPrintJobAccess()

 Tests if a client can initiate a print job request.

 	checkPropertiesAccess()

 Throws a SecurityException if the  calling thread is not allowed to access or modify the system  properties.

 	checkPropertyAccess(String)

 Throws a SecurityException if the  calling thread is not allowed to access the system property with  the specified key  name.

 	checkRead(FileDescriptor)

 Throws a SecurityException if the  calling thread is not allowed to read from the specified file  descriptor.

 	checkRead(String)

 Throws a SecurityException if the  calling thread is not allowed to read the file specified by the  string argument.

 	checkRead(String, Object)

 Throws a SecurityException if the  specified security context is not allowed to read the file  specified by the string argument.

 	checkSecurityAccess(String)

 Tests access to certain operations for a security API  action.

 	checkSetFactory()

 Throws a SecurityException if the  calling thread is not allowed to set the socket factory used by  ServerSocket or Socket, or the stream  handler factory used by URL.

 	checkSystemClipboardAccess()

 Tests if a client can get access to the system clipboard.

 	checkTopLevelWindow(Object)

 Returns false if the calling  thread is not trusted to bring up the top-level window indicated  by the window  argument.

 	checkWrite(FileDescriptor)

 Throws a SecurityException if the  calling thread is not allowed to write to the specified file  descriptor.

 	checkWrite(String)

 Throws a SecurityException if the  calling thread is not allowed to write to the file specified by  the string argument.

 	classDepth(String)

 Returns the stack depth of the specified class.

 	classLoaderDepth()

 Returns the stack depth of the most recently executing method  from a class defined using a class loader.

 	currentClassLoader()

 Returns an object describing the most recent class loader executing  on the stack.

 	currentLoadedClass()

 Returns the current Class with a ClassLoader on the execution stack.

 	getClassContext()

 Returns the current execution stack as an array of classes.

 	getInCheck()

 Tests if there is a security check in progress.

 	getSecurityContext()

 Creates an object that encapsulates the current execution  environment.

 	getThreadGroup()

 Returns the thread group into which to instantiate any new  thread being created at the time this is being called.

 	inClass(String)

 Tests if the specified String is in this Class.

 	inClassLoader()

 Tests if the current ClassLoader is equal to  null.

 inCheck

  protected boolean inCheck

 This field is true if there is a security check in  progress; false otherwise.

 SecurityManager

  protected SecurityManager()

 Constructs a new SecurityManager. An application is  not allowed to create a new security manager if there is already a  current security manager.

Throws: SecurityException

 if a security manager already exists.

See Also:

getSecurityManager

 getInCheck

  public boolean getInCheck()

 Tests if there is a security check in progress.

Returns:

 the value of the inCheck field. This field should  contain true  if a security check is in progress;  false otherwise.

See Also:

inCheck

 getClassContext

  protected Class[] getClassContext()

 Returns the current execution stack as an array of classes.

 The length of the array is the number of methods on the execution  stack. The element at index 0 is the class of the  currently executing method, the element at index 1  is  the class of that method's caller, and so on.

Returns:

 the execution stack.

 currentClassLoader

  protected ClassLoader currentClassLoader()

 Returns an object describing the most recent class loader executing  on the stack.

Returns:

 the class loader of the most recent occurrence on the stack  of a method from a class defined using a class loader;  returns null  if there is no occurrence on the  stack of a method from a class defined using a class loader.

 currentLoadedClass

  protected Class currentLoadedClass()

 Returns the current Class with a ClassLoader on the execution stack.

 classDepth

  protected int classDepth(String name)

 Returns the stack depth of the specified class.

Parameters:

 name - the fully qualified name of the class to search for.

Returns:

 the depth on the stack frame of the first occurrence of a  method from a class with the specified name;  -1 if such a frame cannot be found.

 classLoaderDepth

  protected int classLoaderDepth()

 Returns the stack depth of the most recently executing method  from a class defined using a class loader.

Returns:

 the depth on the stack frame of the most recent occurrence of a  method from a class defined using a class loader; returns  -1  if there is no occurrence of a method from  a class defined using a class loader.

 inClass

  protected boolean inClass(String name)

 Tests if the specified String is in this Class.

Parameters:

 name - the fully qualified name of the class.

Returns:

true if a method from a class with the specified  name is on the execution stack; false otherwise.

 inClassLoader

  protected boolean inClassLoader()

 Tests if the current ClassLoader is equal to  null.

Returns:

true if a method from a class defined using a  class loader is on the execution stack.

 getSecurityContext

  public Object getSecurityContext()

 Creates an object that encapsulates the current execution  environment. The result of this method is used by the  three-argument checkConnect  method and by the  two-argument checkRead method.

 These methods are needed because a trusted method may be called  on to read a file or open a socket on behalf of another method.  The trusted method needs to determine if the other (possibly  untrusted) method would be allowed to perform the operation on its  own.

Returns:

 an implementation-dependent object that encapsulates  sufficient information about the current execution environment  to perform some security checks later.

See Also:

checkConnect, checkRead

 checkCreateClassLoader

  public void checkCreateClassLoader()

 Throws a SecurityException if the  calling thread is not allowed to create a new class loader.

 The checkCreateClassLoader method for class  SecurityManager  always throws a  SecurityException.

Throws: SecurityException

 if the caller does not have permission  to create a new class loader.

See Also:

ClassLoader

 checkAccess

  public void checkAccess(Thread g)

 Throws a SecurityException if the  calling thread is not allowed to modify the thread argument.

 This method is invoked for the current security manager by the  stop, suspend, resume,  setPriority, setName, and  setDaemon methods of class Thread.

 The checkAccess method for class  SecurityManager always throws a  SecurityException.

Parameters:

 g - the thread to be checked.

Throws: SecurityException

 if the caller does not have permission  to modify the thread.

See Also:

getSecurityManager, resume, setDaemon, setName, setPriority, stop, suspend

 checkAccess

  public void checkAccess(ThreadGroup g)

 Throws a SecurityException if the  calling thread is not allowed to modify the thread group argument.

 This method is invoked for the current security manager when a  new child thread or child thread group is created, and by the  setDaemon, setMaxPriority,  stop, suspend, resume, and  destroy methods of class ThreadGroup.

 The checkAccess method for class  SecurityManager always throws a  SecurityException.

Parameters:

 g - the thread group to be checked.

Throws: SecurityException

 if the caller does not have permission  to modify the thread group.

See Also:

getSecurityManager, destroy, resume, setDaemon, setMaxPriority, stop, suspend

 checkExit

  public void checkExit(int status)

 Throws a SecurityException if the  calling thread is not allowed to cause the Java Virtual Machine to  halt with the specified status code.

 This method is invoked for the current security manager by the  exit method of class Runtime. A status  of 0 indicates success; other values indicate various  errors.

 The checkExit method for class  SecurityManager always throws a  SecurityException.

Parameters:

 status - the exit status.

Throws: SecurityException

 if the caller does not have permission  to halt the Java Virtual Machine with the specified status.

See Also:

exit, getSecurityManager

 checkExec

  public void checkExec(String cmd)

 Throws a SecurityException if the  calling thread is not allowed to create a subprocss.

 This method is invoked for the current security manager by the  exec methods of class Runtime.

 The checkExec method for class  SecurityManager always throws a  SecurityException.

Parameters:

 cmd - the specified system command.

Throws: SecurityException

 if the caller does not have permission  to create a subprocess.

See Also:

exec, exec, exec, exec, getSecurityManager

 checkLink

  public void checkLink(String lib)

 Throws a SecurityException if the  calling thread is not allowed to dynamic link the library code  specified by the string argument file. The argument is either a  simple library name or a complete filename.

 This method is invoked for the current security manager by  methods load and loadLibrary of class  Runtime.

 The checkLink method for class  SecurityManager always throws a  SecurityException.

Parameters:

 lib - the name of the library.

Throws: SecurityException

 if the caller does not have permission  to dynamically link the library.

See Also:

load, loadLibrary, getSecurityManager

 checkRead

  public void checkRead(FileDescriptor fd)

 Throws a SecurityException if the  calling thread is not allowed to read from the specified file  descriptor.

 The checkRead method for class  SecurityManager always throws a  SecurityException.

Parameters:

 fd - the system-dependent file descriptor.

Throws: SecurityException

 if the caller does not have permission  to access the specified file descriptor.

See Also:

FileDescriptor

 checkRead

  public void checkRead(String file)

 Throws a SecurityException if the  calling thread is not allowed to read the file specified by the  string argument.

 The checkRead method for class  SecurityManager always throws a  SecurityException.

Parameters:

 file - the system-dependent file name.

Throws: SecurityException

 if the caller does not have permission  to access the specified file.

 checkRead

  public void checkRead(String file,
                        Object context)

 Throws a SecurityException if the  specified security context is not allowed to read the file  specified by the string argument. The context must be a security  context returned by a previous call to  getSecurityContext.

 The checkRead method for class  SecurityManager always throws a  SecurityException.

Parameters:

 file - the system-dependent filename.

 context - a system-dependent security context.

Throws: SecurityException

 if the specified security context does  not have permission to read the specified file.

See Also:

getSecurityContext

 checkWrite

  public void checkWrite(FileDescriptor fd)

 Throws a SecurityException if the  calling thread is not allowed to write to the specified file  descriptor.

 The checkWrite method for class  SecurityManager always throws a  SecurityException.

Parameters:

 fd - the system-dependent file descriptor.

Throws: SecurityException

 if the caller does not have permission  to access the specified file descriptor.

See Also:

FileDescriptor

 checkWrite

  public void checkWrite(String file)

 Throws a SecurityException if the  calling thread is not allowed to write to the file specified by  the string argument.

 The checkWrite method for class  SecurityManager always throws a  SecurityException.

Parameters:

 file - the system-dependent filename.

Throws: SecurityException

 if the caller does not have permission  to access the specified file.

 checkDelete

  public void checkDelete(String file)

 Throws a SecurityException if the  calling thread is not allowed to delete the specified file.

 This method is invoked for the current security manager by the  delete  method of class File.

 The checkDelete method for class  SecurityManager always throws a  SecurityException.

Parameters:

 file - the system-dependent filename.

Throws: SecurityException

 if the caller does not have permission  to delete the file.

See Also:

delete, getSecurityManager

 checkConnect

  public void checkConnect(String host,
                           int port)

 Throws a SecurityException if the  calling thread is not allowed to open a socket connection to the  specified host and port number.

 A port number of -1 indicates that the calling  method is attempting to determine the IP address of the specified  host name.

 The checkConnect method for class  SecurityManager always throws a  SecurityException.

Parameters:

 host - the host name port to connect to.

 port - the protocol port to connect to.

Throws: SecurityException

 if the caller does not have permission  to open a socket connection to the specified  host and port.

 checkConnect

  public void checkConnect(String host,
                           int port,
                           Object context)

 Throws a SecurityException if the  specified security context is not allowed to open a socket  connection to the specified host and port number.

 A port number of -1 indicates that the calling  method is attempting to determine the IP address of the specified  host name.

 The checkConnect method for class  SecurityManager always throws a  SecurityException.

Parameters:

 host - the host name port to connect to.

 port - the protocol port to connect to.

 context - a system-dependent security context.

Throws: SecurityException

 if the specified security context does  not have permission to open a socket connection to the  specified host and port.

See Also:

getSecurityContext

 checkListen

  public void checkListen(int port)

 Throws a SecurityException if the  calling thread is not allowed to wait for a connection request on  the specified local port number.

 The checkListen method for class  SecurityManager always throws a  SecurityException.

Parameters:

 port - the local port.

Throws: SecurityException

 if the caller does not have permission  to listen on the specified port.

 checkAccept

  public void checkAccept(String host,
                          int port)

 Throws a SecurityException if the  calling thread is not permitted to accept a socket connection from  the specified host and port number.

 This method is invoked for the current security manager by the  accept  method of class ServerSocket.

 The checkAccept method for class  SecurityManager always throws a  SecurityException.

Parameters:

 host - the host name of the socket connection.

 port - the port number of the socket connection.

Throws: SecurityException

 if the caller does not have permission  to accept the connection.

See Also:

getSecurityManager, accept

 checkMulticast

  public void checkMulticast(InetAddress maddr)

 Tests if current execution context is allowed to use  (join/leave/send/receive) IP multicast.

Parameters:

 multicast - Internet group address to be used.

Throws: SecurityException

 if a security error has occurred.

 checkMulticast

  public void checkMulticast(InetAddress maddr,
                             byte ttl)

 Tests to see if current execution context is allowed to use  (join/leave/send/receive) IP multicast.

Parameters:

 multicast - Internet group address to be used.

 ttl - value in use, if it is multicast send.

Throws: SecurityException

 if a security error has occurred.

 checkPropertiesAccess

  public void checkPropertiesAccess()

 Throws a SecurityException if the  calling thread is not allowed to access or modify the system  properties.

 This method is used by the getProperties and  setProperties  methods of class System.

 The checkPropertiesAccess method for class  SecurityManager  always throws a  SecurityException.

Throws: SecurityException

 if the caller does not have permission  to access or modify the system properties.

See Also:

getProperties, setProperties

 checkPropertyAccess

  public void checkPropertyAccess(String key)

 Throws a SecurityException if the  calling thread is not allowed to access the system property with  the specified key  name.

 This method is used by the getProperty method of  class System.

 The checkPropertiesAccess method for class  SecurityManager  always throws a  SecurityException.

Parameters:

 key - a system property key.

Throws: SecurityException

 if the caller does not have permission  to access the specified system property.

See Also:

getProperty

 checkTopLevelWindow

  public boolean checkTopLevelWindow(Object window)

 Returns false if the calling  thread is not trusted to bring up the top-level window indicated  by the window  argument. In this case, the caller can  still decide to show the window, but the window should include  some sort of visual warning. If the method returns  true , then the window can be shown without any  special restrictions.

 See class Window for more information on trusted and  untrusted windows.

 The checkSetFactory method for class  SecurityManager always returns false.

Parameters:

 window - the new window that is being created.

Returns:

true if the caller is trusted to put up  top-level windows; false  otherwise.

Throws: SecurityException

 if creation is disallowed entirely.

See Also:

Window

 checkPrintJobAccess

  public void checkPrintJobAccess()

 Tests if a client can initiate a print job request.

 checkSystemClipboardAccess

  public void checkSystemClipboardAccess()

 Tests if a client can get access to the system clipboard.

 checkAwtEventQueueAccess

  public void checkAwtEventQueueAccess()

 Tests if a client can get access to the AWT event queue.

 checkPackageAccess

  public void checkPackageAccess(String pkg)

 Throws a SecurityException if the  calling thread is not allowed to access the package specified by  the argument.

 This method is used by the loadClass method of class  loaders.

 The checkPackageAccess method for class  SecurityManager always throws a  SecurityException.

Parameters:

 pkg - the package name.

Throws: SecurityException

 if the caller does not have permission  to access the specified package.

See Also:

loadClass

 checkPackageDefinition

  public void checkPackageDefinition(String pkg)

 Throws a SecurityException if the  calling thread is not allowed to define classes in the package  specified by the argument.

 This method is used by the loadClass method of some  class loaders.

 The checkPackageDefinition method for class  SecurityManager  always throws a  SecurityException.

Parameters:

 pkg - the package name.

Throws: SecurityException

 if the caller does not have permission  to define classes in the specified package.

See Also:

loadClass

 checkSetFactory

  public void checkSetFactory()

 Throws a SecurityException if the  calling thread is not allowed to set the socket factory used by  ServerSocket or Socket, or the stream  handler factory used by URL.

 The checkSetFactory method for class  SecurityManager always throws a  SecurityException.

Throws: SecurityException

 if the caller does not have permission  to specify a socket factory or a stream handler factory.

See Also:

setSocketFactory, setSocketImplFactory, setURLStreamHandlerFactory

 checkMemberAccess

  public void checkMemberAccess(Class clazz,
                                int which)

 Tests if a client is allowed to access members. If access is  denied, throw a SecurityException.  The default policy is to deny all accesses.

 checkSecurityAccess

  public void checkSecurityAccess(String action)

 Tests access to certain operations for a security API  action.

 getThreadGroup

  public ThreadGroup getThreadGroup()

 Returns the thread group into which to instantiate any new  thread being created at the time this is being called.  By default, it returns the thread group of the current  thread. This should be overriden by specific security  manager to return the appropriate thread group.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.Short

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.Short

java.lang.Object
   |
   +----java.lang.Number
           |
           +----java.lang.Short

______________________________________________________________________________

 public final class Short

 extends Number

The Short class is the standard wrapper for short values.

See Also:

Number

______________________________________________________________________________

 	MAX_VALUE

 The maximum value a Short can have.

 	MIN_VALUE

 The minimum value a Short can have.

 	TYPE

 The Class object representing the primitive type short.

 	Short(short)

 Constructs a Short object initialized to the specified short value.

 	Short(String)

 Constructs a Short object initialized to the value specified by the  String parameter.

 	byteValue()

 Returns the value of this Short as a byte.

 	decode(String)

 Decodes a String into a Short.

 	doubleValue()

 Returns the value of this Short as a double.

 	equals(Object)

 Compares this object to the specified object.

 	floatValue()

 Returns the value of this Short as a float.

 	hashCode()

 Returns a hashcode for this Short.

 	intValue()

 Returns the value of this Short as an int.

 	longValue()

 Returns the value of this Short as a long.

 	parseShort(String)

 Assuming the specified String represents a short, returns  that short's value.

 	parseShort(String, int)

 Assuming the specified String represents a short, returns  that short's value.

 	shortValue()

 Returns the value of this Short as a short.

 	toString()

 Returns a String object representing this Short's value.

 	toString(short)

 Returns a new String object representing the specified  Short.

 	valueOf(String)

 Assuming the specified String represents a short, returns a  new Short object initialized to that value.

 	valueOf(String, int)

 Assuming the specified String represents a short, returns a  new Short object initialized to that value.

 MIN_VALUE

  public final static short MIN_VALUE

 The minimum value a Short can have.

 MAX_VALUE

  public final static short MAX_VALUE

 The maximum value a Short can have.

 TYPE

  public final static Class TYPE

 The Class object representing the primitive type short.

 Short

  public Short(short value)

 Constructs a Short object initialized to the specified short value.

Parameters:

 value - the initial value of the Short

 Short

  public Short(String s) throws NumberFormatException

 Constructs a Short object initialized to the value specified by the  String parameter. The radix is assumed to be 10.

Parameters:

 s - the String to be converted to a Short

Throws: NumberFormatException

 If the String does not 	contain a parsable short.

 toString

  public static String toString(short s)

 Returns a new String object representing the specified  Short. The radix is assumed to be 10.

Parameters:

 s - the short to be converted

 parseShort

  public static short parseShort(String s) throws NumberFormatException

 Assuming the specified String represents a short, returns  that short's value. Throws an exception if the String cannot  be parsed as a short. The radix is assumed to be 10.

Parameters:

 s - the String containing the short

Throws: NumberFormatException

 If the string does not 	contain a parsable short.

 parseShort

  public static short parseShort(String s,
                                 int radix) throws NumberFormatException

 Assuming the specified String represents a short, returns  that short's value. Throws an exception if the String cannot  be parsed as a short.

Parameters:

 s - the String containing the short

 radix - the radix to be used

Throws: NumberFormatException

 If the String does not 	contain a parsable short.

 valueOf

  public static Short valueOf(String s,
                              int radix) throws NumberFormatException

 Assuming the specified String represents a short, returns a  new Short object initialized to that value. Throws an  exception if the String cannot be parsed as a short.

Parameters:

 s - the String containing the integer

 radix - the radix to be used

Throws: NumberFormatException

 If the String does not 	contain a parsable short.

 valueOf

  public static Short valueOf(String s) throws NumberFormatException

 Assuming the specified String represents a short, returns a  new Short object initialized to that value. Throws an  exception if the String cannot be parsed as a short.

Parameters:

 s - the String containing the integer

Throws: NumberFormatException

 If the String does not 	contain a parsable short.

 decode

  public static Short decode(String nm) throws NumberFormatException

 Decodes a String into a Short. The String may represent  decimal, hexadecimal, and octal numbers.

Parameters:

 nm - the string to decode

 byteValue

  public byte byteValue()

 Returns the value of this Short as a byte.

Overrides:

byteValue in class Number

 shortValue

  public short shortValue()

 Returns the value of this Short as a short.

Overrides:

shortValue in class Number

 intValue

  public int intValue()

 Returns the value of this Short as an int.

Overrides:

intValue in class Number

 longValue

  public long longValue()

 Returns the value of this Short as a long.

Overrides:

longValue in class Number

 floatValue

  public float floatValue()

 Returns the value of this Short as a float.

Overrides:

floatValue in class Number

 doubleValue

  public double doubleValue()

 Returns the value of this Short as a double.

Overrides:

doubleValue in class Number

 toString

  public String toString()

 Returns a String object representing this Short's value.

Overrides:

toString in class Object

 hashCode

  public int hashCode()

 Returns a hashcode for this Short.

Overrides:

hashCode in class Object

 equals

  public boolean equals(Object obj)

 Compares this object to the specified object.

Parameters:

 obj - the object to compare with

Returns:

 true if the objects are the same; false otherwise.

Overrides:

equals in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.StackOverflowError

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.StackOverflowError

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Error
                   |
                   +----java.lang.VirtualMachineError
                           |
                           +----java.lang.StackOverflowError

______________________________________________________________________________

 public class StackOverflowError

 extends VirtualMachineError

Thrown when a stack overflow occurs because an application  recurses too deeply.

______________________________________________________________________________

 	StackOverflowError()

 Constructs a StackOverflowError with no detail message.

 	StackOverflowError(String)

 Constructs a StackOverflowError with the specified  detail message.

 StackOverflowError

  public StackOverflowError()

 Constructs a StackOverflowError with no detail message.

 StackOverflowError

  public StackOverflowError(String s)

 Constructs a StackOverflowError with the specified  detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.String

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.String

java.lang.Object
   |
   +----java.lang.String

______________________________________________________________________________

 public final class String

 extends Object

 implements Serializable

The String class represents character strings. All  string literals in Java programs, such as "abc", are  implemented as instances of this class.

 Strings are constant; their values cannot be changed after they  are created. String buffers support mutable strings.  Because String objects are immutable they can be shared. For example:

     String str = "abc";

 is equivalent to:

     char data[] = {'a', 'b', 'c'};
     String str = new String(data);

 Here are some more examples of how strings can be used:

     System.out.println("abc");
     String cde = "cde";
     System.out.println("abc" + cde);
     String c = "abc".substring(2,3);
     String d = cde.substring(1, 2);

 The class String includes methods for examining  individual characters of the sequence, for comparing strings, for  searching strings, for extracting substrings, and for creating a  copy of a string with all characters translated to uppercase or to  lowercase.

 The Java language provides special support for the string  concatentation operator ( + ), and for conversion of  other objects to strings. String concatenation is implemented  through the StringBuffer  class and its  append method.  String conversions are implemented through the method  toString, defined by Object and  inherited by all classes in Java. For additional information on  string concatenation and conversion, see Gosling, Joy, and Steele,  The Java Language Specification.

See Also:

toString, StringBuffer, append, append, append, append, append, append, append, append, append , append

______________________________________________________________________________

 	String()

 Allocates a new String containing no characters.

 	String(byte[])

 Construct a new String by converting the specified array of bytes using  the platform's default character encoding.

 	String(byte[], int)

 Allocates a new String containing characters  constructed from an array of 8-bit integer values. Deprecated.

 	String(byte[], int, int)

 Construct a new String by converting the specified subarray of bytes  using the platform's default character encoding.

 	String(byte[], int, int, int)

 Allocates a new String constructed from a subarray  of an array of 8-bit integer values. Deprecated.

 	String(byte[], int, int, String)

 Construct a new String by converting the specified subarray of bytes  using the specified character encoding.

 	String(byte[], String)

 Construct a new String by converting the specified array of bytes using  the specified character encoding.

 	String(char[])

 Allocates a new String so that it represents the  sequence of characters currently contained in the character array  argument.

 	String(char[], int, int)

 Allocates a new String that contains characters from  a subarray of the character array argument.

 	String(String)

 Allocates a new string that contains the same sequence of  characters as the string argument.

 	String(StringBuffer)

 Allocates a new string that contains the sequence of characters  currently contained in the string buffer argument.

 	charAt(int)

 Returns the character at the specified index.

 	compareTo(String)

 Compares two strings lexicographically.

 	concat(String)

 Concatenates the specified string to the end of this string.

 	copyValueOf(char[])

 Returns a String that is equivalent to the specified character array.

 	copyValueOf(char[], int, int)

 Returns a String that is equivalent to the specified character array.

 	endsWith(String)

 Tests if this string ends with the specified suffix.

 	equals(Object)

 Compares this string to the specified object.

 	equalsIgnoreCase(String)

 Compares this String to another object.

 	getBytes()

 Convert this String into bytes according to the platform's default  character encoding, storing the result into a new byte array.

 	getBytes(int, int, byte[], int)

 Copies characters from this string into the destination byte  array. Deprecated.

 	getBytes(String)

 Convert this String into bytes according to the specified character  encoding, storing the result into a new byte array.

 	getChars(int, int, char[], int)

 Copies characters from this string into the destination character array.

 	hashCode()

 Returns a hashcode for this string.

 	indexOf(int)

 Returns the index within this string of the first occurrence of the  specified character.

 	indexOf(int, int)

 Returns the index within this string of the first occurrence of the  specified character, starting the search at the specified index.

 	indexOf(String)

 Returns the index within this string of the first occurrence of the  specified substring.

 	indexOf(String, int)

 Returns the index within this string of the first occurrence of the  specified substring, starting at the specified index.

 	intern()

 Returns a canonical representation for the string object.

 	lastIndexOf(int)

 Returns the index within this string of the last occurrence of the  specified character.

 	lastIndexOf(int, int)

 Returns the index within this string of the last occurrence of the  specified character, searching backward starting at the specified index.

 	lastIndexOf(String)

 Returns the index within this string of the rightmost occurrence  of the specified substring.

 	lastIndexOf(String, int)

 Returns the index within this string of the last occurrence of  the specified substring.

 	length()

 Returns the length of this string.

 	regionMatches(boolean, int, String, int, int)

 Tests if two string regions are equal.

 	regionMatches(int, String, int, int)

 Tests if two string regions are equal.

 	replace(char, char)

 Returns a new string resulting from replacing all occurrences of  oldChar  in this string with newChar.

 	startsWith(String)

 Tests if this string starts with the specified prefix.

 	startsWith(String, int)

 Tests if this string starts with the specified prefix.

 	substring(int)

 Returns a new string that is a substring of this string.

 	substring(int, int)

 Returns a new string that is a substring of this string.

 	toCharArray()

 Converts this string to a new character array.

 	toLowerCase()

 Converts this string to lowercase.

 	toLowerCase(Locale)

 Converts all of the characters in this String to lower case using  the rules of the given locale.

 	toString()

 This object (which is already a string!) is itself returned.

 	toUpperCase()

 Converts this string to uppercase.

 	toUpperCase(Locale)

 Converts all of the characters in this String to upper case using  the rules of the given locale.

 	trim()

 Removes white space from both ends of this string.

 	valueOf(boolean)

 Returns the string representation of the boolean argument.

 	valueOf(char)

 Returns the string representation of the char * argument.

 	valueOf(char[])

 Returns the string representation of the char array  argument.

 	valueOf(char[], int, int)

 Returns the string representation of a specific subarray of the  char array argument.

 	valueOf(double)

 Returns the string representation of the double argument.

 	valueOf(float)

 Returns the string representation of the float argument.

 	valueOf(int)

 Returns the string representation of the int argument.

 	valueOf(long)

 Returns the string representation of the long argument.

 	valueOf(Object)

 Returns the string representation of the Object argument.

 String

  public String()

 Allocates a new String containing no characters.

 String

  public String(String value)

 Allocates a new string that contains the same sequence of  characters as the string argument.

Parameters:

 value - a String.

 String

  public String(char value[])

 Allocates a new String so that it represents the  sequence of characters currently contained in the character array  argument.

Parameters:

 value - the initial value of the string.

 String

  public String(char value[],
                int offset,
                int count)

 Allocates a new String that contains characters from  a subarray of the character array argument. The offset  argument is the index of the first character of the subarray and  the count  argument specifies the length of the  subarray.

Parameters:

 value - array that is the source of characters.

 offset - the initial offset.

 count - the length.

Throws: StringIndexOutOfBoundsException

 if the offset  and count arguments index characters outside  the bounds of the value array.

 String

  public String(byte ascii[],
                int hibyte,
                int offset,
                int count)

 Note: String() is deprecated. This method does not properly convert bytes into characters.  As of JDK 1.1, the preferred way to do this is using  the String  constructors that take a  character-encoding name or that use the default encoding.

 Allocates a new String constructed from a subarray  of an array of 8-bit integer values.

 The offset argument is the index of the first byte  of the subarray, and the count argument specifies the  length of the subarray.

 Each byte in the subarray is converted to a  char  as specified in the method above.

Parameters:

 ascii - the bytes to be converted to characters.

 hibyte - the top 8 bits of each 16-bit Unicode character.

 offset - the initial offset.

 count - the length.

Throws: StringIndexOutOfBoundsException

 if the offset  or count argument is invalid.

See Also:

String, String, String, String, String

 String

  public String(byte ascii[],
                int hibyte)

 Note: String() is deprecated. This method does not properly convert bytes into characters.  As of JDK 1.1, the preferred way to do this is using  the String  constructors that take a  character-encoding name or that use the default encoding.

 Allocates a new String containing characters  constructed from an array of 8-bit integer values. Each character  c in the resulting string is constructed from the  corresponding component b  in the byte array such that:

     c == (char)(((hibyte & 0xff) << 8)
                         | (b & 0xff))

Parameters:

 ascii - the bytes to be converted to characters.

 hibyte - the top 8 bits of each 16-bit Unicode character.

See Also:

String, String, String, String

 String

  public String(byte bytes[],
                int offset,
                int length,
                String enc) throws UnsupportedEncodingException

 Construct a new String by converting the specified subarray of bytes  using the specified character encoding. The length of the new String is  a function of the encoding, and hence may not be equal to the length of  the subarray.

Parameters:

 bytes - The bytes to be converted into characters

 offset - Index of the first byte to convert

 length - Number of bytes to convert

 enc - The name of a character encoding

Throws: UnsupportedEncodingException

 If the named encoding is not supported

 String

  public String(byte bytes[],
                String enc) throws UnsupportedEncodingException

 Construct a new String by converting the specified array of bytes using   the specified character encoding. The length of the new String is a  function of the encoding, and hence may not be equal to the length of  the byte array.

Parameters:

 bytes - The bytes to be converted into characters

 enc - A character-encoding name

Throws: UnsupportedEncodingException

 If the named encoding is not supported

 String

  public String(byte bytes[],
                int offset,
                int length)

 Construct a new String by converting the specified subarray of bytes  using the platform's default character encoding. The length of the new  String is a function of the encoding, and hence may not be equal to the  length of the subarray.

Parameters:

 bytes - The bytes to be converted into characters

 offset - Index of the first byte to convert

 length - Number of bytes to convert

 String

  public String(byte bytes[])

 Construct a new String by converting the specified array of bytes using   the platform's default character encoding. The length of the new String  is a function of the encoding, and hence may not be equal to the length  of the byte array.

Parameters:

 bytes - The bytes to be converted into characters

 String

  public String(StringBuffer buffer)

 Allocates a new string that contains the sequence of characters  currently contained in the string buffer argument.

Parameters:

 buffer - a StringBuffer.

 length

  public int length()

 Returns the length of this string.  The length is equal to the number of 16-bit  Unicode characters in the string.

Returns:

 the length of the sequence of characters represented by this  object.

 charAt

  public char charAt(int index)

 Returns the character at the specified index. An index ranges  from 0 to length() - 1.

Parameters:

 index - the index of the character.

Returns:

 the character at the specified index of this string.  The first character is at index 0 .

Throws: StringIndexOutOfBoundsException

 if the index is out of  range.

 getChars

  public void getChars(int srcBegin,
                       int srcEnd,
                       char dst[],
                       int dstBegin)

 Copies characters from this string into the destination character array.

 The first character to be copied is at index srcBegin;  the last character to be copied is at index srcEnd-1  (thus the total number of characters to be copied is  srcEnd-srcBegin ). The characters are copied into the  subarray of dst starting at index dstBegin  and ending at index:

     dstbegin + (srcEnd-srcBegin) - 1

Parameters:

 srcBegin - index of the first character in the string  to copy.

 srcEnd - index after the last character in the string  to copy.

 dst - the destination array.

 dstBegin - the start offset in the destination array.

Throws: StringIndexOutOfBoundsException

 If srcBegin or srcEnd is out  of range, or if srcBegin is greater than the srcEnd.

 getBytes

  public void getBytes(int srcBegin,
                       int srcEnd,
                       byte dst[],
                       int dstBegin)

 Note: getBytes() is deprecated. This method does not properly convert characters into bytes.  As of JDK version 1.1, the preferred way to do this is via  the getBytes()  methods that take a  character-encoding name, or that use the  platform's default encoding.

 Copies characters from this string into the destination byte  array. Each byte receives the 8 low-order bits of the  corresponding character.

 The first character to be copied is at index srcBegin;  the last character to be copied is at index srcEnd-1.  The total number of characters to be copied is  srcEnd-srcBegin . The characters, converted to bytes,  are copied into the subarray of dst  starting at index  dstBegin and ending at index:

     dstbegin + (srcEnd-srcBegin) - 1

Parameters:

 srcBegin - index of the first character in the string  to copy.

 srcEnd - index after the last character in the string  to copy.

 dst - the destination array.

 dstBegin - the start offset in the destination array.

Throws: StringIndexOutOfBoundsException

 if srcBegin or srcEnd is out  of range, or if srcBegin is greater than srcEnd.

 getBytes

  public byte[] getBytes(String enc) throws UnsupportedEncodingException

 Convert this String into bytes according to the specified character  encoding, storing the result into a new byte array.

Parameters:

 enc - A character-encoding name

Returns:

 The resultant byte array

Throws: UnsupportedEncodingException

 If the named encoding is not supported

 getBytes

  public byte[] getBytes()

 Convert this String into bytes according to the platform's default  character encoding, storing the result into a new byte array.

Returns:

 the resultant byte array.

 equals

  public boolean equals(Object anObject)

 Compares this string to the specified object.  The result is true if and only if the argument is not  null and is a String  object that represents  the same sequence of characters as this object.

Parameters:

 anObject - the object to compare this String  against.

Returns:

true if the String are equal;  false otherwise.

Overrides:

equals in class Object

See Also:

compareTo, equalsIgnoreCase

 equalsIgnoreCase

  public boolean equalsIgnoreCase(String anotherString)

 Compares this String to another object.  The result is true  if and only if the argument is not  null and is a String  object that represents  the same sequence of characters as this object, where case is ignored.

 Two characters are considered the same, ignoring case, if at  least one of the following is true:

• The two characters are the same (as compared by the ==  operator).

• Applying the method Character.toUppercase to each  character produces the same result.

• Applying the method Character.toLowercase to each  character produces the same result.

 Two sequences of characters are the same, ignoring case, if the  sequences have the same length and corresponding characters are  the same, ignoring case.

Parameters:

 anotherString - the String to compare this  String against.

Returns:

true if the Strings are equal,  ignoring case; false otherwise.

See Also:

toLowerCase, toUpperCase

 compareTo

  public int compareTo(String anotherString)

 Compares two strings lexicographically.  The comparison is based on the Unicode value of each character in  the strings.

Parameters:

 anotherString - the String to be compared.

Returns:

 the value 0 if the argument string is equal to  this string; a value less than 0 if this string  is lexicographically less than the string argument; and a  value greater than 0 if this string is  lexicographically greater than the string argument.

 regionMatches

  public boolean regionMatches(int toffset,
                               String other,
                               int ooffset,
                               int len)

 Tests if two string regions are equal.

 If toffset or ooffset is negative, or  if toffset+length is greater than the  length of this string, or if  ooffset+length  is greater than the  length of the string argument, then this method returns  false.

Parameters:

 toffset - the starting offset of the subregion in this string.

 other - the string argument.

 ooffset - the starting offset of the subregion in the string  argument.

 len - the number of characters to compare.

Returns:

true if the specified subregion of this string  exactly matches the specified subregion of the string argument;  false otherwise.

 regionMatches

  public boolean regionMatches(boolean ignoreCase,
                               int toffset,
                               String other,
                               int ooffset,
                               int len)

 Tests if two string regions are equal.

 If toffset or ooffset is negative, or  if toffset+length is greater than the  length of this string, or if  ooffset+length  is greater than the  length of the string argument, then this method returns  false.

Parameters:

 ignoreCase - if true, ignore case when comparing  characters.

 toffset - the starting offset of the subregion in this  string.

 other - the string argument.

 ooffset - the starting offset of the subregion in the string  argument.

 len - the number of characters to compare.

Returns:

true if the specified subregion of this string  matches the specified subregion of the string argument;  false  otherwise. Whether the matching is exact  or case insensitive depends on the ignoreCase   argument.

 startsWith

  public boolean startsWith(String prefix,
                            int toffset)

 Tests if this string starts with the specified prefix.

Parameters:

 prefix - the prefix.

 toffset - where to begin looking in the string.

Returns:

true if the character sequence represented by the  argument is a prefix of the substring of this object starting  at index toffset; false otherwise.

 startsWith

  public boolean startsWith(String prefix)

 Tests if this string starts with the specified prefix.

Parameters:

 prefix - the prefix.

Returns:

true if the character sequence represented by the  argument is a prefix of the character sequence represented by  this string; false  otherwise.

 endsWith

  public boolean endsWith(String suffix)

 Tests if this string ends with the specified suffix.

Parameters:

 suffix - the suffix.

Returns:

true if the character sequence represented by the  argument is a suffix of the character sequence represented by  this object; false  otherwise.

 hashCode

  public int hashCode()

 Returns a hashcode for this string.

Returns:

 a hash code value for this object.

Overrides:

hashCode in class Object

 indexOf

  public int indexOf(int ch)

 Returns the index within this string of the first occurrence of the  specified character.

Parameters:

 ch - a character.

Returns:

 the index of the first occurrence of the character in the  character sequence represented by this object, or  -1 if the character does not occur.

 indexOf

  public int indexOf(int ch,
                     int fromIndex)

 Returns the index within this string of the first occurrence of the  specified character, starting the search at the specified index.

Parameters:

 ch - a character.

 fromIndex - the index to start the search from.

Returns:

 the index of the first occurrence of the character in the  character sequence represented by this object that is greater  than or equal to fromIndex, or -1  if the character does not occur.

 lastIndexOf

  public int lastIndexOf(int ch)

 Returns the index within this string of the last occurrence of the  specified character.  The String is searched backwards starting at the last character.

Parameters:

 ch - a character.

Returns:

 the index of the last occurrence of the character in the  character sequence represented by this object, or  -1 if the character does not occur.

 lastIndexOf

  public int lastIndexOf(int ch,
                         int fromIndex)

 Returns the index within this string of the last occurrence of the  specified character, searching backward starting at the specified index.

Parameters:

 ch - a character.

 fromIndex - the index to start the search from.

Returns:

 the index of the last occurrence of the character in the  character sequence represented by this object that is less  than or equal to fromIndex , or -1  if the character does not occur before that point.

 indexOf

  public int indexOf(String str)

 Returns the index within this string of the first occurrence of the  specified substring.

Parameters:

 str - any string.

Returns:

 if the string argument occurs as a substring within this  object, then the index of the first character of the first  such substring is returned; if it does not occur as a  substring, -1 is returned.

 indexOf

  public int indexOf(String str,
                     int fromIndex)

 Returns the index within this string of the first occurrence of the  specified substring, starting at the specified index.

Parameters:

 str - the substring to search for.

 fromIndex - the index to start the search from.

Returns:

 If the string argument occurs as a substring within this  object at a starting index no smaller than  fromIndex , then the index of the first character  of the first such substring is returned. If it does not occur  as a substring starting at fromIndex or beyond,  -1 is returned.

 lastIndexOf

  public int lastIndexOf(String str)

 Returns the index within this string of the rightmost occurrence  of the specified substring. The rightmost empty string "" is  considered to occur at the index value this.length().

Parameters:

 str - the substring to search for.

Returns:

 if the string argument occurs one or more times as a substring  within this object, then the index of the first character of  the last such substring is returned. If it does not occur as  a substring, -1  is returned.

 lastIndexOf

  public int lastIndexOf(String str,
                         int fromIndex)

 Returns the index within this string of the last occurrence of  the specified substring.  The returned index indicates the start of the substring, and it  must be equal to or less than fromIndex.

Parameters:

 str - the substring to search for.

 fromIndex - the index to start the search from.

Returns:

 If the string argument occurs one or more times as a substring  within this object at a starting index no greater than  fromIndex , then the index of the first character of  the last such substring is returned. If it does not occur as a  substring starting at fromIndex or earlier,  -1 is returned.

 substring

  public String substring(int beginIndex)

 Returns a new string that is a substring of this string. The  substring begins at the specified index and extends to the end of  this string.

Parameters:

 beginIndex - the beginning index, inclusive.

Returns:

 the specified substring.

Throws: StringIndexOutOfBoundsException

 if the  beginIndex is out of range.

 substring

  public String substring(int beginIndex,
                          int endIndex)

 Returns a new string that is a substring of this string. The  substring begins at the specified beginIndex and  extends to the character at index endIndex - 1.

Parameters:

 beginIndex - the beginning index, inclusive.

 endIndex - the ending index, exclusive.

Returns:

 the specified substring.

Throws: StringIndexOutOfBoundsException

 if the  beginIndex or the endIndex is  out of range.

 concat

  public String concat(String str)

 Concatenates the specified string to the end of this string.

 If the length of the argument string is 0, then this  object is returned.

Parameters:

 str - the String that is concatenated to the end  of this String.

Returns:

 a string that represents the concatenation of this object's  characters followed by the string argument's characters.

 replace

  public String replace(char oldChar,
                        char newChar)

 Returns a new string resulting from replacing all occurrences of  oldChar in this string with newChar.

 If the character oldChar does not occur in the  character sequence represented by this object, then this string is  returned.

Parameters:

 oldChar - the old character.

 newChar - the new character.

Returns:

 a string derived from this string by replacing every  occurrence of oldChar with newChar.

 toLowerCase

  public String toLowerCase(Locale locale)

 Converts all of the characters in this String to lower case using  the rules of the given locale.

Parameters:

 locale - use the case transformation rules for this locale

Returns:

 the String, converted to lowercase.

See Also:

toLowerCase, toUpperCase

 toLowerCase

  public String toLowerCase()

 Converts this string to lowercase.

 If no character in the string has a different lowercase version,  based on calling the toLowerCase method defined by  Character, then the original string is returned.

 Otherwise, a new string is allocated, whose length is identical  to this string, and such that each character that has a different  lowercase version is mapped to this lowercase equivalent.

Returns:

 the string, converted to lowercase.

See Also:

toLowerCase, toUpperCase

 toUpperCase

  public String toUpperCase(Locale locale)

 Converts all of the characters in this String to upper case using  the rules of the given locale.

Parameters:

 locale - use the case transformation rules for this locale

Returns:

 the String, converted to uppercase.

See Also:

toUpperCase, toLowerCase

 toUpperCase

  public String toUpperCase()

 Converts this string to uppercase.

 If no character in this string has a different uppercase version,  based on calling the toUpperCase method defined by  Character , then the original string is returned.

 Otherwise, a new string is allocated, whose length is identical  to this string, and such that each character that has a different  uppercase version is mapped to this uppercase equivalent.

Returns:

 the string, converted to uppercase.

See Also:

toUpperCase, toLowerCase

 trim

  public String trim()

 Removes white space from both ends of this string.

 All characters that have codes less than or equal to  '\u0020'  (the space character) are considered to be  white space.

Returns:

 this string, with white space removed from the front and end.

 toString

  public String toString()

 This object (which is already a string!) is itself returned.

Returns:

 the string itself.

Overrides:

toString in class Object

 toCharArray

  public char[] toCharArray()

 Converts this string to a new character array.

Returns:

 a newly allocated character array whose length is the length  of this string and whose contents are initialized to contain  the character sequence represented by this string.

 valueOf

  public static String valueOf(Object obj)

 Returns the string representation of the Object argument.

Parameters:

 obj - an Object.

Returns:

 if the argument is null, then a string equal to  "null" ; otherwise, the value of  obj.toString() is returned.

See Also:

toString

 valueOf

  public static String valueOf(char data[])

 Returns the string representation of the char array  argument.

Parameters:

 data - a char array.

Returns:

 a newly allocated string representing the same sequence of  characters contained in the character array argument.

 valueOf

  public static String valueOf(char data[],
                               int offset,
                               int count)

 Returns the string representation of a specific subarray of the  char array argument.

 The offset argument is the index of the first  character of the subarray. The count argument  specifies the length of the subarray.

Parameters:

 data - the character array.

 offset - the initial offset into the value of the  String.

 count - the length of the value of the String.

Returns:

 a newly allocated string representing the sequence of  characters contained in the subarray of the character array  argument.

 copyValueOf

  public static String copyValueOf(char data[],
                                   int offset,
                                   int count)

 Returns a String that is equivalent to the specified character array.  It creates a new array and copies the characters into it.

Parameters:

 data - the character array.

 offset - initial offset of the subarray.

 count - length of the subarray.

Returns:

 a String that contains the characters of the  specified subarray of the character array.

 copyValueOf

  public static String copyValueOf(char data[])

 Returns a String that is equivalent to the specified character array.  It creates a new array and copies the characters into it.

Parameters:

 data - the character array.

Returns:

 a String that contains the characters of the  character array.

 valueOf

  public static String valueOf(boolean b)

 Returns the string representation of the boolean argument.

Parameters:

 b - a boolean.

Returns:

 if the argument is true, a string equal to  "true"  is returned; otherwise, a string equal to  "false" is returned.

 valueOf

  public static String valueOf(char c)

 Returns the string representation of the char * argument.

Parameters:

 c - a char.

Returns:

 a newly allocated string of length 1 containing  as its single character the argument c.

 valueOf

  public static String valueOf(int i)

 Returns the string representation of the int argument.

 The representation is exactly the one returned by the  Integer.toString  method of one argument.

Parameters:

 i - an int.

Returns:

 a newly allocated string containing a string representation of  the int argument.

See Also:

toString

 valueOf

  public static String valueOf(long l)

 Returns the string representation of the long argument.

 The representation is exactly the one returned by the  Long.toString  method of one argument.

Parameters:

 l - a long.

Returns:

 a newly allocated string containing a string representation of  the long argument.

See Also:

toString

 valueOf

  public static String valueOf(float f)

 Returns the string representation of the float argument.

 The representation is exactly the one returned by the  Float.toString  method of one argument.

Parameters:

 f - a float.

Returns:

 a newly allocated string containing a string representation of  the float argument.

See Also:

toString

 valueOf

  public static String valueOf(double d)

 Returns the string representation of the double argument.

 The representation is exactly the one returned by the  Double.toString  method of one argument.

Parameters:

 d - a double.

Returns:

 a newly allocated string containing a string representation of  the double argument.

See Also:

toString

 intern

  public String intern()

 Returns a canonical representation for the string object.

 If s and t are strings such that  s.equals(t) , it is guaranteed that
s.intern() == t.intern().

Returns:

 a string that has the same contents as this string, but is  guaranteed to be from a pool of unique strings.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.StringBuffer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.StringBuffer

java.lang.Object
   |
   +----java.lang.StringBuffer

______________________________________________________________________________

 public final class StringBuffer

 extends Object

 implements Serializable

A string buffer implements a mutable sequence of characters.

 String buffers are safe for use by multiple threads. The methods  are synchronized where necessary so that all the operations on any  particular instance behave as if they occur in some serial order.

 String buffers are used by the compiler to implement the binary  string concatenation operator +. For example, the code:

     x = "a" + 4 + "c"

 is compiled to the equivalent of:

     x = new StringBuffer().append("a").append(4).append("c")
                           .toString()

 The principal operations on a StringBuffer are the  append and insert methods, which are  overloaded so as to accept data of any type. Each effectively  converts a given datum to a string and then appends or inserts the  characters of that string to the string buffer. The  append  method always adds these characters at the end  of the buffer; the insert  method adds the characters at  a specified point.

 For example, if z refers to a string buffer object  whose current contents are " start", then  the method call z.append("le") would cause the string  buffer to contain "startle", whereas  z.insert(4, "le")  would alter the string buffer to  contain "starlet".

 Every string buffer has a capacity. As long as the length of the  character sequence contained in the string buffer does not exceed  the capacity, it is not necessary to allocate a new internal  buffer array. If the internal buffer overflows, it is  automatically made larger.

See Also:

ByteArrayOutputStream, String

______________________________________________________________________________

 	StringBuffer()

 Constructs a string buffer with no characters in it and an  initial capacity of 16 characters.

 	StringBuffer(int)

 Constructs a string buffer with no characters in it and an  initial capacity specified by the length argument.

 	StringBuffer(String)

 Constructs a string buffer so that it represents the same  sequence of characters as the string argument.

 	append(boolean)

 Appends the string representation of the boolean  argument to the string buffer.

 	append(char)

 Appends the string representation of the char  argument to this string buffer.

 	append(char[])

 Appends the string representation of the char array  argument to this string buffer.

 	append(char[], int, int)

 Appends the string representation of a subarray of the  char  array argument to this string buffer.

 	append(double)

 Appends the string representation of the double  argument to this string buffer.

 	append(float)

 Appends the string representation of the float  argument to this string buffer.

 	append(int)

 Appends the string representation of the int  argument to this string buffer.

 	append(long)

 Appends the string representation of the long  argument to this string buffer.

 	append(Object)

 Appends the string representation of the Object  argument to this string buffer.

 	append(String)

 Appends the string to this string buffer.

 	capacity()

 Returns the current capacity of the String buffer.

 	charAt(int)

 Returns the character at a specific index in this string buffer.

 	ensureCapacity(int)

 Ensures that the capacity of the buffer is at least equal to the  specified minimum.

 	getChars(int, int, char[], int)

 Characters are copied from this string buffer into the  destination character array dst .

 	insert(int, boolean)

 Inserts the string representation of the boolean  argument into this string buffer.

 	insert(int, char)

 Inserts the string representation of the char  argument into this string buffer.

 	insert(int, char[])

 Inserts the string representation of the char array  argument into this string buffer.

 	insert(int, double)

 Inserts the string representation of the double  argument into this string buffer.

 	insert(int, float)

 Inserts the string representation of the float  argument into this string buffer.

 	insert(int, int)

 Inserts the string representation of the second int  argument into this string buffer.

 	insert(int, long)

 Inserts the string representation of the long  argument into this string buffer.

 	insert(int, Object)

 Inserts the string representation of the Object  argument into this string buffer.

 	insert(int, String)

 Inserts the string into this string buffer.

 	length()

 Returns the length (character count) of this string buffer.

 	reverse()

 The character sequence contained in this string buffer is  replaced by the reverse of the sequence.

 	setCharAt(int, char)

 The character at the specified index of this string buffer is set  to ch.

 	setLength(int)

 Sets the length of this String buffer.

 	toString()

 Converts to a string representing the data in this string buffer.

 StringBuffer

  public StringBuffer()

 Constructs a string buffer with no characters in it and an  initial capacity of 16 characters.

 StringBuffer

  public StringBuffer(int length)

 Constructs a string buffer with no characters in it and an  initial capacity specified by the length argument.

Parameters:

 length - the initial capacity.

Throws: NegativeArraySizeException

 if the length  argument is less than 0.

 StringBuffer

  public StringBuffer(String str)

 Constructs a string buffer so that it represents the same  sequence of characters as the string argument. The initial  capacity of the string buffer is 16 plus the length  of the string argument.

Parameters:

 str - the initial contents of the buffer.

 length

  public int length()

 Returns the length (character count) of this string buffer.

Returns:

 the number of characters in this string buffer.

 capacity

  public int capacity()

 Returns the current capacity of the String buffer. The capacity  is the amount of storage available for newly inserted  characters; beyond which an allocation will occur.

Returns:

 the current capacity of this string buffer.

 ensureCapacity

  public synchronized void ensureCapacity(int minimumCapacity)

 Ensures that the capacity of the buffer is at least equal to the  specified minimum.  If the current capacity of this string buffer is less than the  argument, then a new internal buffer is allocated with greater  capacity. The new capacity is the larger of:

• The minimumCapacity argument.

• Twice the old capacity, plus 2.

 If the minimumCapacity argument is nonpositive, this  method takes no action and simply returns.

Parameters:

 minimumCapacity - the minimum desired capacity.

 setLength

  public synchronized void setLength(int newLength)

 Sets the length of this String buffer.  If the newLength  argument is less than the current  length of the string buffer, the string buffer is truncated to  contain exactly the number of characters given by the  newLength argument.

 If the newLength argument is greater than or equal  to the current length, sufficient null characters  ('\u0000' ) are appended to the string buffer so that  length becomes the newLength argument.

 The newLength argument must be greater than or equal  to 0.

Parameters:

 newLength - the new length of the buffer.

Throws: StringIndexOutOfBoundsException

 if the  newLength argument is invalid.

See Also:

length

 charAt

  public synchronized char charAt(int index)

 Returns the character at a specific index in this string buffer.

 The first character of a string buffer is at index  0, the next at index 1 , and so on, for  array indexing.

 The index argument must be greater than or equal to  0 , and less than the length of this string buffer.

Parameters:

 index - the index of the desired character.

Returns:

 the character at the specified index of this string buffer.

Throws: StringIndexOutOfBoundsException

 if the index is invalid.

See Also:

length

 getChars

  public synchronized void getChars(int srcBegin,
                                    int srcEnd,
                                    char dst[],
                                    int dstBegin)

 Characters are copied from this string buffer into the  destination character array dst. The first character to  be copied is at index srcBegin; the last character to  be copied is at index srcEnd-1.  The total number of  characters to be copied is srcEnd-srcBegin. The  characters are copied into the subarray of dst starting  at index dstBegin  and ending at index:

     dstbegin + (srcEnd-srcBegin) - 1

Parameters:

 srcBegin - start copying at this offset in the string buffer.

 srcEnd - stop copying at this offset in the string buffer.

 dst - the array to copy the data into.

 dstBegin - offset into dst.

Throws: StringIndexOutOfBoundsException

 if there is an invalid  index into the buffer.

 setCharAt

  public synchronized void setCharAt(int index,
                                     char ch)

 The character at the specified index of this string buffer is set  to ch.

 The offset argument must be greater than or equal to  0 , and less than the length of this string buffer.

Parameters:

 index - the index of the character to modify.

 ch - the new character.

Throws: StringIndexOutOfBoundsException

 if the index is invalid.

See Also:

length

 append

  public synchronized StringBuffer append(Object obj)

 Appends the string representation of the Object  argument to this string buffer.

 The argument is converted to a string as if by the method  String.valueOf , and the characters of that  string are then appended to this string buffer.

Parameters:

 obj - an Object.

Returns:

 this string buffer.

See Also:

valueOf, append

 append

  public synchronized StringBuffer append(String str)

 Appends the string to this string buffer.

 The characters of the String argument are appended, in  order, to the contents of this string buffer, increasing the  length of this string buffer by the length of the argument.

Parameters:

 str - a string.

Returns:

 this string buffer.

 append

  public synchronized StringBuffer append(char str[])

 Appends the string representation of the char array  argument to this string buffer.

 The characters of the array argument are appended, in order, to  the contents of this string buffer. The length of this string  buffer increases by the length of the argument.

Parameters:

 str - the characters to be appended.

Returns:

 this string buffer.

 append

  public synchronized StringBuffer append(char str[],
                                          int offset,
                                          int len)

 Appends the string representation of a subarray of the  char  array argument to this string buffer.

 Characters of the character array str, starting at  index offset , are appended, in order, to the contents  of this string buffer. The length of this string buffer increases  by the value of len .

Parameters:

 str - the characters to be appended.

 offset - the index of the first character to append.

 len - the number of characters to append.

Returns:

 this string buffer.

 append

  public StringBuffer append(boolean b)

 Appends the string representation of the boolean  argument to the string buffer.

 The argument is converted to a string as if by the method  String.valueOf , and the characters of that  string are then appended to this string buffer.

Parameters:

 b - a boolean.

Returns:

 this string buffer.

See Also:

valueOf, append

 append

  public synchronized StringBuffer append(char c)

 Appends the string representation of the char  argument to this string buffer.

 The argument is appended to the contents of this string buffer.  The length of this string buffer increases by 1.

Parameters:

 ch - a char.

Returns:

 this string buffer.

 append

  public StringBuffer append(int i)

 Appends the string representation of the int  argument to this string buffer.

 The argument is converted to a string as if by the method  String.valueOf , and the characters of that  string are then appended to this string buffer.

Parameters:

 i - an int.

Returns:

 this string buffer.

See Also:

valueOf, append

 append

  public StringBuffer append(long l)

 Appends the string representation of the long  argument to this string buffer.

 The argument is converted to a string as if by the method  String.valueOf , and the characters of that  string are then appended to this string buffer.

Parameters:

 l - a long.

Returns:

 this string buffer.

See Also:

valueOf, append

 append

  public StringBuffer append(float f)

 Appends the string representation of the float  argument to this string buffer.

 The argument is converted to a string as if by the method  String.valueOf , and the characters of that  string are then appended to this string buffer.

Parameters:

 f - a float.

Returns:

 this string buffer.

See Also:

valueOf, append

 append

  public StringBuffer append(double d)

 Appends the string representation of the double  argument to this string buffer.

 The argument is converted to a string as if by the method  String.valueOf , and the characters of that  string are then appended to this string buffer.

Parameters:

 d - a double.

Returns:

 this string buffer.

See Also:

valueOf, append

 insert

  public synchronized StringBuffer insert(int offset,
                                          Object obj)

 Inserts the string representation of the Object  argument into this string buffer.

 The second argument is converted to a string as if by the method  String.valueOf , and the characters of that  string are then inserted into this string buffer at the indicated  offset.

 The offset argument must be greater than or equal to  0 , and less than or equal to the length of this  string buffer.

Parameters:

 offset - the offset.

 b - an Object.

Returns:

 this string buffer.

Throws: StringIndexOutOfBoundsException

 if the offset is invalid.

See Also:

valueOf, insert, length

 insert

  public synchronized StringBuffer insert(int offset,
                                          String str)

 Inserts the string into this string buffer.

 The characters of the String argument are inserted, in  order, into this string buffer at the indicated offset. The length  of this string buffer is increased by the length of the argument.

 The offset argument must be greater than or equal to  0 , and less than or equal to the length of this  string buffer.

Parameters:

 offset - the offset.

 str - a string.

Returns:

 this string buffer.

Throws: StringIndexOutOfBoundsException

 if the offset is invalid.

See Also:

length

 insert

  public synchronized StringBuffer insert(int offset,
                                          char str[])

 Inserts the string representation of the char array  argument into this string buffer.

 The characters of the array argument are inserted into the  contents of this string buffer at the position indicated by  offset . The length of this string buffer increases by  the length of the argument.

Parameters:

 offset - the offset.

 ch - a character array.

Returns:

 this string buffer.

Throws: StringIndexOutOfBoundsException

 if the offset is invalid.

 insert

  public StringBuffer insert(int offset,
                             boolean b)

 Inserts the string representation of the boolean  argument into this string buffer.

 The second argument is converted to a string as if by the method  String.valueOf , and the characters of that  string are then inserted into this string buffer at the indicated  offset.

 The offset argument must be greater than or equal to  0 , and less than or equal to the length of this  string buffer.

Parameters:

 offset - the offset.

 b - a boolean.

Returns:

 this string buffer.

Throws: StringIndexOutOfBoundsException

 if the offset is invalid.

See Also:

valueOf, insert, length

 insert

  public synchronized StringBuffer insert(int offset,
                                          char c)

 Inserts the string representation of the char  argument into this string buffer.

 The second argument is inserted into the contents of this string  buffer at the position indicated by offset. The length  of this string buffer increases by one.

 The offset argument must be greater than or equal to  0 , and less than or equal to the length of this  string buffer.

Parameters:

 offset - the offset.

 ch - a char.

Returns:

 this string buffer.

Throws: StringIndexOutOfBoundsException

 if the offset is invalid.

See Also:

length

 insert

  public StringBuffer insert(int offset,
                             int i)

 Inserts the string representation of the second int  argument into this string buffer.

 The second argument is converted to a string as if by the method  String.valueOf , and the characters of that  string are then inserted into this string buffer at the indicated  offset.

 The offset argument must be greater than or equal to  0 , and less than or equal to the length of this  string buffer.

Parameters:

 offset - the offset.

 b - an int.

Returns:

 this string buffer.

Throws: StringIndexOutOfBoundsException

 if the offset is invalid.

See Also:

valueOf, insert, length

 insert

  public StringBuffer insert(int offset,
                             long l)

 Inserts the string representation of the long  argument into this string buffer.

 The second argument is converted to a string as if by the method  String.valueOf , and the characters of that  string are then inserted into this string buffer at the indicated  offset.

 The offset argument must be greater than or equal to  0 , and less than or equal to the length of this  string buffer.

Parameters:

 offset - the offset.

 b - a long.

Returns:

 this string buffer.

Throws: StringIndexOutOfBoundsException

 if the offset is invalid.

See Also:

valueOf, insert, length

 insert

  public StringBuffer insert(int offset,
                             float f)

 Inserts the string representation of the float  argument into this string buffer.

 The second argument is converted to a string as if by the method  String.valueOf , and the characters of that  string are then inserted into this string buffer at the indicated  offset.

 The offset argument must be greater than or equal to  0 , and less than or equal to the length of this  string buffer.

Parameters:

 offset - the offset.

 b - a float.

Returns:

 this string buffer.

Throws: StringIndexOutOfBoundsException

 if the offset is invalid.

See Also:

valueOf, insert, length

 insert

  public StringBuffer insert(int offset,
                             double d)

 Inserts the string representation of the double  argument into this string buffer.

 The second argument is converted to a string as if by the method  String.valueOf , and the characters of that  string are then inserted into this string buffer at the indicated  offset.

 The offset argument must be greater than or equal to  0 , and less than or equal to the length of this  string buffer.

Parameters:

 offset - the offset.

 b - a double.

Returns:

 this string buffer.

Throws: StringIndexOutOfBoundsException

 if the offset is invalid.

See Also:

valueOf, insert, length

 reverse

  public synchronized StringBuffer reverse()

 The character sequence contained in this string buffer is  replaced by the reverse of the sequence.

Returns:

 this string buffer.

 toString

  public String toString()

 Converts to a string representing the data in this string buffer.  A new String object is allocated and initialized to  contain the character sequence currently represented by this  string buffer. This String is then returned. Subsequent  changes to the string buffer do not affect the contents of the  String.

Returns:

 a string representation of the string buffer.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.StringIndexOutOfBoundsException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.StringIndexOutOfBoundsException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.RuntimeException
                           |
                           +----java.lang.IndexOutOfBoundsException
                                   |
                                   +----java.lang.StringIndexOutOfBoundsException

______________________________________________________________________________

 public class StringIndexOutOfBoundsException

 extends IndexOutOfBoundsException

Thrown by the charAt method in class  String and by other String   methods to indicate that an index is either negative or greater  than or equal to the size of the string.

See Also:

charAt

______________________________________________________________________________

 	StringIndexOutOfBoundsException()

 Constructs a StringIndexOutOfBoundsException with no  detail message.

 	StringIndexOutOfBoundsException(int)

 Constructs a new StringIndexOutOfBoundsException  class with an argument indicating the illegal index.

 	StringIndexOutOfBoundsException(String)

 Constructs a StringIndexOutOfBoundsException with  the specified detail message.

 StringIndexOutOfBoundsException

  public StringIndexOutOfBoundsException()

 Constructs a StringIndexOutOfBoundsException with no  detail message.

 StringIndexOutOfBoundsException

  public StringIndexOutOfBoundsException(String s)

 Constructs a StringIndexOutOfBoundsException with  the specified detail message.

Parameters:

 s - the detail message.

 StringIndexOutOfBoundsException

  public StringIndexOutOfBoundsException(int index)

 Constructs a new StringIndexOutOfBoundsException  class with an argument indicating the illegal index.

Parameters:

 index - the illegal index.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.System

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.System

java.lang.Object
   |
   +----java.lang.System

______________________________________________________________________________

 public final class System

 extends Object

The System class contains several useful class fields  and methods. It cannot be instantiated.

 Among the facilities provided by the System class  are standard input, standard output, and error output streams;  access to externally defined "properties"; a means of  loading files and libraries; and a utility method for quickly  copying a portion of an array.

______________________________________________________________________________

 	err

 The "standard" error output stream.

 	in

 The "standard" input stream.

 	out

 The "standard" output stream.

 	arraycopy(Object, int, Object, int, int)

 Copies an array from the specified source array, beginning at the  specified position, to the specified position of the destination array.

 	currentTimeMillis()

 Returns the current time in milliseconds.

 	exit(int)

 Terminates the currently running Java Virtual Machine.

 	gc()

 Runs the garbage collector.

 	getenv(String)

 Gets an environment variable. Deprecated.

 	getProperties()

 Determines the current system properties.

 	getProperty(String)

 Gets the system property indicated by the specified key.

 	getProperty(String, String)

 Gets the system property indicated by the specified key.

 	getSecurityManager()

 Gets the system security interface.

 	identityHashCode(Object)

 Returns the same hashcode for the given object as  would be returned by the default method hashCode(),  whether or not the given object's class overrides  hashCode().

 	load(String)

 Loads the specified filename as a dynamic library.

 	loadLibrary(String)

 Loads the system library specified by the libname  argument.

 	runFinalization()

 Runs the finalization methods of any objects pending finalization.

 	runFinalizersOnExit(boolean)

 Enable or disable finalization on exit; doing so specifies that the  finalizers of all objects that have finalizers that have not yet been  automatically invoked are to be run before the Java runtime exits.

 	setErr(PrintStream)

 Reassigns the "standard" error output stream.

 	setIn(InputStream)

 Reassigns the "standard" input stream.

 	setOut(PrintStream)

 Reassigns the "standard" output stream.

 	setProperties(Properties)

 Sets the system properties to the Properties  argument.

 	setSecurityManager(SecurityManager)

 Sets the System security.

 in

  public final static InputStream in

 The "standard" input stream. This stream is already  open and ready to supply input data. Typically this stream  corresponds to keyboard input or another input source specified by  the host environment or user.

 out

  public final static PrintStream out

 The "standard" output stream. This stream is already  open and ready to accept output data. Typically this stream  corresponds to display output or another output destination  specified by the host environment or user.

 For simple stand-alone Java applications, a typical way to write  a line of output data is:

System.out.println(data)

 See the println methods in class PrintStream.

See Also:

println, println, println, println, println , println, println, println, println, println

 err

  public final static PrintStream err

 The "standard" error output stream. This stream is already  open and ready to accept output data.

 Typically this stream corresponds to display output or another  output destination specified by the host environment or user. By  convention, this output stream is used to display error messages  or other information that should come to the immediate attention  of a user even if the principal output stream, the value of the  variable out , has been redirected to a file or other  destination that is typically not continuously monitored.

 setIn

  public static void setIn(InputStream in)

 Reassigns the "standard" input stream.

 setOut

  public static void setOut(PrintStream out)

 Reassigns the "standard" output stream.

 setErr

  public static void setErr(PrintStream err)

 Reassigns the "standard" error output stream.

 setSecurityManager

  public static void setSecurityManager(SecurityManager s)

 Sets the System security.  If a security manager has already been established for the  currently running Java application, a SecurityException  is thrown. Otherwise, the argument is established as the current  security manager. If the argument is null and no  security manager has been established, then no action is taken and  the method simply returns.

Parameters:

 s - the security manager.

Throws: SecurityException

 if the security manager has already  been set.

 getSecurityManager

  public static SecurityManager getSecurityManager()

 Gets the system security interface.

Returns:

 if a security manager has already been established for the  current application, then that security manager is returned;  otherwise, null  is returned.

 currentTimeMillis

  public static long currentTimeMillis()

 Returns the current time in milliseconds.

 See the description of the class Date for a discussion  of slight discrepancies that may arise between "computer  time" and coordinated universal time (UTC).

Returns:

 the difference, measured in milliseconds, between the current  time and midnight, January 1, 1970 UTC.

See Also:

Date

 arraycopy

  public static void arraycopy(Object src,
                               int src_position,
                               Object dst,
                               int dst_position,
                               int length)

 Copies an array from the specified source array, beginning at the  specified position, to the specified position of the destination array.  A subsequence of array components are copied from the source  array referenced by src  to the destination array  referenced by dst. The number of components copied is  equal to the length argument. The components at  positions srcOffset  through  srcOffset+length-1 in the source array are copied into  positions dstOffset through  dstOffset+length-1, respectively, of the destination  array.

 If the src and dst arguments refer to the  same array object, then the copying is performed as if the  components at positions srcOffset through  srcOffset+length-1 were first copied to a temporary  array with length components and then the contents of  the temporary array were copied into positions  dstOffset through dstOffset+length-1 of the  argument array.

 If any of the following is true, an  ArrayStoreException  is thrown and the destination is  not modified:

• The src  argument refers to an object that is not an  array.

• The dst argument refers to an object that is not an  array.

• The src argument and dst argument refer to  arrays whose component types are different primitive types.

• The src argument refers to an array with a primitive  component type and the dst argument refers to an array  with a reference component type.

• The src argument refers to an array with a reference  component type and the dst argument refers to an array  with a primitive component type.

 Otherwise, if any of the following is true, an  ArrayIndexOutOfBoundsException is  thrown and the destination is not modified:

• The srcOffset argument is negative.

• The dstOffset argument is negative.

• The length argument is negative.

• srcOffset+length is greater than  src.length , the length of the source array.

• dstOffset+length is greater than  dst.length , the length of the destination array.

 Otherwise, if any actual component of the source array from  position srcOffset  through  srcOffset+length-1 cannot be converted to the component  type of the destination array by assignment conversion, an  ArrayStoreException  is thrown. In this case, let  k  be the smallest nonnegative integer less than  length such that src[srcOffset+ k]  cannot be converted to the component type of the destination  array; when the exception is thrown, source array components from  positions srcOffset  through  srcOffset+k-1  will already have been copied to destination array positions  dstOffset through  dstOffset+k-1 and no other  positions of the destination array will have been modified.

Parameters:

 src: - the source array.

 srcpos - start position in the source array.

 dest - the destination array.

 destpos - start position in the destination data.

 length - the number of array elements to be copied.

Throws: ArrayIndexOutOfBoundsException

 if copying would cause  access of data outside array bounds.

Throws: ArrayStoreException

 if an element in the src  array could not be stored into the dest array  because of a type mismatch.

 identityHashCode

  public static int identityHashCode(Object x)

 Returns the same hashcode for the given object as  would be returned by the default method hashCode(),  whether or not the given object's class overrides  hashCode().  The hashcode for the null reference is zero.

 getProperties

  public static Properties getProperties()

 Determines the current system properties.

 If there is a security manager, its  checkPropertiesAccess method is called with no  arguments. This may result in a security exception.

 The current set of system properties is returned as a  Properties  object. If there is no current set of  system properties, a set of system properties is first created and  initialized.

 This set of system properties always includes values for the  following keys:

Key
Description of Associated Value
java.version
Java version number
java.vendor
Java vendor-specific string
java.vendor.url
Java vendor URL
java.home
Java installation directory
java.class.version
Java class format version number
java.class.path
Java class path
os.name
Operating system name
os.arch
Operating system architecture
os.version
Operating system version
file.separator
File separator ("/" on UNIX)
path.separator
Path separator (":" on UNIX)
line.separator
Line separator ("\n" on UNIX)
user.name
User's account name
user.home
User's home directory
user.dir
User's current working directory
Throws: SecurityException

 if the current thread cannot access the  system properties.

See Also:

SecurityException, checkPropertiesAccess, Properties

 setProperties

  public static void setProperties(Properties props)

 Sets the system properties to the Properties  argument.

 First, if there is a security manager, its  checkPropertiesAccess  method is called with no  arguments. This may result in a security exception.

 The argument becomes the current set of system properties for use  by the getProperty  method. If the argument is  null, then the current set of system properties is  forgotten.

Parameters:

 props - the new system properties.

Throws: SecurityException

 if the current thread cannot set the  system properties.

See Also:

SecurityException, checkPropertiesAccess

 getProperty

  public static String getProperty(String key)

 Gets the system property indicated by the specified key.

 First, if there is a security manager, its  checkPropertyAccess  method is called with the key as  its argument. This may result in a system exception.

 If there is no current set of system properties, a set of system  properties is first created and initialized in the same manner as  for the getProperties method.

Parameters:

 key - the name of the system property.

Returns:

 the string value of the system property,  or null  if there is no property with that key.

Throws: SecurityException

 if the current thread cannot access the  system properties or the specified property.

See Also:

SecurityException, checkPropertyAccess, getProperties

 getProperty

  public static String getProperty(String key,
                                   String def)

 Gets the system property indicated by the specified key.

 First, if there is a security manager, its  checkPropertyAccess  method is called with the  key as its argument.

 If there is no current set of system properties, a set of system  properties is first created and initialized in the same manner as  for the getProperties method.

Parameters:

 key - the name of the system property.

 def - a default value.

Returns:

 the string value of the system property,  or the default value if there is no property with that key.

Throws: SecurityException

 if the current thread cannot access the  system properties or the specified property.

See Also:

checkPropertyAccess, getProperties

 getenv

  public static String getenv(String name)

 Note: getenv() is deprecated.

 Gets an environment variable. An environment variable is a  system dependent external variable that has a string value.

Parameters:

 the - name of the environment variable.

Returns:

 the value of the variable, or null if the variable is 	not defined.

 exit

  public static void exit(int status)

 Terminates the currently running Java Virtual Machine. The  argument serves as a status code; by convention, a nonzero status  code indicates abnormal termination.

 This method calls the exit method in class  Runtime . This method never returns normally.

Parameters:

 status - exit status.

Throws: SecurityException

 if the current thread cannot exit with  the specified status.

See Also:

exit

 gc

  public static void gc()

 Runs the garbage collector.

 Calling the gc method suggests that the Java Virtual  Machine expend effort toward recycling unused objects in order to  make the memory they currently occupy available for quick reuse.  When control returns from the method call, the Java Virtual  Machine has made a best effort to reclaim space from all unused  objects.

See Also:

gc

 runFinalization

  public static void runFinalization()

 Runs the finalization methods of any objects pending finalization.

 Calling this method suggests that the Java Virtual Machine expend  effort toward running the finalize methods of objects  that have been found to be discarded but whose finalize  methods have not yet been run. When control returns from the  method call, the Java Virtual Machine has made a best effort to  complete all outstanding finalizations.

See Also:

runFinalization

 runFinalizersOnExit

  public static void runFinalizersOnExit(boolean value)

 Enable or disable finalization on exit; doing so specifies that the  finalizers of all objects that have finalizers that have not yet been  automatically invoked are to be run before the Java runtime exits.  By default, finalization on exit is disabled.

See Also:

exit, gc

 load

  public static void load(String filename)

 Loads the specified filename as a dynamic library. The filename  argument must be a complete pathname.

 This method calls the load method in class  Runtime.

Parameters:

 filename - the file to load.

Throws: SecurityException

 if the current thread cannot load the  specified dynamic library.

Throws: UnsatisfiedLinkError

 if the file does not exist.

See Also:

load

 loadLibrary

  public static void loadLibrary(String libname)

 Loads the system library specified by the libname  argument. The manner in which a library name is mapped to the  actual system library is system dependent.

Parameters:

 libname - the name of the library.

Throws: SecurityException

 if the current thread cannot load the  specified dynamic library.

Throws: UnsatisfiedLinkError

 if the library does not exist.

See Also:

loadLibrary

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.Thread

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.Thread

java.lang.Object
   |
   +----java.lang.Thread

______________________________________________________________________________

 public class Thread

 extends Object

 implements Runnable

A thread is a thread of execution in a program. The Java  Virtual Machine allows an application to have multiple threads of  execution running concurrently.

 Every thread has a priority. Threads with higher priority are  executed in preference to threads with lower priority. Each thread  may or may not also be marked as a daemon. When code running in  some thread creates a new Thread object, the new  thread has its priority initially set equal to the priority of the  creating thread, and is a daemon thread if and only if the  creating thread is a daemon.

 When a Java Virtual Machine starts up, there is usually a single  non-daemon thread (which typically calls the method named  main  of some designated class). The Java Virtual  Machine continues to execute threads until either of the following  occurs:

• The exit method of class Runtime  has been  called and the security manager has permitted the exit operation  to take place.

• All threads that are not daemon threads have died, either by  returning from the call to the run method or by  performing the stop  method.

 There are two ways to create a new thread of execution. One is to  declare a class to be a subclass of Thread. This  subclass should override the run method of class  Thread. An instance of the subclass can then be  allocated and started. For example, a thread that computes primes  larger than a stated value could be written as follows:

______________________________________________________________________________

     class PrimeThread extends Thread {
         long minPrime;
         PrimeThread(long minPrime) {
             this.minPrime = minPrime;
         }
         public void run() {
             // compute primes larger than minPrime
              . . .
         }
     }

______________________________________________________________________________

 The following code would then create a thread and start it running:

     PrimeThread p = new PrimeThread(143);
     p.start();

 The other way to create a thread is to declare a class that  implements the Runnable  interface. That class then  implements the run method. An instance of the class can  then be allocated, passed as an argument when creating  Thread , and started. The same example in this other  style looks like the following:

______________________________________________________________________________

     class PrimeRun implements Runnable {
         long minPrime;
         PrimeRun(long minPrime) {
             this.minPrime = minPrime;
         }
         public void run() {
             // compute primes larger than minPrime
              . . .
         }
     }

______________________________________________________________________________

 The following code would then create a thread and start it running:

     PrimeRun p = new PrimeRun(143);
     new Thread(p).start();

 Every thread has a name for identification purposes. More than  one thread may have the same name. If a name is not specified when  a thread is created, a new name is generated for it.

See Also:

Runnable, exit, run, stop

______________________________________________________________________________

 	MAX_PRIORITY

 The maximum priority that a thread can have.

 	MIN_PRIORITY

 The minimum priority that a thread can have.

 	NORM_PRIORITY

 The default priority that is assigned to a thread.

 	Thread()

 Allocates a new Thread object.

 	Thread(Runnable)

 Allocates a new Thread object.

 	Thread(Runnable, String)

 Allocates a new Thread object.

 	Thread(String)

 Allocates a new Thread object.

 	Thread(ThreadGroup, Runnable)

 Allocates a new Thread object.

 	Thread(ThreadGroup, Runnable, String)

 Allocates a new Thread object so that it has  target  as its run object, has the specified  name  as its name, and belongs to the thread group  referred to by group.

 	Thread(ThreadGroup, String)

 Allocates a new Thread object.

 	activeCount()

 Returns the current number of active threads in this thread group.

 	checkAccess()

 Determines if the currently running thread has permission to  modify this thread.

 	countStackFrames()

 Counts the number of stack frames in this thread.

 	currentThread()

 Returns a reference to the currently executing thread object.

 	destroy()

 Destroys this thread, without any cleanup.

 	dumpStack()

 Prints a stack trace of the current thread.

 	enumerate(Thread[])

 Copies into the specified array every active thread in this  thread group and its subgroups.

 	getName()

 Returns this thread's name.

 	getPriority()

 Returns this thread's priority.

 	getThreadGroup()

 Returns this thread's thread group.

 	interrupt()

 Interrupts this thread.

 	interrupted()

 Tests is the current thread has been interrupted.

 	isAlive()

 Tests if this thread is alive.

 	isDaemon()

 Tests if this thread is a daemon thread.

 	isInterrupted()

 Tests if the current thread has been interrupted.

 	join()

 Waits for this thread to die.

 	join(long)

 Waits at most millis milliseconds for this thread to  die.

 	join(long, int)

 Waits at most millis milliseconds plus  nanos  nanoseconds for this thread to die.

 	resume()

 Resumes a suspended thread.

 	run()

 If this thread was constructed using a separate  Runnable run object, then that  Runnable object's run method is called;  otherwise, this method does nothing and returns.

 	setDaemon(boolean)

 Marks this thread as either a daemon thread or a user thread.

 	setName(String)

 Changes the name of this thread to be equal to the argument  name.

 	setPriority(int)

 Changes the priority of this thread.

 	sleep(long)

 Causes the currently executing thread to sleep (temporarily cease  execution) for the specified number of milliseconds.

 	sleep(long, int)

 Causes the currently executing thread to sleep (cease execution)  for the specified number of milliseconds plus the specified number  of nanoseconds.

 	start()

 Causes this thread to begin execution; the Java Virtual Machine  calls the run  method of this thread.

 	stop()

 Forces the thread to stop executing.

 	stop(Throwable)

 Forces the thread to stop executing.

 	suspend()

 Suspends this thread.

 	toString()

 Returns a string representation of this thread, including the  thread's name, priority, and thread group.

 	yield()

 Causes the currently executing thread object to temporarily pause  and allow other threads to execute.

 MIN_PRIORITY

  public final static int MIN_PRIORITY

 The minimum priority that a thread can have.

 NORM_PRIORITY

  public final static int NORM_PRIORITY

 The default priority that is assigned to a thread.

 MAX_PRIORITY

  public final static int MAX_PRIORITY

 The maximum priority that a thread can have.

 Thread

  public Thread()

 Allocates a new Thread object. This constructor has  the same effect as Thread(null, null,  gname), where gname is  a newly generated name. Automatically generated names are of the  form "Thread-"+n, where n is an integer.

 Threads created this way must have overridden their  run()  method to actually do anything. An example  illustrating this method being used follows:

     import java.lang.*;
     class plain01 implements Runnable {
         String name;
         plain01() {
             name = null;
         }
         plain01(String s) {
             name = s;
         }
         public void run() {
             if (name == null)
                 System.out.println("A new thread created");
             else
                 System.out.println("A new thread with name " + name +
                                    " created");
         }
     }
     class threadtest01 {
         public static void main(String args[] ) {
             int failed = 0 ;
             Thread t1 = new Thread();
             if (t1 != null)
                 System.out.println("new Thread() succeed");
             else {
                 System.out.println("new Thread() failed");
                 failed++;
             }
         }
     }

See Also:

Thread

 Thread

  public Thread(Runnable target)

 Allocates a new Thread object. This constructor has  the same effect as Thread(null, target,  gname), where gname is  a newly generated name. Automatically generated names are of the  form "Thread-"+n, where n is an integer.

Parameters:

 target - the object whose run method is called.

See Also:

Thread

 Thread

  public Thread(ThreadGroup group,
                Runnable target)

 Allocates a new Thread object. This constructor has  the same effect as Thread(group, target,  gname), where gname is  a newly generated name. Automatically generated names are of the  form "Thread-"+n, where n is an integer.

Parameters:

 group - the thread group.

 target - the object whose run method is called.

Throws: SecurityException

 if the current thread cannot create a  thread in the specified thread group.

See Also:

Thread

 Thread

  public Thread(String name)

 Allocates a new Thread object. This constructor has  the same effect as Thread(null, null, name).

Parameters:

 name - the name of the new thread.

See Also:

Thread

 Thread

  public Thread(ThreadGroup group,
                String name)

 Allocates a new Thread object. This constructor has  the same effect as Thread(group, null, name)

Parameters:

 group - the thread group.

 name - the name of the new thread.

Throws: SecurityException

 if the current thread cannot create a  thread in the specified thread group.

See Also:

Thread

 Thread

  public Thread(Runnable target,
                String name)

 Allocates a new Thread object. This constructor has  the same effect as Thread(null, target, name).

Parameters:

 target - the object whose run method is called.

 name - the name of the new thread.

See Also:

Thread

 Thread

  public Thread(ThreadGroup group,
                Runnable target,
                String name)

 Allocates a new Thread object so that it has  target as its run object, has the specified  name  as its name, and belongs to the thread group  referred to by group.

 If group is not null, the  checkAccess  method of that thread group is called with  no arguments; this may result in throwing a  SecurityException; if group is  null , the new process belongs to the same group as  the thread that is creating the new thread.

 If the target argument is not null, the  run method of the target is called when  this thread is started. If the target argument is  null, this thread's run method is called  when this thread is started.

 The priority of the newly created thread is set equal to the  priority of the thread creating it, that is, the currently running  thread. The method setPriority may be used to  change the priority to a new value.

 The newly created thread is initially marked as being a daemon  thread if and only if the thread creating it is currently marked  as a daemon thread. The method setDaemon  may be used  to change whether or not a thread is a daemon.

Parameters:

 group - the thread group.

 target - the object whose run method is called.

 name - the name of the new thread.

Throws: SecurityException

 if the current thread cannot create a  thread in the specified thread group.

See Also:

run, run, setDaemon, setPriority, checkAccess

 currentThread

  public static Thread currentThread()

 Returns a reference to the currently executing thread object.

Returns:

 the currently executing thread.

 yield

  public static void yield()

 Causes the currently executing thread object to temporarily pause  and allow other threads to execute.

 sleep

  public static void sleep(long millis) throws InterruptedException

 Causes the currently executing thread to sleep (temporarily cease  execution) for the specified number of milliseconds. The thread  does not lose ownership of any monitors.

Parameters:

 millis - the length of time to sleep in milliseconds.

Throws: InterruptedException

 if another thread has interrupted  this thread.

See Also:

notify

 sleep

  public static void sleep(long millis,
                           int nanos) throws InterruptedException

 Causes the currently executing thread to sleep (cease execution)  for the specified number of milliseconds plus the specified number  of nanoseconds. The thread does not lose ownership of any monitors.

Parameters:

 millis - the length of time to sleep in milliseconds.

 nanos - 0-999999 additional nanoseconds to sleep.

Throws: IllegalArgumentException

 if the value of millis is negative  or the value of nanos is not in the range 0-999999.

Throws: InterruptedException

 if another thread has interrupted  this thread.

See Also:

notify

 start

  public synchronized void start()

 Causes this thread to begin execution; the Java Virtual Machine  calls the run method of this thread.

 The result is that two threads are running concurrently: the  current thread (which returns from the call to the  start  method) and the other thread (which executes its  run method).

Throws: IllegalThreadStateException

 if the thread was already  started.

See Also:

run, stop

 run

  public void run()

 If this thread was constructed using a separate  Runnable  run object, then that  Runnable object's run method is called;  otherwise, this method does nothing and returns.

 Subclasses of Thread should override this method.

See Also:

start, stop, Thread, run

 stop

  public final void stop()

 Forces the thread to stop executing.

 First, the checkAccess method of this thread is called  with no arguments. This may result in throwing a  SecurityException  (in the current thread).

 The thread represented by this thread is forced to stop whatever  it is doing abnormally and to throw a newly created  ThreadDeath  object as an exception.

 It is permitted to stop a thread that has not yet been started.  If the thread is eventually started, it immediately terminates.

 An application should not normally try to catch  ThreadDeath  unless it must do some extraordinary  cleanup operation (note that the throwing of  ThreadDeath causes finally clauses of  try  statements to be executed before the thread  officially dies). If a catch  clause catches a  ThreadDeath object, it is important to rethrow the  object so that the thread actually dies.

 The top-level error handler that reacts to otherwise uncaught  exceptions does not print out a message or otherwise notify the  application if the uncaught exception is an instance of  ThreadDeath.

Throws: SecurityException

 if the current thread cannot modify  this thread.

See Also:

checkAccess, run, start, ThreadDeath, uncaughtException

 stop

  public final synchronized void stop(Throwable o)

 Forces the thread to stop executing.

 First, the checkAccess method of this thread is called  with no arguments. This may result in throwing a  SecurityException  (in the current thread).

 If the argument obj is null, a  NullPointerException  is thrown (in the current thread).

 The thread represented by this thread is forced to complete  whatever it is doing abnormally and to throw the  Throwable object obj  as an exception. This  is an unusual action to take; normally, the stop method  that takes no arguments should be used.

 It is permitted to stop a thread that has not yet been started.  If the thread is eventually started, it immediately terminates.

Parameters:

 obj - the Throwable object to be thrown.

Throws: SecurityException

 if the current thread cannot modify  this thread.

See Also:

checkAccess, run, start, stop

 interrupt

  public void interrupt()

 Interrupts this thread.

 interrupted

  public static boolean interrupted()

 Tests is the current thread has been interrupted.  Note that interrupted is a static method, while  isInterrupted  is called on the current  Thread instance.

Returns:

true if the current thread has been interrupted;  false otherwise.

See Also:

isInterrupted

 isInterrupted

  public boolean isInterrupted()

 Tests if the current thread has been interrupted.  Note that isInterrupted  is called on the current Thread instance; by  contrast, interrupted is a static method.

Returns:

true if this thread has been interrupted;  false otherwise.

See Also:

interrupted

 destroy

  public void destroy()

 Destroys this thread, without any cleanup. Any monitors it has  locked remain locked. (This method is not implemented in  Java 1.0.2.)

 isAlive

  public final boolean isAlive()

 Tests if this thread is alive. A thread is alive if it has  been started and has not yet died.

Returns:

true if this thread is alive;  false otherwise.

 suspend

  public final void suspend()

 Suspends this thread.

 First, the checkAccess method of this thread is called  with no arguments. This may result in throwing a  SecurityException  (in the current thread).

 If the thread is alive, it is suspended and makes no further  progress unless and until it is resumed.

Throws: SecurityException

 if the current thread cannot modify  this thread.

See Also:

checkAccess, isAlive

 resume

  public final void resume()

 Resumes a suspended thread.

 First, the checkAccess method of this thread is called  with no arguments. This may result in throwing a  SecurityException (in the current thread).

 If the thread is alive but suspended, it is resumed and is  permitted to make progress in its execution.

Throws: SecurityException

 if the current thread cannot modify this  thread.

See Also:

checkAccess, isAlive

 setPriority

  public final void setPriority(int newPriority)

 Changes the priority of this thread.

 First the checkAccess method of this thread is called  with no arguments. This may result in throwing a  SecurityException.

 Otherwise, the priority of this thread is set to the smaller of  the specified newPriority and the maximum permitted  priority of the thread's thread group.

Throws: IllegalArgumentException

 If the priority is not in the  range MIN_PRIORITY to  MAX_PRIORITY.

Throws: SecurityException

 if the current thread cannot modify  this thread.

See Also:

checkAccess, getPriority, getThreadGroup, MAX_PRIORITY, MIN_PRIORITY, getMaxPriority

 getPriority

  public final int getPriority()

 Returns this thread's priority.

Returns:

 this thread's name.

See Also:

setPriority

 setName

  public final void setName(String name)

 Changes the name of this thread to be equal to the argument  name.

 First the checkAccess method of this thread is called  with no arguments. This may result in throwing a  SecurityException.

Parameters:

 name - the new name for this thread.

Throws: SecurityException

 if the current thread cannot modify this  thread.

See Also:

checkAccess, getName

 getName

  public final String getName()

 Returns this thread's name.

Returns:

 this thread's name.

See Also:

setName

 getThreadGroup

  public final ThreadGroup getThreadGroup()

 Returns this thread's thread group.

Returns:

 this thread's thread group.

 activeCount

  public static int activeCount()

 Returns the current number of active threads in this thread group.

Returns:

 the current number of threads in this thread's thread group.

 enumerate

  public static int enumerate(Thread tarray[])

 Copies into the specified array every active thread in this  thread group and its subgroups. This method simply calls the  enumerate  method of this thread's thread group with  the array argument.

Returns:

 the number of threads put into the array.

See Also:

enumerate

 countStackFrames

  public int countStackFrames()

 Counts the number of stack frames in this thread. The thread must  be suspended.

Returns:

 the number of stack frames in this thread.

Throws: IllegalThreadStateException

 if this thread is not suspended.

 join

  public final synchronized void join(long millis) throws InterruptedException

 Waits at most millis milliseconds for this thread to  die. A timeout of 0 means to wait forever.

Parameters:

 millis - the time to wait in milliseconds.

Throws: InterruptedException

 if another thread has interrupted the  current thread.

 join

  public final synchronized void join(long millis,
                                      int nanos) throws InterruptedException

 Waits at most millis milliseconds plus  nanos  nanoseconds for this thread to die.

Parameters:

 millis - the time to wait in milliseconds.

 nanos - 0-999999 additional nanoseconds to wait.

Throws: IllegalArgumentException

 if the value of millis is negative  the value of nanos is not in the range 0-999999.

Throws: InterruptedException

 if another thread has interrupted the  current thread.

 join

  public final void join() throws InterruptedException

 Waits for this thread to die.

Throws: InterruptedException

 if another thread has interrupted the  current thread.

 dumpStack

  public static void dumpStack()

 Prints a stack trace of the current thread. This method is used  only for debugging.

See Also:

printStackTrace

 setDaemon

  public final void setDaemon(boolean on)

 Marks this thread as either a daemon thread or a user thread. The  Java Virtual Machine exits when the only threads running are all  daemon threads.

 This method must be called before the thread is started.

Parameters:

 on - if true, marks this thread as a  daemon thread.

Throws: IllegalThreadStateException

 if this thread is active.

See Also:

isDaemon

 isDaemon

  public final boolean isDaemon()

 Tests if this thread is a daemon thread.

Returns:

true if this thread is a daemon thread;  false otherwise.

See Also:

setDaemon

 checkAccess

  public void checkAccess()

 Determines if the currently running thread has permission to  modify this thread.

 If there is a security manager, its checkAccess method  is called with this thread as its argument. This may result in  throwing a SecurityException.

Throws: SecurityException

 if the current thread is not allowed to  access this thread.

See Also:

checkAccess

 toString

  public String toString()

 Returns a string representation of this thread, including the  thread's name, priority, and thread group.

Returns:

 a string representation of this thread.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.ThreadDeath

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.ThreadDeath

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Error
                   |
                   +----java.lang.ThreadDeath

______________________________________________________________________________

 public class ThreadDeath

 extends Error

An instance of ThreadDeath is thrown in the victim  thread when the stop  method with zero arguments in  class Thread is called.

 An application should catch instances of this class only if it  must clean up after being terminated asynchronously. If  ThreadDeath  is caught by a method, it is important  that it be rethrown so that the thread actually dies.

 The top-level error handler does not print out a message if  ThreadDeath  is never caught.

 The class ThreadDeath is specifically a subclass of  Error rather than Exception, even though  it is a "normal occurrence", because many applications  catch all occurrences of Exception and then discard  the exception.

See Also:

stop

______________________________________________________________________________

 	ThreadDeath()

 ThreadDeath

  public ThreadDeath()

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.ThreadGroup

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.ThreadGroup

java.lang.Object
   |
   +----java.lang.ThreadGroup

______________________________________________________________________________

 public class ThreadGroup

 extends Object

A thread group represents a set of threads. In addition, a thread  group can also include other thread groups. The thread groups form  a tree in which every thread group except the initial thread group  has a parent.

 A thread is allowed to access information about its own thread  group, but not to access information about its thread group's  parent thread group or any other thread groups.

______________________________________________________________________________

 	ThreadGroup(String)

 Constructs a new thread group.

 	ThreadGroup(ThreadGroup, String)

 Creates a new thread group.

 	activeCount()

 Returns an estimate of the number of active threads in this  thread group.

 	activeGroupCount()

 Returns an estimate of the number of active groups in this  thread group.

 	allowThreadSuspension(boolean)

 Used by VM to control lowmem implicit suspension.

 	checkAccess()

 Determines if the currently running thread has permission to  modify this thread group.

 	destroy()

 Destroys this thread group and all of its subgroups.

 	enumerate(Thread[])

 Copies into the specified array every active thread in this  thread group and its subgroups.

 	enumerate(Thread[], boolean)

 Copies into the specified array every active thread in this  thread group.

 	enumerate(ThreadGroup[])

 Copies into the specified array references to every active  subgroup in this thread group.

 	enumerate(ThreadGroup[], boolean)

 Copies into the specified array references to every active  subgroup in this thread group.

 	getMaxPriority()

 Returns the maximum priority of this thread group.

 	getName()

 Returns the name of this thread group.

 	getParent()

 Returns the parent of this thread group.

 	isDaemon()

 Tests if this thread group is a daemon thread group.

 	isDestroyed()

 Tests if this thread group has not been destroyed.

 	list()

 Prints information about this thread group to the standard  output.

 	parentOf(ThreadGroup)

 Tests if this thread group is either the thread group  argument or one of its ancestor thread groups.

 	resume()

 Resumes all processes in this thread group.

 	setDaemon(boolean)

 Changes the daemon status of this thread group.

 	setMaxPriority(int)

 Sets the maximum priority of the group.

 	stop()

 Stops all processes in this thread group.

 	suspend()

 Suspends all processes in this thread group.

 	toString()

 Returns a string representation of this Thread group.

 	uncaughtException(Thread, Throwable)

 Called by the Java Virtual Machine when a thread in this  thread group stops because of an uncaught exception.

 ThreadGroup

  public ThreadGroup(String name)

 Constructs a new thread group. The parent of this new group is  the thread group of the currently running thread.

Parameters:

 name - the name of the new thread group.

 ThreadGroup

  public ThreadGroup(ThreadGroup parent,
                     String name)

 Creates a new thread group. The parent of this new group is the  specified thread group.

 The checkAccess method of the parent thread group is  called with no arguments; this may result in a security exception.

Parameters:

 parent - the parent thread group.

 name - the name of the new thread group.

Throws: NullPointerException

 if the thread group argument is  null.

Throws: SecurityException

 if the current thread cannot create a  thread in the specified thread group.

See Also:

SecurityException, checkAccess

 getName

  public final String getName()

 Returns the name of this thread group.

Returns:

 the name of this thread group.

 getParent

  public final ThreadGroup getParent()

 Returns the parent of this thread group.

Returns:

 the parent of this thread group. The top-level thread group  is the only thread group whose parent is null.

 getMaxPriority

  public final int getMaxPriority()

 Returns the maximum priority of this thread group. Threads that are  part of this group cannot have a higher priority than the maximum  priority.

Returns:

 the maximum priority that a thread in this thread group  can have.

 isDaemon

  public final boolean isDaemon()

 Tests if this thread group is a daemon thread group. A  daemon thread group is automatically destroyed when its last  thread is stopped or its last thread group is destroyed.

Returns:

true if this thread group is a daemon thread group;  false otherwise.

 isDestroyed

  public synchronized boolean isDestroyed()

 Tests if this thread group has not been destroyed.

 setDaemon

  public final void setDaemon(boolean daemon)

 Changes the daemon status of this thread group.

 First, the checkAccess method of this thread group is  called with no arguments; this may result in a security exception.

 A daemon thread group is automatically destroyed when its last  thread is stopped or its last thread group is destroyed.

Parameters:

 daemon - if true, marks this thread group as  a daemon thread group; otherwise, marks this  thread group as normal.

Throws: SecurityException

 if the current thread cannot modify  this thread.

See Also:

SecurityException, checkAccess

 setMaxPriority

  public final void setMaxPriority(int pri)

 Sets the maximum priority of the group.

 First, the checkAccess method of this thread group is  called with no arguments; this may result in a security exception.

 Threads in the thread group that already have a higher priority  are not affected.

Parameters:

 pri - the new priority of the thread group.

Throws: SecurityException

 if the current thread cannot modify  this thread group.

See Also:

SecurityException, checkAccess

 parentOf

  public final boolean parentOf(ThreadGroup g)

 Tests if this thread group is either the thread group  argument or one of its ancestor thread groups.

Parameters:

 g - a thread group.

Returns:

true if this thread group is the thread group  argument or one of its ancestor thread groups;  false otherwise.

 checkAccess

  public final void checkAccess()

 Determines if the currently running thread has permission to  modify this thread group.

 If there is a security manager, its checkAccess method  is called with this thread group as its argument. This may result  in throwing a SecurityException.

Throws: SecurityException

 if the current thread is not allowed to  access this thread group.

See Also:

checkAccess

 activeCount

  public int activeCount()

 Returns an estimate of the number of active threads in this  thread group.

Returns:

 the number of active threads in this thread group and in any  other thread group that has this thread group as an ancestor.

 enumerate

  public int enumerate(Thread list[])

 Copies into the specified array every active thread in this  thread group and its subgroups.

 An application should use the activeCount method to  get an estimate of how big the array should be. If the array is  too short to hold all the threads, the extra threads are silently  ignored.

Parameters:

 list - an array into which to place the list of threads.

Returns:

 the number of threads put into the array.

See Also:

activeCount

 enumerate

  public int enumerate(Thread list[],
                       boolean recurse)

 Copies into the specified array every active thread in this  thread group. If the recurse flag is  true , references to every active thread in this  thread's subgroups are also included. If the array is too short to  hold all the threads, the extra threads are silently ignored.

 An application should use the activeCount method to  get an estimate of how big the array should be.

Parameters:

 list - an array into which to place the list of threads.

 recurse - a flag indicating whether also to include threads  in thread groups that are subgroups of this  thread group.

Returns:

 the number of threads placed into the array.

See Also:

activeCount

 activeGroupCount

  public int activeGroupCount()

 Returns an estimate of the number of active groups in this  thread group.

Returns:

 the number of active thread groups with this thread group as  an ancestor.

 enumerate

  public int enumerate(ThreadGroup list[])

 Copies into the specified array references to every active  subgroup in this thread group.

 An application should use the activeGroupCount  method to get an estimate of how big the array should be. If the  array is too short to hold all the thread groups, the extra thread  groups are silently ignored.

Parameters:

 list - an array into which to place the list of thread groups.

Returns:

 the number of thread groups put into the array.

See Also:

activeGroupCount

 enumerate

  public int enumerate(ThreadGroup list[],
                       boolean recurse)

 Copies into the specified array references to every active  subgroup in this thread group. If the recurse flag is  true , references to all active subgroups of the  subgroups and so forth are also included.

 An application should use the activeGroupCount  method to get an estimate of how big the array should be.

Parameters:

 list - an array into which to place the list of threads.

 recurse - a flag indicating whether to recursively enumerate  all included thread groups.

Returns:

 the number of thread groups put into the array.

See Also:

activeGroupCount

 stop

  public final void stop()

 Stops all processes in this thread group.

 First, the checkAccess method of this thread group is  called with no arguments; this may result in a security exception.

 This method then calls the stop method on all the  threads in this thread group and in all of its subgroups.

Throws: SecurityException

 if the current thread is not allowed  to access this thread group or any of the threads in  the thread group.

See Also:

SecurityException, stop, checkAccess

 suspend

  public final void suspend()

 Suspends all processes in this thread group.

 First, the checkAccess method of this thread group is  called with no arguments; this may result in a security exception.

 This method then calls the suspend method on all the  threads in this thread group and in all of its subgroups.

Throws: SecurityException

 if the current thread is not allowed  to access this thread group or any of the threads in  the thread group.

See Also:

SecurityException, suspend, checkAccess

 resume

  public final void resume()

 Resumes all processes in this thread group.

 First, the checkAccess method of this thread group is  called with no arguments; this may result in a security exception.

 This method then calls the resume method on all the  threads in this thread group and in all of its sub groups.

Throws: SecurityException

 if the current thread is not allowed to  access this thread group or any of the threads in the  thread group.

See Also:

SecurityException, resume, checkAccess

 destroy

  public final void destroy()

 Destroys this thread group and all of its subgroups. This thread  group must be empty, indicating that all threads that had been in  this thread group have since stopped.

Throws: IllegalThreadStateException

 if the thread group is not  empty or if the thread group has already been destroyed.

Throws: SecurityException

 if the current thread cannot modify this  thread group.

 list

  public void list()

 Prints information about this thread group to the standard  output. This method is useful only for debugging.

 uncaughtException

  public void uncaughtException(Thread t,
                                Throwable e)

 Called by the Java Virtual Machine when a thread in this  thread group stops because of an uncaught exception.

 The uncaughtException method of  ThreadGroup does the following:

• If this thread group has a parent thread group, the  uncaughtException method of that parent is called  with the same two arguments.

• Otherwise, this method determines if the Throwable  argument is an instance of ThreadDeath. If so, nothing  special is done. Otherwise, the Throwable's  printStackTrace  method is called to print a stack  backtrace to the standard error stream.

 Applications can override this method in subclasses of  ThreadGroup  to provide alternative handling of  uncaught exceptions.

Parameters:

 t - the thread that is about to exit.

 e - the uncaught exception.

See Also:

err, ThreadDeath, printStackTrace

 allowThreadSuspension

  public boolean allowThreadSuspension(boolean b)

 Used by VM to control lowmem implicit suspension.

 toString

  public String toString()

 Returns a string representation of this Thread group.

Returns:

 a string representation of this thread group.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.Throwable

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.Throwable

java.lang.Object
   |
   +----java.lang.Throwable

______________________________________________________________________________

 public class Throwable

 extends Object

 implements Serializable

The Throwable class is the superclass of all errors  and exceptions in the Java language. Only objects that are  instances of this class (or of one of its subclasses) are thrown  by the Java Virtual Machine or can be thrown by the Java  throw  statement. Similarly, only this class or one of  its subclasses can be the argument type in a catch  clause.

 A Throwable class contains a snapshot of the  execution stack of its thread at the time it was created. It can  also contain a message string that gives more information about  the error.

 Here is one example of catching an exception:

     try {
         int a[] = new int[2];
         a[4];
     } catch (ArrayIndexOutOfBoundsException e) {
         System.out.println("exception: " + e.getMessage());
         e.printStackTrace();
     }

______________________________________________________________________________

 	Throwable()

 Constructs a new Throwable with no detail message.

 	Throwable(String)

 Constructs a new Throwable with the specified detail  message.

 	fillInStackTrace()

 Fills in the execution stack trace.

 	getLocalizedMessage()

 Creates a localized description of this Throwable.

 	getMessage()

 Returns the detail message of this throwable object.

 	printStackTrace()

 Prints this Throwable and its backtrace to the  standard error stream.

 	printStackTrace(PrintStream)

 Prints this Throwable and its backtrace to the  specified print stream.

 	printStackTrace(PrintWriter)

 Prints this Throwable and its backtrace to the specified  print writer.

 	toString()

 Returns a short description of this throwable object.

 Throwable

  public Throwable()

 Constructs a new Throwable with no detail message.  The stack trace is automatically filled in.

 Throwable

  public Throwable(String message)

 Constructs a new Throwable with the specified detail  message. The stack trace is automatically filled in.

Parameters:

 message - the detail message.

 getMessage

  public String getMessage()

 Returns the detail message of this throwable object.

Returns:

 the detail message of this Throwable,  or null if this Throwable does not  have a detail message.

 getLocalizedMessage

  public String getLocalizedMessage()

 Creates a localized description of this Throwable.  Subclasses may override this method in order to produce a  locale-specific message. For subclasses that do not override this  method, the default implementation returns the same result as  getMessage().

 toString

  public String toString()

 Returns a short description of this throwable object.

Returns:

 a string representation of this Throwable.

Overrides:

toString in class Object

 printStackTrace

  public void printStackTrace()

 Prints this Throwable and its backtrace to the  standard error stream.

See Also:

err

 printStackTrace

  public void printStackTrace(PrintStream s)

 Prints this Throwable and its backtrace to the  specified print stream.

 printStackTrace

  public void printStackTrace(PrintWriter s)

 Prints this Throwable and its backtrace to the specified  print writer.

 fillInStackTrace

  public Throwable fillInStackTrace()

 Fills in the execution stack trace. This method is useful when an  application is re-throwing an error or exception. For example:

     try {
         a = b / c;
     } catch(ArithmeticThrowable e) {
         a = Number.MAX_VALUE;
         throw e.fillInStackTrace();
     }

Returns:

 this Throwable object.

See Also:

printStackTrace

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.UnknownError

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.UnknownError

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Error
                   |
                   +----java.lang.VirtualMachineError
                           |
                           +----java.lang.UnknownError

______________________________________________________________________________

 public class UnknownError

 extends VirtualMachineError

Thrown when an unknown but serious exception has occurred in the  Java Virtual Machine.

______________________________________________________________________________

 	UnknownError()

 Constructs an UnknownError with no detail message.

 	UnknownError(String)

 Constructs an UnknownError with the specified detail  message.

 UnknownError

  public UnknownError()

 Constructs an UnknownError with no detail message.

 UnknownError

  public UnknownError(String s)

 Constructs an UnknownError with the specified detail  message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.UnsatisfiedLinkError

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.UnsatisfiedLinkError

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Error
                   |
                   +----java.lang.LinkageError
                           |
                           +----java.lang.UnsatisfiedLinkError

______________________________________________________________________________

 public class UnsatisfiedLinkError

 extends LinkageError

Thrown if the Java Virtual Machine cannot find an appropriate  native-language definition of a method declared native.

See Also:

Runtime

______________________________________________________________________________

 	UnsatisfiedLinkError()

 Constructs an UnsatisfiedLinkError with no detail message.

 	UnsatisfiedLinkError(String)

 Constructs an UnsatisfiedLinkError with the  specified detail message.

 UnsatisfiedLinkError

  public UnsatisfiedLinkError()

 Constructs an UnsatisfiedLinkError with no detail message.

 UnsatisfiedLinkError

  public UnsatisfiedLinkError(String s)

 Constructs an UnsatisfiedLinkError with the  specified detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.VerifyError

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.VerifyError

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Error
                   |
                   +----java.lang.LinkageError
                           |
                           +----java.lang.VerifyError

______________________________________________________________________________

 public class VerifyError

 extends LinkageError

Thrown when the "verifier" detects that a class file,  though well formed, contains some sort of internal inconsistency  or security problem.

______________________________________________________________________________

 	VerifyError()

 Constructs an VerifyError with no detail message.

 	VerifyError(String)

 Constructs an VerifyError with the specified detail message.

 VerifyError

  public VerifyError()

 Constructs an VerifyError with no detail message.

 VerifyError

  public VerifyError(String s)

 Constructs an VerifyError  with the specified detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.VirtualMachineError

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.VirtualMachineError

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Error
                   |
                   +----java.lang.VirtualMachineError

______________________________________________________________________________

 public class VirtualMachineError

 extends Error

Thrown to indicate that the Java Virtual Machine is broken or has  run out of resources necessary for it to continue operating.

______________________________________________________________________________

 	VirtualMachineError()

 Constructs a VirtualMachineError with no detail message.

 	VirtualMachineError(String)

 Constructs a VirtualMachineError with the specified  detail message.

 VirtualMachineError

  public VirtualMachineError()

 Constructs a VirtualMachineError with no detail message.

 VirtualMachineError

  public VirtualMachineError(String s)

 Constructs a VirtualMachineError with the specified  detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.lang.Void

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.lang.Void

java.lang.Object
   |
   +----java.lang.Void

______________________________________________________________________________

 public final class Void

 extends Object

The Void class is an uninstantiable placeholder class to hold a  reference to the Class object representing the primitive Java type  void.

______________________________________________________________________________

 	TYPE

 The Class object representing the primitive Java type void.

 TYPE

  public final static Class TYPE

 The Class object representing the primitive Java type void.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.math.BigDecimal

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.math.BigDecimal

java.lang.Object
   |
   +----java.lang.Number
           |
           +----java.math.BigDecimal

______________________________________________________________________________

 public class BigDecimal

 extends Number

Immutable, arbitrary-precision signed decimal numbers. A BigDecimal  consists of an arbitrary precision integer value and a non-negative  integer scale, which represents the number of decimal digits to the  right of the decimal point. (The number represented by the BigDecimal  is intVal/10**scale.) BigDecimals provide operations for basic arithmetic,  scale manipulation, comparison, format conversion and hashing.

The BigDecimal class gives its user complete control over rounding  behavior, forcing the user to explicitly specify a rounding behavior for  operations capable of discarding precision (divide and setScale). Eight  rounding modes  are provided for this purpose.  Two types of operations are provided for manipulating the scale of a  BigDecimal: scaling/rounding operations and decimal point motion operations.  Scaling/Rounding operations (SetScale) return a BigDecimal whose value is  approximately (or exactly) equal to that of the operand, but whose scale is  the specified value; that is, they increase or decrease the precision  of the number with minimal effect on its value. Decimal point motion  operations (movePointLeft and movePointRight) return a BigDecimal created  from the operand by moving the decimal point a specified distance in the  specified direction; that is, they change a number's value without affecting  its precision.

See Also:

BigInteger

______________________________________________________________________________

 	ROUND_CEILING

 If the BigDecimal is positive, behave as for ROUND_UP; if negative,  behave as for ROUND_DOWN.

 	ROUND_DOWN

 Never increment the digit prior to a discarded fraction (i.e.,  truncate).

 	ROUND_FLOOR

 If the BigDecimal is positive, behave as for ROUND_DOWN; if negative  behave as for ROUND_UP.

 	ROUND_HALF_DOWN

 Behave as for ROUND_UP if the discarded fraction is > .5; otherwise,  behave as for ROUND_DOWN.

 	ROUND_HALF_EVEN

 Behave as for ROUND_HALF_UP if the digit to the left of the discarded  fraction is odd; behave as for ROUND_HALF_DOWN if it's even.

 	ROUND_HALF_UP

 Behave as for ROUND_UP if the discarded fraction is >= .5; otherwise,  behave as for ROUND_DOWN.

 	ROUND_UNNECESSARY

 This "pseudo-rounding-mode" is actually an assertion that the requested  operation has an exact result, hence no rounding is necessary.

 	ROUND_UP

 Always increment the digit prior to a non-zero discarded fraction.

 	BigDecimal(BigInteger)

 Translates a BigInteger into a BigDecimal.

 	BigDecimal(BigInteger, int)

 Translates a BigInteger and a scale into a BigDecimal.

 	BigDecimal(double)

 Translates a double into a BigDecimal.

 	BigDecimal(String)

 Constructs a BigDecimal from a string containing an optional minus  sign followed by a sequence of zero or more decimal digits, optionally  followed by a fraction, which consists of a decimal point followed by  zero or more decimal digits.

 	abs()

 Returns a BigDecimal whose value is the absolute value of this  number, and whose scale is this.scale().

 	add(BigDecimal)

 Returns a BigDecimal whose value is (this + val), and whose scale is  MAX(this.scale(), val.scale).

 	compareTo(BigDecimal)

 Returns -1, 0 or 1 as this number is less than, equal to, or greater  than val.

 	divide(BigDecimal, int)

 Returns a BigDecimal whose value is (this / val), and whose scale  is this.scale().

 	divide(BigDecimal, int, int)

 Returns a BigDecimal whose value is (this / val), and whose scale  is as specified.

 	doubleValue()

 Converts the number to a double.

 	equals(Object)

 Returns true iff x is a BigDecimal whose value is equal to this number.

 	floatValue()

 Converts this number to a float.

 	hashCode()

 Computes a hash code for this object.

 	intValue()

 Converts this number to an int.

 	longValue()

 Converts this number to a long.

 	max(BigDecimal)

 Returns the BigDecimal whose value is the greater of this and val.

 	min(BigDecimal)

 Returns the BigDecimal whose value is the lesser of this and val.

 	movePointLeft(int)

 Returns a BigDecimal which is equivalent to this one with the decimal  point moved n places to the left.

 	movePointRight(int)

 Moves the decimal point the specified number of places to the right.

 	multiply(BigDecimal)

 Returns a BigDecimal whose value is (this * val), and whose scale is  this.scale() + val.scale.

 	negate()

 Returns a BigDecimal whose value is -1 * this, and whose scale is  this.scale().

 	scale()

 Returns the scale of this number.

 	setScale(int)

 Returns a BigDecimal whose scale is the specified value, and whose  value is exactly equal to this number's.

 	setScale(int, int)

 Returns a BigDecimal whose scale is the specified value, and whose  integer value is determined by multiplying or dividing this BigDecimal's  integer value by the appropriate power of ten to maintain the overall  value.

 	signum()

 Returns the signum function of this number (i.e., -1, 0 or 1 as  the value of this number is negative, zero or positive).

 	subtract(BigDecimal)

 Returns a BigDecimal whose value is (this - val), and whose scale is  MAX(this.scale(), val.scale).

 	toBigInteger()

 Converts this number to a BigInteger.

 	toString()

 Returns the string representation of this number.

 	valueOf(long)

 Returns a BigDecimal with the given value and a scale of zero.

 	valueOf(long, int)

 Returns a BigDecimal with a value of (val/10**scale).

 ROUND_UP

  public final static int ROUND_UP

 Always increment the digit prior to a non-zero discarded fraction.  Note that this rounding mode never decreases the magnitude.  (Rounds away from zero.)

 ROUND_DOWN

  public final static int ROUND_DOWN

 Never increment the digit prior to a discarded fraction (i.e.,  truncate). Note that this rounding mode never increases the magnitude.  (Rounds towards zero.)

 ROUND_CEILING

  public final static int ROUND_CEILING

 If the BigDecimal is positive, behave as for ROUND_UP; if negative,  behave as for ROUND_DOWN. Note that this rounding mode never decreases  the value. (Rounds towards positive infinity.)

 ROUND_FLOOR

  public final static int ROUND_FLOOR

 If the BigDecimal is positive, behave as for ROUND_DOWN; if negative  behave as for ROUND_UP. Note that this rounding mode never increases  the value. (Rounds towards negative infinity.)

 ROUND_HALF_UP

  public final static int ROUND_HALF_UP

 Behave as for ROUND_UP if the discarded fraction is >= .5; otherwise,  behave as for ROUND_DOWN. (Rounds towards "nearest neighbor" unless  both neighbors are equidistant, in which case rounds up.)

 ROUND_HALF_DOWN

  public final static int ROUND_HALF_DOWN

 Behave as for ROUND_UP if the discarded fraction is > .5; otherwise,  behave as for ROUND_DOWN. (Rounds towards "nearest neighbor" unless  both neighbors are equidistant, in which case rounds down.)

 ROUND_HALF_EVEN

  public final static int ROUND_HALF_EVEN

 Behave as for ROUND_HALF_UP if the digit to the left of the discarded  fraction is odd; behave as for ROUND_HALF_DOWN if it's even. (Rounds  towards the "nearest neighbor" unless both neighbors are equidistant,  in which case, rounds towards the even neighbor.)

 ROUND_UNNECESSARY

  public final static int ROUND_UNNECESSARY

 This "pseudo-rounding-mode" is actually an assertion that the requested   operation has an exact result, hence no rounding is necessary. If this  rounding mode is specified on an operation that yields an inexact result,  an arithmetic exception is thrown.

 BigDecimal

  public BigDecimal(String val) throws NumberFormatException

 Constructs a BigDecimal from a string containing an optional minus  sign followed by a sequence of zero or more decimal digits, optionally  followed by a fraction, which consists of a decimal point followed by  zero or more decimal digits. The string must contain at least one  digit in the integer or fractional part. The scale of the resulting  BigDecimal will be the number of digits to the right of the decimal  point in the string, or 0 if the string contains no decimal point.  The character-to-digit mapping is provided by Character.digit.  Any extraneous characters (including whitespace) will result in  a NumberFormatException.

 BigDecimal

  public BigDecimal(double val) throws NumberFormatException

 Translates a double into a BigDecimal. The scale of the BigDecimal  is the smallest value such that (10**scale * val) is an integer.  A double whose value is -infinity, +infinity or NaN will result in a  NumberFormatException.

 BigDecimal

  public BigDecimal(BigInteger val)

 Translates a BigInteger into a BigDecimal. The scale of the BigDecimal  is zero.

 BigDecimal

  public BigDecimal(BigInteger val,
                    int scale) throws NumberFormatException

 Translates a BigInteger and a scale into a BigDecimal. The value  of the BigDecimal is (BigInteger/10**scale). A negative scale  will result in a NumberFormatException.

 valueOf

  public static BigDecimal valueOf(long val,
                                   int scale) throws NumberFormatException

 Returns a BigDecimal with a value of (val/10**scale). This factory  is provided in preference to a (long) constructor because it allows  for reuse of frequently used BigDecimals (like 0 and 1), obviating  the need for exported constants. A negative scale will result in a  NumberFormatException.

 valueOf

  public static BigDecimal valueOf(long val)

 Returns a BigDecimal with the given value and a scale of zero.  This factory is provided in preference to a (long) constructor  because it allows for reuse of frequently used BigDecimals (like  0 and 1), obviating the need for exported constants.

 add

  public BigDecimal add(BigDecimal val)

 Returns a BigDecimal whose value is (this + val), and whose scale is  MAX(this.scale(), val.scale).

 subtract

  public BigDecimal subtract(BigDecimal val)

 Returns a BigDecimal whose value is (this - val), and whose scale is  MAX(this.scale(), val.scale).

 multiply

  public BigDecimal multiply(BigDecimal val)

 Returns a BigDecimal whose value is (this * val), and whose scale is  this.scale() + val.scale.

 divide

  public BigDecimal divide(BigDecimal val,
                           int scale,
                           int roundingMode) throws ArithmeticException, IllegalArgumentException

 Returns a BigDecimal whose value is (this / val), and whose scale  is as specified. If rounding must be performed to generate a  result with the given scale, the specified rounding mode is  applied. Throws an ArithmeticException if val == 0, scale

 divide

  public BigDecimal divide(BigDecimal val,
                           int roundingMode) throws ArithmeticException, IllegalArgumentException

 Returns a BigDecimal whose value is (this / val), and whose scale  is this.scale(). If rounding must be performed to generate a  result with the given scale, the specified rounding mode is  applied. Throws an ArithmeticException if val == 0. Throws  an IllegalArgumentException if roundingMode does not represent a  valid rounding mode.

 abs

  public BigDecimal abs()

 Returns a BigDecimal whose value is the absolute value of this  number, and whose scale is this.scale().

 negate

  public BigDecimal negate()

 Returns a BigDecimal whose value is -1 * this, and whose scale is  this.scale().

 signum

  public int signum()

 Returns the signum function of this number (i.e., -1, 0 or 1 as  the value of this number is negative, zero or positive).

 scale

  public int scale()

 Returns the scale of this number.

 setScale

  public BigDecimal setScale(int scale,
                             int roundingMode) throws ArithmeticException, IllegalArgumentException

 Returns a BigDecimal whose scale is the specified value, and whose  integer value is determined by multiplying or dividing this BigDecimal's  integer value by the appropriate power of ten to maintain the overall  value. If the scale is reduced by the operation, the integer value  must be divided (rather than multiplied), and precision may be lost;  in this case, the specified rounding mode is applied to the division.  Throws an ArithmeticException if scale is negative, or the rounding  mode is ROUND_UNNECESSARY and it is impossible to perform the  specified scaling operation without loss of precision. Throws an  IllegalArgumentException if roundingMode does not represent a valid  rounding mode.

 setScale

  public BigDecimal setScale(int scale) throws ArithmeticException, IllegalArgumentException

 Returns a BigDecimal whose scale is the specified value, and whose  value is exactly equal to this number's. Throws an ArithmeticException  if this is not possible. This call is typically used to increase  the scale, in which case it is guaranteed that there exists a BigDecimal  of the specified scale and the correct value. The call can also be used  to reduce the scale if the caller knows that the number has sufficiently  many zeros at the end of its fractional part (i.e., factors of ten in  its integer value) to allow for the rescaling without loss of precision.  Note that this call returns the same result as the two argument version  of setScale, but saves the caller the trouble of specifying a rounding  mode in cases where it is irrelevant.

 movePointLeft

  public BigDecimal movePointLeft(int n)

 Returns a BigDecimal which is equivalent to this one with the decimal  point moved n places to the left. If n is non-negative, the call merely  adds n to the scale. If n is negative, the call is equivalent to  movePointRight(-n). (The BigDecimal returned by this call has value  (this * 10**-n) and scale MAX(this.scale()+n, 0).)

 movePointRight

  public BigDecimal movePointRight(int n)

 Moves the decimal point the specified number of places to the right.  If this number's scale is >= n, the call merely subtracts n from the  scale; otherwise, it sets the scale to zero, and multiplies the integer  value by 10 ** (n - this.scale). If n is negative, the call is  equivalent to movePointLeft(-n). (The BigDecimal returned by this call  has value (this * 10**n) and scale MAX(this.scale()-n, 0).)

 compareTo

  public int compareTo(BigDecimal val)

 Returns -1, 0 or 1 as this number is less than, equal to, or greater  than val. Two BigDecimals that are equal in value but have a  different scale (e.g., 2.0, 2.00) are considered equal by this method.  This method is provided in preference to individual methods for each  of the six boolean comparison operators (, >=, !=,  0), where  is one of the six comparison operators.

 equals

  public boolean equals(Object x)

 Returns true iff x is a BigDecimal whose value is equal to this number.   This method is provided so that BigDecimals can be used as hash keys.  Unlike compareTo, this method considers two BigDecimals equal only  if they are equal in value and scale.

Overrides:

equals in class Object

 min

  public BigDecimal min(BigDecimal val)

 Returns the BigDecimal whose value is the lesser of this and val.  If the values are equal (as defined by the compareTo operator),  either may be returned.

 max

  public BigDecimal max(BigDecimal val)

 Returns the BigDecimal whose value is the greater of this and val.  If the values are equal (as defined by the compareTo operator),  either may be returned.

 hashCode

  public int hashCode()

 Computes a hash code for this object. Note that two BigDecimals  that are numerically equal but differ in scale (e.g., 2.0, 2.00) will  not generally have the same hash code.

Overrides:

hashCode in class Object

 toString

  public String toString()

 Returns the string representation of this number. The digit-to-  character mapping provided by Character.forDigit is used. The minus  sign and decimal point are used to indicate sign and scale. (This  representation is compatible with the (String, int) constructor.)

Overrides:

toString in class Object

 toBigInteger

  public BigInteger toBigInteger()

 Converts this number to a BigInteger. Standard narrowing primitive  conversion as per The Java Language Specification. In particular,  note that any fractional part of this number will be truncated.

 intValue

  public int intValue()

 Converts this number to an int. Standard narrowing primitive conversion   as per The Java Language Specification. In particular, note that any  fractional part of this number will be truncated.

Overrides:

intValue in class Number

 longValue

  public long longValue()

 Converts this number to a long. Standard narrowing primitive conversion   as per The Java Language Specification. In particular, note that any  fractional part of this number will be truncated.

Overrides:

longValue in class Number

 floatValue

  public float floatValue()

 Converts this number to a float. Similar to the double-to-float  narrowing primitive conversion defined in The Java Language  Specification: if the number has too great a magnitude to represent  as a float, it will be converted to infinity or negative infinity,  as appropriate.

Overrides:

floatValue in class Number

 doubleValue

  public double doubleValue()

 Converts the number to a double. Similar to the double-to-float  narrowing primitive conversion defined in The Java Language  Specification: if the number has too great a magnitude to represent  as a double, it will be converted to infinity or negative infinity,  as appropriate.

Overrides:

doubleValue in class Number

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.math.BigInteger

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.math.BigInteger

java.lang.Object
   |
   +----java.lang.Number
           |
           +----java.math.BigInteger

______________________________________________________________________________

 public class BigInteger

 extends Number

Immutable arbitrary-precision integers. All operations behave as if  BigIntegers were represented in two's-complement notation (like Java's  primitive integer types). BigIntegers provide analogues to all of Java's  primitive integer operators, and all relevant static methods from  java.lang.Math. Additionally, BigIntegers provide operations for modular  arithmetic, GCD calculation, primality testing, prime generation,  single-bit manipulation, and a few other odds and ends.

Semantics of arithmetic operations exactly mimic those of java's integer  arithmetic operators, as defined in The Java Language Specification. For  example, division by zero throws an ArithmeticException, and division of  a negative by a positive yields a negative (or zero) remainder. All of  the details in the Spec concerning overflow are ignored, as BigIntegers  are made as large as necessary to accommodate the results of an operation.

Semantics of shift operations extend those of Java's shift operators  to allow for negative shift distances. A right-shift with a negative  shift distance results in a left shift, and vice-versa. The unsigned  right shift operator (>>>) is omitted, as this operation makes little  sense in combination with the "infinite word size" abstraction provided  by this class.

Semantics of bitwise logical operations are are exactly mimic those of  Java's bitwise integer operators. The Binary operators (and, or, xor)  implicitly perform sign extension on the shorter of the two operands  prior to performing the operation.

Comparison operations perform signed integer comparisons, analogous to  those performed by java's relational and equality operators.

Modular arithmetic operations are provided to compute residues, perform  exponentiation, and compute multiplicative inverses. These methods always  return a non-negative result, between 0 and (modulus - 1), inclusive.

Single-bit operations operate on a single bit of the two's-complement  representation of their operand. If necessary, the operand is sign  extended so that it contains the designated bit. None of the single-bit  operations can produce a number with a different sign from the the  BigInteger being operated on, as they affect only a single bit, and the  "infinite word size" abstraction provided by this class ensures that there  are infinitely many "virtual sign bits" preceding each BigInteger.

See Also:

BigDecimal

______________________________________________________________________________

 	BigInteger(byte[])

 Translates a byte array containing the two's-complement representation  of a (signed) integer into a BigInteger.

 	BigInteger(int, byte[])

 Translates the sign-magnitude representation of an integer into a  BigInteger.

 	BigInteger(int, int, Random)

 Returns a randomly selected BigInteger with the specified bitLength  that is probably prime.

 	BigInteger(int, Random)

 Returns a random number uniformly distributed on [0, 2**numBits - 1]  (assuming a fair source of random bits is provided in rndSrc).

 	BigInteger(String)

 Translates a string containing an optional minus sign followed by a  sequence of one or more decimal digits into a BigInteger.

 	BigInteger(String, int)

 Translates a string containing an optional minus sign followed by a  sequence of one or more digits in the specified radix into a BigInteger.

 	abs()

 Returns a BigInteger whose value is the absolute value of this  number.

 	add(BigInteger)

 Returns a BigInteger whose value is (this + val).

 	and(BigInteger)

 Returns a BigInteger whose value is (this & val).

 	andNot(BigInteger)

 Returns a BigInteger whose value is (this & ~val).

 	bitCount()

 Returns the number of bits in the two's complement representation  of this number that differ from its sign bit.

 	bitLength()

 Returns the number of bits in the minimal two's-complement  representation of this number, *excluding* a sign bit, i.e.,  (ceil(log2(this   	clearBit(int)

 Returns a BigInteger whose value is equivalent to this number  with the designated bit cleared.

 	compareTo(BigInteger)

 Returns -1, 0 or 1 as this number is less than, equal to, or  greater than val.

 	divide(BigInteger)

 Returns a BigInteger whose value is (this / val).

 	divideAndRemainder(BigInteger)

 Returns an array of two BigIntegers.

 	doubleValue()

 Converts the number to a double.

 	equals(Object)

 Returns true iff x is a BigInteger whose value is equal to this number.

 	flipBit(int)

 Returns a BigInteger whose value is equivalent to this number  with the designated bit flipped.

 	floatValue()

 Converts this number to a float.

 	gcd(BigInteger)

 Returns a BigInteger whose value is the greatest common denominator  of abs(this) and abs(val).

 	getLowestSetBit()

 Returns the index of the rightmost (lowest-order) one bit in this  number (i.e., the number of zero bits to the right of the rightmost  one bit).

 	hashCode()

 Computes a hash code for this object.

 	intValue()

 Converts this number to an int.

 	isProbablePrime(int)

 Returns true if this BigInteger is probably prime, false if it's  definitely composite.

 	longValue()

 Converts this number to a long.

 	max(BigInteger)

 Returns the BigInteger whose value is the greater of this and val.

 	min(BigInteger)

 Returns the BigInteger whose value is the lesser of this and val.

 	mod(BigInteger)

 Returns a BigInteger whose value is this mod m.

 	modInverse(BigInteger)

 Returns modular multiplicative inverse of this, mod m.

 	modPow(BigInteger, BigInteger)

 Returns a BigInteger whose value is (this ** exponent) mod m.

 	multiply(BigInteger)

 Returns a BigInteger whose value is (this * val).

 	negate()

 Returns a BigInteger whose value is (-1 * this).

 	not()

 Returns a BigInteger whose value is (~this).

 	or(BigInteger)

 Returns a BigInteger whose value is (this | val).

 	pow(int)

 Returns a BigInteger whose value is (this ** exponent).

 	remainder(BigInteger)

 Returns a BigInteger whose value is (this % val).

 	setBit(int)

 Returns a BigInteger whose value is equivalent to this number  with the designated bit set.

 	shiftLeft(int)

 Returns a BigInteger whose value is (this   	shiftRight (int)

 Returns a BigInteger whose value is (this >> n).

 	signum()

 Returns the signum function of this number (i.e., -1, 0 or 1 as  the value of this number is negative, zero or positive).

 	subtract(BigInteger)

 Returns a BigInteger whose value is (this - val).

 	testBit(int)

 Returns true iff the designated bit is set.

 	toByteArray()

 Returns the two's-complement representation of this number.

 	toString()

 Returns the string representation of this number, radix 10.

 	toString(int)

 Returns the string representation of this number in the given radix.

 	valueOf(long)

 Returns a BigInteger with the specified value.

 	xor(BigInteger)

 Returns a BigInteger whose value is (this ^ val).

 BigInteger

  public BigInteger(byte val[]) throws NumberFormatException

 Translates a byte array containing the two's-complement representation  of a (signed) integer into a BigInteger. The input array is assumed to  be big-endian (i.e., the most significant byte is in the [0] position).  (The most significant bit of the most significant byte is the sign bit.)  The array must contain at least one byte or a NumberFormatException  will be thrown.

 BigInteger

  public BigInteger(int signum,
                    byte magnitude[]) throws NumberFormatException

 Translates the sign-magnitude representation of an integer into a  BigInteger. The sign is represented as an integer signum value (-1 for  negative, 0 for zero, 1 for positive). The magnitude is represented  as a big-endian byte array (i.e., the most significant byte is in the  [0] position). An invalid signum value or a 0 signum value coupled  with a nonzero magnitude will result in a NumberFormatException.  A zero length magnitude array is permissible, and will result in  in a value of 0 (irrespective of the given signum value).

 BigInteger

  public BigInteger(String val,
                    int radix) throws NumberFormatException

 Translates a string containing an optional minus sign followed by a  sequence of one or more digits in the specified radix into a BigInteger.  The character-to-digit mapping is provided by Character.digit.  Any extraneous characters (including whitespace), or a radix outside  the range from Character.MIN_RADIX(2) to Character.MAX_RADIX(36),  inclusive, will result in a NumberFormatException.

 BigInteger

  public BigInteger(String val) throws NumberFormatException

 Translates a string containing an optional minus sign followed by a  sequence of one or more decimal digits into a BigInteger. The  character-to-digit mapping is provided by Character.digit.  Any extraneous characters (including whitespace) will result in a  NumberFormatException.

 BigInteger

  public BigInteger(int numBits,
                    Random rndSrc) throws IllegalArgumentException

 Returns a random number uniformly distributed on [0, 2**numBits - 1]  (assuming a fair source of random bits is provided in rndSrc).  Note that this constructor always returns a non-negative BigInteger.  Throws an IllegalArgumentException if numBits

 BigInteger

  public BigInteger(int bitLength,
                    int certainty,
                    Random rnd)

 Returns a randomly selected BigInteger with the specified bitLength  that is probably prime. The certainty parameter is a measure of  the uncertainty that the caller is willing to tolerate: the probability  that the number is prime will exceed 1 - 1/2**certainty. The execution  time is proportional to the value of the certainty parameter. The  given random number generator is used to select candidates to be  tested for primality. Throws an ArithmeticException if bitLength

 valueOf

  public static BigInteger valueOf(long val)

 Returns a BigInteger with the specified value. This factory is provided   in preference to a (long) constructor because it allows for reuse  of frequently used BigIntegers (like 0 and 1), obviating the need for  exported constants.

 add

  public BigInteger add(BigInteger val) throws ArithmeticException

 Returns a BigInteger whose value is (this + val).

 subtract

  public BigInteger subtract(BigInteger val)

 Returns a BigInteger whose value is (this - val).

 multiply

  public BigInteger multiply(BigInteger val)

 Returns a BigInteger whose value is (this * val).

 divide

  public BigInteger divide(BigInteger val) throws ArithmeticException

 Returns a BigInteger whose value is (this / val). Throws an  ArithmeticException if val == 0.

 remainder

  public BigInteger remainder(BigInteger val) throws ArithmeticException

 Returns a BigInteger whose value is (this % val). Throws an  ArithmeticException if val == 0.

 divideAndRemainder

  public BigInteger[] divideAndRemainder(BigInteger val) throws ArithmeticException

 Returns an array of two BigIntegers. The first ([0]) element of  the return value is the quotient (this / val), and the second ([1])  element is the remainder (this % val). Throws an ArithmeticException  if val == 0.

 pow

  public BigInteger pow(int exponent) throws ArithmeticException

 Returns a BigInteger whose value is (this ** exponent). Throws  an ArithmeticException if exponent

 gcd

  public BigInteger gcd(BigInteger val)

 Returns a BigInteger whose value is the greatest common denominator  of abs(this) and abs(val). Returns 0 if this == 0 && val == 0.

 abs

  public BigInteger abs()

 Returns a BigInteger whose value is the absolute value of this  number.

 negate

  public BigInteger negate()

 Returns a BigInteger whose value is (-1 * this).

 signum

  public int signum()

 Returns the signum function of this number (i.e., -1, 0 or 1 as  the value of this number is negative, zero or positive).

 mod

  public BigInteger mod(BigInteger m)

 Returns a BigInteger whose value is this mod m. Throws an  ArithmeticException if m

 modPow

  public BigInteger modPow(BigInteger exponent,
                           BigInteger m)

 Returns a BigInteger whose value is (this ** exponent) mod m. (If  exponent == 1, the returned value is (this mod m). If exponent

 modInverse

  public BigInteger modInverse(BigInteger m) throws ArithmeticException

 Returns modular multiplicative inverse of this, mod m. Throws an  ArithmeticException if m

 shiftLeft

  public BigInteger shiftLeft(int n)

 Returns a BigInteger whose value is (this

 shiftRight

  public BigInteger shiftRight(int n)

 Returns a BigInteger whose value is (this >> n). Sign extension is  performed. (Computes floor(this / 2**n).)

 and

  public BigInteger and(BigInteger val)

 Returns a BigInteger whose value is (this & val). (This method  returns a negative number iff this and val are both negative.)

 or

  public BigInteger or(BigInteger val)

 Returns a BigInteger whose value is (this | val). (This method  returns a negative number iff either this or val is negative.)

 xor

  public BigInteger xor(BigInteger val)

 Returns a BigInteger whose value is (this ^ val). (This method  returns a negative number iff exactly one of this and val are  negative.)

 not

  public BigInteger not()

 Returns a BigInteger whose value is (~this). (This method returns  a negative value iff this number is non-negative.)

 andNot

  public BigInteger andNot(BigInteger val)

 Returns a BigInteger whose value is (this & ~val). This method,  which is equivalent to and(val.not()), is provided as a convenience  for masking operations. (This method returns a negative number iff  this is negative and val is positive.)

 testBit

  public boolean testBit(int n) throws ArithmeticException

 Returns true iff the designated bit is set. (Computes  ((this & (1

 setBit

  public BigInteger setBit(int n) throws ArithmeticException

 Returns a BigInteger whose value is equivalent to this number  with the designated bit set. (Computes (this | (1

 clearBit

  public BigInteger clearBit(int n) throws ArithmeticException

 Returns a BigInteger whose value is equivalent to this number  with the designated bit cleared. (Computes (this & ~(1

 flipBit

  public BigInteger flipBit(int n) throws ArithmeticException

 Returns a BigInteger whose value is equivalent to this number  with the designated bit flipped. (Computes (this ^ (1

 getLowestSetBit

  public int getLowestSetBit()

 Returns the index of the rightmost (lowest-order) one bit in this  number (i.e., the number of zero bits to the right of the rightmost  one bit). Returns -1 if this number contains no one bits.  (Computes (this==0? -1 : log2(this & -this)).)

 bitLength

  public int bitLength()

 Returns the number of bits in the minimal two's-complement  representation of this number, *excluding* a sign bit, i.e.,  (ceil(log2(this

 bitCount

  public int bitCount()

 Returns the number of bits in the two's complement representation  of this number that differ from its sign bit. This method is  useful when implementing bit-vector style sets atop BigIntegers.

 isProbablePrime

  public boolean isProbablePrime(int certainty)

 Returns true if this BigInteger is probably prime, false if it's  definitely composite. The certainty parameter is a measure  of the uncertainty that the caller is willing to tolerate:  the method returns true if the probability that this number is  is prime exceeds 1 - 1/2**certainty. The execution time is  proportional to the value of the certainty parameter.

 compareTo

  public int compareTo(BigInteger val)

 Returns -1, 0 or 1 as this number is less than, equal to, or  greater than val. This method is provided in preference to  individual methods for each of the six boolean comparison operators  (, >=, !=,  0), where  is one of the  six comparison operators.

 equals

  public boolean equals(Object x)

 Returns true iff x is a BigInteger whose value is equal to this number.   This method is provided so that BigIntegers can be used as hash keys.

Overrides:

equals in class Object

 min

  public BigInteger min(BigInteger val)

 Returns the BigInteger whose value is the lesser of this and val.  If the values are equal, either may be returned.

 max

  public BigInteger max(BigInteger val)

 Returns the BigInteger whose value is the greater of this and val.  If the values are equal, either may be returned.

 hashCode

  public int hashCode()

 Computes a hash code for this object.

Overrides:

hashCode in class Object

 toString

  public String toString(int radix)

 Returns the string representation of this number in the given radix.  If the radix is outside the range from Character.MIN_RADIX(2) to  Character.MAX_RADIX(36) inclusive, it will default to 10 (as is the  case for Integer.toString). The digit-to-character mapping provided  by Character.forDigit is used, and a minus sign is prepended if  appropriate. (This representation is compatible with the (String, int)  constructor.)

 toString

  public String toString()

 Returns the string representation of this number, radix 10. The  digit-to-character mapping provided by Character.forDigit is used,  and a minus sign is prepended if appropriate. (This representation  is compatible with the (String) constructor, and allows for string  concatenation with Java's + operator.)

Overrides:

toString in class Object

 toByteArray

  public byte[] toByteArray()

 Returns the two's-complement representation of this number. The array  is big-endian (i.e., the most significant byte is in the [0] position).  The array contains the minimum number of bytes required to represent  the number (ceil((this.bitLength() + 1)/8)). (This representation is  compatible with the (byte[]) constructor.)

 intValue

  public int intValue()

 Converts this number to an int. Standard narrowing primitive conversion   as per The Java Language Specification.

Overrides:

intValue in class Number

 longValue

  public long longValue()

 Converts this number to a long. Standard narrowing primitive conversion   as per The Java Language Specification.

Overrides:

longValue in class Number

 floatValue

  public float floatValue()

 Converts this number to a float. Similar to the double-to-float  narrowing primitive conversion defined in The Java Language  Specification: if the number has too great a magnitude to represent  as a float, it will be converted to infinity or negative infinity,  as appropriate.

Overrides:

floatValue in class Number

 doubleValue

  public double doubleValue()

 Converts the number to a double. Similar to the double-to-float  narrowing primitive conversion defined in The Java Language  Specification: if the number has too great a magnitude to represent  as a double, it will be converted to infinity or negative infinity,  as appropriate.

Overrides:

doubleValue in class Number

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.net.BindException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.net.BindException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.net.SocketException
                                   |
                                   +----java.net.BindException

______________________________________________________________________________

 public class BindException

 extends SocketException

Signals that an error occurred while attempting to bind a  socket to a local address and port. Typically, the port is  in use, or the requested local address could not be assigned.

______________________________________________________________________________

 	BindException()

 Construct a new BindException with no detailed message.

 	BindException(String)

 Constructs a new BindException with the specified detail  message as to why the bind error occurred.

 BindException

  public BindException(String msg)

 Constructs a new BindException with the specified detail  message as to why the bind error occurred.  A detail message is a String that gives a specific  description of this error.

Parameters:

 msg - the detail message

 BindException

  public BindException()

 Construct a new BindException with no detailed message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.net.ConnectException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.net.ConnectException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.net.SocketException
                                   |
                                   +----java.net.ConnectException

______________________________________________________________________________

 public class ConnectException

 extends SocketException

Signals that an error occurred while attempting to connect a  socket to a remote address and port. Typically, the connection  was refused remotely (e.g., no process is listening on the  remote address/port).

______________________________________________________________________________

 	ConnectException()

 Construct a new ConnectException with no detailed message.

 	ConnectException(String)

 Constructs a new ConnectException with the specified detail  message as to why the connect error occurred.

 ConnectException

  public ConnectException(String msg)

 Constructs a new ConnectException with the specified detail  message as to why the connect error occurred.  A detail message is a String that gives a specific  description of this error.

Parameters:

 msg - the detail message

 ConnectException

  public ConnectException()

 Construct a new ConnectException with no detailed message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.net.ContentHandler

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.net.ContentHandler

java.lang.Object
   |
   +----java.net.ContentHandler

______________________________________________________________________________

 public class ContentHandler

 extends Object

The abstract class ContentHandler is the superclass  of all classes that read an Object from a  URLConnection.

 An application does not generally call the  getContent  method in this class directly. Instead, an  application calls the getContent  method in class  URL or in URLConnection.  The application's content handler factory (an instance of a class that  implements the interface ContentHandlerFactory set  up by a call to setContentHandler) is  called with a String giving the MIME type of the  object being received on the socket. The factory returns an  instance of a subclass of ContentHandler, and its  getContent method is called to create the object.

See Also:

getContent, ContentHandlerFactory, getContent, URLConnection , getContent, setContentHandlerFactory

______________________________________________________________________________

 	ContentHandler()

 	getContent(URLConnection)

 Given a URL connect stream positioned at the beginning of the  representation of an object, this method reads that stream and  creates an object from it.

 ContentHandler

  public ContentHandler()

 getContent

  public abstract Object getContent(URLConnection urlc) throws IOException

 Given a URL connect stream positioned at the beginning of the  representation of an object, this method reads that stream and  creates an object from it.

Parameters:

 urlc - a URL connection.

Returns:

 the object read by the ContentHandler.

Throws: IOException

 if an I/O error occurs while reading the object.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.net.ContentHandlerFactory

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.net.ContentHandlerFactory

 public interface ContentHandlerFactory

This interface defines a factory for content handlers. An  implementation of this interface should map a MIME type into an  instance of ContentHandler.

 This interface is used by the URLStreamHandler class  to create a ContentHandler for a MIME type.

See Also:

ContentHandler, URLStreamHandler

______________________________________________________________________________

 	createContentHandler(String)

 Creates a new ContentHandler to read an object from  a URLStreamHandler.

 createContentHandler

  public abstract ContentHandler createContentHandler(String mimetype)

 Creates a new ContentHandler to read an object from  a URLStreamHandler.

Parameters:

 mimetype - the MIME type for which a content handler is desired.

Returns:

 a new ContentHandler to read an object from a  URLStreamHandler.

See Also:

ContentHandler, URLStreamHandler

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.net.DatagramPacket

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.net.DatagramPacket

java.lang.Object
   |
   +----java.net.DatagramPacket

______________________________________________________________________________

 public final class DatagramPacket

 extends Object

This class represents a datagram packet.

 Datagram packets are used to implement a connectionless packet  delivery service. Each message is routed from one machine to  another based solely on information contained within that packet.  Multiple packets sent from one machine to another might be routed  differently, and might arrive in any order.

______________________________________________________________________________

 	DatagramPacket(byte[], int)

 Constructs a DatagramPacket for receiving packets of  length ilength.

 	DatagramPacket(byte[], int, InetAddress, int)

 Constructs a datagram packet for sending packets of length  ilength  to the specified port number on the specified  host.

 	getAddress()

 Returns the IP address of the machine to which this datagram is being  sent or from which the datagram was received.

 	getData()

 Returns the data received or the data to be sent.

 	getLength()

 Returns the length of the data to be sent or the length of the  data received.

 	getPort()

 Returns the port number on the remote host to which this datagram is  being sent or from which the datagram was received.

 	setAddress(InetAddress)

  	setData(byte[])

  	setLength(int)

  	setPort(int)

 DatagramPacket

  public DatagramPacket(byte ibuf[],
                        int ilength)

 Constructs a DatagramPacket for receiving packets of  length ilength.

 The length argument must be less than or equal to  ibuf.length.

Parameters:

 ibuf - buffer for holding the incoming datagram.

 ilength - the number of bytes to read.

 DatagramPacket

  public DatagramPacket(byte ibuf[],
                        int ilength,
                        InetAddress iaddr,
                        int iport)

 Constructs a datagram packet for sending packets of length  ilength to the specified port number on the specified  host. The length  argument must be less than or equal  to ibuf.length.

Parameters:

 ibuf - the packet data.

 ilength - the packet length.

 iaddr - the destination address.

 iport - the destination port number.

See Also:

InetAddress

 getAddress

  public synchronized InetAddress getAddress()

 Returns the IP address of the machine to which this datagram is being  sent or from which the datagram was received.

Returns:

 the IP address of the machine to which this datagram is being  sent or from which the datagram was received.

See Also:

InetAddress

 getPort

  public synchronized int getPort()

 Returns the port number on the remote host to which this datagram is  being sent or from which the datagram was received.

Returns:

 the port number on the remote host to which this datagram is  being sent or from which the datagram was received.

 getData

  public synchronized byte[] getData()

 Returns the data received or the data to be sent.

Returns:

 the data received or the data to be sent.

 getLength

  public synchronized int getLength()

 Returns the length of the data to be sent or the length of the  data received.

Returns:

 the length of the data to be sent or the length of the  data received.

 setAddress

  public synchronized void setAddress(InetAddress iaddr)

 setPort

  public synchronized void setPort(int iport)

 setData

  public synchronized void setData(byte ibuf[])

 setLength

  public synchronized void setLength(int ilength)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.net.DatagramSocket

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.net.DatagramSocket

java.lang.Object
   |
   +----java.net.DatagramSocket

______________________________________________________________________________

 public class DatagramSocket

 extends Object

This class represents a socket for sending and receiving datagram packets.

 A datagram socket is the sending or receiving point for a  connectionless packet delivery service. Each packet sent or  received on a datagram socket is individually addressed and  routed. Multiple packets sent from one machine to another may be  routed differently, and may arrive in any order.

See Also:

DatagramPacket

______________________________________________________________________________

 	DatagramSocket()

 Constructs a datagram socket and binds it to any available port  on the local host machine.

 	DatagramSocket(int)

 Constructs a datagram socket and binds it to the specified port  on the local host machine.

 	DatagramSocket(int, InetAddress)

 Creates a datagram socket, bound to the specified local  address.

 	close()

 Closes this datagram socket.

 	getLocalAddress()

 Gets the local address to which the socket is bound.

 	getLocalPort()

 Returns the port number on the local host to which this socket is bound.

 	getSoTimeout()

 Retrive setting for SO_TIMEOUT.

 	receive(DatagramPacket)

 Receives a datagram packet from this socket.

 	send(DatagramPacket)

 Sends a datagram packet from this socket.

 	setSoTimeout(int)

 Enable/disable SO_TIMEOUT with the specified timeout, in  milliseconds.

 DatagramSocket

  public DatagramSocket() throws SocketException

 Constructs a datagram socket and binds it to any available port  on the local host machine.

Throws: SocketException

 if the socket could not be opened,  or the socket could not bind to the specified local port.

 DatagramSocket

  public DatagramSocket(int port) throws SocketException

 Constructs a datagram socket and binds it to the specified port  on the local host machine.

Parameters:

 local - port to use.

Throws: SocketException

 if the socket could not be opened,  or the socket could not bind to the specified local port.

 DatagramSocket

  public DatagramSocket(int port,
                        InetAddress laddr) throws SocketException

 Creates a datagram socket, bound to the specified local  address. The local port must be between 0 and 65535 inclusive.

Parameters:

 port - local port to use

 laddr - local address to bind

 send

  public void send(DatagramPacket p) throws IOException

 Sends a datagram packet from this socket. The  DatagramPacket includes information indicating the  data to be sent, its length, the IP address of the remote host,  and the port number on the remote host.

Parameters:

 p - the DatagramPacket to be sent.

Throws: IOException

 if an I/O error occurs.

See Also:

DatagramPacket

 receive

  public synchronized void receive(DatagramPacket p) throws IOException

 Receives a datagram packet from this socket. When this method  returns, the DatagramPacket's buffer is filled with  the data received. The datagram packet also contains the sender's  IP address, and the port number on the sender's machine.

 This method blocks until a datagram is received. The  length  field of the datagram packet object contains  the length of the received message. If the message is longer than  the buffer length, the message is truncated.

Parameters:

 p - the DatagramPacket into which to place  the incoming data.

Throws: IOException

 if an I/O error occurs.

See Also:

DatagramPacket, DatagramSocket

 getLocalAddress

  public InetAddress getLocalAddress()

 Gets the local address to which the socket is bound.

 getLocalPort

  public int getLocalPort()

 Returns the port number on the local host to which this socket is bound.

Returns:

 the port number on the local host to which this socket is bound.

 setSoTimeout

  public synchronized void setSoTimeout(int timeout) throws SocketException

 Enable/disable SO_TIMEOUT with the specified timeout, in  milliseconds. With this option set to a non-zero timeout,  a call to receive() for this DatagramSocket  will block for only this amount of time. If the timeout expires,  a java.io.InterruptedIOException is raised, though the  ServerSocket is still valid. The option must be enabled  prior to entering the blocking operation to have effect. The  timeout must be > 0.  A timeout of zero is interpreted as an infinite timeout.

 getSoTimeout

  public synchronized int getSoTimeout() throws SocketException

 Retrive setting for SO_TIMEOUT. 0 returns implies that the  option is disabled (i.e., timeout of infinity).

 close

  public void close()

 Closes this datagram socket.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.net.DatagramSocketImpl

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.net.DatagramSocketImpl

java.lang.Object
   |
   +----java.net.DatagramSocketImpl

______________________________________________________________________________

 public class DatagramSocketImpl

 extends Object

 implements SocketOptions

Abstract datagram and multicast socket implementation base class.

______________________________________________________________________________

 	fd

 The file descriptor object

 	localPort

 	DatagramSocketImpl()

 	bind(int, InetAddress)

 Binds a datagram socket to a local port and address.

 	close()

 Close the socket.

 	create()

 Creates a datagram socket

 	getFileDescriptor()

 Get the datagram socket file descriptor

 	getLocalPort()

 Get the local port.

 	getOption(int)

 Fetch the value of an option.

 	getTTL()

 Retrieve the TTL (time-to-live) option.

 	join(InetAddress)

 Join the multicast group.

 	leave(InetAddress)

 Leave the multicast group.

 	peek(InetAddress)

 Peek at the packet to see who it is from.

 	receive(DatagramPacket)

 Receive the datagram packet.

 	send(DatagramPacket)

 Sends a datagram packet.

 	setOption(int, Object)

 Enable/disable the option specified by optID.

 	setTTL(byte)

 Set the TTL (time-to-live) option.

 localPort

  protected int localPort

 fd

  protected FileDescriptor fd

 The file descriptor object

 DatagramSocketImpl

  public DatagramSocketImpl()

 create

  protected abstract void create() throws SocketException

 Creates a datagram socket

 bind

  protected abstract void bind(int lport,
                               InetAddress laddr) throws SocketException

 Binds a datagram socket to a local port and address.

 send

  protected abstract void send(DatagramPacket p) throws IOException

 Sends a datagram packet. The packet contains the data and the  destination address to send the packet to.

Parameters:

 packet - to be sent.

 peek

  protected abstract int peek(InetAddress i) throws IOException

 Peek at the packet to see who it is from.

Parameters:

 return - the address which the packet came from.

 receive

  protected abstract void receive(DatagramPacket p) throws IOException

 Receive the datagram packet.

Parameters:

 Packet - Received.

 setTTL

  protected abstract void setTTL(byte ttl) throws IOException

 Set the TTL (time-to-live) option.

Parameters:

 TTL - to be set.

 getTTL

  protected abstract byte getTTL() throws IOException

 Retrieve the TTL (time-to-live) option.

 join

  protected abstract void join(InetAddress inetaddr) throws IOException

 Join the multicast group.

Parameters:

 multicast - address to join.

 leave

  protected abstract void leave(InetAddress inetaddr) throws IOException

 Leave the multicast group.

Parameters:

 multicast - address to leave.

 close

  protected abstract void close()

 Close the socket.

 getLocalPort

  protected int getLocalPort()

 Get the local port.

 getFileDescriptor

  protected FileDescriptor getFileDescriptor()

 Get the datagram socket file descriptor

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.net.FileNameMap

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.net.FileNameMap

 public interface FileNameMap

A simple interface which provides a mechanism to map between  between a file name and a MIME type string.

______________________________________________________________________________

 	getContentTypeFor(String)

 getContentTypeFor

  public abstract String getContentTypeFor(String fileName)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.net.HttpURLConnection

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.net.HttpURLConnection

java.lang.Object
   |
   +----java.net.URLConnection
           |
           +----java.net.HttpURLConnection

______________________________________________________________________________

 public class HttpURLConnection

 extends URLConnection

A URLConnection with support for HTTP-specific features. See   the spec   for  details.

______________________________________________________________________________

 	HTTP_ACCEPTED

  	HTTP_BAD_GATEWAY

  	HTTP_BAD_METHOD

  	HTTP_BAD_REQUEST

 4XX: client error

 	HTTP_CLIENT_TIMEOUT

  	HTTP_CONFLICT

  	HTTP_CREATED

  	HTTP_ENTITY_TOO_LARGE

  	HTTP_FORBIDDEN

  	HTTP_GATEWAY_TIMEOUT

  	HTTP_GONE

  	HTTP_INTERNAL_ERROR

  	HTTP_LENGTH_REQUIRED

  	HTTP_MOVED_PERM

  	HTTP_MOVED_TEMP

  	HTTP_MULT_CHOICE

 3XX: relocation/redirect

 	HTTP_NO_CONTENT

  	HTTP_NOT_ACCEPTABLE

  	HTTP_NOT_AUTHORITATIVE

  	HTTP_NOT_FOUND

  	HTTP_NOT_MODIFIED

  	HTTP_OK

 2XX: generally "OK"

 	HTTP_PARTIAL

  	HTTP_PAYMENT_REQUIRED

  	HTTP_PRECON_FAILED

  	HTTP_PROXY_AUTH

  	HTTP_REQ_TOO_LONG

  	HTTP_RESET

  	HTTP_SEE_OTHER

  	HTTP_SERVER_ERROR

 5XX: server error

 	HTTP_UNAUTHORIZED

  	HTTP_UNAVAILABLE

  	HTTP_UNSUPPORTED_TYPE

  	HTTP_USE_PROXY

  	HTTP_VERSION

  	method

  	responseCode

  	responseMessage

 	HttpURLConnection(URL)

 Constructor for the URLStreamHandler.

 	disconnect()

 Close the connection to the server.

 	getFollowRedirects()

  	getRequestMethod()

 Get the request method.

 	getResponseCode()

 Gets HTTP response status.

 	getResponseMessage()

 Gets the HTTP response message, if any, returned along with the  response code from a server.

 	setFollowRedirects(boolean)

 Sets whether HTTP redirects (requests with response code 3xx) should  be automatically followed by this class.

 	setRequestMethod(String)

 Set the method for the URL request, one of:

• GET

• POST

• HEAD

• OPTIONS

• PUT

• DELETE

• TRACE

 are legal, subject to protocol restrictions.

 	usingProxy()

 Indicates if the connection is going through a proxy.

 method

  protected String method

 responseCode

  protected int responseCode

 responseMessage

  protected String responseMessage

 HTTP_OK

  public final static int HTTP_OK

 2XX: generally "OK"

 HTTP_CREATED

  public final static int HTTP_CREATED

 HTTP_ACCEPTED

  public final static int HTTP_ACCEPTED

 HTTP_NOT_AUTHORITATIVE

  public final static int HTTP_NOT_AUTHORITATIVE

 HTTP_NO_CONTENT

  public final static int HTTP_NO_CONTENT

 HTTP_RESET

  public final static int HTTP_RESET

 HTTP_PARTIAL

  public final static int HTTP_PARTIAL

 HTTP_MULT_CHOICE

  public final static int HTTP_MULT_CHOICE

 3XX: relocation/redirect

 HTTP_MOVED_PERM

  public final static int HTTP_MOVED_PERM

 HTTP_MOVED_TEMP

  public final static int HTTP_MOVED_TEMP

 HTTP_SEE_OTHER

  public final static int HTTP_SEE_OTHER

 HTTP_NOT_MODIFIED

  public final static int HTTP_NOT_MODIFIED

 HTTP_USE_PROXY

  public final static int HTTP_USE_PROXY

 HTTP_BAD_REQUEST

  public final static int HTTP_BAD_REQUEST

 4XX: client error

 HTTP_UNAUTHORIZED

  public final static int HTTP_UNAUTHORIZED

 HTTP_PAYMENT_REQUIRED

  public final static int HTTP_PAYMENT_REQUIRED

 HTTP_FORBIDDEN

  public final static int HTTP_FORBIDDEN

 HTTP_NOT_FOUND

  public final static int HTTP_NOT_FOUND

 HTTP_BAD_METHOD

  public final static int HTTP_BAD_METHOD

 HTTP_NOT_ACCEPTABLE

  public final static int HTTP_NOT_ACCEPTABLE

 HTTP_PROXY_AUTH

  public final static int HTTP_PROXY_AUTH

 HTTP_CLIENT_TIMEOUT

  public final static int HTTP_CLIENT_TIMEOUT

 HTTP_CONFLICT

  public final static int HTTP_CONFLICT

 HTTP_GONE

  public final static int HTTP_GONE

 HTTP_LENGTH_REQUIRED

  public final static int HTTP_LENGTH_REQUIRED

 HTTP_PRECON_FAILED

  public final static int HTTP_PRECON_FAILED

 HTTP_ENTITY_TOO_LARGE

  public final static int HTTP_ENTITY_TOO_LARGE

 HTTP_REQ_TOO_LONG

  public final static int HTTP_REQ_TOO_LONG

 HTTP_UNSUPPORTED_TYPE

  public final static int HTTP_UNSUPPORTED_TYPE

 HTTP_SERVER_ERROR

  public final static int HTTP_SERVER_ERROR

 5XX: server error

 HTTP_INTERNAL_ERROR

  public final static int HTTP_INTERNAL_ERROR

 HTTP_BAD_GATEWAY

  public final static int HTTP_BAD_GATEWAY

 HTTP_UNAVAILABLE

  public final static int HTTP_UNAVAILABLE

 HTTP_GATEWAY_TIMEOUT

  public final static int HTTP_GATEWAY_TIMEOUT

 HTTP_VERSION

  public final static int HTTP_VERSION

 HttpURLConnection

  protected HttpURLConnection(URL u)

 Constructor for the URLStreamHandler.

 setFollowRedirects

  public static void setFollowRedirects(boolean set)

 Sets whether HTTP redirects (requests with response code 3xx) should  be automatically followed by this class. False by default. Applets  cannot change this variable.

 getFollowRedirects

  public static boolean getFollowRedirects()

 setRequestMethod

  public void setRequestMethod(String method) throws ProtocolException

 Set the method for the URL request, one of:

• GET

• POST

• HEAD

• OPTIONS

• PUT

• DELETE

• TRACE

 are legal, subject to protocol restrictions. The default  method is GET.

Throws: ProtocolException

 if the method cannot be reset or if  the requested method isn't valid for HTTP.

 getRequestMethod

  public String getRequestMethod()

 Get the request method.

 getResponseCode

  public int getResponseCode() throws IOException

 Gets HTTP response status. From responses like:

 HTTP/1.0 200 OK
 HTTP/1.0 401 Unauthorized

 Extracts the ints 200 and 401 respectively.  Returns -1 if none can be discerned  from the response (i.e., the response is not valid HTTP).

 getResponseMessage

  public String getResponseMessage() throws IOException

 Gets the HTTP response message, if any, returned along with the  response code from a server. From responses like:

 HTTP/1.0 200 OK
 HTTP/1.0 404 Not Found

 Extracts the Strings "OK" and "Not Found" respectively.  Returns null if none could be discerned from the responses  (the result was not valid HTTP).

 disconnect

  public abstract void disconnect()

 Close the connection to the server.

 usingProxy

  public abstract boolean usingProxy()

 Indicates if the connection is going through a proxy.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.net.InetAddress

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.net.InetAddress

java.lang.Object
   |
   +----java.net.InetAddress

______________________________________________________________________________

 public final class InetAddress

 extends Object

 implements Serializable

This class represents an Internet Protocol (IP) address.

 Applications should use the methods getLocalHost,  getByName, or getAllByName to  create a new InetAddress instance.

See Also:

getAllByName, getByName, getLocalHost

______________________________________________________________________________

 	equals(Object)

 Compares this object against the specified object.

 	getAddress()

 Returns the raw IP address of this InetAddress  object.

 	getAllByName(String)

 Determines all the IP addresses of a host, given the host's name.

 	getByName(String)

 Determines the IP address of a host, given the host's name.

 	getHostAddress()

 Returns the IP address string "%d.%d.%d.%d"

 	getHostName()

 Returns the hostname for this address.

 	getLocalHost()

 Returns the local host.

 	hashCode()

 Returns a hashcode for this IP address.

 	isMulticastAddress()

 Utility routine to check if the InetAddress is a  IP multicast address.

 	toString()

 Converts this IP address to a String.

 isMulticastAddress

  public boolean isMulticastAddress()

 Utility routine to check if the InetAddress is a  IP multicast address. IP multicast address is a Class D  address i.e first four bits of the address are 1110.

 getHostName

  public String getHostName()

 Returns the hostname for this address.  If the host is equal to null, then this address refers to any  of the local machine's available network addresses.

Returns:

 the host name for this IP address.

 getAddress

  public byte[] getAddress()

 Returns the raw IP address of this InetAddress  object. The result is in network byte order: the highest order  byte of the address is in getAddress()[0].

Returns:

 the raw IP address of this object.

 getHostAddress

  public String getHostAddress()

 Returns the IP address string "%d.%d.%d.%d"

Returns:

 raw IP address in a string format

 hashCode

  public int hashCode()

 Returns a hashcode for this IP address.

Returns:

 a hash code value for this IP address.

Overrides:

hashCode in class Object

 equals

  public boolean equals(Object obj)

 Compares this object against the specified object.  The result is true if and only if the argument is  not null  and it represents the same IP address as  this object.

 Two instances of InetAddress represent the same IP  address if the length of the byte arrays returned by  getAddress  is the same for both, and each of the  array components is the same for the byte arrays.

Parameters:

 obj - the object to compare against.

Returns:

true if the objects are the same;  false otherwise.

Overrides:

equals in class Object

See Also:

getAddress

 toString

  public String toString()

 Converts this IP address to a String.

Returns:

 a string representation of this IP address.

Overrides:

toString in class Object

 getByName

  public static InetAddress getByName(String host) throws UnknownHostException

 Determines the IP address of a host, given the host's name. The  host name can either be a machine name, such as  "java.sun.com ", or a string representing its IP  address, such as "206.26.48.100".

Parameters:

 host - the specified host, or null for the  local host.

Returns:

 an IP address for the given host name.

Throws: UnknownHostException

 if no IP address for the  host could be found.

 getAllByName

  public static InetAddress[] getAllByName(String host) throws UnknownHostException

 Determines all the IP addresses of a host, given the host's name.  The host name can either be a machine name, such as  "java.sun.com ", or a string representing  its IP address, such as "206.26.48.100".

Parameters:

 host - the name of the host.

Returns:

 an array of all the IP addresses for a given host name.

Throws: UnknownHostException

 if no IP address for the  host could be found.

 getLocalHost

  public static InetAddress getLocalHost() throws UnknownHostException

 Returns the local host.

Returns:

 the IP address of the local host.

Throws: UnknownHostException

 if no IP address for the  host could be found.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.net.MalformedURLException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.net.MalformedURLException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.net.MalformedURLException

______________________________________________________________________________

 public class MalformedURLException

 extends IOException

Thrown to indicate that a malformed URL has occurred. Either no  legal protocol could be found in a specification string or the  string could not be parsed.

______________________________________________________________________________

 	MalformedURLException()

 Constructs a MalformedURLException with no detail message.

 	MalformedURLException(String)

 Constructs a MalformedURLException with the  specified detail message.

 MalformedURLException

  public MalformedURLException()

 Constructs a MalformedURLException with no detail message.

 MalformedURLException

  public MalformedURLException(String msg)

 Constructs a MalformedURLException with the  specified detail message.

Parameters:

 msg - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.net.MulticastSocket

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.net.MulticastSocket

java.lang.Object
   |
   +----java.net.DatagramSocket
           |
           +----java.net.MulticastSocket

______________________________________________________________________________

 public class MulticastSocket

 extends DatagramSocket

The multicast datagram socket class is useful for sending  and receiving IP multicast packets. A MulticastSocket is  a (UDP) DatagramSocket, with additional capabilities for  joining "groups" of other multicast hosts on the internet.

 A multicast group is specified by a class D IP address, those  in the range 224.0.0.1  to 239.255.255.255,  inclusive, and by a standard UDP port number. One would join a  multicast group by first creating a MulticastSocket with the desired  port, then invoking the joinGroup(InetAddress groupAddr)  method:

 // join a Multicast group and send the group salutations
 ...
 byte[] msg = {'H', 'e', 'l', 'l', 'o'};
 InetAddress group = InetAddress.getByName("228.5.6.7");
 MulticastSocket s = new MulticastSocket(6789);
 s.joinGroup(group);
 DatagramPacket hi = new DatagramPacket(msg, msg.length,
                             group, 6789);
 s.send(hi);
 // get their responses!
 byte[] buf = new byte[1000];
 DatagramPacket recv = new DatagramPacket(buf, buf.length);
 s.receive(recv);
 ...
 // OK, I'm done talking - leave the group...
 s.leaveGroup(group);

 When one sends a message to a multicast group, all subscribing  recipients to that host and port receive the message (within the  time-to-live range of the packet, see below). The socket needn't  be a member of the multicast group to send messages to it.

 When a socket subscribes to a multicast group/port, it receives  datagrams sent by other hosts to the group/port, as do all other  members of the group and port. A socket relinquishes membership  in a group by the leaveGroup(InetAddress addr) method.   Multiple MulticastSocket's  may subscribe to a multicast group  and port concurrently, and they will all receive group datagrams.

 Currently applets are not allowed ot use multicast sockets.

______________________________________________________________________________

 	MulticastSocket()

 Create a multicast socket.

 	MulticastSocket(int)

 Create a multicast socket and bind it to a specific port.

 	getInterface()

 Retrieve the address of the network interface used for  multicast packets.

 	getTTL()

 Get the default time-to-live for multicast packets sent out  on the socket.

 	joinGroup(InetAddress)

 Joins a multicast group.

 	leaveGroup(InetAddress)

 Leave a multicast group.

 	send(DatagramPacket, byte)

 Sends a datagram packet to the destination, with a TTL (time-  to-live) other than the default for the socket.

 	setInterface(InetAddress)

 Set the outgoing network interface for multicast packets on this  socket, to other than the system default.

 	setTTL(byte)

 Set the default time-to-live for multicast packets sent out  on this socket.

 MulticastSocket

  public MulticastSocket() throws IOException

 Create a multicast socket.

 MulticastSocket

  public MulticastSocket(int port) throws IOException

 Create a multicast socket and bind it to a specific port.

Parameters:

 local - port to use

 setTTL

  public void setTTL(byte ttl) throws IOException

 Set the default time-to-live for multicast packets sent out  on this socket. The TTL sets the IP time-to-live for  DatagramPackets  sent to a MulticastGroup, which  specifies how many "hops" that the packet will be forwarded  on the network before it expires.

 The ttl is an unsigned 8-bit quantity, and so must be  in the range  0 .

Parameters:

 ttl - the time-to-live

 getTTL

  public byte getTTL() throws IOException

 Get the default time-to-live for multicast packets sent out  on the socket.

 joinGroup

  public void joinGroup(InetAddress mcastaddr) throws IOException

 Joins a multicast group.

Parameters:

 mcastaddr - is the multicast address to join

Throws: IOException

 is raised if there is an error joining  or when address is not a multicast address.

 leaveGroup

  public void leaveGroup(InetAddress mcastaddr) throws IOException

 Leave a multicast group.

Parameters:

 mcastaddr - is the multicast address to leave

Throws: IOException

 is raised if there is an error leaving  or when address is not a multicast address.

 setInterface

  public void setInterface(InetAddress inf) throws SocketException

 Set the outgoing network interface for multicast packets on this  socket, to other than the system default. Useful for multihomed  hosts.

 getInterface

  public InetAddress getInterface() throws SocketException

 Retrieve the address of the network interface used for  multicast packets.

 send

  public synchronized void send(DatagramPacket p,
                                byte ttl) throws IOException

 Sends a datagram packet to the destination, with a TTL (time-  to-live) other than the default for the socket. This method  need only be used in instances where a particular TTL is desired;  otherwise it is preferable to set a TTL once on the socket, and  use that default TTL for all packets. This method does not    alter the default TTL for the socket.

Parameters:

 p - is the packet to be sent. The packet should contain  the destination multicast ip address and the data to be sent.  One does not need to be the member of the group to send  packets to a destination multicast address.

 ttl - optional time to live for multicast packet.  default ttl is 1.

Throws: IOException

 is raised if an error occurs i.e  error while setting ttl.

See Also:

send, receive

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.net.NoRouteToHostException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.net.NoRouteToHostException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.net.SocketException
                                   |
                                   +----java.net.NoRouteToHostException

______________________________________________________________________________

 public class NoRouteToHostException

 extends SocketException

Signals that an error occurred while attempting to connect a  socket to a remote address and port. Typically, the remote  host cannot be reached because of an intervening firewall, or  if an intermediate router is down.

______________________________________________________________________________

 	NoRouteToHostException()

 Construct a new NoRouteToHostException with no detailed message.

 	NoRouteToHostException(String)

 Constructs a new NoRouteToHostException with the specified detail  message as to why the remote host cannot be reached.

 NoRouteToHostException

  public NoRouteToHostException(String msg)

 Constructs a new NoRouteToHostException with the specified detail  message as to why the remote host cannot be reached.  A detail message is a String that gives a specific  description of this error.

Parameters:

 msg - the detail message

 NoRouteToHostException

  public NoRouteToHostException()

 Construct a new NoRouteToHostException with no detailed message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.net.ProtocolException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.net.ProtocolException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.net.ProtocolException

______________________________________________________________________________

 public class ProtocolException

 extends IOException

Thrown to indicate that there is an error in the underlying  protocol, such as a TCP error.

______________________________________________________________________________

 	ProtocolException()

 Constructs a new ProtocolException with no detail message.

 	ProtocolException(String)

 Constructs a new ProtocolException with the  specified detail message.

 ProtocolException

  public ProtocolException(String host)

 Constructs a new ProtocolException with the  specified detail message.

Parameters:

 host - the detail message.

 ProtocolException

  public ProtocolException()

 Constructs a new ProtocolException with no detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.net.ServerSocket

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.net.ServerSocket

java.lang.Object
   |
   +----java.net.ServerSocket

______________________________________________________________________________

 public class ServerSocket

 extends Object

This class implements server sockets. A server socket waits for  requests to come in over the network. It performs some operation  based on that request, and then possibly returns a result to the requester.

 The actual work of the server socket is performed by an instance  of the SocketImpl  class. An application can  change the socket factory that creates the socket  implementation to configure itself to create sockets  appropriate to the local firewall.

See Also:

SocketImpl, setSocketFactory

______________________________________________________________________________

 	ServerSocket(int)

 Creates a server socket on a specified port.

 	ServerSocket(int, int)

 Creates a server socket and binds it to the specified local port  number.

 	ServerSocket(int, int, InetAddress)

 Create a server with the specified port, listen backlog, and  local IP address to bind to.

 	accept()

 Listens for a connection to be made to this socket and accepts  it.

 	close()

 Closes this socket.

 	getInetAddress()

 Returns the local address of this server socket.

 	getLocalPort()

 Returns the port on which this socket is listening.

 	getSoTimeout()

 Retrive setting for SO_TIMEOUT.

 	implAccept(Socket)

 Subclasses of ServerSocket use this method to override accept()  to return their own subclass of socket.

 	setSocketFactory(SocketImplFactory)

 Sets the server socket implementation factory for the  application.

 	setSoTimeout(int)

 Enable/disable SO_TIMEOUT with the specified timeout, in  milliseconds.

 	toString()

 Returns the implementation address and implementation port of  this socket as a String .

 ServerSocket

  public ServerSocket(int port) throws IOException

 Creates a server socket on a specified port. A port of  0  creates a socket on any free port.

 The maximum queue length for incoming connection indications (a  request to connect) is set to 50. If a connection  indication arrives when the queue is full, the connection is refused.

 If the application has specified a server socket factory, that  factory's createSocketImpl method is called to create  the actual socket implementation. Otherwise a "plain" socket is created.

Parameters:

 port - the port number, or 0 to use any  free port.

Throws: IOException

 if an I/O error occurs when opening the socket.

See Also:

SocketImpl, createSocketImpl, setSocketFactory

 ServerSocket

  public ServerSocket(int port,
                      int backlog) throws IOException

 Creates a server socket and binds it to the specified local port  number. A port number of 0 creates a socket on any  free port.

 The maximum queue length for incoming connection indications (a  request to connect) is set to the count parameter. If  a connection indication arrives when the queue is full, the  connection is refused.

 If the application has specified a server socket factory, that  factory's createSocketImpl method is called to create  the actual socket implementation. Otherwise a "plain" socket is created.

Parameters:

 port - the specified port, or 0 to use  any free port.

 backlog - the maximum length of the queue.

Throws: IOException

 if an I/O error occurs when opening the socket.

See Also:

SocketImpl, createSocketImpl, setSocketFactory

 ServerSocket

  public ServerSocket(int port,
                      int backlog,
                      InetAddress bindAddr) throws IOException

 Create a server with the specified port, listen backlog, and  local IP address to bind to. The bindAddr argument  can be used on a multi-homed host for a ServerSocket that  will only accept connect requests to one of its addresses.  If bindAddr  is null, it will default accepting  connections on any/all local addresses.  The port must be between 0 and 65535, inclusive.

Parameters:

 port - the local TCP port

 backlog - the listen backlog

 bindAddr - the local InetAddress the server will bind to

See Also:

 SocketConstants, SocketOption, SocketImpl, 1

 getInetAddress

  public InetAddress getInetAddress()

 Returns the local address of this server socket.

Returns:

 the address to which this socket is connected,  or null  if the socket is not yet connected.

 getLocalPort

  public int getLocalPort()

 Returns the port on which this socket is listening.

Returns:

 the port number to which this socket is listening.

 accept

  public Socket accept() throws IOException

 Listens for a connection to be made to this socket and accepts  it. The method blocks until a connection is made.

Throws: IOException

 if an I/O error occurs when waiting for a  connection.

 implAccept

  protected final void implAccept(Socket s) throws IOException

 Subclasses of ServerSocket use this method to override accept()  to return their own subclass of socket. So a FooServerSocket  will typically hand this method an empty FooSocket(). On  return from implAccept the FooSocket will be connected to a client.

 close

  public void close() throws IOException

 Closes this socket.

Throws: IOException

 if an I/O error occurs when closing the socket.

 setSoTimeout

  public synchronized void setSoTimeout(int timeout) throws SocketException

 Enable/disable SO_TIMEOUT with the specified timeout, in  milliseconds. With this option set to a non-zero timeout,  a call to accept() for this ServerSocket  will block for only this amount of time. If the timeout expires,  a java.io.InterruptedIOException is raised, though the  ServerSocket is still valid. The option must be enabled  prior to entering the blocking operation to have effect. The  timeout must be > 0.  A timeout of zero is interpreted as an infinite timeout.

 getSoTimeout

  public synchronized int getSoTimeout() throws IOException

 Retrive setting for SO_TIMEOUT. 0 returns implies that the  option is disabled (i.e., timeout of infinity).

 toString

  public String toString()

 Returns the implementation address and implementation port of  this socket as a String.

Returns:

 a string representation of this socket.

Overrides:

toString in class Object

 setSocketFactory

  public static synchronized void setSocketFactory(SocketImplFactory fac) throws IOException

 Sets the server socket implementation factory for the  application. The factory can be specified only once.

 When an application creates a new server socket, the socket  implementation factory's createSocketImpl method is  called to create the actual socket implementation.

Parameters:

 fac - the desired factory.

Throws: IOException

 if an I/O error occurs when setting the  socket factory.

Throws: SocketException

 if the factory has already been defined.

See Also:

createSocketImpl

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.net.Socket

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.net.Socket

java.lang.Object
   |
   +----java.net.Socket

______________________________________________________________________________

 public class Socket

 extends Object

This class implements client sockets (also called just  "sockets"). A socket is an endpoint for communication  between two machines.

 The actual work of the socket is performed by an instance of the  SocketImpl  class. An application, by changing  the socket factory that creates the socket implementation,  can configure itself to create sockets appropriate to the local  firewall.

See Also:

setSocketImplFactory, SocketImpl

______________________________________________________________________________

 	Socket()

 Creates an unconnected socket, with the  system-default type of SocketImpl.

 	Socket(InetAddress, int)

 Creates a stream socket and connects it to the specified port  number at the specified IP address.

 	Socket(InetAddress, int, boolean)

 Creates a socket and connects it to the specified port number at  the specified IP address. Deprecated.

 	Socket(InetAddress, int, InetAddress, int)

 Creates a socket and connects it to the specified remote address on  the specified remote port.

 	Socket(SocketImpl)

 Creates an unconnected Socket with a user-specified  SocketImpl.

 	Socket(String, int)

 Creates a stream socket and connects it to the specified port  number on the named host.

 	Socket(String, int, boolean)

 Creates a stream socket and connects it to the specified port  number on the named host. Deprecated.

 	Socket(String, int, InetAddress, int)

 Creates a socket and connects it to the specified remote host on  the specified remote port.

 	close()

 Closes this socket.

 	getInetAddress()

 Returns the address to which the socket is connected.

 	getInputStream()

 Returns an input stream for this socket.

 	getLocalAddress()

 Gets the local address to which the socket is bound.

 	getLocalPort()

 Returns the local port to which this socket is bound.

 	getOutputStream()

 Returns an output stream for this socket.

 	getPort()

 Returns the remote port to which this socket is connected.

 	getSoLinger()

 Returns setting for SO_LINGER.

 	getSoTimeout()

 Returns setting for SO_TIMEOUT.

 	getTcpNoDelay()

 Tests if TCP_NODELAY is enabled.

 	setSocketImplFactory(SocketImplFactory)

 Sets the client socket implementation factory for the  application.

 	setSoLinger(boolean, int)

 Enable/disable SO_LINGER with the specified linger time.

 	setSoTimeout(int)

 Enable/disable SO_TIMEOUT with the specified timeout, in  milliseconds.

 	setTcpNoDelay(boolean)

 Enable/disable TCP_NODELAY (disable/enable Nagle's algorithm).

 	toString()

 Converts this socket to a String.

 Socket

  protected Socket()

 Creates an unconnected socket, with the  system-default type of SocketImpl.

 Socket

  protected Socket(SocketImpl impl) throws SocketException

 Creates an unconnected Socket with a user-specified  SocketImpl.

 The impl parameter is an instance of a SocketImpl  the subclass wishes to use on the Socket.

 Socket

  public Socket(String host,
                int port) throws UnknownHostException, IOException

 Creates a stream socket and connects it to the specified port  number on the named host.

 If the application has specified a server socket factory, that  factory's createSocketImpl method is called to create  the actual socket implementation. Otherwise a "plain" socket is created.

Parameters:

 host - the host name.

 port - the port number.

Throws: IOException

 if an I/O error occurs when creating the socket.

See Also:

setSocketImplFactory, SocketImpl, createSocketImpl

 Socket

  public Socket(InetAddress address,
                int port) throws IOException

 Creates a stream socket and connects it to the specified port  number at the specified IP address.

 If the application has specified a socket factory, that factory's  createSocketImpl  method is called to create the  actual socket implementation. Otherwise a "plain" socket is created.

Parameters:

 address - the IP address.

 port - the port number.

Throws: IOException

 if an I/O error occurs when creating the socket.

See Also:

setSocketImplFactory, SocketImpl, createSocketImpl

 Socket

  public Socket(String host,
                int port,
                InetAddress localAddr,
                int localPort) throws IOException

 Creates a socket and connects it to the specified remote host on  the specified remote port. The Socket will also bind() to the local  address and port supplied.

Parameters:

 host - the name of the remote host

 port - the remote port

 localAddr - the local address the socket is bound to

 localPort - the local port the socket is bound to

 Socket

  public Socket(InetAddress address,
                int port,
                InetAddress localAddr,
                int localPort) throws IOException

 Creates a socket and connects it to the specified remote address on  the specified remote port. The Socket will also bind() to the local  address and port supplied.

Parameters:

 address - the remote address

 port - the remote port

 localAddr - the local address the socket is bound to

 localPort - the local port the socket is bound to

 Socket

  public Socket(String host,
                int port,
                boolean stream) throws IOException

 Note: Socket() is deprecated. Use DatagramSocket instead for UDP transport.

 Creates a stream socket and connects it to the specified port  number on the named host.

 If the stream argument is true, this creates a  stream socket. If the stream argument is false, it  creates a datagram socket.

 If the application has specified a server socket factory, that  factory's createSocketImpl method is called to create  the actual socket implementation. Otherwise a "plain" socket is created.

Parameters:

 host - the host name.

 port - the port number.

 stream - a boolean indicating whether this is  a stream socket or a datagram socket.

Throws: IOException

 if an I/O error occurs when creating the socket.

See Also:

setSocketImplFactory, SocketImpl, createSocketImpl

 Socket

  public Socket(InetAddress host,
                int port,
                boolean stream) throws IOException

 Note: Socket() is deprecated. Use DatagramSocket instead for UDP transport.

 Creates a socket and connects it to the specified port number at  the specified IP address.

 If the stream argument is true, this creates a  stream socket. If the stream argument is false, it  creates a datagram socket.

 If the application has specified a server socket factory, that  factory's createSocketImpl method is called to create  the actual socket implementation. Otherwise a "plain" socket is created.

Parameters:

 address - the IP address.

 port - the port number.

 stream - if true, create a stream socket;  otherwise, create a datagram socket.

Throws: IOException

 if an I/O error occurs when creating the socket.

See Also:

setSocketImplFactory, SocketImpl, createSocketImpl

 getInetAddress

  public InetAddress getInetAddress()

 Returns the address to which the socket is connected.

Returns:

 the remote IP address to which this socket is connected.

 getLocalAddress

  public InetAddress getLocalAddress()

 Gets the local address to which the socket is bound.

 getPort

  public int getPort()

 Returns the remote port to which this socket is connected.

Returns:

 the remote port number to which this socket is connected.

 getLocalPort

  public int getLocalPort()

 Returns the local port to which this socket is bound.

Returns:

 the local port number to which this socket is connected.

 getInputStream

  public InputStream getInputStream() throws IOException

 Returns an input stream for this socket.

Returns:

 an input stream for reading bytes from this socket.

Throws: IOException

 if an I/O error occurs when creating the  input stream.

 getOutputStream

  public OutputStream getOutputStream() throws IOException

 Returns an output stream for this socket.

Returns:

 an output stream for writing bytes to this socket.

Throws: IOException

 if an I/O error occurs when creating the  output stream.

 setTcpNoDelay

  public void setTcpNoDelay(boolean on) throws SocketException

 Enable/disable TCP_NODELAY (disable/enable Nagle's algorithm).

 getTcpNoDelay

  public boolean getTcpNoDelay() throws SocketException

 Tests if TCP_NODELAY is enabled.

 setSoLinger

  public void setSoLinger(boolean on,
                          int val) throws SocketException

 Enable/disable SO_LINGER with the specified linger time.

 getSoLinger

  public int getSoLinger() throws SocketException

 Returns setting for SO_LINGER. -1 returns implies that the  option is disabled.

 setSoTimeout

  public synchronized void setSoTimeout(int timeout) throws SocketException

 Enable/disable SO_TIMEOUT with the specified timeout, in  milliseconds. With this option set to a non-zero timeout,  a read() call on the InputStream associated with this Socket  will block for only this amount of time. If the timeout expires,  a java.io.InterruptedIOException is raised, though the  Socket is still valid. The option must be enabled  prior to entering the blocking operation to have effect. The  timeout must be > 0.  A timeout of zero is interpreted as an infinite timeout.

 getSoTimeout

  public synchronized int getSoTimeout() throws SocketException

 Returns setting for SO_TIMEOUT. 0 returns implies that the  option is disabled (i.e., timeout of infinity).

 close

  public synchronized void close() throws IOException

 Closes this socket.

Throws: IOException

 if an I/O error occurs when closing this socket.

 toString

  public String toString()

 Converts this socket to a String.

Returns:

 a string representation of this socket.

Overrides:

toString in class Object

 setSocketImplFactory

  public static synchronized void setSocketImplFactory(SocketImplFactory fac) throws IOException

 Sets the client socket implementation factory for the  application. The factory can be specified only once.

 When an application creates a new client socket, the socket  implementation factory's createSocketImpl method is  called to create the actual socket implementation.

Parameters:

 fac - the desired factory.

Throws: IOException

 if an I/O error occurs when setting the  socket factory.

Throws: SocketException

 if the factory is already defined.

See Also:

createSocketImpl

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.net.SocketException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.net.SocketException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.net.SocketException

______________________________________________________________________________

 public class SocketException

 extends IOException

Thrown to indicate that there is an error in the underlying  protocol, such as a TCP error.

______________________________________________________________________________

 	SocketException()

 Constructs a new ProtocolException with no detail message.

 	SocketException(String)

 Constructs a new ProtocolException with the  specified detail message.

 SocketException

  public SocketException(String msg)

 Constructs a new ProtocolException with the  specified detail message.

Parameters:

 host - the detail message.

 SocketException

  public SocketException()

 Constructs a new ProtocolException with no detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.net.SocketImpl

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.net.SocketImpl

java.lang.Object
   |
   +----java.net.SocketImpl

______________________________________________________________________________

 public class SocketImpl

 extends Object

 implements SocketOptions

The abstract class SocketImpl is a common superclass  of all classes that actually implement sockets. It is used to  create both client and server sockets.

 A "plain" socket implements these methods exactly as  described, without attempting to go through a firewall or proxy.

______________________________________________________________________________

 	address

 The IP address of the remote end of this socket.

 	fd

 The file descriptor object for this socket.

 	localport

 The local port number to which this socket is connected.

 	port

 The port number on the remote host to which this socket is connected.

 	SocketImpl()

 	accept(SocketImpl)

 Accepts a connection.

 	available()

 Returns the number of bytes that can be read from this socket  without blocking.

 	bind(InetAddress, int)

 Binds this socket to the specified port number on the specified host.

 	close()

 Closes this socket.

 	connect(InetAddress, int)

 Connects this socket to the specified port number on the specified host.

 	connect(String, int)

 Connects this socket to the specified port on the named host.

 	create(boolean)

 Creates either a stream or a datagram socket.

 	getFileDescriptor()

 Returns the value of this socket's fd field.

 	getInetAddress()

 Returns the value of this socket's address field.

 	getInputStream()

 Returns an input stream for this socket.

 	getLocalPort()

 Returns the value of this socket's localport field.

 	getOption(int)

 Fetch the value of an option.

 	getOutputStream()

 Returns an output stream for this socket.

 	getPort()

 Returns the value of this socket's port field.

 	listen(int)

 Sets the maximum queue length for incoming connection indications  (a request to connect) to the count argument.

 	setOption(int, Object)

 Enable/disable the option specified by optID.

 	toString()

 Returns the address and port of this socket as a String.

 fd

  protected FileDescriptor fd

 The file descriptor object for this socket.

 address

  protected InetAddress address

 The IP address of the remote end of this socket.

 port

  protected int port

 The port number on the remote host to which this socket is connected.

 localport

  protected int localport

 The local port number to which this socket is connected.

 SocketImpl

  public SocketImpl()

 create

  protected abstract void create(boolean stream) throws IOException

 Creates either a stream or a datagram socket.

Parameters:

 stream - if true, create a stream socket;  otherwise, create a datagram socket.

Throws: IOException

 if an I/O error occurs while creating the  socket.

 connect

  protected abstract void connect(String host,
                                  int port) throws IOException

 Connects this socket to the specified port on the named host.

Parameters:

 host - the name of the remote host.

 port - the port number.

Throws: IOException

 if an I/O error occurs when connecting to the  remote host.

 connect

  protected abstract void connect(InetAddress address,
                                  int port) throws IOException

 Connects this socket to the specified port number on the specified host.

Parameters:

 address - the IP address of the remote host.

 port - the port number.

Throws: IOException

 if an I/O error occurs when attempting a  connection.

 bind

  protected abstract void bind(InetAddress host,
                               int port) throws IOException

 Binds this socket to the specified port number on the specified host.

Parameters:

 host - the IP address of the remote host.

 port - the port number.

Throws: IOException

 if an I/O error occurs when binding this socket.

 listen

  protected abstract void listen(int backlog) throws IOException

 Sets the maximum queue length for incoming connection indications  (a request to connect) to the count argument. If a  connection indication arrives when the queue is full, the  connection is refused.

Parameters:

 backlog - the maximum length of the queue.

Throws: IOException

 if an I/O error occurs when creating the queue.

 accept

  protected abstract void accept(SocketImpl s) throws IOException

 Accepts a connection.

Parameters:

 s - the accepted connection.

Throws: IOException

 if an I/O error occurs when accepting the  connection.

 getInputStream

  protected abstract InputStream getInputStream() throws IOException

 Returns an input stream for this socket.

Returns:

 a stream for reading from this socket.

Throws: IOException

 if an I/O error occurs when creating the  input stream.

 getOutputStream

  protected abstract OutputStream getOutputStream() throws IOException

 Returns an output stream for this socket.

Returns:

 an output stream for writing to this socket.

Throws: IOException

 if an I/O error occurs when creating the  output stream.

 available

  protected abstract int available() throws IOException

 Returns the number of bytes that can be read from this socket  without blocking.

Returns:

 the number of bytes that can be read from this socket  without blocking.

Throws: IOException

 if an I/O error occurs when determining the  number of bytes available.

 close

  protected abstract void close() throws IOException

 Closes this socket.

Throws: IOException

 if an I/O error occurs when closing this socket.

 getFileDescriptor

  protected FileDescriptor getFileDescriptor()

 Returns the value of this socket's fd field.

Returns:

 the value of this socket's fd field.

See Also:

fd

 getInetAddress

  protected InetAddress getInetAddress()

 Returns the value of this socket's address field.

Returns:

 the value of this socket's address field.

See Also:

address

 getPort

  protected int getPort()

 Returns the value of this socket's port field.

Returns:

 the value of this socket's port field.

See Also:

port

 getLocalPort

  protected int getLocalPort()

 Returns the value of this socket's localport field.

Returns:

 the value of this socket's localport field.

See Also:

localport

 toString

  public String toString()

 Returns the address and port of this socket as a String.

Returns:

 a string representation of this socket.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.net.SocketImplFactory

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.net.SocketImplFactory

 public interface SocketImplFactory

This interface defines a factory for socket implementations. It  is used by the classes Socket and  ServerSocket to create actual socket  implementations.

See Also:

Socket, ServerSocket

______________________________________________________________________________

 	createSocketImpl()

 Creates a new SocketImpl instance.

 createSocketImpl

  public abstract SocketImpl createSocketImpl()

 Creates a new SocketImpl instance.

Returns:

 a new instance of SocketImpl.

See Also:

 SocketImpl

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.net.UnknownHostException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.net.UnknownHostException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.net.UnknownHostException

______________________________________________________________________________

 public class UnknownHostException

 extends IOException

Thrown to indicate that the IP address of a host could not be determined.

______________________________________________________________________________

 	UnknownHostException()

 Constructs a new UnknownHostException with no detail  message.

 	UnknownHostException(String)

 Constructs a new UnknownHostException with the  specified detail message.

 UnknownHostException

  public UnknownHostException(String host)

 Constructs a new UnknownHostException with the  specified detail message.

Parameters:

 host - the detail message.

 UnknownHostException

  public UnknownHostException()

 Constructs a new UnknownHostException with no detail  message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.net.UnknownServiceException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.net.UnknownServiceException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.net.UnknownServiceException

______________________________________________________________________________

 public class UnknownServiceException

 extends IOException

Thrown to indicate that an unknown service exception has  occurred. Either the MIME type returned by a URL connection does  not make sense, or the application is attempting to write to a  read-only URL connection.

______________________________________________________________________________

 	UnknownServiceException()

 Constructs a new UnknownServiceException with no  detail message.

 	UnknownServiceException(String)

 Constructs a new UnknownServiceException with the  specified detail message.

 UnknownServiceException

  public UnknownServiceException()

 Constructs a new UnknownServiceException with no  detail message.

 UnknownServiceException

  public UnknownServiceException(String msg)

 Constructs a new UnknownServiceException with the  specified detail message.

Parameters:

 msg - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.net.URL

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.net.URL

java.lang.Object
   |
   +----java.net.URL

______________________________________________________________________________

 public final class URL

 extends Object

 implements Serializable

Class URL represents a Uniform Resource  Locator, a pointer to a "resource" on the World  Wide Web. A resource can be something as simple as a file or a  directory, or it can be a reference to a more complicated object,  such as a query to a database or to a search engine. More  information on the types of URLs and their formats can be found at:

  http://www.ncsa.uiuc.edu/demoweb/url-primer.html

 In general, a URL can be broken into several parts. The previous  example of a URL indicates that the protocol to use is  http  (HyperText Transport Protocol) and that the  information resides on a host machine named  www.ncsa.uiuc.edu. The information on that host  machine is named demoweb/url-primer.html. The exact  meaning of this name on the host machine is both protocol  dependent and host dependent. The information normally resides in  a file, but it could be generated on the fly. This component of  the URL is called the file component, even though the  information is not necessarily in a file.

 A URL can optionally specify a "port", which is the  port number to which the TCP connection is made on the remote host  machine. If the port is not specified, the default port for  the protocol is used instead. For example, the default port for  http is 80 . An alternative port could be  specified as:

  http://www.ncsa.uiuc.edu:8080/demoweb/url-primer.html

 A URL may have appended to it an "anchor", also known  as a "ref" or a "reference". The anchor is  indicated by the sharp sign character "#" followed by  more characters. For example,

  http://java.sun.com/index.html#chapter1

 This anchor is not technically part of the URL. Rather, it  indicates that after the specified resource is retrieved, the  application is specifically interested in that part of the  document that has the tag chapter1 attached to it. The  meaning of a tag is resource specific.

 An application can also specify a "relative URL",  which contains only enough information to reach the resource  relative to another URL. Relative URLs are frequently used within  HTML pages. For example, if the contents of the URL:

  http://java.sun.com/index.html

 contained within it the relative URL:

  FAQ.html

 it would be a shorthand for:

  http://java/sun.com/FAQ.html

 The relative URL need not specify all the components of a URL. If  the protocol, host name, or port number is missing, the value is  inherited from the fully specified URL. The file component must be  specified. The optional anchor is not inherited.

______________________________________________________________________________

 	URL(String)

 Creates a URL object from the String  representation.

 	URL(String, String, int, String)

 Creates a URL object from the specified  protocol, host, port  number, and file.

 	URL(String, String, String)

 Creates an absolute URL from the specified protocol  name, host name, and file name.

 	URL(URL, String)

 Creates a URL by parsing the specification spec  within a specified context.

 	equals(Object)

 Compares two URLs.

 	getContent()

 Returns the contents of this URL.

 	getFile()

 Returns the file name of this URL.

 	getHost()

 Returns the host name of this URL, if applicable.

 	getPort()

 Returns the port number of this URL.

 	getProtocol()

 Returns the protocol name this URL.

 	getRef()

 Returns the anchor (also known as the "reference") of this  URL.

 	hashCode()

 Creates an integer suitable for hash table indexing.

 	openConnection()

 Returns a URLConnection object that represents a  connection to the remote object referred to by the URL.

 	openStream()

 Opens a connection to this URL and returns an  InputStream  for reading from that connection.

 	sameFile(URL)

 Compares two URLs, excluding the "ref" fields.

 	set(String, String, int, String, String)

 Sets the fields of the URL.

 	setURLStreamHandlerFactory(URLStreamHandlerFactory)

 Sets an application's URLStreamHandlerFactory.

 	toExternalForm()

 Constructs a string representation of this URL.

 	toString()

 Constructs a string representation of this URL.

 URL

  public URL(String protocol,
             String host,
             int port,
             String file) throws MalformedURLException

 Creates a URL object from the specified  protocol, host, port  number, and file. Specifying a port  number of -1 indicates that the URL should use  the default port for the protocol.

 If this is the first URL object being created with the specified  protocol, a stream protocol handler object, an instance of  class URLStreamHandler , is created for that protocol:

1. If the application has previously set up an instance of  URLStreamHandlerFactory as the stream handler factory,  then the createURLStreamHandler  method of that instance  is called with the protocol string as an argument to create the  stream protocol handler.

2. If no URLStreamHandlerFactory has yet been set up,  or if the factory's createURLStreamHandler method  returns null, then the constructor finds the  value of the system property:

  java.handler.protol.pkgs

 If the value of that system property is not null,  it is interpreted as a list of packages separated by a vertical  slash character '| '. The constructor tries to load  the class named:

  <package>.<protocol>.Handler

 where <package> is replaced by the name of the package  and <protocol > is replaced by the name of the protocol.  If this class does not exist, or if the class exists but it is not  a subclass of URLStreamHandler, then the next package  in the list is tried.

3. If the previous step fails to find a protocol handler, then the  constructor tries to load the class named:

  sun.net.www.protocol.<protocol>.Handler

 If this class does not exist, or if the class exists but it is not a  subclass of URLStreamHandler, then a  MalformedURLException is thrown.

Parameters:

 protocol - the name of the protocol.

 host - the name of the host.

 port - the port number.

 file - the host file.

Throws: MalformedURLException

 if an unknown protocol is specified.

See Also:

getProperty, setURLStreamHandlerFactory, URLStreamHandler, createURLStreamHandler

 URL

  public URL(String protocol,
             String host,
             String file) throws MalformedURLException

 Creates an absolute URL from the specified protocol  name, host name, and file name. The  default port for the specified protocol is used.

 This method is equivalent to calling the four-argument  constructor with the arguments being protocol,  host, -1, and file.

Parameters:

 protocol - the protocol to use.

 host - the host to connect to.

 file - the file on that host.

Throws: MalformedURLException

 if an unknown protocol is specified.

See Also:

URL

 URL

  public URL(String spec) throws MalformedURLException

 Creates a URL object from the String  representation.

 This constructor is equivalent to a call to the two-argument  constructor with a null  first argument.

Parameters:

 spec - the String to parse as a URL.

Throws: MalformedURLException

 If the string specifies an  unknown protocol.

See Also:

URL

 URL

  public URL(URL context,
             String spec) throws MalformedURLException

 Creates a URL by parsing the specification spec  within a specified context. If the context argument  is not null and the spec argument is a  partial URL specification, then any of the strings missing  components are inherited from the context argument.

 The specification given by the String argument is  parsed to determine if it specifies a protocol. If the  String  contains an ASCII colon ':'  character before the first occurrence of an ASCII slash character  '/ ', then the characters before the colon comprise  the protocol.

• If the spec  argument does not specify a protocol:

• If the context argument is not null, then the  protocol is copied from the context argument.

• If the context argument is null, then a  MalformedURLException  is thrown.

• If the spec argument does specify a protocol:

• If the context argument is null, or specifies a   different protocol than the specification argument, the context  argument is ignored.

• If the context argument is not null and specifies  the same protocol as the specification, the host,  port number, and file are copied from  the context argument into the newly created URL.

 The constructor then searches for an appropriate stream protocol  handler of type URLStreamHandler as outlined for:

  java.net.URL#URL(java.lang.String, java.lang.String, int,  java.lang.String)

 The stream protocol handler's  parseURL method is called to parse the remaining  fields of the specification that override any defaults set by the  context argument.

Parameters:

 context - the context in which to parse the specification.

 spec - a String representation of a URL.

Throws: MalformedURLException

 if no protocol is specified, or an  unknown protocol is found.

See Also:

URL, URLStreamHandler, parseURL

 set

  protected void set(String protocol,
                     String host,
                     int port,
                     String file,
                     String ref)

 Sets the fields of the URL. This is not a public method so that  only URLStreamHandlers can modify URL fields. URLs are  otherwise constant.  REMIND: this method will be moved to URLStreamHandler

Parameters:

 protocol - the protocol to use

 host - the host name to connecto to

 port - the protocol port to connect to

 file - the specified file name on that host

 ref - the reference

 getPort

  public int getPort()

 Returns the port number of this URL.  Returns -1 if the port is not set.

Returns:

 the port number

 getProtocol

  public String getProtocol()

 Returns the protocol name this URL.

Returns:

 the protocol of this URL.

 getHost

  public String getHost()

 Returns the host name of this URL, if applicable.  For " file" protocol, this is an empty string.

Returns:

 the host name of this URL.

 getFile

  public String getFile()

 Returns the file name of this URL.

Returns:

 the file name of this URL.

 getRef

  public String getRef()

 Returns the anchor (also known as the "reference") of this  URL.

Returns:

 the anchor (also known as the "reference") of this  URL.

 equals

  public boolean equals(Object obj)

 Compares two URLs.  The result is true  if and only if the argument is  not null and is a URL object that  represents the same URL as this object. Two URL  objects are equal if they have the same protocol and reference the  same host, the same port number on the host, and the same file on  the host. The anchors of the URL objects are not compared.

 This method is equivalent to:

  (obj instanceof URL) && sameFile((URL)obj)

Parameters:

 obj - the URL to compare against.

Returns:

true if the objects are the same;  false otherwise.

Overrides:

equals in class Object

 hashCode

  public int hashCode()

 Creates an integer suitable for hash table indexing.

Returns:

 a hash code for this URL.

Overrides:

hashCode in class Object

 sameFile

  public boolean sameFile(URL other)

 Compares two URLs, excluding the "ref" fields.  Returns true  if this URL and the  other argument both refer to the same resource.  The two URLs might not both contain the same anchor.

Parameters:

 other - the URL to compare against.

Returns:

true if they reference the same remote object;  false otherwise.

 toString

  public String toString()

 Constructs a string representation of this URL. The  string is created by calling the toExternalForm  method of the stream protocol handler for this object.

Returns:

 a string representation of this object.

Overrides:

toString in class Object

See Also:

URL, toExternalForm

 toExternalForm

  public String toExternalForm()

 Constructs a string representation of this URL. The  string is created by calling the toExternalForm  method of the stream protocol handler for this object.

Returns:

 a string representation of this object.

See Also:

URL, toExternalForm

 openConnection

  public URLConnection openConnection() throws IOException

 Returns a URLConnection object that represents a  connection to the remote object referred to by the URL.

 If there is not already an open connection, the connection is  opened by calling the openConnection method of the  protocol handler for this URL.

Returns:

 a URLConnection to the URL.

Throws: IOException

 if an I/O exception occurs.

See Also:

URL, URLConnection, openConnection

 openStream

  public final InputStream openStream() throws IOException

 Opens a connection to this URL and returns an  InputStream for reading from that connection. This  method is a shorthand for:

  openConnection().getInputStream()

Returns:

 an input stream for reading from the URL connection.

Throws: IOException

 if an I/O exception occurs.

 getContent

  public final Object getContent() throws IOException

 Returns the contents of this URL. This method is a shorthand for:

  openConnection().getContent()

Returns:

 the contents of this URL.

Throws: IOException

 if an I/O exception occurs.

See Also:

getContent

 setURLStreamHandlerFactory

  public static synchronized void setURLStreamHandlerFactory(URLStreamHandlerFactory fac)

 Sets an application's URLStreamHandlerFactory.  This method can be called at most once by an application.

 The URLStreamHandlerFactory instance is used to  construct a stream protocol handler from a protocol name.

Parameters:

 fac - the desired factory.

Throws: Error

 if the application has already set a factory.

See Also:

URL, URLStreamHandlerFactory

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.net.URLConnection

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.net.URLConnection

java.lang.Object
   |
   +----java.net.URLConnection

______________________________________________________________________________

 public class URLConnection

 extends Object

The abstract class URLConnection is the superclass  of all classes that represent a communications link between the  application and a URL. Instances of this class can be used both to  read from and to write to the resource referenced by the URL. In  general, creating a connection to a URL is a multistep process:

openConnection()
connect()
Manipulate parameters that affect the connection to the remote  resource.
Interact with the resource; query header fields and  contents.
   ---------------------------->

time

1. The connection object is created by invoking the  openConnection method on a URL.

2. The setup parameters and general request properties are manipulated.

3. The actual connection to the remote object is made, using the  connect method.

4. The remote object becomes available. The header fields and the contents  of the remote object can be accessed.

 The setup parameters are modified using the following methods:

• setAllowUserInteraction

• setDoInput

• setDoOutput

• setIfModifiedSince

• setUseCaches

 and the general request properties are modified using the method:

• setRequestProperty

 Default values for the AllowUserInteraction and  UseCaches  parameters can be set using the methods  setDefaultAllowUserInteraction and  setDefaultUseCaches. Default values for general  request properties can be set using the  setDefaultRequestProperty method.

 Each of the above set methods has a corresponding  get  method to retrieve the value of the parameter or  general request property. The specific parameters and general  request properties that are applicable are protocol specific.

 The following methods are used to access the header fields and  the contents after the connection is made to the remote object:

• getContent

• getHeaderField

• getInputStream

• getOutputStream

 Certain header fields are accessed frequently. The methods:

• getContentEncoding

• getContentLength

• getContentType

• getDate

• getExpiration

• getLastModifed

 provide convenient access to these fields. The  getContentType method is used by the  getContent method to determine the type of the remote  object; subclasses may find it convenient to override the  getContentType method.

 In the common case, all of the pre-connection parameters and  general request properties can be ignored: the pre-connection  parameters and request properties default to sensible values. For  most clients of this interface, there are only two interesting  methods: getInputStream  and getObject,  which are mirrored in the URL  class by convenience methods.

 More information on the request properties and header fields of  an http  connection can be found at:

  http://www.w3.org/hypertext/WWW/Protocols/HTTP1.0/draft-ietf-http-spec.html

See Also:

openConnection, connect, getContent, getContentEncoding, getContentLength, getContentType, getDate, getExpiration , getHeaderField, getHeaderField, getInputStream, getLastModified , getOutputStream, setAllowUserInteraction, setDefaultRequestProperty , setDefaultUseCaches, setDoInput, setDoOutput, setIfModifiedSince , setRequestProperty, setUseCaches

______________________________________________________________________________

 	allowUserInteraction

 If true, this URL is being examined in  a context in which it makes sense to allow user interactions such  as popping up an authentication dialog.

 	connected

 If false, this connection object has not created a  communications link to the specified URL.

 	doInput

 This variable is set by the setDoInput method.

 	doOutput

 This variable is set by the setDoOutput method.

 	fileNameMap

  	ifModifiedSince

 Some protocols support skipping the fetching of the object unless  the object has been modified more recently than a certain time.

 	url

 The URL represents the remote object on the World Wide Web to  which this connection is opened.

 	useCaches

 If true, the protocol is allowed to use caching  whenever it can.

 	URLConnection(URL)

 Constructs a URL connection to the specified URL.

 	connect()

 Opens a communications link to the resource referenced by this  URL, if such a connection has not already been established.

 	getAllowUserInteraction()

 Returns the value of the allowUserInteraction field for  this object.

 	getContent()

 Retrieves the contents of this URL connection.

 	getContentEncoding()

 Returns the value of the content-encoding header field.

 	getContentLength()

 Returns the value of the content-length header field.

 	getContentType()

 Returns the value of the content-type header field.

 	getDate()

 Returns the value of the date header field.

 	getDefaultAllowUserInteraction()

 Returns the default value of the allowUserInteraction  field.

 	getDefaultRequestProperty(String)

 Returns the value of the default request property.

 	getDefaultUseCaches()

 Returns the default value of a URLConnection's  useCaches flag.

 	getDoInput()

 Returns the value of this URLConnection's  doInput flag.

 	getDoOutput()

 Returns the value of this URLConnection's  doOutput flag.

 	getExpiration()

 Returns the value of the expires header field.

 	getHeaderField(int)

 Returns the value for the nth header field.

 	getHeaderField(String)

 Returns the name of the specified header field.

 	getHeaderFieldDate(String, long)

 Returns the value of the named field parsed as date.

 	getHeaderFieldInt(String, int)

 Returns the value of the named field parsed as a number.

 	getHeaderFieldKey(int)

 Returns the key for the nth header field.

 	getIfModifiedSince()

 Returns the value of this object's ifModifiedSince field.

 	getInputStream()

 Returns an input stream that reads from this open connection.

 	getLastModified()

 Returns the value of the last-modified header field.

 	getOutputStream()

 Returns an output stream that writes to this connection.

 	getRequestProperty(String)

 Returns the value of the named general request property for this  connection.

 	getURL()

 Returns the value of this URLConnection's URL  field.

 	getUseCaches()

 Returns the value of this URLConnection's  useCaches field.

 	guessContentTypeFromName(String)

 Tries to determine the content type of an object, based  on the specified "file" component of a URL.

 	guessContentTypeFromStream(InputStream)

 Tries to determine the type of an input stream based on the  characters at the beginning of the input stream.

 	setAllowUserInteraction(boolean)

 Set the value of the allowUserInteraction field of  this URLConnection.

 	setContentHandlerFactory(ContentHandlerFactory)

 Sets the ContentHandlerFactory of an  application.

 	setDefaultAllowUserInteraction(boolean)

 Sets the default value of the  allowUserInteraction field for all future  URLConnection objects to the specified value.

 	setDefaultRequestProperty(String, String)

 Sets the default value of a general request property.

 	setDefaultUseCaches(boolean)

 Sets the default value of the useCaches field to the  specified value.

 	setDoInput(boolean)

 Sets the value of the doInput field for this  URLConnection  to the specified value.

 	setDoOutput(boolean)

 Sets the value of the doOutput field for this  URLConnection  to the specified value.

 	setIfModifiedSince(long)

 Sets the value of the ifModifiedSince field of  this URLConnection  to the specified value.

 	setRequestProperty(String, String)

 Sets the general request property.

 	setUseCaches(boolean)

 Sets the value of the useCaches field of this  URLConnection  to the specified value.

 	toString()

 Returns a String representation of this URL connection.

 url

  protected URL url

 The URL represents the remote object on the World Wide Web to  which this connection is opened.

 The value of this field can be accessed by the  getURL method.

 The default value of this variable is the value of the URL  argument in the URLConnection constructor.

See Also:

getURL, url

 doInput

  protected boolean doInput

 This variable is set by the setDoInput method. Its  value is returned by the getDoInput method.

 A URL connection can be used for input and/or output. Setting the  doInput flag to true indicates that  the application intends to read data from the URL connection.

 The default value of this field is true.

See Also:

getDoInput, setDoInput

 doOutput

  protected boolean doOutput

 This variable is set by the setDoOutput method. Its  value is returned by the getDoInput method.

 A URL connection can be used for input and/or output. Setting the  doOutput flag to true indicates  that the application intends to write data to the URL connection.

 The default value of this field is false.

See Also:

getDoOutput, setDoOutput

 allowUserInteraction

  protected boolean allowUserInteraction

 If true, this URL is being examined in  a context in which it makes sense to allow user interactions such  as popping up an authentication dialog. If false,  then no user interaction is allowed.

 The value of this field can be set by the  setAllowUserInteraction method.  Its value is returned by the  getAllowUserInteraction method.  Its default value is the value of the argument in the last invocation  of the setDefaultAllowUserInteraction method.

See Also:

getAllowUserInteraction, setAllowUserInteraction, setDefaultAllowUserInteraction

 useCaches

  protected boolean useCaches

 If true, the protocol is allowed to use caching  whenever it can. If false, the protocol must always  try to get a fresh copy of the object.

 This field is set by the setUseCaches method. Its  value is returned by the getUseCaches method.

 Its default value is the value given in the last invocation of the  setDefaultUseCaches  method.

See Also:

setUseCaches, getUseCaches, setDefaultUseCaches

 ifModifiedSince

  protected long ifModifiedSince

 Some protocols support skipping the fetching of the object unless  the object has been modified more recently than a certain time.

 A nonzero value gives a time as the number of seconds since  January 1, 1970, GMT. The object is fetched only if it has been  modified more recently than that time.

 This variable is set by the setIfModifiedSince  method. Its value is returned by the  getIfModifiedSince method.

 The default value of this field is 0, indicating  that the fetching must always occur.

See Also:

getIfModifiedSince, setIfModifiedSince

 fileNameMap

  public static FileNameMap fileNameMap

 connected

  protected boolean connected

 If false, this connection object has not created a  communications link to the specified URL. If true,  the communications link has been established.

 URLConnection

  protected URLConnection(URL url)

 Constructs a URL connection to the specified URL. A connection to  the object referenced by the URL is not created.

Parameters:

 url - the specified URL.

 connect

  public abstract void connect() throws IOException

 Opens a communications link to the resource referenced by this  URL, if such a connection has not already been established.

 If the connect method is called when the connection  has already been opened (indicated by the connected  field having the value true), the call is ignored.

 URLConnection objects go through two phases: first they are  created, then they are connected. After being created, and  before being connected, various options can be specified  (e.g., doInput and UseCaches). After connecting, it is an  error to try to set them. Operations that depend on being  connected, like getContentLength, will implicitly perform the  connection, if necessary.

Throws: IOException

 if an I/O error occurs while opening the  connection.

See Also:

connected

 getURL

  public URL getURL()

 Returns the value of this URLConnection's URL  field.

Returns:

 the value of this URLConnection's URL  field.

See Also:

url

 getContentLength

  public int getContentLength()

 Returns the value of the content-length header field.

Returns:

 the content length of the resource that this connection's URL  references, or -1  if the content length is  not known.

 getContentType

  public String getContentType()

 Returns the value of the content-type header field.

Returns:

 the content type of the resource that the URL references,  or null if not known.

See Also:

getHeaderField

 getContentEncoding

  public String getContentEncoding()

 Returns the value of the content-encoding header field.

Returns:

 the content encoding of the resource that the URL references,  or null if not known.

See Also:

getHeaderField

 getExpiration

  public long getExpiration()

 Returns the value of the expires header field.

Returns:

 the expiration date of the resource that this URL references,  or 0 if not known. The value is the number of seconds since  January 1, 1970 GMT.

See Also:

getHeaderField

 getDate

  public long getDate()

 Returns the value of the date header field.

Returns:

 the sending date of the resource that the URL references,  or 0  if not known. The value returned is the  number of seconds since January 1, 1970 GMT.

See Also:

getHeaderField

 getLastModified

  public long getLastModified()

 Returns the value of the last-modified header field.  The result is the number of seconds since January 1, 1970 GMT.

Returns:

 the date the resource referenced by this  URLConnection  was last modified, or 0 if not known.

See Also:

getHeaderField

 getHeaderField

  public String getHeaderField(String name)

 Returns the name of the specified header field.

Parameters:

 name - the name of a header field.

Returns:

 the value of the named header field, or null  if there is no such field in the header.

 getHeaderFieldInt

  public int getHeaderFieldInt(String name,
                               int Default)

 Returns the value of the named field parsed as a number.

 This form of getHeaderField exists because some  connection types (e.g., http-ng) have pre-parsed  headers. Classes for that connection type can override this method  and short-circuit the parsing.

Parameters:

 name - the name of the header field.

 Default - the default value.

Returns:

 the value of the named field, parsed as an integer. The  Default  value is returned if the field is  missing or malformed.

 getHeaderFieldDate

  public long getHeaderFieldDate(String name,
                                 long Default)

 Returns the value of the named field parsed as date.  The result is the number of seconds since January 1, 1970 GMT  represented by the named field.

 This form of getHeaderField exists because some  connection types (e.g., http-ng) have pre-parsed  headers. Classes for that connection type can override this method  and short-circuit the parsing.

Parameters:

 name - the name of the header field.

 Default - a default value.

Returns:

 the value of the field, parsed as a date. The value of the  Default  argument is returned if the field is  missing or malformed.

 getHeaderFieldKey

  public String getHeaderFieldKey(int n)

 Returns the key for the nth header field.

Parameters:

 n - an index.

Returns:

 the key for the nth header field,  or null if there are fewer than n  fields.

 getHeaderField

  public String getHeaderField(int n)

 Returns the value for the nth header field.  It returns null if there are fewer than  n fields.

 This method can be used in conjunction with the  getHeaderFieldKey  method to iterate through all  the headers in the message.

Parameters:

 n - an index.

Returns:

 the value of the nth header field.

See Also:

getHeaderFieldKey

 getContent

  public Object getContent() throws IOException

 Retrieves the contents of this URL connection.

 This method first determines the content type of the object by  calling the getContentType method. If this is  the first time that the application has seen that specific content  type, a content handler for that content type is created:

1. If the application has set up a content handler factory instance  using the setContentHandlerFactory method, the  createContentHandler  method of that instance is called  with the content type as an argument; the result is a content  handler for that content type.

2. If no content handler factory has yet been set up, or if the  factory's createContentHandler method returns  null, then the application loads the class named:

  sun.net.www.content.<contentType>

 where <contentType> is formed by taking the  content-type string, replacing all slash characters with a  period  ('.'), and all other non-alphanumeric characters  with the underscore character '_ '. The alphanumeric  characters are specifically the 26 uppercase ASCII letters  'A ' through 'Z', the 26 lowercase ASCII  letters 'a' through 'z ', and the 10 ASCII  digits '0' through '9'. If the specified  class does not exist, or is not a subclass of  ContentHandler, then an  UnknownServiceException is thrown.

Returns:

 the object fetched. The instanceOf operation  should be used to determine the specific kind of object  returned.

Throws: IOException

 if an I/O error occurs while  getting the content.

Throws: UnknownServiceException

 if the protocol does not support  the content type.

See Also:

createContentHandler, getContentType, setContentHandlerFactory

 getInputStream

  public InputStream getInputStream() throws IOException

 Returns an input stream that reads from this open connection.

Returns:

 an input stream that reads from this open connection.

Throws: IOException

 if an I/O error occurs while  creating the input stream.

Throws: UnknownServiceException

 if the protocol does not support  input.

 getOutputStream

  public OutputStream getOutputStream() throws IOException

 Returns an output stream that writes to this connection.

Returns:

 an output stream that writes to this connection.

Throws: IOException

 if an I/O error occurs while  creating the output stream.

Throws: UnknownServiceException

 if the protocol does not support  output.

 toString

  public String toString()

 Returns a String representation of this URL connection.

Returns:

 a string representation of this URLConnection.

Overrides:

toString in class Object

 setDoInput

  public void setDoInput(boolean doinput)

 Sets the value of the doInput field for this  URLConnection to the specified value.

 A URL connection can be used for input and/or output. Set the DoInput  flag to true if you intend to use the URL connection for input,  false if not. The default is true unless DoOutput is explicitly  set to true, in which case DoInput defaults to false.

Parameters:

 value - the new value.

See Also:

doInput

 getDoInput

  public boolean getDoInput()

 Returns the value of this URLConnection's  doInput flag.

Returns:

 the value of this URLConnection's  doInput flag.

See Also:

doInput

 setDoOutput

  public void setDoOutput(boolean dooutput)

 Sets the value of the doOutput field for this  URLConnection to the specified value.

 A URL connection can be used for input and/or output. Set the DoOutput  flag to true if you intend to use the URL connection for output,  false if not. The default is false.

Parameters:

 value - the new value.

See Also:

doOutput

 getDoOutput

  public boolean getDoOutput()

 Returns the value of this URLConnection's  doOutput flag.

Returns:

 the value of this URLConnection's  doOutput flag.

See Also:

doOutput

 setAllowUserInteraction

  public void setAllowUserInteraction(boolean allowuserinteraction)

 Set the value of the allowUserInteraction field of  this URLConnection.

Parameters:

 allowuserinteraction - the new value.

See Also:

allowUserInteraction

 getAllowUserInteraction

  public boolean getAllowUserInteraction()

 Returns the value of the allowUserInteraction field for  this object.

Returns:

 the value of the allowUserInteraction field for  this object.

See Also:

allowUserInteraction

 setDefaultAllowUserInteraction

  public static void setDefaultAllowUserInteraction(boolean defaultallowuserinteraction)

 Sets the default value of the  allowUserInteraction  field for all future  URLConnection objects to the specified value.

Parameters:

 defaultallowuserinteraction - the new value.

See Also:

allowUserInteraction

 getDefaultAllowUserInteraction

  public static boolean getDefaultAllowUserInteraction()

 Returns the default value of the allowUserInteraction  field.

 Ths default is "sticky", being a part of the static state of all  URLConnections. This flag applies to the next, and all following  URLConnections that are created.

Returns:

 the default value of the allowUserInteraction  field.

See Also:

allowUserInteraction

 setUseCaches

  public void setUseCaches(boolean usecaches)

 Sets the value of the useCaches field of this  URLConnection to the specified value.

 Some protocols do caching of documents. Occasionally, it is important  to be able to "tunnel through" and ignore the caches (e.g., the  "reload" button in a browser). If the UseCaches flag on a connection  is true, the connection is allowed to use whatever caches it can.  If false, caches are to be ignored.  The default value comes from DefaultUseCaches, which defaults to  true.

See Also:

useCaches

 getUseCaches

  public boolean getUseCaches()

 Returns the value of this URLConnection's  useCaches field.

Returns:

 the value of this URLConnection's  useCaches field.

See Also:

useCaches

 setIfModifiedSince

  public void setIfModifiedSince(long ifmodifiedsince)

 Sets the value of the ifModifiedSince field of  this URLConnection to the specified value.

Parameters:

 value - the new value.

See Also:

ifModifiedSince

 getIfModifiedSince

  public long getIfModifiedSince()

 Returns the value of this object's ifModifiedSince field.

Returns:

 the value of this object's ifModifiedSince field.

See Also:

ifModifiedSince

 getDefaultUseCaches

  public boolean getDefaultUseCaches()

 Returns the default value of a URLConnection's  useCaches flag.

 Ths default is "sticky", being a part of the static state of all  URLConnections. This flag applies to the next, and all following  URLConnections that are created.

Returns:

 the default value of a URLConnection's  useCaches flag.

See Also:

useCaches

 setDefaultUseCaches

  public void setDefaultUseCaches(boolean defaultusecaches)

 Sets the default value of the useCaches field to the  specified value.

Parameters:

 defaultusecaches - the new value.

See Also:

useCaches

 setRequestProperty

  public void setRequestProperty(String key,
                                 String value)

 Sets the general request property.

Parameters:

 key - the keyword by which the request is known  (e.g., "accept").

 value - the value associated with it.

 getRequestProperty

  public String getRequestProperty(String key)

 Returns the value of the named general request property for this  connection.

Returns:

 the value of the named general request property for this  connection.

 setDefaultRequestProperty

  public static void setDefaultRequestProperty(String key,
                                               String value)

 Sets the default value of a general request property. When a  URLConnection is created, it is initialized with  these properties.

Parameters:

 key - the keyword by which the request is known  (e.g., "accept").

 value - the value associated with the key.

 getDefaultRequestProperty

  public static String getDefaultRequestProperty(String key)

 Returns the value of the default request property. Default request  properties are set for every connection.

Returns:

 the value of the default request property for the specified key.

See Also:

setDefaultRequestProperty

 setContentHandlerFactory

  public static synchronized void setContentHandlerFactory(ContentHandlerFactory fac)

 Sets the ContentHandlerFactory of an  application. It can be called at most once by an application.

 The ContentHandlerFactory instance is used to  construct a content handler from a content type

Parameters:

 fac - the desired factory.

Throws: Error

 if the factory has already been defined.

See Also:

ContentHandlerFactory, getContent

 guessContentTypeFromName

  protected static String guessContentTypeFromName(String fname)

 Tries to determine the content type of an object, based  on the specified "file" component of a URL.  This is a convenience method that can be used by  subclasses that override the getContentType method.

Parameters:

 fname - a filename.

Returns:

 a guess as to what the content type of the object is,  based upon its file name.

See Also:

getContentType

 guessContentTypeFromStream

  public static String guessContentTypeFromStream(InputStream is) throws IOException

 Tries to determine the type of an input stream based on the  characters at the beginning of the input stream. This method can  be used by subclasses that override the  getContentType method.

 Ideally, this routine would not be needed. But many  http  servers return the incorrect content type; in  addition, there are many nonstandard extensions. Direct inspection  of the bytes to determine the content type is often more accurate  than believing the content type claimed by the http server.

Parameters:

 is - an input stream that supports marks.

Returns:

 a guess at the content type, or null if none  can be determined.

Throws: IOException

 if an I/O error occurs while reading the  input stream.

See Also:

mark, markSupported, getContentType

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.net.URLEncoder

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.net.URLEncoder

java.lang.Object
   |
   +----java.net.URLEncoder

______________________________________________________________________________

 public class URLEncoder

 extends Object

The class contains a utility method for converting a  String into a MIME format called  "x-www-form-urlencoded" format.

 To convert a String, each character is examined in turn:

• The ASCII characters 'a' through 'z ',  'A' through 'Z', and '0'  through '9 ' remain the same.

• The space character ' ' is converted into a  plus sign '+'.

• All other characters are converted into the 3-character string  "% xy", where xy is the two-digit  hexadecimal representation of the lower 8-bits of the character.

______________________________________________________________________________

 	encode(String)

 Translates a string into x-www-form-urlencoded format.

 encode

  public static String encode(String s)

 Translates a string into x-www-form-urlencoded format.

Parameters:

 s - String to be translated.

Returns:

 the translated String.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.net.URLStreamHandler

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.net.URLStreamHandler

java.lang.Object
   |
   +----java.net.URLStreamHandler

______________________________________________________________________________

 public class URLStreamHandler

 extends Object

The abstract class URLStreamHandler is the common  superclass for all stream protocol handlers. A stream protocol  handler knows how to make a connection for a particular protocol  type, such as http, ftp, or  gopher.

 In most cases, an instance of a URLStreamHandler  subclass is not created directly by an application. Rather, the  first time a protocol name is encountered when constructing a  URL , the appropriate stream protocol handler is  automatically loaded.

See Also:

URL

______________________________________________________________________________

 	URLStreamHandler()

 	openConnection(URL)

 Opens a connection to the object referenced by the  URL argument.

 	parseURL(URL, String, int, int)

 Parses the string representation of a URL into a  URL object.

 	setURL(URL, String, String, int, String, String)

 Sets the fields of the URL argument to the indicated values.

 	toExternalForm(URL)

 Converts a URL of a specific protocol to a  String.

 URLStreamHandler

  public URLStreamHandler()

 openConnection

  protected abstract URLConnection openConnection(URL u) throws IOException

 Opens a connection to the object referenced by the  URL  argument.  This method should be overridden by a subclass.

Parameters:

 u - the URL that this connects to.

Returns:

 a URLConnection object for the URL.

Throws: IOException

 if an I/O error occurs while opening the  connection.

 parseURL

  protected void parseURL(URL u,
                          String spec,
                          int start,
                          int limit)

 Parses the string representation of a URL into a  URL object.

 If there is any inherited context, then it has already been  copied into the URL  argument.

 The parseURL method of URLStreamHandler  parses the string representation as if it were an  http  specification. Most URL protocol families have a  similar parsing. A stream protocol handler for a protocol that has  a different syntax must override this routine.

Parameters:

 u - the URL to receive the result of parsing  the spec.

 spec - the String representing the URL that  must be parsed.

 start - the character index at which to begin parsing. This is  just past the ': ' (if there is one) that  specifies the determination of the protocol name.

 limit - the character position to stop parsing at. This is the  end of the string or the position of the  "#" character, if present. All information  after the sharp sign indicates an anchor.

 toExternalForm

  protected String toExternalForm(URL u)

 Converts a URL of a specific protocol to a  String.

Parameters:

 u - the URL.

Returns:

 a string representation of the URL argument.

 setURL

  protected void setURL(URL u,
                        String protocol,
                        String host,
                        int port,
                        String file,
                        String ref)

 Sets the fields of the URL  argument to the indicated values.  Only classes derived from URLStreamHandler are supposed to be able  to call the set method on a URL.

Parameters:

 u - the URL to modify.

 protocol - the protocol name.

 host - the remote host value for the URL.

 port - the port on the remote machine.

 file - the file.

 ref - the reference.

See Also:

set

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.net.URLStreamHandlerFactory

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.net.URLStreamHandlerFactory

 public interface URLStreamHandlerFactory

This interface defines a factory for URL stream  protocol handlers.

 It is used by the URL class to create a  URLStreamHandler  for a specific protocol.

See Also:

URL, URLStreamHandler

______________________________________________________________________________

 	createURLStreamHandler(String)

 Creates a new URLStreamHandler instance with the specified  protocol.

 createURLStreamHandler

  public abstract URLStreamHandler createURLStreamHandler(String protocol)

 Creates a new URLStreamHandler instance with the specified  protocol.

Parameters:

 protocol - the protocol ("ftp",  "http", "nntp", etc.).

Returns:

 a URLStreamHandler for the specific protocol.

See Also:

 URLStreamHandler

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.AccessException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.AccessException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.rmi.RemoteException
                                   |
                                   +----java.rmi.AccessException

______________________________________________________________________________

 public class AccessException

 extends RemoteException

______________________________________________________________________________

 	AccessException(String)

 Create a new AccessException with a description.

 	AccessException(String, Exception)

 Create a new AccessException with a description and detail exception.

 AccessException

  public AccessException(String s)

 Create a new AccessException with a description.

 AccessException

  public AccessException(String s,
                         Exception ex)

 Create a new AccessException with a description and detail exception.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.AlreadyBoundException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.AlreadyBoundException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.rmi.AlreadyBoundException

______________________________________________________________________________

 public class AlreadyBoundException

 extends Exception

______________________________________________________________________________

 	AlreadyBoundException()

  	AlreadyBoundException (String)

 AlreadyBoundException

  public AlreadyBoundException()

 AlreadyBoundException

  public AlreadyBoundException(String s)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.ConnectException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.ConnectException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.rmi.RemoteException
                                   |
                                   +----java.rmi.ConnectException

______________________________________________________________________________

 public class ConnectException

 extends RemoteException

______________________________________________________________________________

 	ConnectException(String)

 Create A remote exception with the specified string

 	ConnectException(String, Exception)

 Create A remote exception with the specified string, and the  exception specified.

 ConnectException

  public ConnectException(String s)

 Create A remote exception with the specified string

 ConnectException

  public ConnectException(String s,
                          Exception ex)

 Create A remote exception with the specified string, and the  exception specified.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.ConnectIOException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.ConnectIOException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.rmi.RemoteException
                                   |
                                   +----java.rmi.ConnectIOException

______________________________________________________________________________

 public class ConnectIOException

 extends RemoteException

______________________________________________________________________________

 	ConnectIOException(String)

 Create A remote exception with the specified string

 	ConnectIOException(String, Exception)

 Create A remote exception with the specified string, and the  exception specified.

 ConnectIOException

  public ConnectIOException(String s)

 Create A remote exception with the specified string

 ConnectIOException

  public ConnectIOException(String s,
                            Exception ex)

 Create A remote exception with the specified string, and the  exception specified.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.rmi.dgc.DGC

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Interface java.rmi.dgc.DGC

 public interface DGC

 extends Remote

The DGC abstraction is used for the server side of the distributed  garbage collection algorithm. This interface contains the two  methods: dirty and clean. A dirty call is made when a remote  reference is unmarshaled in a client (the client is indicated by  its VMID). A corresponding clean call is made when no more  references to the remote reference exist in the client. A failed  dirty call must schedule a strong clean call so that the call's  sequence number can be retained in order to detect future calls  received out of order by the distributed garbage collector.  A reference to a remote object is leased for a period of time by  the client holding the reference. The lease period starts when the  dirty call is received. It is the client's responsibility to renew  the leases, by making additional dirty calls, on the remote  references it holds before such leases expire. If the client does  not renew the lease before it expires, the distributed garbage  collector assumes that the remote object is no longer referenced by  that client.

______________________________________________________________________________

 	clean(ObjID[], long, VMID, boolean)

 The clean call removes the 'vmid' from the reference list of  each remote object indicated in 'id's.

 	dirty(ObjID[], long, Lease)

 The dirty call requests leases for the remote object references  associated with the object identifiers contained in the array  'ids'.

 dirty

  public abstract Lease dirty(ObjID ids[],
                              long sequenceNum,
                              Lease lease) throws RemoteException

 The dirty call requests leases for the remote object references  associated with the object identifiers contained in the array  'ids'. The 'lease' contains a client's unique VM identifier (VMID)  and a requested lease period. For each remote object exported  in the local VM, the garbage collector maintains a reference  list-a list of clients that hold references to it. If the lease  is granted, the garbage collector adds the client's VMID to the  reference list for each remote object indicated in 'ids'. The  'sequenceNum' parameter is a sequence number that is used to  detect and discard late calls to the garbage collector. The  sequence number should always increase for each subsequent call  to the garbage collector.  Some clients are unable to generate a VMID, since a VMID is a  universally unique identifier that contains a host address  which some clients are unable to obtain due to security  restrictions. In this case, a client can use a VMID of null,  and the distributed garbage collector will assign a VMID for  the client.  The dirty call returns a Lease object that contains the VMID  used and the lease period granted for the remote references (a  server may decide to grant a smaller lease period than the  client requests). A client must use the VMID the garbage  collector uses in order to make corresponding clean calls when  the client drops remote object references.  A client VM need only make one initial dirty call for each  remote reference referenced in the VM (even if it has multiple  references to the same remote object). The client must also  make a dirty call to renew leases on remote references before  such leases expire. When the client no longer has any  references to a specific remote object, it must schedule a  clean call for the object ID associated with the reference.

 clean

  public abstract void clean(ObjID ids[],
                             long sequenceNum,
                             VMID vmid,
                             boolean strong) throws RemoteException

 The clean call removes the 'vmid' from the reference list of  each remote object indicated in 'id's. The sequence number is  used to detect late clean calls. If the argument 'strong' is  true, then the clean call is a result of a failed dirty call,  thus the sequence number for the client 'vmid' needs to be  remembered.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.dgc.Lease

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.dgc.Lease

java.lang.Object
   |
   +----java.rmi.dgc.Lease

______________________________________________________________________________

 public final class Lease

 extends Object

 implements Serializable

A lease contains a unique VM identifier and a lease duration. A  Lease object is used to request and grant leases to remote object  references.

______________________________________________________________________________

 	Lease(VMID, long)

 Constructs a lease with a specific VMID and lease duration.

 	getValue()

 Returns the lease duration.

 	getVMID()

 Returns the client VMID associated with the lease.

 Lease

  public Lease(VMID id,
               long duration)

 Constructs a lease with a specific VMID and lease duration. The  vmid may be null.

 getVMID

  public VMID getVMID()

 Returns the client VMID associated with the lease.

 getValue

  public long getValue()

 Returns the lease duration.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.dgc.VMID

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.dgc.VMID

java.lang.Object
   |
   +----java.rmi.dgc.VMID

______________________________________________________________________________

 public final class VMID

 extends Object

 implements Serializable

A VMID is a identifier that is unique across all Java virtual  machines. VMIDs are used by the distributed garbage collector  to identify client VMs.

______________________________________________________________________________

 	VMID()

 Create a new VMID.

 	equals(Object)

 Compare this VMID to another, and return true if they are the  same identifier.

 	hashCode()

 Compute hash code for this VMID.

 	isUnique()

 Return true if an accurate address can be determined for this  host.

 	toString()

 Return string representation of this VMID.

 VMID

  public VMID()

 Create a new VMID. Each new VMID returned from this constructor  is unique for all Java virtual machines under the following  conditions: a) the conditions for uniqueness for objects of  the class java.rmi.server.UID are satisfied, and b) an  address can be obtained for this host that is unique and constant  for the lifetime of this object.

 The static method isUnique can be invoked to determine  if an accurate address can be obtained for this host.

 isUnique

  public static boolean isUnique()

 Return true if an accurate address can be determined for this  host. If false, reliable VMID cannot be generated from this host

Returns:

 true if host address can be determined, false otherwise

 hashCode

  public int hashCode()

 Compute hash code for this VMID.

Overrides:

hashCode in class Object

 equals

  public boolean equals(Object obj)

 Compare this VMID to another, and return true if they are the  same identifier.

Overrides:

equals in class Object

 toString

  public String toString()

 Return string representation of this VMID.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.MarshalException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.MarshalException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.rmi.RemoteException
                                   |
                                   +----java.rmi.MarshalException

______________________________________________________________________________

 public class MarshalException

 extends RemoteException

______________________________________________________________________________

 	MarshalException(String)

 Create a new marshal exception with a descriptive string.

 	MarshalException(String, Exception)

 Create a new marshal exception with a descriptive string and an  exception.

 MarshalException

  public MarshalException(String s)

 Create a new marshal exception with a descriptive string.

 MarshalException

  public MarshalException(String s,
                          Exception ex)

 Create a new marshal exception with a descriptive string and an  exception.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.Naming

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.Naming

java.lang.Object
   |
   +----java.rmi.Naming

______________________________________________________________________________

 public final class Naming

 extends Object

This is the bootstrap mechanism for obtaining references to remote  objects based on Uniform Resource Locator (URL) syntax. The URL  for a remote object is specified using the usual host, port and  name:
rmi://host:port/name
host = host name of registry (defaults to current host)
port = port number of registry (defaults to the registry port number)
 name = name for remote object

______________________________________________________________________________

 	bind(String, Remote)

 Binds the name to the specified remote object.

 	list(String)

 Returns an array of strings of the URLs in the registry.

 	lookup(String)

 Returns the remote object for the URL.

 	rebind(String, Remote)

 Rebind the name to a new object; replaces any existing binding.

 	unbind(String)

 Unbind the name.

 lookup

  public static Remote lookup(String name) throws NotBoundException, MalformedURLException, UnknownHostException, RemoteException

 Returns the remote object for the URL.

Throws: RemoteException

 If registry could not be contacted.

Throws: NotBoundException

 If name is not currently bound.

 bind

  public static void bind(String name,
                          Remote obj) throws AlreadyBoundException, MalformedURLException, UnknownHostException, RemoteException

 Binds the name to the specified remote object.

Throws: RemoteException

 If registry could not be contacted.

Throws: AlreadyBoundException

 If name is already bound.

 unbind

  public static void unbind(String name) throws RemoteException, NotBoundException, MalformedURLException, UnknownHostException

 Unbind the name.

Throws: RemoteException

 If registry could not be contacted.

Throws: NotBoundException

 If name is not currently bound.

 rebind

  public static void rebind(String name,
                            Remote obj) throws RemoteException, MalformedURLException, UnknownHostException

 Rebind the name to a new object; replaces any existing binding.

Throws: RemoteException

 If registry could not be contacted.

 list

  public static String[] list(String name) throws RemoteException, MalformedURLException, UnknownHostException

 Returns an array of strings of the URLs in the registry.  The array contains a snapshot of the names present in the registry.

Throws: RemoteException

 If registry could not be contacted.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.NoSuchObjectException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.NoSuchObjectException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.rmi.RemoteException
                                   |
                                   +----java.rmi.NoSuchObjectException

______________________________________________________________________________

 public class NoSuchObjectException

 extends RemoteException

______________________________________________________________________________

 	NoSuchObjectException(String)

 Create a new NoSuchObjectException with a description.

 NoSuchObjectException

  public NoSuchObjectException(String s)

 Create a new NoSuchObjectException with a description.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.NotBoundException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.NotBoundException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.rmi.NotBoundException

______________________________________________________________________________

 public class NotBoundException

 extends Exception

______________________________________________________________________________

 	NotBoundException()

  	NotBoundException(String)

 NotBoundException

  public NotBoundException()

 NotBoundException

  public NotBoundException(String s)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.registry.LocateRegistry

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class java.rmi.registry.LocateRegistry

java.lang.Object
   |
   +----java.rmi.registry.LocateRegistry

______________________________________________________________________________

 public final class LocateRegistry

 extends Object

This class is used to obtain the bootstrap Registry on a particular  host (including your local host). The following example demonstrates usage  (minus exception handling):
 Server wishes to make itself available to others:
 SomeService service = ...; // remote object for service
 Registry registry = LocateRegistry.getRegistry();
 registry.bind("I Serve", service);
 The client wishes to make requests of the above service:
 Registry registry = LocateRegistry.getRegistry("foo.services.com");
 SomeService service = (SomeService)registry.lookup("I Serve");
 service.requestService(...);

See Also:

Registry

______________________________________________________________________________

 	createRegistry(int)

 Create and export a registry on the local host.

 	getRegistry()

 Returns the remote object Registry for the local host.

 	getRegistry(int)

 Returns the remote object Registry on the current host at the  specified port.

 	getRegistry(String)

 Returns the remote object Registry on the specified host at a  default (i.e., well-known) port number.

 	getRegistry(String, int)

 Returns the remote object Registry on the specified host at the  specified port.

 getRegistry

  public static Registry getRegistry() throws RemoteException

 Returns the remote object Registry for the local host.

 getRegistry

  public static Registry getRegistry(int port) throws RemoteException

 Returns the remote object Registry on the current host at the  specified port.

 getRegistry

  public static Registry getRegistry(String host) throws RemoteException , UnknownHostException

 Returns the remote object Registry on the specified host at a  default (i.e., well-known) port number. If the host  String reference is null, the local  host is used.

 getRegistry

  public static Registry getRegistry(String host,
                                     int port) throws RemoteException, UnknownHostException

 Returns the remote object Registry on the specified host at the  specified port. If port String reference is  null, the local host is used.

Throws: UnknownHostException

 If the host is not known.

 createRegistry

  public static Registry createRegistry(int port) throws RemoteException

 Create and export a registry on the local host.

Parameters:

 port - the port on which the registry is to be exported

Throws: RemoteException

 If failure occurs during remote  object creation.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.rmi.registry.Registry

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.rmi.registry.Registry

 public interface Registry

 extends Remote

A "registry" exists on every node that allows RMI connections to  servers on that node. The registry on a particular node contains a  transient database that maps names to remote objects. When the  node boots, the registry database is empty. The names stored in the  registry are pure and are not parsed. A service storing itself in  the registry may want to prefix its name of the service by a package  name (although not required), to reduce name collisions in the  registry.  The LocateRegistry class is used to obtain the registry for different hosts.

See Also:

LocateRegistry

______________________________________________________________________________

 	REGISTRY_PORT

 Well known port for registry

 	bind(String, Remote)

 Binds the name to the specified remote object.

 	list()

 Returns an array of the names in the registry.

 	lookup(String)

 Returns the remote object associated with the specified name in the  registry.

 	rebind(String, Remote)

 Rebind the name to a new object, replacing any existing binding.

 	unbind(String)

 Unbind the name.

 REGISTRY_PORT

  public final static int REGISTRY_PORT

 Well known port for registry

 lookup

  public abstract Remote lookup(String name) throws RemoteException, NotBoundException, AccessException

 Returns the remote object associated with the specified name in the  registry.

Throws: RemoteException

 If remote operation failed.

Throws: NotBoundException

 if there is no object with this name in the  registry.

Throws: AccessException

 If this operation is not permitted.

 bind

  public abstract void bind(String name,
                            Remote obj) throws RemoteException, AlreadyBoundException, AccessException

 Binds the name to the specified remote object.

Throws: RemoteException

 If remote operation failed.

Throws: AlreadyBoundException

 If name is already bound.

Throws: AccessException

 If this operation is not permitted.

 unbind

  public abstract void unbind(String name) throws RemoteException, NotBoundException, AccessException

 Unbind the name.

Throws: RemoteException

 If remote operation failed.

Throws: NotBoundException

 if there is no object with this name in the  registry.

Throws: AccessException

 If this operation is not permitted.

 rebind

  public abstract void rebind(String name,
                              Remote obj) throws RemoteException, AccessException

 Rebind the name to a new object, replacing any existing binding.

Throws: RemoteException

 If remote operation failed.

Throws: AccessException

 If this operation is not permitted.

 list

  public abstract String[] list() throws RemoteException, AccessException

 Returns an array of the names in the registry.

Throws: RemoteException

 If remote operation failed.

Throws: AccessException

 If this operation is not permitted.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.rmi.registry.RegistryHandler

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.rmi.registry.RegistryHandler

 public interface RegistryHandler

RegistryHandler is used to interface to the private  implementation.

______________________________________________________________________________

 	registryImpl(int)

 Constructs and exports a Registry on the specified port.

 	registryStub(String, int)

 Returns a "stub" for contacting a remote registry  on the specified host and port.

 registryStub

  public abstract Registry registryStub(String host,
                                        int port) throws RemoteException, UnknownHostException

 Returns a "stub" for contacting a remote registry  on the specified host and port.

 registryImpl

  public abstract Registry registryImpl(int port) throws RemoteException

 Constructs and exports a Registry on the specified port.  The port must be non-zero.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.rmi.Remote

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Interface java.rmi.Remote

 public interface Remote

The Remote interface serves to identify all remote objects.  Any object that is a remote object must directly or indirectly implement  this interface. Only those methods specified in a remote interface are  available remotely.

 Implementation classes can implement any number of remote interfaces  and can extend other remote implementation classes.

______________________________________________________________________________
______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.RemoteException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.RemoteException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.rmi.RemoteException

______________________________________________________________________________

 public class RemoteException

 extends IOException

______________________________________________________________________________

 	detail

 	RemoteException()

 Create a remote exception

 	RemoteException(String)

 Create a remote exception with the specified string

 	RemoteException(String, Throwable)

 Create a remote exception with the specified string, and the  exception specified.

 	getMessage()

 Produce the message, include the message from the nested  exception if there is one.

 detail

  public Throwable detail

 RemoteException

  public RemoteException()

 Create a remote exception

 RemoteException

  public RemoteException(String s)

 Create a remote exception with the specified string

 RemoteException

  public RemoteException(String s,
                         Throwable ex)

 Create a remote exception with the specified string, and the  exception specified.

 getMessage

  public String getMessage()

 Produce the message, include the message from the nested  exception if there is one.

Overrides:

getMessage in class Throwable

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.RMISecurityException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.RMISecurityException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.RuntimeException
                           |
                           +----java.lang.SecurityException
                                   |
                                   +----java.rmi.RMISecurityException

______________________________________________________________________________

 public class RMISecurityException

 extends SecurityException

Signals that a security exception has occurred.

______________________________________________________________________________

 	RMISecurityException(String)

 Constructs a RMISecurityException with no detail message.

 	RMISecurityException(String, String)

 Constructs a RMISecurityException with the specified detail message.

 RMISecurityException

  public RMISecurityException(String name)

 Constructs a RMISecurityException with no detail message.  A detail message is a String that describes this particular exception.

 RMISecurityException

  public RMISecurityException(String name,
                              String arg)

 Constructs a RMISecurityException with the specified detail message.  A detail message is a String that describes this particular exception.

Parameters:

 s - the detail message

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.RMISecurityManager

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.RMISecurityManager

java.lang.Object
   |
   +----java.lang.SecurityManager
           |
           +----java.rmi.RMISecurityManager

______________________________________________________________________________

 public class RMISecurityManager

 extends SecurityManager

This class defines the RMI Stub security policy for applications  (not applets). For code loaded as a Stub, the security manager  disables all functions except class definition and access. To set a  RMISecurityManager, add the following to an application's main()  method:
 System.setSecurityManager(new RMISecurityManager()); If no security  manager has been set, RMI will load stub classes only from the  local files as defined by CLASSPATH.

______________________________________________________________________________

 	RMISecurityManager()

 Construct and initialize.

 	checkAccept(String, int)

 For now stubs can't accept connections on any port.

 	checkAccess(Thread)

 Stubs are not allowed to manipulate threads.

 	checkAccess(ThreadGroup)

 Stubs are not allowed to manipulate thread groups.

 	checkAwtEventQueueAccess()

 Checks to see if an client can get access to the AWT event queue  (disallowed from stubs).

 	checkConnect(String, int)

 Stubs can make connections if called through the RMI transport.

 	checkConnect(String, int, Object)

 Downloaded classes (including stubs) can make connections if  called through the RMI transport.

 	checkCreateClassLoader()

 Stubs are not allowed to create class loaders, or even execute any  of ClassLoader's methods.

 	checkDelete(String)

 Check if a file with the specified system dependent  file name can be deleted.

 	checkExec(String)

 Stubs are not allowed to fork processes.

 	checkExit(int)

 Stubs are not allowed to exit the VM.

 	checkLink(String)

 Stubs are not allowed to link dynamic libraries.

 	checkListen(int)

 For now stubs can't listen on any port.

 	checkMemberAccess(Class, int)

 Checks to see if client code can access class members.

 	checkMulticast(InetAddress)

 Checks to see if current execution context is allowed to use  (join/leave/send/receive) IP multicast (disallowed from stubs).

 	checkMulticast(InetAddress, byte)

 Checks to see if current execution context is allowed to use  (join/leave/send/receive) IP multicast (disallowed from stubs).

 	checkPackageAccess(String)

 Check if a stub can access a package.

 	checkPackageDefinition(String)

 Check if a stub can define classes in a package.

 	checkPrintJobAccess()

 Disallow printing from stubs.

 	checkPropertiesAccess()

 Stubs are not allowed to access the entire system properties  list, only properties explicitly labeled as accessible to stubs.

 	checkPropertyAccess(String)

 Stubs can access the system property named by key  only if its twin key.stub property is set to true.

 	checkRead(FileDescriptor)

 Stubs are not allowed to open file descriptors for reading unless  it is done through a socket, in which case other access  restrictions still apply.

 	checkRead(String)

 Check if a stub can read a particular file.

 	checkRead(String, Object)

 No file reads are valid from a stub.

 	checkSecurityAccess(String)

 Stubs cannot perform security provider operations.

 	checkSetFactory()

 Check if a stub can set a networking-related object factory.

 	checkSystemClipboardAccess()

 Checks to see if an client can get access to the System Clipboard  (disallowed from stubs).

 	checkTopLevelWindow(Object)

 Allow caller to create top-level windows.

 	checkWrite(FileDescriptor)

 Stubs are not allowed to open file descriptors for writing unless  it is done through a socket, in which case other access  restrictions still apply.

 	checkWrite(String)

 Check if a Stub can write a particular file.

 	getSecurityContext()

 Returns the security context (e.g., a URL).

 RMISecurityManager

  public RMISecurityManager()

 Construct and initialize.

 getSecurityContext

  public Object getSecurityContext()

 Returns the security context (e.g., a URL).

Overrides:

getSecurityContext in class SecurityManager

 checkCreateClassLoader

  public synchronized void checkCreateClassLoader()

 Stubs are not allowed to create class loaders, or even execute any  of ClassLoader's methods.

Overrides:

checkCreateClassLoader in class SecurityManager

 checkAccess

  public synchronized void checkAccess(Thread t)

 Stubs are not allowed to manipulate threads.

Overrides:

checkAccess in class SecurityManager

 checkAccess

  public synchronized void checkAccess(ThreadGroup g)

 Stubs are not allowed to manipulate thread groups.

Overrides:

checkAccess in class SecurityManager

 checkExit

  public synchronized void checkExit(int status)

 Stubs are not allowed to exit the VM.

Overrides:

checkExit in class SecurityManager

 checkExec

  public synchronized void checkExec(String cmd)

 Stubs are not allowed to fork processes.

Overrides:

checkExec in class SecurityManager

 checkLink

  public synchronized void checkLink(String lib)

 Stubs are not allowed to link dynamic libraries.

Overrides:

checkLink in class SecurityManager

 checkPropertiesAccess

  public synchronized void checkPropertiesAccess()

 Stubs are not allowed to access the entire system properties  list, only properties explicitly labeled as accessible to stubs.

Overrides:

checkPropertiesAccess in class SecurityManager

 checkPropertyAccess

  public synchronized void checkPropertyAccess(String key)

 Stubs can access the system property named by key  only if its twin key.stub property is set to true.  For example, the property java.home can be read by  stubs only if java.home.stub is true.

Overrides:

checkPropertyAccess in class SecurityManager

 checkRead

  public synchronized void checkRead(String file)

 Check if a stub can read a particular file.

Overrides:

checkRead in class SecurityManager

 checkRead

  public void checkRead(String file,
                        Object context)

 No file reads are valid from a stub.

Throws: SecurityException

 If called from a stub class.

Overrides:

checkRead in class SecurityManager

 checkWrite

  public synchronized void checkWrite(String file)

 Check if a Stub can write a particular file.

Throws: SecurityException

 If called from a stub class.

Overrides:

checkWrite in class SecurityManager

 checkDelete

  public void checkDelete(String file)

 Check if a file with the specified system dependent  file name can be deleted.

Parameters:

 file - the system dependent file name

Throws: SecurityException

 If the file is not found.

Overrides:

checkDelete in class SecurityManager

 checkRead

  public synchronized void checkRead(FileDescriptor fd)

 Stubs are not allowed to open file descriptors for reading unless  it is done through a socket, in which case other access  restrictions still apply.

Overrides:

checkRead in class SecurityManager

 checkWrite

  public synchronized void checkWrite(FileDescriptor fd)

 Stubs are not allowed to open file descriptors for writing unless  it is done through a socket, in which case other access  restrictions still apply.

Overrides:

checkWrite in class SecurityManager

 checkListen

  public synchronized void checkListen(int port)

 For now stubs can't listen on any port.

Overrides:

checkListen in class SecurityManager

 checkAccept

  public synchronized void checkAccept(String host,
                                       int port)

 For now stubs can't accept connections on any port.

Overrides:

checkAccept in class SecurityManager

 checkMulticast

  public void checkMulticast(InetAddress maddr)

 Checks to see if current execution context is allowed to use  (join/leave/send/receive) IP multicast (disallowed from stubs).

Overrides:

checkMulticast in class SecurityManager

 checkMulticast

  public void checkMulticast(InetAddress maddr,
                             byte ttl)

 Checks to see if current execution context is allowed to use  (join/leave/send/receive) IP multicast (disallowed from stubs).

Overrides:

checkMulticast in class SecurityManager

 checkConnect

  public synchronized void checkConnect(String host,
                                        int port)

 Stubs can make connections if called through the RMI transport.

Overrides:

checkConnect in class SecurityManager

 checkConnect

  public void checkConnect(String host,
                           int port,
                           Object context)

 Downloaded classes (including stubs) can make connections if  called through the RMI transport.

Overrides:

checkConnect in class SecurityManager

 checkTopLevelWindow

  public synchronized boolean checkTopLevelWindow(Object window)

 Allow caller to create top-level windows.  Allow stubs to create windows with warnings.

Overrides:

checkTopLevelWindow in class SecurityManager

 checkPackageAccess

  public synchronized void checkPackageAccess(String pkg)

 Check if a stub can access a package.

Overrides:

checkPackageAccess in class SecurityManager

 checkPackageDefinition

  public synchronized void checkPackageDefinition(String pkg)

 Check if a stub can define classes in a package.

Overrides:

checkPackageDefinition in class SecurityManager

 checkSetFactory

  public synchronized void checkSetFactory()

 Check if a stub can set a networking-related object factory.

Overrides:

checkSetFactory in class SecurityManager

 checkPrintJobAccess

  public void checkPrintJobAccess()

 Disallow printing from stubs.

Overrides:

checkPrintJobAccess in class SecurityManager

 checkSystemClipboardAccess

  public void checkSystemClipboardAccess()

 Checks to see if an client can get access to the System Clipboard  (disallowed from stubs).

Overrides:

checkSystemClipboardAccess in class SecurityManager

 checkAwtEventQueueAccess

  public void checkAwtEventQueueAccess()

 Checks to see if an client can get access to the AWT event queue  (disallowed from stubs).

Overrides:

checkAwtEventQueueAccess in class SecurityManager

 checkMemberAccess

  public void checkMemberAccess(Class clazz,
                                int which)

 Checks to see if client code can access class members.  Allow access to all public information.  Allow non-stubs to access default, package, and private declarations  (and data).

Overrides:

checkMemberAccess in class SecurityManager

 checkSecurityAccess

  public void checkSecurityAccess(String provider)

 Stubs cannot perform security provider operations.

Overrides:

checkSecurityAccess in class SecurityManager

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.server.ExportException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.server.ExportException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.rmi.RemoteException
                                   |
                                   +----java.rmi.server.ExportException

______________________________________________________________________________

 public class ExportException

 extends RemoteException

______________________________________________________________________________

 	ExportException(String)

 Create A remote exception with the specified string

 	ExportException(String, Exception)

 Create A remote exception with the specified string, and the  exception specified.

 ExportException

  public ExportException(String s)

 Create A remote exception with the specified string

 ExportException

  public ExportException(String s,
                         Exception ex)

 Create A remote exception with the specified string, and the  exception specified.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.rmi.server.LoaderHandler

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.rmi.server.LoaderHandler

 public interface LoaderHandler

______________________________________________________________________________

 	packagePrefix

 Find loader handler package prefix: assumes that the implementation of  the LoaderHandler class is located in the package defined by the  prefix.

 	getSecurityContext(ClassLoader)

 Returns the security context of the given class loader  (e.g., a URL)

 	loadClass(String)

 Load class using java.rmi.server.codebase property.

 	loadClass(URL, String)

 Load class from codebase URL specified.

 packagePrefix

  public final static String packagePrefix

 Find loader handler package prefix: assumes that the implementation of  the LoaderHandler class is located in the package defined by the  prefix.

 loadClass

  public abstract Class loadClass(String name) throws MalformedURLException , ClassNotFoundException

 Load class using java.rmi.server.codebase property.

Throws: ClassNotFoundException

 if the class could not be  found.

Throws: MalformedURLException

 if the URL is malformed.

 loadClass

  public abstract Class loadClass(URL codebase,
                                  String name) throws MalformedURLException, ClassNotFoundException

 Load class from codebase URL specified.

Throws: ClassNotFoundException

 if the class could not be  found.

Throws: MalformedURLException

 if the URL is malformed.

 getSecurityContext

  public abstract Object getSecurityContext(ClassLoader loader)

 Returns the security context of the given class loader  (e.g., a URL)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.server.LogStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.server.LogStream

java.lang.Object
   |
   +----java.io.OutputStream
           |
           +----java.io.FilterOutputStream
                   |
                   +----java.io.PrintStream
                           |
                           +----java.rmi.server.LogStream

______________________________________________________________________________

 public class LogStream

 extends PrintStream

LogStream presents a mechanism for logging errors that are  of possible interest to those monitoring the system.

______________________________________________________________________________

 	BRIEF

  	SILENT

 constants for logging levels

 	VERBOSE

 	getDefaultStream()

 Return the current default stream for new logs.

 	getOutputStream()

 Return the current stream to which output from this log is sent.

 	log(String)

 Return the LogStream identified by the given name.

 	parseLevel(String)

 Convert a string name of a logging level to its internal  integer representation.

 	setDefaultStream(PrintStream)

 Set the default stream for new logs.

 	setOutputStream(OutputStream)

 Set the stream to which output from this log is sent.

 	toString()

 Return log name as string representation

 	write(byte[], int, int)

 Write a subarray of bytes.

 	write(int)

 Write a byte of data to the stream.

 SILENT

  public final static int SILENT

 constants for logging levels

 BRIEF

  public final static int BRIEF

 VERBOSE

  public final static int VERBOSE

 log

  public static LogStream log(String name)

 Return the LogStream identified by the given name. If  a log corresponding to "name" does not exist, a log using  the default stream is created.

 getDefaultStream

  public static synchronized PrintStream getDefaultStream()

 Return the current default stream for new logs.

 setDefaultStream

  public static synchronized void setDefaultStream(PrintStream newDefault)

 Set the default stream for new logs.

 getOutputStream

  public synchronized OutputStream getOutputStream()

 Return the current stream to which output from this log is sent.

 setOutputStream

  public synchronized void setOutputStream(OutputStream out)

 Set the stream to which output from this log is sent.

 write

  public void write(int b)

 Write a byte of data to the stream. If it is not a newline, then  the byte is appended to the internal buffer. If it is a newline,  then the currently buffered line is sent to the log's output  stream, prefixed with the appropriate logging information.

Overrides:

write in class PrintStream

 write

  public void write(byte b[],
                    int off,
                    int len)

 Write a subarray of bytes. Pass each through write byte method.

Overrides:

write in class PrintStream

 toString

  public String toString()

 Return log name as string representation

Overrides:

toString in class Object

 parseLevel

  public static int parseLevel(String s)

 Convert a string name of a logging level to its internal  integer representation.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.server.ObjID

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.server.ObjID

java.lang.Object
   |
   +----java.rmi.server.ObjID

______________________________________________________________________________

 public final class ObjID

 extends Object

 implements Serializable

The class ObjID is used to identify remote objects uniquely in a VM  over time. Each identifier contains an object number and an address  space identifier that is unique with respect to a specific host. An  object identifier is assigned to a remote object when it is  exported.

______________________________________________________________________________

 	DGC_ID

 well-known id for the distributed garbage collector

 	REGISTRY_ID

 well-known id for the registry

 	ObjID()

 Generate unique object identifier.

 	ObjID(int)

 Generate a "well-known" object ID.

 	equals(Object)

 Two object identifiers are considered equal if they have the  same contents.

 	hashCode()

 The hashcode is the object number.

 	read(ObjectInput)

 The read method constructs an object id whose contents is read  from the specified input stream.

 	toString()

 Returns a string containing the object id representation.

 	write(ObjectOutput)

 Marshal object id to output stream.

 REGISTRY_ID

  public final static int REGISTRY_ID

 well-known id for the registry

 DGC_ID

  public final static int DGC_ID

 well-known id for the distributed garbage collector

 ObjID

  public ObjID()

 Generate unique object identifier.

 ObjID

  public ObjID(int num)

 Generate a "well-known" object ID. An object ID generated via  this constructor will not clash with any object IDs generated  via the default constructor.

Parameters:

 num - a unique well-known object number

 write

  public void write(ObjectOutput out) throws IOException

 Marshal object id to output stream.

 read

  public static ObjID read(ObjectInput in) throws IOException

 The read method constructs an object id whose contents is read  from the specified input stream.

 hashCode

  public int hashCode()

 The hashcode is the object number.

Overrides:

hashCode in class Object

 equals

  public boolean equals(Object obj)

 Two object identifiers are considered equal if they have the  same contents.

Overrides:

equals in class Object

 toString

  public String toString()

 Returns a string containing the object id representation. The  address space identifier is included in the string  representation only if the object id is from a non-local  address space.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.server.Operation

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.server.Operation

java.lang.Object
   |
   +----java.rmi.server.Operation

______________________________________________________________________________

 public class Operation

 extends Object

Operation holds a description of a Java method.

______________________________________________________________________________

 	Operation(String)

 Creates a new Operation object.

 	getOperation()

 Returns the name of the method.

 	toString()

 Returns a string representation of the object.

 Operation

  public Operation(String op)

 Creates a new Operation object.

 getOperation

  public String getOperation()

 Returns the name of the method.

 toString

  public String toString()

 Returns a string representation of the object.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.rmi.server.RemoteCall

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.rmi.server.RemoteCall

 public interface RemoteCall

RemoteCall is an abstraction used solely by the implementation  (stubs and skeletons of remote objects) to carry out a call to a  remote object.

______________________________________________________________________________

 	done()

 Allow cleanup after the remote call has completed.

 	executeCall()

 Do whatever it takes to execute the call.

 	getInputStream()

 Get the InputStream that the stub/skeleton should get  results/arguments from.

 	getOutputStream()

 Return the output stream the stub/skeleton should put arguments/results  into.

 	getResultStream(boolean)

 Returns an output stream (may put out header information  relating to the success of the call).

 	releaseInputStream()

 Release the input stream.

 	releaseOutputStream()

 Release the output stream; in some transports this would release  the stream.

 getOutputStream

  public abstract ObjectOutput getOutputStream() throws IOException

 Return the output stream the stub/skeleton should put arguments/results   into.

Throws: IOException

 if an I/O error occurs.

 releaseOutputStream

  public abstract void releaseOutputStream() throws IOException

 Release the output stream; in some transports this would release  the stream.

Throws: IOException

 if an I/O error occurs.

 getInputStream

  public abstract ObjectInput getInputStream() throws IOException

 Get the InputStream that the stub/skeleton should get  results/arguments from.

Throws: IOException

 if an I/O error occurs.

 releaseInputStream

  public abstract void releaseInputStream() throws IOException

 Release the input stream. This would allow some transports to release  the channel early.

Throws: IOException

 if an I/O error occurs.

 getResultStream

  public abstract ObjectOutput getResultStream(boolean success) throws IOException , StreamCorruptedException

 Returns an output stream (may put out header information  relating to the success of the call). Should only succeed  once per remote call.

Parameters:

 success - If true, indicates normal return, else indicates  exceptional return.

Throws: IOException

 if an I/O error occurs.

Throws: StreamCorruptedException

 If already been called.

 executeCall

  public abstract void executeCall() throws Exception

 Do whatever it takes to execute the call.

Throws: Exception

 if a general exception occurs.

 done

  public abstract void done() throws IOException

 Allow cleanup after the remote call has completed.

Throws: IOException

 if an I/O error occurs.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.server.RemoteObject

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.server.RemoteObject

java.lang.Object
   |
   +----java.rmi.server.RemoteObject

______________________________________________________________________________

 public class RemoteObject

 extends Object

 implements Remote, Serializable

The RemoteObject class implements the java.lang.Object behavior for  remote objects. RemoteObject provides the remote semantics of  Object by implementing methods for hashCode, equals, and toString.

______________________________________________________________________________

 	ref

 	RemoteObject()

 Create a remote object.

 	RemoteObject(RemoteRef)

 Create a remote object, initialized with the specified remote reference.

 	equals(Object)

 Compares two remote objects for equality.

 	hashCode()

 Returns a hashcode for a remote object.

 	toString()

 Returns a String that represents the value of this remote object.

 ref

  protected transient RemoteRef ref

 RemoteObject

  protected RemoteObject()

 Create a remote object.

 RemoteObject

  protected RemoteObject(RemoteRef newref)

 Create a remote object, initialized with the specified remote reference.

 hashCode

  public int hashCode()

 Returns a hashcode for a remote object. Two remote object stubs  that refer to the same remote object will have the same hash code  (in order to support remote objects as keys in hash tables).

Overrides:

hashCode in class Object

See Also:

Hashtable

 equals

  public boolean equals(Object obj)

 Compares two remote objects for equality.  Returns a boolean that indicates whether this remote object is  equivalent to the specified Object. This method is used when a  remote object is stored in a hashtable.

Parameters:

 obj - the Object to compare with

Returns:

 true if these Objects are equal; false otherwise.

Overrides:

equals in class Object

See Also:

Hashtable

 toString

  public String toString()

 Returns a String that represents the value of this remote object.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.rmi.server.RemoteRef

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.rmi.server.RemoteRef

 public interface RemoteRef

 extends Externalizable

RemoteRef represents the handle for a remote object.

______________________________________________________________________________

 	packagePrefix

 Find server package prefix: assumes that the implementation of  server ref classes (e.g., UnicastRef, UnicastServerRef) are  located in the package defined by the prefix.

 	done(RemoteCall)

 Allows the remote reference to clean up (or reuse) the connection.

 	getRefClass(ObjectOutput)

 Returns the class name of the ref type to be serialized onto  the stream 'out'.

 	invoke(RemoteCall)

 Executes the remote call.

 	newCall(RemoteObject, Operation[], int, long)

 Creates an appropriate call object for a new remote method  invocation on this object.

 	remoteEquals(RemoteRef)

 Compares two remote objects for equality.

 	remoteHashCode()

 Returns a hashcode for a remote object.

 	remoteToString()

 Returns a String that represents the reference of this remote  object.

 packagePrefix

  public final static String packagePrefix

 Find server package prefix: assumes that the implementation of  server ref classes (e.g., UnicastRef, UnicastServerRef) are  located in the package defined by the prefix.

 newCall

  public abstract RemoteCall newCall(RemoteObject obj,
                                     Operation op[],
                                     int opnum,
                                     long hash) throws RemoteException

 Creates an appropriate call object for a new remote method  invocation on this object. Passing operation array and index,  allows the stubs generator to assign the operation indexes and  interpret them. The remote reference may need the operation to  encode in the call.

Throws: RemoteException

 if registry could not be contacted.

 invoke

  public abstract void invoke(RemoteCall call) throws Exception

 Executes the remote call.  Invoke will raise any "user" exceptions which  should pass through and not be caught by the stub. If any  exception is raised during the remote invocation, invoke should  take care of cleaning up the connection before raising the  "user" or remote exception.

Throws: Exception

 if a general exception occurs.

 done

  public abstract void done(RemoteCall call) throws RemoteException

 Allows the remote reference to clean up (or reuse) the connection.  Done should only be called if the invoke returns successfully  (non-exceptionally) to the stub.

Throws: RemoteException

 if registry could not be contacted.

 getRefClass

  public abstract String getRefClass(ObjectOutput out)

 Returns the class name of the ref type to be serialized onto  the stream 'out'.

 remoteHashCode

  public abstract int remoteHashCode()

 Returns a hashcode for a remote object. Two remote object stubs  that refer to the same remote object will have the same hash code  (in order to support remote objects as keys in hash tables).

See Also:

Hashtable

 remoteEquals

  public abstract boolean remoteEquals(RemoteRef obj)

 Compares two remote objects for equality.  Returns a boolean that indicates whether this remote object is  equivalent to the specified Object. This method is used when a  remote object is stored in a hashtable.

Parameters:

 obj - the Object to compare with

Returns:

 true if these Objects are equal; false otherwise.

See Also:

Hashtable

 remoteToString

  public abstract String remoteToString()

 Returns a String that represents the reference of this remote  object.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.server.RemoteServer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.server.RemoteServer

java.lang.Object
   |
   +----java.rmi.server.RemoteObject
           |
           +----java.rmi.server.RemoteServer

______________________________________________________________________________

 public class RemoteServer

 extends RemoteObject

The RemoteServer class is the common superclass to all server  implementations and provides the framework to support a wide range  of remote reference semantics. Specifically, the functions needed  to create and export remote objects (i.e. to make them remotely  available) are provided abstractly by RemoteServer and concretely  by its subclass(es).

 The subclass selected identifies the semantics of the remote  reference, for example whether the server is a single object or is  a replicated object requiring communications with multiple  locations. At present only UnicastRemoteObject is supported.

______________________________________________________________________________

 	RemoteServer()

  	RemoteServer(RemoteRef)

 	getClientHost()

 Return the hostname of the current client.

 	getLog()

 Returns stream for the RMI call log.

 	setLog(OutputStream)

 Log RMI calls to the output stream out.

 RemoteServer

  protected RemoteServer()

 RemoteServer

  protected RemoteServer(RemoteRef ref)

 getClientHost

  public static String getClientHost() throws ServerNotActiveException

 Return the hostname of the current client. When called from a  thread actively handling a remote method invocation the  hostname of the client is returned.

Throws: ServerNotActiveException

 If called outside of servicing  a remote method invocation.

 setLog

  public static void setLog(OutputStream out)

 Log RMI calls to the output stream out. If out  is  null, call logging is turned off.

 getLog

  public static PrintStream getLog()

 Returns stream for the RMI call log.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.server.RemoteStub

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.server.RemoteStub

java.lang.Object
   |
   +----java.rmi.server.RemoteObject
           |
           +----java.rmi.server.RemoteStub

______________________________________________________________________________

 public class RemoteStub

 extends RemoteObject

The RemoteStub class is the common superclass to all client stubs  and provides the framework to support a wide range of remote  reference semantics. Stub objects are surrogates that support  exactly the same set of remote interfaces defined by the actual  implementation of the remote object.

______________________________________________________________________________

 	RemoteStub()

 Constructor for RemoteStub.

 	RemoteStub(RemoteRef)

 Constructor for RemoteStub, with the specified remote reference.

 	setRef(RemoteStub, RemoteRef)

 RemoteStub

  protected RemoteStub()

 Constructor for RemoteStub.

 RemoteStub

  protected RemoteStub(RemoteRef ref)

 Constructor for RemoteStub, with the specified remote reference.

 setRef

  protected static void setRef(RemoteStub stub,
                               RemoteRef ref)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.server.RMIClassLoader

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.server.RMIClassLoader

java.lang.Object
   |
   +----java.rmi.server.RMIClassLoader

______________________________________________________________________________

 public class RMIClassLoader

 extends Object

The RMIClassLoader class provides static methods for loading classes  over the network. Classes can be loaded from either a particular URL,  or from the URL specified in the java.rmi.server.codebase  system property.

______________________________________________________________________________

 	getSecurityContext(ClassLoader)

 Returns the security context of the given class loader

 	loadClass(String)

 Load a class from the URL specified in the  java.rmi.server.codebase property.

 	loadClass(URL, String)

 Load a class from a URL.

 loadClass

  public static Class loadClass(String name) throws MalformedURLException , ClassNotFoundException

 Load a class from the URL specified in the  java.rmi.server.codebase property.

Parameters:

 name - the name of the class to load

Returns:

 the Class object representing the loaded class

Throws: MalformedURLException

 The system property java.rmi.server.codebase  does not contain a valid URL.

Throws: ClassNotFoundException

 A definition for the class could not  be found at the codebase URL.

 loadClass

  public static Class loadClass(URL codebase,
                                String name) throws MalformedURLException, ClassNotFoundException

 Load a class from a URL.

Parameters:

 codebase - the URL from which to load the class

 name - the name of the class to load

Returns:

 the Class object representing the loaded class

Throws: MalformedURLException

 The codebase paramater was null.

Throws: ClassNotFoundException

 A definition for the class could not  be found at the specified URL.

 getSecurityContext

  public static Object getSecurityContext(ClassLoader loader)

 Returns the security context of the given class loader

Parameters:

 loader - a class loader from which to get the security  context

Returns:

 the security context (e.g., a URL)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.rmi.server.RMIFailureHandler

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.rmi.server.RMIFailureHandler

 public interface RMIFailureHandler

An RMIFailureHandler can be registered via the  RMISocketFactory.setFailureHandler call. The "failure" method of  the handler is invoked when the RMI runtime is unable to create a  Socket or ServerSocket. The "failure" method returns a boolean  indicating whether the runtime should attempt to retry.

______________________________________________________________________________

 	failure(Exception)

 The "failure" callback is invoked when the RMI runtime is  unable to create a Socket or ServerSocket via the  RMISocketFactory.

 failure

  public abstract boolean failure(Exception ex)

 The "failure" callback is invoked when the RMI runtime is  unable to create a Socket or ServerSocket via the  RMISocketFactory. The RMIFailureHandler is registered via a  call to RMISocketFacotry.setFailureHandler(). The default  failure handler returns false.

Parameters:

 ex - the exception that occurred during socket creation

Returns:

 if true, the RMI runtime attempts to retry

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.server.RMISocketFactory

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.server.RMISocketFactory

java.lang.Object
   |
   +----java.rmi.server.RMISocketFactory

______________________________________________________________________________

 public class RMISocketFactory

 extends Object

The RMISocketFactory is used by the RMI runtime in order to obtain  client and server sockets for RMI calls. The default implementation  of the socket factory performs a three-tiered approach to creating  client sockets. First, a direct socket connection to the remote VM  is attempted. If that fails (due to a firewall), the runtime uses  HTTP with the explicit port number of the server. If the firewall  does not allow this type of communication, then HTTP to a cgi-bin  script on the server is used to POST the RMI call.  An application may set the source of sockets for RMI. In this case,  the application is responsible for offering up sockets that will  penetrate a firewall.

______________________________________________________________________________

 	RMISocketFactory()

 	createServerSocket(int)

 Create a server socket on the specified port (port 0 represents  an anonymous port).

 	createSocket(String, int)

 Create a client socket connected to the specified host and port.

 	getFailureHandler()

 Returns the handler for socket creation failure.

 	getSocketFactory()

 Returns the socket factory used by RMI.

 	setFailureHandler(RMIFailureHandler)

 Set the failure handler to be called by the RMI runtime if  socket creation fails.

 	setSocketFactory(RMISocketFactory)

 Set the socket factory from which RMI gets sockets.

 RMISocketFactory

  public RMISocketFactory()

 createSocket

  public abstract Socket createSocket(String host,
                                      int port) throws IOException

 Create a client socket connected to the specified host and port.

 createServerSocket

  public abstract ServerSocket createServerSocket(int port) throws IOException

 Create a server socket on the specified port (port 0 represents  an anonymous port).

 setSocketFactory

  public static void setSocketFactory(RMISocketFactory fac) throws IOException

 Set the socket factory from which RMI gets sockets. The RMI  socket factory can only be set once. Note: The RMISocketFactory  may only be set if the current security manager allows setting  a socket factory; if disallowed, a SecurityException will be  thrown.

 getSocketFactory

  public static RMISocketFactory getSocketFactory()

 Returns the socket factory used by RMI.

 setFailureHandler

  public static void setFailureHandler(RMIFailureHandler fh)

 Set the failure handler to be called by the RMI runtime if  socket creation fails. The default implementation of this  handler returns false (thus recreation of sockets is not  attempted by the runtime).

 getFailureHandler

  public static RMIFailureHandler getFailureHandler()

 Returns the handler for socket creation failure.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.server.ServerCloneException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.server.ServerCloneException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.CloneNotSupportedException
                           |
                           +----java.rmi.server.ServerCloneException

______________________________________________________________________________

 public class ServerCloneException

 extends CloneNotSupportedException

______________________________________________________________________________

 	detail

 	ServerCloneException(String)

 Create A remote exception with the specified string

 	ServerCloneException(String, Exception)

 Create A remote exception with the specified string, and the  exception specified.

 	getMessage()

 Produce the message, include the message from the nested  exception if there is one.

 detail

  public Exception detail

 ServerCloneException

  public ServerCloneException(String s)

 Create A remote exception with the specified string

 ServerCloneException

  public ServerCloneException(String s,
                              Exception ex)

 Create A remote exception with the specified string, and the  exception specified.

 getMessage

  public String getMessage()

 Produce the message, include the message from the nested  exception if there is one.

Overrides:

getMessage in class Throwable

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.server.ServerNotActiveException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.server.ServerNotActiveException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.rmi.server.ServerNotActiveException

______________________________________________________________________________

 public class ServerNotActiveException

 extends Exception

______________________________________________________________________________

 	ServerNotActiveException()

 Create a new exception.

 	ServerNotActiveException(String)

 ServerNotActiveException

  public ServerNotActiveException()

 Create a new exception.

 ServerNotActiveException

  public ServerNotActiveException(String s)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.rmi.server.ServerRef

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.rmi.server.ServerRef

 public interface ServerRef

 extends RemoteRef

A ServerRef represents the server-side handle for a remote object  implementation.

______________________________________________________________________________

 	exportObject(Remote, Object)

 Find or create a client stub object for the supplied Remote.

 	getClientHost()

 Return the hostname of the current client.

 exportObject

  public abstract RemoteStub exportObject(Remote obj,
                                          Object data) throws RemoteException

 Find or create a client stub object for the supplied Remote.

Parameters:

 obj - the remote object implementation

 data - information necessary to export the object  (e.g. port number)

 getClientHost

  public abstract String getClientHost() throws ServerNotActiveException

 Return the hostname of the current client. When called from a  thread actively handling a remote method invocation the  hostname of the client is returned.

Throws: ServerNotActiveException

 If called outside of servicing  a remote method invocation.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.rmi.server.Skeleton

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.rmi.server.Skeleton

 public interface Skeleton

Used solely by the implementation.

 Every skeleton class generated by the rmic stub compiler implements  this interface. A skeleton for a remote object is a server-side entity  that dispatches calls to the actual remote object implementation.

______________________________________________________________________________

 	dispatch(Remote, RemoteCall, int, long)

 Unmarshals arguments, calls the actual remote object implementation,  and marshals the return value or any exception.

 	getOperations()

 dispatch

  public abstract void dispatch(Remote obj,
                                RemoteCall theCall,
                                int opnum,
                                long hash) throws Exception

 Unmarshals arguments, calls the actual remote object implementation,  and marshals the return value or any exception.

Throws: Exception

 if a general exception occurs.

 getOperations

  public abstract Operation[] getOperations()

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.server.SkeletonMismatchException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.server.SkeletonMismatchException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.rmi.RemoteException
                                   |
                                   +----java.rmi.server.SkeletonMismatchException

______________________________________________________________________________

 public class SkeletonMismatchException

 extends RemoteException

This exception is thrown when a call is received that does not  match the available skeleton. It indicates either that the  remote method names or signatures in this interface have changed or  that the stub class used to make the call and the skeleton  receiving the call were not generated by the same version of  the stub compiler (RMIC).

______________________________________________________________________________

 	SkeletonMismatchException(String)

 Create a new SkeletonMismatchException exception with a descriptive string.

 SkeletonMismatchException

  public SkeletonMismatchException(String s)

 Create a new SkeletonMismatchException exception with a descriptive string.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.server.SkeletonNotFoundException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.server.SkeletonNotFoundException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.rmi.RemoteException
                                   |
                                   +----java.rmi.server.SkeletonNotFoundException

______________________________________________________________________________

 public class SkeletonNotFoundException

 extends RemoteException

______________________________________________________________________________

 	SkeletonNotFoundException(String)

 Create a new SkeletonNotFoundException exception with a descriptive string.

 	SkeletonNotFoundException(String, Exception)

 Create a new SkeletonNotFoundException with a descriptive string and an exception.

 SkeletonNotFoundException

  public SkeletonNotFoundException(String s)

 Create a new SkeletonNotFoundException exception with a descriptive string.

 SkeletonNotFoundException

  public SkeletonNotFoundException(String s,
                                   Exception ex)

 Create a new SkeletonNotFoundException with a descriptive string and an exception.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.server.SocketSecurityException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.server.SocketSecurityException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.rmi.RemoteException
                                   |
                                   +----java.rmi.server.ExportException
                                           |
                                           +----java.rmi.server.SocketSecurityException

______________________________________________________________________________

 public class SocketSecurityException

 extends ExportException

______________________________________________________________________________

 	SocketSecurityException(String)

 Create A remote exception with the specified string

 	SocketSecurityException(String, Exception)

 Create A remote exception with the specified string, and the  exception specified.

 SocketSecurityException

  public SocketSecurityException(String s)

 Create A remote exception with the specified string

 SocketSecurityException

  public SocketSecurityException(String s,
                                 Exception ex)

 Create A remote exception with the specified string, and the  exception specified.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.server.UID

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.server.UID

java.lang.Object
   |
   +----java.rmi.server.UID

______________________________________________________________________________

 public final class UID

 extends Object

 implements Serializable

Abstraction for creating identifiers that are unique with respect  to the the host on which it is generated.

______________________________________________________________________________

 	UID()

 Create a pure identifier that is unique with respect to the  host on which it is generated.

 	UID(short)

 Create a "well-known" ID.

 	equals(Object)

 Compares two Objects for equality.

 	hashCode()

 Returns a hash code value for the object.

 	read(DataInput)

 Get the uid from the input stream.

 	toString()

 Returns a string representation of the object.

 	write(DataOutput)

 Write uid to output stream.

 UID

  public UID()

 Create a pure identifier that is unique with respect to the  host on which it is generated. This UID is unique under the  following conditions: a) the machine takes more than one second  to reboot, and b) the machine's clock is never set backward.  In order to construct a UID that is globally unique, simply  pair a UID with an InetAddress.

 UID

  public UID(short num)

 Create a "well-known" ID. There are 2^16 -1 such possible  well-known ids. An id generated via this constructor will not  clash with any id generated via the default UID  constructor which will generates a genuinely unique identifier  with respect to this host.

 hashCode

  public int hashCode()

 Returns a hash code value for the object.

Overrides:

hashCode in class Object

 equals

  public boolean equals(Object obj)

 Compares two Objects for equality.

Overrides:

equals in class Object

 toString

  public String toString()

 Returns a string representation of the object.

Overrides:

toString in class Object

 write

  public void write(DataOutput out) throws IOException

 Write uid to output stream.

 read

  public static UID read(DataInput in) throws IOException

 Get the uid from the input stream.

Parameters:

 in - the input stream

Throws: IOException

 If uid could not be read  (due to stream failure or malformed uid)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.server.UnicastRemoteObject

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.server.UnicastRemoteObject

java.lang.Object
   |
   +----java.rmi.server.RemoteObject
           |
           +----java.rmi.server.RemoteServer
                   |
                   +----java.rmi.server.UnicastRemoteObject

______________________________________________________________________________

 public class UnicastRemoteObject

 extends RemoteServer

The UnicastRemoteObject class defines a non-replicated remote  object whose references are valid only while the server process is  alive. The UnicastRemoteObject class provides support for  point-to-point active object references (invocations, parameters,  and results) using TCP streams.

 Objects that require remote behavior should extend RemoteObject,  typically via UnicastRemoteObject. If UnicastRemoteObject is not  extended, the implementation class must then assume the  responsibility for the correct semantics of the hashCode, equals,  and toString methods inherited from the Object class, so that they  behave appropriately for remote objects.

______________________________________________________________________________

 	UnicastRemoteObject()

 Create and export a new UnicastRemoteObject object using an  anonymous port.

 	clone()

 Returns a clone of the remote object that is distinct from  the original.

 	exportObject(Remote)

 Export the remote object to make it available to receive incoming calls.

 UnicastRemoteObject

  protected UnicastRemoteObject() throws RemoteException

 Create and export a new UnicastRemoteObject object using an  anonymous port.

 clone

  public Object clone() throws CloneNotSupportedException

 Returns a clone of the remote object that is distinct from  the original.

Returns:

 the new remote object

Throws: CloneNotSupportedException

 if clone failed due to  a RemoteException.

Overrides:

clone in class Object

 exportObject

  public static RemoteStub exportObject(Remote obj) throws RemoteException

 Export the remote object to make it available to receive incoming calls.

Parameters:

 obj - the remote object to be exported

Throws: RemoteException

 if export fails

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.rmi.server.Unreferenced

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.rmi.server.Unreferenced

 public interface Unreferenced

A remote object should implement this interface to receive notification  when there are no more remote references to it.

______________________________________________________________________________

 	unreferenced()

 Called when there are no current references to this remote object.

 unreferenced

  public abstract void unreferenced()

 Called when there are no current references to this remote object.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.ServerError

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.ServerError

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.rmi.RemoteException
                                   |
                                   +----java.rmi.ServerError

______________________________________________________________________________

 public class ServerError

 extends RemoteException

______________________________________________________________________________

 	ServerError(String, Error)

 Create a new "server error" exception with the string and  the specified exception.

 ServerError

  public ServerError(String s,
                     Error err)

 Create a new "server error" exception with the string and  the specified exception.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.ServerException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.ServerException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.rmi.RemoteException
                                   |
                                   +----java.rmi.ServerException

______________________________________________________________________________

 public class ServerException

 extends RemoteException

______________________________________________________________________________

 	ServerException(String)

 Create a new server exception with a descriptive string.

 	ServerException(String, Exception)

 Create a new server exception with a descriptive string and an  exception.

 ServerException

  public ServerException(String s)

 Create a new server exception with a descriptive string.

 ServerException

  public ServerException(String s,
                         Exception ex)

 Create a new server exception with a descriptive string and an  exception.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.ServerRuntimeException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.ServerRuntimeException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.rmi.RemoteException
                                   |
                                   +----java.rmi.ServerRuntimeException

______________________________________________________________________________

 public class ServerRuntimeException

 extends RemoteException

______________________________________________________________________________

 	ServerRuntimeException(String, Exception)

 Create a new runtime exception with the strings and  the specified exception.

 ServerRuntimeException

  public ServerRuntimeException(String s,
                                Exception ex)

 Create a new runtime exception with the strings and  the specified exception.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.StubNotFoundException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.StubNotFoundException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.rmi.RemoteException
                                   |
                                   +----java.rmi.StubNotFoundException

______________________________________________________________________________

 public class StubNotFoundException

 extends RemoteException

______________________________________________________________________________

 	StubNotFoundException(String)

 Create a new StubNotFoundException with a descriptive string.

 	StubNotFoundException(String, Exception)

 Create a new StubNotFoundException with a descriptive string and an exception.

 StubNotFoundException

  public StubNotFoundException(String s)

 Create a new StubNotFoundException with a descriptive string.

 StubNotFoundException

  public StubNotFoundException(String s,
                               Exception ex)

 Create a new StubNotFoundException with a descriptive string and an exception.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.UnexpectedException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.UnexpectedException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.rmi.RemoteException
                                   |
                                   +----java.rmi.UnexpectedException

______________________________________________________________________________

 public class UnexpectedException

 extends RemoteException

______________________________________________________________________________

 	UnexpectedException(String)

 Create a new UnexpectedException with a description.

 	UnexpectedException(String, Exception)

 Create a new UnexpectedException with a description, and detail  exception.

 UnexpectedException

  public UnexpectedException(String s)

 Create a new UnexpectedException with a description.

 UnexpectedException

  public UnexpectedException(String s,
                             Exception ex)

 Create a new UnexpectedException with a description, and detail  exception.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.UnknownHostException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.UnknownHostException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.rmi.RemoteException
                                   |
                                   +----java.rmi.UnknownHostException

______________________________________________________________________________

 public class UnknownHostException

 extends RemoteException

______________________________________________________________________________

 	UnknownHostException(String)

 Create a new UnknownHostException with a description.

 	UnknownHostException(String, Exception)

 Create a new UnknownHostException with a description and  detail exception.

 UnknownHostException

  public UnknownHostException(String s)

 Create a new UnknownHostException with a description.

 UnknownHostException

  public UnknownHostException(String s,
                              Exception ex)

 Create a new UnknownHostException with a description and  detail exception.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.rmi.UnmarshalException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.rmi.UnmarshalException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.rmi.RemoteException
                                   |
                                   +----java.rmi.UnmarshalException

______________________________________________________________________________

 public class UnmarshalException

 extends RemoteException

______________________________________________________________________________

 	UnmarshalException(String)

 Create a new marshal exception with a descriptive string.

 	UnmarshalException(String, Exception)

 Create a new marshal exception with a descriptive string and an  exception.

 UnmarshalException

  public UnmarshalException(String s)

 Create a new marshal exception with a descriptive string.

 UnmarshalException

  public UnmarshalException(String s,
                            Exception ex)

 Create a new marshal exception with a descriptive string and an  exception.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.security.acl.Acl

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.security.acl.Acl

 public interface Acl

 extends Owner

Interface representing an Access Control List (ACL). An Access  Control List is a data structure used to guard access to  resources.

 An ACL can be thought of as a data structure with multiple ACL  entries. Each ACL entry, of interface type AclEntry, contains a  set of permissions associated with a particular principal. (A  principal represents an entity such as an individual user or a  group). Additionally, each ACL entry is specified as being either  positive or negative. If positive, the permissions are to be  granted to the associated principal. If negative, the permissions  are to be denied.

 The ACL Entries in each ACL observe the following rules:

• Each principal can have at most one positive ACL entry and  one negative entry; that is, multiple positive or negative ACL  entries are not allowed for any principal. Each entry specifies  the set of permissions that are to be granted (if positive) or  denied (if negative).

• If there is no entry for a particular principal, then the  principal is considered to have a null (empty) permission set.

• If there is a positive entry that grants a principal a  particular permission, and a negative entry that denies the  principal the same permission, the result is as though the  permission was never granted or denied.

• Individual permissions always override permissions of the  group(s) to which the individual belongs. That is, individual  negative permissions (specific denial of permissions) override the  groups' positive permissions. And individual positive permissions  override the groups' negative permissions.

 The  java.security.acl  package provides the  interfaces to the ACL and related data structures (ACL entries,  groups, permissions, etc.), and the  sun.security.acl   classes provide a default implementation of the interfaces. For  example,  java.security.acl.Acl  provides the  interface to an ACL and the  sun.security.acl.AclImpl   class provides the default implementation of the interface.

 The  java.security.acl.Acl  interface extends the   java.security.acl.Owner  interface. The Owner  interface is used to maintain a list of owners for each ACL. Only  owners are allowed to modify an ACL. For example, only an owner can  call the ACL's addEntry method to add a new ACL entry  to the ACL.

See Also:

AclEntry, Owner, getPermissions

______________________________________________________________________________

 	addEntry(Principal, AclEntry)

 Adds an ACL entry to this ACL.

 	checkPermission(Principal, Permission)

 Checks whether or not the specified principal has the specified  permission.

 	entries()

 Returns an enumeration of the entries in this ACL.

 	getName()

 Returns the name of this ACL.

 	getPermissions(Principal)

 Returns an enumeration for the set of allowed permissions for the  specified principal (representing an entity such as an individual or  a group).

 	removeEntry(Principal, AclEntry)

 Removes an ACL entry from this ACL.

 	setName(Principal, String)

 Sets the name of this ACL.

 	toString()

 Returns a string representation of the  ACL contents.

 setName

  public abstract void setName(Principal caller,
                               String name) throws NotOwnerException

 Sets the name of this ACL.

Parameters:

 caller - the principal invoking this method. It must be an  owner of this ACL.

 name - the name to be given to this ACL.

Throws: NotOwnerException

 if the caller principal  is not an owner of this ACL.

 getName

  public abstract String getName()

 Returns the name of this ACL.

Returns:

 the name of this ACL.

 addEntry

  public abstract boolean addEntry(Principal caller,
                                   AclEntry entry) throws NotOwnerException

 Adds an ACL entry to this ACL. An entry associates a principal  (e.g., an individual or a group) with a set of  permissions. Each principal can have at most one positive ACL  entry (specifying permissions to be granted to the principal)  and one negative ACL entry (specifying permissions to be  denied). If there is already an ACL entry of the same type  (negative or positive) already in the ACL, false is returned.

Parameters:

 caller - the principal invoking this method. It must be an  owner of this ACL.

 entry - the ACL entry to be added to this ACL.

Returns:

 true on success, false if an entry of the same type  (positive or negative) for the same principal is already  present in this ACL.

Throws: NotOwnerException

 if the caller principal  is not an owner of this ACL.

 removeEntry

  public abstract boolean removeEntry(Principal caller,
                                      AclEntry entry) throws NotOwnerException

 Removes an ACL entry from this ACL.

Parameters:

 caller - the principal invoking this method. It must be an  owner of this ACL.

 entry - the ACL entry to be removed from this ACL.

Returns:

 true on success, false if the entry is not part of this ACL.

Throws: NotOwnerException

 if the caller principal is not  an owner of this Acl.

 getPermissions

  public abstract Enumeration getPermissions(Principal user)

 Returns an enumeration for the set of allowed permissions for the  specified principal (representing an entity such as an individual or  a group). This set of allowed permissions is calculated as  follows:

• If there is no entry in this Access Control List for the  specified principal, an empty permission set is returned.

• Otherwise, the principal's group permission sets are determined.  (A principal can belong to one or more groups, where a group is a  group of principals, represented by the Group interface.)  The group positive permission set is the union of all  the positive permissions of each group that the principal belongs to.  The group negative permission set is the union of all  the negative permissions of each group that the principal belongs to.  If there is a specific permission that occurs in both  the positive permission set and the negative permission set,  it is removed from both.

 The individual positive and negative permission sets are also  determined. The positive permission set contains the permissions  specified in the positive ACL entry (if any) for the principal.  Similarly, the negative permission set contains the permissions  specified in the negative ACL entry (if any) for the principal.  The individual positive (or negative) permission set is considered  to be null if there is not a positive (negative) ACL entry for the  principal in this ACL.

 The set of permissions granted to the principal is then calculated  using the simple rule that individual permissions always override  the group permissions. That is, the principal's individual negative  permission set (specific denial of permissions) overrides the group  positive permission set, and the principal's individual positive  permission set overrides the group negative permission set.

Parameters:

 user - the principal whose permission set is to be returned.

Returns:

 the permission set specifying the permissions the principal  is allowed.

 entries

  public abstract Enumeration entries()

 Returns an enumeration of the entries in this ACL. Each element in  the enumeration is of type AclEntry.

Returns:

 an enumeration of the entries in this ACL.

 checkPermission

  public abstract boolean checkPermission(Principal principal,
                                          Permission permission)

 Checks whether or not the specified principal has the specified  permission. If it does, true is returned, otherwise false is returned.  More specifically, this method checks whether the passed permission  is a member of the allowed permission set of the specified principal.  The allowed permission set is determined by the same algorithm as is  used by the getPermissions method.

Parameters:

 principal - the principal, assumed to be a valid authenticated  Principal.

 permission - the permission to be checked for.

Returns:

 true if the principal has the specified permission, false  otherwise.

See Also:

getPermissions

 toString

  public abstract String toString()

 Returns a string representation of the  ACL contents.

Returns:

 a string representation of the ACL contents.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.security.acl.AclEntry

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.security.acl.AclEntry

 public interface AclEntry

 extends Cloneable

This is the interface used for representing one entry in an Access  Control List (ACL).

 An ACL can be thought of as a data structure with multiple ACL entry  objects. Each ACL entry object contains a set of permissions associated  with a particular principal. (A principal represents an entity such as  an individual user or a group). Additionally, each ACL entry is specified  as being either positive or negative. If positive, the permissions are  to be granted to the associated principal. If negative, the permissions  are to be denied. Each principal can have at most one positive ACL entry  and one negative entry; that is, multiple positive or negative ACL  entries are not allowed for any principal.  Note: ACL entries are by default positive. An entry becomes a  negative entry only if the setNegativePermissions  method is called on it.

See Also:

Acl

______________________________________________________________________________

 	addPermission(Permission)

 Adds the specified permission to this ACL entry.

 	checkPermission(Permission)

 Checks if the specified permission is part of the  permission set in this entry.

 	clone()

 Clones this ACL entry.

 	getPrincipal()

 Returns the principal for which permissions are granted or denied by  this ACL entry.

 	isNegative()

 Returns true if this is a negative ACL entry (one denying the  associated principal the set of permissions in the entry), false  otherwise.

 	permissions()

 Returns an enumeration of the permissions in this ACL entry.

 	removePermission(Permission)

 Removes the specified permission from this ACL entry.

 	setNegativePermissions()

 Sets this ACL entry to be a negative one.

 	setPrincipal(Principal)

 Specifies the principal for which permissions are granted or denied  by this ACL entry.

 	toString()

 Returns a string representation of the contents of this ACL entry.

 setPrincipal

  public abstract boolean setPrincipal(Principal user)

 Specifies the principal for which permissions are granted or denied  by this ACL entry. If a principal was already set for this ACL entry,  false is returned, otherwise true is returned.

Parameters:

 user - the principal to be set for this entry.

Returns:

 true if the principal is set, false if there was  already a principal set for this entry.

 getPrincipal

  public abstract Principal getPrincipal()

 Returns the principal for which permissions are granted or denied by  this ACL entry. Returns null if there is no principal set for this  entry yet.

Returns:

 the principal associated with this entry.

 setNegativePermissions

  public abstract void setNegativePermissions()

 Sets this ACL entry to be a negative one. That is, the associated  principal (e.g., a user or a group) will be denied the permission set  specified in the entry.  Note: ACL entries are by default positive. An entry becomes a  negative entry only if this setNegativePermissions  method is called on it.

 isNegative

  public abstract boolean isNegative()

 Returns true if this is a negative ACL entry (one denying the  associated principal the set of permissions in the entry), false  otherwise.

Returns:

 true if this is a negative ACL entry, false if it's not.

 addPermission

  public abstract boolean addPermission(Permission permission)

 Adds the specified permission to this ACL entry. Note: An entry can  have multiple permissions.

Parameters:

 permission - the permission to be associated with  the principal in this entry.

Returns:

 true if the permission was added, false if the  permission was already part of this entry's permission set.

 removePermission

  public abstract boolean removePermission(Permission permission)

 Removes the specified permission from this ACL entry.

Parameters:

 permission - the permission to be removed from this entry.

Returns:

 true if the permission is removed, false if the  permission was not part of this entry's permission set.

 checkPermission

  public abstract boolean checkPermission(Permission permission)

 Checks if the specified permission is part of the  permission set in this entry.

Parameters:

 permission - the permission to be checked for.

Returns:

 true if the permission is part of the  permission set in this entry, false otherwise.

 permissions

  public abstract Enumeration permissions()

 Returns an enumeration of the permissions in this ACL entry.

Returns:

 an enumeration of the permissions in this ACL entry.

 toString

  public abstract String toString()

 Returns a string representation of the contents of this ACL entry.

Returns:

 a string representation of the contents.

Overrides:

toString in class Object

 clone

  public abstract Object clone()

 Clones this ACL entry.

Returns:

 a clone of this ACL entry.

Overrides:

clone in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.security.acl.AclNotFoundException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.security.acl.AclNotFoundException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.security.acl.AclNotFoundException

______________________________________________________________________________

 public class AclNotFoundException

 extends Exception

This is an exception that is thrown whenever a reference is made to a  non-existent ACL (Access Control List).

______________________________________________________________________________

 	AclNotFoundException()

 Constructs an AclNotFoundException.

 AclNotFoundException

  public AclNotFoundException()

 Constructs an AclNotFoundException.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.security.acl.Group

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.security.acl.Group

 public interface Group

 extends Principal

This interface is used to represent a group of principals. (A principal  represents an entity such as an individual user or a company).

 Note that Group extends Principal. Thus, either a Principal or a Group can  be passed as an argument to methods containing a Principal parameter. For  example, you can add either a Principal or a Group to a Group object by  calling the object's addMember method, passing it the  Principal or Group.

______________________________________________________________________________

 	addMember(Principal)

 Adds the specified member to the group.

 	isMember(Principal)

 Returns true if the passed principal is a member of the group.

 	members()

 Returns an enumeration of the members in the group.

 	removeMember(Principal)

 Removes the specified member from the group.

 addMember

  public abstract boolean addMember(Principal user)

 Adds the specified member to the group.

Parameters:

 user - the principal to add to this group.

Returns:

 true if the member was successfully added,  false if the principal was already a member.

 removeMember

  public abstract boolean removeMember(Principal user)

 Removes the specified member from the group.

Parameters:

 user - the principal to remove from this group.

Returns:

 true if the principal was removed, or  false if the principal was not a member.

 isMember

  public abstract boolean isMember(Principal member)

 Returns true if the passed principal is a member of the group.  This method does a recursive search, so if a principal belongs to a  group which is a member of this group, true is returned.

Parameters:

 member - the principal whose membership is to be checked.

Returns:

 true if the principal is a member of this group,  false otherwise.

 members

  public abstract Enumeration members()

 Returns an enumeration of the members in the group.  The returned objects can be instances of either Principal  or Group (which is a subclass of Principal).

Returns:

 an enumeration of the group members.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.security.acl.LastOwnerException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.security.acl.LastOwnerException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.security.acl.LastOwnerException

______________________________________________________________________________

 public class LastOwnerException

 extends Exception

This is an exception that is thrown whenever an attempt is made to delete  the last owner of an Access Control List.

See Also:

deleteOwner

______________________________________________________________________________

 	LastOwnerException()

 Constructs a LastOwnerException.

 LastOwnerException

  public LastOwnerException()

 Constructs a LastOwnerException.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.security.acl.NotOwnerException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.security.acl.NotOwnerException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.security.acl.NotOwnerException

______________________________________________________________________________

 public class NotOwnerException

 extends Exception

This is an exception that is thrown whenever the modification of an object  (such as an Access Control List) is only allowed to be done by an owner of  the object, but the Principal attempting the modification is not an owner.

______________________________________________________________________________

 	NotOwnerException()

 Constructs a NotOwnerException.

 NotOwnerException

  public NotOwnerException()

 Constructs a NotOwnerException.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.security.acl.Owner

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.security.acl.Owner

 public interface Owner

Interface for managing owners of Access Control Lists (ACLs) or ACL  configurations. (Note that the Acl interface in the   java.security.acl   package extends this Owner  interface.) The initial owner Principal should be specified as an  argument to the constructor of the class implementing this interface.

See Also:

Acl

______________________________________________________________________________

 	addOwner(Principal, Principal)

 Adds an owner.

 	deleteOwner(Principal, Principal)

 Deletes an owner.

 	isOwner(Principal)

 Returns true if the given principal is an owner of the ACL.

 addOwner

  public abstract boolean addOwner(Principal caller,
                                   Principal owner) throws NotOwnerException

 Adds an owner. Only owners can modify ACL contents. The caller  principal must be an owner of the ACL in order to invoke this method.  That is, only an owner can add another owner. The initial owner is  configured at ACL construction time.

Parameters:

 caller - the principal invoking this method. It must be an owner  of the ACL.

 owner - the owner that should be added to the list of owners.

Returns:

 true if successful, false if owner is already an owner.

Throws: NotOwnerException

 if the caller principal is not an owner  of the ACL.

 deleteOwner

  public abstract boolean deleteOwner(Principal caller,
                                      Principal owner) throws NotOwnerException , LastOwnerException

 Deletes an owner. If this is the last owner in the ACL, an exception is  raised.

 The caller principal must be an owner of the ACL in order to invoke  this method.

Parameters:

 caller - the principal invoking this method. It must be an owner  of the ACL.

 owner - the owner to be removed from the list of owners.

Returns:

 true if the owner is removed, false if the owner is not part  of the list of owners.

Throws: NotOwnerException

 if the caller principal is not an owner  of the ACL.

Throws: LastOwnerException

 if there is only one owner left, so that  deleteOwner would leave the ACL owner-less.

 isOwner

  public abstract boolean isOwner(Principal owner)

 Returns true if the given principal is an owner of the ACL.

Parameters:

 owner - the principal to be checked to determine whether or not  it is an owner.

Returns:

 true if the passed principal is in the list of owners, false  if not.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.security.acl.Permission

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.security.acl.Permission

 public interface Permission

This interface represents a permission, such as that used to grant  a particular type of access to a resource.

______________________________________________________________________________

 	equals(Object)

 Returns true if the object passed matches the permission represented  in this interface.

 	toString()

 Prints a string representation of this permission.

 equals

  public abstract boolean equals(Object another)

 Returns true if the object passed matches the permission represented  in this interface.

Parameters:

 another - the Permission object to compare with.

Returns:

 true if the Permission objects are equal, false otherwise

Overrides:

equals in class Object

 toString

  public abstract String toString()

 Prints a string representation of this permission.

Returns:

 the string representation of the permission.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.security.Certificate

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.security.Certificate

 public interface Certificate

This is an interface of abstract methods for managing an  identity certificate. An identity certificate is a guarantee by a  principal that a public key is that of another principal. (A  principal represents an entity such as an individual user or a  group.)

In particular, this interface is intended to be a common  abstraction for constructs that have different formats but  important common uses. For example, different types of  certificates, such as X.509 certificates and PGP certificates,  share general certificate functionality (the need to encode and  decode certificates) and some types of information, such as a  public key, the principal whose key it is, and the guarantor  guaranteeing that the public key is that of the specified  principal. So an implementation of X.509 certificates and an  implementation of PGP certificates can both utilize the Certificate  interface, even though their formats and additional types and  amounts of information stored are different.

Important: This interface is useful for cataloging and  grouping objects sharing certain common uses. It does not have any  semantics of its own. In particular, a Certificate object does not  make any statement as to the validity of the binding. It is  the duty of the application implementing this interface to verify  the certificate and satisfy itself of its validity.

______________________________________________________________________________

 	decode(InputStream)

 Decodes a certificate from an input stream.

 	encode(OutputStream)

 Encodes the certificate to an output stream in a format that can  be decoded by the decode method.

 	getFormat()

 Returns the name of the coding format.

 	getGuarantor()

 Returns the guarantor of the certificate, that is, the principal  guaranteeing that the public key associated with this certificate  is that of the principal associated with this certificate.

 	getPrincipal()

 Returns the principal of the principal-key pair being guaranteed by  the guarantor.

 	getPublicKey()

 Returns the key of the principal-key pair being guaranteed by  the guarantor.

 	toString(boolean)

 Returns a string that represents the contents of the certificate.

 getGuarantor

  public abstract Principal getGuarantor()

 Returns the guarantor of the certificate, that is, the principal  guaranteeing that the public key associated with this certificate  is that of the principal associated with this certificate. For X.509  certificates, the guarantor will typically be a Certificate Authority  (such as the United States Postal Service or Verisign, Inc.).

Returns:

 the guarantor which guaranteed the principal-key  binding.

 getPrincipal

  public abstract Principal getPrincipal()

 Returns the principal of the principal-key pair being guaranteed by  the guarantor.

Returns:

 the principal to which this certificate is bound.

 getPublicKey

  public abstract PublicKey getPublicKey()

 Returns the key of the principal-key pair being guaranteed by  the guarantor.

Returns:

 the public key that this certificate certifies belongs  to a particular principal.

 encode

  public abstract void encode(OutputStream stream) throws KeyException, IOException

 Encodes the certificate to an output stream in a format that can  be decoded by the decode method.

Parameters:

 stream - the output stream to which to encode the  certificate.

Throws: KeyException

 if the certificate is not  properly initialized, or data is missing, etc.

Throws: IOException

 if a stream exception occurs while  trying to output the encoded certificate to the output stream.

See Also:

decode, getFormat

 decode

  public abstract void decode(InputStream stream) throws KeyException, IOException

 Decodes a certificate from an input stream. The format should be  that returned by getFormat and produced by  encode.

Parameters:

 stream - the input stream from which to fetch the data  being decoded.

Throws: KeyException

 if the certificate is not properly initialized,  or data is missing, etc.

Throws: IOException

 if an exception occurs while trying to input  the encoded certificate from the input stream.

See Also:

encode, getFormat

 getFormat

  public abstract String getFormat()

 Returns the name of the coding format. This is used as a hint to find  an appropriate parser. It could be "X.509", "PGP", etc. This is  the format produced and understood by the encode  and decode methods.

Returns:

 the name of the coding format.

 toString

  public abstract String toString(boolean detailed)

 Returns a string that represents the contents of the certificate.

Parameters:

 detailed - whether or not to give detailed information  about the certificate.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.security.DigestException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.security.DigestException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.security.DigestException

______________________________________________________________________________

 public class DigestException

 extends Exception

This is the generic Message Digest exception.

______________________________________________________________________________

 	DigestException()

 Constructs a DigestException with no detail message.

 	DigestException(String)

 Constructs a DigestException with the specified detail  message.

 DigestException

  public DigestException()

 Constructs a DigestException with no detail message. (A  detail message is a String that describes this particular  exception.)

 DigestException

  public DigestException(String msg)

 Constructs a DigestException with the specified detail  message. (A detail message is a String that describes this  particular exception.)

Parameters:

 msg - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.security.DigestInputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.security.DigestInputStream

java.lang.Object
   |
   +----java.io.InputStream
           |
           +----java.io.FilterInputStream
                   |
                   +----java.security.DigestInputStream

______________________________________________________________________________

 public class DigestInputStream

 extends FilterInputStream

A transparent stream that updates the associated message digest using  the bits going through the stream.

To complete the message digest computation, call one of the  digest  methods on the associated message  digest after your calls to one of this digest input stream's read methods.

It is possible to turn this stream on or off (see on). When it is on, a call to read  results in an update on the message digest. But when it is off,  the message digest is not updated. The default is for the stream  to be on.

Note that digest objects can compute only one digest (see MessageDigest ),  so that in order to compute intermediate digests, a caller should  retain a handle onto the digest object, and clone it for each  digest to be computed, leaving the orginal digest untouched.

See Also:

MessageDigest, DigestOutputStream

______________________________________________________________________________

 	digest

 The message digest associated with this stream.

 	DigestInputStream(InputStream, MessageDigest)

 Creates a digest input stream, using the specified input stream  and message digest.

 	getMessageDigest()

 Returns the message digest associated with this stream.

 	on(boolean)

 Turns the digest function on or off.

 	read()

 Reads a byte, and updates the message digest (if the digest  function is on).

 	read(byte[], int, int)

 Reads into a byte array, and updates the message digest (if the  digest function is on).

 	setMessageDigest(MessageDigest)

 Associates the specified message digest with this stream.

 	toString()

 Prints a string representation of this digest input stream and  its associated message digest object.

 digest

  protected MessageDigest digest

 The message digest associated with this stream.

 DigestInputStream

  public DigestInputStream(InputStream stream,
                           MessageDigest digest)

 Creates a digest input stream, using the specified input stream  and message digest.

Parameters:

 stream - the input stream.

 digest - the message digest to associate with this stream.

 getMessageDigest

  public MessageDigest getMessageDigest()

 Returns the message digest associated with this stream.

Returns:

 the message digest associated with this stream.

 setMessageDigest

  public void setMessageDigest(MessageDigest digest)

 Associates the specified message digest with this stream.

Parameters:

 digest - the message digest to be associated with this stream.

 read

  public int read() throws IOException

 Reads a byte, and updates the message digest (if the digest  function is on). That is, this method reads a byte from the  input stream, blocking until the byte is actually read. If the  digest function is on (see on ), this method  will then call update on the message digest associated  with this stream, passing it the byte read.

Returns:

 the byte read.

Throws: IOException

 if an I/O error occurs.

Overrides:

read in class FilterInputStream

See Also:

update

 read

  public int read(byte b[],
                  int off,
                  int len) throws IOException

 Reads into a byte array, and updates the message digest (if the  digest function is on). That is, this method reads up to  len  bytes from the input stream into the array  b, starting at offset off . This method  blocks until the data is actually  read. If the digest function is on (see on ), this method will then call update  on the message digest associated with this stream, passing it  the data.

Parameters:

 b - the array into which the data is read.

 off - the starting offset into b of where the  data should be placed.

 len - the maximum number of bytes to be read from the input  stream into b, starting at offset off.

Returns:

 the actual number of bytes read. This is less than  len  if the end of the stream is reached prior to  reading len  bytes. -1 is returned if no bytes were  read because the end of the stream had already been reached when  the call was made.

Throws: IOException

 if an I/O error occurs.

Overrides:

read in class FilterInputStream

See Also:

update

 on

  public void on(boolean on)

 Turns the digest function on or off. The default is on. When  it is on, a call to read results in an  update on the message digest. But when it is off, the message  digest is not updated.

Parameters:

 on - true to turn the digest function on, false to turn  it off.

 toString

  public String toString()

 Prints a string representation of this digest input stream and  its associated message digest object.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.security.DigestOutputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.security.DigestOutputStream

java.lang.Object
   |
   +----java.io.OutputStream
           |
           +----java.io.FilterOutputStream
                   |
                   +----java.security.DigestOutputStream

______________________________________________________________________________

 public class DigestOutputStream

 extends FilterOutputStream

A transparent stream that updates the associated message digest using  the bits going through the stream.

To complete the message digest computation, call one of the  digest  methods on the associated message  digest after your calls to one of this digest ouput stream's write methods.

It is possible to turn this stream on or off (see on). When it is on, a call to write results in  an update on the message digest. But when it is off, the message  digest is not updated. The default is for the stream to be on.

See Also:

MessageDigest, DigestInputStream

______________________________________________________________________________

 	digest

 The message digest associated with this stream.

 	DigestOutputStream(OutputStream, MessageDigest)

 Creates a digest output stream, using the specified output stream  and message digest.

 	getMessageDigest()

 Returns the message digest associated with this stream.

 	on(boolean)

 Turns the digest function on or off.

 	setMessageDigest(MessageDigest)

 Associates the specified message digest with this stream.

 	toString()

 Prints a string representation of this digest output stream and  its associated message digest object.

 	write(byte[], int, int)

 Updates the message digest (if the digest function is on) using  the specified subarray, and in any case writes the subarray to  the output stream.

 	write(int)

 Updates the message digest (if the digest function is on) using  the specified byte, and in any case writes the byte  to the output stream.

 digest

  protected MessageDigest digest

 The message digest associated with this stream.

 DigestOutputStream

  public DigestOutputStream(OutputStream stream,
                            MessageDigest digest)

 Creates a digest output stream, using the specified output stream  and message digest.

Parameters:

 stream - the output stream.

 digest - the message digest to associate with this stream.

 getMessageDigest

  public MessageDigest getMessageDigest()

 Returns the message digest associated with this stream.

Returns:

 the message digest associated with this stream.

 setMessageDigest

  public void setMessageDigest(MessageDigest digest)

 Associates the specified message digest with this stream.

Parameters:

 digest - the message digest to be associated with this stream.

 write

  public void write(int b) throws IOException

 Updates the message digest (if the digest function is on) using  the specified byte, and in any case writes the byte  to the output stream. That is, if the digest function is on  (see on), this method calls   update on the message digest associated with this  stream, passing it the byte b. This method then  writes the byte to the output stream, blocking until the byte  is actually written.

Parameters:

 b - the byte to be used for updating and writing to the  output stream.

Throws: IOException

 if an I/O error occurs.

Overrides:

write in class FilterOutputStream

See Also:

update

 write

  public void write(byte b[],
                    int off,
                    int len) throws IOException

 Updates the message digest (if the digest function is on) using  the specified subarray, and in any case writes the subarray to  the output stream. That is, if the digest function is on (see  on), this method calls update  on the message digest associated with this stream, passing it  the subarray specifications. This method then writes the subarray  bytes to the output stream, blocking until the bytes are actually  written.

Parameters:

 b - the array containing the subarray to be used for updating  and writing to the output stream.

 off - the offset into b of the first byte to  be updated and written.

 len - the number of bytes of data to be updated and written  from b , starting at offset off.

Throws: IOException

 if an I/O error occurs.

Overrides:

write in class FilterOutputStream

See Also:

update

 on

  public void on(boolean on)

 Turns the digest function on or off. The default is on. When  it is on, a call to write results in an  update on the message digest. But when it is off, the message  digest is not updated.

Parameters:

 on - true to turn the digest function on, false to turn it  off.

 toString

  public String toString()

 Prints a string representation of this digest output stream and  its associated message digest object.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.security.Identity

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.security.Identity

java.lang.Object
   |
   +----java.security.Identity

______________________________________________________________________________

 public class Identity

 extends Object

 implements Principal, Serializable

This class represents identities: real-world objects such as people,  companies or organizations whose identities can be authenticated using  their public keys. Identities may also be more abstract (or concrete)  constructs, such as daemon threads or smart cards.

All Identity objects have a name and a public key. Names are  immutable. Identities may also be scoped. That is, if an Identity is  specified to have a particular scope, then the name and public  key of the Identity are unique within that scope.

An Identity also has a set of certificates (all certifying its own  public key). The Principal names specified in these certificates need  not be the same, only the key.

An Identity can be subclassed, to include postal and email addresses,  telephone numbers, images of faces and logos, and so on.

See Also:

IdentityScope, Signer, Principal

______________________________________________________________________________

 	Identity()

 Constructor for serialization only.

 	Identity(String)

 Constructs an identity with the specified name and no scope.

 	Identity(String, IdentityScope)

 Constructs an identity with the specified name and scope.

 	addCertificate(Certificate)

 Adds a certificate for this identity.

 	certificates()

 Returns a copy of all the certificates for this identity.

 	equals(Object)

 Tests for equality between the specified object and this identity.

 	getInfo()

 Returns general information previously specified for this identity.

 	getName()

 Returns this identity's name.

 	getPublicKey()

 Returns this identity's public key.

 	getScope()

 Returns this identity's scope.

 	hashCode()

 Returns a hashcode for this identity.

 	identityEquals(Identity)

 Tests for equality between the specified identity and this identity.

 	removeCertificate(Certificate)

 Removes a certificate from this identity.

 	setInfo(String)

 Specifies a general information string for this identity.

 	setPublicKey(PublicKey)

 Sets this identity's public key.

 	toString()

 Returns a short string describing this identity, telling its  name and its scope (if any).

 	toString(boolean)

 Returns a string representation of this identity, with  optionally more details than that provided by the  toString  method without any arguments.

 Identity

  protected Identity()

 Constructor for serialization only.

 Identity

  public Identity(String name,
                  IdentityScope scope) throws KeyManagementException

 Constructs an identity with the specified name and scope.

Parameters:

 name - the identity name.

 scope - the scope of the identity.

Throws: KeyManagementException

 if there is already an identity  with the same name in the scope.

 Identity

  public Identity(String name)

 Constructs an identity with the specified name and no scope.

Parameters:

 name - the identity name.

 getName

  public final String getName()

 Returns this identity's name.

Returns:

 the name of this identity.

 getScope

  public final IdentityScope getScope()

 Returns this identity's scope.

Returns:

 the scope of this identity.

 getPublicKey

  public PublicKey getPublicKey()

 Returns this identity's public key.

Returns:

 the public key for this identity.

 setPublicKey

  public void setPublicKey(PublicKey key) throws KeyManagementException

 Sets this identity's public key. The old key and all of this  identity's certificates are removed by this operation.

Parameters:

 key - the public key for this identity.

Throws: KeyManagementException

 if another identity in the  identity's scope has the same public key, or if another exception occurs.

 setInfo

  public void setInfo(String info)

 Specifies a general information string for this identity.

Parameters:

 info - the information string.

See Also:

getInfo

 getInfo

  public String getInfo()

 Returns general information previously specified for this identity.

Returns:

 general information about this identity.

See Also:

setInfo

 addCertificate

  public void addCertificate(Certificate certificate) throws KeyManagementException

 Adds a certificate for this identity. If the identity has a public  key, the public key in the certificate must be the same, and if  the identity does not have a public key, the identity's  public key is set to be that specified in the certificate.

Parameters:

 certificate - the certificate to be added.

Throws: KeyManagementException

 if the certificate is not valid,  if the public key in the certificate being added conflicts with  this identity's public key, or if another exception occurs.

 removeCertificate

  public void removeCertificate(Certificate certificate) throws KeyManagementException

 Removes a certificate from this identity.

Parameters:

 certificate - the certificate to be removed.

Throws: KeyManagementException

 if the certificate is  missing, or if another exception occurs.

 certificates

  public Certificate[] certificates()

 Returns a copy of all the certificates for this identity.

Returns:

 a copy of all the certificates for this identity.

 equals

  public final boolean equals(Object identity)

 Tests for equality between the specified object and this identity.  This first tests to see if the entities actually refer to the same  object, in which case it returns true. Next, it checks to see if  the entities have the same name and the same scope. If they do,  the method returns true. Otherwise, it calls identityEquals, which subclasses should  override.

Parameters:

 identity - the object to test for equality with this identity.

Returns:

 true if the objects are considered equal, false otherwise.

Overrides:

equals in class Object

See Also:

identityEquals

 identityEquals

  protected boolean identityEquals(Identity identity)

 Tests for equality between the specified identity and this identity.  This method should be overriden by subclasses to test for equality.  The default behavior is to return true if the names and public keys  are equal.

Parameters:

 identity - the identity to test for equality with this identity.

Returns:

 true if the identities are considered equal, false  otherwise.

See Also:

equals

 toString

  public String toString()

 Returns a short string describing this identity, telling its  name and its scope (if any).

Returns:

 information about this identity, such as its name and the  name of its scope (if any).

Overrides:

toString in class Object

 toString

  public String toString(boolean detailed)

 Returns a string representation of this identity, with  optionally more details than that provided by the  toString  method without any arguments.

Parameters:

 detailed - whether or not to provide detailed information.

Returns:

 information about this identity. If detailed  is true, then this method returns more information than that  provided by the toString  method without any arguments.

See Also:

toString

 hashCode

  public int hashCode()

 Returns a hashcode for this identity.

Returns:

 a hashcode for this identity.

Overrides:

hashCode in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.security.IdentityScope

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.security.IdentityScope

java.lang.Object
   |
   +----java.security.Identity
           |
           +----java.security.IdentityScope

______________________________________________________________________________

 public class IdentityScope

 extends Identity

This class represents a scope for identities. It is an Identity  itself, and therefore has a name and can have a scope. It can also  optionally have a public key and associated certificates.

An IdentityScope can contain Identity objects of all kinds, including  Signers. All types of Identity objects can be retrieved, added, and  removed using the same methods. Note that it is possible, and in fact  expected, that different types of identity scopes will  apply different policies for their various operations on the  various types of Identities.

There is a one-to-one mapping between keys and identities, and  there can only be one copy of one key per scope. For example, suppose  Acme Software, Inc  is a software publisher known to a user.  Suppose it is an Identity, that is, it has a public key, and a set of  associated certificates. It is named in the scope using the name  "Acme Software". No other named Identity in the scope has the same  public key. Of course, none has the same name as well.

See Also:

Identity, Signer, Principal, Key

______________________________________________________________________________

 	IdentityScope()

 This constructor is used for serialization only and should not  be used by subclasses.

 	IdentityScope(String)

 Constructs a new identity scope with the specified name.

 	IdentityScope(String, IdentityScope)

 Constructs a new identity scope with the specified name and scope.

 	addIdentity(Identity)

 Adds an identity to this identity scope.

 	getIdentity(Principal)

 Retrieves the identity whose name is the same as that of the  specified principal.

 	getIdentity(PublicKey)

 Retrieves the identity with the specified public key.

 	getIdentity(String)

 Returns the identity in this scope with the specified name (if any).

 	getSystemScope()

 Returns the system's identity scope.

 	identities()

 Returns an enumeration of all identities in this identity scope.

 	removeIdentity(Identity)

 Removes an identity from this identity scope.

 	setSystemScope(IdentityScope)

 Sets the system's identity scope.

 	size()

 Returns the number of identities within this identity scope.

 	toString()

 Returns a string representation of this identity scope, including  its name, its scope name, and the number of identities in this  identity scope.

 IdentityScope

  protected IdentityScope()

 This constructor is used for serialization only and should not  be used by subclasses.

 IdentityScope

  public IdentityScope(String name)

 Constructs a new identity scope with the specified name.

Parameters:

 name - the scope name.

 IdentityScope

  public IdentityScope(String name,
                       IdentityScope scope) throws KeyManagementException

 Constructs a new identity scope with the specified name and scope.

Parameters:

 name - the scope name.

 scope - the scope for the new identity scope.

Throws: KeyManagementException

 if there is already an identity  with the same name in the scope.

 getSystemScope

  public static IdentityScope getSystemScope()

 Returns the system's identity scope. See the  "System Identity Scope" section in the  Java Cryptography Architecture API Specification & Reference  .

Returns:

 the system's identity scope.

 setSystemScope

  protected static void setSystemScope(IdentityScope scope)

 Sets the system's identity scope. See the  "System Identity Scope" section in the  Java Cryptography Architecture API Specification & Reference  .

Parameters:

 scope - the scope to set.

 size

  public abstract int size()

 Returns the number of identities within this identity scope.

Returns:

 the number of identities within this identity scope.

 getIdentity

  public abstract Identity getIdentity(String name)

 Returns the identity in this scope with the specified name (if any).

Parameters:

 name - the name of the identity to be retrieved.

Returns:

 the identity named name, or null if there are  no identities named name  in this scope.

 getIdentity

  public Identity getIdentity(Principal principal)

 Retrieves the identity whose name is the same as that of the  specified principal. (Note: Identity implements Principal.)

Parameters:

 principal - the principal corresponding to the identity  to be retrieved.

Returns:

 the identity whose name is the same as that of the  principal, or null if there are no identities of the same name  in this scope.

 getIdentity

  public abstract Identity getIdentity(PublicKey key)

 Retrieves the identity with the specified public key.

Parameters:

 key - the public key for the identity to be returned.

Returns:

 the identity with the given key, or null if there are  no identities in this scope with that key.

 addIdentity

  public abstract void addIdentity(Identity identity) throws KeyManagementException

 Adds an identity to this identity scope.

Parameters:

 identity - the identity to be added.

Throws: KeyManagementException

 if the identity is not  valid, a name conflict occurs, another identity has the same  public key as the identity being added, or another exception  occurs.

 removeIdentity

  public abstract void removeIdentity(Identity identity) throws KeyManagementException

 Removes an identity from this identity scope.

Parameters:

 identity - the identity to be removed.

Throws: KeyManagementException

 if the identity is missing,  or another exception occurs.

 identities

  public abstract Enumeration identities()

 Returns an enumeration of all identities in this identity scope.

Returns:

 an enumeration of all identities in this identity scope.

 toString

  public String toString()

 Returns a string representation of this identity scope, including  its name, its scope name, and the number of identities in this  identity scope.

Returns:

 a string representation of this identity scope.

Overrides:

toString in class Identity

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.security.interfaces.DSAKey

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.security.interfaces.DSAKey

 public interface DSAKey

The interface to a DSA public or private key. DSA (Digital Signature  Algorithm) is defined in NIST's FIPS-186.

See Also:

DSAParams, Key, Signature

______________________________________________________________________________

 	getParams()

 Returns the DSA-specific key parameters.

 getParams

  public abstract DSAParams getParams()

 Returns the DSA-specific key parameters. These parameters are  never secret.

Returns:

 the DSA-specific key parameters.

See Also:

DSAParams

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.security.interfaces.DSAKeyPairGenerator

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.security.interfaces.DSAKeyPairGenerator

 public interface DSAKeyPairGenerator

An interface to an object capable of generating DSA key pairs.

The initialize methods may each be called any number  of times. If no initialize method is called on a  DSAKeyPairGenerator, the default is to generate 1024-bit keys, using  precomputed p, q and g parameters and an instance of SecureRandom as  the random bit source.

Users wishing to indicate DSA-specific parameters, and to generate a key  pair suitable for use with the DSA algorithm typically

1. Get a key pair generator for the DSA algorithm by calling the  KeyPairGenerator getInstance method with "DSA"  as its argument.

2. Initialize the generator by casting the result to a DSAKeyPairGenerator  and calling one of the  initialize methods from this DSAKeyPairGenerator interface.

3. Generate a key pair by calling the generateKeyPair  method from the KeyPairGenerator class.

Note: it is not always necessary to do do algorithm-specific  initialization for a DSA key pair generator. That is, it is not always  necessary to call an initialize method in this interface.  Algorithm-independent initialization using the initialize method  in the KeyPairGenerator  interface is all that is needed when you accept defaults for algorithm-specific  parameters.

See Also:

KeyPairGenerator

______________________________________________________________________________

 	initialize(DSAParams, SecureRandom)

 Initializes the key pair generator using p, q and g, the DSA  family parameters.

 	initialize(int, boolean, SecureRandom)

 Initializes the key pair generator for a given modulus length,  without parameters.

 initialize

  public abstract void initialize(DSAParams params,
                                  SecureRandom random) throws InvalidParameterException

 Initializes the key pair generator using p, q and g, the DSA  family parameters.

Parameters:

 params - the parameters to use to generate the keys.

 random - the random bit source to use to generate  key bits.

Throws: InvalidParameterException

 if the parameters passed are  invalid or null.

 initialize

  public abstract void initialize(int modlen,
                                  boolean genParams,
                                  SecureRandom random) throws InvalidParameterException

 Initializes the key pair generator for a given modulus length,  without parameters.

If genParams is true, this method will generate new  p, q and g parameters. If it is false, the method will use precomputed  parameters for the modulus length requested. If there are no  precomputed parameters for that modulus length, an exception will be  thrown. It is guaranteed that there will always be  default parameters for modulus lengths of 512 and 1024 bits.

Parameters:

 modlen - the modulus length, in bits. Valid values are any  multiple of 8 between 512 and 1024, inclusive.

 random - the random bit source to use to generate  key bits.

 genParams - whether or not to generate new parameters for  the modulus length requested.

Throws: InvalidParameterException

 if the modulus length is not  between 512 and 1024, or if genParams is false and there are  not precomputed parameters for the modulus length requested.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.security.interfaces.DSAParams

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.security.interfaces.DSAParams

 public interface DSAParams

Interface to a DSA-specific set of key parameters, which defines a  DSA key family . DSA (Digital Signature Algorithm) is defined  in NIST's FIPS-186.

See Also:

DSAKey, Key, Signature

______________________________________________________________________________

 	getG()

 Returns the base, g.

 	getP()

 Returns the prime, p.

 	getQ()

 Returns the subprime, q.

 getP

  public abstract BigInteger getP()

 Returns the prime, p.

Returns:

 the prime, p.

 getQ

  public abstract BigInteger getQ()

 Returns the subprime, q.

Returns:

 the subprime, q.

 getG

  public abstract BigInteger getG()

 Returns the base, g.

Returns:

 the base, g.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.security.interfaces.DSAPrivateKey

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.security.interfaces.DSAPrivateKey

 public interface DSAPrivateKey

 extends DSAKey, PrivateKey

The standard interface to a DSA private key. DSA (Digital Signature  Algorithm) is defined in NIST's FIPS-186.

See Also:

Key, Signature, DSAKey, DSAPublicKey

______________________________________________________________________________

 	getX()

 Returns the value of the private key, x.

 getX

  public abstract BigInteger getX()

 Returns the value of the private key, x.

Returns:

 the value of the private key, x.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.security.interfaces.DSAPublicKey

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.security.interfaces.DSAPublicKey

 public interface DSAPublicKey

 extends DSAKey, PublicKey

The interface to a DSA public key. DSA (Digital Signature Algorithm)  is defined in NIST's FIPS-186.

See Also:

Key, KeyParams, Signature

______________________________________________________________________________

 	getY()

 Returns the value of the public key, y.

 getY

  public abstract BigInteger getY()

 Returns the value of the public key, y.

Returns:

 the value of the public key, y.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.security.InvalidKeyException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.security.InvalidKeyException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.security.KeyException
                           |
                           +----java.security.InvalidKeyException

______________________________________________________________________________

 public class InvalidKeyException

 extends KeyException

This is the exception for invalid Keys (invalid encoding, wrong  length, uninitialized, etc).

______________________________________________________________________________

 	InvalidKeyException()

 Constructs an InvalidKeyException with no detail message.

 	InvalidKeyException(String)

 Constructs an InvalidKeyException with the specified detail  message.

 InvalidKeyException

  public InvalidKeyException()

 Constructs an InvalidKeyException with no detail message. A  detail message is a String that describes this particular  exception.

 InvalidKeyException

  public InvalidKeyException(String msg)

 Constructs an InvalidKeyException with the specified detail  message. A detail message is a String that describes this  particular exception.

Parameters:

 msg - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.security.InvalidParameterException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.security.InvalidParameterException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.RuntimeException
                           |
                           +----java.lang.IllegalArgumentException
                                   |
                                   +----java.security.InvalidParameterException

______________________________________________________________________________

 public class InvalidParameterException

 extends IllegalArgumentException

This exception is thrown when an invalid parameter is passed  to a method.

______________________________________________________________________________

 	InvalidParameterException()

 Constructs an InvalidParameterException with no detail message.

 	InvalidParameterException(String)

 Constructs an InvalidParameterException with the specified  detail message.

 InvalidParameterException

  public InvalidParameterException()

 Constructs an InvalidParameterException with no detail message.  A detail message is a String that describes this particular  exception.

 InvalidParameterException

  public InvalidParameterException(String msg)

 Constructs an InvalidParameterException with the specified  detail message. A detail message is a String that describes  this particular exception.

Parameters:

 msg - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.security.Key

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.security.Key

 public interface Key

 extends Serializable

The Key interface is the top-level interface for all keys. It  defines the functionality shared by all key objects. All keys  have three characteristics:

• An Algorithm

This is the key algorithm for that key. The key algorithm is usually  an encryption or asymmetric operation algorithm (such as DSA or  RSA), which will work with those algorithms and with related  algorithms (such as MD5 with RSA, SHA-1 with RSA, Raw DSA, etc.)  The name of the algorithm of a key is obtained using the  getAlgorithm method.

• An Encoded Form

This is an external encoded form for the key used when a standard  representation of the key is needed outside the Java Virtual Machine,  as when transmitting the key to some other party. The key  is encoded according to a standard format (such as X.509  or PKCS#8), and is returned using the  getEncoded method.

• A Format

This is the name of the format of the encoded key. It is returned  by the getFormat  method.

 Keys are generally obtained through key generators, certificates,  or various Identity classes used to manage keys. There are no  provisions in this release for the parsing of encoded keys and  certificates.

See Also:

PublicKey, PrivateKey, KeyPair, KeyPairGenerator, Identity , IdentityScope, Signer

______________________________________________________________________________

 	getAlgorithm()

 Returns the standard algorithm name this key is for.

 	getEncoded()

 Returns the encoded key.

 	getFormat()

 Returns the format used to encode the key or null if the key does not  support encoding.

 getAlgorithm

  public abstract String getAlgorithm()

 Returns the standard algorithm name this key is for. For  example, "DSA" would indicate that this key is a DSA key.  Note that this method may return null, when the  algorithm this key is for is unknown.

See Appendix A in the  Java Cryptography Architecture API Specification & Reference    for information about standard algorithm names.

Returns:

 the name of the algorithm this key is for, or null  if the algorithm this key is for is unknown.

 getFormat

  public abstract String getFormat()

 Returns the format used to encode the key or null if the key does not  support encoding.

Returns:

 the format used to encode the key.

 getEncoded

  public abstract byte[] getEncoded()

 Returns the encoded key.

Returns:

 the encoded key, or null if the key does not support  encoding.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.security.KeyException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.security.KeyException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.security.KeyException

______________________________________________________________________________

 public class KeyException

 extends Exception

This is the basic key exception.

See Also:

Key, InvalidKeyException, KeyManagementException

______________________________________________________________________________

 	KeyException()

 Constructs a KeyException with no detail message.

 	KeyException(String)

 Constructs a KeyException with the specified detail message.

 KeyException

  public KeyException()

 Constructs a KeyException with no detail message. A detail  message is a String that describes this particular exception.

 KeyException

  public KeyException(String msg)

 Constructs a KeyException with the specified detail message.  A detail message is a String that describes this particular  exception.

Parameters:

 msg - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.security.KeyManagementException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.security.KeyManagementException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.security.KeyException
                           |
                           +----java.security.KeyManagementException

______________________________________________________________________________

 public class KeyManagementException

 extends KeyException

This is the general key management exception, for all operations  dealing with key management. Subclasses  could include:

• KeyIDConflict

• KeyAuthorizationFailureException

• ExpiredKeyException

See Also:

Key, KeyException

______________________________________________________________________________

 	KeyManagementException()

 Constructs a KeyManagementException with no detail message.

 	KeyManagementException(String)

 Constructs a KeyManagementException with the specified detail  message.

 KeyManagementException

  public KeyManagementException()

 Constructs a KeyManagementException with no detail message. A  detail message is a String that describes this particular  exception.

 KeyManagementException

  public KeyManagementException(String msg)

 Constructs a KeyManagementException with the specified detail  message. A detail message is a String that describes this  particular exception.

Parameters:

 msg - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.security.KeyPair

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.security.KeyPair

java.lang.Object
   |
   +----java.security.KeyPair

______________________________________________________________________________

 public final class KeyPair

 extends Object

This class is a simple holder for a key pair (a public key and a  private key). It does not enforce any security, and, when initialized,  should be treated like a PrivateKey.

See Also:

PublicKey, PrivateKey

______________________________________________________________________________

 	KeyPair(PublicKey, PrivateKey)

 Constructs a key with the specified public key and private key.

 	getPrivate()

 Returns the private key from this key pair.

 	getPublic()

 Returns the public key from this key pair.

 KeyPair

  public KeyPair(PublicKey publicKey,
                 PrivateKey privateKey)

 Constructs a key with the specified public key and private key.

Parameters:

 publicKey - the public key.

 privateKey - the private key.

 getPublic

  public PublicKey getPublic()

 Returns the public key from this key pair.

Returns:

 the public key.

 getPrivate

  public PrivateKey getPrivate()

 Returns the private key from this key pair.

Returns:

 the private key.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.security.KeyPairGenerator

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.security.KeyPairGenerator

java.lang.Object
   |
   +----java.security.KeyPairGenerator

______________________________________________________________________________

 public class KeyPairGenerator

 extends Object

The KeyPairGenerator class is used to generate pairs of  public and private keys. Key generators are constructed using the  getInstance  factory methods (static methods that  return instances of a given class).

Key generation is an area that sometimes  does not lend itself well to algorithm independence. For example,  it is possible to generate a DSA key pair specifying key family  parameters (p, q and g), while it is not possible to do so for  an RSA key pair. That is, those parameters are applicable to DSA  but not to RSA.

There are therefore two ways to generate a key pair: in an  algorithm-independent  manner, and in an algorithm-specific manner. The only difference  between the two is the initialization of the object.

All key pair generators share the concepts of a "strength" and a  source of randomness. The measure of strength is universally shared  by all algorithms,  though it is interpreted differently for different algorithms.  The initialize  method in this  KeyPairGenerator class  takes these two universally shared  types of arguments.

Since no other parameters are specified when you call this  algorithm-independent initialize  method, all other values, such as algorithm parameters, public  exponent, etc., are defaulted to standard values.

 It is sometimes desirable to initialize a key pair generator object  using algorithm-specific semantics. For example, you may want to  initialize a DSA key generator for a given set of parameters  p, q and g,  or an RSA key generator for a given public exponent.

 This is done through algorithm-specific standard interfaces. Rather than  calling the algorithm-independent KeyPairGenerator initialize  method, the key pair generator is cast to an algorithm-specific interface  so that one of its specialized parameter initialization methods can be  called. An example is the DSAKeyPairGenerator interface (from  java.security.interfaces ).

See The KeyPairGenerator Class   in the "Java Cryptography Architecture API Specification & Reference"  for more information and examples.

See Also:

DSAKeyPairGenerator

______________________________________________________________________________

 	KeyPairGenerator(String)

 Creates a KeyPairGenerator object for the specified algorithm.

 	generateKeyPair()

 Generates a key pair.

 	getAlgorithm()

 Returns the standard name of the algorithm for this key generator.

 	getInstance(String)

 Generates a KeyPairGenerator object that implements the algorithm  requested, as available in the environment.

 	getInstance(String, String)

 Generates a KeyPairGenerator object implementing the specified  algorithm, as supplied from the specified provider,  if such an algorithm is available from the provider.

 	initialize(int)

 Initializes the key pair generator for a certain strength using  a system-provided source of randomness.

 	initialize(int, SecureRandom)

 Initializes the key pair generator for a certain strength.

 KeyPairGenerator

  protected KeyPairGenerator(String algorithm)

 Creates a KeyPairGenerator object for the specified algorithm.

Parameters:

 algorithm - the standard string name of the algorithm.  See Appendix A in the  Java Cryptography Architecture API Specification & Reference    for information about standard algorithm names.

 getAlgorithm

  public String getAlgorithm()

 Returns the standard name of the algorithm for this key generator.  See Appendix A in the  Java Cryptography Architecture API Specification & Reference    for information about standard algorithm names.

Returns:

 the standard string name of the algorithm.

 getInstance

  public static KeyPairGenerator getInstance(String algorithm) throws NoSuchAlgorithmException

 Generates a KeyPairGenerator object that implements the algorithm  requested, as available in the environment.

Parameters:

 algorithm - the standard string name of the algorithm.  See Appendix A in the  Java Cryptography Architecture API Specification & Reference    for information about standard algorithm names.

Returns:

 the new KeyPairGenerator object.

Throws: NoSuchAlgorithmException

 if the algorithm is  not available in the environment.

 getInstance

  public static KeyPairGenerator getInstance(String algorithm,
                                             String provider) throws NoSuchAlgorithmException, NoSuchProviderException

 Generates a KeyPairGenerator object implementing the specified  algorithm, as supplied from the specified provider,  if such an algorithm is available from the provider.

Parameters:

 algorithm - the standard string name of the algorithm.  See Appendix A in the  Java Cryptography Architecture API Specification & Reference    for information about standard algorithm names.

 provider - the string name of the provider.

Returns:

 the new KeyPairGenerator object.

Throws: NoSuchAlgorithmException

 if the algorithm is  not available from the provider.

Throws: NoSuchProviderException

 if the provider is not  available in the environment.

See Also:

Provider

 initialize

  public abstract void initialize(int strength,
                                  SecureRandom random)

 Initializes the key pair generator for a certain strength.

Parameters:

 strength - the strength of the key. This is an  algorithm-specific metric, such as modulus length.

 random - the source of randomness for this generator.

 initialize

  public void initialize(int strength)

 Initializes the key pair generator for a certain strength using  a system-provided source of randomness.

Parameters:

 strength - the strength of the key. This is an  algorithm-specific metric, such as modulus length.

 generateKeyPair

  public abstract KeyPair generateKeyPair()

 Generates a key pair. Unless an initialization method is called  using a KeyPairGenerator interface, algorithm-specific defaults  will be used. This will generate a new key pair every time it  is called.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.security.MessageDigest

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.security.MessageDigest

java.lang.Object
   |
   +----java.security.MessageDigest

______________________________________________________________________________

 public class MessageDigest

 extends Object

This MessageDigest class provides the functionality of a message digest  algorithm, such as MD5 or SHA. Message digests are secure one-way  hash functions that take arbitrary-sized data and output a  fixed-length hash value.

Like other algorithm-based classes in Java Security,  MessageDigest has two major components:

Message Digest API (Application Program Interface)

This is the interface of methods called by applications needing  message digest services. The API consists of all public methods.

Message Digest SPI (Service Provider Interface)

This is the interface implemented by providers that supply  specific algorithms. It consists of all methods whose names  are prefixed by engine . Each such method is called by  a correspondingly-named public API method. For example,  the engineReset method is  called by the reset method.  The SPI methods are abstract; providers must supply a  concrete implementation.

A MessageDigest object starts out initialized. The data is  processed through it using the update   methods. At any point reset can be called  to reset the digest. Once all the data to be updated has been  updated, one of the digest  methods should  be called to complete the hash computation.

The digest method can be called once for a given number  of updates. After digest has been called, the MessageDigest  object is reset to its initialized state.

Implementations are free to implement the Cloneable interface,  and doing so will let client applications test cloneability  using instanceof Cloneable  before cloning:

 MessageDigest md = MessageDigest.getInstance("SHA");
 if (md instanceof Cloneable) {
     md.update(toChapter1);
     MessageDigest tc1 = md.clone();
     byte[] toChapter1Digest = tc1.digest;
     md.update(toChapter2);
     ...etc.
 } else {
     throw new DigestException("couldn't make digest of partial content");
 }

Note that if a given implementation is not cloneable, it is  still possible to compute intermediate digests by instantiating  several instances, if the number of digests is known in advance.

See Also:

DigestInputStream, DigestOutputStream

______________________________________________________________________________

 	MessageDigest(String)

 Creates a message digest with the specified algorithm name.

 	clone()

 Returns a clone if the implementation is cloneable.

 	digest()

 Completes the hash computation by performing final operations  such as padding.

 	digest(byte[])

 Performs a final update on the digest using the specified array  of bytes, then completes the digest computation.

 	engineDigest()

SPI: Completes the hash computation by performing final  operations such as padding.

 	engineReset()

SPI: Resets the digest for further use.

 	engineUpdate(byte)

SPI: Updates the digest using the specified byte.

 	engineUpdate(byte[], int, int)

SPI: Updates the digest using the specified array of bytes,  starting at the specified offset.

 	getAlgorithm()

 Returns a string that identifies the algorithm, independent of  implementation details.

 	getInstance(String)

 Generates a MessageDigest object that implements the specified digest  algorithm.

 	getInstance(String, String)

 Generates a MessageDigest object implementing the specified  algorithm, as supplied from the specified provider, if such an  algorithm is available from the provider.

 	isEqual(byte[], byte[])

 Compares two digests for equality.

 	reset()

 Resets the digest for further use.

 	toString()

 Returns a string representation of this message digest object.

 	update(byte)

 Updates the digest using the specified byte.

 	update(byte[])

 Updates the digest using the specified array of bytes.

 	update(byte[], int, int)

 Updates the digest using the specified array of bytes, starting  at the specified offset.

 MessageDigest

  protected MessageDigest(String algorithm)

 Creates a message digest with the specified algorithm name.

Parameters:

 algorithm - the standard name of the digest algorithm.  See Appendix A in the  Java Cryptography Architecture API Specification & Reference    for information about standard algorithm names.

 getInstance

  public static MessageDigest getInstance(String algorithm) throws NoSuchAlgorithmException

 Generates a MessageDigest object that implements the specified digest  algorithm. If the default provider package contains a MessageDigest  subclass implementing the algorithm, an instance of that subclass  is returned. If the algorithm is not available in the default  package, other packages are searched.

Parameters:

 algorithm - the name of the algorithm requested.  See Appendix A in the  Java Cryptography Architecture API Specification & Reference    for information about standard algorithm names.

Returns:

 a Message Digest object implementing the specified  algorithm.

Throws: NoSuchAlgorithmException

 if the algorithm is  not available in the caller's environment.

 getInstance

  public static MessageDigest getInstance(String algorithm,
                                          String provider) throws NoSuchAlgorithmException, NoSuchProviderException

 Generates a MessageDigest object implementing the specified  algorithm, as supplied from the specified provider, if such an  algorithm is available from the provider.

Parameters:

 algorithm - the name of the algorithm requested.  See Appendix A in the  Java Cryptography Architecture API Specification & Reference    for information about standard algorithm names.

 provider - the name of the provider.

Returns:

 a Message Digest object implementing the specified  algorithm.

Throws: NoSuchAlgorithmException

 if the algorithm is  not available in the package supplied by the requested  provider.

Throws: NoSuchProviderException

 if the provider is not  available in the environment.

See Also:

Provider

 update

  public void update(byte input)

 Updates the digest using the specified byte.

Parameters:

 input - the byte with which to update the digest.

 update

  public void update(byte input[],
                     int offset,
                     int len)

 Updates the digest using the specified array of bytes, starting  at the specified offset.

Parameters:

 input - the array of bytes.

 offset - the offset to start from in the array of bytes.

 len - the number of bytes to use, starting at  offset.

 update

  public void update(byte input[])

 Updates the digest using the specified array of bytes.

Parameters:

 input - the array of bytes.

 digest

  public byte[] digest()

 Completes the hash computation by performing final operations  such as padding. The digest is reset after this call is made.

Returns:

 the array of bytes for the resulting hash value.

 digest

  public byte[] digest(byte input[])

 Performs a final update on the digest using the specified array  of bytes, then completes the digest computation. That is, this  method first calls update  on the  array, then calls digest().

Parameters:

 input - the input to be updated before the digest is  completed.

Returns:

 the array of bytes for the resulting hash value.

 toString

  public String toString()

 Returns a string representation of this message digest object.

Overrides:

toString in class Object

 isEqual

  public static boolean isEqual(byte digesta[],
                                byte digestb[])

 Compares two digests for equality. Does a simple byte compare.

Parameters:

 digesta - one of the digests to compare.

 digestb - the other digest to compare.

Returns:

 true if the digests are equal, false otherwise.

 reset

  public void reset()

 Resets the digest for further use.

 getAlgorithm

  public final String getAlgorithm()

 Returns a string that identifies the algorithm, independent of  implementation details. The name should be a standard  Java Security name (such as "SHA", "MD5", and so on).  See Appendix A in the  Java Cryptography Architecture API Specification & Reference    for information about standard algorithm names.

 engineUpdate

  protected abstract void engineUpdate(byte input)

 SPI: Updates the digest using the specified byte.

Parameters:

 input - the byte to use for the update.

 engineUpdate

  protected abstract void engineUpdate(byte input[],
                                       int offset,
                                       int len)

 SPI: Updates the digest using the specified array of bytes,  starting at the specified offset. This should be a no-op if  the digest has been finalized.

Parameters:

 input - the array of bytes to use for the update.

 offset - the offset to start from in the array of bytes.

 len - the number of bytes to use, starting at  offset.

 engineDigest

  protected abstract byte[] engineDigest()

 SPI: Completes the hash computation by performing final  operations such as padding. Once engineDigest has  been called, the engine should be reset (see reset ). Resetting is the responsibility of the  engine implementor.

Returns:

 the array of bytes for the resulting hash value.

 engineReset

  protected abstract void engineReset()

 SPI: Resets the digest for further use.

 clone

  public Object clone() throws CloneNotSupportedException

 Returns a clone if the implementation is cloneable.

Returns:

 a clone if the implementation is cloneable.

Throws: CloneNotSupportedException

 if this is called on an  implementation that does not support Cloneable.

Overrides:

clone in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.security.NoSuchAlgorithmException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.security.NoSuchAlgorithmException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.security.NoSuchAlgorithmException

______________________________________________________________________________

 public class NoSuchAlgorithmException

 extends Exception

This exception is thrown when a particular cryptographic algorithm is  requested but is not available in the environment.

______________________________________________________________________________

 	NoSuchAlgorithmException()

 Constructs a NoSuchAlgorithmException with no detail  message.

 	NoSuchAlgorithmException(String)

 Constructs a NoSuchAlgorithmException with the specified  detail message.

 NoSuchAlgorithmException

  public NoSuchAlgorithmException()

 Constructs a NoSuchAlgorithmException with no detail  message. A detail message is a String that describes this  particular exception.

 NoSuchAlgorithmException

  public NoSuchAlgorithmException(String msg)

 Constructs a NoSuchAlgorithmException with the specified  detail message. A detail message is a String that describes  this particular exception, which may, for example, specify which  algorithm is not available.

Parameters:

 msg - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.security.NoSuchProviderException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.security.NoSuchProviderException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.security.NoSuchProviderException

______________________________________________________________________________

 public class NoSuchProviderException

 extends Exception

This exception is thrown when a particular security provider is  requested but is not available in the environment.

______________________________________________________________________________

 	NoSuchProviderException()

 Constructs a NoSuchProviderException with no detail message.

 	NoSuchProviderException(String)

 Constructs a NoSuchProviderException with the specified detail  message.

 NoSuchProviderException

  public NoSuchProviderException()

 Constructs a NoSuchProviderException with no detail message. A  detail message is a String that describes this particular  exception.

 NoSuchProviderException

  public NoSuchProviderException(String msg)

 Constructs a NoSuchProviderException with the specified detail  message. A detail message is a String that describes this  particular exception.

Parameters:

 msg - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.security.Principal

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.security.Principal

 public interface Principal

This interface represents a principal. A principal can be an  individual, a corporation, a program thread; anything which can  have an identity. See the ACL   white paper for more information.

See Also:

Identity, Certificate, Acl, Group

______________________________________________________________________________

 	equals(Object)

 Compares this principal to the specified object.

 	getName()

 Returns the name of this principal.

 	hashCode()

 Returns a hashcode for this principal.

 	toString()

 Returns a string representation of this principal.

 equals

  public abstract boolean equals(Object another)

 Compares this principal to the specified object. Returns true  if the object passed in matches the principal represented by  the implementation of this interface.

Parameters:

 another - the principal to compare with.

Returns:

 true if  the principal passed in is the same as that encapsulated by  this principal, false otherwise.

Overrides:

equals in class Object

 toString

  public abstract String toString()

 Returns a string representation of this principal.

Returns:

 a string representation of this principal.

Overrides:

toString in class Object

 hashCode

  public abstract int hashCode()

 Returns a hashcode for this principal.

Returns:

 a hashcode for this principal.

Overrides:

hashCode in class Object

 getName

  public abstract String getName()

 Returns the name of this principal.

Returns:

 the name of this principal.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.security.PrivateKey

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.security.PrivateKey

 public interface PrivateKey

 extends Key

A private key. This interface contains no methods or constants. It  merely serves to group (and provide type safety for) all private key  interfaces.  Note: The specialized private key interfaces extend this interface.  See, for example, the DSAPrivateKey interface in  java.security.interfaces.

See Also:

Key, PublicKey, Certificate, initVerify, DSAPrivateKey

______________________________________________________________________________
______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.security.Provider

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.security.Provider

java.lang.Object
   |
   +----java.util.Dictionary
           |
           +----java.util.Hashtable
                   |
                   +----java.util.Properties
                           |
                           +----java.security.Provider

______________________________________________________________________________

 public class Provider

 extends Properties

This class represents a "provider" for the  Java Security API. A provider implements some or all parts of  Java Security, including:

• Algorithms (such as DSA, RSA, MD5 or SHA-1).

• Key generation and management facilities (such as for  algorithm-specific keys).

Each provider has a name and a version number, and is configured  in each runtime it is installed in.

There is a default provider that comes standard with the JDK. It is  called the SUN Provider.  See The Provider Class  in the "Java Cryptography Architecture API Specification & Reference"  for information about how providers work and how to install them.

______________________________________________________________________________

 	Provider(String, double, String)

 Constructs a provider with the specified name, version number,  and information.

 	getInfo()

 Returns a human-readable description of the provider and its  services.

 	getName()

 Returns the name of this provider.

 	getVersion()

 Returns the version number for this provider.

 	toString()

 Returns a string with the name and the version number  of this provider.

 Provider

  protected Provider(String name,
                     double version,
                     String info)

 Constructs a provider with the specified name, version number,  and information.

Parameters:

 name - the provider name.

 version - the provider version number.

 info - a description of the provider and its services.

 getName

  public String getName()

 Returns the name of this provider.

Returns:

 the name of this provider.

 getVersion

  public double getVersion()

 Returns the version number for this provider.

Returns:

 the version number for this provider.

 getInfo

  public String getInfo()

 Returns a human-readable description of the provider and its  services. This may return an HTML page, with relevant links.

Returns:

 a description of the provider and its services.

 toString

  public String toString()

 Returns a string with the name and the version number  of this provider.

Returns:

 the string with the name and the version number  for this provider.

Overrides:

toString in class Hashtable

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.security.ProviderException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.security.ProviderException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.RuntimeException
                           |
                           +----java.security.ProviderException

______________________________________________________________________________

 public class ProviderException

 extends RuntimeException

A runtime exception for Provider exceptions (such as  misconfiguration errors), which may be subclassed by Providers to  throw specialized, provider-specific runtime errors.

______________________________________________________________________________

 	ProviderException()

 Constructs a ProviderException with no detail message.

 	ProviderException(String)

 Constructs a ProviderException with the specified detail  message.

 ProviderException

  public ProviderException()

 Constructs a ProviderException with no detail message. A  detail message is a String that describes this particular  exception.

 ProviderException

  public ProviderException(String s)

 Constructs a ProviderException with the specified detail  message. A detail message is a String that describes this  particular exception.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.security.PublicKey

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.security.PublicKey

 public interface PublicKey

 extends Key

A public key. This interface contains no methods or constants. It  merely serves to group (and provide type safety for) all public key  interfaces.  Note: The specialized public key interfaces extend this interface.  See, for example, the DSAPublicKey interface in  java.security.interfaces.

See Also:

Key, PublicKey, Certificate, initVerify, DSAPublicKey

______________________________________________________________________________
______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.security.SecureRandom

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.security.SecureRandom

java.lang.Object
   |
   +----java.util.Random
           |
           +----java.security.SecureRandom

______________________________________________________________________________

 public class SecureRandom

 extends Random

This class provides a crytpographically strong pseudo-random number  generator based on the SHA-1 hash algorithm.

The calls inherited from Random will be implemented in terms of the  strengthened functionality.

See Also:

Random

______________________________________________________________________________

 	SecureRandom()

 This empty constructor automatically seeds the generator.

 	SecureRandom(byte[])

 This constructor uses a user-provided seed in preference to the  self-seeding algorithm referred to in the empty constructor  description.

 	getSeed(int)

 Returns the given number of seed bytes, computed using the seed  generation algorithm that this class uses to seed itself.

 	next(int)

 Generates an integer containing the user-specified number of  pseudo-random bits (right justified, with leading zeros).

 	nextBytes(byte[])

 Generates a user-specified number of random bytes.

 	setSeed(byte[])

 Reseeds this random object.

 	setSeed(long)

 Reseeds this random object, using the eight bytes contained  in the given long seed.

 SecureRandom

  public SecureRandom()

 This empty constructor automatically seeds the generator. We attempt  to provide sufficient seed bytes to completely randomize the internal  state of the generator (20 bytes). Note, however, that our seed  generation algorithm has not been thoroughly studied or widely deployed.  It relies on counting the number of times that the calling thread  can yield while waiting for another thread to sleep for a specified  interval.

The first time this constructor is called in a given Virtual Machine,  it may take several seconds of CPU time to seed the generator, depending  on the underlying hardware. Successive calls run quickly because they  rely on the same (internal) pseudo-random number generator for their  seed bits.

The seeding procedure implemented by this constructor ensures that  the sequence of pseudo-random bytes produced by each SecureRandom  instance yields no useful information about the byte-sequence produced  by any other instance. If however, the user wishes to produce multiple  instances with truly unrelated seeds, the following code yields  the desired result (at substantial CPU cost per instance!):

 SecureRandom rnd = new SecureRandom(SecureRandom.getSeed(20));

 SecureRandom

  public SecureRandom(byte seed[])

 This constructor uses a user-provided seed in preference to the  self-seeding algorithm referred to in the empty constructor  description. It may be preferable to the empty constructor if the  caller has access to high-quality random bytes from some physical  device (for example, a radiation detector or a noisy diode).

Parameters:

 seed - the seed.

 setSeed

  public synchronized void setSeed(byte seed[])

 Reseeds this random object. The given seed supplements, rather than  replaces, the existing seed. Thus, repeated calls are guaranteed  never to reduce randomness.

Parameters:

 seed - the seed.

 setSeed

  public void setSeed(long seed)

 Reseeds this random object, using the eight bytes contained  in the given long seed. The given seed supplements,  rather than replaces, the existing seed. Thus, repeated calls  are guaranteed never to reduce randomness.

This method is defined for compatibility with  java.util.Random.

Parameters:

 seed - the seed.

Overrides:

setSeed in class Random

 nextBytes

  public synchronized void nextBytes(byte bytes[])

 Generates a user-specified number of random bytes. This method is  used as the basis of all random entities returned by this class  (except seed bytes). Thus, it may be overridden to change the  behavior of the class.

Parameters:

 bytes - the array to be filled in with random bytes.

Overrides:

nextBytes in class Random

 next

  protected final int next(int numBits)

 Generates an integer containing the user-specified number of  pseudo-random bits (right justified, with leading zeros). This  method overrides a java.util.Random method, and serves  to provide a source of random bits to all of the methods inherited  from that class (for example, nextInt,  nextLong, and nextFloat).

Parameters:

 numBits - number of pseudo-random bits to be generated, where  0 numBits  Overrides:

next in class Random

 getSeed

  public static byte[] getSeed(int numBytes)

 Returns the given number of seed bytes, computed using the seed  generation algorithm that this class uses to seed itself. This  call may be used to seed other random number generators. While  we attempt to return a "truly random" sequence of bytes, we do not  know exactly how random the bytes returned by this call are. (See  the empty constructor SecureRandom  for a brief description of the underlying algorithm.)  The prudent user will err on the side of caution and get extra  seed bytes, although it should be noted that seed generation is  somewhat costly.

Parameters:

 numBytes - the number of seed bytes to generate.

Returns:

 the seed bytes.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.security.Security

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.security.Security

java.lang.Object
   |
   +----java.security.Security

______________________________________________________________________________

 public final class Security

 extends Object

This class centralizes all security properties and common security  methods. One of its primary uses is to manage providers.

______________________________________________________________________________

 	addProvider(Provider)

 Adds a provider to the next position available.

 	getAlgorithmProperty(String, String)

 Gets a specified property for an algorithm.

 	getProperty(String)

 Gets a security property.

 	getProvider(String)

 Returns the provider installed with the specified name, if  any.

 	getProviders()

 Returns all providers currently installed.

 	insertProviderAt(Provider, int)

 Adds a new provider, at a specified position.

 	removeProvider(String)

 Removes the provider with the specified name.

 	setProperty(String, String)

 Sets a security property.

 getAlgorithmProperty

  public static String getAlgorithmProperty(String algName,
                                            String propName)

 Gets a specified property for an algorithm. The algorithm name  should be a standard name. See Appendix A in the  Java Cryptography Architecture API Specification & Reference    for information about standard algorithm names.  One possible use is by specialized algorithm parsers, which may map  classes to algorithms which they understand (much like Key parsers  do).

Parameters:

 algName - the algorithm name.

 propName - the name of the property to get.

Returns:

 the value of the specified property.

 insertProviderAt

  public static int insertProviderAt(Provider provider,
                                     int position)

 Adds a new provider, at a specified position. The position is  the preference order in which providers are searched for  requested algorithms. Note that it is not guaranteed that this  preference will be respected. The position is 1-based, that is,  1 is most preferred, followed by 2, and so on. Sometimes it  will be legal to add a provider, but only in the last position,  in which case the position argument will be ignored.

A provider cannot be added if it is already installed.

Parameters:

 provider - the provider to be added.

 position - the preference position that the caller would  like for this provider.

Returns:

 the actual preference position in which the provider was  added, or -1 if the provider was not added because it is  already installed.

See Also:

getProvider, removeProvider

 addProvider

  public static int addProvider(Provider provider)

 Adds a provider to the next position available.

Parameters:

 provider - the provider to be added.

Returns:

 the preference position in which the provider was  added, or -1 if the provider was not added because it is  already installed.

See Also:

getProvider, removeProvider

 removeProvider

  public static void removeProvider(String name)

 Removes the provider with the specified name. This method  returns silently if the provider is not installed.

Parameters:

 name - the name of the provider to remove.

See Also:

getProvider, addProvider

 getProviders

  public static Provider[] getProviders()

 Returns all providers currently installed.

Returns:

 an array of all providers currently installed.

 getProvider

  public static Provider getProvider(String name)

 Returns the provider installed with the specified name, if  any. Returns null if no provider with the speicified name is  installed.

Parameters:

 name - the name of the provider to get.

Returns:

 the provider of the specified name.

See Also:

removeProvider, addProvider

 getProperty

  public static String getProperty(String key)

 Gets a security property.

Parameters:

 key - the key of the property being retrieved.

Returns:

 the valeu of the security property corresponding to key.

 setProperty

  public static void setProperty(String key,
                                 String datum)

 Sets a security property.

Parameters:

 key - the name of the property to be set.

 datum - the value of the property to be set.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.security.Signature

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.security.Signature

java.lang.Object
   |
   +----java.security.Signature

______________________________________________________________________________

 public class Signature

 extends Object

This Signature class is used to provide the functionality of a  digital signature algorithm, such as RSA with MD5 or  DSA . Digital signatures are used for authentication and  integrity assurance of digital data.

Like other algorithm-based classes in Java Security, the  Signature class has two major components:

Digital Signature API (Application Program Interface)

This is the interface of methods called by applications needing  digital signature services. The API consists of all public methods.

Digital Signature SPI (Service Provider Interface)

This is the interface implemented by providers that supply  specific algorithms. It consists of all methods whose names are  prefixed by engine . Each such method is called by a  correspondingly-named public API method. For example, the  engineSign method is called by the  sign  method. The SPI methods are abstract;  providers must supply a concrete implementation.

Also like other algorithm-based classes in Java Security, Signature  provides implementation-independent algorithms, whereby a caller  (application code) requests a particular signature algorithm  and is handed back a properly initialized Signature object. It is  also possible, if desired, to request a particular algorithm from a  particular provider. See the getInstance  methods.

Thus, there are two ways to request a Signature algorithm object: by  specifying either just an algorithm name, or both an algorithm name  and a package provider.

• If just an algorithm name is specified, the system will  determine if there is an implementation of the algorithm requested  available in the environment, and if there is more than one, if  there is a preferred one.

• If both an algorithm name and a package provider are specified,  the system will determine if there is an implementation of the  algorithm in the package requested, and throw an exception if there  is not.

A Signature object can be used to generate and verify digital  signatures.

There are three phases to the use of a Signature object for  either signing data or verifying a signature:

1. Initialization, with either

• a public key, which initializes the signature for  verification (see initVerify), or

• a private key, which initializes the signature for  signing (see initSign).

2. Updating

Depending on the type of initialization, this will update the  bytes to be signed or verified. See the update methods.

3. Signing or Verifying

a signature on all updated bytes. See sign and verify.

______________________________________________________________________________

 	SIGN

 Possible state  value, signifying that  this signature object has been initialized for signing.

 	state

 Current state of this signature object.

 	UNINITIALIZED

 Possible state  value, signifying that  this signature object has not yet been initialized.

 	VERIFY

 Possible state  value, signifying that  this signature object has been initialized for verification.

 	Signature(String)

 Creates a Signature object for the specified algorithm.

 	clone()

 Returns a clone if the implementation is cloneable.

 	engineGetParameter(String)

SPI: Gets the value of the specified algorithm parameter.

 	engineInitSign(PrivateKey)

SPI: Initializes this signature object with the specified  private key for signing operations.

 	engineInitVerify(PublicKey)

SPI: Initializes this signature object with the specified  public key for verification operations.

 	engineSetParameter(String, Object)

SPI: Sets the specified algorithm parameter to the specified  value.

 	engineSign()

SPI: Returns the signature bytes of all the data  updated so far.

 	engineUpdate(byte)

SPI: Updates the data to be signed or verified  using the specified byte.

 	engineUpdate(byte[], int, int)

SPI: Updates the data to be signed or verified, using the  specified array of bytes, starting at the specified offset.

 	engineVerify(byte[])

SPI: Verifies the passed-in signature.

 	getAlgorithm()

 Returns the name of the algorithm for this signature object.

 	getInstance(String)

 Generates a Signature object that implements the specified  algorithm.

 	getInstance(String, String)

 Generates a Signature object implementing the specified  algorithm, as supplied from the specified provider, if such an  algorithm is available from the provider.

 	getParameter(String)

 Gets the value of the specified algorithm parameter.

 	initSign(PrivateKey)

 Initialize this object for signing.

 	initVerify(PublicKey)

 Initializes this object for verification.

 	setParameter(String, Object)

 Sets the specified algorithm parameter to the specified value.

 	sign()

 Returns the signature bytes of all the data updated.

 	toString()

 Returns a string representation of this signature object,  providing information that includes the state of the object  and the name of the algorithm used.

 	update(byte)

 Updates the data to be signed or verified by a byte.

 	update(byte[])

 Updates the data to be signed or verified, using the specified  array of bytes.

 	update(byte[], int, int)

 Updates the data to be signed or verified, using the specified  array of bytes, starting at the specified offset.

 	verify(byte[])

 Verifies the passed-in signature.

 UNINITIALIZED

  protected final static int UNINITIALIZED

 Possible state  value, signifying that  this signature object has not yet been initialized.

 SIGN

  protected final static int SIGN

 Possible state  value, signifying that  this signature object has been initialized for signing.

 VERIFY

  protected final static int VERIFY

 Possible state  value, signifying that  this signature object has been initialized for verification.

 state

  protected int state

 Current state of this signature object.

 Signature

  protected Signature(String algorithm)

 Creates a Signature object for the specified algorithm.

Parameters:

 algorithm - the standard string name of the algorithm.  See Appendix A in the  Java Cryptography Architecture API Specification & Reference    for information about standard algorithm names.

 getInstance

  public static Signature getInstance(String algorithm) throws NoSuchAlgorithmException

 Generates a Signature object that implements the specified  algorithm. If the default provider package contains a Signature  subclass implementing the algorithm, an instance of that subclass  is returned. If the algorithm is not available in the default  package, other packages are searched.

Parameters:

 algorithm - the standard name of the algorithm requested.  See Appendix A in the  Java Cryptography Architecture API Specification & Reference    for information about standard algorithm names.

Returns:

 the new Signature object.

Throws: NoSuchAlgorithmException

 if the algorithm is  not available in the environment.

 getInstance

  public static Signature getInstance(String algorithm,
                                      String provider) throws NoSuchAlgorithmException , NoSuchProviderException

 Generates a Signature object implementing the specified  algorithm, as supplied from the specified provider, if such an  algorithm is available from the provider.

Parameters:

 algorithm - the name of the algorithm requested.  See Appendix A in the  Java Cryptography Architecture API Specification & Reference    for information about standard algorithm names.

 provider - the name of the provider.

Returns:

 the new Signature object.

Throws: NoSuchAlgorithmException

 if the algorithm is  not available in the package supplied by the requested  provider.

Throws: NoSuchProviderException

 if the provider is not  available in the environment.

See Also:

Provider

 initVerify

  public final void initVerify(PublicKey publicKey) throws InvalidKeyException

 Initializes this object for verification. If this method is called  again with a different argument, it negates the effect  of this call.

Parameters:

 publicKey - the public key of the identity whose signature is  going to be verified.

Throws: InvalidKeyException

 if the key is invalid.

 initSign

  public final void initSign(PrivateKey privateKey) throws InvalidKeyException

 Initialize this object for signing. If this method is called  again with a different argument, it negates the effect  of this call.

Parameters:

 privateKey - the private key of the identity whose signature  is going to be generated.

Throws: InvalidKeyException

 if the key is invalid.

 sign

  public final byte[] sign() throws SignatureException

 Returns the signature bytes of all the data updated. The  signature returned is X.509-encoded.

A call to this method resets this signature object to the state  it was in when previously initialized for signing via a  call to initSign(PrivateKey) . That is, the object is  reset and available to generate another signature from the same  signer, if desired, via new calls to update and  sign.

Returns:

 the signature bytes of the signing operation's result.

Throws: SignatureException

 if this signature object is not  initialized properly.

 verify

  public final boolean verify(byte signature[]) throws SignatureException

 Verifies the passed-in signature. The signature bytes are expected  to be X.509-encoded.

A call to this method resets this signature object to the state  it was in when previously initialized for verification via a  call to initVerify(PublicKey). That is, the object is  reset and available to verify another signature from the identity  whose public key was specified in the call to initVerify.

Parameters:

 signature - the signature bytes to be verified.

Returns:

 true if the signature was verified, false if not.

Throws: SignatureException

 if this signature object is not  initialized properly, or the passed-in signature is improperly  encoded or of the wrong type, etc.

 update

  public final void update(byte b) throws SignatureException

 Updates the data to be signed or verified by a byte.

Parameters:

 b - the byte to use for the update.

Throws: SignatureException

 if this signature object is not  initialized properly.

 update

  public final void update(byte data[]) throws SignatureException

 Updates the data to be signed or verified, using the specified  array of bytes.

Parameters:

 data - the byte array to use for the update.

Throws: SignatureException

 if this signature object is not  initialized properly.

 update

  public final void update(byte data[],
                           int off,
                           int len) throws SignatureException

 Updates the data to be signed or verified, using the specified  array of bytes, starting at the specified offset.

Parameters:

 data - the array of bytes.

 off - the offset to start from in the array of bytes.

 len - the number of bytes to use, starting at offset.

Throws: SignatureException

 if this signature object is not  initialized properly.

 getAlgorithm

  public final String getAlgorithm()

 Returns the name of the algorithm for this signature object.

Returns:

 the name of the algorithm for this signature object.

 toString

  public String toString()

 Returns a string representation of this signature object,  providing information that includes the state of the object  and the name of the algorithm used.

Returns:

 a string representation of this signature object.

Overrides:

toString in class Object

 setParameter

  public final void setParameter(String param,
                                 Object value) throws InvalidParameterException

 Sets the specified algorithm parameter to the specified value.  This method supplies a general-purpose mechanism through  which it is possible to set the various parameters of this object.  A parameter may be any settable parameter for the algorithm, such as  a parameter size, or a source of random bits for signature generation  (if appropriate), or an indication of whether or not to perform  a specific but optional computation. A uniform algorithm-specific  naming scheme for each parameter is desirable but left unspecified  at this time.

Parameters:

 param - the string identifier of the parameter.

 value - the parameter value.

Throws: InvalidParameterException

 if param is an  invalid parameter for this signature algorithm engine,  the parameter is already set  and cannot be set again, a security exception occurs, and so on.

 getParameter

  public final Object getParameter(String param) throws InvalidParameterException

 Gets the value of the specified algorithm parameter. This method  supplies a general-purpose mechanism through which it is possible to  get the various parameters of this object. A parameter may be any  settable parameter for the algorithm, such as a parameter size, or  a source of random bits for signature generation (if appropriate),  or an indication of whether or not to perform a specific but optional  computation. A uniform algorithm-specific naming scheme for each  parameter is desirable but left unspecified at this time.

Parameters:

 param - the string name of the parameter.

Returns:

 the object that represents the parameter value, or null if  there is none.

Throws: InvalidParameterException

 if param is an invalid  parameter for this engine, or another exception occurs while  trying to get this parameter.

 engineInitVerify

  protected abstract void engineInitVerify(PublicKey publicKey) throws InvalidKeyException

 SPI: Initializes this signature object with the specified  public key for verification operations.

Parameters:

 publicKey - the public key of the identity whose signature is  going to be verified.

Throws: InvalidKeyException

 if the key is improperly  encoded, parameters are missing, and so on.

 engineInitSign

  protected abstract void engineInitSign(PrivateKey privateKey) throws InvalidKeyException

 SPI: Initializes this signature object with the specified  private key for signing operations.

Parameters:

 privateKey - the private key of the identity whose signature  will be generated.

Throws: InvalidKeyException

 if the key is improperly  encoded, parameters are missing, and so on.

 engineUpdate

  protected abstract void engineUpdate(byte b) throws SignatureException

 SPI: Updates the data to be signed or verified  using the specified byte.

Parameters:

 b - the byte to use for the update.

Throws: SignatureException

 if the engine is not initialized  properly.

 engineUpdate

  protected abstract void engineUpdate(byte b[],
                                       int off,
                                       int len) throws SignatureException

 SPI: Updates the data to be signed or verified, using the  specified array of bytes, starting at the specified offset.

Parameters:

 data - the array of bytes.

 off - the offset to start from in the array of bytes.

 len - the number of bytes to use, starting at offset.

Throws: SignatureException

 if the engine is not initialized  properly.

 engineSign

  protected abstract byte[] engineSign() throws SignatureException

 SPI: Returns the signature bytes of all the data  updated so far. The signature returned is X.509-encoded.  For more information about the X.509 encoding, see  X.509 certificates .

Returns:

 the signature bytes of the signing operation's result.

Throws: SignatureException

 if the engine is not  initialized properly.

 engineVerify

  protected abstract boolean engineVerify(byte sigBytes[]) throws SignatureException

 SPI: Verifies the passed-in signature. The signature bytes  are expected to be X.509-encoded. For more information about the  X.509 encoding, see X.509   certificates.

Parameters:

 sigBytes - the signature bytes to be verified.

Returns:

 true if the signature was verified, false if not.

Throws: SignatureException

 if the engine is not initialized  properly, or the passed-in signature is improperly encoded or  of the wrong type, etc.

 engineSetParameter

  protected abstract void engineSetParameter(String param,
                                             Object value) throws InvalidParameterException

 SPI: Sets the specified algorithm parameter to the specified  value. This method supplies a general-purpose mechanism through  which it is possible to set the various parameters of this object.  A parameter may be any settable parameter for the algorithm, such as  a parameter size, or a source of random bits for signature generation  (if appropriate), or an indication of whether or not to perform  a specific but optional computation. A uniform algorithm-specific  naming scheme for each parameter is desirable but left unspecified  at this time.

Parameters:

 param - the string identifier of the parameter.

 value - the parameter value.

Throws: InvalidParameterException

 if param is an  invalid parameter for this signature algorithm engine,  the parameter is already set  and cannot be set again, a security exception occurs, and so on.

 engineGetParameter

  protected abstract Object engineGetParameter(String param) throws InvalidParameterException

 SPI: Gets the value of the specified algorithm parameter.  This method supplies a general-purpose mechanism through which it  is possible to get the various parameters of this object. A parameter  may be any settable parameter for the algorithm, such as a parameter  size, or a source of random bits for signature generation (if  appropriate), or an indication of whether or not to perform a  specific but optional computation. A uniform algorithm-specific  naming scheme for each parameter is desirable but left unspecified  at this time.

Parameters:

 param - the string name of the parameter.

Returns:

 the object that represents the parameter value, or null if  there is none.

Throws: InvalidParameterException

 if param is an  invalid parameter for this engine, or another exception occurs while  trying to get this parameter.

 clone

  public Object clone() throws CloneNotSupportedException

 Returns a clone if the implementation is cloneable.

Returns:

 a clone if the implementation is cloneable.

Throws: CloneNotSupportedException

 if this is called  on an implementation that does not support Cloneable.

Overrides:

clone in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.security.SignatureException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.security.SignatureException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.security.SignatureException

______________________________________________________________________________

 public class SignatureException

 extends Exception

This is the generic Signature exception.

______________________________________________________________________________

 	SignatureException()

 Constructs a SignatureException with no detail message.

 	SignatureException(String)

 Constructs a SignatureException with the specified detail  message.

 SignatureException

  public SignatureException()

 Constructs a SignatureException with no detail message. A  detail message is a String that describes this particular  exception.

 SignatureException

  public SignatureException(String msg)

 Constructs a SignatureException with the specified detail  message. A detail message is a String that describes this  particular exception.

Parameters:

 msg - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.security.Signer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.security.Signer

java.lang.Object
   |
   +----java.security.Identity
           |
           +----java.security.Signer

______________________________________________________________________________

 public class Signer

 extends Identity

This class is used to represent an Identity that can also digitally  sign data.

The management of a signer's private keys is an important and  sensitive issue that should be handled by subclasses as appropriate  to their intended use.

See Also:

Identity

______________________________________________________________________________

 	Signer()

 Creates a signer.

 	Signer(String)

 Creates a signer with the specified identity name.

 	Signer(String, IdentityScope)

 Creates a signer with the specified identity name and scope.

 	getPrivateKey()

 Returns this signer's private key.

 	setKeyPair(KeyPair)

 Sets the key pair (public key and private key) for this signer.

 	toString()

 Returns a string of information about the signer.

 Signer

  protected Signer()

 Creates a signer. This constructor should only be used for  serialization.

 Signer

  public Signer(String name)

 Creates a signer with the specified identity name.

Parameters:

 name - the identity name.

 Signer

  public Signer(String name,
                IdentityScope scope) throws KeyManagementException

 Creates a signer with the specified identity name and scope.

Parameters:

 name - the identity name.

 scope - the scope of the identity.

Throws: KeyManagementException

 if there is already an identity  with the same name in the scope.

 getPrivateKey

  public PrivateKey getPrivateKey()

 Returns this signer's private key.

Returns:

 this signer's private key, or null if the private key has  not yet been set.

 setKeyPair

  public final void setKeyPair(KeyPair pair) throws InvalidParameterException, KeyException

 Sets the key pair (public key and private key) for this signer.

Parameters:

 pair - an initialized key pair.

Throws: InvalidParameterException

 if the key pair is not  properly initialized.

Throws: KeyException

 if the key pair cannot be set for any  other reason.

 toString

  public String toString()

 Returns a string of information about the signer.

Returns:

 a string of information about the signer.

Overrides:

toString in class Identity

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.sql.CallableStatement

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.sql.CallableStatement

 public interface CallableStatement

 extends PreparedStatement

CallableStatement is used to execute SQL stored procedures.

JDBC provides a stored procedure SQL escape that allows stored  procedures to be called in a standard way for all RDBMS's. This  escape syntax has one form that includes a result parameter and one  that does not. If used, the result parameter must be registered as  an OUT parameter. The other parameters may be used for input,  output or both. Parameters are refered to sequentially, by  number. The first parameter is 1.

  {?= call [,, ...]}
 {call [,, ...]}

IN parameter values are set using the set methods inherited from  PreparedStatement. The type of all OUT parameters must be  registered prior to executing the stored procedure; their values  are retrieved after execution via the get methods provided here.

A Callable statement may return a ResultSet or multiple  ResultSets. Multiple ResultSets are handled using operations  inherited from Statement.

For maximum portability, a call's ResultSets and update counts  should be processed prior to getting the values of output  parameters.

See Also:

prepareCall, ResultSet

______________________________________________________________________________

 	getBigDecimal(int, int)

 Get the value of a NUMERIC parameter as a java.math.BigDecimal object.

 	getBoolean(int)

 Get the value of a BIT parameter as a Java boolean.

 	getByte(int)

 Get the value of a TINYINT parameter as a Java byte.

 	getBytes(int)

 Get the value of a SQL BINARY or VARBINARY parameter as a Java byte[]

 	getDate(int)

 Get the value of a SQL DATE parameter as a java.sql.Date object

 	getDouble(int)

 Get the value of a DOUBLE parameter as a Java double.

 	getFloat(int)

 Get the value of a FLOAT parameter as a Java float.

 	getInt(int)

 Get the value of an INTEGER parameter as a Java int.

 	getLong(int)

 Get the value of a BIGINT parameter as a Java long.

 	getObject(int)

 Get the value of a parameter as a Java object.

 	getShort(int)

 Get the value of a SMALLINT parameter as a Java short.

 	getString(int)

 Get the value of a CHAR, VARCHAR, or LONGVARCHAR parameter as a Java String.

 	getTime(int)

 Get the value of a SQL TIME parameter as a java.sql.Time object.

 	getTimestamp(int)

 Get the value of a SQL TIMESTAMP parameter as a java.sql.Timestamp object.

 	registerOutParameter(int, int)

 Before executing a stored procedure call, you must explicitly  call registerOutParameter to register the java.sql.Type of each  out parameter.

 	registerOutParameter(int, int, int)

 Use this version of registerOutParameter for registering  Numeric or Decimal out parameters.

 	wasNull()

 An OUT parameter may have the value of SQL NULL; wasNull reports  whether the last value read has this special value.

 registerOutParameter

  public abstract void registerOutParameter(int parameterIndex,
                                            int sqlType) throws SQLException

 Before executing a stored procedure call, you must explicitly  call registerOutParameter to register the java.sql.Type of each  out parameter.

Note: When reading the value of an out parameter, you  must use the getXXX method whose Java type XXX corresponds to the  parameter's registered SQL type.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2,...

 sqlType - SQL type code defined by java.sql.Types;  for parameters of type Numeric or Decimal use the version of  registerOutParameter that accepts a scale value

Throws: SQLException

 if a database-access error occurs.

See Also:

 Type

 registerOutParameter

  public abstract void registerOutParameter(int parameterIndex,
                                            int sqlType,
                                            int scale) throws SQLException

 Use this version of registerOutParameter for registering  Numeric or Decimal out parameters.

Note: When reading the value of an out parameter, you  must use the getXXX method whose Java type XXX corresponds to the  parameter's registered SQL type.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

 sqlType - use either java.sql.Type.NUMERIC or java.sql.Type.DECIMAL

 scale - a value greater than or equal to zero representing the  desired number of digits to the right of the decimal point

Throws: SQLException

 if a database-access error occurs.

See Also:

 Type

 wasNull

  public abstract boolean wasNull() throws SQLException

 An OUT parameter may have the value of SQL NULL; wasNull reports  whether the last value read has this special value.

Note: You must first call getXXX on a parameter to  read its value and then call wasNull() to see if the value was  SQL NULL.

Returns:

 true if the last parameter read was SQL NULL

Throws: SQLException

 if a database-access error occurs.

 getString

  public abstract String getString(int parameterIndex) throws SQLException

 Get the value of a CHAR, VARCHAR, or LONGVARCHAR parameter as a Java String.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

Returns:

 the parameter value; if the value is SQL NULL, the result is null

Throws: SQLException

 if a database-access error occurs.

 getBoolean

  public abstract boolean getBoolean(int parameterIndex) throws SQLException

 Get the value of a BIT parameter as a Java boolean.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

Returns:

 the parameter value; if the value is SQL NULL, the result is false

Throws: SQLException

 if a database-access error occurs.

 getByte

  public abstract byte getByte(int parameterIndex) throws SQLException

 Get the value of a TINYINT parameter as a Java byte.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

Returns:

 the parameter value; if the value is SQL NULL, the result is 0

Throws: SQLException

 if a database-access error occurs.

 getShort

  public abstract short getShort(int parameterIndex) throws SQLException

 Get the value of a SMALLINT parameter as a Java short.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

Returns:

 the parameter value; if the value is SQL NULL, the result is 0

Throws: SQLException

 if a database-access error occurs.

 getInt

  public abstract int getInt(int parameterIndex) throws SQLException

 Get the value of an INTEGER parameter as a Java int.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

Returns:

 the parameter value; if the value is SQL NULL, the result is 0

Throws: SQLException

 if a database-access error occurs.

 getLong

  public abstract long getLong(int parameterIndex) throws SQLException

 Get the value of a BIGINT parameter as a Java long.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

Returns:

 the parameter value; if the value is SQL NULL, the result is 0

Throws: SQLException

 if a database-access error occurs.

 getFloat

  public abstract float getFloat(int parameterIndex) throws SQLException

 Get the value of a FLOAT parameter as a Java float.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

Returns:

 the parameter value; if the value is SQL NULL, the result is 0

Throws: SQLException

 if a database-access error occurs.

 getDouble

  public abstract double getDouble(int parameterIndex) throws SQLException

 Get the value of a DOUBLE parameter as a Java double.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

Returns:

 the parameter value; if the value is SQL NULL, the result is 0

Throws: SQLException

 if a database-access error occurs.

 getBigDecimal

  public abstract BigDecimal getBigDecimal(int parameterIndex,
                                           int scale) throws SQLException

 Get the value of a NUMERIC parameter as a java.math.BigDecimal object.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

 scale - a value greater than or equal to zero representing the  desired number of digits to the right of the decimal point

Returns:

 the parameter value; if the value is SQL NULL, the result is  null

Throws: SQLException

 if a database-access error occurs.

 getBytes

  public abstract byte[] getBytes(int parameterIndex) throws SQLException

 Get the value of a SQL BINARY or VARBINARY parameter as a Java byte[]

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

Returns:

 the parameter value; if the value is SQL NULL, the result is null

Throws: SQLException

 if a database-access error occurs.

 getDate

  public abstract Date getDate(int parameterIndex) throws SQLException

 Get the value of a SQL DATE parameter as a java.sql.Date object

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

Returns:

 the parameter value; if the value is SQL NULL, the result is null

Throws: SQLException

 if a database-access error occurs.

 getTime

  public abstract Time getTime(int parameterIndex) throws SQLException

 Get the value of a SQL TIME parameter as a java.sql.Time object.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

Returns:

 the parameter value; if the value is SQL NULL, the result is null

Throws: SQLException

 if a database-access error occurs.

 getTimestamp

  public abstract Timestamp getTimestamp(int parameterIndex) throws SQLException

 Get the value of a SQL TIMESTAMP parameter as a java.sql.Timestamp object.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

Returns:

 the parameter value; if the value is SQL NULL, the result is null

Throws: SQLException

 if a database-access error occurs.

 getObject

  public abstract Object getObject(int parameterIndex) throws SQLException

 Get the value of a parameter as a Java object.

This method returns a Java object whose type coresponds to the SQL  type that was registered for this parameter using registerOutParameter.

Note that this method may be used to read  datatabase-specific, abstract data types. This is done by  specifying a targetSqlType of java.sql.types.OTHER, which  allows the driver to return a database-specific Java type.

Parameters:

 parameterIndex - The first parameter is 1, the second is 2, ...

Returns:

 A java.lang.Object holding the OUT parameter value.

Throws: SQLException

 if a database-access error occurs.

See Also:

Types

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.sql.Connection

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.sql.Connection

 public interface Connection

A Connection represents a session with a specific  database. Within the context of a Connection, SQL statements are  executed and results are returned.

A Connection's database is able to provide information  describing its tables, its supported SQL grammar, its stored  procedures, the capabilities of this connection, etc. This  information is obtained with the getMetaData method.

Note: By default the Connection automatically commits  changes after executing each statement. If auto commit has been  disabled, an explicit commit must be done or database changes will  not be saved.

See Also:

getConnection, Statement, ResultSet, DatabaseMetaData

______________________________________________________________________________

 	TRANSACTION_NONE

 Transactions are not supported.

 	TRANSACTION_READ_COMMITTED

 Dirty reads are prevented; non-repeatable reads and phantom  reads can occur.

 	TRANSACTION_READ_UNCOMMITTED

 Dirty reads, non-repeatable reads and phantom reads can occur.

 	TRANSACTION_REPEATABLE_READ

 Dirty reads and non-repeatable reads are prevented; phantom  reads can occur.

 	TRANSACTION_SERIALIZABLE

 Dirty reads, non-repeatable reads and phantom reads are prevented.

 	clearWarnings()

 After this call, getWarnings returns null until a new warning is  reported for this Connection.

 	close()

 In some cases, it is desirable to immediately release a  Connection's database and JDBC resources instead of waiting for  them to be automatically released; the close method provides this  immediate release.

 	commit()

 Commit makes all changes made since the previous  commit/rollback permanent and releases any database locks  currently held by the Connection.

 	createStatement()

 SQL statements without parameters are normally  executed using Statement objects.

 	getAutoCommit()

 Get the current auto-commit state.

 	getCatalog()

 Return the Connection's current catalog name.

 	getMetaData()

 A Connection's database is able to provide information  describing its tables, its supported SQL grammar, its stored  procedures, the capabilities of this connection, etc.

 	getTransactionIsolation()

 Get this Connection's current transaction isolation mode.

 	getWarnings()

 The first warning reported by calls on this Connection is  returned.

 	isClosed()

 Tests to see if a Connection is closed.

 	isReadOnly()

 Tests to see if the connection is in read-only mode.

 	nativeSQL(String)

 A driver may convert the JDBC sql grammar into its system's  native SQL grammar prior to sending it; nativeSQL returns the  native form of the statement that the driver would have sent.

 	prepareCall(String)

 A SQL stored procedure call statement is handled by creating a  CallableStatement for it.

 	prepareStatement(String)

 A SQL statement with or without IN parameters can be  pre-compiled and stored in a PreparedStatement object.

 	rollback()

 Rollback drops all changes made since the previous  commit/rollback and releases any database locks currently held  by the Connection.

 	setAutoCommit(boolean)

 If a connection is in auto-commit mode, then all its SQL  statements will be executed and committed as individual  transactions.

 	setCatalog(String)

 A sub-space of this Connection's database may be selected by setting a  catalog name.

 	setReadOnly(boolean)

 You can put a connection in read-only mode as a hint to enable  database optimizations.

 	setTransactionIsolation(int)

 You can call this method to try to change the transaction  isolation level using one of the TRANSACTION_* values.

 TRANSACTION_NONE

  public final static int TRANSACTION_NONE

 Transactions are not supported.

 TRANSACTION_READ_UNCOMMITTED

  public final static int TRANSACTION_READ_UNCOMMITTED

 Dirty reads, non-repeatable reads and phantom reads can occur.

 TRANSACTION_READ_COMMITTED

  public final static int TRANSACTION_READ_COMMITTED

 Dirty reads are prevented; non-repeatable reads and phantom  reads can occur.

 TRANSACTION_REPEATABLE_READ

  public final static int TRANSACTION_REPEATABLE_READ

 Dirty reads and non-repeatable reads are prevented; phantom  reads can occur.

 TRANSACTION_SERIALIZABLE

  public final static int TRANSACTION_SERIALIZABLE

 Dirty reads, non-repeatable reads and phantom reads are prevented.

 createStatement

  public abstract Statement createStatement() throws SQLException

 SQL statements without parameters are normally  executed using Statement objects. If the same SQL statement  is executed many times, it is more efficient to use a  PreparedStatement

Returns:

 a new Statement object

Throws: SQLException

 if a database-access error occurs.

 prepareStatement

  public abstract PreparedStatement prepareStatement(String sql) throws SQLException

 A SQL statement with or without IN parameters can be  pre-compiled and stored in a PreparedStatement object. This  object can then be used to efficiently execute this statement  multiple times.

Note: This method is optimized for handling  parametric SQL statements that benefit from precompilation. If  the driver supports precompilation, prepareStatement will send  the statement to the database for precompilation. Some drivers  may not support precompilation. In this case, the statement may  not be sent to the database until the PreparedStatement is  executed. This has no direct affect on users; however, it does  affect which method throws certain SQLExceptions.

Parameters:

 sql - a SQL statement that may contain one or more '?' IN  parameter placeholders

Returns:

 a new PreparedStatement object containing the  pre-compiled statement

Throws: SQLException

 if a database-access error occurs.

 prepareCall

  public abstract CallableStatement prepareCall(String sql) throws SQLException

 A SQL stored procedure call statement is handled by creating a  CallableStatement for it. The CallableStatement provides  methods for setting up its IN and OUT parameters, and  methods for executing it.

Note: This method is optimized for handling stored  procedure call statements. Some drivers may send the call  statement to the database when the prepareCall is done; others  may wait until the CallableStatement is executed. This has no  direct affect on users; however, it does affect which method  throws certain SQLExceptions.

Parameters:

 sql - a SQL statement that may contain one or more '?'  parameter placeholders. Typically this statement is a JDBC  function call escape string.

Returns:

 a new CallableStatement object containing the  pre-compiled SQL statement

Throws: SQLException

 if a database-access error occurs.

 nativeSQL

  public abstract String nativeSQL(String sql) throws SQLException

 A driver may convert the JDBC sql grammar into its system's  native SQL grammar prior to sending it; nativeSQL returns the  native form of the statement that the driver would have sent.

Parameters:

 sql - a SQL statement that may contain one or more '?'  parameter placeholders

Returns:

 the native form of this statement

Throws: SQLException

 if a database-access error occurs.

 setAutoCommit

  public abstract void setAutoCommit(boolean autoCommit) throws SQLException

 If a connection is in auto-commit mode, then all its SQL  statements will be executed and committed as individual  transactions. Otherwise, its SQL statements are grouped into  transactions that are terminated by either commit() or  rollback(). By default, new connections are in auto-commit  mode.  The commit occurs when the statement completes or the next  execute occurs, whichever comes first. In the case of  statements returning a ResultSet, the statement completes when  the last row of the ResultSet has been retrieved or the  ResultSet has been closed. In advanced cases, a single  statement may return multiple results as well as output  parameter values. Here the commit occurs when all results and  output param values have been retrieved.

Parameters:

 autoCommit - true enables auto-commit; false disables  auto-commit.

Throws: SQLException

 if a database-access error occurs.

 getAutoCommit

  public abstract boolean getAutoCommit() throws SQLException

 Get the current auto-commit state.

Returns:

 Current state of auto-commit mode.

Throws: SQLException

 if a database-access error occurs.

See Also:

setAutoCommit

 commit

  public abstract void commit() throws SQLException

 Commit makes all changes made since the previous  commit/rollback permanent and releases any database locks  currently held by the Connection. This method should only be  used when auto commit has been disabled.

Throws: SQLException

 if a database-access error occurs.

See Also:

setAutoCommit

 rollback

  public abstract void rollback() throws SQLException

 Rollback drops all changes made since the previous  commit/rollback and releases any database locks currently held  by the Connection. This method should only be used when auto  commit has been disabled.

Throws: SQLException

 if a database-access error occurs.

See Also:

setAutoCommit

 close

  public abstract void close() throws SQLException

 In some cases, it is desirable to immediately release a  Connection's database and JDBC resources instead of waiting for  them to be automatically released; the close method provides this  immediate release.

Note: A Connection is automatically closed when it is  garbage collected. Certain fatal errors also result in a closed  Connection.

Throws: SQLException

 if a database-access error occurs.

 isClosed

  public abstract boolean isClosed() throws SQLException

 Tests to see if a Connection is closed.

Returns:

 true if the connection is closed; false if it's still open

Throws: SQLException

 if a database-access error occurs.

 getMetaData

  public abstract DatabaseMetaData getMetaData() throws SQLException

 A Connection's database is able to provide information  describing its tables, its supported SQL grammar, its stored  procedures, the capabilities of this connection, etc. This  information is made available through a DatabaseMetaData  object.

Returns:

 a DatabaseMetaData object for this Connection

Throws: SQLException

 if a database-access error occurs.

 setReadOnly

  public abstract void setReadOnly(boolean readOnly) throws SQLException

 You can put a connection in read-only mode as a hint to enable  database optimizations.

Note: setReadOnly cannot be called while in the  middle of a transaction.

Parameters:

 readOnly - true enables read-only mode; false disables  read-only mode.

Throws: SQLException

 if a database-access error occurs.

 isReadOnly

  public abstract boolean isReadOnly() throws SQLException

 Tests to see if the connection is in read-only mode.

Returns:

 true if connection is read-only

Throws: SQLException

 if a database-access error occurs.

 setCatalog

  public abstract void setCatalog(String catalog) throws SQLException

 A sub-space of this Connection's database may be selected by setting a  catalog name. If the driver does not support catalogs it will  silently ignore this request.

Throws: SQLException

 if a database-access error occurs.

 getCatalog

  public abstract String getCatalog() throws SQLException

 Return the Connection's current catalog name.

Returns:

 the current catalog name or null

Throws: SQLException

 if a database-access error occurs.

 setTransactionIsolation

  public abstract void setTransactionIsolation(int level) throws SQLException

 You can call this method to try to change the transaction  isolation level using one of the TRANSACTION_* values.

Note: setTransactionIsolation cannot be called while  in the middle of a transaction.

Parameters:

 level - one of the TRANSACTION_* isolation values with the  exception of TRANSACTION_NONE; some databases may not support  other values

Throws: SQLException

 if a database-access error occurs.

See Also:

supportsTransactionIsolationLevel

 getTransactionIsolation

  public abstract int getTransactionIsolation() throws SQLException

 Get this Connection's current transaction isolation mode.

Returns:

 the current TRANSACTION_* mode value

Throws: SQLException

 if a database-access error occurs.

 getWarnings

  public abstract SQLWarning getWarnings() throws SQLException

 The first warning reported by calls on this Connection is  returned.

Note: Subsequent warnings will be chained to this  SQLWarning.

Returns:

 the first SQLWarning or null

Throws: SQLException

 if a database-access error occurs.

 clearWarnings

  public abstract void clearWarnings() throws SQLException

 After this call, getWarnings returns null until a new warning is  reported for this Connection.

Throws: SQLException

 if a database-access error occurs.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.sql.DatabaseMetaData

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.sql.DatabaseMetaData

 public interface DatabaseMetaData

This class provides information about the database as a whole.

Many of the methods here return lists of information in ResultSets.  You can use the normal ResultSet methods such as getString and getInt  to retrieve the data from these ResultSets. If a given form of  metadata is not available, these methods should throw a SQLException.

Some of these methods take arguments that are String patterns. These  arguments all have names such as fooPattern. Within a pattern String, "%"  means match any substring of 0 or more characters, and "_" means match  any one character. Only metadata entries matching the search pattern  are returned. If a search pattern argument is set to a null ref, it means  that argument's criteria should be dropped from the search.

A SQLException will be thrown if a driver does not support a meta  data method. In the case of methods that return a ResultSet,  either a ResultSet (which may be empty) is returned or a  SQLException is thrown.

______________________________________________________________________________

 	bestRowNotPseudo

 BEST ROW PSEUDO_COLUMN - is NOT a pseudo column.

 	bestRowPseudo

 BEST ROW PSEUDO_COLUMN - is a pseudo column.

 	bestRowSession

 BEST ROW SCOPE - valid for remainder of current session.

 	bestRowTemporary

 BEST ROW SCOPE - very temporary, while using row.

 	bestRowTransaction

 BEST ROW SCOPE - valid for remainder of current transaction.

 	bestRowUnknown

 BEST ROW PSEUDO_COLUMN - may or may not be pseudo column.

 	columnNoNulls

 COLUMN NULLABLE - might not allow NULL values.

 	columnNullable

 COLUMN NULLABLE - definitely allows NULL values.

 	columnNullableUnknown

 COLUMN NULLABLE - nullability unknown.

 	importedKeyCascade

 IMPORT KEY UPDATE_RULE and DELETE_RULE - for update, change  imported key to agree with primary key update; for delete,  delete rows that import a deleted key.

 	importedKeyInitiallyDeferred

 IMPORT KEY DEFERRABILITY - see SQL92 for definition

 	importedKeyInitiallyImmediate

 IMPORT KEY DEFERRABILITY - see SQL92 for definition

 	importedKeyNoAction

 IMPORT KEY UPDATE_RULE and DELETE_RULE - do not allow update or  delete of primary key if it has been imported.

 	importedKeyNotDeferrable

 IMPORT KEY DEFERRABILITY - see SQL92 for definition

 	importedKeyRestrict

 IMPORT KEY UPDATE_RULE and DELETE_RULE - do not allow update or  delete of primary key if it has been imported.

 	importedKeySetDefault

 IMPORT KEY UPDATE_RULE and DELETE_RULE - change imported key to  default values if its primary key has been updated or deleted.

 	importedKeySetNull

 IMPORT KEY UPDATE_RULE and DELETE_RULE - change imported key to  NULL if its primary key has been updated or deleted.

 	procedureColumnIn

 COLUMN_TYPE - IN parameter.

 	procedureColumnInOut

 COLUMN_TYPE - INOUT parameter.

 	procedureColumnOut

 COLUMN_TYPE - OUT parameter.

 	procedureColumnResult

 COLUMN_TYPE - result column in ResultSet.

 	procedureColumnReturn

 COLUMN_TYPE - procedure return value.

 	procedureColumnUnknown

 COLUMN_TYPE - nobody knows.

 	procedureNoNulls

 TYPE NULLABLE - does not allow NULL values.

 	procedureNoResult

 PROCEDURE_TYPE - Does not return a result.

 	procedureNullable

 TYPE NULLABLE - allows NULL values.

 	procedureNullableUnknown

 TYPE NULLABLE - nullability unknown.

 	procedureResultUnknown

 PROCEDURE_TYPE - May return a result.

 	procedureReturnsResult

 PROCEDURE_TYPE - Returns a result.

 	tableIndexClustered

 INDEX INFO TYPE - this identifies a clustered index

 	tableIndexHashed

 INDEX INFO TYPE - this identifies a hashed index

 	tableIndexOther

 INDEX INFO TYPE - this identifies some other form of index

 	tableIndexStatistic

 INDEX INFO TYPE - this identifies table statistics that are  returned in conjuction with a table's index descriptions

 	typeNoNulls

 TYPE NULLABLE - does not allow NULL values.

 	typeNullable

 TYPE NULLABLE - allows NULL values.

 	typeNullableUnknown

 TYPE NULLABLE - nullability unknown.

 	typePredBasic

 TYPE INFO SEARCHABLE - Supported except for WHERE ..

 	typePredChar

 TYPE INFO SEARCHABLE - Only supported with WHERE ..

 	typePredNone

 TYPE INFO SEARCHABLE - No support.

 	typeSearchable

 TYPE INFO SEARCHABLE - Supported for all WHERE ...

 	versionColumnNotPseudo

 VERSION COLUMNS PSEUDO_COLUMN - is NOT a pseudo column.

 	versionColumnPseudo

 VERSION COLUMNS PSEUDO_COLUMN - is a pseudo column.

 	versionColumnUnknown

 VERSION COLUMNS PSEUDO_COLUMN - may or may not be pseudo column.

 	allProceduresAreCallable()

 Can all the procedures returned by getProcedures be called by the  current user?

 	allTablesAreSelectable()

 Can all the tables returned by getTable be SELECTed by the  current user?

 	dataDefinitionCausesTransactionCommit()

 Does a data definition statement within a transaction force the  transaction to commit?

 	dataDefinitionIgnoredInTransactions()

 Is a data definition statement within a transaction ignored?

 	doesMaxRowSizeIncludeBlobs()

 Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY  blobs?

 	getBestRowIdentifier (String, String, String, int, boolean)

 Get a description of a table's optimal set of columns that  uniquely identifies a row.

 	getCatalogs()

 Get the catalog names available in this database.

 	getCatalogSeparator()

 What's the separator between catalog and table name?

 	getCatalogTerm()

 What's the database vendor's preferred term for "catalog"?

 	getColumnPrivileges(String, String, String, String)

 Get a description of the access rights for a table's columns.

 	getColumns(String, String, String, String)

 Get a description of table columns available in a catalog.

 	getCrossReference (String, String, String, String, String, String)

 Get a description of the foreign key columns in the foreign key  table that reference the primary key columns of the primary key  table (describe how one table imports another's key.) This  should normally return a single foreign key/primary key pair  (most tables only import a foreign key from a table once.) They  are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and  KEY_SEQ.

 	getDatabaseProductName()

 What's the name of this database product?

 	getDatabaseProductVersion()

 What's the version of this database product?

 	getDefaultTransactionIsolation()

 What's the database's default transaction isolation level? The  values are defined in java.sql.Connection.

 	getDriverMajorVersion()

 What's this JDBC driver's major version number?

 	getDriverMinorVersion()

 What's this JDBC driver's minor version number?

 	getDriverName()

 What's the name of this JDBC driver?

 	getDriverVersion()

 What's the version of this JDBC driver?

 	getExportedKeys(String, String, String)

 Get a description of the foreign key columns that reference a  table's primary key columns (the foreign keys exported by a  table).

 	getExtraNameCharacters()

 Get all the "extra" characters that can be used in unquoted  identifier names (those beyond a-z, A-Z, 0-9 and _).

 	getIdentifierQuoteString()

 What's the string used to quote SQL identifiers?  This returns a space " " if identifier quoting isn't supported.

 	getImportedKeys(String, String, String)

 Get a description of the primary key columns that are  referenced by a table's foreign key columns (the primary keys  imported by a table).

 	getIndexInfo (String, String, String, boolean, boolean)

 Get a description of a table's indices and statistics.

 	getMaxBinaryLiteralLength()

 How many hex characters can you have in an inline binary literal?

 	getMaxCatalogNameLength()

 What's the maximum length of a catalog name?

 	getMaxCharLiteralLength()

 What's the max length for a character literal?

 	getMaxColumnNameLength()

 What's the limit on column name length?

 	getMaxColumnsInGroupBy()

 What's the maximum number of columns in a "GROUP BY" clause?

 	getMaxColumnsInIndex()

 What's the maximum number of columns allowed in an index?

 	getMaxColumnsInOrderBy()

 What's the maximum number of columns in an "ORDER BY" clause?

 	getMaxColumnsInSelect()

 What's the maximum number of columns in a "SELECT" list?

 	getMaxColumnsInTable()

 What's the maximum number of columns in a table?

 	getMaxConnections()

 How many active connections can we have at a time to this database?

 	getMaxCursorNameLength()

 What's the maximum cursor name length?

 	getMaxIndexLength()

 What's the maximum length of an index (in bytes)?

 	getMaxProcedureNameLength()

 What's the maximum length of a procedure name?

 	getMaxRowSize()

 What's the maximum length of a single row?

 	getMaxSchemaNameLength()

 What's the maximum length allowed for a schema name?

 	getMaxStatementLength()

 What's the maximum length of a SQL statement?

 	getMaxStatements()

 How many active statements can we have open at one time to this  database?

 	getMaxTableNameLength()

 What's the maximum length of a table name?

 	getMaxTablesInSelect()

 What's the maximum number of tables in a SELECT?

 	getMaxUserNameLength()

 What's the maximum length of a user name?

 	getNumericFunctions()

 Get a comma separated list of math functions.

 	getPrimaryKeys(String, String, String)

 Get a description of a table's primary key columns.

 	getProcedureColumns(String, String, String, String)

 Get a description of a catalog's stored procedure parameters  and result columns.

 	getProcedures(String, String, String)

 Get a description of stored procedures available in a  catalog.

 	getProcedureTerm()

 What's the database vendor's preferred term for "procedure"?

 	getSchemas()

 Get the schema names available in this database.

 	getSchemaTerm()

 What's the database vendor's preferred term for "schema"?

 	getSearchStringEscape()

 This is the string that can be used to escape '_' or '%' in  the string pattern style catalog search parameters.

 	getSQLKeywords()

 Get a comma separated list of all a database's SQL keywords  that are NOT also SQL92 keywords.

 	getStringFunctions()

 Get a comma separated list of string functions.

 	getSystemFunctions()

 Get a comma separated list of system functions.

 	getTablePrivileges(String, String, String)

 Get a description of the access rights for each table available  in a catalog.

 	getTables(String, String, String, String[])

 Get a description of tables available in a catalog.

 	getTableTypes()

 Get the table types available in this database.

 	getTimeDateFunctions()

 Get a comma separated list of time and date functions.

 	getTypeInfo()

 Get a description of all the standard SQL types supported by  this database.

 	getURL()

 What's the url for this database?

 	getUserName()

 What's our user name as known to the database?

 	getVersionColumns(String, String, String)

 Get a description of a table's columns that are automatically  updated when any value in a row is updated.

 	isCatalogAtStart()

 Does a catalog appear at the start of a qualified table name?  (Otherwise it appears at the end)

 	isReadOnly()

 Is the database in read-only mode?

 	nullPlusNonNullIsNull()

 Are concatenations between NULL and non-NULL values NULL?  A JDBC-Compliant driver always returns true.

 	nullsAreSortedAtEnd()

 Are NULL values sorted at the end regardless of sort order?

 	nullsAreSortedAtStart()

 Are NULL values sorted at the start regardless of sort order?

 	nullsAreSortedHigh()

 Are NULL values sorted high?

 	nullsAreSortedLow()

 Are NULL values sorted low?

 	storesLowerCaseIdentifiers()

 Does the database treat mixed case unquoted SQL identifiers as  case insensitive and store them in lower case?

 	storesLowerCaseQuotedIdentifiers()

 Does the database treat mixed case quoted SQL identifiers as  case insensitive and store them in lower case?

 	storesMixedCaseIdentifiers()

 Does the database treat mixed case unquoted SQL identifiers as  case insensitive and store them in mixed case?

 	storesMixedCaseQuotedIdentifiers()

 Does the database treat mixed case quoted SQL identifiers as  case insensitive and store them in mixed case?

 	storesUpperCaseIdentifiers()

 Does the database treat mixed case unquoted SQL identifiers as  case insensitive and store them in upper case?

 	storesUpperCaseQuotedIdentifiers()

 Does the database treat mixed case quoted SQL identifiers as  case insensitive and store them in upper case?

 	supportsAlterTableWithAddColumn()

 Is "ALTER TABLE" with add column supported?

 	supportsAlterTableWithDropColumn()

 Is "ALTER TABLE" with drop column supported?

 	supportsANSI92EntryLevelSQL()

 Is the ANSI92 entry level SQL grammar supported?  All JDBC-Compliant drivers must return true.

 	supportsANSI92FullSQL()

 Is the ANSI92 full SQL grammar supported?

 	supportsANSI92IntermediateSQL()

 Is the ANSI92 intermediate SQL grammar supported?

 	supportsCatalogsInDataManipulation()

 Can a catalog name be used in a data manipulation statement?

 	supportsCatalogsInIndexDefinitions()

 Can a catalog name be used in an index definition statement?

 	supportsCatalogsInPrivilegeDefinitions()

 Can a catalog name be used in a privilege definition statement?

 	supportsCatalogsInProcedureCalls()

 Can a catalog name be used in a procedure call statement?

 	supportsCatalogsInTableDefinitions()

 Can a catalog name be used in a table definition statement?

 	supportsColumnAliasing()

 Is column aliasing supported?

If so, the SQL AS clause can be used to provide names for  computed columns or to provide alias names for columns as  required.

 	supportsConvert()

 Is the CONVERT function between SQL types supported?

 	supportsConvert(int, int)

 Is CONVERT between the given SQL types supported?

 	supportsCoreSQLGrammar()

 Is the ODBC Core SQL grammar supported?

 	supportsCorrelatedSubqueries()

 Are correlated subqueries supported?  A JDBC-Compliant driver always returns true.

 	supportsDataDefinitionAndDataManipulationTransactions ()

 Are both data definition and data manipulation statements  within a transaction supported?

 	supportsDataManipulationTransactionsOnly()

 Are only data manipulation statements within a transaction  supported?

 	supportsDifferentTableCorrelationNames()

 If table correlation names are supported, are they restricted  to be different from the names of the tables?

 	supportsExpressionsInOrderBy()

 Are expressions in "ORDER BY" lists supported?

 	supportsExtendedSQLGrammar()

 Is the ODBC Extended SQL grammar supported?

 	supportsFullOuterJoins()

 Are full nested outer joins supported?

 	supportsGroupBy()

 Is some form of "GROUP BY" clause supported?

 	supportsGroupByBeyondSelect()

 Can a "GROUP BY" clause add columns not in the SELECT  provided it specifies all the columns in the SELECT?

 	supportsGroupByUnrelated()

 Can a "GROUP BY" clause use columns not in the SELECT?

 	supportsIntegrityEnhancementFacility()

 Is the SQL Integrity Enhancement Facility supported?

 	supportsLikeEscapeClause()

 Is the escape character in "LIKE" clauses supported?  A JDBC-Compliant driver always returns true.

 	supportsLimitedOuterJoins()

 Is there limited support for outer joins? (This will be true  if supportFullOuterJoins is true.)

 	supportsMinimumSQLGrammar()

 Is the ODBC Minimum SQL grammar supported?  All JDBC-Compliant drivers must return true.

 	supportsMixedCaseIdentifiers()

 Does the database treat mixed case unquoted SQL identifiers as  case sensitive and as a result store them in mixed case?  A JDBC-Compliant driver will always return false.

 	supportsMixedCaseQuotedIdentifiers()

 Does the database treat mixed case quoted SQL identifiers as  case sensitive and as a result store them in mixed case?  A JDBC-Compliant driver will always return true.

 	supportsMultipleResultSets()

 Are multiple ResultSets from a single execute supported?

 	supportsMultipleTransactions()

 Can we have multiple transactions open at once (on different  connections)?

 	supportsNonNullableColumns()

 Can columns be defined as non-nullable?  A JDBC-Compliant driver always returns true.

 	supportsOpenCursorsAcrossCommit()

 Can cursors remain open across commits?

 	supportsOpenCursorsAcrossRollback()

 Can cursors remain open across rollbacks?

 	supportsOpenStatementsAcrossCommit()

 Can statements remain open across commits?

 	supportsOpenStatementsAcrossRollback()

 Can statements remain open across rollbacks?

 	supportsOrderByUnrelated()

 Can an "ORDER BY" clause use columns not in the SELECT?

 	supportsOuterJoins()

 Is some form of outer join supported?

 	supportsPositionedDelete()

 Is positioned DELETE supported?

 	supportsPositionedUpdate()

 Is positioned UPDATE supported?

 	supportsSchemasInDataManipulation()

 Can a schema name be used in a data manipulation statement?

 	supportsSchemasInIndexDefinitions()

 Can a schema name be used in an index definition statement?

 	supportsSchemasInPrivilegeDefinitions()

 Can a schema name be used in a privilege definition statement?

 	supportsSchemasInProcedureCalls()

 Can a schema name be used in a procedure call statement?

 	supportsSchemasInTableDefinitions()

 Can a schema name be used in a table definition statement?

 	supportsSelectForUpdate()

 Is SELECT for UPDATE supported?

 	supportsStoredProcedures()

 Are stored procedure calls using the stored procedure escape  syntax supported?

 	supportsSubqueriesInComparisons()

 Are subqueries in comparison expressions supported?  A JDBC-Compliant driver always returns true.

 	supportsSubqueriesInExists()

 Are subqueries in 'exists' expressions supported?  A JDBC-Compliant driver always returns true.

 	supportsSubqueriesInIns()

 Are subqueries in 'in' statements supported?  A JDBC-Compliant driver always returns true.

 	supportsSubqueriesInQuantifieds()

 Are subqueries in quantified expressions supported?  A JDBC-Compliant driver always returns true.

 	supportsTableCorrelationNames()

 Are table correlation names supported?  A JDBC-Compliant driver always returns true.

 	supportsTransactionIsolationLevel(int)

 Does the database support the given transaction isolation level?

 	supportsTransactions()

 Are transactions supported? If not, commit is a noop and the  isolation level is TRANSACTION_NONE.

 	supportsUnion()

 Is SQL UNION supported?

 	supportsUnionAll()

 Is SQL UNION ALL supported?

 	usesLocalFilePerTable()

 Does the database use a file for each table?

 	usesLocalFiles()

 Does the database store tables in a local file?

 procedureResultUnknown

  public final static int procedureResultUnknown

 PROCEDURE_TYPE - May return a result.

 procedureNoResult

  public final static int procedureNoResult

 PROCEDURE_TYPE - Does not return a result.

 procedureReturnsResult

  public final static int procedureReturnsResult

 PROCEDURE_TYPE - Returns a result.

 procedureColumnUnknown

  public final static int procedureColumnUnknown

 COLUMN_TYPE - nobody knows.

 procedureColumnIn

  public final static int procedureColumnIn

 COLUMN_TYPE - IN parameter.

 procedureColumnInOut

  public final static int procedureColumnInOut

 COLUMN_TYPE - INOUT parameter.

 procedureColumnOut

  public final static int procedureColumnOut

 COLUMN_TYPE - OUT parameter.

 procedureColumnReturn

  public final static int procedureColumnReturn

 COLUMN_TYPE - procedure return value.

 procedureColumnResult

  public final static int procedureColumnResult

 COLUMN_TYPE - result column in ResultSet.

 procedureNoNulls

  public final static int procedureNoNulls

 TYPE NULLABLE - does not allow NULL values.

 procedureNullable

  public final static int procedureNullable

 TYPE NULLABLE - allows NULL values.

 procedureNullableUnknown

  public final static int procedureNullableUnknown

 TYPE NULLABLE - nullability unknown.

 columnNoNulls

  public final static int columnNoNulls

 COLUMN NULLABLE - might not allow NULL values.

 columnNullable

  public final static int columnNullable

 COLUMN NULLABLE - definitely allows NULL values.

 columnNullableUnknown

  public final static int columnNullableUnknown

 COLUMN NULLABLE - nullability unknown.

 bestRowTemporary

  public final static int bestRowTemporary

 BEST ROW SCOPE - very temporary, while using row.

 bestRowTransaction

  public final static int bestRowTransaction

 BEST ROW SCOPE - valid for remainder of current transaction.

 bestRowSession

  public final static int bestRowSession

 BEST ROW SCOPE - valid for remainder of current session.

 bestRowUnknown

  public final static int bestRowUnknown

 BEST ROW PSEUDO_COLUMN - may or may not be pseudo column.

 bestRowNotPseudo

  public final static int bestRowNotPseudo

 BEST ROW PSEUDO_COLUMN - is NOT a pseudo column.

 bestRowPseudo

  public final static int bestRowPseudo

 BEST ROW PSEUDO_COLUMN - is a pseudo column.

 versionColumnUnknown

  public final static int versionColumnUnknown

 VERSION COLUMNS PSEUDO_COLUMN - may or may not be pseudo column.

 versionColumnNotPseudo

  public final static int versionColumnNotPseudo

 VERSION COLUMNS PSEUDO_COLUMN - is NOT a pseudo column.

 versionColumnPseudo

  public final static int versionColumnPseudo

 VERSION COLUMNS PSEUDO_COLUMN - is a pseudo column.

 importedKeyCascade

  public final static int importedKeyCascade

 IMPORT KEY UPDATE_RULE and DELETE_RULE - for update, change  imported key to agree with primary key update; for delete,  delete rows that import a deleted key.

 importedKeyRestrict

  public final static int importedKeyRestrict

 IMPORT KEY UPDATE_RULE and DELETE_RULE - do not allow update or  delete of primary key if it has been imported.

 importedKeySetNull

  public final static int importedKeySetNull

 IMPORT KEY UPDATE_RULE and DELETE_RULE - change imported key to  NULL if its primary key has been updated or deleted.

 importedKeyNoAction

  public final static int importedKeyNoAction

 IMPORT KEY UPDATE_RULE and DELETE_RULE - do not allow update or  delete of primary key if it has been imported.

 importedKeySetDefault

  public final static int importedKeySetDefault

 IMPORT KEY UPDATE_RULE and DELETE_RULE - change imported key to  default values if its primary key has been updated or deleted.

 importedKeyInitiallyDeferred

  public final static int importedKeyInitiallyDeferred

 IMPORT KEY DEFERRABILITY - see SQL92 for definition

 importedKeyInitiallyImmediate

  public final static int importedKeyInitiallyImmediate

 IMPORT KEY DEFERRABILITY - see SQL92 for definition

 importedKeyNotDeferrable

  public final static int importedKeyNotDeferrable

 IMPORT KEY DEFERRABILITY - see SQL92 for definition

 typeNoNulls

  public final static int typeNoNulls

 TYPE NULLABLE - does not allow NULL values.

 typeNullable

  public final static int typeNullable

 TYPE NULLABLE - allows NULL values.

 typeNullableUnknown

  public final static int typeNullableUnknown

 TYPE NULLABLE - nullability unknown.

 typePredNone

  public final static int typePredNone

 TYPE INFO SEARCHABLE - No support.

 typePredChar

  public final static int typePredChar

 TYPE INFO SEARCHABLE - Only supported with WHERE .. LIKE.

 typePredBasic

  public final static int typePredBasic

 TYPE INFO SEARCHABLE - Supported except for WHERE .. LIKE.

 typeSearchable

  public final static int typeSearchable

 TYPE INFO SEARCHABLE - Supported for all WHERE ...

 tableIndexStatistic

  public final static short tableIndexStatistic

 INDEX INFO TYPE - this identifies table statistics that are  returned in conjuction with a table's index descriptions

 tableIndexClustered

  public final static short tableIndexClustered

 INDEX INFO TYPE - this identifies a clustered index

 tableIndexHashed

  public final static short tableIndexHashed

 INDEX INFO TYPE - this identifies a hashed index

 tableIndexOther

  public final static short tableIndexOther

 INDEX INFO TYPE - this identifies some other form of index

 allProceduresAreCallable

  public abstract boolean allProceduresAreCallable() throws SQLException

 Can all the procedures returned by getProcedures be called by the  current user?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 allTablesAreSelectable

  public abstract boolean allTablesAreSelectable() throws SQLException

 Can all the tables returned by getTable be SELECTed by the  current user?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 getURL

  public abstract String getURL() throws SQLException

 What's the url for this database?

Returns:

 the url or null if it can't be generated

Throws: SQLException

 if a database-access error occurs.

 getUserName

  public abstract String getUserName() throws SQLException

 What's our user name as known to the database?

Returns:

 our database user name

Throws: SQLException

 if a database-access error occurs.

 isReadOnly

  public abstract boolean isReadOnly() throws SQLException

 Is the database in read-only mode?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 nullsAreSortedHigh

  public abstract boolean nullsAreSortedHigh() throws SQLException

 Are NULL values sorted high?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 nullsAreSortedLow

  public abstract boolean nullsAreSortedLow() throws SQLException

 Are NULL values sorted low?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 nullsAreSortedAtStart

  public abstract boolean nullsAreSortedAtStart() throws SQLException

 Are NULL values sorted at the start regardless of sort order?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 nullsAreSortedAtEnd

  public abstract boolean nullsAreSortedAtEnd() throws SQLException

 Are NULL values sorted at the end regardless of sort order?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 getDatabaseProductName

  public abstract String getDatabaseProductName() throws SQLException

 What's the name of this database product?

Returns:

 database product name

Throws: SQLException

 if a database-access error occurs.

 getDatabaseProductVersion

  public abstract String getDatabaseProductVersion() throws SQLException

 What's the version of this database product?

Returns:

 database version

Throws: SQLException

 if a database-access error occurs.

 getDriverName

  public abstract String getDriverName() throws SQLException

 What's the name of this JDBC driver?

Returns:

 JDBC driver name

Throws: SQLException

 if a database-access error occurs.

 getDriverVersion

  public abstract String getDriverVersion() throws SQLException

 What's the version of this JDBC driver?

Returns:

 JDBC driver version

Throws: SQLException

 if a database-access error occurs.

 getDriverMajorVersion

  public abstract int getDriverMajorVersion()

 What's this JDBC driver's major version number?

Returns:

 JDBC driver major version

 getDriverMinorVersion

  public abstract int getDriverMinorVersion()

 What's this JDBC driver's minor version number?

Returns:

 JDBC driver minor version number

 usesLocalFiles

  public abstract boolean usesLocalFiles() throws SQLException

 Does the database store tables in a local file?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 usesLocalFilePerTable

  public abstract boolean usesLocalFilePerTable() throws SQLException

 Does the database use a file for each table?

Returns:

 true if the database uses a local file for each table

Throws: SQLException

 if a database-access error occurs.

 supportsMixedCaseIdentifiers

  public abstract boolean supportsMixedCaseIdentifiers() throws SQLException

 Does the database treat mixed case unquoted SQL identifiers as  case sensitive and as a result store them in mixed case?  A JDBC-Compliant driver will always return false.

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 storesUpperCaseIdentifiers

  public abstract boolean storesUpperCaseIdentifiers() throws SQLException

 Does the database treat mixed case unquoted SQL identifiers as  case insensitive and store them in upper case?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 storesLowerCaseIdentifiers

  public abstract boolean storesLowerCaseIdentifiers() throws SQLException

 Does the database treat mixed case unquoted SQL identifiers as  case insensitive and store them in lower case?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 storesMixedCaseIdentifiers

  public abstract boolean storesMixedCaseIdentifiers() throws SQLException

 Does the database treat mixed case unquoted SQL identifiers as  case insensitive and store them in mixed case?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsMixedCaseQuotedIdentifiers

  public abstract boolean supportsMixedCaseQuotedIdentifiers() throws SQLException

 Does the database treat mixed case quoted SQL identifiers as  case sensitive and as a result store them in mixed case?  A JDBC-Compliant driver will always return true.

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 storesUpperCaseQuotedIdentifiers

  public abstract boolean storesUpperCaseQuotedIdentifiers() throws SQLException

 Does the database treat mixed case quoted SQL identifiers as  case insensitive and store them in upper case?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 storesLowerCaseQuotedIdentifiers

  public abstract boolean storesLowerCaseQuotedIdentifiers() throws SQLException

 Does the database treat mixed case quoted SQL identifiers as  case insensitive and store them in lower case?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 storesMixedCaseQuotedIdentifiers

  public abstract boolean storesMixedCaseQuotedIdentifiers() throws SQLException

 Does the database treat mixed case quoted SQL identifiers as  case insensitive and store them in mixed case?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 getIdentifierQuoteString

  public abstract String getIdentifierQuoteString() throws SQLException

 What's the string used to quote SQL identifiers?  This returns a space " " if identifier quoting isn't supported.  A JDBC-Compliant driver always uses a double quote character.

Returns:

 the quoting string

Throws: SQLException

 if a database-access error occurs.

 getSQLKeywords

  public abstract String getSQLKeywords() throws SQLException

 Get a comma separated list of all a database's SQL keywords  that are NOT also SQL92 keywords.

Returns:

 the list

Throws: SQLException

 if a database-access error occurs.

 getNumericFunctions

  public abstract String getNumericFunctions() throws SQLException

 Get a comma separated list of math functions.

Returns:

 the list

Throws: SQLException

 if a database-access error occurs.

 getStringFunctions

  public abstract String getStringFunctions() throws SQLException

 Get a comma separated list of string functions.

Returns:

 the list

Throws: SQLException

 if a database-access error occurs.

 getSystemFunctions

  public abstract String getSystemFunctions() throws SQLException

 Get a comma separated list of system functions.

Returns:

 the list

Throws: SQLException

 if a database-access error occurs.

 getTimeDateFunctions

  public abstract String getTimeDateFunctions() throws SQLException

 Get a comma separated list of time and date functions.

Returns:

 the list

Throws: SQLException

 if a database-access error occurs.

 getSearchStringEscape

  public abstract String getSearchStringEscape() throws SQLException

 This is the string that can be used to escape '_' or '%' in  the string pattern style catalog search parameters.

The '_' character represents any single character.

The '%' character represents any sequence of zero or  more characters.

Returns:

 the string used to escape wildcard characters

Throws: SQLException

 if a database-access error occurs.

 getExtraNameCharacters

  public abstract String getExtraNameCharacters() throws SQLException

 Get all the "extra" characters that can be used in unquoted  identifier names (those beyond a-z, A-Z, 0-9 and _).

Returns:

 the string containing the extra characters

Throws: SQLException

 if a database-access error occurs.

 supportsAlterTableWithAddColumn

  public abstract boolean supportsAlterTableWithAddColumn() throws SQLException

 Is "ALTER TABLE" with add column supported?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsAlterTableWithDropColumn

  public abstract boolean supportsAlterTableWithDropColumn() throws SQLException

 Is "ALTER TABLE" with drop column supported?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsColumnAliasing

  public abstract boolean supportsColumnAliasing() throws SQLException

 Is column aliasing supported?

If so, the SQL AS clause can be used to provide names for  computed columns or to provide alias names for columns as  required.  A JDBC-Compliant driver always returns true.

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 nullPlusNonNullIsNull

  public abstract boolean nullPlusNonNullIsNull() throws SQLException

 Are concatenations between NULL and non-NULL values NULL?  A JDBC-Compliant driver always returns true.

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsConvert

  public abstract boolean supportsConvert() throws SQLException

 Is the CONVERT function between SQL types supported?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsConvert

  public abstract boolean supportsConvert(int fromType,
                                          int toType) throws SQLException

 Is CONVERT between the given SQL types supported?

Parameters:

 fromType - the type to convert from

 toType - the type to convert to

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

See Also:

Types

 supportsTableCorrelationNames

  public abstract boolean supportsTableCorrelationNames() throws SQLException

 Are table correlation names supported?  A JDBC-Compliant driver always returns true.

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsDifferentTableCorrelationNames

  public abstract boolean supportsDifferentTableCorrelationNames() throws SQLException

 If table correlation names are supported, are they restricted  to be different from the names of the tables?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsExpressionsInOrderBy

  public abstract boolean supportsExpressionsInOrderBy() throws SQLException

 Are expressions in "ORDER BY" lists supported?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsOrderByUnrelated

  public abstract boolean supportsOrderByUnrelated() throws SQLException

 Can an "ORDER BY" clause use columns not in the SELECT?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsGroupBy

  public abstract boolean supportsGroupBy() throws SQLException

 Is some form of "GROUP BY" clause supported?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsGroupByUnrelated

  public abstract boolean supportsGroupByUnrelated() throws SQLException

 Can a "GROUP BY" clause use columns not in the SELECT?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsGroupByBeyondSelect

  public abstract boolean supportsGroupByBeyondSelect() throws SQLException

 Can a "GROUP BY" clause add columns not in the SELECT  provided it specifies all the columns in the SELECT?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsLikeEscapeClause

  public abstract boolean supportsLikeEscapeClause() throws SQLException

 Is the escape character in "LIKE" clauses supported?  A JDBC-Compliant driver always returns true.

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsMultipleResultSets

  public abstract boolean supportsMultipleResultSets() throws SQLException

 Are multiple ResultSets from a single execute supported?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsMultipleTransactions

  public abstract boolean supportsMultipleTransactions() throws SQLException

 Can we have multiple transactions open at once (on different  connections)?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsNonNullableColumns

  public abstract boolean supportsNonNullableColumns() throws SQLException

 Can columns be defined as non-nullable?  A JDBC-Compliant driver always returns true.

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsMinimumSQLGrammar

  public abstract boolean supportsMinimumSQLGrammar() throws SQLException

 Is the ODBC Minimum SQL grammar supported?  All JDBC-Compliant drivers must return true.

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsCoreSQLGrammar

  public abstract boolean supportsCoreSQLGrammar() throws SQLException

 Is the ODBC Core SQL grammar supported?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsExtendedSQLGrammar

  public abstract boolean supportsExtendedSQLGrammar() throws SQLException

 Is the ODBC Extended SQL grammar supported?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsANSI92EntryLevelSQL

  public abstract boolean supportsANSI92EntryLevelSQL() throws SQLException

 Is the ANSI92 entry level SQL grammar supported?  All JDBC-Compliant drivers must return true.

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsANSI92IntermediateSQL

  public abstract boolean supportsANSI92IntermediateSQL() throws SQLException

 Is the ANSI92 intermediate SQL grammar supported?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsANSI92FullSQL

  public abstract boolean supportsANSI92FullSQL() throws SQLException

 Is the ANSI92 full SQL grammar supported?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsIntegrityEnhancementFacility

  public abstract boolean supportsIntegrityEnhancementFacility() throws SQLException

 Is the SQL Integrity Enhancement Facility supported?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsOuterJoins

  public abstract boolean supportsOuterJoins() throws SQLException

 Is some form of outer join supported?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsFullOuterJoins

  public abstract boolean supportsFullOuterJoins() throws SQLException

 Are full nested outer joins supported?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsLimitedOuterJoins

  public abstract boolean supportsLimitedOuterJoins() throws SQLException

 Is there limited support for outer joins? (This will be true  if supportFullOuterJoins is true.)

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 getSchemaTerm

  public abstract String getSchemaTerm() throws SQLException

 What's the database vendor's preferred term for "schema"?

Returns:

 the vendor term

Throws: SQLException

 if a database-access error occurs.

 getProcedureTerm

  public abstract String getProcedureTerm() throws SQLException

 What's the database vendor's preferred term for "procedure"?

Returns:

 the vendor term

Throws: SQLException

 if a database-access error occurs.

 getCatalogTerm

  public abstract String getCatalogTerm() throws SQLException

 What's the database vendor's preferred term for "catalog"?

Returns:

 the vendor term

Throws: SQLException

 if a database-access error occurs.

 isCatalogAtStart

  public abstract boolean isCatalogAtStart() throws SQLException

 Does a catalog appear at the start of a qualified table name?  (Otherwise it appears at the end)

Returns:

 true if it appears at the start

Throws: SQLException

 if a database-access error occurs.

 getCatalogSeparator

  public abstract String getCatalogSeparator() throws SQLException

 What's the separator between catalog and table name?

Returns:

 the separator string

Throws: SQLException

 if a database-access error occurs.

 supportsSchemasInDataManipulation

  public abstract boolean supportsSchemasInDataManipulation() throws SQLException

 Can a schema name be used in a data manipulation statement?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsSchemasInProcedureCalls

  public abstract boolean supportsSchemasInProcedureCalls() throws SQLException

 Can a schema name be used in a procedure call statement?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsSchemasInTableDefinitions

  public abstract boolean supportsSchemasInTableDefinitions() throws SQLException

 Can a schema name be used in a table definition statement?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsSchemasInIndexDefinitions

  public abstract boolean supportsSchemasInIndexDefinitions() throws SQLException

 Can a schema name be used in an index definition statement?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsSchemasInPrivilegeDefinitions

  public abstract boolean supportsSchemasInPrivilegeDefinitions() throws SQLException

 Can a schema name be used in a privilege definition statement?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsCatalogsInDataManipulation

  public abstract boolean supportsCatalogsInDataManipulation() throws SQLException

 Can a catalog name be used in a data manipulation statement?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsCatalogsInProcedureCalls

  public abstract boolean supportsCatalogsInProcedureCalls() throws SQLException

 Can a catalog name be used in a procedure call statement?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsCatalogsInTableDefinitions

  public abstract boolean supportsCatalogsInTableDefinitions() throws SQLException

 Can a catalog name be used in a table definition statement?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsCatalogsInIndexDefinitions

  public abstract boolean supportsCatalogsInIndexDefinitions() throws SQLException

 Can a catalog name be used in an index definition statement?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsCatalogsInPrivilegeDefinitions

  public abstract boolean supportsCatalogsInPrivilegeDefinitions() throws SQLException

 Can a catalog name be used in a privilege definition statement?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsPositionedDelete

  public abstract boolean supportsPositionedDelete() throws SQLException

 Is positioned DELETE supported?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsPositionedUpdate

  public abstract boolean supportsPositionedUpdate() throws SQLException

 Is positioned UPDATE supported?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsSelectForUpdate

  public abstract boolean supportsSelectForUpdate() throws SQLException

 Is SELECT for UPDATE supported?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsStoredProcedures

  public abstract boolean supportsStoredProcedures() throws SQLException

 Are stored procedure calls using the stored procedure escape  syntax supported?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsSubqueriesInComparisons

  public abstract boolean supportsSubqueriesInComparisons() throws SQLException

 Are subqueries in comparison expressions supported?  A JDBC-Compliant driver always returns true.

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsSubqueriesInExists

  public abstract boolean supportsSubqueriesInExists() throws SQLException

 Are subqueries in 'exists' expressions supported?  A JDBC-Compliant driver always returns true.

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsSubqueriesInIns

  public abstract boolean supportsSubqueriesInIns() throws SQLException

 Are subqueries in 'in' statements supported?  A JDBC-Compliant driver always returns true.

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsSubqueriesInQuantifieds

  public abstract boolean supportsSubqueriesInQuantifieds() throws SQLException

 Are subqueries in quantified expressions supported?  A JDBC-Compliant driver always returns true.

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsCorrelatedSubqueries

  public abstract boolean supportsCorrelatedSubqueries() throws SQLException

 Are correlated subqueries supported?  A JDBC-Compliant driver always returns true.

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsUnion

  public abstract boolean supportsUnion() throws SQLException

 Is SQL UNION supported?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsUnionAll

  public abstract boolean supportsUnionAll() throws SQLException

 Is SQL UNION ALL supported?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsOpenCursorsAcrossCommit

  public abstract boolean supportsOpenCursorsAcrossCommit() throws SQLException

 Can cursors remain open across commits?

Returns:

 true if cursors always remain open; false if they might not remain open

Throws: SQLException

 if a database-access error occurs.

 supportsOpenCursorsAcrossRollback

  public abstract boolean supportsOpenCursorsAcrossRollback() throws SQLException

 Can cursors remain open across rollbacks?

Returns:

 true if cursors always remain open; false if they might not remain open

Throws: SQLException

 if a database-access error occurs.

 supportsOpenStatementsAcrossCommit

  public abstract boolean supportsOpenStatementsAcrossCommit() throws SQLException

 Can statements remain open across commits?

Returns:

 true if statements always remain open; false if they might not remain open

Throws: SQLException

 if a database-access error occurs.

 supportsOpenStatementsAcrossRollback

  public abstract boolean supportsOpenStatementsAcrossRollback() throws SQLException

 Can statements remain open across rollbacks?

Returns:

 true if statements always remain open; false if they might not remain open

Throws: SQLException

 if a database-access error occurs.

 getMaxBinaryLiteralLength

  public abstract int getMaxBinaryLiteralLength() throws SQLException

 How many hex characters can you have in an inline binary literal?

Returns:

 max literal length

Throws: SQLException

 if a database-access error occurs.

 getMaxCharLiteralLength

  public abstract int getMaxCharLiteralLength() throws SQLException

 What's the max length for a character literal?

Returns:

 max literal length

Throws: SQLException

 if a database-access error occurs.

 getMaxColumnNameLength

  public abstract int getMaxColumnNameLength() throws SQLException

 What's the limit on column name length?

Returns:

 max literal length

Throws: SQLException

 if a database-access error occurs.

 getMaxColumnsInGroupBy

  public abstract int getMaxColumnsInGroupBy() throws SQLException

 What's the maximum number of columns in a "GROUP BY" clause?

Returns:

 max number of columns

Throws: SQLException

 if a database-access error occurs.

 getMaxColumnsInIndex

  public abstract int getMaxColumnsInIndex() throws SQLException

 What's the maximum number of columns allowed in an index?

Returns:

 max columns

Throws: SQLException

 if a database-access error occurs.

 getMaxColumnsInOrderBy

  public abstract int getMaxColumnsInOrderBy() throws SQLException

 What's the maximum number of columns in an "ORDER BY" clause?

Returns:

 max columns

Throws: SQLException

 if a database-access error occurs.

 getMaxColumnsInSelect

  public abstract int getMaxColumnsInSelect() throws SQLException

 What's the maximum number of columns in a "SELECT" list?

Returns:

 max columns

Throws: SQLException

 if a database-access error occurs.

 getMaxColumnsInTable

  public abstract int getMaxColumnsInTable() throws SQLException

 What's the maximum number of columns in a table?

Returns:

 max columns

Throws: SQLException

 if a database-access error occurs.

 getMaxConnections

  public abstract int getMaxConnections() throws SQLException

 How many active connections can we have at a time to this database?

Returns:

 max connections

Throws: SQLException

 if a database-access error occurs.

 getMaxCursorNameLength

  public abstract int getMaxCursorNameLength() throws SQLException

 What's the maximum cursor name length?

Returns:

 max cursor name length in bytes

Throws: SQLException

 if a database-access error occurs.

 getMaxIndexLength

  public abstract int getMaxIndexLength() throws SQLException

 What's the maximum length of an index (in bytes)?

Returns:

 max index length in bytes

Throws: SQLException

 if a database-access error occurs.

 getMaxSchemaNameLength

  public abstract int getMaxSchemaNameLength() throws SQLException

 What's the maximum length allowed for a schema name?

Returns:

 max name length in bytes

Throws: SQLException

 if a database-access error occurs.

 getMaxProcedureNameLength

  public abstract int getMaxProcedureNameLength() throws SQLException

 What's the maximum length of a procedure name?

Returns:

 max name length in bytes

Throws: SQLException

 if a database-access error occurs.

 getMaxCatalogNameLength

  public abstract int getMaxCatalogNameLength() throws SQLException

 What's the maximum length of a catalog name?

Returns:

 max name length in bytes

Throws: SQLException

 if a database-access error occurs.

 getMaxRowSize

  public abstract int getMaxRowSize() throws SQLException

 What's the maximum length of a single row?

Returns:

 max row size in bytes

Throws: SQLException

 if a database-access error occurs.

 doesMaxRowSizeIncludeBlobs

  public abstract boolean doesMaxRowSizeIncludeBlobs() throws SQLException

 Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY  blobs?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 getMaxStatementLength

  public abstract int getMaxStatementLength() throws SQLException

 What's the maximum length of a SQL statement?

Returns:

 max length in bytes

Throws: SQLException

 if a database-access error occurs.

 getMaxStatements

  public abstract int getMaxStatements() throws SQLException

 How many active statements can we have open at one time to this  database?

Returns:

 the maximum

Throws: SQLException

 if a database-access error occurs.

 getMaxTableNameLength

  public abstract int getMaxTableNameLength() throws SQLException

 What's the maximum length of a table name?

Returns:

 max name length in bytes

Throws: SQLException

 if a database-access error occurs.

 getMaxTablesInSelect

  public abstract int getMaxTablesInSelect() throws SQLException

 What's the maximum number of tables in a SELECT?

Returns:

 the maximum

Throws: SQLException

 if a database-access error occurs.

 getMaxUserNameLength

  public abstract int getMaxUserNameLength() throws SQLException

 What's the maximum length of a user name?

Returns:

 max name length in bytes

Throws: SQLException

 if a database-access error occurs.

 getDefaultTransactionIsolation

  public abstract int getDefaultTransactionIsolation() throws SQLException

 What's the database's default transaction isolation level? The  values are defined in java.sql.Connection.

Returns:

 the default isolation level

Throws: SQLException

 if a database-access error occurs.

See Also:

Connection

 supportsTransactions

  public abstract boolean supportsTransactions() throws SQLException

 Are transactions supported? If not, commit is a noop and the  isolation level is TRANSACTION_NONE.

Returns:

 true if transactions are supported

Throws: SQLException

 if a database-access error occurs.

 supportsTransactionIsolationLevel

  public abstract boolean supportsTransactionIsolationLevel(int level) throws SQLException

 Does the database support the given transaction isolation level?

Parameters:

 level - the values are defined in java.sql.Connection

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

See Also:

Connection

 supportsDataDefinitionAndDataManipulationTransactions

  public abstract boolean supportsDataDefinitionAndDataManipulationTransactions() throws SQLException

 Are both data definition and data manipulation statements  within a transaction supported?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 supportsDataManipulationTransactionsOnly

  public abstract boolean supportsDataManipulationTransactionsOnly() throws SQLException

 Are only data manipulation statements within a transaction  supported?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 dataDefinitionCausesTransactionCommit

  public abstract boolean dataDefinitionCausesTransactionCommit() throws SQLException

 Does a data definition statement within a transaction force the  transaction to commit?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 dataDefinitionIgnoredInTransactions

  public abstract boolean dataDefinitionIgnoredInTransactions() throws SQLException

 Is a data definition statement within a transaction ignored?

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 getProcedures

  public abstract ResultSet getProcedures(String catalog,
                                          String schemaPattern,
                                          String procedureNamePattern) throws SQLException

 Get a description of stored procedures available in a  catalog.

Only procedure descriptions matching the schema and  procedure name criteria are returned. They are ordered by  PROCEDURE_SCHEM, and PROCEDURE_NAME.

Each procedure description has the the following columns:

1. PROCEDURE_CAT String => procedure catalog (may be null)

2. PROCEDURE_SCHEM String => procedure schema (may be null)

3. PROCEDURE_NAME String => procedure name

4.  reserved for future use

5.  reserved for future use

6.  reserved for future use

7. REMARKS String => explanatory comment on the procedure

8. PROCEDURE_TYPE short => kind of procedure:

•  procedureResultUnknown - May return a result

•  procedureNoResult - Does not return a result

•  procedureReturnsResult - Returns a result

Parameters:

 catalog - a catalog name; "" retrieves those without a  catalog; null means drop catalog name from the selection criteria

 schemaPattern - a schema name pattern; "" retrieves those  without a schema

 procedureNamePattern - a procedure name pattern

Returns:

 ResultSet - each row is a procedure description

Throws: SQLException

 if a database-access error occurs.

See Also:

getSearchStringEscape

 getProcedureColumns

  public abstract ResultSet getProcedureColumns(String catalog,
                                                String schemaPattern,
                                                String procedureNamePattern,
                                                String columnNamePattern) throws SQLException

 Get a description of a catalog's stored procedure parameters  and result columns.

Only descriptions matching the schema, procedure and  parameter name criteria are returned. They are ordered by  PROCEDURE_SCHEM and PROCEDURE_NAME. Within this, the return value,  if any, is first. Next are the parameter descriptions in call  order. The column descriptions follow in column number order.

Each row in the ResultSet is a parameter description or  column description with the following fields:

1. PROCEDURE_CAT String => procedure catalog (may be null)

2. PROCEDURE_SCHEM String => procedure schema (may be null)

3. PROCEDURE_NAME String => procedure name

4. COLUMN_NAME String => column/parameter name

5. COLUMN_TYPE Short => kind of column/parameter:

•  procedureColumnUnknown - nobody knows

•  procedureColumnIn - IN parameter

•  procedureColumnInOut - INOUT parameter

•  procedureColumnOut - OUT parameter

•  procedureColumnReturn - procedure return value

•  procedureColumnResult - result column in ResultSet

6. DATA_TYPE short => SQL type from java.sql.Types

7. TYPE_NAME String => SQL type name

8. PRECISION int => precision

9. LENGTH int => length in bytes of data

10. SCALE short => scale

11. RADIX short => radix

12. NULLABLE short => can it contain NULL?

•  procedureNoNulls - does not allow NULL values

•  procedureNullable - allows NULL values

•  procedureNullableUnknown - nullability unknown

13. REMARKS String => comment describing parameter/column

Note: Some databases may not return the column  descriptions for a procedure. Additional columns beyond  REMARKS can be defined by the database.

Parameters:

 catalog - a catalog name; "" retrieves those without a  catalog; null means drop catalog name from the selection criteria

 schemaPattern - a schema name pattern; "" retrieves those  without a schema

 procedureNamePattern - a procedure name pattern

 columnNamePattern - a column name pattern

Returns:

 ResultSet - each row is a stored procedure parameter or  column description

Throws: SQLException

 if a database-access error occurs.

See Also:

getSearchStringEscape

 getTables

  public abstract ResultSet getTables(String catalog,
                                      String schemaPattern,
                                      String tableNamePattern,
                                      String types[]) throws SQLException

 Get a description of tables available in a catalog.

Only table descriptions matching the catalog, schema, table  name and type criteria are returned. They are ordered by  TABLE_TYPE, TABLE_SCHEM and TABLE_NAME.

Each table description has the following columns:

1. TABLE_CAT String => table catalog (may be null)

2. TABLE_SCHEM String => table schema (may be null)

3. TABLE_NAME String => table name

4. TABLE_TYPE String => table type. Typical types are "TABLE", 	"VIEW",	"SYSTEM TABLE", "GLOBAL TEMPORARY", 	"LOCAL TEMPORARY", "ALIAS", "SYNONYM".

5. REMARKS String => explanatory comment on the table

Note: Some databases may not return information for  all tables.

Parameters:

 catalog - a catalog name; "" retrieves those without a  catalog; null means drop catalog name from the selection criteria

 schemaPattern - a schema name pattern; "" retrieves those  without a schema

 tableNamePattern - a table name pattern

 types - a list of table types to include; null returns all types

Returns:

 ResultSet - each row is a table description

Throws: SQLException

 if a database-access error occurs.

See Also:

getSearchStringEscape

 getSchemas

  public abstract ResultSet getSchemas() throws SQLException

 Get the schema names available in this database. The results  are ordered by schema name.

The schema column is:

1. TABLE_SCHEM String => schema name

Returns:

 ResultSet - each row has a single String column that is a  schema name

Throws: SQLException

 if a database-access error occurs.

 getCatalogs

  public abstract ResultSet getCatalogs() throws SQLException

 Get the catalog names available in this database. The results  are ordered by catalog name.

The catalog column is:

1. TABLE_CAT String => catalog name

Returns:

 ResultSet - each row has a single String column that is a  catalog name

Throws: SQLException

 if a database-access error occurs.

 getTableTypes

  public abstract ResultSet getTableTypes() throws SQLException

 Get the table types available in this database. The results  are ordered by table type.

The table type is:

1. TABLE_TYPE String => table type. Typical types are "TABLE", 	"VIEW",	"SYSTEM TABLE", "GLOBAL TEMPORARY", 	"LOCAL TEMPORARY", "ALIAS", "SYNONYM".

Returns:

 ResultSet - each row has a single String column that is a  table type

Throws: SQLException

 if a database-access error occurs.

 getColumns

  public abstract ResultSet getColumns(String catalog,
                                       String schemaPattern,
                                       String tableNamePattern,
                                       String columnNamePattern) throws SQLException

 Get a description of table columns available in a catalog.

Only column descriptions matching the catalog, schema, table  and column name criteria are returned. They are ordered by  TABLE_SCHEM, TABLE_NAME and ORDINAL_POSITION.

Each column description has the following columns:

1. TABLE_CAT String => table catalog (may be null)

2. TABLE_SCHEM String => table schema (may be null)

3. TABLE_NAME String => table name

4. COLUMN_NAME String => column name

5. DATA_TYPE short => SQL type from java.sql.Types

6. TYPE_NAME String => Data source dependent type name

7. COLUMN_SIZE int => column size. For char or date 	types this is the maximum number of characters, for numeric or 	decimal types this is precision.

8. BUFFER_LENGTH is not used.

9. DECIMAL_DIGITS int => the number of fractional digits

10. NUM_PREC_RADIX int => Radix (typically either 10 or 2)

11. NULLABLE int => is NULL allowed?

•  columnNoNulls - might not allow NULL values

•  columnNullable - definitely allows NULL values

•  columnNullableUnknown - nullability unknown

12. REMARKS String => comment describing column (may be null)

13. COLUMN_DEF String => default value (may be null)

14. SQL_DATA_TYPE int => unused

15. SQL_DATETIME_SUB int => unused

16. CHAR_OCTET_LENGTH int => for char types the  maximum number of bytes in the column

17. ORDINAL_POSITION int	=> index of column in table  (starting at 1)

18. IS_NULLABLE String => "NO" means column definitely  does not allow NULL values; "YES" means the column might  allow NULL values. An empty string means nobody knows.

Parameters:

 catalog - a catalog name; "" retrieves those without a  catalog; null means drop catalog name from the selection criteria

 schemaPattern - a schema name pattern; "" retrieves those  without a schema

 tableNamePattern - a table name pattern

 columnNamePattern - a column name pattern

Returns:

 ResultSet - each row is a column description

Throws: SQLException

 if a database-access error occurs.

See Also:

getSearchStringEscape

 getColumnPrivileges

  public abstract ResultSet getColumnPrivileges(String catalog,
                                                String schema,
                                                String table,
                                                String columnNamePattern) throws SQLException

 Get a description of the access rights for a table's columns.

Only privileges matching the column name criteria are  returned. They are ordered by COLUMN_NAME and PRIVILEGE.

Each privilige description has the following columns:

1. TABLE_CAT String => table catalog (may be null)

2. TABLE_SCHEM String => table schema (may be null)

3. TABLE_NAME String => table name

4. COLUMN_NAME String => column name

5. GRANTOR => grantor of access (may be null)

6. GRANTEE String => grantee of access

7. PRIVILEGE String => name of access (SELECT,  INSERT, UPDATE, REFRENCES, ...)

8. IS_GRANTABLE String => "YES" if grantee is permitted  to grant to others; "NO" if not; null if unknown

Parameters:

 catalog - a catalog name; "" retrieves those without a  catalog; null means drop catalog name from the selection criteria

 schema - a schema name; "" retrieves those without a schema

 table - a table name

 columnNamePattern - a column name pattern

Returns:

 ResultSet - each row is a column privilege description

Throws: SQLException

 if a database-access error occurs.

See Also:

getSearchStringEscape

 getTablePrivileges

  public abstract ResultSet getTablePrivileges(String catalog,
                                               String schemaPattern,
                                               String tableNamePattern) throws SQLException

 Get a description of the access rights for each table available  in a catalog. Note that a table privilege applies to one or  more columns in the table. It would be wrong to assume that  this priviledge applies to all columns (this may be true for  some systems but is not true for all.)

Only privileges matching the schema and table name  criteria are returned. They are ordered by TABLE_SCHEM,  TABLE_NAME, and PRIVILEGE.

Each privilige description has the following columns:

1. TABLE_CAT String => table catalog (may be null)

2. TABLE_SCHEM String => table schema (may be null)

3. TABLE_NAME String => table name

4. GRANTOR => grantor of access (may be null)

5. GRANTEE String => grantee of access

6. PRIVILEGE String => name of access (SELECT,  INSERT, UPDATE, REFRENCES, ...)

7. IS_GRANTABLE String => "YES" if grantee is permitted  to grant to others; "NO" if not; null if unknown

Parameters:

 catalog - a catalog name; "" retrieves those without a  catalog; null means drop catalog name from the selection criteria

 schemaPattern - a schema name pattern; "" retrieves those  without a schema

 tableNamePattern - a table name pattern

Returns:

 ResultSet - each row is a table privilege description

Throws: SQLException

 if a database-access error occurs.

See Also:

getSearchStringEscape

 getBestRowIdentifier

  public abstract ResultSet getBestRowIdentifier(String catalog,
                                                 String schema,
                                                 String table,
                                                 int scope,
                                                 boolean nullable) throws SQLException

 Get a description of a table's optimal set of columns that  uniquely identifies a row. They are ordered by SCOPE.

Each column description has the following columns:

1. SCOPE short => actual scope of result

•  bestRowTemporary - very temporary, while using row

•  bestRowTransaction - valid for remainder of current transaction

•  bestRowSession - valid for remainder of current session

2. COLUMN_NAME String => column name

3. DATA_TYPE short => SQL data type from java.sql.Types

4. TYPE_NAME String => Data source dependent type name

5. COLUMN_SIZE int => precision

6. BUFFER_LENGTH int => not used

7. DECIMAL_DIGITS short	=> scale

8. PSEUDO_COLUMN short => is this a pseudo column  like an Oracle ROWID

•  bestRowUnknown - may or may not be pseudo column

•  bestRowNotPseudo - is NOT a pseudo column

•  bestRowPseudo - is a pseudo column

Parameters:

 catalog - a catalog name; "" retrieves those without a  catalog; null means drop catalog name from the selection criteria

 schema - a schema name; "" retrieves those without a schema

 table - a table name

 scope - the scope of interest; use same values as SCOPE

 nullable - include columns that are nullable?

Returns:

 ResultSet - each row is a column description

Throws: SQLException

 if a database-access error occurs.

 getVersionColumns

  public abstract ResultSet getVersionColumns(String catalog,
                                              String schema,
                                              String table) throws SQLException

 Get a description of a table's columns that are automatically  updated when any value in a row is updated. They are  unordered.

Each column description has the following columns:

1. SCOPE short => is not used

2. COLUMN_NAME String => column name

3. DATA_TYPE short => SQL data type from java.sql.Types

4. TYPE_NAME String => Data source dependent type name

5. COLUMN_SIZE int => precision

6. BUFFER_LENGTH int => length of column value in bytes

7. DECIMAL_DIGITS short	=> scale

8. PSEUDO_COLUMN short => is this a pseudo column  like an Oracle ROWID

•  versionColumnUnknown - may or may not be pseudo column

•  versionColumnNotPseudo - is NOT a pseudo column

•  versionColumnPseudo - is a pseudo column

Parameters:

 catalog - a catalog name; "" retrieves those without a  catalog; null means drop catalog name from the selection criteria

 schema - a schema name; "" retrieves those without a schema

 table - a table name

Returns:

 ResultSet - each row is a column description

Throws: SQLException

 if a database-access error occurs.

 getPrimaryKeys

  public abstract ResultSet getPrimaryKeys(String catalog,
                                           String schema,
                                           String table) throws SQLException

 Get a description of a table's primary key columns. They  are ordered by COLUMN_NAME.

Each primary key column description has the following columns:

1. TABLE_CAT String => table catalog (may be null)

2. TABLE_SCHEM String => table schema (may be null)

3. TABLE_NAME String => table name

4. COLUMN_NAME String => column name

5. KEY_SEQ short => sequence number within primary key

6. PK_NAME String => primary key name (may be null)

Parameters:

 catalog - a catalog name; "" retrieves those without a  catalog; null means drop catalog name from the selection criteria

 schema - a schema name pattern; "" retrieves those  without a schema

 table - a table name

Returns:

 ResultSet - each row is a primary key column description

Throws: SQLException

 if a database-access error occurs.

 getImportedKeys

  public abstract ResultSet getImportedKeys(String catalog,
                                            String schema,
                                            String table) throws SQLException

 Get a description of the primary key columns that are  referenced by a table's foreign key columns (the primary keys  imported by a table). They are ordered by PKTABLE_CAT,  PKTABLE_SCHEM, PKTABLE_NAME, and KEY_SEQ.

Each primary key column description has the following columns:

1. PKTABLE_CAT String => primary key table catalog  being imported (may be null)

2. PKTABLE_SCHEM String => primary key table schema  being imported (may be null)

3. PKTABLE_NAME String => primary key table name  being imported

4. PKCOLUMN_NAME String => primary key column name  being imported

5. FKTABLE_CAT String => foreign key table catalog (may be null)

6. FKTABLE_SCHEM String => foreign key table schema (may be null)

7. FKTABLE_NAME String => foreign key table name

8. FKCOLUMN_NAME String => foreign key column name

9. KEY_SEQ short => sequence number within foreign key

10. UPDATE_RULE short => What happens to  foreign key when primary is updated:

•  importedNoAction - do not allow update of primary  key if it has been imported

•  importedKeyCascade - change imported key to agree  with primary key update

•  importedKeySetNull - change imported key to NULL if  its primary key has been updated

•  importedKeySetDefault - change imported key to default values  if its primary key has been updated

•  importedKeyRestrict - same as importedKeyNoAction  (for ODBC 2.x compatibility)

11. DELETE_RULE short => What happens to  the foreign key when primary is deleted.

•  importedKeyNoAction - do not allow delete of primary  key if it has been imported

•  importedKeyCascade - delete rows that import a deleted key

•  importedKeySetNull - change imported key to NULL if  its primary key has been deleted

•  importedKeyRestrict - same as importedKeyNoAction  (for ODBC 2.x compatibility)

•  importedKeySetDefault - change imported key to default if  its primary key has been deleted

12. FK_NAME String => foreign key name (may be null)

13. PK_NAME String => primary key name (may be null)

14. DEFERRABILITY short => can the evaluation of foreign key  constraints be deferred until commit

•  importedKeyInitiallyDeferred - see SQL92 for definition

•  importedKeyInitiallyImmediate - see SQL92 for definition

•  importedKeyNotDeferrable - see SQL92 for definition

Parameters:

 catalog - a catalog name; "" retrieves those without a  catalog; null means drop catalog name from the selection criteria

 schema - a schema name pattern; "" retrieves those  without a schema

 table - a table name

Returns:

 ResultSet - each row is a primary key column description

Throws: SQLException

 if a database-access error occurs.

See Also:

getExportedKeys

 getExportedKeys

  public abstract ResultSet getExportedKeys(String catalog,
                                            String schema,
                                            String table) throws SQLException

 Get a description of the foreign key columns that reference a  table's primary key columns (the foreign keys exported by a  table). They are ordered by FKTABLE_CAT, FKTABLE_SCHEM,  FKTABLE_NAME, and KEY_SEQ.

Each foreign key column description has the following columns:

1. PKTABLE_CAT String => primary key table catalog (may be null)

2. PKTABLE_SCHEM String => primary key table schema (may be null)

3. PKTABLE_NAME String => primary key table name

4. PKCOLUMN_NAME String => primary key column name

5. FKTABLE_CAT String => foreign key table catalog (may be null)  being exported (may be null)

6. FKTABLE_SCHEM String => foreign key table schema (may be null)  being exported (may be null)

7. FKTABLE_NAME String => foreign key table name  being exported

8. FKCOLUMN_NAME String => foreign key column name  being exported

9. KEY_SEQ short => sequence number within foreign key

10. UPDATE_RULE short => What happens to  foreign key when primary is updated:

•  importedNoAction - do not allow update of primary  key if it has been imported

•  importedKeyCascade - change imported key to agree  with primary key update

•  importedKeySetNull - change imported key to NULL if  its primary key has been updated

•  importedKeySetDefault - change imported key to default values  if its primary key has been updated

•  importedKeyRestrict - same as importedKeyNoAction  (for ODBC 2.x compatibility)

11. DELETE_RULE short => What happens to  the foreign key when primary is deleted.

•  importedKeyNoAction - do not allow delete of primary  key if it has been imported

•  importedKeyCascade - delete rows that import a deleted key

•  importedKeySetNull - change imported key to NULL if  its primary key has been deleted

•  importedKeyRestrict - same as importedKeyNoAction  (for ODBC 2.x compatibility)

•  importedKeySetDefault - change imported key to default if  its primary key has been deleted

12. FK_NAME String => foreign key name (may be null)

13. PK_NAME String => primary key name (may be null)

14. DEFERRABILITY short => can the evaluation of foreign key  constraints be deferred until commit

•  importedKeyInitiallyDeferred - see SQL92 for definition

•  importedKeyInitiallyImmediate - see SQL92 for definition

•  importedKeyNotDeferrable - see SQL92 for definition

Parameters:

 catalog - a catalog name; "" retrieves those without a  catalog; null means drop catalog name from the selection criteria

 schema - a schema name pattern; "" retrieves those  without a schema

 table - a table name

Returns:

 ResultSet - each row is a foreign key column description

Throws: SQLException

 if a database-access error occurs.

See Also:

getImportedKeys

 getCrossReference

  public abstract ResultSet getCrossReference(String primaryCatalog,
                                              String primarySchema,
                                              String primaryTable,
                                              String foreignCatalog,
                                              String foreignSchema,
                                              String foreignTable) throws SQLException

 Get a description of the foreign key columns in the foreign key  table that reference the primary key columns of the primary key  table (describe how one table imports another's key.) This  should normally return a single foreign key/primary key pair  (most tables only import a foreign key from a table once.) They  are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and  KEY_SEQ.

Each foreign key column description has the following columns:

1. PKTABLE_CAT String => primary key table catalog (may be null)

2. PKTABLE_SCHEM String => primary key table schema (may be null)

3. PKTABLE_NAME String => primary key table name

4. PKCOLUMN_NAME String => primary key column name

5. FKTABLE_CAT String => foreign key table catalog (may be null)  being exported (may be null)

6. FKTABLE_SCHEM String => foreign key table schema (may be null)  being exported (may be null)

7. FKTABLE_NAME String => foreign key table name  being exported

8. FKCOLUMN_NAME String => foreign key column name  being exported

9. KEY_SEQ short => sequence number within foreign key

10. UPDATE_RULE short => What happens to  foreign key when primary is updated:

•  importedNoAction - do not allow update of primary  key if it has been imported

•  importedKeyCascade - change imported key to agree  with primary key update

•  importedKeySetNull - change imported key to NULL if  its primary key has been updated

•  importedKeySetDefault - change imported key to default values  if its primary key has been updated

•  importedKeyRestrict - same as importedKeyNoAction  (for ODBC 2.x compatibility)

11. DELETE_RULE short => What happens to  the foreign key when primary is deleted.

•  importedKeyNoAction - do not allow delete of primary  key if it has been imported

•  importedKeyCascade - delete rows that import a deleted key

•  importedKeySetNull - change imported key to NULL if  its primary key has been deleted

•  importedKeyRestrict - same as importedKeyNoAction  (for ODBC 2.x compatibility)

•  importedKeySetDefault - change imported key to default if  its primary key has been deleted

12. FK_NAME String => foreign key name (may be null)

13. PK_NAME String => primary key name (may be null)

14. DEFERRABILITY short => can the evaluation of foreign key  constraints be deferred until commit

•  importedKeyInitiallyDeferred - see SQL92 for definition

•  importedKeyInitiallyImmediate - see SQL92 for definition

•  importedKeyNotDeferrable - see SQL92 for definition

Parameters:

 primaryCatalog - a catalog name; "" retrieves those without a  catalog; null means drop catalog name from the selection criteria

 primarySchema - a schema name pattern; "" retrieves those  without a schema

 primaryTable - the table name that exports the key

 foreignCatalog - a catalog name; "" retrieves those without a  catalog; null means drop catalog name from the selection criteria

 foreignSchema - a schema name pattern; "" retrieves those  without a schema

 foreignTable - the table name that imports the key

Returns:

 ResultSet - each row is a foreign key column description

Throws: SQLException

 if a database-access error occurs.

See Also:

getImportedKeys

 getTypeInfo

  public abstract ResultSet getTypeInfo() throws SQLException

 Get a description of all the standard SQL types supported by  this database. They are ordered by DATA_TYPE and then by how  closely the data type maps to the corresponding JDBC SQL type.

Each type description has the following columns:

1. TYPE_NAME String => Type name

2. DATA_TYPE short => SQL data type from java.sql.Types

3. PRECISION int => maximum precision

4. LITERAL_PREFIX String => prefix used to quote a literal  (may be null)

5. LITERAL_SUFFIX String => suffix used to quote a literal (may be null)

6. CREATE_PARAMS String => parameters used in creating  the type (may be null)

7. NULLABLE short => can you use NULL for this type?

•  typeNoNulls - does not allow NULL values

•  typeNullable - allows NULL values

•  typeNullableUnknown - nullability unknown

8. CASE_SENSITIVE boolean=> is it case sensitive?

9. SEARCHABLE short => can you use "WHERE" based on this type:

•  typePredNone - No support

•  typePredChar - Only supported with WHERE .. LIKE

•  typePredBasic - Supported except for WHERE .. LIKE

•  typeSearchable - Supported for all WHERE ..

10. UNSIGNED_ATTRIBUTE boolean => is it unsigned?

11. FIXED_PREC_SCALE boolean => can it be a money value?

12. AUTO_INCREMENT boolean => can it be used for an  auto-increment value?

13. LOCAL_TYPE_NAME String => localized version of type name  (may be null)

14. MINIMUM_SCALE short => minimum scale supported

15. MAXIMUM_SCALE short => maximum scale supported

16. SQL_DATA_TYPE int => unused

17. SQL_DATETIME_SUB int => unused

18. NUM_PREC_RADIX int => usually 2 or 10

Returns:

 ResultSet - each row is a SQL type description

Throws: SQLException

 if a database-access error occurs.

 getIndexInfo

  public abstract ResultSet getIndexInfo(String catalog,
                                         String schema,
                                         String table,
                                         boolean unique,
                                         boolean approximate) throws SQLException

 Get a description of a table's indices and statistics. They are  ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION.

Each index column description has the following columns:

1. TABLE_CAT String => table catalog (may be null)

2. TABLE_SCHEM String => table schema (may be null)

3. TABLE_NAME String => table name

4. NON_UNIQUE boolean => Can index values be non-unique?  false when TYPE is tableIndexStatistic

5. INDEX_QUALIFIER String => index catalog (may be null);  null when TYPE is tableIndexStatistic

6. INDEX_NAME String => index name; null when TYPE is  tableIndexStatistic

7. TYPE short => index type:

•  tableIndexStatistic - this identifies table statistics that are  returned in conjuction with a table's index descriptions

•  tableIndexClustered - this is a clustered index

•  tableIndexHashed - this is a hashed index

•  tableIndexOther - this is some other style of index

8. ORDINAL_POSITION short => column sequence number  within index; zero when TYPE is tableIndexStatistic

9. COLUMN_NAME String => column name; null when TYPE is  tableIndexStatistic

10. ASC_OR_DESC String => column sort sequence, "A" => ascending,  "D" => descending, may be null if sort sequence is not supported;  null when TYPE is tableIndexStatistic

11. CARDINALITY int => When TYPE is tableIndexStatistic, then  this is the number of rows in the table; otherwise, it is the  number of unique values in the index.

12. PAGES int => When TYPE is tableIndexStatisic then  this is the number of pages used for the table, otherwise it  is the number of pages used for the current index.

13. FILTER_CONDITION String => Filter condition, if any.  (may be null)

Parameters:

 catalog - a catalog name; "" retrieves those without a  catalog; null means drop catalog name from the selection criteria

 schema - a schema name pattern; "" retrieves those without a schema

 table - a table name

 unique - when true, return only indices for unique values;  when false, return indices regardless of whether unique or not

 approximate - when true, result is allowed to reflect approximate  or out of data values; when false, results are requested to be  accurate

Returns:

 ResultSet - each row is an index column description

Throws: SQLException

 if a database-access error occurs.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.sql.DataTruncation

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.sql.DataTruncation

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.sql.SQLException
                           |
                           +----java.sql.SQLWarning
                                   |
                                   +----java.sql.DataTruncation

______________________________________________________________________________

 public class DataTruncation

 extends SQLWarning

When JDBC unexpectedly truncates a data value, it reports a  DataTruncation warning (on reads) or throws a DataTruncation exception  (on writes).

The SQLstate for a DataTruncation is "01004".

______________________________________________________________________________

 	DataTruncation(int, boolean, boolean, int, int)

Create a DataTruncation object.

 	getDataSize()

 Get the number of bytes of data that should have been transferred.

 	getIndex()

 Get the index of the column or parameter that was truncated.

 	getParameter()

 Is this a truncated parameter value?

 	getRead()

 Was this a read truncation?

 	getTransferSize()

 Get the number of bytes of data actually transferred.

 DataTruncation

  public DataTruncation(int index,
                        boolean parameter,
                        boolean read,
                        int dataSize,
                        int transferSize)

Create a DataTruncation object. The SQLState is initialized  to 01004, the reason is set to "Data truncation" and the  vendorCode is set to the SQLException default.

Parameters:

 index - The index of the parameter or column value

 parameter - true if a parameter value was truncated

 read - true if a read was truncated

 dataSize - the original size of the data

 transferSize - the size after truncation

 getIndex

  public int getIndex()

 Get the index of the column or parameter that was truncated.

This may be -1 if the column or parameter index is unknown, in  which case the "parameter" and "read" fields should be ignored.

Returns:

 the index of the truncated paramter or column value.

 getParameter

  public boolean getParameter()

 Is this a truncated parameter value?

Returns:

 True if the value was a parameter; false if it was a column value.

 getRead

  public boolean getRead()

 Was this a read truncation?

Returns:

 True if the value was truncated when read from the database; false  if the data was truncated on a write.

 getDataSize

  public int getDataSize()

 Get the number of bytes of data that should have been transferred.  This number may be approximate if data conversions were being  performed. The value may be "-1" if the size is unknown.

Returns:

 the number of bytes of data that should have been transferred

 getTransferSize

  public int getTransferSize()

 Get the number of bytes of data actually transferred.  The value may be "-1" if the size is unknown.

Returns:

 the number of bytes of data actually transferred

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.sql.Date

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.sql.Date

java.lang.Object
   |
   +----java.util.Date
           |
           +----java.sql.Date

______________________________________________________________________________

 public class Date

 extends Date

This class is a thin wrapper around java.util.Date that allows  JDBC to identify this as a SQL DATE value. It adds formatting and  parsing operations to support the JDBC escape syntax for date  values.

______________________________________________________________________________

 	Date(int, int, int)

 Construct a Date

 	Date(long)

 Construct a Date using a milliseconds time value

 	getHours()

 Returns the hour represented by this date.

 	getMinutes()

 Returns the number of minutes past the hour represented by this date.

 	getSeconds()

 Returns the number of seconds past the minute represented by this date.

 	setHours(int)

 Sets the hour of this date to the specified value.

 	setMinutes(int)

 Sets the minutes of this date to the specified value.

 	setSeconds(int)

 Sets the seconds of this date to the specified value.

 	setTime(long)

 Set a Date using a milliseconds time value

 	toString()

 Format a date in JDBC date escape format

 	valueOf(String)

 Convert a string in JDBC date escape format to a Date value

 Date

  public Date(int year,
              int month,
              int day)

 Construct a Date

Parameters:

 year - year-1900

 month - 0 to 11

 day - 1 to 31

 Date

  public Date(long date)

 Construct a Date using a milliseconds time value

Parameters:

 date - milliseconds since January 1, 1970, 00:00:00 GMT

 setTime

  public void setTime(long date)

 Set a Date using a milliseconds time value

Parameters:

 date - milliseconds since January 1, 1970, 00:00:00 GMT

Overrides:

setTime in class Date

 valueOf

  public static Date valueOf(String s)

 Convert a string in JDBC date escape format to a Date value

Parameters:

 s - date in format "yyyy-mm-dd"

Returns:

 corresponding Date

 toString

  public String toString()

 Format a date in JDBC date escape format

Returns:

 a String in yyyy-mm-dd format

Overrides:

toString in class Date

 getHours

  public int getHours()

 Returns the hour represented by this date.

Overrides:

getHours in class Date

 getMinutes

  public int getMinutes()

 Returns the number of minutes past the hour represented by this date.

Overrides:

getMinutes in class Date

 getSeconds

  public int getSeconds()

 Returns the number of seconds past the minute represented by this date.

Overrides:

getSeconds in class Date

 setHours

  public void setHours(int i)

 Sets the hour of this date to the specified value.

Overrides:

setHours in class Date

 setMinutes

  public void setMinutes(int i)

 Sets the minutes of this date to the specified value.

Overrides:

setMinutes in class Date

 setSeconds

  public void setSeconds(int i)

 Sets the seconds of this date to the specified value.

Overrides:

setSeconds in class Date

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.sql.Driver

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.sql.Driver

 public interface Driver

The Java SQL framework allows for multiple database drivers.

Each driver should supply a class that implements  the Driver interface.

The DriverManager will try to load as many drivers as it can  find and then for any given connection request, it will ask each  driver in turn to try to connect to the target URL.

It is strongly recommended that each Driver class should be  small and standalone so that the Driver class can be loaded and  queried without bringing in vast quantities of supporting code.

When a Driver class is loaded, it should create an instance of  itself and register it with the DriverManager. This means that a  user can load and register a driver by doing  Class.forName("foo.bah.Driver").

See Also:

DriverManager, Connection

______________________________________________________________________________

 	acceptsURL(String)

 Returns true if the driver thinks that it can open a connection  to the given URL.

 	connect(String, Properties)

 Try to make a database connection to the given URL.

 	getMajorVersion()

 Get the driver's major version number.

 	getMinorVersion()

 Get the driver's minor version number.

 	getPropertyInfo(String, Properties)

The getPropertyInfo method is intended to allow a generic GUI tool to  discover what properties it should prompt a human for in order to get  enough information to connect to a database.

 	jdbcCompliant()

 Report whether the Driver is a genuine JDBC COMPLIANT (tm) driver.

 connect

  public abstract Connection connect(String url,
                                     Properties info) throws SQLException

 Try to make a database connection to the given URL.  The driver should return "null" if it realizes it is the wrong kind  of driver to connect to the given URL. This will be common, as when  the JDBC driver manager is asked to connect to a given URL it passes  the URL to each loaded driver in turn.

The driver should raise a SQLException if it is the right  driver to connect to the given URL, but has trouble connecting to  the database.

The java.util.Properties argument can be used to passed arbitrary  string tag/value pairs as connection arguments.  Normally at least "user" and "password" properties should be  included in the Properties.

Parameters:

 url - The URL of the database to connect to

 info - a list of arbitrary string tag/value pairs as  connection arguments; normally at least a "user" and  "password" property should be included

Returns:

 a Connection to the URL

Throws: SQLException

 if a database-access error occurs.

 acceptsURL

  public abstract boolean acceptsURL(String url) throws SQLException

 Returns true if the driver thinks that it can open a connection  to the given URL. Typically drivers will return true if they  understand the subprotocol specified in the URL and false if  they don't.

Parameters:

 url - The URL of the database.

Returns:

 True if this driver can connect to the given URL.

Throws: SQLException

 if a database-access error occurs.

 getPropertyInfo

  public abstract DriverPropertyInfo[] getPropertyInfo(String url,
                                                       Properties info) throws SQLException

The getPropertyInfo method is intended to allow a generic GUI tool to  discover what properties it should prompt a human for in order to get  enough information to connect to a database. Note that depending on  the values the human has supplied so far, additional values may become  necessary, so it may be necessary to iterate though several calls  to getPropertyInfo.

Parameters:

 url - The URL of the database to connect to.

 info - A proposed list of tag/value pairs that will be sent on  connect open.

Returns:

 An array of DriverPropertyInfo objects describing possible  properties. This array may be an empty array if no properties  are required.

Throws: SQLException

 if a database-access error occurs.

 getMajorVersion

  public abstract int getMajorVersion()

 Get the driver's major version number. Initially this should be 1.

 getMinorVersion

  public abstract int getMinorVersion()

 Get the driver's minor version number. Initially this should be 0.

 jdbcCompliant

  public abstract boolean jdbcCompliant()

 Report whether the Driver is a genuine JDBC COMPLIANT (tm) driver.  A driver may only report "true" here if it passes the JDBC compliance  tests, otherwise it is required to return false.  JDBC compliance requires full support for the JDBC API and full support  for SQL 92 Entry Level. It is expected that JDBC compliant drivers will  be available for all the major commercial databases.  This method is not intended to encourage the development of non-JDBC  compliant drivers, but is a recognition of the fact that some vendors  are interested in using the JDBC API and framework for lightweight  databases that do not support full database functionality, or for  special databases such as document information retrieval where a SQL  implementation may not be feasible.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.sql.DriverManager

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.sql.DriverManager

java.lang.Object
   |
   +----java.sql.DriverManager

______________________________________________________________________________

 public class DriverManager

 extends Object

The DriverManager provides a basic service for managing a set of  JDBC drivers.

As part of its initialization, the DriverManager class will  attempt to load the driver classes referenced in the "jdbc.drivers"  system property. This allows a user to customize the JDBC Drivers  used by their applications. For example in your  ~/.hotjava/properties file you might specify:  jdbc.drivers=foo.bah.Driver:wombat.sql.Driver:bad.taste.ourDriver  A program can also explicitly load JDBC drivers at any time. For  example, the my.sql.Driver is loaded with the following statement:  Class.forName("my.sql.Driver");

When getConnection is called the DriverManager will attempt to  locate a suitable driver from amongst those loaded at  initialization and those loaded explicitly using the same classloader  as the current applet or application.

See Also:

Driver, Connection

______________________________________________________________________________

 	deregisterDriver(Driver)

 Drop a Driver from the DriverManager's list.

 	getConnection(String)

 Attempt to establish a connection to the given database URL.

 	getConnection(String, Properties)

 Attempt to establish a connection to the given database URL.

 	getConnection(String, String, String)

 Attempt to establish a connection to the given database URL.

 	getDriver(String)

 Attempt to locate a driver that understands the given URL.

 	getDrivers()

 Return an Enumeration of all the currently loaded JDBC drivers  which the current caller has access to.

 	getLoginTimeout()

 Get the maximum time in seconds that all drivers can wait  when attempting to log in to a database.

 	getLogStream()

 Get the logging/tracing PrintStream that is used by the DriverManager  and all drivers.

 	println(String)

 Print a message to the current JDBC log stream

 	registerDriver(Driver)

 A newly loaded driver class should call registerDriver to make itself  known to the DriverManager.

 	setLoginTimeout(int)

 Set the maximum time in seconds that all drivers can wait  when attempting to log in to a database.

 	setLogStream(PrintStream)

 Set the logging/tracing PrintStream that is used by the DriverManager  and all drivers.

 getConnection

  public static synchronized Connection getConnection(String url,
                                                      Properties info) throws SQLException

 Attempt to establish a connection to the given database URL.  The DriverManager attempts to select an appropriate driver from  the set of registered JDBC drivers.

Parameters:

 url - a database url of the form jdbc:subprotocol:subname

 info - a list of arbitrary string tag/value pairs as  connection arguments; normally at least a "user" and  "password" property should be included

Returns:

 a Connection to the URL

Throws: SQLException

 if a database-access error occurs.

 getConnection

  public static synchronized Connection getConnection(String url,
                                                      String user,
                                                      String password) throws SQLException

 Attempt to establish a connection to the given database URL.  The DriverManager attempts to select an appropriate driver from  the set of registered JDBC drivers.

Parameters:

 url - a database url of the form jdbc:subprotocol:subname

 user - the database user on whose behalf the Connection is being made

 password - the user's password

Returns:

 a Connection to the URL

Throws: SQLException

 if a database-access error occurs.

 getConnection

  public static synchronized Connection getConnection(String url) throws SQLException

 Attempt to establish a connection to the given database URL.  The DriverManager attempts to select an appropriate driver from  the set of registered JDBC drivers.

Parameters:

 url - a database url of the form jdbc:subprotocol:subname

Returns:

 a Connection to the URL

Throws: SQLException

 if a database-access error occurs.

 getDriver

  public static Driver getDriver(String url) throws SQLException

 Attempt to locate a driver that understands the given URL.  The DriverManager attempts to select an appropriate driver from  the set of registered JDBC drivers.

Parameters:

 url - a database url of the form jdbc:subprotocol:subname

Returns:

 a Driver that can connect to the URL

Throws: SQLException

 if a database-access error occurs.

 registerDriver

  public static synchronized void registerDriver(Driver driver) throws SQLException

 A newly loaded driver class should call registerDriver to make itself  known to the DriverManager.

Parameters:

 driver - the new JDBC Driver

Throws: SQLException

 if a database-access error occurs.

 deregisterDriver

  public static void deregisterDriver(Driver driver) throws SQLException

 Drop a Driver from the DriverManager's list. Applets can only  deregister Drivers from their own classloader.

Parameters:

 driver - the JDBC Driver to drop

Throws: SQLException

 if a database-access error occurs.

 getDrivers

  public static Enumeration getDrivers()

 Return an Enumeration of all the currently loaded JDBC drivers  which the current caller has access to.

Note: The classname of a driver can be found using  d.getClass().getName()

Returns:

 the list of JDBC Drivers loaded by the caller's class loader

 setLoginTimeout

  public static void setLoginTimeout(int seconds)

 Set the maximum time in seconds that all drivers can wait  when attempting to log in to a database.

Parameters:

 seconds - the driver login time limit

 getLoginTimeout

  public static int getLoginTimeout()

 Get the maximum time in seconds that all drivers can wait  when attempting to log in to a database.

Returns:

 the driver login time limit

 setLogStream

  public static void setLogStream(PrintStream out)

 Set the logging/tracing PrintStream that is used by the DriverManager  and all drivers.

Parameters:

 out - the new logging/tracing PrintStream; to disable, set to null

 getLogStream

  public static PrintStream getLogStream()

 Get the logging/tracing PrintStream that is used by the DriverManager  and all drivers.

Returns:

 the logging/tracing PrintStream; if disabled, is null

 println

  public static void println(String message)

 Print a message to the current JDBC log stream

Parameters:

 message - a log or tracing message

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.sql.DriverPropertyInfo

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.sql.DriverPropertyInfo

java.lang.Object
   |
   +----java.sql.DriverPropertyInfo

______________________________________________________________________________

 public class DriverPropertyInfo

 extends Object

The DriverPropertyInfo class is only of interest to advanced programmers  who need to interact with a Driver via getDriverProperties to discover  and supply properties for connections.

______________________________________________________________________________

 	choices

 If the value may be selected from a particular set of values,  then this is an array of the possible values.

 	description

 A brief description of the property.

 	name

 The name of the property.

 	required

 "required" is true if a value must be supplied for this property  during Driver.connect.

 	value

 "value" specifies the current value of the property, based on a  combination of the information supplied to getPropertyInfo, the  Java environment, and driver supplied default values.

 	DriverPropertyInfo(String, String)

 Constructor a DriverPropertyInfo with a name and value; other  members default to their initial values.

 name

  public String name

 The name of the property.

 description

  public String description

 A brief description of the property. This may be null.

 required

  public boolean required

 "required" is true if a value must be supplied for this property  during Driver.connect. Otherwise the property is optional.

 value

  public String value

 "value" specifies the current value of the property, based on a  combination of the information supplied to getPropertyInfo, the  Java environment, and driver supplied default values. This  may be null if no value is known.

 choices

  public String choices[]

 If the value may be selected from a particular set of values,  then this is an array of the possible values. Otherwise it should  be null.

 DriverPropertyInfo

  public DriverPropertyInfo(String name,
                            String value)

 Constructor a DriverPropertyInfo with a name and value; other  members default to their initial values.

Parameters:

 name - the name of the property

 value - the current value, which may be null

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.sql.PreparedStatement

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.sql.PreparedStatement

 public interface PreparedStatement

 extends Statement

A SQL statement is pre-compiled and stored in a  PreparedStatement object. This object can then be used to  efficiently execute this statement multiple times.

Note: The setXXX methods for setting IN parameter values  must specify types that are compatible with the defined SQL type of  the input parameter. For instance, if the IN parameter has SQL type  Integer then setInt should be used.

If arbitrary parameter type conversions are required then the  setObject method should be used with a target SQL type.

See Also:

prepareStatement, ResultSet

______________________________________________________________________________

 	clearParameters()

In general, parameter values remain in force for repeated use of a  Statement.

 	execute()

 Some prepared statements return multiple results; the execute  method handles these complex statements as well as the simpler  form of statements handled by executeQuery and executeUpdate.

 	executeQuery()

 A prepared SQL query is executed and its ResultSet is returned.

 	executeUpdate()

 Execute a SQL INSERT, UPDATE or DELETE statement.

 	setAsciiStream(int, InputStream, int)

 When a very large ASCII value is input to a LONGVARCHAR  parameter, it may be more practical to send it via a  java.io.InputStream.

 	setBigDecimal(int, BigDecimal)

 Set a parameter to a java.lang.BigDecimal value.

 	setBinaryStream(int, InputStream, int)

 When a very large binary value is input to a LONGVARBINARY  parameter, it may be more practical to send it via a  java.io.InputStream.

 	setBoolean(int, boolean)

 Set a parameter to a Java boolean value.

 	setByte(int, byte)

 Set a parameter to a Java byte value.

 	setBytes(int, byte[])

 Set a parameter to a Java array of bytes.

 	setDate(int, Date)

 Set a parameter to a java.sql.Date value.

 	setDouble(int, double)

 Set a parameter to a Java double value.

 	setFloat(int, float)

 Set a parameter to a Java float value.

 	setInt(int, int)

 Set a parameter to a Java int value.

 	setLong(int, long)

 Set a parameter to a Java long value.

 	setNull(int, int)

 Set a parameter to SQL NULL.

 	setObject(int, Object)

Set the value of a parameter using an object; use the  java.lang equivalent objects for integral values.

 	setObject(int, Object, int)

 This method is like setObject above, but assumes a scale of zero.

 	setObject(int, Object, int, int)

Set the value of a parameter using an object; use the  java.lang equivalent objects for integral values.

 	setShort(int, short)

 Set a parameter to a Java short value.

 	setString(int, String)

 Set a parameter to a Java String value.

 	setTime(int, Time)

 Set a parameter to a java.sql.Time value.

 	setTimestamp(int, Timestamp)

 Set a parameter to a java.sql.Timestamp value.

 	setUnicodeStream(int, InputStream, int)

 When a very large UNICODE value is input to a LONGVARCHAR  parameter, it may be more practical to send it via a  java.io.InputStream.

 executeQuery

  public abstract ResultSet executeQuery() throws SQLException

 A prepared SQL query is executed and its ResultSet is returned.

Returns:

 a ResultSet that contains the data produced by the  query; never null

Throws: SQLException

 if a database-access error occurs.

 executeUpdate

  public abstract int executeUpdate() throws SQLException

 Execute a SQL INSERT, UPDATE or DELETE statement. In addition,  SQL statements that return nothing such as SQL DDL statements  can be executed.

Returns:

 either the row count for INSERT, UPDATE or DELETE; or 0  for SQL statements that return nothing

Throws: SQLException

 if a database-access error occurs.

 setNull

  public abstract void setNull(int parameterIndex,
                               int sqlType) throws SQLException

 Set a parameter to SQL NULL.

Note: You must specify the parameter's SQL type.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

 sqlType - SQL type code defined by java.sql.Types

Throws: SQLException

 if a database-access error occurs.

 setBoolean

  public abstract void setBoolean(int parameterIndex,
                                  boolean x) throws SQLException

 Set a parameter to a Java boolean value. The driver converts this  to a SQL BIT value when it sends it to the database.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

 x - the parameter value

Throws: SQLException

 if a database-access error occurs.

 setByte

  public abstract void setByte(int parameterIndex,
                               byte x) throws SQLException

 Set a parameter to a Java byte value. The driver converts this  to a SQL TINYINT value when it sends it to the database.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

 x - the parameter value

Throws: SQLException

 if a database-access error occurs.

 setShort

  public abstract void setShort(int parameterIndex,
                                short x) throws SQLException

 Set a parameter to a Java short value. The driver converts this  to a SQL SMALLINT value when it sends it to the database.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

 x - the parameter value

Throws: SQLException

 if a database-access error occurs.

 setInt

  public abstract void setInt(int parameterIndex,
                              int x) throws SQLException

 Set a parameter to a Java int value. The driver converts this  to a SQL INTEGER value when it sends it to the database.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

 x - the parameter value

Throws: SQLException

 if a database-access error occurs.

 setLong

  public abstract void setLong(int parameterIndex,
                               long x) throws SQLException

 Set a parameter to a Java long value. The driver converts this  to a SQL BIGINT value when it sends it to the database.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

 x - the parameter value

Throws: SQLException

 if a database-access error occurs.

 setFloat

  public abstract void setFloat(int parameterIndex,
                                float x) throws SQLException

 Set a parameter to a Java float value. The driver converts this  to a SQL FLOAT value when it sends it to the database.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

 x - the parameter value

Throws: SQLException

 if a database-access error occurs.

 setDouble

  public abstract void setDouble(int parameterIndex,
                                 double x) throws SQLException

 Set a parameter to a Java double value. The driver converts this  to a SQL DOUBLE value when it sends it to the database.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

 x - the parameter value

Throws: SQLException

 if a database-access error occurs.

 setBigDecimal

  public abstract void setBigDecimal(int parameterIndex,
                                     BigDecimal x) throws SQLException

 Set a parameter to a java.lang.BigDecimal value.  The driver converts this to a SQL NUMERIC value when  it sends it to the database.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

 x - the parameter value

Throws: SQLException

 if a database-access error occurs.

 setString

  public abstract void setString(int parameterIndex,
                                 String x) throws SQLException

 Set a parameter to a Java String value. The driver converts this  to a SQL VARCHAR or LONGVARCHAR value (depending on the arguments  size relative to the driver's limits on VARCHARs) when it sends  it to the database.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

 x - the parameter value

Throws: SQLException

 if a database-access error occurs.

 setBytes

  public abstract void setBytes(int parameterIndex,
                                byte x[]) throws SQLException

 Set a parameter to a Java array of bytes. The driver converts  this to a SQL VARBINARY or LONGVARBINARY (depending on the  argument's size relative to the driver's limits on VARBINARYs)  when it sends it to the database.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

 x - the parameter value

Throws: SQLException

 if a database-access error occurs.

 setDate

  public abstract void setDate(int parameterIndex,
                               Date x) throws SQLException

 Set a parameter to a java.sql.Date value. The driver converts this  to a SQL DATE value when it sends it to the database.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

 x - the parameter value

Throws: SQLException

 if a database-access error occurs.

 setTime

  public abstract void setTime(int parameterIndex,
                               Time x) throws SQLException

 Set a parameter to a java.sql.Time value. The driver converts this  to a SQL TIME value when it sends it to the database.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

 x - the parameter value

Throws: SQLException

 if a database-access error occurs.

 setTimestamp

  public abstract void setTimestamp(int parameterIndex,
                                    Timestamp x) throws SQLException

 Set a parameter to a java.sql.Timestamp value. The driver  converts this to a SQL TIMESTAMP value when it sends it to the  database.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

 x - the parameter value

Throws: SQLException

 if a database-access error occurs.

 setAsciiStream

  public abstract void setAsciiStream(int parameterIndex,
                                      InputStream x,
                                      int length) throws SQLException

 When a very large ASCII value is input to a LONGVARCHAR  parameter, it may be more practical to send it via a  java.io.InputStream. JDBC will read the data from the stream  as needed, until it reaches end-of-file. The JDBC driver will  do any necessary conversion from ASCII to the database char format.

Note: This stream object can either be a standard  Java stream object or your own subclass that implements the  standard interface.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

 x - the java input stream which contains the ASCII parameter value

 length - the number of bytes in the stream

Throws: SQLException

 if a database-access error occurs.

 setUnicodeStream

  public abstract void setUnicodeStream(int parameterIndex,
                                        InputStream x,
                                        int length) throws SQLException

 When a very large UNICODE value is input to a LONGVARCHAR  parameter, it may be more practical to send it via a  java.io.InputStream. JDBC will read the data from the stream  as needed, until it reaches end-of-file. The JDBC driver will  do any necessary conversion from UNICODE to the database char format.

Note: This stream object can either be a standard  Java stream object or your own subclass that implements the  standard interface.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

 x - the java input stream which contains the  UNICODE parameter value

 length - the number of bytes in the stream

Throws: SQLException

 if a database-access error occurs.

 setBinaryStream

  public abstract void setBinaryStream(int parameterIndex,
                                       InputStream x,
                                       int length) throws SQLException

 When a very large binary value is input to a LONGVARBINARY  parameter, it may be more practical to send it via a  java.io.InputStream. JDBC will read the data from the stream  as needed, until it reaches end-of-file.

Note: This stream object can either be a standard  Java stream object or your own subclass that implements the  standard interface.

Parameters:

 parameterIndex - the first parameter is 1, the second is 2, ...

 x - the java input stream which contains the binary parameter value

 length - the number of bytes in the stream

Throws: SQLException

 if a database-access error occurs.

 clearParameters

  public abstract void clearParameters() throws SQLException

In general, parameter values remain in force for repeated use of a  Statement. Setting a parameter value automatically clears its  previous value. However, in some cases it is useful to immediately  release the resources used by the current parameter values; this can  be done by calling clearParameters.

Throws: SQLException

 if a database-access error occurs.

 setObject

  public abstract void setObject(int parameterIndex,
                                 Object x,
                                 int targetSqlType,
                                 int scale) throws SQLException

Set the value of a parameter using an object; use the  java.lang equivalent objects for integral values.

The given Java object will be converted to the targetSqlType  before being sent to the database.

Note that this method may be used to pass datatabase-  specific abstract data types. This is done by using a Driver-  specific Java type and using a targetSqlType of  java.sql.types.OTHER.

Parameters:

 parameterIndex - The first parameter is 1, the second is 2, ...

 x - The object containing the input parameter value

 targetSqlType - The SQL type (as defined in java.sql.Types) to be  sent to the database. The scale argument may further qualify this type.

 scale - For java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types  this is the number of digits after the decimal. For all other  types this value will be ignored,

Throws: SQLException

 if a database-access error occurs.

See Also:

Types

 setObject

  public abstract void setObject(int parameterIndex,
                                 Object x,
                                 int targetSqlType) throws SQLException

 This method is like setObject above, but assumes a scale of zero.

Throws: SQLException

 if a database-access error occurs.

 setObject

  public abstract void setObject(int parameterIndex,
                                 Object x) throws SQLException

Set the value of a parameter using an object; use the  java.lang equivalent objects for integral values.

The JDBC specification specifies a standard mapping from  Java Object types to SQL types. The given argument java object  will be converted to the corresponding SQL type before being  sent to the database.

Note that this method may be used to pass datatabase  specific abstract data types, by using a Driver specific Java  type.

Parameters:

 parameterIndex - The first parameter is 1, the second is 2, ...

 x - The object containing the input parameter value

Throws: SQLException

 if a database-access error occurs.

 execute

  public abstract boolean execute() throws SQLException

 Some prepared statements return multiple results; the execute  method handles these complex statements as well as the simpler  form of statements handled by executeQuery and executeUpdate.

Throws: SQLException

 if a database-access error occurs.

See Also:

execute

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.sql.ResultSet

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.sql.ResultSet

 public interface ResultSet

A ResultSet provides access to a table of data generated by  executing a Statement. The table rows are retrieved in  sequence. Within a row its column values can be accessed in any  order.

A ResultSet maintains a cursor pointing to its current row of  data. Initially the cursor is positioned before the first row.  The 'next' method moves the cursor to the next row.

The getXXX methods retrieve column values for the current  row. You can retrieve values either using the index number of the  column, or by using the name of the column. In general using the  column index will be more efficient. Columns are numbered from 1.

For maximum portability, ResultSet columns within each row should be  read in left-to-right order and each column should be read only once.

For the getXXX methods, the JDBC driver attempts to convert the  underlying data to the specified Java type and returns a suitable  Java value. See the JDBC specification for allowable mappings  from SQL types to Java types with the ResultSet.getXXX methods.

Column names used as input to getXXX methods are case  insensitive. When performing a getXXX using a column name, if  several columns have the same name, then the value of the first  matching column will be returned. The column name option is  designed to be used when column names are used in the SQL  query. For columns that are NOT explicitly named in the query, it  is best to use column numbers. If column names were used there is  no way for the programmer to guarantee that they actually refer to  the intended columns.

A ResultSet is automatically closed by the Statement that  generated it when that Statement is closed, re-executed, or is used  to retrieve the next result from a sequence of multiple results.

The number, types and properties of a ResultSet's columns are  provided by the ResulSetMetaData object returned by the getMetaData  method.

See Also:

executeQuery, getResultSet, ResultSetMetaData

______________________________________________________________________________

 	clearWarnings()

 After this call getWarnings returns null until a new warning is  reported for this ResultSet.

 	close()

 In some cases, it is desirable to immediately release a  ResultSet's database and JDBC resources instead of waiting for  this to happen when it is automatically closed; the close  method provides this immediate release.

 	findColumn(String)

 Map a Resultset column name to a ResultSet column index.

 	getAsciiStream(int)

 A column value can be retrieved as a stream of ASCII characters  and then read in chunks from the stream.

 	getAsciiStream(String)

 A column value can be retrieved as a stream of ASCII characters  and then read in chunks from the stream.

 	getBigDecimal(int, int)

 Get the value of a column in the current row as a java.lang.BigDecimal object.

 	getBigDecimal(String, int)

 Get the value of a column in the current row as a java.lang.BigDecimal object.

 	getBinaryStream(int)

 A column value can be retrieved as a stream of uninterpreted bytes  and then read in chunks from the stream.

 	getBinaryStream(String)

 A column value can be retrieved as a stream of uninterpreted bytes  and then read in chunks from the stream.

 	getBoolean(int)

 Get the value of a column in the current row as a Java boolean.

 	getBoolean(String)

 Get the value of a column in the current row as a Java boolean.

 	getByte(int)

 Get the value of a column in the current row as a Java byte.

 	getByte(String)

 Get the value of a column in the current row as a Java byte.

 	getBytes(int)

 Get the value of a column in the current row as a Java byte array.

 	getBytes(String)

 Get the value of a column in the current row as a Java byte array.

 	getCursorName()

 Get the name of the SQL cursor used by this ResultSet.

 	getDate(int)

 Get the value of a column in the current row as a java.sql.Date object.

 	getDate(String)

 Get the value of a column in the current row as a java.sql.Date object.

 	getDouble(int)

 Get the value of a column in the current row as a Java double.

 	getDouble(String)

 Get the value of a column in the current row as a Java double.

 	getFloat(int)

 Get the value of a column in the current row as a Java float.

 	getFloat(String)

 Get the value of a column in the current row as a Java float.

 	getInt(int)

 Get the value of a column in the current row as a Java int.

 	getInt(String)

 Get the value of a column in the current row as a Java int.

 	getLong(int)

 Get the value of a column in the current row as a Java long.

 	getLong(String)

 Get the value of a column in the current row as a Java long.

 	getMetaData()

 The number, types and properties of a ResultSet's columns  are provided by the getMetaData method.

 	getObject(int)

Get the value of a column in the current row as a Java object.

 	getObject(String)

Get the value of a column in the current row as a Java object.

 	getShort(int)

 Get the value of a column in the current row as a Java short.

 	getShort(String)

 Get the value of a column in the current row as a Java short.

 	getString(int)

 Get the value of a column in the current row as a Java String.

 	getString(String)

 Get the value of a column in the current row as a Java String.

 	getTime(int)

 Get the value of a column in the current row as a java.sql.Time object.

 	getTime(String)

 Get the value of a column in the current row as a java.sql.Time object.

 	getTimestamp(int)

 Get the value of a column in the current row as a java.sql.Timestamp object.

 	getTimestamp(String)

 Get the value of a column in the current row as a java.sql.Timestamp object.

 	getUnicodeStream(int)

 A column value can be retrieved as a stream of Unicode characters  and then read in chunks from the stream.

 	getUnicodeStream(String)

 A column value can be retrieved as a stream of Unicode characters  and then read in chunks from the stream.

 	getWarnings()

The first warning reported by calls on this ResultSet is  returned.

 	next()

 A ResultSet is initially positioned before its first row; the  first call to next makes the first row the current row; the  second call makes the second row the current row, etc.

 	wasNull()

 A column may have the value of SQL NULL; wasNull reports whether  the last column read had this special value.

 next

  public abstract boolean next() throws SQLException

 A ResultSet is initially positioned before its first row; the  first call to next makes the first row the current row; the  second call makes the second row the current row, etc.

If an input stream from the previous row is open, it is  implicitly closed. The ResultSet's warning chain is cleared  when a new row is read.

Returns:

 true if the new current row is valid; false if there  are no more rows

Throws: SQLException

 if a database-access error occurs.

 close

  public abstract void close() throws SQLException

 In some cases, it is desirable to immediately release a  ResultSet's database and JDBC resources instead of waiting for  this to happen when it is automatically closed; the close  method provides this immediate release.

Note: A ResultSet is automatically closed by the  Statement that generated it when that Statement is closed,  re-executed, or is used to retrieve the next result from a  sequence of multiple results. A ResultSet is also automatically  closed when it is garbage collected.

Throws: SQLException

 if a database-access error occurs.

 wasNull

  public abstract boolean wasNull() throws SQLException

 A column may have the value of SQL NULL; wasNull reports whether  the last column read had this special value.  Note that you must first call getXXX on a column to try to read  its value and then call wasNull() to find if the value was  the SQL NULL.

Returns:

 true if last column read was SQL NULL

Throws: SQLException

 if a database-access error occurs.

 getString

  public abstract String getString(int columnIndex) throws SQLException

 Get the value of a column in the current row as a Java String.

Parameters:

 columnIndex - the first column is 1, the second is 2, ...

Returns:

 the column value; if the value is SQL NULL, the result is null

Throws: SQLException

 if a database-access error occurs.

 getBoolean

  public abstract boolean getBoolean(int columnIndex) throws SQLException

 Get the value of a column in the current row as a Java boolean.

Parameters:

 columnIndex - the first column is 1, the second is 2, ...

Returns:

 the column value; if the value is SQL NULL, the result is false

Throws: SQLException

 if a database-access error occurs.

 getByte

  public abstract byte getByte(int columnIndex) throws SQLException

 Get the value of a column in the current row as a Java byte.

Parameters:

 columnIndex - the first column is 1, the second is 2, ...

Returns:

 the column value; if the value is SQL NULL, the result is 0

Throws: SQLException

 if a database-access error occurs.

 getShort

  public abstract short getShort(int columnIndex) throws SQLException

 Get the value of a column in the current row as a Java short.

Parameters:

 columnIndex - the first column is 1, the second is 2, ...

Returns:

 the column value; if the value is SQL NULL, the result is 0

Throws: SQLException

 if a database-access error occurs.

 getInt

  public abstract int getInt(int columnIndex) throws SQLException

 Get the value of a column in the current row as a Java int.

Parameters:

 columnIndex - the first column is 1, the second is 2, ...

Returns:

 the column value; if the value is SQL NULL, the result is 0

Throws: SQLException

 if a database-access error occurs.

 getLong

  public abstract long getLong(int columnIndex) throws SQLException

 Get the value of a column in the current row as a Java long.

Parameters:

 columnIndex - the first column is 1, the second is 2, ...

Returns:

 the column value; if the value is SQL NULL, the result is 0

Throws: SQLException

 if a database-access error occurs.

 getFloat

  public abstract float getFloat(int columnIndex) throws SQLException

 Get the value of a column in the current row as a Java float.

Parameters:

 columnIndex - the first column is 1, the second is 2, ...

Returns:

 the column value; if the value is SQL NULL, the result is 0

Throws: SQLException

 if a database-access error occurs.

 getDouble

  public abstract double getDouble(int columnIndex) throws SQLException

 Get the value of a column in the current row as a Java double.

Parameters:

 columnIndex - the first column is 1, the second is 2, ...

Returns:

 the column value; if the value is SQL NULL, the result is 0

Throws: SQLException

 if a database-access error occurs.

 getBigDecimal

  public abstract BigDecimal getBigDecimal(int columnIndex,
                                           int scale) throws SQLException

 Get the value of a column in the current row as a java.lang.BigDecimal object.

Parameters:

 columnIndex - the first column is 1, the second is 2, ...

 scale - the number of digits to the right of the decimal

Returns:

 the column value; if the value is SQL NULL, the result is null

Throws: SQLException

 if a database-access error occurs.

 getBytes

  public abstract byte[] getBytes(int columnIndex) throws SQLException

 Get the value of a column in the current row as a Java byte array.  The bytes represent the raw values returned by the driver.

Parameters:

 columnIndex - the first column is 1, the second is 2, ...

Returns:

 the column value; if the value is SQL NULL, the result is null

Throws: SQLException

 if a database-access error occurs.

 getDate

  public abstract Date getDate(int columnIndex) throws SQLException

 Get the value of a column in the current row as a java.sql.Date object.

Parameters:

 columnIndex - the first column is 1, the second is 2, ...

Returns:

 the column value; if the value is SQL NULL, the result is null

Throws: SQLException

 if a database-access error occurs.

 getTime

  public abstract Time getTime(int columnIndex) throws SQLException

 Get the value of a column in the current row as a java.sql.Time object.

Parameters:

 columnIndex - the first column is 1, the second is 2, ...

Returns:

 the column value; if the value is SQL NULL, the result is null

Throws: SQLException

 if a database-access error occurs.

 getTimestamp

  public abstract Timestamp getTimestamp(int columnIndex) throws SQLException

 Get the value of a column in the current row as a java.sql.Timestamp object.

Parameters:

 columnIndex - the first column is 1, the second is 2, ...

Returns:

 the column value; if the value is SQL NULL, the result is null

Throws: SQLException

 if a database-access error occurs.

 getAsciiStream

  public abstract InputStream getAsciiStream(int columnIndex) throws SQLException

 A column value can be retrieved as a stream of ASCII characters  and then read in chunks from the stream. This method is particularly  suitable for retrieving large LONGVARCHAR values. The JDBC driver will  do any necessary conversion from the database format into ASCII.

Note: All the data in the returned stream must be  read prior to getting the value of any other column. The next  call to a get method implicitly closes the stream. . Also, a  stream may return 0 for available() whether there is data  available or not.

Parameters:

 columnIndex - the first column is 1, the second is 2, ...

Returns:

 a Java input stream that delivers the database column value  as a stream of one byte ASCII characters. If the value is SQL NULL  then the result is null.

Throws: SQLException

 if a database-access error occurs.

 getUnicodeStream

  public abstract InputStream getUnicodeStream(int columnIndex) throws SQLException

 A column value can be retrieved as a stream of Unicode characters  and then read in chunks from the stream. This method is particularly  suitable for retrieving large LONGVARCHAR values. The JDBC driver will  do any necessary conversion from the database format into Unicode.

Note: All the data in the returned stream must be  read prior to getting the value of any other column. The next  call to a get method implicitly closes the stream. . Also, a  stream may return 0 for available() whether there is data  available or not.

Parameters:

 columnIndex - the first column is 1, the second is 2, ...

Returns:

 a Java input stream that delivers the database column value  as a stream of two byte Unicode characters. If the value is SQL NULL  then the result is null.

Throws: SQLException

 if a database-access error occurs.

 getBinaryStream

  public abstract InputStream getBinaryStream(int columnIndex) throws SQLException

 A column value can be retrieved as a stream of uninterpreted bytes  and then read in chunks from the stream. This method is particularly  suitable for retrieving large LONGVARBINARY values.

Note: All the data in the returned stream must be  read prior to getting the value of any other column. The next  call to a get method implicitly closes the stream. Also, a  stream may return 0 for available() whether there is data  available or not.

Parameters:

 columnIndex - the first column is 1, the second is 2, ...

Returns:

 a Java input stream that delivers the database column value  as a stream of uninterpreted bytes. If the value is SQL NULL  then the result is null.

Throws: SQLException

 if a database-access error occurs.

 getString

  public abstract String getString(String columnName) throws SQLException

 Get the value of a column in the current row as a Java String.

Parameters:

 columnName - is the SQL name of the column

Returns:

 the column value; if the value is SQL NULL, the result is null

Throws: SQLException

 if a database-access error occurs.

 getBoolean

  public abstract boolean getBoolean(String columnName) throws SQLException

 Get the value of a column in the current row as a Java boolean.

Parameters:

 columnName - is the SQL name of the column

Returns:

 the column value; if the value is SQL NULL, the result is false

Throws: SQLException

 if a database-access error occurs.

 getByte

  public abstract byte getByte(String columnName) throws SQLException

 Get the value of a column in the current row as a Java byte.

Parameters:

 columnName - is the SQL name of the column

Returns:

 the column value; if the value is SQL NULL, the result is 0

Throws: SQLException

 if a database-access error occurs.

 getShort

  public abstract short getShort(String columnName) throws SQLException

 Get the value of a column in the current row as a Java short.

Parameters:

 columnName - is the SQL name of the column

Returns:

 the column value; if the value is SQL NULL, the result is 0

Throws: SQLException

 if a database-access error occurs.

 getInt

  public abstract int getInt(String columnName) throws SQLException

 Get the value of a column in the current row as a Java int.

Parameters:

 columnName - is the SQL name of the column

Returns:

 the column value; if the value is SQL NULL, the result is 0

Throws: SQLException

 if a database-access error occurs.

 getLong

  public abstract long getLong(String columnName) throws SQLException

 Get the value of a column in the current row as a Java long.

Parameters:

 columnName - is the SQL name of the column

Returns:

 the column value; if the value is SQL NULL, the result is 0

Throws: SQLException

 if a database-access error occurs.

 getFloat

  public abstract float getFloat(String columnName) throws SQLException

 Get the value of a column in the current row as a Java float.

Parameters:

 columnName - is the SQL name of the column

Returns:

 the column value; if the value is SQL NULL, the result is 0

Throws: SQLException

 if a database-access error occurs.

 getDouble

  public abstract double getDouble(String columnName) throws SQLException

 Get the value of a column in the current row as a Java double.

Parameters:

 columnName - is the SQL name of the column

Returns:

 the column value; if the value is SQL NULL, the result is 0

Throws: SQLException

 if a database-access error occurs.

 getBigDecimal

  public abstract BigDecimal getBigDecimal(String columnName,
                                           int scale) throws SQLException

 Get the value of a column in the current row as a java.lang.BigDecimal object.

Parameters:

 columnName - is the SQL name of the column

 scale - the number of digits to the right of the decimal

Returns:

 the column value; if the value is SQL NULL, the result is null

Throws: SQLException

 if a database-access error occurs.

 getBytes

  public abstract byte[] getBytes(String columnName) throws SQLException

 Get the value of a column in the current row as a Java byte array.  The bytes represent the raw values returned by the driver.

Parameters:

 columnName - is the SQL name of the column

Returns:

 the column value; if the value is SQL NULL, the result is null

Throws: SQLException

 if a database-access error occurs.

 getDate

  public abstract Date getDate(String columnName) throws SQLException

 Get the value of a column in the current row as a java.sql.Date object.

Parameters:

 columnName - is the SQL name of the column

Returns:

 the column value; if the value is SQL NULL, the result is null

Throws: SQLException

 if a database-access error occurs.

 getTime

  public abstract Time getTime(String columnName) throws SQLException

 Get the value of a column in the current row as a java.sql.Time object.

Parameters:

 columnName - is the SQL name of the column

Returns:

 the column value; if the value is SQL NULL, the result is null

Throws: SQLException

 if a database-access error occurs.

 getTimestamp

  public abstract Timestamp getTimestamp(String columnName) throws SQLException

 Get the value of a column in the current row as a java.sql.Timestamp object.

Parameters:

 columnName - is the SQL name of the column

Returns:

 the column value; if the value is SQL NULL, the result is null

Throws: SQLException

 if a database-access error occurs.

 getAsciiStream

  public abstract InputStream getAsciiStream(String columnName) throws SQLException

 A column value can be retrieved as a stream of ASCII characters  and then read in chunks from the stream. This method is particularly  suitable for retrieving large LONGVARCHAR values. The JDBC driver will  do any necessary conversion from the database format into ASCII.

Note: All the data in the returned stream must  be read prior to getting the value of any other column. The  next call to a get method implicitly closes the stream.

Parameters:

 columnName - is the SQL name of the column

Returns:

 a Java input stream that delivers the database column value  as a stream of one byte ASCII characters. If the value is SQL NULL  then the result is null.

Throws: SQLException

 if a database-access error occurs.

 getUnicodeStream

  public abstract InputStream getUnicodeStream(String columnName) throws SQLException

 A column value can be retrieved as a stream of Unicode characters  and then read in chunks from the stream. This method is particularly  suitable for retrieving large LONGVARCHAR values. The JDBC driver will  do any necessary conversion from the database format into Unicode.

Note: All the data in the returned stream must  be read prior to getting the value of any other column. The  next call to a get method implicitly closes the stream.

Parameters:

 columnName - is the SQL name of the column

Returns:

 a Java input stream that delivers the database column value  as a stream of two byte Unicode characters. If the value is SQL NULL  then the result is null.

Throws: SQLException

 if a database-access error occurs.

 getBinaryStream

  public abstract InputStream getBinaryStream(String columnName) throws SQLException

 A column value can be retrieved as a stream of uninterpreted bytes  and then read in chunks from the stream. This method is particularly  suitable for retrieving large LONGVARBINARY values.

Note: All the data in the returned stream must  be read prior to getting the value of any other column. The  next call to a get method implicitly closes the stream.

Parameters:

 columnName - is the SQL name of the column

Returns:

 a Java input stream that delivers the database column value  as a stream of uninterpreted bytes. If the value is SQL NULL  then the result is null.

Throws: SQLException

 if a database-access error occurs.

 getWarnings

  public abstract SQLWarning getWarnings() throws SQLException

The first warning reported by calls on this ResultSet is  returned. Subsequent ResultSet warnings will be chained to this  SQLWarning.

The warning chain is automatically cleared each time a new  row is read.

Note: This warning chain only covers warnings caused  by ResultSet methods. Any warning caused by statement methods  (such as reading OUT parameters) will be chained on the  Statement object.

Returns:

 the first SQLWarning or null

Throws: SQLException

 if a database-access error occurs.

 clearWarnings

  public abstract void clearWarnings() throws SQLException

 After this call getWarnings returns null until a new warning is  reported for this ResultSet.

Throws: SQLException

 if a database-access error occurs.

 getCursorName

  public abstract String getCursorName() throws SQLException

 Get the name of the SQL cursor used by this ResultSet.

In SQL, a result table is retrieved through a cursor that is  named. The current row of a result can be updated or deleted  using a positioned update/delete statement that references the  cursor name.

JDBC supports this SQL feature by providing the name of the  SQL cursor used by a ResultSet. The current row of a ResultSet  is also the current row of this SQL cursor.

Note: If positioned update is not supported a  SQLException is thrown

Returns:

 the ResultSet's SQL cursor name

Throws: SQLException

 if a database-access error occurs.

 getMetaData

  public abstract ResultSetMetaData getMetaData() throws SQLException

 The number, types and properties of a ResultSet's columns  are provided by the getMetaData method.

Returns:

 the description of a ResultSet's columns

Throws: SQLException

 if a database-access error occurs.

 getObject

  public abstract Object getObject(int columnIndex) throws SQLException

Get the value of a column in the current row as a Java object.

This method will return the value of the given column as a  Java object. The type of the Java object will be the default  Java Object type corresponding to the column's SQL type,  following the mapping specified in the JDBC spec.

This method may also be used to read datatabase specific abstract  data types.

Parameters:

 columnIndex - the first column is 1, the second is 2, ...

Returns:

 A java.lang.Object holding the column value.

Throws: SQLException

 if a database-access error occurs.

 getObject

  public abstract Object getObject(String columnName) throws SQLException

Get the value of a column in the current row as a Java object.

This method will return the value of the given column as a  Java object. The type of the Java object will be the default  Java Object type corresponding to the column's SQL type,  following the mapping specified in the JDBC spec.

This method may also be used to read datatabase specific abstract  data types.

Parameters:

 columnName - is the SQL name of the column

Returns:

 A java.lang.Object holding the column value.

Throws: SQLException

 if a database-access error occurs.

 findColumn

  public abstract int findColumn(String columnName) throws SQLException

 Map a Resultset column name to a ResultSet column index.

Parameters:

 columnName - the name of the column

Returns:

 the column index

Throws: SQLException

 if a database-access error occurs.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.sql.ResultSetMetaData

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.sql.ResultSetMetaData

 public interface ResultSetMetaData

A ResultSetMetaData object can be used to find out about the types  and properties of the columns in a ResultSet.

______________________________________________________________________________

 	columnNoNulls

 Does not allow NULL values.

 	columnNullable

 Allows NULL values.

 	columnNullableUnknown

 Nullability unknown.

 	getCatalogName(int)

 What's a column's table's catalog name?

 	getColumnCount()

 What's the number of columns in the ResultSet?

 	getColumnDisplaySize(int)

 What's the column's normal max width in chars?

 	getColumnLabel(int)

 What's the suggested column title for use in printouts and  displays?

 	getColumnName(int)

 What's a column's name?

 	getColumnType(int)

 What's a column's SQL type?

 	getColumnTypeName(int)

 What's a column's data source specific type name?

 	getPrecision(int)

 What's a column's number of decimal digits?

 	getScale(int)

 What's a column's number of digits to right of the decimal point?

 	getSchemaName(int)

 What's a column's table's schema?

 	getTableName(int)

 What's a column's table name?

 	isAutoIncrement(int)

 Is the column automatically numbered, thus read-only?

 	isCaseSensitive(int)

 Does a column's case matter?

 	isCurrency(int)

 Is the column a cash value?

 	isDefinitelyWritable(int)

 Will a write on the column definitely succeed?

 	isNullable(int)

 Can you put a NULL in this column?

 	isReadOnly(int)

 Is a column definitely not writable?

 	isSearchable(int)

 Can the column be used in a where clause?

 	isSigned(int)

 Is the column a signed number?

 	isWritable(int)

 Is it possible for a write on the column to succeed?

 columnNoNulls

  public final static int columnNoNulls

 Does not allow NULL values.

 columnNullable

  public final static int columnNullable

 Allows NULL values.

 columnNullableUnknown

  public final static int columnNullableUnknown

 Nullability unknown.

 getColumnCount

  public abstract int getColumnCount() throws SQLException

 What's the number of columns in the ResultSet?

Returns:

 the number

Throws: SQLException

 if a database-access error occurs.

 isAutoIncrement

  public abstract boolean isAutoIncrement(int column) throws SQLException

 Is the column automatically numbered, thus read-only?

Parameters:

 column - the first column is 1, the second is 2, ...

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 isCaseSensitive

  public abstract boolean isCaseSensitive(int column) throws SQLException

 Does a column's case matter?

Parameters:

 column - the first column is 1, the second is 2, ...

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 isSearchable

  public abstract boolean isSearchable(int column) throws SQLException

 Can the column be used in a where clause?

Parameters:

 column - the first column is 1, the second is 2, ...

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 isCurrency

  public abstract boolean isCurrency(int column) throws SQLException

 Is the column a cash value?

Parameters:

 column - the first column is 1, the second is 2, ...

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 isNullable

  public abstract int isNullable(int column) throws SQLException

 Can you put a NULL in this column?

Parameters:

 column - the first column is 1, the second is 2, ...

Returns:

 columnNoNulls, columnNullable or columnNullableUnknown

Throws: SQLException

 if a database-access error occurs.

 isSigned

  public abstract boolean isSigned(int column) throws SQLException

 Is the column a signed number?

Parameters:

 column - the first column is 1, the second is 2, ...

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 getColumnDisplaySize

  public abstract int getColumnDisplaySize(int column) throws SQLException

 What's the column's normal max width in chars?

Parameters:

 column - the first column is 1, the second is 2, ...

Returns:

 max width

Throws: SQLException

 if a database-access error occurs.

 getColumnLabel

  public abstract String getColumnLabel(int column) throws SQLException

 What's the suggested column title for use in printouts and  displays?

Parameters:

 column - the first column is 1, the second is 2, ...

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 getColumnName

  public abstract String getColumnName(int column) throws SQLException

 What's a column's name?

Parameters:

 column - the first column is 1, the second is 2, ...

Returns:

 column name

Throws: SQLException

 if a database-access error occurs.

 getSchemaName

  public abstract String getSchemaName(int column) throws SQLException

 What's a column's table's schema?

Parameters:

 column - the first column is 1, the second is 2, ...

Returns:

 schema name or "" if not applicable

Throws: SQLException

 if a database-access error occurs.

 getPrecision

  public abstract int getPrecision(int column) throws SQLException

 What's a column's number of decimal digits?

Parameters:

 column - the first column is 1, the second is 2, ...

Returns:

 precision

Throws: SQLException

 if a database-access error occurs.

 getScale

  public abstract int getScale(int column) throws SQLException

 What's a column's number of digits to right of the decimal point?

Parameters:

 column - the first column is 1, the second is 2, ...

Returns:

 scale

Throws: SQLException

 if a database-access error occurs.

 getTableName

  public abstract String getTableName(int column) throws SQLException

 What's a column's table name?

Returns:

 table name or "" if not applicable

Throws: SQLException

 if a database-access error occurs.

 getCatalogName

  public abstract String getCatalogName(int column) throws SQLException

 What's a column's table's catalog name?

Parameters:

 column - the first column is 1, the second is 2, ...

Returns:

 column name or "" if not applicable.

Throws: SQLException

 if a database-access error occurs.

 getColumnType

  public abstract int getColumnType(int column) throws SQLException

 What's a column's SQL type?

Parameters:

 column - the first column is 1, the second is 2, ...

Returns:

 SQL type

Throws: SQLException

 if a database-access error occurs.

See Also:

Types

 getColumnTypeName

  public abstract String getColumnTypeName(int column) throws SQLException

 What's a column's data source specific type name?

Parameters:

 column - the first column is 1, the second is 2, ...

Returns:

 type name

Throws: SQLException

 if a database-access error occurs.

 isReadOnly

  public abstract boolean isReadOnly(int column) throws SQLException

 Is a column definitely not writable?

Parameters:

 column - the first column is 1, the second is 2, ...

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 isWritable

  public abstract boolean isWritable(int column) throws SQLException

 Is it possible for a write on the column to succeed?

Parameters:

 column - the first column is 1, the second is 2, ...

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

 isDefinitelyWritable

  public abstract boolean isDefinitelyWritable(int column) throws SQLException

 Will a write on the column definitely succeed?

Parameters:

 column - the first column is 1, the second is 2, ...

Returns:

 true if so

Throws: SQLException

 if a database-access error occurs.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.sql.SQLException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.sql.SQLException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.sql.SQLException

______________________________________________________________________________

 public class SQLException

 extends Exception

The SQLException class provides information on a database access  error.

Each SQLException provides several kinds of information:

•  a string describing the error. This is used as the Java Exception  message, and is available via the getMesage() method

•  A "SQLstate" string which follows the XOPEN SQLstate conventions.  The values of the SQLState string as described in the XOPEN SQL spec.

•  An integer error code that is vendor specific. Normally this will 	be the actual error code returned by the underlying database.

•  A chain to a next Exception. This can be used to provided additional  error information.

______________________________________________________________________________

 	SQLException()

 Construct an SQLException; reason defaults to null, SQLState  defaults to null and vendorCode defaults to 0.

 	SQLException(String)

 Construct an SQLException with a reason; SQLState defaults to  null and vendorCode defaults to 0.

 	SQLException(String, String)

 Construct an SQLException with a reason and SQLState;  vendorCode defaults to 0.

 	SQLException(String, String, int)

 Construct a fully-specified SQLException

 	getErrorCode()

 Get the vendor specific exception code

 	getNextException()

 Get the exception chained to this one.

 	getSQLState()

 Get the SQLState

 	setNextException(SQLException)

 Add an SQLException to the end of the chain.

 SQLException

  public SQLException(String reason,
                      String SQLState,
                      int vendorCode)

 Construct a fully-specified SQLException

Parameters:

 reason - a description of the exception

 SQLState - an XOPEN code identifying the exception

 vendorCode - a database vendor specific exception code

 SQLException

  public SQLException(String reason,
                      String SQLState)

 Construct an SQLException with a reason and SQLState;  vendorCode defaults to 0.

Parameters:

 reason - a description of the exception

 SQLState - an XOPEN code identifying the exception

 SQLException

  public SQLException(String reason)

 Construct an SQLException with a reason; SQLState defaults to  null and vendorCode defaults to 0.

Parameters:

 reason - a description of the exception

 SQLException

  public SQLException()

 Construct an SQLException; reason defaults to null, SQLState  defaults to null and vendorCode defaults to 0.

 getSQLState

  public String getSQLState()

 Get the SQLState

Returns:

 the SQLState value

 getErrorCode

  public int getErrorCode()

 Get the vendor specific exception code

Returns:

 the vendor's error code

 getNextException

  public SQLException getNextException()

 Get the exception chained to this one.

Returns:

 the next SQLException in the chain, null if none

 setNextException

  public synchronized void setNextException(SQLException ex)

 Add an SQLException to the end of the chain.

Parameters:

 ex - the new end of the SQLException chain

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.sql.SQLWarning

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.sql.SQLWarning

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.sql.SQLException
                           |
                           +----java.sql.SQLWarning

______________________________________________________________________________

 public class SQLWarning

 extends SQLException

The SQLWarning class provides information on a database access  warnings. Warnings are silently chained to the object whose method  caused it to be reported.

See Also:

getWarnings, getWarnings, getWarnings

______________________________________________________________________________

 	SQLWarning()

 Construct an SQLWarning ; reason defaults to null, SQLState  defaults to null and vendorCode defaults to 0.

 	SQLWarning(String)

 Construct an SQLWarning with a reason; SQLState defaults to  null and vendorCode defaults to 0.

 	SQLWarning(String, String)

 Construct an SQLWarning with a reason and SQLState;  vendorCode defaults to 0.

 	SQLWarning(String, String, int)

 Construct a fully specified SQLWarning.

 	getNextWarning()

 Get the warning chained to this one

 	setNextWarning(SQLWarning)

 Add an SQLWarning to the end of the chain.

 SQLWarning

  public SQLWarning(String reason,
                    String SQLstate,
                    int vendorCode)

 Construct a fully specified SQLWarning.

Parameters:

 reason - a description of the warning

 SQLState - an XOPEN code identifying the warning

 vendorCode - a database vendor specific warning code

 SQLWarning

  public SQLWarning(String reason,
                    String SQLstate)

 Construct an SQLWarning with a reason and SQLState;  vendorCode defaults to 0.

Parameters:

 reason - a description of the warning

 SQLState - an XOPEN code identifying the warning

 SQLWarning

  public SQLWarning(String reason)

 Construct an SQLWarning with a reason; SQLState defaults to  null and vendorCode defaults to 0.

Parameters:

 reason - a description of the warning

 SQLWarning

  public SQLWarning()

 Construct an SQLWarning ; reason defaults to null, SQLState  defaults to null and vendorCode defaults to 0.

 getNextWarning

  public SQLWarning getNextWarning()

 Get the warning chained to this one

Returns:

 the next SQLException in the chain, null if none

 setNextWarning

  public void setNextWarning(SQLWarning w)

 Add an SQLWarning to the end of the chain.

Parameters:

 w - the new end of the SQLException chain

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.sql.Statement

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.sql.Statement

 public interface Statement

A Statement object is used for executing a static SQL statement  and obtaining the results produced by it.

Only one ResultSet per Statement can be open at any point in  time. Therefore, if the reading of one ResultSet is interleaved  with the reading of another, each must have been generated by  different Statements. All statement execute methods implicitly  close a statment's current ResultSet if an open one exists.

See Also:

createStatement, ResultSet

______________________________________________________________________________

 	cancel()

 Cancel can be used by one thread to cancel a statement that  is being executed by another thread.

 	clearWarnings()

 After this call, getWarnings returns null until a new warning is  reported for this Statement.

 	close()

 In many cases, it is desirable to immediately release a  Statements's database and JDBC resources instead of waiting for  this to happen when it is automatically closed; the close  method provides this immediate release.

 	execute(String)

 Execute a SQL statement that may return multiple results.

 	executeQuery(String)

 Execute a SQL statement that returns a single ResultSet.

 	executeUpdate(String)

 Execute a SQL INSERT, UPDATE or DELETE statement.

 	getMaxFieldSize()

 The maxFieldSize limit (in bytes) is the maximum amount of data  returned for any column value; it only applies to BINARY,  VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR  columns.

 	getMaxRows()

 The maxRows limit is the maximum number of rows that a  ResultSet can contain.

 	getMoreResults()

 getMoreResults moves to a Statement's next result.

 	getQueryTimeout()

 The queryTimeout limit is the number of seconds the driver will  wait for a Statement to execute.

 	getResultSet()

 getResultSet returns the current result as a ResultSet.

 	getUpdateCount()

 getUpdateCount returns the current result as an update count;  if the result is a ResultSet or there are no more results, -1  is returned.

 	getWarnings()

 The first warning reported by calls on this Statement is  returned.

 	setCursorName(String)

 setCursorname defines the SQL cursor name that will be used by  subsequent Statement execute methods.

 	setEscapeProcessing(boolean)

 If escape scanning is on (the default), the driver will do  escape substitution before sending the SQL to the database.

 	setMaxFieldSize(int)

 The maxFieldSize limit (in bytes) is set to limit the size of  data that can be returned for any column value; it only applies  to BINARY, VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and  LONGVARCHAR fields.

 	setMaxRows(int)

 The maxRows limit is set to limit the number of rows that any  ResultSet can contain.

 	setQueryTimeout(int)

 The queryTimeout limit is the number of seconds the driver will  wait for a Statement to execute.

 executeQuery

  public abstract ResultSet executeQuery(String sql) throws SQLException

 Execute a SQL statement that returns a single ResultSet.

Parameters:

 sql - typically this is a static SQL SELECT statement

Returns:

 a ResultSet that contains the data produced by the  query; never null

Throws: SQLException

 if a database-access error occurs.

 executeUpdate

  public abstract int executeUpdate(String sql) throws SQLException

 Execute a SQL INSERT, UPDATE or DELETE statement. In addition,  SQL statements that return nothing such as SQL DDL statements  can be executed.

Parameters:

 sql - a SQL INSERT, UPDATE or DELETE statement or a SQL  statement that returns nothing

Returns:

 either the row count for INSERT, UPDATE or DELETE or 0  for SQL statements that return nothing

Throws: SQLException

 if a database-access error occurs.

 close

  public abstract void close() throws SQLException

 In many cases, it is desirable to immediately release a  Statements's database and JDBC resources instead of waiting for  this to happen when it is automatically closed; the close  method provides this immediate release.

Note: A Statement is automatically closed when it is  garbage collected. When a Statement is closed, its current  ResultSet, if one exists, is also closed.

Throws: SQLException

 if a database-access error occurs.

 getMaxFieldSize

  public abstract int getMaxFieldSize() throws SQLException

 The maxFieldSize limit (in bytes) is the maximum amount of data  returned for any column value; it only applies to BINARY,  VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR  columns. If the limit is exceeded, the excess data is silently  discarded.

Returns:

 the current max column size limit; zero means unlimited

Throws: SQLException

 if a database-access error occurs.

 setMaxFieldSize

  public abstract void setMaxFieldSize(int max) throws SQLException

 The maxFieldSize limit (in bytes) is set to limit the size of  data that can be returned for any column value; it only applies  to BINARY, VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and  LONGVARCHAR fields. If the limit is exceeded, the excess data  is silently discarded. For maximum portability use values  greater than 256.

Parameters:

 max - the new max column size limit; zero means unlimited

Throws: SQLException

 if a database-access error occurs.

 getMaxRows

  public abstract int getMaxRows() throws SQLException

 The maxRows limit is the maximum number of rows that a  ResultSet can contain. If the limit is exceeded, the excess  rows are silently dropped.

Returns:

 the current max row limit; zero means unlimited

Throws: SQLException

 if a database-access error occurs.

 setMaxRows

  public abstract void setMaxRows(int max) throws SQLException

 The maxRows limit is set to limit the number of rows that any  ResultSet can contain. If the limit is exceeded, the excess  rows are silently dropped.

Parameters:

 max - the new max rows limit; zero means unlimited

Throws: SQLException

 if a database-access error occurs.

 setEscapeProcessing

  public abstract void setEscapeProcessing(boolean enable) throws SQLException

 If escape scanning is on (the default), the driver will do  escape substitution before sending the SQL to the database.  Note: Since prepared statements have usually been parsed prior  to making this call, disabling escape processing for prepared  statements will like have no affect.

Parameters:

 enable - true to enable; false to disable

Throws: SQLException

 if a database-access error occurs.

 getQueryTimeout

  public abstract int getQueryTimeout() throws SQLException

 The queryTimeout limit is the number of seconds the driver will  wait for a Statement to execute. If the limit is exceeded, a  SQLException is thrown.

Returns:

 the current query timeout limit in seconds; zero means unlimited

Throws: SQLException

 if a database-access error occurs.

 setQueryTimeout

  public abstract void setQueryTimeout(int seconds) throws SQLException

 The queryTimeout limit is the number of seconds the driver will  wait for a Statement to execute. If the limit is exceeded, a  SQLException is thrown.

Parameters:

 seconds - the new query timeout limit in seconds; zero means unlimited

Throws: SQLException

 if a database-access error occurs.

 cancel

  public abstract void cancel() throws SQLException

 Cancel can be used by one thread to cancel a statement that  is being executed by another thread.

Throws: SQLException

 if a database-access error occurs.

 getWarnings

  public abstract SQLWarning getWarnings() throws SQLException

 The first warning reported by calls on this Statement is  returned. A Statment's execute methods clear its SQLWarning  chain. Subsequent Statement warnings will be chained to this  SQLWarning.

The warning chain is automatically cleared each time  a statement is (re)executed.

Note: If you are processing a ResultSet then any  warnings associated with ResultSet reads will be chained on the  ResultSet object.

Returns:

 the first SQLWarning or null

Throws: SQLException

 if a database-access error occurs.

 clearWarnings

  public abstract void clearWarnings() throws SQLException

 After this call, getWarnings returns null until a new warning is  reported for this Statement.

Throws: SQLException

 if a database-access error occurs.

 setCursorName

  public abstract void setCursorName(String name) throws SQLException

 setCursorname defines the SQL cursor name that will be used by  subsequent Statement execute methods. This name can then be  used in SQL positioned update/delete statements to identify the  current row in the ResultSet generated by this statement. If  the database doesn't support positioned update/delete, this  method is a noop.

Note: By definition, positioned update/delete  execution must be done by a different Statement than the one  which generated the ResultSet being used for positioning. Also,  cursor names must be unique within a Connection.

Parameters:

 name - the new cursor name.

Throws: SQLException

 if a database-access error occurs.

 execute

  public abstract boolean execute(String sql) throws SQLException

 Execute a SQL statement that may return multiple results.  Under some (uncommon) situations a single SQL statement may return  multiple result sets and/or update counts. Normally you can ignore  this, unless you're executing a stored procedure that you know may  return multiple results, or unless you're dynamically executing an  unknown SQL string. The "execute", "getMoreResults", "getResultSet"  and "getUpdateCount" methods let you navigate through multiple results.  The "execute" method executes a SQL statement and indicates the  form of the first result. You can then use getResultSet or  getUpdateCount to retrieve the result, and getMoreResults to  move to any subsequent result(s).

Parameters:

 sql - any SQL statement

Returns:

 true if the next result is a ResultSet; false if it is  an update count or there are no more results

Throws: SQLException

 if a database-access error occurs.

See Also:

getResultSet, getUpdateCount, getMoreResults

 getResultSet

  public abstract ResultSet getResultSet() throws SQLException

 getResultSet returns the current result as a ResultSet. It  should only be called once per result.

Returns:

 the current result as a ResultSet; null if the result  is an update count or there are no more results

Throws: SQLException

 if a database-access error occurs.

See Also:

execute

 getUpdateCount

  public abstract int getUpdateCount() throws SQLException

 getUpdateCount returns the current result as an update count;  if the result is a ResultSet or there are no more results, -1  is returned. It should only be called once per result.

Returns:

 the current result as an update count; -1 if it is a  ResultSet or there are no more results

Throws: SQLException

 if a database-access error occurs.

See Also:

execute

 getMoreResults

  public abstract boolean getMoreResults() throws SQLException

 getMoreResults moves to a Statement's next result. It returns true if  this result is a ResultSet. getMoreResults also implicitly  closes any current ResultSet obtained with getResultSet.  There are no more results when (!getMoreResults() &&  (getUpdateCount() == -1)

Returns:

 true if the next result is a ResultSet; false if it is  an update count or there are no more results

Throws: SQLException

 if a database-access error occurs.

See Also:

execute

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.sql.Time

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.sql.Time

java.lang.Object
   |
   +----java.util.Date
           |
           +----java.sql.Time

______________________________________________________________________________

 public class Time

 extends Date

This class is a thin wrapper around java.util.Date that allows  JDBC to identify this as a SQL TIME value. It adds formatting and  parsing operations to support the JDBC escape syntax for time  values.

______________________________________________________________________________

 	Time(int, int, int)

 Construct a Time Object

 	Time(long)

 Construct a Time using a milliseconds time value

 	getDate()

 Returns the day of the month represented by this date.

 	getDay()

 Returns the day of the week represented by this date.

 	getMonth()

 Returns the month represented by this date.

 	getYear()

 Returns the year represented by this date, minus 1900.

 	setDate(int)

 Sets the day of the month of this date to the specified value.

 	setMonth(int)

 Sets the month of this date to the specified value.

 	setTime(long)

 Set a Time using a milliseconds time value

 	setYear(int)

 Sets the year of this date to be the specified value plus 1900.

 	toString()

 Format a time in JDBC date escape format

 	valueOf(String)

 Convert a string in JDBC time escape format to a Time value

 Time

  public Time(int hour,
              int minute,
              int second)

 Construct a Time Object

Parameters:

 hour - 0 to 23

 minute - 0 to 59

 second - 0 to 59

 Time

  public Time(long time)

 Construct a Time using a milliseconds time value

Parameters:

 time - milliseconds since January 1, 1970, 00:00:00 GMT

 setTime

  public void setTime(long time)

 Set a Time using a milliseconds time value

Parameters:

 time - milliseconds since January 1, 1970, 00:00:00 GMT

Overrides:

setTime in class Date

 valueOf

  public static Time valueOf(String s)

 Convert a string in JDBC time escape format to a Time value

Parameters:

 s - time in format "hh:mm:ss"

Returns:

 corresponding Time

 toString

  public String toString()

 Format a time in JDBC date escape format

Returns:

 a String in hh:mm:ss format

Overrides:

toString in class Date

 getYear

  public int getYear()

 Returns the year represented by this date, minus 1900.

Overrides:

getYear in class Date

 getMonth

  public int getMonth()

 Returns the month represented by this date.

Overrides:

getMonth in class Date

 getDay

  public int getDay()

 Returns the day of the week represented by this date.

Overrides:

getDay in class Date

 getDate

  public int getDate()

 Returns the day of the month represented by this date.

Overrides:

getDate in class Date

 setYear

  public void setYear(int i)

 Sets the year of this date to be the specified value plus 1900.

Overrides:

setYear in class Date

 setMonth

  public void setMonth(int i)

 Sets the month of this date to the specified value.

Overrides:

setMonth in class Date

 setDate

  public void setDate(int i)

 Sets the day of the month of this date to the specified value.

Overrides:

setDate in class Date

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.sql.Timestamp

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.sql.Timestamp

java.lang.Object
   |
   +----java.util.Date
           |
           +----java.sql.Timestamp

______________________________________________________________________________

 public class Timestamp

 extends Date

This class is a thin wrapper around java.util.Date that allows  JDBC to identify this as a SQL TIMESTAMP value. It adds the ability  to hold the SQL TIMESTAMP nanos value and provides formatting and  parsing operations to support the JDBC escape syntax for timestamp  values.

Note: This type is a composite of a java.util.Date and a  separate nanos value. Only integral seconds are stored in the  java.util.Date component. The fractional seconds - the nanos - are  separate. The getTime method will only return integral seconds. If  a time value that includes the fractional seconds is desired you  must convert nanos to milliseconds (nanos/1000000) and add this to  the getTime value. Also note that the hashcode() method uses the  underlying java.util.Data implementation and therefore does not  include nanos in its computation.

______________________________________________________________________________

 	Timestamp(int, int, int, int, int, int, int)

 Construct a Timestamp Object

 	Timestamp(long)

 Construct a Timestamp using a milliseconds time value.

 	after(Timestamp)

 Is this timestamp later than the timestamp argument?

 	before(Timestamp)

 Is this timestamp earlier than the timestamp argument?

 	equals(Timestamp)

 Test Timestamp values for equality

 	getNanos()

 Get the Timestamp's nanos value

 	setNanos(int)

 Set the Timestamp's nanos value

 	toString()

 Format a timestamp in JDBC timestamp escape format

 	valueOf(String)

 Convert a string in JDBC timestamp escape format to a Timestamp value

 Timestamp

  public Timestamp(int year,
                   int month,
                   int date,
                   int hour,
                   int minute,
                   int second,
                   int nano)

 Construct a Timestamp Object

Parameters:

 year - year-1900

 month - 0 to 11

 day - 1 to 31

 hour - 0 to 23

 minute - 0 to 59

 second - 0 to 59

 nano - 0 to 999,999,999

 Timestamp

  public Timestamp(long time)

 Construct a Timestamp using a milliseconds time value. The  integral seconds are stored in the underlying date value; the  fractional seconds are stored in the nanos value.

Parameters:

 time - milliseconds since January 1, 1970, 00:00:00 GMT

 valueOf

  public static Timestamp valueOf(String s)

 Convert a string in JDBC timestamp escape format to a Timestamp value

Parameters:

 s - timestamp in format "yyyy-mm-dd hh:mm:ss.fffffffff"

Returns:

 corresponding Timestamp

 toString

  public String toString()

 Format a timestamp in JDBC timestamp escape format

Returns:

 a String in yyyy-mm-dd hh:mm:ss.fffffffff format

Overrides:

toString in class Date

 getNanos

  public int getNanos()

 Get the Timestamp's nanos value

Returns:

 the Timestamp's fractional seconds component

 setNanos

  public void setNanos(int n)

 Set the Timestamp's nanos value

Parameters:

 n - the new fractional seconds component

 equals

  public boolean equals(Timestamp ts)

 Test Timestamp values for equality

Parameters:

 ts - the Timestamp value to compare with

 before

  public boolean before(Timestamp ts)

 Is this timestamp earlier than the timestamp argument?

Parameters:

 ts - the Timestamp value to compare with

 after

  public boolean after(Timestamp ts)

 Is this timestamp later than the timestamp argument?

Parameters:

 ts - the Timestamp value to compare with

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.sql.Types

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.sql.Types

java.lang.Object
   |
   +----java.sql.Types

______________________________________________________________________________

 public class Types

 extends Object

This class defines constants that are used to identify SQL types.  The actual type constant values are equivalent to those in XOPEN.

______________________________________________________________________________

 	BIGINT

  	BINARY

  	BIT

  	CHAR

  	DATE

  	DECIMAL

  	DOUBLE

  	FLOAT

  	INTEGER

  	LONGVARBINARY

  	LONGVARCHAR

  	NULL

  	NUMERIC

  	OTHER

 OTHER indicates that the SQL type is database specific and  gets mapped to a Java object which can be accessed via  getObject and setObject.

 	REAL

  	SMALLINT

  	TIME

  	TIMESTAMP

  	TINYINT

  	VARBINARY

  	VARCHAR

 BIT

  public final static int BIT

 TINYINT

  public final static int TINYINT

 SMALLINT

  public final static int SMALLINT

 INTEGER

  public final static int INTEGER

 BIGINT

  public final static int BIGINT

 FLOAT

  public final static int FLOAT

 REAL

  public final static int REAL

 DOUBLE

  public final static int DOUBLE

 NUMERIC

  public final static int NUMERIC

 DECIMAL

  public final static int DECIMAL

 CHAR

  public final static int CHAR

 VARCHAR

  public final static int VARCHAR

 LONGVARCHAR

  public final static int LONGVARCHAR

 DATE

  public final static int DATE

 TIME

  public final static int TIME

 TIMESTAMP

  public final static int TIMESTAMP

 BINARY

  public final static int BINARY

 VARBINARY

  public final static int VARBINARY

 LONGVARBINARY

  public final static int LONGVARBINARY

 NULL

  public final static int NULL

 OTHER

  public final static int OTHER

 OTHER indicates that the SQL type is database specific and  gets mapped to a Java object which can be accessed via  getObject and setObject.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.text.BreakIterator

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.text.BreakIterator

java.lang.Object
   |
   +----java.text.BreakIterator

______________________________________________________________________________

 public class BreakIterator

 extends Object

 implements Cloneable, Serializable

The BreakIterator class implements methods for finding  the location of boundaries in text. Instances of BreakIterator  maintain a current position and scan over text  returning the index of characters where boundaries occur.  Internally, BreakIterator  scans text using a  CharacterIterator, and is thus able to scan text held  by any object implementing that protocol. A StringCharacterIterator  is used to scan String objects passed to setText.

 You use the factory methods provided by this class to create  instances of various types of break iterators. In particular,  use getWordIterator, getLineIterator,  getSentenceIterator, and getCharacterIterator   to create BreakIterators that perform  word, line, sentence, and character boundary analysis respectively.  A single BreakIterator can work only on one unit  (word, line, sentence, and so on). You must use a different iterator  for each unit boundary analysis you wish to perform.

 Line boundary analysis determines where a text string can be  broken when line-wrapping. The mechanism correctly handles  punctuation and hyphenated words.

 Sentence boundary analysis allows selection with correct interpretation  of periods within numbers and abbreviations, and trailing punctuation  marks such as quotation marks and parentheses.

 Word boundary analysis is used by search and replace functions, as  well as within text editing applications that allow the user to  select words with a double click. Word selection provides correct  interpretation of punctuation marks within and following  words. Characters that are not part of a word, such as symbols  or punctuation marks, have word-breaks on both sides.

 Character boundary analysis allows users to interact with characters  as they expect to, for example, when moving the cursor through a text  string. Character boundary analysis provides correct navigation of  through character strings, regardless of how the character is stored.  For example, an accented character might be stored as a base character  and a diacritical mark. What users consider to be a character can  differ between languages.

BreakIterator is intended for use with natural  languages only. Do not use this class to tokenize a programming language.

Examples:

 Creating and using text boundaries

 public static void main(String args[]) {
      if (args.length == 1) {
          String stringToExamine = args[0];
          //print each word in order
          BreakIterator boundary = BreakIterator.getWordInstance();
          boundary.setText(stringToExamine);
          printEachForward(boundary, stringToExamine);
          //print each sentence in reverse order
          boundary = BreakIterator.getSentenceInstance(Locale.US);
          boundary.setText(stringToExamine);
          printEachBackward(boundary, stringToExamine);
          printFirst(boundary, stringToExamine);
          printLast(boundary, stringToExamine);
      }
 }

 Print each element in order

 public static void printEachForward(BreakIterator boundary, String source) {
     int start = boundary.first();
     for (int end = boundary.next();
          end != BreakIterator.DONE;
          start = end, end = boundary.next()) {
          System.out.println(source.substring(start,end));
     }
 }

 Print each element in reverse order

 public static void printEachBackward(BreakIterator boundary, String source) {
     int end = boundary.last();
     for (int start = boundary.previous();
          start != BreakIterator.DONE;
          end = start, start = boundary.previous()) {
         System.out.println(source.substring(start,end));
     }
 }

 Print first element

 public static void printFirst(BreakIterator boundary, String source) {
     int start = boundary.first();
     int end = boundary.next();
     System.out.println(source.substring(start,end));
 }

 Print last element

 public static void printLast(BreakIterator boundary, String source) {
     int end = boundary.last();
     int start = boundary.previous();
     System.out.println(source.substring(start,end));
 }

 Print the element at a specified position

 public static void printAt(BreakIterator boundary, int pos, String source) {
     int end = boundary.following(pos);
     int start = boundary.previous();
     System.out.println(source.substring(start,end));
 }

See Also:

CharacterIterator

______________________________________________________________________________

 	DONE

 DONE is returned by previous() and next() after all valid  boundaries have been returned.

 	BreakIterator()

 Constructor.

 	clone()

 Create a copy of this boundary

 	current()

 Return character index of the text boundary that was most recently  returned by next(), previous(), first(), or last()

 	first()

 Return the first boundary.

 	following(int)

 Return the first boundary following the specified offset.

 	getAvailableLocales()

 Get the set of Locales for which TextBoundaries are installed

 	getCharacterInstance()

 Create BreakIterator for character-breaks using default locale  Returns an instance of a BreakIterator implementing character breaks.

 	getCharacterInstance(Locale)

 Create BreakIterator for character-breaks using specified locale  Returns an instance of a BreakIterator implementing character breaks.

 	getLineInstance()

 Create BreakIterator for line-breaks using default locale.

 	getLineInstance(Locale)

 Create BreakIterator for line-breaks using default locale.

 	getSentenceInstance()

 Create BreakIterator for sentence-breaks using default locale  Returns an instance of a BreakIterator implementing sentence breaks.

 	getSentenceInstance(Locale)

 Create BreakIterator for sentence-breaks using specified locale  Returns an instance of a BreakIterator implementing sentence breaks.

 	getText()

 Get the text being scanned

 	getWordInstance()

 Create BreakIterator for word-breaks using default locale.

 	getWordInstance(Locale)

 Create BreakIterator for word-breaks using default locale.

 	last()

 Return the last boundary.

 	next()

 Return the boundary following the current boundary.

 	next(int)

 Return the nth boundary from the current boundary

 	previous()

 Return the boundary preceding the current boundary.

 	setText(CharacterIterator)

 Set a new text for scanning.

 	setText(String)

 Set a new text string to be scanned.

 DONE

  public final static int DONE

 DONE is returned by previous() and next() after all valid  boundaries have been returned.

 BreakIterator

  protected BreakIterator()

 Constructor. BreakIterator is stateless and has no default behavior.

 clone

  public Object clone()

 Create a copy of this boundary

Returns:

 A copy of this

Overrides:

clone in class Object

 first

  public abstract int first()

 Return the first boundary. The iterator's current position is set  to the first boundary.

Returns:

 The character index of the first text boundary.

 last

  public abstract int last()

 Return the last boundary. The iterator's current position is set  to the last boundary.

Returns:

 The character index of the last text boundary.

 next

  public abstract int next(int n)

 Return the nth boundary from the current boundary

Parameters:

 n - which boundary to return. A value of 0  does nothing. Negative values move to previous boundaries  and positive values move to later boundaries.

Returns:

 The index of the nth boundary from the current position.

 next

  public abstract int next()

 Return the boundary following the current boundary.

Returns:

 The character index of the next text boundary or DONE if all  boundaries have been returned. Equivalent to next(1).

 previous

  public abstract int previous()

 Return the boundary preceding the current boundary.

Returns:

 The character index of the previous text boundary or DONE if all  boundaries have been returned.

 following

  public abstract int following(int offset)

 Return the first boundary following the specified offset.  The value returned is always greater than the offset or  the value BreakIterator.DONE

Parameters:

 offset - the offset to begin scanning. Valid values  are determined by the CharacterIterator passed to  setText(). Invalid values cause  an IllegalArgumentException to be thrown.

Returns:

 The first boundary after the specified offset.

 current

  public abstract int current()

 Return character index of the text boundary that was most recently  returned by next(), previous(), first(), or last()

Returns:

 The boundary most recently returned.

 getText

  public abstract CharacterIterator getText()

 Get the text being scanned

Returns:

 the text being scanned

 setText

  public void setText(String newText)

 Set a new text string to be scanned. The current scan  position is reset to first().

Parameters:

 newText - new text to scan.

 setText

  public abstract void setText(CharacterIterator newText)

 Set a new text for scanning. The current scan  position is reset to first().

Parameters:

 newText - new text to scan.

 getWordInstance

  public static BreakIterator getWordInstance()

 Create BreakIterator for word-breaks using default locale.  Returns an instance of a BreakIterator implementing word breaks.  WordBreak is usefull for word selection (ex. double click)

Returns:

 A BreakIterator for word-breaks

See Also:

getDefault

 getWordInstance

  public static BreakIterator getWordInstance(Locale where)

 Create BreakIterator for word-breaks using default locale.  Returns an instance of a BreakIterator implementing word breaks.  WordBreak is usefull for word selection (ex. double click)

Parameters:

 where - the local. If a specific WordBreak is not  avaliable for the specified local, a default WordBreak is returned.

Returns:

 A BreakIterator for word-breaks

 getLineInstance

  public static BreakIterator getLineInstance()

 Create BreakIterator for line-breaks using default locale.  Returns an instance of a BreakIterator implementing line breaks. Line  breaks are logically possible line breaks, actual line breaks are  usually determined based on display width.  LineBreak is usefull for word wrapping text.

Returns:

 A BreakIterator for line-breaks

See Also:

getDefault

 getLineInstance

  public static BreakIterator getLineInstance(Locale where)

 Create BreakIterator for line-breaks using default locale.  Returns an instance of a BreakIterator implementing line breaks. Line  breaks are logically possible line breaks, actual line breaks are  usually determined based on display width.  LineBreak is usefull for word wrapping text.

Parameters:

 where - the local. If a specific LineBreak is not  avaliable for the specified local, a default LineBreak is returned.

Returns:

 A BreakIterator for line-breaks

 getCharacterInstance

  public static BreakIterator getCharacterInstance()

 Create BreakIterator for character-breaks using default locale  Returns an instance of a BreakIterator implementing character breaks.  Character breaks are boundaries of combining character sequences.

Returns:

 A BreakIterator for character-breaks

See Also:

getDefault

 getCharacterInstance

  public static BreakIterator getCharacterInstance(Locale where)

 Create BreakIterator for character-breaks using specified locale  Returns an instance of a BreakIterator implementing character breaks.  Character breaks are boundaries of combining character sequences.

Parameters:

 where - the local. If a specific character break is not  avaliable for the specified local, a default character break is returned.

Returns:

 A BreakIterator for character-breaks

 getSentenceInstance

  public static BreakIterator getSentenceInstance()

 Create BreakIterator for sentence-breaks using default locale  Returns an instance of a BreakIterator implementing sentence breaks.

Returns:

 A BreakIterator for sentence-breaks

See Also:

getDefault

 getSentenceInstance

  public static BreakIterator getSentenceInstance(Locale where)

 Create BreakIterator for sentence-breaks using specified locale  Returns an instance of a BreakIterator implementing sentence breaks.

Parameters:

 where - the local. If a specific SentenceBreak is not  avaliable for the specified local, a default SentenceBreak is returned.

Returns:

 A BreakIterator for sentence-breaks

 getAvailableLocales

  public static synchronized Locale[] getAvailableLocales()

 Get the set of Locales for which TextBoundaries are installed

Returns:

 available locales

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.text.CharacterIterator

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Interface java.text.CharacterIterator

 public interface CharacterIterator

 extends Cloneable

This interface defines a protocol for bidirectional iteration over text.  The iterator iterates over a bounded sequence of characters. Characters  are indexed with values beginning with the value returned by getBeginIndex and  continuing through the value returned by getEndIndex()-1. The index of the  current character can be retrieved by calling getIndex. Calling setIndex  will move the iterator to a new position within the sequence of characters.  If at any time the iterator's current index moves outside the range of  getBeginIndex and getEndIndex, previous() and next() will return DONE, signaling that  the iterator has reached the end of the sequence.

Examples:

 Traverse the text from start to finish

 public void traverseForward(CharacterIterator iter) {
     for(char c = iter.first(); c != CharacterIterator.DONE; c = iter.next()) {
         processChar(c);
     }
 }

 Traverse the text backwards, from end to start

 public void traverseBackward(CharacterIterator iter) {
     for(char c = iter.last(); c != CharacterIterator.DONE; c = iter.prev()) {
         processChar(c);
     }
 }

 Traverse both forward and backward from a given position in the text.  Calls to notBoundary() in this example represents some  additional stopping criteria.

 public void traverseOut(CharacterIterator iter, int pos) {
     for (char c = iter.setIndex(pos);
          c != CharacterIterator.DONE && notBoundary(c);
          c = iter.next()) {}
 int end = iter.getIndex();
 for (char c = iter.setIndex(pos);
     c != CharacterIterator.DONE && notBoundary(c);
     c = iter.prev()) {}
 int start = iter.getIndex();
 processSection(start,end);
 }

See Also:

StringCharacterIterator

______________________________________________________________________________

 	DONE

 Constant that is returned when the iterator has reached either the end  or the beginning of the text.

 	clone()

 Create a copy of this iterator

 	current()

 Get the character at the current position (as returned by getIndex()).

 	first()

 Set the position to getBeginIndex() and return the character at that  position.

 	getBeginIndex()

 Return the start index of the text.

 	getEndIndex()

 Return the end index of the text.

 	getIndex()

 Return the current index.

 	last()

 Set the position to getEndIndex()-1, return the character at that position.

 	next()

 Increment the iterator's index by one and return the character  at the new index.

 	previous()

 Decrement the iterator's index by one and return the character  at the new index.

 	setIndex(int)

 Set the position to the specified position in the text and return that  character.

 DONE

  public final static char DONE

 Constant that is returned when the iterator has reached either the end  or the beginning of the text. The unicode 2.0 standard states that  '\\uFFFF' is an invalid unicode value and should not occur in any valid  unicode string.

 first

  public abstract char first()

 Set the position to getBeginIndex() and return the character at that  position.

Returns:

 the first character in the text

See Also:

 getBeginIndex

 last

  public abstract char last()

 Set the position to getEndIndex()-1, return the character at that position.

Returns:

 the last character in the text

See Also:

 getEndIndex

 current

  public abstract char current()

 Get the character at the current position (as returned by getIndex()).

Returns:

 the character at the current position or DONE if the current  position is off the end of the text.

See Also:

 getIndex

 next

  public abstract char next()

 Increment the iterator's index by one and return the character  at the new index. If the resulting index is greater or equal  to getEndIndex(), the current index is reset to getEndIndex() and  a value of DONE is returned.

Returns:

 the character at the new position or DONE if the current  position is off the end of the text.

 previous

  public abstract char previous()

 Decrement the iterator's index by one and return the character  at the new index. If the resulting index is  less than getBeginIndex(), the current index is reset to getBeginIndex()  and a value of DONE is returned.

Returns:

 the character at the new position or DONE if the current  position is off the end of the text.

 setIndex

  public abstract char setIndex(int position)

 Set the position to the specified position in the text and return that  character.

Parameters:

 position - the position within the text. Valid values range from  getBeginIndex() to getEndIndex() - 1. An IllegalArgumentException is thrown  if an invalid value is supplied.

Returns:

 the character at the specified position.

 getBeginIndex

  public abstract int getBeginIndex()

 Return the start index of the text.

Returns:

 the index at which the text begins.

 getEndIndex

  public abstract int getEndIndex()

 Return the end index of the text. This index is the index of the first  character following the end of the text.

Returns:

 the index at which the text end.

 getIndex

  public abstract int getIndex()

 Return the current index.

Returns:

 the current index.

 clone

  public abstract Object clone()

 Create a copy of this iterator

Returns:

 A copy of this

Overrides:

clone in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.text.ChoiceFormat

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.text.ChoiceFormat

java.lang.Object
   |
   +----java.text.Format
           |
           +----java.text.NumberFormat
                   |
                   +----java.text.ChoiceFormat

______________________________________________________________________________

 public class ChoiceFormat

 extends NumberFormat

A ChoiceFormat allows you to attach a format to a range of numbers.  It is generally used in a MessageFormat for handling plurals.  The choice is specified with an ascending list of doubles, where each item  specifies a half-open interval up to the next item:

 X matches j if and only if limit[j]

 If there is no match, then either the first or last index is used, depending
 on whether the number (X) is too low or too high.

 Note:
 ChoiceFormat differs from the other Format
 classes in that you create a ChoiceFormat object with a
 constructor (not with a getInstance style factory
 method). The factory methods aren't necessary because ChoiceFormat
 doesn't require any complex setup for a given locale. In fact,
 ChoiceFormat doesn't implement any locale specific behavior.

 When creating a ChoiceFormat, you must specify an array of formats
 and an array of limits. The length of these arrays must be the same.
 For example,

•
     limits = {1,2,3,4,5,6,7}

     formats = {"Sun","Mon","Tue","Wed","Thur","Fri","Sat"}

     limits = {0, 1, ChoiceFormat.nextDouble(1)}

     formats = {"no files", "one file", "many files"}

     (nextDouble can be used to get the next higher double, to
     make the half-open interval.)

 Here is a simple example that shows formatting and parsing:

 double[] limits = {1,2,3,4,5,6,7};
 String[] monthNames = {"Sun","Mon","Tue","Wed","Thur","Fri","Sat"};
 ChoiceFormat form = new ChoiceFormat(limits, monthNames);
 ParsePosition status = new ParsePosition(0);
 for (double i = 0.0; i

 Here is a more complex example, with a pattern format:

 double[] filelimits = {0,1,2};
 String[] filepart = {"are no files","is one file","are {2} files"};
 ChoiceFormat fileform = new ChoiceFormat(filelimits, filepart);
 Format[] testFormats = {fileform, null, NumberFormat.getInstance()};
 MessageFormat pattform = new MessageFormat("There {0} on {1}");
 pattform.setFormats(testFormats);
 Object[] testArgs = {null, "ADisk", null};
 for (int i = 0; i

 See Also:

 DecimalFormat, MessageFormat

______________________________________________________________________________

        ChoiceFormat(double[], String[])

  Constructs with the limits and the corresponding formats.

        ChoiceFormat(String)

  Constructs with limits and corresponding formats based on the pattern.

        applyPattern(String)

  Sets the pattern.

        clone()

  Overrides Cloneable

        equals(Object)

  Equality comparision between two

        format(double, StringBuffer, FieldPosition)

  Specialization of format.

        format(long, StringBuffer, FieldPosition)

  Specialization of format.

        getFormats()

  Get the formats passed in the constructor.

        getLimits()

  Get the limits passed in the constructor.

        hashCode()

  Generates a hash code for the message format object.

        nextDouble(double)

  Finds the least double greater than d.

        nextDouble(double, boolean)

        parse(String, ParsePosition)

  Returns a Long if possible (e.g.

        previousDouble(double)

  Finds the greatest double less than d.

        setChoices(double[], String[])

  Set the choices to be used in formatting.

        toPattern()

  Gets the pattern.

ChoiceFormat

  public ChoiceFormat(String newPattern)

 Constructs with limits and corresponding formats based on the pattern.

ChoiceFormat

  public ChoiceFormat(double limits[],
                      String formats[])

 Constructs with the limits and the corresponding formats.

 See Also:

 setChoices

applyPattern

  public void applyPattern(String newPattern)

 Sets the pattern.

 Parameters:

 newPattern - See the class description.

toPattern

  public String toPattern()

 Gets the pattern.

setChoices

  public void setChoices(double limits[],
                         String formats[])

 Set the choices to be used in formatting.

 Parameters:

 limits - contains the top value that you want
 parsed with that format,and should be in ascending sorted order. When
 formatting X, the choice will be the i, where limit[i]  formats - are the formats you want to use for each limit.
 They can be either Format objects or Strings.
 When formatting with object Y,
 if the object is a NumberFormat, then ((NumberFormat) Y).format(X)
 is called. Otherwise Y.toString() is called.

getLimits

  public double[] getLimits()

 Get the limits passed in the constructor.

 Returns:

 the limits.

getFormats

  public Object[] getFormats()

 Get the formats passed in the constructor.

 Returns:

 the formats.

format

  public StringBuffer format(long number,
                             StringBuffer toAppendTo,
                             FieldPosition status)

 Specialization of format. This method really calls
 format(double, StringBuffer, FieldPosition)
 thus the range of longs that are supported is only equal to
 the range that can be stored by double. This will never be
 a practical limitation.

 Overrides:

 format in class NumberFormat

format

  public StringBuffer format(double number,
                             StringBuffer toAppendTo,
                             FieldPosition status)

 Specialization of format.

 Overrides:

 format in class NumberFormat

parse

  public Number parse(String text,
                      ParsePosition status)

 Returns a Long if possible (e.g.

 Overrides:

 parse in class NumberFormat

nextDouble

  public final static double nextDouble(double d)

 Finds the least double greater than d.
 If NaN, returns same value.

Used to make half-open intervals.

 See Also:

 previousDouble

previousDouble

  public final static double previousDouble(double d)

 Finds the greatest double less than d.
 If NaN, returns same value.

 See Also:

 nextDouble

clone

  public Object clone()

 Overrides Cloneable

 Overrides:

 clone in class NumberFormat

hashCode

  public int hashCode()

 Generates a hash code for the message format object.

 Overrides:

 hashCode in class NumberFormat

equals

  public boolean equals(Object obj)

 Equality comparision between two

 Overrides:

 equals in class NumberFormat

nextDouble

  public static double nextDouble(double d,
                                  boolean positive)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.text.CollationElementIterator

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.text.CollationElementIterator

java.lang.Object
   |
   +----java.text.CollationElementIterator

______________________________________________________________________________

 public final class CollationElementIterator

 extends Object

The CollationElementIterator class is used as an iterator  to walk through each character of an international string. Use the iterator  to return the ordering priority of the positioned character. The ordering  priority of a character, which we refer to as a key, defines how a character  is collated in the given collation object.

 For example, consider the following in Spanish:

 "ca" -> the first key is key('c') and second key is key('a').
 "cha" -> the first key is key('ch') and second key is key('a').

 And in German,

 "äb"-> the first key is key('a'), the second key is key('e'), and
 the third key is key('b').

 The key of a character is an integer composed of primary order(short),  secondary order(byte), and tertiary order(byte). Java strictly defines  the size and signedness of its primitive data types. Therefore, the static  functions primaryOrder, secondaryOrder, and  tertiaryOrder return int, short,  and short respectively to ensure the correctness of the key  value.

 Example of the iterator usage,

 // get the first key of the string
 String str = "This is a test";
 CollationElementIterator c =
     new CollationElementIterator(str, 0, str.length(),
                                  Collator.getInstance());
 int primaryOrder = CollationElementIterator.primaryOrder(c->next());

CollationElementIterator.next returns the collation order  of the next character. A collation order consists of primary order,  secondary order and tertiary order. The data type of the collation  order is int . The first 16 bits of a collation order  is its primary order; the next 8 bits is the secondary order and the  last 8 bits is the tertiary order.

See Also:

Collator, RuleBasedCollator

______________________________________________________________________________

 	NULLORDER

 Null order which indicates the end of string is reached by the  cursor.

 	next()

 Get the ordering priority of the next character in the string.

 	primaryOrder(int)

 Get the primary order of a collation order.

 	reset()

 Resets the cursor to the beginning of the string.

 	secondaryOrder(int)

 Get the secondary order of a collation order.

 	tertiaryOrder(int)

 Get the tertiary order of a collation order.

 NULLORDER

  public final static int NULLORDER

 Null order which indicates the end of string is reached by the  cursor.

 reset

  public void reset()

 Resets the cursor to the beginning of the string.

 next

  public int next()

 Get the ordering priority of the next character in the string.

Returns:

 the next character's ordering. Returns NULLORDER if  the end of string is reached.

 primaryOrder

  public final static int primaryOrder(int order)

 Get the primary order of a collation order.

Parameters:

 order - the collation order

Returns:

 the primary order of a collation order.

 secondaryOrder

  public final static short secondaryOrder(int order)

 Get the secondary order of a collation order.

Parameters:

 order - the collation order

Returns:

 the secondary order of a collation order.

 tertiaryOrder

  public final static short tertiaryOrder(int order)

 Get the tertiary order of a collation order.

Parameters:

 order - the collation order

Returns:

 the tertiary order of a collation order.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.text.CollationKey

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.text.CollationKey

java.lang.Object
   |
   +----java.text.CollationKey

______________________________________________________________________________

 public final class CollationKey

 extends Object

A CollationKey represents a String under the  rules of a specific Collator object. Comparing two  CollationKey s returns the relative order of the  Strings they represent. Using CollationKeys  to compare Strings is generally faster than using  Collator.compare. Thus, when the Strings  must be compared multiple times, for example when sorting a list  of String s. It's more efficient to use CollationKeys.

 You can not create CollationKeys directly. Rather,  generate them by calling Collator.getCollationKey.  You can only compare CollationKey s generated from  the same Collator object.

 Generating a CollationKey for a String  involves examining the entire String  and converting it to series of bits that can be compared bitwise. This  allows fast comparisons once the keys are generated. The cost of generating  keys is recouped in faster comparisons when Strings need  to be compared many times. On the other hand, the result of a comparison  is often determined by the first couple of characters of each String.  Collator.compare examines only as many characters as it needs which  allows it to be faster when doing single comparisons.

 The following example shows how CollationKeys might be used  to sort a list of Strings.

 // Create an array of CollationKeys for the Strings to be sorted.
 Collator myCollator = Collator.getInstance();
 CollationKey[] keys = new CollationKey[3];
 keys[0] = myCollator.getCollationKey("Tom");
 keys[1] = myCollator.getCollationKey("Dick");
 keys[2] = myCollator.getCollationKey("Harry");
 sort( keys );

 //...

 // Inside body of sort routine, compare keys this way
 if( keys[i].compareTo( keys[j] ) > 0 )
    // swap keys[i] and keys[j]

 //...

 // Finally, when we've returned from sort.
 System.out.println( keys[0].getSourceString() );
 System.out.println( keys[1].getSourceString() );
 System.out.println( keys[2].getSourceString() );

See Also:

Collator, RuleBasedCollator

______________________________________________________________________________

 	compareTo(CollationKey)

 Compare this CollationKey to the target CollationKey.

 	equals(Object)

 Compare this CollationKey and the target CollationKey for equality.

 	getSourceString()

 Returns the String that this CollationKey represents.

 	hashCode()

 Creates a hash code for this CollationKey.

 	toByteArray()

 Converts the CollationKey to a sequence of bits.

 compareTo

  public int compareTo(CollationKey target)

 Compare this CollationKey to the target CollationKey. The collation rules of the  Collator object which created these keys are applied. Note:  CollationKeys created by different Collators can not be compared.

Parameters:

 target - target CollationKey

Returns:

 Returns an integer value. Value is less than zero if this is less  than target, value is zero if this and target are equal and value is greater than  zero if this is greater than target.

See Also:

compare

 equals

  public boolean equals(Object target)

 Compare this CollationKey and the target CollationKey for equality.  The collation rules of the Collator object which created these keys are applied.  Note: CollationKeys created by different Collators can not be  compared.

Parameters:

 target - the CollationKey to compare to.

Returns:

 Returns true if two objects are equal, false otherwise.

Overrides:

equals in class Object

 hashCode

  public int hashCode()

 Creates a hash code for this CollationKey. The hash value is calculated on the  key itself, not the String from which the key was created. Thus  if x and y are CollationKeys, then x.hashCode(x) == y.hashCode() if  x.equals(y) is true. This allows language-sensitive comparison in a hash table.  See the CollatinKey class description for an example.

Returns:

 the hash value based on the string's collation order.

Overrides:

hashCode in class Object

 getSourceString

  public String getSourceString()

 Returns the String that this CollationKey represents.

 toByteArray

  public byte[] toByteArray()

 Converts the CollationKey to a sequence of bits. If two CollationKeys  could be legitimately compared, then one could compare the byte arrays  for each of those keys to obtain the same result. Byte arrays are  organized most significant byte first.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.text.Collator

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.text.Collator

java.lang.Object
   |
   +----java.text.Collator

______________________________________________________________________________

 public class Collator

 extends Object

 implements Cloneable, Serializable

The Collator class performs locale-sensitive  String  comparison. You use this class to build  searching and sorting routines for natural language text.

Collator is an abstract base class. Subclasses  implement specific collation strategies. One subclass,  RuleBasedCollator , is currently provided with  the JDK and is applicable to a wide set of languages. Other  subclasses may be created to handle more specialized needs.

 Like other locale-sensitive classes, you can use the static  factory method, getInstance, to obtain the appropriate  Collator  object for a given locale. You will only need  to look at the subclasses of Collator  if you need  to understand the details of a particular collation strategy or  if you need to modify that strategy.

 The following example shows how to compare two strings using  the Collator  for the default locale.

 // Compare two strings in the default locale
 Collator myCollator = Collator.getInstance();
 if( myCollator.compare("abc", "ABC")

 You can set a Collator's strength property
 to determine the level of difference considered significant in
 comparisons. Four strengths are provided: PRIMARY,
 SECONDARY, TERTIARY, and IDENTICAL.
 The exact assignment of strengths to language features is
 locale dependant.  For example, in Czech, "e" and "f" are considered
 primary differences, while "e" and "ê" are secondary differences,
 "e" and "E" are tertiary differences and "e" and "e" are identical.
 The following shows how both case and accents could be ignored for
 US English.

 //Get the Collator for US English and set its strength to PRIMARY
 Collator usCollator = Collator.getInstance(Locale.US);
 usCollator.setStrength(Collator.PRIMARY);
 if( usCollator.compare("abc", "ABC") == 0 ) {
     System.out.println("Strings are equivalent");
 }

 For comparing Strings exactly once, the compare
 method provides the best performance. When sorting a list of
 Strings however, it is generally necessary to compare each
 String multiple times. In this case, CollationKeys
 provide better performance. The CollationKey class converts
 a String to a series of bits that can be compared bitwise
 against other CollationKeys. A CollationKey is
 created by a Collator object for a given String.

 Note: CollationKeys from different
 Collators can not be compared. See the class description
 for CollationKey
 for an example using CollationKeys.

 See Also:

 RuleBasedCollator, CollationKey, CollationElementIterator, Locale

______________________________________________________________________________

        CANONICAL_DECOMPOSITION

  Decomposition mode value.

        FULL_DECOMPOSITION

  Decomposition mode value.

        IDENTICAL

  Collator strength value.

        NO_DECOMPOSITION

  Decomposition mode value.

        PRIMARY

  Collator strength value.

        SECONDARY

  Collator strength value.

        TERTIARY

  Collator strength value.

        Collator()

  Default constructor.

        clone()

  Overrides Cloneable

        compare(String, String)

  Compares the source string to the target string according to the
 collation rules for this Collator.

        equals(Object)

  Compares the equality of two Collators.

        equals(String, String)

  Convenience method for comparing the equality of two strings based on
 this Collator's collation rules.

        getAvailableLocales()

  Get the set of Locales for which Collators are installed.

        getCollationKey(String)

  Transforms the String into a series of bits that can be compared bitwise
 to other CollationKeys.

        getDecomposition()

  Get the decomposition mode of this Collator.

        getInstance()

  Gets the Collator for the current default locale.

        getInstance(Locale)

  Gets the Collator for the desired locale.

        getStrength()

  Returns this Collator's strength property.

        hashCode()

  Generates the hash code for this Collator.

        setDecomposition(int)

  Set the decomposition mode of this Collator.

        setStrength(int)

  Sets this Collator's strength property.

PRIMARY

  public final static int PRIMARY

 Collator strength value.  When set, only PRIMARY differences are
 considered significant during comparison. The assignment of strengths
 to language features is locale dependant. A common example is for
 different base letters ("a" vs "b") to be considered a PRIMARY difference.

 See Also:

 setStrength, getStrength

SECONDARY

  public final static int SECONDARY

 Collator strength value.  When set, only SECONDARY and above differences are
 considered significant during comparison. The assignment of strengths
 to language features is locale dependant. A common example is for
 different accented forms of the same base letter ("a" vs "ä") to be
 considered a SECONDARY difference.

 See Also:

 setStrength, getStrength

TERTIARY

  public final static int TERTIARY

 Collator strength value.  When set, only TERTIARY and above differences are
 considered significant during comparison. The assignment of strengths
 to language features is locale dependant. A common example is for
 case differences ("a" vs "A") to be considered a TERTIARY difference.

 See Also:

 setStrength, getStrength

IDENTICAL

  public final static int IDENTICAL

 Collator strength value.  When set, all differences are
 considered significant during comparison. The assignment of strengths
 to language features is locale dependant. A common example is for characters
 with equivalent Unicode spellings ("ä" vs "a?") to be considered IDENTICAL.

NO_DECOMPOSITION

  public final static int NO_DECOMPOSITION

 Decomposition mode value. With NO_DECOMPOSITION
 set, accented characters will not be decomposed for collation. This
 provides the fastest collation but will only produce correct results
 for languages that do not use accents.

 See Also:

 getDecomposition, setDecomposition

CANONICAL_DECOMPOSITION

  public final static int CANONICAL_DECOMPOSITION

 Decomposition mode value. With CANONICAL_DECOMPOSITION
 set, characters that are canonical variants according to Unicode 2.0
 will be decomposed for collation. This is the default setting and
 should be used to get correct collation of accented characters.

 See Also:

 getDecomposition, setDecomposition

FULL_DECOMPOSITION

  public final static int FULL_DECOMPOSITION

 Decomposition mode value. With FULL_DECOMPOSITION
 set, both Unicode canonical variants and Unicode compatibility variants
 will be decomposed for collation.  This causes not only accented
 characters to be collated, but also characters that have special formats
 to be collated with their norminal form. For example, the half-width and
 full-width ASCII and Katakana characters are then collated together.
 FULL_DECOMPOSITION is the most complete and therefore the slowest
 decomposition mode.

 See Also:

 getDecomposition, setDecomposition

Collator

  protected Collator()

 Default constructor.  This constructor is
 protected so subclasses can get access to it. Users typically create
 a Collator sub-class by calling the factory method getInstance.

 See Also:

 getInstance

getInstance

  public static synchronized Collator getInstance()

 Gets the Collator for the current default locale.
 The default locale is determined by java.util.Locale.getDefault.

 Returns:

 the Collator for the default locale.(for example, en_US)

 See Also:

 getDefault

getInstance

  public static synchronized Collator getInstance(Locale desiredLocale)

 Gets the Collator for the desired locale.

 Parameters:

 desiredLocale - the desired locale.

 Returns:

 the Collator for the desired locale.

 See Also:

 Locale, ResourceBundle

compare

  public abstract int compare(String source,
                              String target)

 Compares the source string to the target string according to the
 collation rules for this Collator.  Returns an integer less than,
 equal to or greater than zero depending on whether the source String is
 less than, equal to or greater than the target string.  See the Collator
 class description for an example of use.

 For a one time comparison, this method has the best performance. If a
 given String will be involved in multiple comparisons, CollationKey.compareTo
 has the best performance. See the Collator class description for an example
 using CollationKeys.

 Parameters:

 source - the source string.

 target - the target string.

 Returns:

 Returns an integer value. Value is less than zero if source is less than
 target, value is zero if source and target are equal, value is greater than zero
 if source is greater than target.

 See Also:

 CollationKey, getCollationKey

getCollationKey

  public abstract CollationKey getCollationKey(String source)

 Transforms the String into a series of bits that can be compared bitwise
 to other CollationKeys. CollationKeys provide better performance than
 Collator.compare when Strings are involved in multiple comparisons.
 See the Collator class description for an example using CollationKeys.

 Parameters:

 source - the string to be transformed into a collation key.

 Returns:

 the CollationKey for the given String based on this Collator's collation
 rules. If the source String is null, a null CollationKey is returned.

 See Also:

 CollationKey, compare

equals

  public boolean equals(String source,
                        String target)

 Convenience method for comparing the equality of two strings based on
 this Collator's collation rules.

 Parameters:

 source - the source string to be compared with.

 target - the target string to be compared with.

 Returns:

 true if the strings are equal according to the collation
 rules.  false, otherwise.

 See Also:

 compare

getStrength

  public synchronized int getStrength()

 Returns this Collator's strength property.  The strength property determines
 the minimum level of difference considered significant during comparison.
 See the Collator class description for an example of use.

 Returns:

 this Collator's current strength property.

 See Also:

 setStrength, PRIMARY, SECONDARY, TERTIARY, IDENTICAL

setStrength

  public synchronized void setStrength(int newStrength)

 Sets this Collator's strength property.  The strength property determines
 the minimum level of difference considered significant during comparison.
 See the Collator class description for an example of use.

 Parameters:

 the - new strength value.

 Throws: IllegalArgumentException

 If the new strength value is not one of
 PRIMARY, SECONDARY, TERTIARY or IDENTICAL.

 See Also:

 getStrength, PRIMARY, SECONDARY, TERTIARY, IDENTICAL

getDecomposition

  public synchronized int getDecomposition()

 Get the decomposition mode of this Collator. Decomposition mode
 determines how Unicode composed characters are handled. Adjusting
 decomposition mode allows the user to select between faster and more
 complete collation behavior.

The three values for decomposition mode are:

• NO_DECOMPOSITION,

• CANONICAL_DECOMPOSITION

• FULL_DECOMPOSITION.

 See the documentation for these three constants for a description
 of their meaning.

 Returns:

 the decomposition mode

 See Also:

 setDecomposition, NO_DECOMPOSITION, CANONICAL_DECOMPOSITION, FULL_DECOMPOSITION

setDecomposition

  public synchronized void setDecomposition(int decompositionMode)

 Set the decomposition mode of this Collator. See getDecomposition
 for a description of decomposition mode.

 Parameters:

 the - new decomposition mode

 Throws: IllegalArgumentException

 If the given value is not a valid decomposition
 mode.

 See Also:

 getDecomposition, NO_DECOMPOSITION, CANONICAL_DECOMPOSITION, FULL_DECOMPOSITION

getAvailableLocales

  public static synchronized Locale[] getAvailableLocales()

 Get the set of Locales for which Collators are installed.

 Returns:

 the list of available locales which collators are installed.

clone

  public Object clone()

 Overrides Cloneable

 Overrides:

 clone in class Object

equals

  public boolean equals(Object that)

 Compares the equality of two Collators.

 Parameters:

 that - the Collator to be compared with this.

 Returns:

 true if this Collator is the same as that Collator;
 false otherwise.

 Overrides:

 equals in class Object

hashCode

  public synchronized abstract int hashCode()

 Generates the hash code for this Collator.

 Overrides:

 hashCode in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.text.DateFormat

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.text.DateFormat

java.lang.Object
   |
   +----java.text.Format
           |
           +----java.text.DateFormat

______________________________________________________________________________

 public class DateFormat

 extends Format

 implements Cloneable

DateFormat is an abstract base class  that defines the programming interface for formatting  and parsing a date or time in a locale-sensitive manner.

 Subclasses of DateFormat, such as  SimpleDateFormat, allow for  formatting (millis -> text), parsing (text -> millis),  and normalization.

DateFormat provides many class methods for  obtaining default date/time formatters based on the default  locale or a specified locale and a number of formatting styles.  The formatting styles include FULL, LONG,  MEDIUM, and SHORT.  More detail and examples of using these styles are provided  in the method descriptions.

DateFormat helps you to format and parse dates  for any locale. Your code can be completely independent of the  locale conventions for months, days of the week, or even the  calendar format (lunar vs. solar).

 To format a date for the current locale, use one of the  class getXxxxxInstance  methods or the  getInstance method. For example,

 myString = DateFormat.getDateInstance().format(myDate);

 If you are formatting multiple numbers, it is  more efficient to get the format and use it multiple  times so that the system doesn't have to fetch the  information about the local language and country  conventions multiple times.

  DateFormat df = DateFormat.getDateInstance();
  for (int i = 0; i

 To format a number for a different locale, specify it in the
 call to getXxxxxInstance or getInstance.

 DateFormat df = DateFormat.getDateInstance(Locale.FRANCE);

 You can use a DateInstance to parse also.

 myDate = df.parse(myString);

 Use getDateInstance to get the normal date format for that country.
 Use getTimeInstance to get the time format for that country.
 Use getDateTimeInstance to get a date and time format. You
 can pass in different options to these methods to control the length
 of the result; from SHORT to MEDIUM to
 LONG to FULL. The exact result depends
 on the locale, but generally:

• SHORT is completely numeric, such as 12.13.52 or 3:30pm

• MEDIUM is longer, such as Jan 12, 1952

• LONG is longer, such as January 12, 1952 or 3:30:32pm

• FULL is pretty completely specified, such as
 Tuesday, April 12, 1952 AD or 3:30:42pm PST.

 You can also set the time zone on the format if you wish.
 If you want even more control over the format or parsing,
 (or want to give your users more control),
 you can try casting the DateFormat you get from the
 factory methods to a SimpleDateFormat. This will
 work for the majority of countries; just remember to put it in
 a try block in case you encounter an unusual one.

 You can also use forms of the parse and format
 methods with ParsePosition and FieldPosition to
 allow you to

• progressively parse through pieces of a string.

• align any particular field, or find out where it is for selection
 on the screen.

 See Also:

 Format, NumberFormat, SimpleDateFormat, Calendar, GregorianCalendar, TimeZone

______________________________________________________________________________

        AM_PM_FIELD

  Useful constant for AM_PM field alignment.

        calendar

  The calendar that DateFormat uses to produce the time field values
 needed to implement date/time formatting.

        DATE_FIELD

  Useful constant for DATE field alignment.

        DAY_OF_WEEK_FIELD

  Useful constant for DAY_OF_WEEK field alignment.

        DAY_OF_WEEK_IN_MONTH_FIELD

  Useful constant for DAY_OF_WEEK_IN_MONTH field alignment.

        DAY_OF_YEAR_FIELD

  Useful constant for DAY_OF_YEAR field alignment.

        DEFAULT

  Constant for default style pattern.

        ERA_FIELD

  Useful constant for ERA field alignment.

        FULL

  Constant for full style pattern.

        HOUR0_FIELD

  Useful constant for zero-based HOUR field alignment.

        HOUR1_FIELD

  Useful constant for one-based HOUR field alignment.

        HOUR_OF_DAY0_FIELD

  Useful constant for zero-based HOUR_OF_DAY field alignment.

        HOUR_OF_DAY1_FIELD

  Useful constant for one-based HOUR_OF_DAY field alignment.

        LONG

  Constant for long style pattern.

        MEDIUM

  Constant for medium style pattern.

        MILLISECOND_FIELD

  Useful constant for MILLISECOND field alignment.

        MINUTE_FIELD

  Useful constant for MINUTE field alignment.

        MONTH_FIELD

  Useful constant for MONTH field alignment.

        numberFormat

  The number formatter that DateFormat uses to format numbers in dates
 and times.

        SECOND_FIELD

  Useful constant for SECOND field alignment.

        SHORT

  Constant for short style pattern.

        TIMEZONE_FIELD

  Useful constant for TIMEZONE field alignment.

        WEEK_OF_MONTH_FIELD

  Useful constant for WEEK_OF_MONTH field alignment.

        WEEK_OF_YEAR_FIELD

  Useful constant for WEEK_OF_YEAR field alignment.

        YEAR_FIELD

  Useful constant for YEAR field alignment.

        DateFormat()

        clone()

  Overrides Cloneable

        equals(Object)

  Overrides equals

        format(Date)

  Formats a Date into a date/time string.

        format(Date, StringBuffer, FieldPosition)

  Formats a Date into a date/time string.

        format(Object, StringBuffer, FieldPosition)

  Overrides Format.

        getAvailableLocales()

  Gets the set of locales for which DateFormats are installed.

        getCalendar()

  Gets the calendar associated with this date/time formatter.

        getDateInstance()

  Gets the date formatter with the default formatting style
 for the default locale.

        getDateInstance(int)

  Gets the date formatter with the given formatting style
 for the default locale.

        getDateInstance(int, Locale)

  Gets the date formatter with the given formatting style
 for the given locale.

        getDateTimeInstance()

  Gets the date/time formatter with the default formatting style
 for the default locale.

        getDateTimeInstance(int, int)

  Gets the date/time formatter with the given date and time
 formatting styles for the default locale.

        getDateTimeInstance(int, int, Locale)

  Gets the date/time formatter with the given formatting styles
 for the given locale.

        getInstance()

  Get a default date/time formatter that uses the SHORT style for both the
 date and the time.

        getNumberInstance()

  Gets the number formatter which this date/time formatter uses to
 format and parse a time.

        getTimeInstance()

  Gets the time formatter with the default formatting style
 for the default locale.

        getTimeInstance(int)

  Gets the time formatter with the given formatting style
 for the default locale.

        getTimeInstance(int, Locale)

  Gets the time formatter with the given formatting style
 for the given locale.

        getTimeZone()

  Gets the time zone.

        hashCode()

  Overrides hashCode

        isLenient()

  Tell whether date/time parsing is to be lenient.

        parse(String)

  Parse a date/time string.

        parse(String, ParsePosition)

  Parse a date/time string according to the given parse position.

        parseObject(String, ParsePosition)

  Parse a date/time string into an Object.

        setCalendar(Calendar)

  Set the calendar to be used by this date format.

        setLenient(boolean)

  Specify whether or not date/time parsing is to be lenient.

        setNumberFormat(NumberFormat)

  Allows you to set the number formatter.

        setTimeZone(TimeZone)

  Sets the time zone for the calendar of this DateFormat object.

calendar

  protected Calendar calendar

 The calendar that DateFormat uses to produce the time field values
 needed to implement date/time formatting.  Subclasses should initialize
 this to the default calendar for the locale associated with this
 DateFormat.

numberFormat

  protected NumberFormat numberFormat

 The number formatter that DateFormat uses to format numbers in dates
 and times.  Subclasses should initialize this to the default number
 format for the locale associated with this DateFormat.

ERA_FIELD

  public final static int ERA_FIELD

 Useful constant for ERA field alignment.
 Used in FieldPosition of date/time formatting.

YEAR_FIELD

  public final static int YEAR_FIELD

 Useful constant for YEAR field alignment.
 Used in FieldPosition of date/time formatting.

MONTH_FIELD

  public final static int MONTH_FIELD

 Useful constant for MONTH field alignment.
 Used in FieldPosition of date/time formatting.

DATE_FIELD

  public final static int DATE_FIELD

 Useful constant for DATE field alignment.
 Used in FieldPosition of date/time formatting.

HOUR_OF_DAY1_FIELD

  public final static int HOUR_OF_DAY1_FIELD

 Useful constant for one-based HOUR_OF_DAY field alignment.
 Used in FieldPosition of date/time formatting.
 HOUR_OF_DAY1_FIELD is used for the one-based 24-hour clock.
 For example, 23:59 + 01:00 results in 24:59.

HOUR_OF_DAY0_FIELD

  public final static int HOUR_OF_DAY0_FIELD

 Useful constant for zero-based HOUR_OF_DAY field alignment.
 Used in FieldPosition of date/time formatting.
 HOUR_OF_DAY0_FIELD is used for the zero-based 24-hour clock.
 For example, 23:59 + 01:00 results in 00:59.

MINUTE_FIELD

  public final static int MINUTE_FIELD

 Useful constant for MINUTE field alignment.
 Used in FieldPosition of date/time formatting.

SECOND_FIELD

  public final static int SECOND_FIELD

 Useful constant for SECOND field alignment.
 Used in FieldPosition of date/time formatting.

MILLISECOND_FIELD

  public final static int MILLISECOND_FIELD

 Useful constant for MILLISECOND field alignment.
 Used in FieldPosition of date/time formatting.

DAY_OF_WEEK_FIELD

  public final static int DAY_OF_WEEK_FIELD

 Useful constant for DAY_OF_WEEK field alignment.
 Used in FieldPosition of date/time formatting.

DAY_OF_YEAR_FIELD

  public final static int DAY_OF_YEAR_FIELD

 Useful constant for DAY_OF_YEAR field alignment.
 Used in FieldPosition of date/time formatting.

DAY_OF_WEEK_IN_MONTH_FIELD

  public final static int DAY_OF_WEEK_IN_MONTH_FIELD

 Useful constant for DAY_OF_WEEK_IN_MONTH field alignment.
 Used in FieldPosition of date/time formatting.

WEEK_OF_YEAR_FIELD

  public final static int WEEK_OF_YEAR_FIELD

 Useful constant for WEEK_OF_YEAR field alignment.
 Used in FieldPosition of date/time formatting.

WEEK_OF_MONTH_FIELD

  public final static int WEEK_OF_MONTH_FIELD

 Useful constant for WEEK_OF_MONTH field alignment.
 Used in FieldPosition of date/time formatting.

AM_PM_FIELD

  public final static int AM_PM_FIELD

 Useful constant for AM_PM field alignment.
 Used in FieldPosition of date/time formatting.

HOUR1_FIELD

  public final static int HOUR1_FIELD

 Useful constant for one-based HOUR field alignment.
 Used in FieldPosition of date/time formatting.
 HOUR1_FIELD is used for the one-based 12-hour clock.
 For example, 11:30 PM + 1 hour results in 12:30 AM.

HOUR0_FIELD

  public final static int HOUR0_FIELD

 Useful constant for zero-based HOUR field alignment.
 Used in FieldPosition of date/time formatting.
 HOUR0_FIELD is used for the zero-based 12-hour clock.
 For example, 11:30 PM + 1 hour results in 00:30 AM.

TIMEZONE_FIELD

  public final static int TIMEZONE_FIELD

 Useful constant for TIMEZONE field alignment.
 Used in FieldPosition of date/time formatting.

FULL

  public final static int FULL

 Constant for full style pattern.

LONG

  public final static int LONG

 Constant for long style pattern.

MEDIUM

  public final static int MEDIUM

 Constant for medium style pattern.

SHORT

  public final static int SHORT

 Constant for short style pattern.

DEFAULT

  public final static int DEFAULT

 Constant for default style pattern.

DateFormat

  protected DateFormat()

format

  public final StringBuffer format(Object obj,
                                   StringBuffer toAppendTo,
                                   FieldPosition fieldPosition)

 Overrides Format.
 Formats a time object into a time string. Examples of time objects
 are a time value expressed in milliseconds and a Date object.

 Parameters:

 obj - must be a Number or a Date.

 toAppendTo - the string buffer for the returning time string.

 fieldPosition - the field. On input: an alignment field,
 if desired. On output: the offsets of the alignment field.

 Returns:

 the formatted time string.

 Overrides:

 format in class Format

 See Also:

 Format

format

  public abstract StringBuffer format(Date date,
                                      StringBuffer toAppendTo,
                                      FieldPosition fieldPosition)

 Formats a Date into a date/time string.

 Parameters:

 date - a Date to be formatted into a date/time string.

 toAppendTo - the string buffer for the returning date/time string.

 fieldPosition - the field. On input: an alignment field,
 if desired. On output: the offsets of the alignment field. For
 example, given a time text "1996.07.10 AD at 15:08:56 PDT",
 if the given fieldPosition.field is DateFormat.YEAR_FIELD, the offsets
 fieldPosition.beginIndex and fieldPosition.getEndIndex will be set to 0 and 4,
 respectively. Notice that if the same time field appears
 more than once in a pattern, the fieldPosition will be set for the first
 occurence of that time field. For instance, formatting a Date to
 the time string "1 PM PDT (Pacific Daylight Time)" using the pattern
 "h a z (zzzz)" and the alignment field DateFormat.TIMEZONE_FIELD,
 the offsets fieldPosition.beginIndex and fieldPosition.getEndIndex will be set to
 5 and 8, respectively, for the first occurence of the time zone
 pattern character 'z'.

 Returns:

 the formatted date/time string.

format

  public final String format(Date date)

 Formats a Date into a date/time string.

 Parameters:

 date - the time value to be formatted into a time string.

 Returns:

 the formatted time string.

parse

  public Date parse(String text) throws ParseException

 Parse a date/time string.

 Throws: ParseException

 If the given string cannot be parsed as a date.

 See Also:

 parse

parse

  public abstract Date parse(String text,
                             ParsePosition pos)

 Parse a date/time string according to the given parse position.  For
 example, a time text "07/10/96 4:5 PM, PDT" will be parsed into a Date
 that is equivalent to Date(837039928046).

 By default, parsing is lenient: If the input is not in the form used
 by this object's format method but can still be parsed as a date, then
 the parse succeeds.  Clients may insist on strict adherence to the
 format by calling setLenient(false).

 Parameters:

 text - The date/time string to be parsed

 pos - On input, the position at which to start parsing; on
              output, the position at which parsing terminated, or the
              start position if the parse failed.

 Returns:

 A Date, or null if the input could not be parsed

 See Also:

 setLenient

parseObject

  public Object parseObject(String source,
                            ParsePosition pos)

 Parse a date/time string into an Object.  This convenience method simply
 calls parse(String, ParsePosition).

 Overrides:

 parseObject in class Format

 See Also:

 parse

getTimeInstance

  public final static DateFormat getTimeInstance()

 Gets the time formatter with the default formatting style
 for the default locale.

 Returns:

 a time formatter.

getTimeInstance

  public final static DateFormat getTimeInstance(int style)

 Gets the time formatter with the given formatting style
 for the default locale.

 Parameters:

 style - the given formatting style. For example,
 SHORT for "h:mm a" in the US locale.

 Returns:

 a time formatter.

getTimeInstance

  public final static DateFormat getTimeInstance(int style,
                                                 Locale aLocale)

 Gets the time formatter with the given formatting style
 for the given locale.

 Parameters:

 style - the given formatting style. For example,
 SHORT for "h:mm a" in the US locale.

 inLocale - the given locale.

 Returns:

 a time formatter.

getDateInstance

  public final static DateFormat getDateInstance()

 Gets the date formatter with the default formatting style
 for the default locale.

 Returns:

 a date formatter.

getDateInstance

  public final static DateFormat getDateInstance(int style)

 Gets the date formatter with the given formatting style
 for the default locale.

 Parameters:

 style - the given formatting style. For example,
 SHORT for "M/d/yy" in the US locale.

 Returns:

 a date formatter.

getDateInstance

  public final static DateFormat getDateInstance(int style,
                                                 Locale aLocale)

 Gets the date formatter with the given formatting style
 for the given locale.

 Parameters:

 style - the given formatting style. For example,
 SHORT for "M/d/yy" in the US locale.

 inLocale - the given locale.

 Returns:

 a date formatter.

getDateTimeInstance

  public final static DateFormat getDateTimeInstance()

 Gets the date/time formatter with the default formatting style
 for the default locale.

 Returns:

 a date/time formatter.

getDateTimeInstance

  public final static DateFormat getDateTimeInstance(int dateStyle,
                                                     int timeStyle)

 Gets the date/time formatter with the given date and time
 formatting styles for the default locale.

 Parameters:

 dateStyle - the given date formatting style. For example,
 SHORT for "M/d/yy" in the US locale.

 timeStyle - the given time formatting style. For example,
 SHORT for "h:mm a" in the US locale.

 Returns:

 a date/time formatter.

getDateTimeInstance

  public final static DateFormat getDateTimeInstance(int dateStyle,
                                                     int timeStyle,
                                                     Locale aLocale)

 Gets the date/time formatter with the given formatting styles
 for the given locale.

 Parameters:

 dateStyle - the given date formatting style.

 timeStyle - the given time formatting style.

 inLocale - the given locale.

 Returns:

 a date/time formatter.

getInstance

  public final static DateFormat getInstance()

 Get a default date/time formatter that uses the SHORT style for both the
 date and the time.

getAvailableLocales

  public static Locale[] getAvailableLocales()

 Gets the set of locales for which DateFormats are installed.

 Returns:

 the set of locales for which DateFormats are installed.

setCalendar

  public void setCalendar(Calendar newCalendar)

 Set the calendar to be used by this date format.  Initially, the default
 calendar for the specified or default locale is used.

getCalendar

  public Calendar getCalendar()

 Gets the calendar associated with this date/time formatter.

 Returns:

 the calendar associated with this date/time formatter.

setNumberFormat

  public void setNumberFormat(NumberFormat newNumberFormat)

 Allows you to set the number formatter.

 Parameters:

 newNumberFormat - the given new NumberFormat.

getNumberInstance

  public NumberFormat getNumberInstance()

 Gets the number formatter which this date/time formatter uses to
 format and parse a time.

 Returns:

 the number formatter which this date/time formatter uses.

setTimeZone

  public void setTimeZone(TimeZone zone)

 Sets the time zone for the calendar of this DateFormat object.

 Parameters:

 zone - the given new time zone.

getTimeZone

  public TimeZone getTimeZone()

 Gets the time zone.

 Returns:

 the time zone associated with the calendar of DateFormat.

setLenient

  public void setLenient(boolean lenient)

 Specify whether or not date/time parsing is to be lenient.  With
 lenient parsing, the parser may use heuristics to interpret inputs that
 do not precisely match this object's format.  With strict parsing,
 inputs must match this object's format.

 See Also:

 setLenient

isLenient

  public boolean isLenient()

 Tell whether date/time parsing is to be lenient.

hashCode

  public int hashCode()

 Overrides hashCode

 Overrides:

 hashCode in class Object

equals

  public boolean equals(Object obj)

 Overrides equals

 Overrides:

 equals in class Object

clone

  public Object clone()

 Overrides Cloneable

 Overrides:

 clone in class Format

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.text.DateFormatSymbols

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.text.DateFormatSymbols

java.lang.Object
   |
   +----java.text.DateFormatSymbols

______________________________________________________________________________

 public class DateFormatSymbols

 extends Object

 implements Serializable, Cloneable

DateFormatSymbols is a public class for encapsulating  localizable date-time formatting data, such as the names of the  months, the names of the days of the week, and the time zone data.  DateFormat and SimpleDateFormat both use  DateFormatSymbols  to encapsulate this information.

 Typically you shouldn't use DateFormatSymbols directly.  Rather, you are encouraged to create a date-time formatter with the  DateFormat  class's factory methods: getTimeInstance,  getDateInstance, or getDateTimeInstance.  These methods automatically create a DateFormatSymbols for  the formatter so that you don't have to. After the  formatter is created, you may modify its format pattern using the  setPattern  method. For more information about  creating formatters using DateFormat 's factory methods,  see DateFormat.

 If you decide to create a date-time formatter with a specific  format pattern for a specific locale, you can do so with:

 new SimpleDateFormat(aPattern, new DateFormatSymbols(aLocale)).

DateFormatSymbols objects are clonable. When you obtain  a DateFormatSymbols  object, feel free to modify the  date-time formatting data. For instance, you can replace the localized  date-time format pattern characters with the ones that you feel easy  to remember. Or you can change the representative cities  to your favorite ones.

 New DateFormatSymbols subclasses may be added to support  SimpleDateFormat  for date-time formatting for additional locales.

See Also:

DateFormat, SimpleDateFormat, SimpleTimeZone

______________________________________________________________________________

 	DateFormatSymbols()

 Construct a DateFormatSymbols object by loading format data from  resources for the default locale.

 	DateFormatSymbols(Locale)

 Construct a DateFormatSymbols object by loading format data from  resources for the given locale.

 	clone()

 Overrides Cloneable

 	equals(Object)

 Override equals

 	getAmPmStrings()

 Gets ampm strings.

 	getEras()

 Gets era strings.

 	getLocalPatternChars()

 Gets localized date-time pattern characters.

 	getMonths()

 Gets month strings.

 	getShortMonths()

 Gets short month strings.

 	getShortWeekdays()

 Gets short weekday strings.

 	getWeekdays()

 Gets weekday strings.

 	getZoneStrings()

 Gets timezone strings.

 	hashCode()

 Override hashCode.

 	setAmPmStrings(String[])

 Sets ampm strings.

 	setEras(String[])

 Sets era strings.

 	setLocalPatternChars(String)

 Sets localized date-time pattern characters.

 	setMonths(String[])

 Sets month strings.

 	setShortMonths(String[])

 Sets short month strings.

 	setShortWeekdays(String[])

 Sets short weekday strings.

 	setWeekdays(String[])

 Sets weekday strings.

 	setZoneStrings(String[][])

 Sets timezone strings.

 DateFormatSymbols

  public DateFormatSymbols()

 Construct a DateFormatSymbols object by loading format data from  resources for the default locale.

Throws: MissingResourceException

 if the resources for the default locale cannot be  found or cannot be loaded.

 DateFormatSymbols

  public DateFormatSymbols(Locale locale)

 Construct a DateFormatSymbols object by loading format data from  resources for the given locale.

Throws: MissingResourceException

 if the resources for the specified locale cannot be  found or cannot be loaded.

 getEras

  public String[] getEras()

 Gets era strings. For example: "AD" and "BC".

Returns:

 the era strings.

 setEras

  public void setEras(String newEras[])

 Sets era strings. For example: "AD" and "BC".

Parameters:

 newEras - the new era strings.

 getMonths

  public String[] getMonths()

 Gets month strings. For example: "January", "February", etc.

Returns:

 the month strings.

 setMonths

  public void setMonths(String newMonths[])

 Sets month strings. For example: "January", "February", etc.

Parameters:

 newMonths - the new month strings.

 getShortMonths

  public String[] getShortMonths()

 Gets short month strings. For example: "Jan", "Feb", etc.

Returns:

 the short month strings.

 setShortMonths

  public void setShortMonths(String newShortMonths[])

 Sets short month strings. For example: "Jan", "Feb", etc.

Parameters:

 newShortMonths - the new short month strings.

 getWeekdays

  public String[] getWeekdays()

 Gets weekday strings. For example: "Sunday", "Monday", etc.

Returns:

 the weekday strings.

 setWeekdays

  public void setWeekdays(String newWeekdays[])

 Sets weekday strings. For example: "Sunday", "Monday", etc.

Parameters:

 newWeekdays - the new weekday strings.

 getShortWeekdays

  public String[] getShortWeekdays()

 Gets short weekday strings. For example: "Sun", "Mon", etc.

Returns:

 the short weekday strings.

 setShortWeekdays

  public void setShortWeekdays(String newShortWeekdays[])

 Sets short weekday strings. For example: "Sun", "Mon", etc.

Parameters:

 newShortWeekdays - the new short weekday strings.

 getAmPmStrings

  public String[] getAmPmStrings()

 Gets ampm strings. For example: "AM" and "PM".

Returns:

 the weekday strings.

 setAmPmStrings

  public void setAmPmStrings(String newAmpms[])

 Sets ampm strings. For example: "AM" and "PM".

Parameters:

 newAmpms - the new ampm strings.

 getZoneStrings

  public String[][] getZoneStrings()

 Gets timezone strings.

Returns:

 the timezone strings.

 setZoneStrings

  public void setZoneStrings(String newZoneStrings[][])

 Sets timezone strings.

Parameters:

 newZoneStrings - the new timezone strings.

 getLocalPatternChars

  public String getLocalPatternChars()

 Gets localized date-time pattern characters. For example: 'u', 't', etc.

Returns:

 the localized date-time pattern characters.

 setLocalPatternChars

  public void setLocalPatternChars(String newLocalPatternChars)

 Sets localized date-time pattern characters. For example: 'u', 't', etc.

Parameters:

 newLocalPatternChars - the new localized date-time  pattern characters.

 clone

  public Object clone()

 Overrides Cloneable

Overrides:

clone in class Object

 hashCode

  public int hashCode()

 Override hashCode.  Generates a hash code for the DateFormatSymbols object.

Overrides:

hashCode in class Object

 equals

  public boolean equals(Object obj)

 Override equals

Overrides:

equals in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.text.DecimalFormat

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.text.DecimalFormat

java.lang.Object
   |
   +----java.text.Format
           |
           +----java.text.NumberFormat
                   |
                   +----java.text.DecimalFormat

______________________________________________________________________________

 public class DecimalFormat

 extends NumberFormat

DecimalFormat is a concrete subclass of NumberFormat  for formatting decimal numbers. This class allows for a variety  of parameters, and localization to Western, Arabic, or Indic numbers.

 Normally, you get the proper NumberFormat for a specific  locale (including the default locale) using one of NumberFormat's  factory methods such as getInstance. You may then modify it  from there (after testing to make sure it is a DecimalFormat,  of course!)

 Either the prefixes or the suffixes must be different for  the parse to distinguish positive from negative.  Parsing will be unreliable if the digits, thousands or decimal separators  are the same, or if any of them occur in the prefixes or suffixes.

Special cases:

NaN is formatted as a single character, typically  \\uFFFD.

 +/-Infinity is formatted as a single character, typically \\u221E,  plus the positive and negative pre/suffixes.

Note: this class is designed for common users; for very  large or small numbers, use a format that can express exponential values.

Example:

 // normally we would have a GUI with a menu for this
 Locale[] locales = NumberFormat.getAvailableLocales();
 double myNumber = -1234.56;
 NumberFormat form;
 // just for fun, we print out a number with the locale number, currency
 // and percent format for each locale we can.
 for (int j = 0; j  " + form.format(myNumber));
         } catch (IllegalArgumentException iae) { }
         try {
             System.out.println(" -> " + form.parse(form.format(myNumber)));
         } catch (ParseException pe) { }
     }
 }

The following shows the structure of the pattern.

 pattern    := subpattern{;subpattern}
 subpattern := {prefix}integer{.fraction}{suffix}
 prefix     := '\\u0000'..'\\uFFFD' - specialCharacters
 suffix     := '\\u0000'..'\\uFFFD' - specialCharacters
 integer    := '#'* '0'* '0'
 fraction   := '0'* '#'*
 Notation:
  X*       0 or more instances of X
  (X | Y)  either X or Y.
  X..Y     any character from X up to Y, inclusive.
  S - T    characters in S, except those in T

 The first subpattern is for positive numbers. The second (optional)  subpattern is for negative numbers. (In both cases, ',' can occur  inside the integer portion--it is just too messy to indicate in BNF.)

 Here are the special characters used in the parts of the  subpattern, with notes on their usage.

 Symbol Meaning
 0      a digit
 #      a digit, zero shows as absent
 .      placeholder for decimal separator
 ,      placeholder for grouping separator.
 ;      separates formats.
 -      default negative prefix.
 %      divide by 100 and show as percentage
 X      any other characters can be used in the prefix or suffix
 '      used to quote special characters in a prefix or suffix.

Notes

 If there is no explicit negative subpattern, - is prefixed to the  positive form. That is, "0.00" alone is equivalent to "0.00;-0.00".

 Illegal formats, such as "#.#.#" or mixing '_' and '*' in the  same format, will cause an ParseException to be thrown.  From that ParseException , you can find the place in the string  where the error occurred.

 The grouping separator is commonly used for thousands, but in some  countries for ten-thousands. The interval is a constant number of  digits between the grouping characters, such as 100,000,000 or 1,0000,0000.  If you supply a pattern with multiple grouping characters, the interval  between the last one and the end of the integer is the one that is  used. So "#,##,###,####" == "######,####" == "##,####,####".

 This class only handles localized digits where the 10 digits  are contiguous in Unicode, from 0 to 9. Other digits sets  (such as superscripts) would need a different subclass.

See Also:

 Format, NumberFormat, ChoiceFormat

______________________________________________________________________________

 	DecimalFormat()

 Create a DecimalFormat using the default pattern and symbols  for the default locale.

 	DecimalFormat(String)

 Create a DecimalFormat from the given pattern and the symbols  for the default locale.

 	DecimalFormat(String, DecimalFormatSymbols)

 Create a DecimalFormat from the given pattern and symbols.

 	applyLocalizedPattern(String)

 Apply the given pattern to this Format object.

 	applyPattern(String)

 Apply the given pattern to this Format object.

 	clone()

 Standard override; no change in semantics.

 	equals(Object)

 Overrides equals

 	format(double, StringBuffer, FieldPosition)

 Specialization of format.

 	format(long, StringBuffer, FieldPosition)

 Specialization of format.

 	getDecimalFormatSymbols()

 Returns the decimal format symbols, which is generally not changed  by the programmer or user.

 	getGroupingSize()

 Return the grouping size.

 	getMultiplier()

 Get the multiplier for use in percent, permill, etc.

 	getNegativePrefix()

 Get the negative prefix.

 	getNegativeSuffix()

 Get the negative suffix.

 	getPositivePrefix()

 Get the positive prefix.

 	getPositiveSuffix()

 Get the positive suffix.

 	hashCode()

 Overrides hashCode

 	isDecimalSeparatorAlwaysShown()

 Allows you to get the behavior of the decimal separator with integers.

 	parse(String, ParsePosition)

 Returns a Long if possible (e.g.

 	setDecimalFormatSymbols(DecimalFormatSymbols)

 Sets the decimal format symbols, which is generally not changed  by the programmer or user.

 	setDecimalSeparatorAlwaysShown(boolean)

 Allows you to set the behavior of the decimal separator with integers.

 	setGroupingSize(int)

 Set the grouping size.

 	setMultiplier(int)

 Set the multiplier for use in percent, permill, etc.

 	setNegativePrefix(String)

 Set the negative prefix.

 	setNegativeSuffix(String)

 Set the positive suffix.

 	setPositivePrefix(String)

 Set the positive prefix.

 	setPositiveSuffix(String)

 Set the positive suffix.

 	toLocalizedPattern()

 Synthesizes a localized pattern string that represents the current  state of this Format object.

 	toPattern()

 Synthesizes a pattern string that represents the current state  of this Format object.

 DecimalFormat

  public DecimalFormat()

 Create a DecimalFormat using the default pattern and symbols  for the default locale. This is a convenient way to obtain a  DecimalFormat when internationalization is not the main concern.

 To obtain standard formats for a given locale, use the factory methods  on NumberFormat such as getNumberInstance. These factories will  return the most appropriate sub-class of NumberFormat for a given  locale.

See Also:

getInstance, getNumberInstance, getCurrencyInstance, getPercentInstance

 DecimalFormat

  public DecimalFormat(String pattern)

 Create a DecimalFormat from the given pattern and the symbols  for the default locale. This is a convenient way to obtain a  DecimalFormat when internationalization is not the main concern.

 To obtain standard formats for a given locale, use the factory methods  on NumberFormat such as getNumberInstance. These factories will  return the most appropriate sub-class of NumberFormat for a given  locale.

Parameters:

 pattern - A non-localized pattern string.

Throws: IllegalArgumentException

 if the given pattern is invalid.

See Also:

getInstance, getNumberInstance, getCurrencyInstance, getPercentInstance

 DecimalFormat

  public DecimalFormat(String pattern,
                       DecimalFormatSymbols symbols)

 Create a DecimalFormat from the given pattern and symbols.  Use this constructor when you need to completely customize the  behavior of the format.

 To obtain standard formats for a given  locale, use the factory methods on NumberFormat such as  getInstance or getCurrencyInstance. If you need only minor adjustments  to a standard format, you can modify the format returned by  a NumberFormat factory method.

Parameters:

 pattern - a non-localized pattern string

 symbols - the set of symbols to be used

Throws: IllegalArgumentException

 if the given pattern is invalid

See Also:

getInstance, getNumberInstance, getCurrencyInstance, getPercentInstance, DecimalFormatSymbols

 format

  public StringBuffer format(double number,
                             StringBuffer result,
                             FieldPosition fieldPosition)

 Specialization of format.

Overrides:

format in class NumberFormat

 format

  public StringBuffer format(long number,
                             StringBuffer result,
                             FieldPosition fieldPosition)

 Specialization of format.

Overrides:

format in class NumberFormat

 parse

  public Number parse(String text,
                      ParsePosition status)

 Returns a Long if possible (e.g.

Overrides:

parse in class NumberFormat

 getDecimalFormatSymbols

  public DecimalFormatSymbols getDecimalFormatSymbols()

 Returns the decimal format symbols, which is generally not changed  by the programmer or user.

Returns:

 desired DecimalFormatSymbols

See Also:

 DecimalFormatSymbols

 setDecimalFormatSymbols

  public void setDecimalFormatSymbols(DecimalFormatSymbols newSymbols)

 Sets the decimal format symbols, which is generally not changed  by the programmer or user.

Parameters:

 newSymbols - desired DecimalFormatSymbols

See Also:

 DecimalFormatSymbols

 getPositivePrefix

  public String getPositivePrefix()

 Get the positive prefix.

Examples: +123, $123, sFr123

 setPositivePrefix

  public void setPositivePrefix(String newValue)

 Set the positive prefix.

Examples: +123, $123, sFr123

 getNegativePrefix

  public String getNegativePrefix()

 Get the negative prefix.

Examples: -123, ($123) (with negative suffix), sFr-123

 setNegativePrefix

  public void setNegativePrefix(String newValue)

 Set the negative prefix.

Examples: -123, ($123) (with negative suffix), sFr-123

 getPositiveSuffix

  public String getPositiveSuffix()

 Get the positive suffix.

Example: 123%

 setPositiveSuffix

  public void setPositiveSuffix(String newValue)

 Set the positive suffix.

Example: 123%

 getNegativeSuffix

  public String getNegativeSuffix()

 Get the negative suffix.

Examples: -123%, ($123) (with positive suffixes)

 setNegativeSuffix

  public void setNegativeSuffix(String newValue)

 Set the positive suffix.

Examples: 123%

 getMultiplier

  public int getMultiplier()

 Get the multiplier for use in percent, permill, etc.  For a percentage, set the suffixes to have "%" and the multiplier to be 100.  (For Arabic, use arabic percent symbol).  For a permill, set the suffixes to have "?" and the multiplier to be 1000.

Examples: with 100, 1.23 -> "123", and "123" -> 1.23

 setMultiplier

  public void setMultiplier(int newValue)

 Set the multiplier for use in percent, permill, etc.  For a percentage, set the suffixes to have "%" and the multiplier to be 100.  (For Arabic, use arabic percent symbol).  For a permill, set the suffixes to have "?" and the multiplier to be 1000.

Examples: with 100, 1.23 -> "123", and "123" -> 1.23

 getGroupingSize

  public int getGroupingSize()

 Return the grouping size. Grouping size is the number of digits between   grouping separators in the integer portion of a number. For example,  in the number "123,456.78", the grouping size is 3.

See Also:

setGroupingSize, isGroupingUsed, getGroupingSeparator

 setGroupingSize

  public void setGroupingSize(int newValue)

 Set the grouping size. Grouping size is the number of digits between  grouping separators in the integer portion of a number. For example,  in the number "123,456.78", the grouping size is 3.

See Also:

getGroupingSize, setGroupingUsed, setGroupingSeparator

 isDecimalSeparatorAlwaysShown

  public boolean isDecimalSeparatorAlwaysShown()

 Allows you to get the behavior of the decimal separator with integers.  (The decimal separator will always appear with decimals.)

Example: Decimal ON: 12345 -> 12345.; OFF: 12345 -> 12345

 setDecimalSeparatorAlwaysShown

  public void setDecimalSeparatorAlwaysShown(boolean newValue)

 Allows you to set the behavior of the decimal separator with integers.  (The decimal separator will always appear with decimals.)

Example: Decimal ON: 12345 -> 12345.; OFF: 12345 -> 12345

 clone

  public Object clone()

 Standard override; no change in semantics.

Overrides:

clone in class NumberFormat

 equals

  public boolean equals(Object obj)

 Overrides equals

Overrides:

equals in class NumberFormat

 hashCode

  public int hashCode()

 Overrides hashCode

Overrides:

hashCode in class NumberFormat

 toPattern

  public String toPattern()

 Synthesizes a pattern string that represents the current state  of this Format object.

See Also:

applyPattern

 toLocalizedPattern

  public String toLocalizedPattern()

 Synthesizes a localized pattern string that represents the current  state of this Format object.

See Also:

applyPattern

 applyPattern

  public void applyPattern(String pattern)

 Apply the given pattern to this Format object. A pattern is a  short-hand specification for the various formatting properties.  These properties can also be changed individually through the  various setter methods.

 There is no limit to integer digits are set  by this routine, since that is the typical end-user desire;  use setMaximumInteger if you want to set a real value.  For negative numbers, use a second pattern, separated by a semicolon

Example "#,#00.0#" -> 1,234.56

This means a minimum of 2 integer digits, 1 fraction digit, and  a maximum of 2 fraction digits.

Example: "#,#00.0#;(#,#00.0#)" for negatives in parantheses.

In negative patterns, the minimum and maximum counts are ignored;  these are presumed to be set in the positive pattern.

Throws: ParseException

 if the pattern is incorrect.

 applyLocalizedPattern

  public void applyLocalizedPattern(String pattern)

 Apply the given pattern to this Format object. The pattern  is assumed to be in a localized notation. A pattern is a  short-hand specification for the various formatting properties.  These properties can also be changed individually through the  various setter methods.

 There is no limit to integer digits are set  by this routine, since that is the typical end-user desire;  use setMaximumInteger if you want to set a real value.  For negative numbers, use a second pattern, separated by a semicolon

Example "#,#00.0#" -> 1,234.56

This means a minimum of 2 integer digits, 1 fraction digit, and  a maximum of 2 fraction digits.

Example: "#,#00.0#;(#,#00.0#)" for negatives in parantheses.

In negative patterns, the minimum and maximum counts are ignored;  these are presumed to be set in the positive pattern.

Throws: ParseException

 if the pattern is incorrect.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.text.DecimalFormatSymbols

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.text.DecimalFormatSymbols

java.lang.Object
   |
   +----java.text.DecimalFormatSymbols

______________________________________________________________________________

 public final class DecimalFormatSymbols

 extends Object

 implements Cloneable, Serializable

This class represents the set of symbols (such as the decimal separator,  the grouping separator, and so on) needed by DecimalFormat  to format numbers. DecimalFormat creates for itself an instance of  DecimalFormatSymbols  from its locale data. If you need to change any  of these symbols, you can get the DecimalFormatSymbols object from  your DecimalFormat and modify it.

See Also:

Locale, DecimalFormat

______________________________________________________________________________

 	DecimalFormatSymbols()

 Create a DecimalFormatSymbols object for the default locale.

 	DecimalFormatSymbols(Locale)

 Create a DecimalFormatSymbols object for the given locale.

 	clone()

 Standard override.

 	equals(Object)

 Override equals

 	getDecimalSeparator()

 character used for decimal sign.

 	getDigit()

 character used for a digit in a pattern.

 	getGroupingSeparator()

 character used for thousands separator.

 	getInfinity()

 character used to represent infinity.

 	getMinusSign()

 character used to represent minus sign.

 	getNaN()

 character used to represent NaN.

 	getPatternSeparator()

 character used to separate positive and negative subpatterns  in a pattern.

 	getPercent()

 character used for percent sign.

 	getPerMill()

 character used for mille percent sign.

 	getZeroDigit()

 character used for zero.

 	hashCode()

 Override hashCode

 	setDecimalSeparator(char)

  	setDigit(char)

  	setGroupingSeparator(char)

  	setInfinity(String)

  	setMinusSign(char)

  	setNaN(String)

  	setPatternSeparator(char)

  	setPercent(char)

  	setPerMill(char)

  	setZeroDigit(char)

 DecimalFormatSymbols

  public DecimalFormatSymbols()

 Create a DecimalFormatSymbols object for the default locale.

 DecimalFormatSymbols

  public DecimalFormatSymbols(Locale locale)

 Create a DecimalFormatSymbols object for the given locale.

 getZeroDigit

  public char getZeroDigit()

 character used for zero. Different for Arabic, etc.

 setZeroDigit

  public void setZeroDigit(char zeroDigit)

 getGroupingSeparator

  public char getGroupingSeparator()

 character used for thousands separator. Different for French, etc.

 setGroupingSeparator

  public void setGroupingSeparator(char groupingSeparator)

 getDecimalSeparator

  public char getDecimalSeparator()

 character used for decimal sign. Different for French, etc.

 setDecimalSeparator

  public void setDecimalSeparator(char decimalSeparator)

 getPerMill

  public char getPerMill()

 character used for mille percent sign. Different for Arabic, etc.

 setPerMill

  public void setPerMill(char perMill)

 getPercent

  public char getPercent()

 character used for percent sign. Different for Arabic, etc.

 setPercent

  public void setPercent(char percent)

 getDigit

  public char getDigit()

 character used for a digit in a pattern.

 setDigit

  public void setDigit(char digit)

 getPatternSeparator

  public char getPatternSeparator()

 character used to separate positive and negative subpatterns  in a pattern.

 setPatternSeparator

  public void setPatternSeparator(char patternSeparator)

 getInfinity

  public String getInfinity()

 character used to represent infinity. Almost always left  unchanged.

 setInfinity

  public void setInfinity(String infinity)

 getNaN

  public String getNaN()

 character used to represent NaN. Almost always left  unchanged.

 setNaN

  public void setNaN(String NaN)

 getMinusSign

  public char getMinusSign()

 character used to represent minus sign. If no explicit  negative format is specified, one is formed by prefixing  minusSign to the positive format.

 setMinusSign

  public void setMinusSign(char minusSign)

 clone

  public Object clone()

 Standard override.

Overrides:

clone in class Object

 equals

  public boolean equals(Object obj)

 Override equals

Overrides:

equals in class Object

 hashCode

  public int hashCode()

 Override hashCode

Overrides:

hashCode in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.text.FieldPosition

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.text.FieldPosition

java.lang.Object
   |
   +----java.text.FieldPosition

______________________________________________________________________________

 public class FieldPosition

 extends Object

FieldPosition is a simple class used by Format  and its subclasses to identify fields in formatted output. Fields are  identified by constants, whose names typically end with _FIELD,  defined in the various subclasses of Format. See  ERA_FIELD  and its friends in DateFormat for  an example.

FieldPosition keeps track of the position of the  field within the formatted output with two indices: the index  of the first character of the field and the index of the last  character of the field.

 One version of the format method in the various  Format  classes requires a FieldPosition  object as an argument. You use this format method  to perform partial formatting or to get information about the  formatted output (such as the position of a field).

See Also:

 Format

______________________________________________________________________________

 	FieldPosition(int)

 Creates a FieldPosition object for the given field.

 	getBeginIndex()

 Retrieve the index of the first character in the requested field.

 	getEndIndex()

 Retrieve the index of the character following the last character in the  requested field.

 	getField()

 Retrieve the field identifier.

 FieldPosition

  public FieldPosition(int field)

 Creates a FieldPosition object for the given field. Fields are  identified by constants, whose names typically end with _FIELD,  in the various subclasses of Format.

See Also:

INTEGER_FIELD, FRACTION_FIELD, YEAR_FIELD, MONTH_FIELD

 getField

  public int getField()

 Retrieve the field identifier.

 getBeginIndex

  public int getBeginIndex()

 Retrieve the index of the first character in the requested field.

 getEndIndex

  public int getEndIndex()

 Retrieve the index of the character following the last character in the   requested field.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.text.Format

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.text.Format

java.lang.Object
   |
   +----java.text.Format

______________________________________________________________________________

 public class Format

 extends Object

 implements Serializable, Cloneable

Format is an abstract base class for formatting locale-sensitive  information such as dates, messages, and numbers.

Format defines the programming interface for formatting  locale-sensitive objects into Strings (the  format method) and for parsing Strings back  into objects (the parseObject method). Any String  formatted by format is guaranteed to be parseable by  parseObject.

 If formatting is unsuccessful because the Format object  cannot format the type of object specified, format throws an  IllegalArgumentException. Otherwise, if there is something  illformed about the object, format returns the Unicode  replacement character \\uFFFD.

 If there is no match when parsing,  parseObject(String) throws a ParseException,  and parseObject(String, ParsePosition) leaves the  ParsePosition index member unchanged and  returns null.

Subclassing:  The JDK provides three concrete subclasses of Format--  DateFormat, MessageFormat, and  NumberFormat --for formatting dates, messages, and numbers,  respectively.

 Concrete subclasses must implement these two methods:

1.  format(Object obj, StringBuffer toAppendTo, FieldPosition pos)

2.  parseObject (String source, ParsePosition pos)

 Most subclasses will also implement the following two methods:

1.  getInstance  for getting a useful format object appropriate  for the current locale

2.  getInstance(Locale) for getting a useful format  object appropriate for the specified locale

 In addition, some subclasses may also choose to implement other  getXxxxInstance  methods for more specialized control. For  example, the NumberFormat class provides  getPercentInstance and getCurrencyInstance  methods for getting specialized number formatters.

 Subclasses of Format that allow programmers to create objects  for locales (with getInstance(Locale) for example)  must also implement the following class method:

 public static Locale[] getAvailableLocales()

 And finally subclasses may define a set of constants to identify the various  fields in the formatted output. These constants are used to create a FieldPosition  object which identifies what information is contained in the field and its  position in the formatted result. These constants should be named  item_FIELD  where item identifies  the field. For examples of these constants, see ERA_FIELD and its  friends in DateFormat.

See Also:

ParsePosition, FieldPosition, NumberFormat, DateFormat, MessageFormat

______________________________________________________________________________

 	Format()

 	clone()

 Creates a new object of the same class as this object.

 	format(Object)

 Formats an object to produce a string.

 	format(Object, StringBuffer, FieldPosition)

 Formats an object to produce a string.

 	parseObject(String)

 Parses a string to produce an object.

 	parseObject(String, ParsePosition)

 Parses a string to produce an object.

 Format

  public Format()

 format

  public final String format(Object obj)

 Formats an object to produce a string.

Subclasses will override the StringBuffer version of format.

Parameters:

 obj - The object to format

Returns:

 Formatted string.

Throws: IllegalArgumentException

 when the Format cannot format the  type of object.

See Also:

MessageFormat, format

 format

  public abstract StringBuffer format(Object obj,
                                      StringBuffer toAppendTo,
                                      FieldPosition pos)

 Formats an object to produce a string.  Subclasses will implement for particular object, such as:

 StringBuffer format (Number obj, StringBuffer toAppendTo)
 Number parse (String str)

 These general routines allow polymorphic parsing and  formatting for objects such as the MessageFormat.

Parameters:

 obj - The object to format

 toAppendTo - where the text is to be appended

 status - On input: an alignment field, if desired.  On output: the offsets of the alignment field.

Returns:

 the value passed in as toAppendTo (this allows chaining,  as with StringBuffer.append())

Throws: IllegalArgumentException

 when the Format cannot format the  given object.

See Also:

MessageFormat, FieldPosition

 parseObject

  public abstract Object parseObject(String source,
                                     ParsePosition status)

 Parses a string to produce an object.  Subclasses will typically implement for particular object, such as:

       String format (Number obj);
       String format (long obj);
       String format (double obj);
       Number parse (String str);

Parameters:

 ParsePosition - Input-Output parameter.

Before calling, set status.index to the offset you want to start  parsing at in the source.  After calling, status.index is the end of the text you parsed.  If error occurs, index is unchanged.

When parsing, leading whitespace is discarded  (with successful parse),  while trailing whitespace is left as is.

Example:  Parsing "_12_xy" (where _ represents a space) for a number,  with index == 0 will result in  the number 12, with status.index updated to 3  (just before the second space).  Parsing a second time will result in a ParseException  since "xy" is not a number, and leave index at 3.

Subclasses will typically supply specific parse methods that  return different types of values. Since methods can't overload on  return types, these will typically be named "parse", while this  polymorphic method will always be called parseObject.  Any parse method that does not take a status should  throw ParseException when no text in the required format is at  the start position.

Returns:

 Object parsed from string. In case of error, returns null.

See Also:

ParsePosition

 parseObject

  public Object parseObject(String source) throws ParseException

 Parses a string to produce an object.

Throws: ParseException

 if the specified string is invalid.

 clone

  public Object clone()

 Creates a new object of the same class as this object.

Overrides:

clone in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.text.FormatException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.text.FormatException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.RuntimeException
                           |
                           +----java.lang.IllegalArgumentException
                                   |
                                   +----java.text.FormatException

______________________________________________________________________________

 public class FormatException

 extends IllegalArgumentException

Signals that an error has been has been reached unexpectedly  while formatting.

See Also:

 Exception, Format, FieldPosition

______________________________________________________________________________

 	FormatException(String, int)

 Constructs a FormatException with the specified detail message and  offset.

 	getErrorOffset()

 Returns the position where the error was found.

 FormatException

  public FormatException(String s,
                         int errorOffset)

 Constructs a FormatException with the specified detail message and  offset. A detail message is a String that describes this particular  exception.

Parameters:

 s - the detail message

 errorOffset - the position where the error is found while parsing.

 getErrorOffset

  public int getErrorOffset()

 Returns the position where the error was found.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.text.MessageFormat

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.text.MessageFormat

java.lang.Object
   |
   +----java.text.Format
           |
           +----java.text.MessageFormat

______________________________________________________________________________

 public class MessageFormat

 extends Format

MessageFormat provides a means to produce concatenated  messages in language-neutral way. Use this to construct messages  displayed for end users.

MessageFormat takes a set of objects, formats them, then  inserts the formatted strings into the pattern at the appropriate places.

Note:  MessageFormat differs from the other Format  classes in that you create a MessageFormat object with one  of its constructors (not with a getInstance style factory  method). The factory methods aren't necessary because MessageFormat  doesn't require any complex setup for a given locale. In fact,  MessageFormat  doesn't implement any locale specific behavior  at all. It just needs to be set up on a sentence by sentence basis.

 Here are some examples of usage:

 Object[] arguments = {
     new Integer(7),
     new Date(System.currentTimeMillis()),
     "a disturbance in the Force"
 };
 String result = MessageFormat.format(
     "At {1,time} on {1,date}, there was {2} on planet {0,number,integer}.",
     arguments);
 : At 12:30 PM on Jul 3, 2053, there was a disturbance
           in the Force on planet 7.

 Typically, the message format will come from resources, and the  arguments will be dynamically set at runtime.

 Example 2:

 Object[] testArgs = {new Long(3), "MyDisk"};
 MessageFormat form = new MessageFormat(
     "The disk \"{1}\" contains {0} file(s).");
 System.out.println(form.format(testArgs));
 // output, with different testArgs
 : The disk "MyDisk" contains 0 file(s).
 : The disk "MyDisk" contains 1 file(s).
 : The disk "MyDisk" contains 1,273 file(s).

 The pattern is of the form:

 messageFormatPattern := string ( "{" messageFormatElement "}" string )*
 messageFormatElement := argument { "," elementFormat }
 elementFormat := "time" { "," datetimeStyle }
                | "date" { "," datetimeStyle }
                | "number" { "," numberStyle }
                | "choice" { "," choiceStyle }
 datetimeStyle := "short"
                  | "medium"
                  | "long"
                  | "full"
                  | dateFormatPattern
 numberStyle := "currency"
               | "percent"
               | "integer"
               | numberFormatPattern
 choiceStyle := choiceFormatPattern

 If there is no elementFormat,  then the argument must be a string, which is substituted. If there is  no dateTimeStyle  or numberStyle, then the  default format is used (for example, NumberFormat.getInstance,  DateFormat.getTimeInstance, or DateFormat.getInstance).

 In strings, single quotes can be used to quote the "{"  (curly brace) if necessary. A real single quote is represented by ''.  Inside a messageFormatElement, quotes are not  removed. For example, {1,number,$'#',##} will produce a number format  with the pound-sign quoted, with a result such as: "$#31,45".

 If a pattern is used, then unquoted braces in the pattern, if any, must match:  that is, "ab {0} de" and "ab '}' de" are ok, but "ab {0'}' de" and "ab } de" are  not.

 The argument is a number from 0 to 9, which corresponds to the  arguments presented in an array to be formatted.

 It is ok to have unused arguments in the array.  With missing arguments or arguments that are not of the right class for  the specified format, a ParseException is thrown.  First, format checks to see if a Format object has been  specified for the argument with the setFormats method.  If so, then format uses that Format object to format the  argument. Otherwise, the argument is formatted based on the object's  type. If the argument is a Number, then format  uses NumberFormat.getInstance  to format the argument; if the  argument is a Date, then format uses  DateFormat.getDateTimeInstance to format the argument.  Otherwise, it uses the toString method.

 For more sophisticated patterns, you can use a ChoiceFormat to get  output such as:

 MessageFormat form = new MessageFormat("The disk \"{1}\" contains {0}.");
 double[] filelimits = {0,1,2};
 String[] filepart = {"no files","one file","{0,number} files"};
 ChoiceFormat fileform = new ChoiceFormat(filelimits, filepart);
 form.setFormat(1,fileform); // NOT zero, see below
 Object[] testArgs = {new Long(12373), "MyDisk"};
 System.out.println(form.format(testArgs));
 // output, with different testArgs
 output: The disk "MyDisk" contains no files.
 output: The disk "MyDisk" contains one file.
 output: The disk "MyDisk" contains 1,273 files.

 You can either do this programmatically, as in the above example,  or by using a pattern (see  ChoiceFormat  for more information) as in:

 form.applyPattern(
    "There {0,choice,0#are no files|1#is one file|1#are {0,number,integer} files}.");

Note: As we see above, the string produced  by a ChoiceFormat in MessageFormat is treated specially;  occurances of '{' are used to indicated subformats, and cause recursion.  If you create both a MessageFormat and ChoiceFormat  programmatically (instead of using the string patterns), then be careful not to  produce a format that recurses on itself, which will cause an infinite loop.

Note: formats are numbered by order of  variable in the string.  This is not the same as the argument numbering!  For example: with "abc{2}def{3}ghi{0}...",

• format0 affects the first variable {2}

• format1 affects the second variable {3}

• format2 affects the second variable {0}

• and so on.

See Also:

Locale, Format, NumberFormat, DecimalFormat, ChoiceFormat

______________________________________________________________________________

 	MessageFormat(String)

 Constructs with the specified pattern.

 	applyPattern(String)

 Sets the pattern.

 	clone()

 Overrides Cloneable

 	equals(Object)

 Equality comparision between two message format objects

 	format(Object, StringBuffer, FieldPosition)

 Formats an object to produce a string.

 	format(Object[], StringBuffer, FieldPosition)

 Returns pattern with formatted objects.

 	format(String, Object[])

 Convenience routine.

 	getFormats()

 Gets formats that were set with setFormats.

 	getLocale()

 Gets the locale.

 	hashCode()

 Generates a hash code for the message format object.

 	parse(String)

 Parses the string.

 	parse(String, ParsePosition)

 Parses the string.

 	parseObject(String, ParsePosition)

 Parses the string.

 	setFormat(int, Format)

 Sets formats individually to use on parameters.

 	setFormats(Format[])

 Sets formats to use on parameters.

 	setLocale(Locale)

 Constructs with the specified pattern and formats for the  arguments in that pattern.

 	toPattern()

 Gets the pattern.

 MessageFormat

  public MessageFormat(String pattern)

 Constructs with the specified pattern.

See Also:

applyPattern

 setLocale

  public void setLocale(Locale theLocale)

 Constructs with the specified pattern and formats for the  arguments in that pattern.

See Also:

setPattern

 getLocale

  public Locale getLocale()

 Gets the locale. This locale is used for fetching default number or date  format information.

 applyPattern

  public void applyPattern(String newPattern)

 Sets the pattern. See the class description.

 toPattern

  public String toPattern()

 Gets the pattern. See the class description.

 setFormats

  public void setFormats(Format newFormats[])

 Sets formats to use on parameters.  See the class description about format numbering.

 setFormat

  public void setFormat(int variable,
                        Format newFormat)

 Sets formats individually to use on parameters.  See the class description about format numbering.

 getFormats

  public Format[] getFormats()

 Gets formats that were set with setFormats.  See the class description about format numbering.

 format

  public final StringBuffer format(Object source[],
                                   StringBuffer result,
                                   FieldPosition ignore)

 Returns pattern with formatted objects.

Parameters:

 source - an array of objects to be formatted & substituted.

 result - where text is appended.

 ignore - no useful status is returned.

 format

  public static String format(String pattern,
                              Object arguments[])

 Convenience routine.  Avoids explicit creation of MessageFormat,  but doesn't allow future optimizations.

 format

  public final StringBuffer format(Object source,
                                   StringBuffer result,
                                   FieldPosition ignore)

 Formats an object to produce a string.

Overrides:

format in class Format

 parse

  public Object[] parse(String source,
                        ParsePosition status)

 Parses the string.

Caveats: The parse may fail in a number of circumstances.  For example  If one of the arguments does not occur in the pattern.  If the format of an argument is loses information, such as  with a choice format where a large number formats to "many".  Does not yet handle recursion (where  the substituted strings contain {n} references.)  Will not always find a match (or the correct match)  if some part of the parse is ambiguous.  For example, if the pattern "{1},{2}" is used with the  string arguments {"a,b", "c"}, it will format as "a,b,c".  When the result is parsed, it will return {"a", "b,c"}.  If a single argument is formatted twice in the string,  then the later parse wins.

 parse

  public Object[] parse(String source) throws ParseException

 Parses the string. Does not yet handle recursion (where  the substituted strings contain {n} references.)

Throws: ParseException

 if the string can't be parsed.

 parseObject

  public Object parseObject(String text,
                            ParsePosition status)

 Parses the string. Does not yet handle recursion (where  the substituted strings contain %n references.)

Overrides:

parseObject in class Format

 clone

  public Object clone()

 Overrides Cloneable

Overrides:

clone in class Format

 equals

  public boolean equals(Object obj)

 Equality comparision between two message format objects

Overrides:

equals in class Object

 hashCode

  public int hashCode()

 Generates a hash code for the message format object.

Overrides:

hashCode in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.text.NumberFormat

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.text.NumberFormat

java.lang.Object
   |
   +----java.text.Format
           |
           +----java.text.NumberFormat

______________________________________________________________________________

 public class NumberFormat

 extends Format

 implements Cloneable

NumberFormat is the abstract base class for all number  formats. This class provides the interface for formatting and parsing  numbers. NumberFormat also provides methods for determining  which locales have number formats, and what their names are.

NumberFormat helps you to format and parse numbers for any locale.  Your code can be completely independent of the locale conventions for  decimal points, thousands-separators, or even the particular decimal  digits used, or whether the number format is even decimal.

 To format a number for the current Locale, use one of the factory  class methods:

  myString = NumberFormat.getInstance().format(myNumber);

 If you are formatting multiple numbers, it is  more efficient to get the format and use it multiple times so that  the system doesn't have to fetch the information about the local  language and country conventions multiple times.

 NumberFormat nf = NumberFormat.getInstance();
 for (int i = 0; i

 To format a number for a different Locale, specify it in the
 call to getInstance.

 NumberFormat nf = NumberFormat.getInstance(Locale.FRENCH);

 You can also use a NumberFormat to parse numbers:

 myNumber = nf.parse(myString);

 Use getInstance or getNumberInstance to get the
 normal number format. Use getCurrencyInstance to get the
 currency number format. And use getPercentInstance to get a
 format for displaying percentages. With this format, a fraction like
 0.53 is displayed as 53%.

 You can also control the display of numbers with such methods as
 setMinimumFractionDigits.
 If you want even more control over the format or parsing,
 or want to give your users more control,
 you can try casting the NumberFormat you get from the factory methods
 to a DecimalNumberFormat. This will work for the vast majority
 of locales; just remember to put it in a try block in case you
 encounter an unusual one.

 You can also use forms of the parse and format
 methods with ParsePosition and FieldPosition to
 allow you to:

•  progressively parse through pieces of a string

•  align the decimal point and other areas

 For example, you can align numbers in two ways:

1.  If you are using a monospaced font with spacing for alignment,
      you can pass the FieldPosition in your format call, with
      field = INTEGER_FIELD. On output,
      getEndIndex will be set to the offset between the
      last character of the integer and the decimal. Add
      (desiredSpaceCount - getEndIndex) spaces at the front of the string.

2.  If you are using proportional fonts,
      instead of padding with spaces, measure the width
      of the string in pixels from the start to getEndIndex.
      Then move the pen by
      (desiredPixelWidth - widthToAlignmentPoint) before drawing the text.
      It also works where there is no decimal, but possibly additional
      characters at the end, e.g. with parentheses in negative
      numbers: "(12)" for -12.

 See Also:

 DecimalFormat, ChoiceFormat

______________________________________________________________________________

        FRACTION_FIELD

  Field constant used to construct a FieldPosition object.

        INTEGER_FIELD

  Field constant used to construct a FieldPosition object.

        NumberFormat()

        clone()

  Overrides Cloneable

        equals(Object)

  Overrides equals

        format(double)

  Specialization of format.

        format(double, StringBuffer, FieldPosition)

  Specialization of format.

        format(long)

  Specialization of format.

        format(long, StringBuffer, FieldPosition)

  Specialization of format.

        format(Object, StringBuffer, FieldPosition)

  Formats an object to produce a string.

        getAvailableLocales()

  Get the set of Locales for which NumberFormats are installed

        getCurrencyInstance()

  Returns a currency format for the current default locale.

        getCurrencyInstance(Locale)

  Returns a currency format for the specified locale.

        getInstance()

  Returns the default number format for the current default locale.

        getInstance(Locale)

  Returns the default number format for the specified locale.

        getMaximumFractionDigits()

  Returns the maximum number of digits allowed in the fraction portion of a
 number.

        getMaximumIntegerDigits()

  Returns the maximum number of digits allowed in the integer portion of a
 number.

        getMinimumFractionDigits()

  Returns the minimum number of digits allowed in the fraction portion of a
 number.

        getMinimumIntegerDigits()

  Returns the minimum number of digits allowed in the integer portion of a
 number.

        getNumberInstance()

  Returns a general-purpose number format for the current default locale.

        getNumberInstance(Locale)

  Returns a general-purpose number format for the specified locale.

        getPercentInstance()

  Returns a percentage format for the current default locale.

        getPercentInstance(Locale)

  Returns a percentage format for the specified locale.

        hashCode()

  Overrides hashCode

        isGroupingUsed()

  Returns true if grouping is used in this format.

        isParseIntegerOnly()

  Returns true if this format will parse numbers as integers only.

        parse(String)

  Convenience method.

        parse(String, ParsePosition)

  Returns a Long if possible (e.g.

        parseObject(String, ParsePosition)

  Parses a string to produce an object.

        setGroupingUsed(boolean)

  Set whether or not grouping will be used in this format.

        setMaximumFractionDigits(int)

  Sets the maximum number of digits allowed in the fraction portion of a
 number.

        setMaximumIntegerDigits(int)

  Sets the maximum number of digits allowed in the integer portion of a
 number.

        setMinimumFractionDigits(int)

  Sets the minimum number of digits allowed in the fraction portion of a
 number.

        setMinimumIntegerDigits(int)

  Sets the minimum number of digits allowed in the integer portion of a
 number.

        setParseIntegerOnly(boolean)

  Sets whether or not numbers should be parsed as integers only.

INTEGER_FIELD

  public final static int INTEGER_FIELD

 Field constant used to construct a FieldPosition object. Signifies that
 the position of the integer part of a formatted number should be returned.

 See Also:

 FieldPosition

FRACTION_FIELD

  public final static int FRACTION_FIELD

 Field constant used to construct a FieldPosition object. Signifies that
 the position of the fraction part of a formatted number should be returned.

 See Also:

 FieldPosition

NumberFormat

  public NumberFormat()

format

  public final StringBuffer format(Object number,
                                   StringBuffer toAppendTo,
                                   FieldPosition pos)

 Formats an object to produce a string.

 Overrides:

 format in class Format

parseObject

  public final Object parseObject(String source,
                                  ParsePosition parsePosition)

 Parses a string to produce an object.

 Overrides:

 parseObject in class Format

format

  public final String format(double number)

 Specialization of format.

 See Also:

 format

format

  public final String format(long number)

 Specialization of format.

 See Also:

 format

format

  public abstract StringBuffer format(double number,
                                      StringBuffer toAppendTo,
                                      FieldPosition pos)

 Specialization of format.

 See Also:

 format

format

  public abstract StringBuffer format(long number,
                                      StringBuffer toAppendTo,
                                      FieldPosition pos)

 Specialization of format.

 See Also:

 format

parse

  public abstract Number parse(String text,
                               ParsePosition parsePosition)

 Returns a Long if possible (e.g. within range [Long.MIN_VALUE,
 Long.MAX_VALUE], and with no decimals), otherwise a Double.
 If IntegerOnly is set, will stop at a decimal
 point (or equivalent; e.g. for rational numbers "1 2/3", will stop
 after the 1).
 Does not throw an exception; if no object can be parsed, index is
 unchanged!

 See Also:

 isParseIntegerOnly, parseObject

parse

  public Number parse(String text) throws ParseException

 Convenience method.

 Throws: ParseException

 if the specified string is invalid.

 See Also:

 format

isParseIntegerOnly

  public boolean isParseIntegerOnly()

 Returns true if this format will parse numbers as integers only.
 For example in the English locale, with ParseIntegerOnly true, the
 string "1234." would be parsed as the integer value 1234 and parsing
 would stop at the "." character.  Of course, the exact format accepted
 by the parse operation is locale dependant and determined by sub-classes
 of NumberFormat.

setParseIntegerOnly

  public void setParseIntegerOnly(boolean value)

 Sets whether or not numbers should be parsed as integers only.

 See Also:

 isParseIntegerOnly

getInstance

  public final static NumberFormat getInstance()

 Returns the default number format for the current default locale.
 The default format is one of the styles provided by the other
 factory methods: getNumberInstance, getCurrencyInstance or getPercentInstance.
 Exactly which one is locale dependant.

getInstance

  public static NumberFormat getInstance(Locale inLocale)

 Returns the default number format for the specified locale.
 The default format is one of the styles provided by the other
 factory methods: getNumberInstance, getCurrencyInstance or getPercentInstance.
 Exactly which one is locale dependant.

getNumberInstance

  public final static NumberFormat getNumberInstance()

 Returns a general-purpose number format for the current default locale.

getNumberInstance

  public static NumberFormat getNumberInstance(Locale inLocale)

 Returns a general-purpose number format for the specified locale.

getCurrencyInstance

  public final static NumberFormat getCurrencyInstance()

 Returns a currency format for the current default locale.

getCurrencyInstance

  public static NumberFormat getCurrencyInstance(Locale inLocale)

 Returns a currency format for the specified locale.

getPercentInstance

  public final static NumberFormat getPercentInstance()

 Returns a percentage format for the current default locale.

getPercentInstance

  public static NumberFormat getPercentInstance(Locale inLocale)

 Returns a percentage format for the specified locale.

getAvailableLocales

  public static Locale[] getAvailableLocales()

 Get the set of Locales for which NumberFormats are installed

 Returns:

 available locales

hashCode

  public int hashCode()

 Overrides hashCode

 Overrides:

 hashCode in class Object

equals

  public boolean equals(Object obj)

 Overrides equals

 Overrides:

 equals in class Object

clone

  public Object clone()

 Overrides Cloneable

 Overrides:

 clone in class Format

isGroupingUsed

  public boolean isGroupingUsed()

 Returns true if grouping is used in this format. For example, in the
 English locale, with grouping on, the number 1234567 might be formatted
 as "1,234,567". The grouping separator as well as the size of each group
 is locale dependant and is determined by sub-classes of NumberFormat.

 See Also:

 setGroupingUsed

setGroupingUsed

  public void setGroupingUsed(boolean newValue)

 Set whether or not grouping will be used in this format.

 See Also:

 isGroupingUsed

getMaximumIntegerDigits

  public int getMaximumIntegerDigits()

 Returns the maximum number of digits allowed in the integer portion of a
 number.

 See Also:

 setMaximumIntegerDigits

setMaximumIntegerDigits

  public void setMaximumIntegerDigits(int newValue)

 Sets the maximum number of digits allowed in the integer portion of a
 number. maximumIntegerDigits must be >= minimumIntegerDigits.  If the
 new value for maximumIntegerDigits is less than the current value
 of minimumIntegerDigits, then minimumIntegerDigits will also be set to
 the new value.

 See Also:

 getMaximumIntegerDigits

getMinimumIntegerDigits

  public int getMinimumIntegerDigits()

 Returns the minimum number of digits allowed in the integer portion of a
 number.

 See Also:

 setMinimumIntegerDigits

setMinimumIntegerDigits

  public void setMinimumIntegerDigits(int newValue)

 Sets the minimum number of digits allowed in the integer portion of a
 number. minimumIntegerDigits must be

 See Also:

 getMinimumIntegerDigits

getMaximumFractionDigits

  public int getMaximumFractionDigits()

 Returns the maximum number of digits allowed in the fraction portion of a
 number.

 See Also:

 setMaximumFractionDigits

setMaximumFractionDigits

  public void setMaximumFractionDigits(int newValue)

 Sets the maximum number of digits allowed in the fraction portion of a
 number. maximumFractionDigits must be >= minimumFractionDigits.  If the
 new value for maximumFractionDigits is less than the current value
 of minimumFractionDigits, then minimumFractionDigits will also be set to
 the new value.

 See Also:

 getMaximumFractionDigits

getMinimumFractionDigits

  public int getMinimumFractionDigits()

 Returns the minimum number of digits allowed in the fraction portion of a
 number.

 See Also:

 setMinimumFractionDigits

setMinimumFractionDigits

  public void setMinimumFractionDigits(int newValue)

 Sets the minimum number of digits allowed in the fraction portion of a
 number. minimumFractionDigits must be

 See Also:

 getMinimumFractionDigits

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.text.ParseException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.text.ParseException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.text.ParseException

______________________________________________________________________________

 public class ParseException

 extends Exception

Signals that an error has been has been reached unexpectedly  while parsing.

See Also:

 Exception, Format, FieldPosition

______________________________________________________________________________

 	ParseException(String, int)

 Constructs a ParseException with the specified detail message and  offset.

 	getErrorOffset()

 Returns the position where the error was found.

 ParseException

  public ParseException(String s,
                        int errorOffset)

 Constructs a ParseException with the specified detail message and  offset.  A detail message is a String that describes this particular exception.

Parameters:

 s - the detail message

 errorOffset - the position where the error is found while parsing.

 getErrorOffset

  public int getErrorOffset()

 Returns the position where the error was found.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.text.ParsePosition

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.text.ParsePosition

java.lang.Object
   |
   +----java.text.ParsePosition

______________________________________________________________________________

 public class ParsePosition

 extends Object

ParsePosition is a simple class used by Format  and its subclasses to keep track of the current position during parsing.  The parseObject method in the various Format  classes requires a ParsePosition  object as an argument.

 By design, as you parse through a string with different formats,  you can use the same ParsePosition, since the index parameter  records the current position.

See Also:

 Format

______________________________________________________________________________

 	ParsePosition(int)

 Create a new ParsePosition with the given initial index.

 	getIndex()

 Retrieve the current parse position.

 	setIndex(int)

 Set the current parse position.

 ParsePosition

  public ParsePosition(int index)

 Create a new ParsePosition with the given initial index.

 getIndex

  public int getIndex()

 Retrieve the current parse position. On input to a parse method, this  is the index of the character at which parsing will begin; on output, it  is the index of the character following the last character parsed.

 setIndex

  public void setIndex(int index)

 Set the current parse position.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.text.RuleBasedCollator

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.text.RuleBasedCollator

java.lang.Object
   |
   +----java.text.Collator
           |
           +----java.text.RuleBasedCollator

______________________________________________________________________________

 public class RuleBasedCollator

 extends Collator

The RuleBasedCollator class is a concrete subclass of  Collator  that provides a simple, data-driven, table collator.  With this class you can create a customized table-based Collator.  RuleBasedCollator maps characters to sort keys.

RuleBasedCollator has the following restrictions  for efficiency (other subclasses may be used for more complex languages) :

1. The French secondary ordering is applied to the whole collator  object.

2. All non-mentioned Unicode characters are at the end of the  collation order.

3. Private use characters are treated as identical. The private  use area in Unicode is 0xE800-0xF8FF.

 The collation table is composed of a list of collation rules, where each  rule is of three forms:

 The following demonstrates how to create your own collation rules:

• Text-Argument : A text-argument is any sequence of  characters, excluding special characters (that is, whitespace   characters and the characters used in modifier, relation and reset).  If those characters are desired, you can put them in single quotes  (e.g. ampersand => '&').

• Modifier: There is a single modifier  which is used to specify that all accents (secondary differences) are  backwards.

'@' : Indicates that accents are sorted backwards, as in French.

• Relation: The relations are the following:

• '';' : Greater, as an accent difference (secondary)

• ',' : Greater, as a case difference (tertiary)

• '=' : Equal

• Reset: There is a single reset  which is used primarily for contractions and expansions, but which  can also be used to add a modification at the end of a set of rules.

'&' : Indicates that the next rule follows the position to where  the reset text-argument would be sorted.

 This sounds more complicated than it is in practice. For example, the  following are equivalent ways of expressing the same thing:

 a

 Notice that the order is important, as the subsequent item goes immediately
 after the text-argument. The following are not equivalent:

 a

 Either the text-argument must already be present in the sequence, or some
 initial substring of the text-argument must be present. (e.g. "a
 Ignorable Characters

 For ignorable characters, the first rule must start with a relation (the
 examples we have used above are really fragments; "a Normalization and Accents

 The Collator object automatically normalizes text internally
 to separate accents from base characters where possible. This is done both when
 processing the rules, and when comparing two strings. Collator
 also uses the Unicode canonical mapping to ensure that combining sequences
 are sorted properly (for more information, see
 The Unicode Standard, Version 2.0.)

Errors

 The following are errors:

• A text-argument not preceded by either a reset or relation character
        (e.g. "a A relation or reset character not followed by a text-argument
        (e.g. "a A reset where the text-argument (or an initial substring of the
         text-argument) is not already in the sequence.
         (e.g. "a
 If you produce one of these errors, a RuleBasedCollator throws
 a ParseException.

Examples

Simple:     "Norwegian:  "
 Normally, to create a rule-based Collator object, you will use
 Collator's factory method getInstance.
 However, to create a rule-based Collator object with specialized
 rules tailored to your needs, you construct the RuleBasedCollator
 with the rules contained in a String object. For example:

 String Simple = "

 Or:

 String Norwegian = "

 Combining Collators is as simple as concatenating strings.
 Here's an example that combines two Collators from two
 different locales:

 // Create an en_US Collator object
 RuleBasedCollator en_USCollator = (RuleBasedCollator)
     Collator.getInstance(new Locale("en", "US", ""));
 // Create a da_DK Collator object
 RuleBasedCollator da_DKCollator = (RuleBasedCollator)
     Collator.getInstance(new Locale("da", "DK", ""));
 // Combine the two
 // First, get the collation rules from en_USCollator
 String en_USRules = en_USCollator.getRules();
 // Second, get the collation rules from da_DKCollator
 String da_DKRules = da_DKCollator.getRules();
 RuleBasedCollator newCollator =
     new RuleBasedCollator(en_USRules + da_DKRules);
 // newCollator has the combined rules

 Another more interesting example would be to make changes on an existing
 table to create a new Collator object.  For example, add
 "& C en_USCollator object to create
 your own:

 // Create a new Collator object with additional rules
 String addRules = "& C

 The following example demonstrates how to change the order of
 non-spacing accents,

 // old rule
 String oldRules = "=?;?;?;?"    // main accents
                 + ";?;?;?;?"    // main accents
                 + ";?;?;?;?"    // main accents
                 + ";?;?;?;?"    // main accents
                 + ";?;?;?;?"    // main accents
                 + "

 The last example shows how to put new primary ordering in before the
 default setting. For example, in Japanese Collator, you
 can either sort English characters before or after Japanese characters,

 // get en_US Collator rules
 RuleBasedCollator en_USCollator = (RuleBasedCollator)Collator.getInstance(Locale.US);
 // add a few Japanese character to sort before English characters
 // suppose the last character before the first base letter 'a' in
 // the English collation rule is ?
 String jaString = "& ?

 See Also:

 Collator, CollationElementIterator

______________________________________________________________________________

        RuleBasedCollator(String)

  RuleBasedCollator constructor.

        clone()

  Standard override; no change in semantics.

        compare(String, String)

  Compares the character data stored in two different strings based on the
 collation rules.

        equals(Object)

  Compares the equality of two collation objects.

        getCollationElementIterator(String)

  Return a CollationElementIterator for the given String.

        getCollationKey(String)

  Transforms the string into a series of characters that can be compared
 with CollationKey.compareTo.

        getRules()

  Gets the table-based rules for the collation object.

        hashCode()

  Generates the hash code for the table-based collation object

RuleBasedCollator

  public RuleBasedCollator(String rules) throws ParseException

 RuleBasedCollator constructor.  This takes the table rules and builds
 a collation table out of them.  Please see RuleBasedCollator class
 description for more details on the collation rule syntax.

 Parameters:

 rules - the collation rules to build the collation table from.

 Throws: ParseException

 A format exception
 will be thrown if the build process of the rules fails. For
 example, build rule "a  See Also:

 Locale

getRules

  public String getRules()

 Gets the table-based rules for the collation object.

 Returns:

 returns the collation rules that the table collation object
 was created from.

getCollationElementIterator

  public CollationElementIterator getCollationElementIterator(String source)

 Return a CollationElementIterator for the given String.

 See Also:

 CollationElementIterator

compare

  public int compare(String source,
                     String target)

 Compares the character data stored in two different strings based on the
 collation rules.  Returns information about whether a string is less
 than, greater than or equal to another string in a language.
 This can be overriden in a subclass.

 Overrides:

 compare in class Collator

getCollationKey

  public CollationKey getCollationKey(String source)

 Transforms the string into a series of characters that can be compared
 with CollationKey.compareTo. This overrides java.text.Collator.getCollationKey.
 It can be overriden in a subclass.

 Overrides:

 getCollationKey in class Collator

clone

  public Object clone()

 Standard override; no change in semantics.

 Overrides:

 clone in class Collator

equals

  public boolean equals(Object obj)

 Compares the equality of two collation objects.

 Parameters:

 obj - the table-based collation object to be compared with this.

 Returns:

 true if the current table-based collation object is the same
 as the table-based collation object obj; false otherwise.

 Overrides:

 equals in class Collator

hashCode

  public int hashCode()

 Generates the hash code for the table-based collation object

 Overrides:

 hashCode in class Collator

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.text.SimpleDateFormat

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.text.SimpleDateFormat

java.lang.Object
   |
   +----java.text.Format
           |
           +----java.text.DateFormat
                   |
                   +----java.text.SimpleDateFormat

______________________________________________________________________________

 public class SimpleDateFormat

 extends DateFormat

SimpleDateFormat is a concrete class for formatting and  parsing dates in a locale-sensitive manner. It allows for formatting  (millis -> text), parsing (text -> millis), and normalization.

SimpleDateFormat allows you to start by choosing  any user-defined patterns for date-time formatting. However, you  are encouraged to create a date-time formatter with either  getTimeInstance, getDateInstance, or  getDateTimeInstance in DateFormat. Each  of these class methods can return a date/time formatter initialized  with a default format pattern. You may modify the format pattern  using the applyPattern methods as desired.  For more information on using these methods, see  DateFormat.

Time Format Syntax:

 To specify the time format use a time pattern string.  In this pattern, all ASCII letters are reserved as pattern letters,  which are defined as the following:

 Symbol   Meaning                 Presentation        Example
 ------   -------                 ------------        -------
 G        era designator          (Text)              AD
 y        year                    (Number)            1996
 M        month in year           (Text & Number)     July & 07
 d        day in month            (Number)            10
 h        hour in am/pm (1~12)    (Number)            12
 H        hour in day (0~23)      (Number)            0
 m        minute in hour          (Number)            30
 s        second in minute        (Number)            55
 S        millisecond             (Number)            978
 E        day in week             (Text)              Tuesday
 D        day in year             (Number)            189
 F        day of week in month    (Number)            2 (2nd Wed in July)
 w        week in year            (Number)            27
 W        week in month           (Number)            2
 a        am/pm marker            (Text)              PM
 k        hour in day (1~24)      (Number)            24
 K        hour in am/pm (0~11)    (Number)            0
 z        time zone               (Text)              Pacific Standard Time
 '        escape for text
 ''        single quote                              '

 The count of pattern letters determine the format.

(Text): 4 or more pattern letters--use full form,  < 4--use short or abbreviated form if one exists.

(Number): the minimum number of digits. Shorter  numbers are zero-padded to this amount. Year is handled specially;  that is, if the count of 'y' is 2, the Year will be truncated to 2 digits.

(Text & Number): 3 or over, use text, otherwise use number.

 Any characters in the pattern that are not in the ranges of ['a'..'z']  and ['A'..'Z'] will be treated as quoted text. For instance, characters  like ':', '.', ' ', '#' and '@' will appear in the resulting time text  even they are not embraced within single quotes.

 A pattern containing any invalid pattern letter will result in a thrown  exception during formatting or parsing.

Examples Using the US Locale:

 Format Pattern                         Result
 --------------                         -------
 "yyyy.MM.dd G 'at' hh:mm:ss z"    ->>  1996.07.10 AD at 15:08:56 PDT
 "EEE, MMM d, ''yy"                ->>  Wed, July 10, '96
 "h:mm a"                          ->>  12:08 PM
 "hh 'o''''clock' a, zzzz"         ->>  12 o'clock PM, Pacific Daylight Time
 "K:mm a, z"                       ->>  0:00 PM, PST
 "yyyyy.MMMMM.dd GGG hh:mm aaa"    ->>  1996.July.10 AD 12:08 PM

Code Sample:

 SimpleTimeZone pdt = new SimpleTimeZone(-8 * 60 * 60 * 1000, "PST");
 pdt.setStartRule(DateFields.APRIL, 1, DateFields.SUNDAY, 2*60*60*1000);
 pdt.setEndRule(DateFields.OCTOBER, -1, DateFields.SUNDAY, 2*60*60*1000);
 // Format the current time.
 SimpleDateFormat formatter
     = new SimpleDateFormat ("yyyy.mm.dd e 'at' hh:mm:ss a zzz");
 Date currentTime_1 = new Date();
 String dateString = formatter.format(currentTime_1);
 // Parse the previous string back into a Date.
 ParsePosition pos = new ParsePosition(0);
 Date currentTime_2 = formatter.parse(dateString, pos);

 In the example, the time value currentTime_2 obtained from  parsing will be equal to currentTime_1. However, they may not be  equal if the am/pm marker 'a' is left out from the format pattern while  the "hour in am/pm" pattern symbol is used. This information loss can  happen when formatting the time in PM.

 For time zones that have no names, use strings GMT+hours:minutes or  GMT-hours:minutes.

 The calendar defines what is the first day of the week, the first week  of the year, whether hours are zero based or not (0 vs 12 or 24), and the  time zone. There is one common decimal format to handle all the numbers;  the digit count is handled programmatically according to the pattern.

See Also:

Calendar, GregorianCalendar, TimeZone, DateFormat, DateFormatSymbols, DecimalFormat

______________________________________________________________________________

 	SimpleDateFormat()

 Construct a SimpleDateFormat using the default pattern for the default  locale.

 	SimpleDateFormat(String)

 Construct a SimpleDateFormat using the given pattern in the default  locale.

 	SimpleDateFormat(String, DateFormatSymbols)

 Construct a SimpleDateFormat using the given pattern and  locale-specific symbol data.

 	SimpleDateFormat(String, Locale)

 Construct a SimpleDateFormat using the given pattern and locale.

 	applyLocalizedPattern(String)

 Apply the given localized pattern string to this date format.

 	applyPattern(String)

 Apply the given unlocalized pattern string to this date format.

 	clone()

 Overrides Cloneable

 	equals(Object)

 Override equals.

 	format(Date, StringBuffer, FieldPosition)

 Overrides DateFormat

Formats a date or time, which is the standard millis  since 24:00 GMT, Jan 1, 1970.

 	getDateFormatSymbols()

 Gets the date/time formatting data.

 	hashCode()

 Override hashCode.

 	parse(String, ParsePosition)

 Overrides DateFormat

 	setDateFormatSymbols(DateFormatSymbols)

 Allows you to set the date/time formatting data.

 	toLocalizedPattern()

 Return a localized pattern string describing this date format.

 	toPattern()

 Return a pattern string describing this date format.

 SimpleDateFormat

  public SimpleDateFormat()

 Construct a SimpleDateFormat using the default pattern for the default  locale. Note: Not all locales support SimpleDateFormat; for full  generality, use the factory methods in the DateFormat class.

See Also:

DateFormat

 SimpleDateFormat

  public SimpleDateFormat(String pattern)

 Construct a SimpleDateFormat using the given pattern in the default  locale. Note: Not all locales support SimpleDateFormat; for full  generality, use the factory methods in the DateFormat class.

 SimpleDateFormat

  public SimpleDateFormat(String pattern,
                          Locale loc)

 Construct a SimpleDateFormat using the given pattern and locale.  Note: Not all locales support SimpleDateFormat; for full  generality, use the factory methods in the DateFormat class.

 SimpleDateFormat

  public SimpleDateFormat(String pattern,
                          DateFormatSymbols formatData)

 Construct a SimpleDateFormat using the given pattern and  locale-specific symbol data.

 format

  public StringBuffer format(Date date,
                             StringBuffer toAppendTo,
                             FieldPosition pos)

 Overrides DateFormat

Formats a date or time, which is the standard millis  since 24:00 GMT, Jan 1, 1970.

Example: using the US locale:  "yyyy.MM.dd e 'at' HH:mm:ss zzz" ->> 1996.07.10 AD at 15:08:56 PDT

Parameters:

 date - the date-time value to be formatted into a date-time string.

 toAppendTo - where the new date-time text is to be appended.

 pos - the formatting position. On input: an alignment field,  if desired. On output: the offsets of the alignment field.

Returns:

 the formatted date-time string.

Overrides:

format in class DateFormat

See Also:

 DateFormat

 parse

  public Date parse(String text,
                    ParsePosition pos)

 Overrides DateFormat

Overrides:

parse in class DateFormat

See Also:

 DateFormat

 toPattern

  public String toPattern()

 Return a pattern string describing this date format.

 toLocalizedPattern

  public String toLocalizedPattern()

 Return a localized pattern string describing this date format.

 applyPattern

  public void applyPattern(String pattern)

 Apply the given unlocalized pattern string to this date format.

 applyLocalizedPattern

  public void applyLocalizedPattern(String pattern)

 Apply the given localized pattern string to this date format.

 getDateFormatSymbols

  public DateFormatSymbols getDateFormatSymbols()

 Gets the date/time formatting data.

Returns:

 a copy of the date-time formatting data associated  with this date-time formatter.

 setDateFormatSymbols

  public void setDateFormatSymbols(DateFormatSymbols newFormatSymbols)

 Allows you to set the date/time formatting data.

Parameters:

 newFormatData - the given date-time formatting data.

 clone

  public Object clone()

 Overrides Cloneable

Overrides:

clone in class DateFormat

 hashCode

  public int hashCode()

 Override hashCode.  Generates the hash code for the SimpleDateFormat object

Overrides:

hashCode in class DateFormat

 equals

  public boolean equals(Object obj)

 Override equals.

Overrides:

equals in class DateFormat

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.text.StringCharacterIterator

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.text.StringCharacterIterator

java.lang.Object
   |
   +----java.text.StringCharacterIterator

______________________________________________________________________________

 public final class StringCharacterIterator

 extends Object

 implements CharacterIterator

StringCharacterIterator implements the  CharacterIterater protocol for a String.  The StringCharacterIterator class iterates over the  entire String.

Examples:

 Traverse the text from start to finish

 public void traverseForward(CharacterIterator iter) {
     for (char c = iter.first(); c != CharacterIterator.DONE; c = iter.next()) {
         processChar(c);
     }
 }

 Traverse the text backwards, from end to start

 public void traverseBackward(CharacterIterator iter) {
     for (char c = iter.last(); c != CharacterIterator.DONE; c = iter.prev()) {
         processChar(c);
     }
 }

 Traverse both forward and backward from a given position in the text.

 public void traverseOut(CharacterIterator iter, int pos) {
     for (char c = iter.setIndex(pos);
          c != CharacterIterator.DONE && notBoundary(c);
          c = iter.next()) {}
     int end = iter.getIndex();
     for (char c = iter.setIndex(pos);
          c != CharacterIterator.DONE && notBoundary(c);
          c = iter.prev()) {}
     int start = iter.getIndex();
     processSection(iter.getText.subString(start,end);
 }

______________________________________________________________________________

 	StringCharacterIterator(String)

 Construct an iterator with an initial index of 0.

 	StringCharacterIterator(String, int)

 Construct an iterator with the specified initial index.

 	StringCharacterIterator(String, int, int, int)

 Construct an iterator over the given range of the given string, with the  index set at the specified position.

 	clone()

 Create a copy of this boundary

 	current()

 Get the character at the current position (as returned by getIndex()).

 	equals(Object)

 Compares the equality of two StringCharacterIterator objects.

 	first()

 Set the position to getBeginIndex() and return the character at that  position.

 	getBeginIndex()

 Return the start index of the text.

 	getEndIndex()

 Return the end index of the text.

 	getIndex()

 Return the current index.

 	hashCode()

 Compute a hashcode for this enumeration

 	last()

 Set the position to getEndIndex() and return the character at that  position.

 	next()

 Increment the iterator's index by one and return the character  at the new index.

 	previous()

 Decrement the iterator's index by one and return the character  at the new index.

 	setIndex(int)

 Set the position to specified position in the text and return that  character.

 StringCharacterIterator

  public StringCharacterIterator(String text)

 Construct an iterator with an initial index of 0.

 StringCharacterIterator

  public StringCharacterIterator(String text,
                                 int pos)

 Construct an iterator with the specified initial index.

Parameters:

 text - The String to be iterated over

 pos - Initial iterator position

 StringCharacterIterator

  public StringCharacterIterator(String text,
                                 int begin,
                                 int end,
                                 int pos)

 Construct an iterator over the given range of the given string, with the  index set at the specified position.

Parameters:

 text - The String to be iterated over

 begin - Index of the first character

 end - Index of the character following the last character

 pos - Initial iterator position

 first

  public char first()

 Set the position to getBeginIndex() and return the character at that  position.

 last

  public char last()

 Set the position to getEndIndex() and return the character at that  position.

 setIndex

  public char setIndex(int p)

 Set the position to specified position in the text and return that  character.

 current

  public char current()

 Get the character at the current position (as returned by getIndex()).

Returns:

 the character at the current position or DONE if the current  position is off the end of the text.

 next

  public char next()

 Increment the iterator's index by one and return the character  at the new index. If the resulting index is greater or equal  to getEndIndex(), the current index is reset to getEndIndex() and  a value of DONE is returned.

Returns:

 the character at the new position or DONE if the current  position is off the end of the text.

 previous

  public char previous()

 Decrement the iterator's index by one and return the character  at the new index. If the resulting index is  less than getBeginIndex(), the current index is reset to getBeginIndex()  and a value of DONE is returned.

Returns:

 the character at the new position or DONE if the current  position is off the end of the text.

 getBeginIndex

  public int getBeginIndex()

 Return the start index of the text.

Returns:

 the index at which the text begins.

 getEndIndex

  public int getEndIndex()

 Return the end index of the text. This index is the index of the  first character following the end of the text.

Returns:

 the index at which the text end.

 getIndex

  public int getIndex()

 Return the current index.

Returns:

 the current index.

 equals

  public boolean equals(Object obj)

 Compares the equality of two StringCharacterIterator objects.

Parameters:

 obj - the StringCharacterIterator object to be compared with.

Returns:

 true if the given obj is the same as this  StringCharacterIterator object; false otherwise.

Overrides:

equals in class Object

 hashCode

  public int hashCode()

 Compute a hashcode for this enumeration

Returns:

 A hash code

Overrides:

hashCode in class Object

 clone

  public Object clone()

 Create a copy of this boundary

Returns:

 A copy of this

Overrides:

clone in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.BitSet

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.BitSet

java.lang.Object
   |
   +----java.util.BitSet

______________________________________________________________________________

 public final class BitSet

 extends Object

 implements Cloneable, Serializable

This class implements a vector of bits that grows as needed. Each  component of the bit set has a boolean value. The  bits of a BitSet are indexed by nonnegative integers.  Individual indexed bits can be examined, set, or cleared.

 By default, all bits in the set initially have the value  false.

 Every bit set has a current size, which is the number of bits  currently in the bit set.

______________________________________________________________________________

 	BitSet()

 Creates a new bit set.

 	BitSet(int)

 Creates a bit set whose initial size is the specified number of  bits.

 	and(BitSet)

 Performs a logical AND of this target bit set with the  argument bit set.

 	clear(int)

 Sets the bit specified by the index to false.

 	clone()

 Clones this BitSet.

 	equals(Object)

 Compares this object against the specified object.

 	get(int)

 Returns the value of the bit with the specified index.

 	hashCode()

 Returns a hash code value for this bit set.

 	or(BitSet)

 Performs a logical OR of this bit set with the bit set  argument.

 	set(int)

 Sets the bit specified by the index to true.

 	size()

 Returns the number of bits currently in this bit set.

 	toString()

 Returns a string representation of this bit set.

 	xor(BitSet)

 Performs a logical XOR of this bit set with the bit set  argument.

 BitSet

  public BitSet()

 Creates a new bit set. All bits are initially false.

 BitSet

  public BitSet(int nbits)

 Creates a bit set whose initial size is the specified number of  bits. All bits are initially false.

Parameters:

 nbits - the initial size of the bit set.

 set

  public void set(int bit)

 Sets the bit specified by the index to true.

Parameters:

 bit - a bit index.

 clear

  public void clear(int bit)

 Sets the bit specified by the index to false.

Parameters:

 bit - the index of the bit to be cleared.

 get

  public boolean get(int bit)

 Returns the value of the bit with the specified index.

Parameters:

 bit - the bit index.

Returns:

 the value of the bit with the specified index.

 and

  public void and(BitSet set)

 Performs a logical AND of this target bit set with the  argument bit set. This bit set is modified so that each bit in it  has the value true  if and only if it both initially  had the value true and the corresponding bit in the  bit set argument also had the value true.

Parameters:

 set - a bit set.

 or

  public void or(BitSet set)

 Performs a logical OR of this bit set with the bit set  argument. This bit set is modified so that a bit in it has the  value true  if and only if it either already had the  value true  or the corresponding bit in the bit set  argument has the value true.

Parameters:

 set - a bit set.

 xor

  public void xor(BitSet set)

 Performs a logical XOR of this bit set with the bit set  argument. This bit set is modified so that a bit in it has the  value true  if and only if one of the following  statements holds:

• The bit initially has the value true, and the  corresponding bit in the argument has the value false.

• The bit initially has the value false, and the  corresponding bit in the argument has the value true.

Parameters:

 set - a bit set.

 hashCode

  public int hashCode()

 Returns a hash code value for this bit set.

Returns:

 a hash code value for this bit set.

Overrides:

hashCode in class Object

 size

  public int size()

 Returns the number of bits currently in this bit set.

Returns:

 the number of bits currently in this bit set.

 equals

  public boolean equals(Object obj)

 Compares this object against the specified object.  The result is true if and only if the argument is  not null and is a Bitset  object that has  exactly the same set of bits set to true as this bit  set. The current sizes of the two bit sets are not compared.

Parameters:

 obj - the object to compare with.

Returns:

true if the objects are the same;  false otherwise.

Overrides:

equals in class Object

See Also:

size

 clone

  public Object clone()

 Clones this BitSet.  The clone of the bit set is another bit set that has exactly the  same bits set to true  as this bit set and the same  current size.

Returns:

 a clone of this bit set.

Overrides:

clone in class Object

See Also:

size

 toString

  public String toString()

 Returns a string representation of this bit set.

Returns:

 a string representation of this bit set.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.Calendar

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.Calendar

java.lang.Object
   |
   +----java.util.Calendar

______________________________________________________________________________

 public class Calendar

 extends Object

 implements Serializable, Cloneable

Calendar is an abstract base class for converting between  a Date  object and a set of integer fields such as  YEAR, MONTH, DAY, HOUR,  and so on. (A Date object represents a specific instant in  time with millisecond precision. See  java.util.Date  for information about the Date class.)

 Subclasses of Calendar interpret a Date  according to the rules of a specific calendar system. The JDK  provides one concrete subclass of Calendar:  GregorianCalendar. Future subclasses could represent  the various types of lunar calendars in use in many parts of the world.

 Like other locale-sensitive classes, Calendar provides a  class method, getInstance, for getting a generally useful  object of this type. Calendar's getInstance method  returns a GregorianCalendar object whose  time fields have been initialized with the current date and time:

 Calendar rightNow = Calendar.getInstance();

 A Calendar object can produce all the time field values  needed to implement the date-time formatting for a particular language  and calendar style (for example, Japanese-Gregorian, Japanese-Traditional).

 When computing a Date from time fields, two special circumstances  may arise: there may be insufficient information to compute the  Date  (such as only year and month but no day in the month),  or there may be inconsistent information (such as "Tuesday, July 15, 1996"  -- July 15, 1996 is actually a Monday).

Insufficient information. The calendar will use default  information to specify the missing fields. This may vary by calendar; for  the Gregorian calendar, the default for a field is the same as that of the  start of the epoch: i.e., YEAR = 1970, MONTH = JANUARY, DATE = 1, etc.

Inconsistent information. The calendar will give preference  to the combinations of fields in the following order (and disregard other  inconsistent information).

 month + day-of-month
 month + week-of-month + day-of-week
 month + day-of-week-of-month + day-of-week
 day-of-year
 day-of-week + week-of-year
 hour-of-day
 ampm + hour-of-ampm

Note: for some non-Gregorian calendars, different  fields may be necessary for complete disambiguation. For example, a full  specification of the historial Arabic astronomical calendar requires year,  month, day-of-month and day-of-week in some cases.

Note: There are certain possible ambiguities in  interpretation of certain singular times, which are resolved in the  following ways:

1.  24:00:00 "belongs" to the following day. That is,  23:59 on Dec 31, 1969 < 24:00 on Jan 1, 1970 < 24:01:00 on Jan 1, 1970

2.  Although historically not precise, midnight also belongs to "am",  and noon belongs to "pm", so on the same day,  12:00 am (midnight) < 12:01 am, and 12:00 pm (noon) < 12:01 pm

 The date or time format strings are not part of the definition of a  calendar, as those must be modifiable or overridable by the user at  runtime. Use java.text.DateFormat  to format dates.

Calendar provides an API for field "rolling", where fields  can be incremented or decremented, but wrap around. For example, rolling the  month up in the date "September 12, 1996" results in "October 12, 1996".

Calendar also provides a date arithmetic function for  adding the specified (signed) amount of time to a particular time field.  For example, subtracting 5 days from the date "September 12, 1996" results  in "September 7, 1996".

See Also:

Date, GregorianCalendar, TimeZone, DateFormat

______________________________________________________________________________

 	AM

 Useful constant for hour in 12-hour clock.

 	AM_PM

 Useful constant for date and time.

 	APRIL

 Useful constant for month.

 	areFieldsSet

 The flag which tells if the time fields are set for the calendar.

 	AUGUST

 Useful constant for month.

 	DATE

 Useful constant for date and time.

 	DAY_OF_MONTH

 Useful constant for date and time.

 	DAY_OF_WEEK

 Useful constant for date and time.

 	DAY_OF_WEEK_IN_MONTH

 Useful constant for date and time.

 	DAY_OF_YEAR

 Useful constant for date and time.

 	DECEMBER

 Useful constant for month.

 	DST_OFFSET

 Useful constant for date and time.

 	ERA

 Useful constant for date and time.

 	FEBRUARY

 Useful constant for month.

 	FIELD_COUNT

 Useful constant for date and time.

 	fields

 The time fields containing values into which the millis is computed.

 	FRIDAY

 Useful constant for days of week.

 	HOUR

 Useful constant for date and time.

 	HOUR_OF_DAY

 Useful constant for date and time.

 	isSet

 The flags which tell if a specified time field for the calendar is set.

 	isTimeSet

 The flag which indicates if the current time is set for the calendar.

 	JANUARY

 Useful constant for month.

 	JULY

 Useful constant for month.

 	JUNE

 Useful constant for month.

 	MARCH

 Useful constant for month.

 	MAY

 Useful constant for month.

 	MILLISECOND

 Useful constant for date and time.

 	MINUTE

 Useful constant for date and time.

 	MONDAY

 Useful constant for days of week.

 	MONTH

 Useful constant for date and time.

 	NOVEMBER

 Useful constant for month.

 	OCTOBER

 Useful constant for month.

 	PM

 Useful constant for hour in 12-hour clock.

 	SATURDAY

 Useful constant for days of week.

 	SECOND

 Useful constant for date and time.

 	SEPTEMBER

 Useful constant for month.

 	SUNDAY

 Useful constant for days of week.

 	THURSDAY

 Useful constant for days of week.

 	time

 The current time set for the calendar.

 	TUESDAY

 Useful constant for days of week.

 	UNDECIMBER

 Useful constant for month.

 	WEDNESDAY

 Useful constant for days of week.

 	WEEK_OF_MONTH

 Useful constant for date and time.

 	WEEK_OF_YEAR

 Useful constant for date and time.

 	YEAR

 Useful constant for date and time.

 	ZONE_OFFSET

 Useful constant for date and time.

 	Calendar()

 Constructs a Calendar with the default time zone as returned  by TimeZone.getDefault(), and the default locale.

 	Calendar(TimeZone, Locale)

 Constructs a Calendar with the given time zone and locale.

 	add(int, int)

 Date Arithmetic function.

 	after(Object)

 Compares the time field records.

 	before(Object)

 Compares the time field records.

 	clear()

 Clears the values of all the time fields.

 	clear(int)

 Clears the value in the given time field.

 	clone()

 Overrides Cloneable

 	complete()

 Fills in any unset fields in the time field list.

 	computeFields()

 Converts UTC as milliseconds to time field values.

 	computeTime()

 Converts Calendar's time field values to UTC as milliseconds.

 	equals(Object)

 Compares the time field records.

 	get(int)

 Gets the value for a given time field.

 	getAvailableLocales()

 Gets the set of locales for which Calendars are installed.

 	getFirstDayOfWeek()

 Gets what the first day of the week is; e.g., Sunday in US,  Monday in France.

 	getGreatestMinimum(int)

 Gets the highest minimum value for the given field if varies.

 	getInstance()

 Gets a Calendar using the default timezone and locale.

 	getInstance(Locale)

 Gets a Calendar using the default timezone and given locale.

 	getInstance(TimeZone)

 Gets a Calendar using the given timezone and default locale.

 	getInstance(TimeZone, Locale)

 Gets a Calendar using the given timezone and given locale.

 	getLeastMaximum(int)

 Gets the lowest maximum value for the given field if varies.

 	getMaximum(int)

 Gets the maximum value for the given time field.

 	getMinimalDaysInFirstWeek()

 Gets what the minimal days required in the first week of the year are;  e.g., if the first week is defined as one that contains the first day  of the first month of a year, getMinimalDaysInFirstWeek returns 1.

 	getMinimum(int)

 Gets the minimum value for the given time field.

 	getTime()

 Gets this Calendar's current time.

 	getTimeInMillis()

 Gets this Calendar's current time as a long.

 	getTimeZone()

 Gets the time zone.

 	internalGet(int)

 Gets the value for a given time field.

 	isLenient()

 Tell whether date/time interpretation is to be lenient.

 	isSet(int)

 Determines if the given time field has a value set.

 	roll(int, boolean)

 Time Field Rolling function.

 	set(int, int)

 Sets the time field with the given value.

 	set(int, int, int)

 Sets the values for the fields year, month, and date.

 	set(int, int, int, int, int)

 Sets the values for the fields year, month, date, hour, and minute.

 	set(int, int, int, int, int, int)

 Sets the values for the fields year, month, date, hour, minute,  and second.

 	setFirstDayOfWeek(int)

 Sets what the first day of the week is; e.g., Sunday in US,  Monday in France.

 	setLenient(boolean)

 Specify whether or not date/time interpretation is to be lenient.

 	setMinimalDaysInFirstWeek(int)

 Sets what the minimal days required in the first week of the year are;  For example, if the first week is defined as one that contains the first  day of the first month of a year, call the method with value 1.

 	setTime(Date)

 Sets this Calendar's current time with the given Date.

 	setTimeInMillis(long)

 Sets this Calendar's current time from the given long value.

 	setTimeZone(TimeZone)

 Sets the time zone with the given time zone value.

 ERA

  public final static int ERA

 Useful constant for date and time. Used in time fields.  ERA is calendar specific.

 YEAR

  public final static int YEAR

 Useful constant for date and time. Used in time fields.

 MONTH

  public final static int MONTH

 Useful constant for date and time. Used in time fields.

 WEEK_OF_YEAR

  public final static int WEEK_OF_YEAR

 Useful constant for date and time. Used in time fields.

 WEEK_OF_MONTH

  public final static int WEEK_OF_MONTH

 Useful constant for date and time. Used in time fields.

 DATE

  public final static int DATE

 Useful constant for date and time. Used in time fields.  DATE is the time field name for day-of-month.

 DAY_OF_MONTH

  public final static int DAY_OF_MONTH

 Useful constant for date and time. Used in time fields.  This is a synonym for DATE.

 DAY_OF_YEAR

  public final static int DAY_OF_YEAR

 Useful constant for date and time. Used in time fields.

 DAY_OF_WEEK

  public final static int DAY_OF_WEEK

 Useful constant for date and time. Used in time fields.

 DAY_OF_WEEK_IN_MONTH

  public final static int DAY_OF_WEEK_IN_MONTH

 Useful constant for date and time. Used in time fields.

 AM_PM

  public final static int AM_PM

 Useful constant for date and time. Used in time fields.

 HOUR

  public final static int HOUR

 Useful constant for date and time. Used in time fields.  HOUR is used for the 12-hour clock.

 HOUR_OF_DAY

  public final static int HOUR_OF_DAY

 Useful constant for date and time. Used in time fields.  HOUR_OF_DAY is used for the 24-hour clock.

 MINUTE

  public final static int MINUTE

 Useful constant for date and time. Used in time fields.

 SECOND

  public final static int SECOND

 Useful constant for date and time. Used in time fields.

 MILLISECOND

  public final static int MILLISECOND

 Useful constant for date and time. Used in time fields.

 ZONE_OFFSET

  public final static int ZONE_OFFSET

 Useful constant for date and time. Used in time fields.

 DST_OFFSET

  public final static int DST_OFFSET

 Useful constant for date and time. Used in time fields.

 FIELD_COUNT

  public final static int FIELD_COUNT

 Useful constant for date and time.  FIELD_COUNT is used for the time field array creation.

 SUNDAY

  public final static int SUNDAY

 Useful constant for days of week. Used in GregorianCalendar.

 MONDAY

  public final static int MONDAY

 Useful constant for days of week. Used in GregorianCalendar.

 TUESDAY

  public final static int TUESDAY

 Useful constant for days of week. Used in GregorianCalendar.

 WEDNESDAY

  public final static int WEDNESDAY

 Useful constant for days of week. Used in GregorianCalendar.

 THURSDAY

  public final static int THURSDAY

 Useful constant for days of week. Used in GregorianCalendar.

 FRIDAY

  public final static int FRIDAY

 Useful constant for days of week. Used in GregorianCalendar.

 SATURDAY

  public final static int SATURDAY

 Useful constant for days of week. Used in GregorianCalendar.

 JANUARY

  public final static int JANUARY

 Useful constant for month. Used in GregorianCalendar.  Note: Calendar month is now 0-based.

 FEBRUARY

  public final static int FEBRUARY

 Useful constant for month. Used in GregorianCalendar.

 MARCH

  public final static int MARCH

 Useful constant for month. Used in GregorianCalendar.

 APRIL

  public final static int APRIL

 Useful constant for month. Used in GregorianCalendar.

 MAY

  public final static int MAY

 Useful constant for month. Used in GregorianCalendar.

 JUNE

  public final static int JUNE

 Useful constant for month. Used in GregorianCalendar.

 JULY

  public final static int JULY

 Useful constant for month. Used in GregorianCalendar.

 AUGUST

  public final static int AUGUST

 Useful constant for month. Used in GregorianCalendar.

 SEPTEMBER

  public final static int SEPTEMBER

 Useful constant for month. Used in GregorianCalendar.

 OCTOBER

  public final static int OCTOBER

 Useful constant for month. Used in GregorianCalendar.

 NOVEMBER

  public final static int NOVEMBER

 Useful constant for month. Used in GregorianCalendar.

 DECEMBER

  public final static int DECEMBER

 Useful constant for month. Used in GregorianCalendar.

 UNDECIMBER

  public final static int UNDECIMBER

 Useful constant for month. Used in GregorianCalendar.  UNDECIMBER is an artifical name. This 13th month is for lunar  calendars.

 AM

  public final static int AM

 Useful constant for hour in 12-hour clock. Used in GregorianCalendar.

 PM

  public final static int PM

 Useful constant for hour in 12-hour clock. Used in GregorianCalendar.

 fields

  protected int fields[]

 The time fields containing values into which the millis is computed.

 isSet

  protected boolean isSet[]

 The flags which tell if a specified time field for the calendar is set.

 time

  protected long time

 The current time set for the calendar.

 isTimeSet

  protected boolean isTimeSet

 The flag which indicates if the current time is set for the calendar.

 areFieldsSet

  protected boolean areFieldsSet

 The flag which tells if the time fields are set for the calendar.

 Calendar

  protected Calendar()

 Constructs a Calendar with the default time zone as returned  by TimeZone.getDefault(), and the default locale.

See Also:

getDefault

 Calendar

  protected Calendar(TimeZone zone,
                     Locale aLocale)

 Constructs a Calendar with the given time zone and locale.

Parameters:

 zone - the given time zone.

 getInstance

  public static synchronized Calendar getInstance()

 Gets a Calendar using the default timezone and locale.

Returns:

 a Calendar.

 getInstance

  public static synchronized Calendar getInstance(TimeZone zone)

 Gets a Calendar using the given timezone and default locale.

Parameters:

 zone - the given timezone.

Returns:

 a Calendar.

 getInstance

  public static synchronized Calendar getInstance(Locale aLocale)

 Gets a Calendar using the default timezone and given locale.

Parameters:

 aLocale - the given locale.

Returns:

 a Calendar.

 getInstance

  public static synchronized Calendar getInstance(TimeZone zone,
                                                  Locale aLocale)

 Gets a Calendar using the given timezone and given locale.

Parameters:

 zone - the given timezone.

 aLocale - the given locale.

Returns:

 a Calendar.

 getAvailableLocales

  public static synchronized Locale[] getAvailableLocales()

 Gets the set of locales for which Calendars are installed.

Returns:

 the set of locales for which Calendars are installed.

 computeTime

  protected abstract void computeTime()

 Converts Calendar's time field values to UTC as milliseconds.

 computeFields

  protected abstract void computeFields()

 Converts UTC as milliseconds to time field values.  This allows you to sync up the time field values with  a new time that is set for the calendar.

 getTime

  public final Date getTime()

 Gets this Calendar's current time.

Returns:

 the current time.

 setTime

  public final void setTime(Date date)

 Sets this Calendar's current time with the given Date.

Parameters:

 date - the given Date.

 getTimeInMillis

  protected long getTimeInMillis()

 Gets this Calendar's current time as a long.

Returns:

 the current time as milliseconds from the epoch.

 setTimeInMillis

  protected void setTimeInMillis(long millis)

 Sets this Calendar's current time from the given long value.

Parameters:

 date - the new time in milliseconds from the epoch.

 get

  public final int get(int field)

 Gets the value for a given time field.

Parameters:

 field - the given time field.

Returns:

 the value for the given time field.

 internalGet

  protected final int internalGet(int field)

 Gets the value for a given time field. This is an internal  fast time field value getter for the subclasses.

Parameters:

 field - the given time field.

Returns:

 the value for the given time field.

 set

  public final void set(int field,
                        int value)

 Sets the time field with the given value.

Parameters:

 field - the given time field.

 value - the value to be set for the given time field.

 set

  public final void set(int year,
                        int month,
                        int date)

 Sets the values for the fields year, month, and date.

Parameters:

 year - the value used to set the YEAR time field.

 month - the value used to set the MONTH time field.  Month value is 0-based. e.g., 0 for January.

 date - the value used to set the DATE time field.

 set

  public final void set(int year,
                        int month,
                        int date,
                        int hour,
                        int minute)

 Sets the values for the fields year, month, date, hour, and minute.

Parameters:

 year - the value used to set the YEAR time field.

 month - the value used to set the MONTH time field.  Month value is 0-based. e.g., 0 for January.

 date - the value used to set the DATE time field.

 hour - the value used to set the HOUR_OF_DAY time field.

 minute - the value used to set the MINUTE time field.

 set

  public final void set(int year,
                        int month,
                        int date,
                        int hour,
                        int minute,
                        int second)

 Sets the values for the fields year, month, date, hour, minute,  and second.

Parameters:

 year - the value used to set the YEAR time field.

 month - the value used to set the MONTH time field.  Month value is 0-based. e.g., 0 for January.

 date - the value used to set the DATE time field.

 hour - the value used to set the HOUR_OF_DAY time field.

 minute - the value used to set the MINUTE time field.

 second - the value used to set the SECOND time field.

 clear

  public final void clear()

 Clears the values of all the time fields.

 clear

  public final void clear(int field)

 Clears the value in the given time field.

Parameters:

 field - the time field to be cleared.

 isSet

  public final boolean isSet(int field)

 Determines if the given time field has a value set.

Returns:

 true if the given time field has a value set; false otherwise.

 complete

  protected void complete()

 Fills in any unset fields in the time field list.

 equals

  public abstract boolean equals(Object when)

 Compares the time field records.  Equivalent to comparing result of conversion to UTC.

Parameters:

 when - the Calendar to be compared with this Calendar.

Returns:

 true if the current time of this Calendar is equal  to the time of Calendar when; false otherwise.

Overrides:

equals in class Object

 before

  public abstract boolean before(Object when)

 Compares the time field records.  Equivalent to comparing result of conversion to UTC.

Parameters:

 when - the Calendar to be compared with this Calendar.

Returns:

 true if the current time of this Calendar is before  the time of Calendar when; false otherwise.

 after

  public abstract boolean after(Object when)

 Compares the time field records.  Equivalent to comparing result of conversion to UTC.

Parameters:

 when - the Calendar to be compared with this Calendar.

Returns:

 true if the current time of this Calendar is after  the time of Calendar when; false otherwise.

 add

  public abstract void add(int field,
                           int amount)

 Date Arithmetic function.  Adds the specified (signed) amount of time to the given time field,  based on the calendar's rules. For example, to subtract 5 days from  the current time of the calendar, you can achieve it by calling:

add(Calendar.DATE, -5).

Parameters:

 field - the time field.

 amount - the amount of date or time to be added to the field.

 roll

  public abstract void roll(int field,
                            boolean up)

 Time Field Rolling function.  Rolls (up/down) a single unit of time on the given time field. For  example, to roll the current date up by one day, you can achieve it  by calling:

roll(Calendar.DATE, true).  When rolling on the year or Calendar.YEAR field, it will roll the year  value in the range between 1 and the value returned by calling  getMaximum(Calendar.YEAR).  When rolling on the month or Calendar.MONTH field, other fields like  date might conflict and, need to be changed. For instance,  rolling the month on the date 01/31/96 will result in 03/02/96.  When rolling on the hour-in-day or Calendar.HOUR_OF_DAY field, it will  roll the hour value in the range between 0 and 23, which is zero-based.

Parameters:

 field - the time field.

 up - indicates if the value of the specified time field is to be  rolled up or rolled down. Use true if rolling up, false otherwise.

 setTimeZone

  public void setTimeZone(TimeZone value)

 Sets the time zone with the given time zone value.

Parameters:

 value - the given time zone.

 getTimeZone

  public TimeZone getTimeZone()

 Gets the time zone.

Returns:

 the time zone object associated with this calendar.

 setLenient

  public void setLenient(boolean lenient)

 Specify whether or not date/time interpretation is to be lenient. With  lenient interpretation, a date such as "February 942, 1996" will be  treated as being equivalent to the 941st day after February 1, 1996.  With strict interpretation, such dates will cause an exception to be  thrown.

See Also:

setLenient

 isLenient

  public boolean isLenient()

 Tell whether date/time interpretation is to be lenient.

 setFirstDayOfWeek

  public void setFirstDayOfWeek(int value)

 Sets what the first day of the week is; e.g., Sunday in US,  Monday in France.

Parameters:

 value - the given first day of the week.

 getFirstDayOfWeek

  public int getFirstDayOfWeek()

 Gets what the first day of the week is; e.g., Sunday in US,  Monday in France.

Returns:

 the first day of the week.

 setMinimalDaysInFirstWeek

  public void setMinimalDaysInFirstWeek(int value)

 Sets what the minimal days required in the first week of the year are;  For example, if the first week is defined as one that contains the first  day of the first month of a year, call the method with value 1. If it  must be a full week, use value 7.

Parameters:

 value - the given minimal days required in the first week  of the year.

 getMinimalDaysInFirstWeek

  public int getMinimalDaysInFirstWeek()

 Gets what the minimal days required in the first week of the year are;  e.g., if the first week is defined as one that contains the first day  of the first month of a year, getMinimalDaysInFirstWeek returns 1. If  the minimal days required must be a full week, getMinimalDaysInFirstWeek  returns 7.

Returns:

 the minimal days required in the first week of the year.

 getMinimum

  public abstract int getMinimum(int field)

 Gets the minimum value for the given time field.  e.g., for Gregorian DAY_OF_MONTH, 1.

Parameters:

 field - the given time field.

Returns:

 the minimum value for the given time field.

 getMaximum

  public abstract int getMaximum(int field)

 Gets the maximum value for the given time field.  e.g. for Gregorian DAY_OF_MONTH, 31.

Parameters:

 field - the given time field.

Returns:

 the maximum value for the given time field.

 getGreatestMinimum

  public abstract int getGreatestMinimum(int field)

 Gets the highest minimum value for the given field if varies.  Otherwise same as getMinimum(). For Gregorian, no difference.

Parameters:

 field - the given time field.

Returns:

 the highest minimum value for the given time field.

 getLeastMaximum

  public abstract int getLeastMaximum(int field)

 Gets the lowest maximum value for the given field if varies.  Otherwise same as getMaximum(). e.g., for Gregorian DAY_OF_MONTH, 28.

Parameters:

 field - the given time field.

Returns:

 the lowest maximum value for the given time field.

 clone

  public Object clone()

 Overrides Cloneable

Overrides:

clone in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.Date

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.Date

java.lang.Object
   |
   +----java.util.Date

______________________________________________________________________________

 public class Date

 extends Object

 implements Serializable, Cloneable

A Date object represents a specific instant in time with  millisecond precision.

______________________________________________________________________________
Important Note:  Prior to JDK 1.1 Date had two additional functions.  It allowed the interpretation of dates as year, month, day, hour,  minute and second values. It also allowed the formatting and parsing  of date strings. Unfortunately, the API for these functions was not  amenable to internationalization. As of JDK 1.1, the Calendar  class should be used to convert between dates and time fields and the  DateFormat  class should be used to format and parse date  strings. The corresponding methods in Date are deprecated.
______________________________________________________________________________

 While the API is intended to reflect UTC, Coordinated Universal Time,  it doesn't do so exactly. This inexact behavior is inherited from  the time system of the underlying OS. All modern OS's that I (jag)  am aware of assume that 1 day = 24*60*60 seconds. In UTC, about once  a year there is an extra second, called a "leap second" added to  a day to account for the wobble of the earth. Most computer clocks  are not accurate enough to be able to reflect this distinction.  Some computer standards are defined in GMT, which is equivalent  to UT, Universal Time. GMT is the "civil" name for the standard,  UT is the "scientific" name for the same standard. The distinction  between UTC and UT is that the first is based on an atomic clock and  the second is based on astronomical observations, which for all  practical purposes is an invisibly fine hair to split.  An interesting source of further information is the  US Naval Observatory, particularly the  Directorate of Time  and their definitions of  Systems of Time.

 See Also:

DateFormat, Calendar, TimeZone

______________________________________________________________________________

 	Date()

 Allocates a Date object and initializes it so that  it represents the time at which it was allocated measured to the  nearest millisecond.

 	Date(int, int, int)

 Allocates a Date object and initializes it so that  it represents midnight, local time, at the beginning of the day  specified by the year , month, and  date arguments. Deprecated.

 	Date(int, int, int, int, int)

 Allocates a Date object and initializes it so that  it represents the specified hour and minute, local time, of the  date specified by the year, month,  date, hrs, and min arguments. Deprecated.

 	Date(int, int, int, int, int, int)

 Allocates a Date object and initializes it so that  it represents the specified hour, minute, and second, local time  of the date specified by the year, month,  date, hrs, min, and  sec arguments. Deprecated.

 	Date(long)

 Allocates a Date object and initializes it to  represent the specified number of milliseconds since January 1,  1970, 00:00:00 GMT.

 	Date(String)

 Allocates a Date object and initializes it so that  it represents the date and time indicated by the string  s , which is interpreted as if by the  parse method. Deprecated.

 	after(Date)

 Tests if this date is after the specified date.

 	before(Date)

 Tests if this date is before the specified date.

 	equals(Object)

 Compares two dates.

 	getDate()

 Returns the day of the month represented by this date. Deprecated.

 	getDay()

 Returns the day of the week represented by this date. Deprecated.

 	getHours()

 Returns the hour represented by this date. Deprecated.

 	getMinutes()

 Returns the number of minutes past the hour represented by this date. Deprecated.

 	getMonth()

 Returns the month represented by this date. Deprecated.

 	getSeconds()

 Returns the number of seconds past the minute represented by this date. Deprecated.

 	getTime()

 Returns the number of milliseconds since January 1, 1970, 00:00:00 GMT  represented by this date.

 	getTimezoneOffset()

 Returns the local time-zone offset. Deprecated.

 	getYear()

 Returns the year represented by this date, minus 1900. Deprecated.

 	hashCode()

 Returns a hash code value for this object.

 	parse(String)

 Given a string representing a time, parse it and return the time  value. Deprecated.

 	setDate(int)

 Sets the day of the month of this date to the specified value. Deprecated.

 	setHours(int)

 Sets the hour of this date to the specified value. Deprecated.

 	setMinutes(int)

 Sets the minutes of this date to the specified value. Deprecated.

 	setMonth(int)

 Sets the month of this date to the specified value. Deprecated.

 	setSeconds(int)

 Sets the seconds of this date to the specified value. Deprecated.

 	setTime(long)

 Sets this date to represent the specified number of milliseconds  since January 1, 1970 00:00:00 GMT.

 	setYear(int)

 Sets the year of this date to be the specified value plus 1900. Deprecated.

 	toGMTString()

 Creates a string representation of this date. Deprecated.

 	toLocaleString()

 Creates a string representation of this date in an  implementation-dependent form. Deprecated.

 	toString()

 Returns a canonical string representation of the date.

 	UTC(int, int, int, int, int, int)

 Determines the date and time based on the arguments. Deprecated.

 Date

  public Date()

 Allocates a Date object and initializes it so that  it represents the time at which it was allocated measured to the  nearest millisecond.

See Also:

currentTimeMillis

 Date

  public Date(long date)

 Allocates a Date object and initializes it to  represent the specified number of milliseconds since January 1,  1970, 00:00:00 GMT.

Parameters:

 date - the milliseconds since January 1, 1970, 00:00:00 GMT.

See Also:

currentTimeMillis

 Date

  public Date(int year,
              int month,
              int date)

 Note: Date() is deprecated.

 Allocates a Date object and initializes it so that  it represents midnight, local time, at the beginning of the day  specified by the year , month, and  date arguments.

Parameters:

 year - the year minus 1900.

 month - the month between 0-11.

 date - the day of the month between 1-31.

See Also:

Calendar

 Date

  public Date(int year,
              int month,
              int date,
              int hrs,
              int min)

 Note: Date() is deprecated.

 Allocates a Date object and initializes it so that  it represents the specified hour and minute, local time, of the  date specified by the year, month,  date, hrs, and min arguments.

Parameters:

 year - the year minus 1900.

 month - the month between 0-11.

 date - the day of the month between 1-31.

 hrs - the hours between 0-23.

 min - the minutes between 0-59.

See Also:

Calendar

 Date

  public Date(int year,
              int month,
              int date,
              int hrs,
              int min,
              int sec)

 Note: Date() is deprecated.

 Allocates a Date object and initializes it so that  it represents the specified hour, minute, and second, local time  of the date specified by the year, month,  date, hrs, min, and  sec arguments.

Parameters:

 year - the year minus 1900.

 month - the month between 0-11.

 date - the day of the month between 1-31.

 hrs - the hours between 0-23.

 min - the minutes between 0-59.

 sec - the seconds between 0-59.

See Also:

Calendar

 Date

  public Date(String s)

 Note: Date() is deprecated.

 Allocates a Date object and initializes it so that  it represents the date and time indicated by the string  s , which is interpreted as if by the  parse method.

Parameters:

 s - a string representation of the date.

See Also:

DateFormat, parse

 UTC

  public static long UTC(int year,
                         int month,
                         int date,
                         int hrs,
                         int min,
                         int sec)

 Note: UTC() is deprecated.

 Determines the date and time based on the arguments. The  arguments are interpreted in UTC, not in the local time zone

Parameters:

 year - the year minus 1900.

 month - the month between 0-11.

 date - the day of the month between 1-31.

 hrs - the hours between 0-23.

 min - the minutes between 0-59.

 sec - the seconds between 0-59.

Returns:

 the number of seconds since January 1, 1970, 00:00:00 GMT for  the date and time specified by the arguments.

See Also:

Calendar

 parse

  public static long parse(String s)

 Note: parse() is deprecated.

 Given a string representing a time, parse it and return the time  value. This method recognizes most standard syntaxes.

 It accepts many syntaxes; in particular, it recognizes the IETF  standard date syntax: "Sat, 12 Aug 1995 13:30:00 GMT". It also  understands the continental U.S. time-zone abbreviations, but for  general use, a time-zone offset should be used: "Sat, 12 Aug 1995  13:30:00 GMT+0430" (4 hours, 30 minutes west of the Greenwich  meridian). If no time zone is specified, the local time zone is  assumed. GMT and UTC are considered equivalent.

Parameters:

 s - a string to be parsed as a date.

Returns:

 the number of milliseconds since January 1, 1970, 00:00:00  GMT represented by the string argument.

See Also:

DateFormat

 getYear

  public int getYear()

 Note: getYear() is deprecated.

 Returns the year represented by this date, minus 1900.

Returns:

 the year represented by this date, minus 1900.

See Also:

Calendar

 setYear

  public void setYear(int year)

 Note: setYear() is deprecated.

 Sets the year of this date to be the specified value plus 1900.

Parameters:

 year - the year value.

See Also:

Calendar

 getMonth

  public int getMonth()

 Note: getMonth() is deprecated.

 Returns the month represented by this date. The value returned is  between 0 and 11, with the value  0 representing January.

Returns:

 the month represented by this date.

See Also:

Calendar

 setMonth

  public void setMonth(int month)

 Note: setMonth() is deprecated.

 Sets the month of this date to the specified value.

Parameters:

 month - the month value between 0-11.

See Also:

Calendar

 getDate

  public int getDate()

 Note: getDate() is deprecated.

 Returns the day of the month represented by this date. The value  returned is between 1 and 31.

Returns:

 the day of the month represented by this date.

See Also:

Calendar

 setDate

  public void setDate(int date)

 Note: setDate() is deprecated.

 Sets the day of the month of this date to the specified value.

Parameters:

 date - the day of the month value between 1-31.

See Also:

Calendar

 getDay

  public int getDay()

 Note: getDay() is deprecated.

 Returns the day of the week represented by this date. The value returned  is between 0  and 6, where 0  represents Sunday.

Returns:

 the day of the week represented by this date.

See Also:

Calendar

 getHours

  public int getHours()

 Note: getHours() is deprecated.

 Returns the hour represented by this date. The value returned is between  0 and 23, where 0 represents  midnight.

Returns:

 the hour represented by this date.

See Also:

Calendar

 setHours

  public void setHours(int hours)

 Note: setHours() is deprecated.

 Sets the hour of this date to the specified value.

Parameters:

 hours - the hour value.

See Also:

Calendar

 getMinutes

  public int getMinutes()

 Note: getMinutes() is deprecated.

 Returns the number of minutes past the hour represented by this date.  The value returned is between 0 and 59.

Returns:

 the number of minutes past the hour represented by this date.

See Also:

Calendar

 setMinutes

  public void setMinutes(int minutes)

 Note: setMinutes() is deprecated.

 Sets the minutes of this date to the specified value.

Parameters:

 minutes - the value of the minutes.

See Also:

Calendar

 getSeconds

  public int getSeconds()

 Note: getSeconds() is deprecated.

 Returns the number of seconds past the minute represented by this date.   The value returned is between 0 and 60. The  value 60  can only occur on those Java Virtual Machines that  take leap seconds into account.

Returns:

 the number of seconds past the minute represented by  this date.

See Also:

Calendar

 setSeconds

  public void setSeconds(int seconds)

 Note: setSeconds() is deprecated.

 Sets the seconds of this date to the specified value.

Parameters:

 seconds - the seconds value.

See Also:

Calendar

 getTime

  public long getTime()

 Returns the number of milliseconds since January 1, 1970, 00:00:00 GMT  represented by this date.

Returns:

 the number of milliseconds since January 1, 1970, 00:00:00 GMT  represented by this date.

 setTime

  public void setTime(long time)

 Sets this date to represent the specified number of milliseconds  since January 1, 1970 00:00:00 GMT.

Parameters:

 time - the number of milliseconds.

 before

  public boolean before(Date when)

 Tests if this date is before the specified date.

Parameters:

 when - a date.

Returns:

true if this date is before the argument date;  false otherwise.

 after

  public boolean after(Date when)

 Tests if this date is after the specified date.

Parameters:

 when - a date.

Returns:

true if this date is after the argument date;  false otherwise.

 equals

  public boolean equals(Object obj)

 Compares two dates.  The result is true  if and only if the argument is  not null and is a Date object that  represents the same point in time, to the millisecond, as this object.

 Thus, two Date objects are equal if and only if the  getTime  method returns the same long  value for both.

Parameters:

 obj - the object to compare with.

Returns:

true if the objects are the same;  false otherwise.

Overrides:

equals in class Object

See Also:

getTime

 hashCode

  public int hashCode()

 Returns a hash code value for this object.

Returns:

 a hash code value for this object.

Overrides:

hashCode in class Object

 toString

  public String toString()

 Returns a canonical string representation of the date. The result  is of the form "Sat Aug 12 02:30:00 PDT 1995".

Returns:

 a string representation of this date.

Overrides:

toString in class Object

 toLocaleString

  public String toLocaleString()

 Note: toLocaleString() is deprecated.

 Creates a string representation of this date in an  implementation-dependent form. The intent is that the form should  be familiar to the user of the Java application, wherever it may  happen to be running. The intent is comparable to that of the  "%c " format supported by the strftime()  function of ISO C.

Returns:

 a string representation of this date, using the locale  conventions.

See Also:

DateFormat

 toGMTString

  public String toGMTString()

 Note: toGMTString() is deprecated.

 Creates a string representation of this date. The result is of the form:

  "12 Aug 1995 02:30:00 GMT"

 in which the day of the month is always one or two digits. The  other fields have exactly the width shown. The time zone is always  given as "GMT".

Returns:

 a string representation of this date, using the Internet GMT  conventions.

See Also:

DateFormat

 getTimezoneOffset

  public int getTimezoneOffset()

 Note: getTimezoneOffset() is deprecated.

 Returns the local time-zone offset. The time-zone offset is  the number of minutes that must be added to GMT to give the local  time zone. This value includes the correction, if necessary, for  daylight saving time.

Returns:

 the time-zone offset, in minutes, for the current locale.

See Also:

Calendar, TimeZone

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.Dictionary

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.Dictionary

java.lang.Object
   |
   +----java.util.Dictionary

______________________________________________________________________________

 public class Dictionary

 extends Object

The Dictionary class is the abstract parent of any  class, such as Hashtable , which maps keys to values.  Any non-null object can be used as a key and as a value.

 As a rule, the equals method should be used by  implementations of this class to decide if two keys are the same.

See Also:

equals, hashCode, Hashtable

______________________________________________________________________________

 	Dictionary()

 	elements()

 Returns an enumeration of the values in this dictionary.

 	get(Object)

 Returns the value to which the key is mapped in this dictionary.

 	isEmpty()

 Tests if this dictionary maps no keys to value.

 	keys()

 Returns an enumeration of the keys in this dictionary.

 	put(Object, Object)

 Maps the specified key to the specified  value in this dictionary.

 	remove(Object)

 Removes the key (and its corresponding  value) from this dictionary.

 	size()

 Returns the number of keys in this dictionary.

 Dictionary

  public Dictionary()

 size

  public abstract int size()

 Returns the number of keys in this dictionary.

Returns:

 the number of keys in this dictionary.

 isEmpty

  public abstract boolean isEmpty()

 Tests if this dictionary maps no keys to value.

Returns:

true if this dictionary maps no keys to values;  false otherwise.

 keys

  public abstract Enumeration keys()

 Returns an enumeration of the keys in this dictionary.

Returns:

 an enumeration of the keys in this dictionary.

See Also:

elements, Enumeration

 elements

  public abstract Enumeration elements()

 Returns an enumeration of the values in this dictionary.  the Enumeration methods on the returned object to fetch the elements  sequentially.

Returns:

 an enumeration of the values in this dictionary.

See Also:

keys, Enumeration

 get

  public abstract Object get(Object key)

 Returns the value to which the key is mapped in this dictionary.

Parameters:

 key - a key in this dictionary.  null if the key is not mapped to any value in  this dictionary.

Returns:

 the value to which the key is mapped in this dictionary;

See Also:

put

 put

  public abstract Object put(Object key,
                             Object value)

 Maps the specified key to the specified  value  in this dictionary. Neither the key nor the  value can be null.

 The value can be retrieved by calling the  get method with a key that is equal to  the original key.

Parameters:

 key - the hashtable key.

 value - the value.

Returns:

 the previous value to which the key was mapped  in this dictionary, or null  if the key did not  have a previous mapping.

Throws: NullPointerException

 if the key or  value is null.

See Also:

equals, get

 remove

  public abstract Object remove(Object key)

 Removes the key (and its corresponding  value ) from this dictionary. This method does nothing  if the key is not in this dictionary.

Parameters:

 key - the key that needs to be removed.

Returns:

 the value to which the key had been mapped in this  dictionary, or null  if the key did not have a  mapping.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.EmptyStackException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.EmptyStackException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.RuntimeException
                           |
                           +----java.util.EmptyStackException

______________________________________________________________________________

 public class EmptyStackException

 extends RuntimeException

Thrown by methods in the Stack class to indicate  that the stack is empty.

See Also:

Stack

______________________________________________________________________________

 	EmptyStackException()

 Constructs a new EmptyStackException with no detail message.

 EmptyStackException

  public EmptyStackException()

 Constructs a new EmptyStackException  with no detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.util.Enumeration

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.util.Enumeration

 public interface Enumeration

An object that implements the Enumeration interface generates a  series of elements, one at a time. Successive calls to the  nextElement  method return successive elements of the  series.

 For example, to print all elements of a vector v:

     for (Enumeration e = v.elements() ; e.hasMoreElements() ;) {
         System.out.println(e.nextElement());

     }

 Methods are provided to enumerate through the elements of a  vector, the keys of a hashtable, and the values in a hashtable.  Enumerations are also used to specify the input streams to a  SequenceInputStream.

See Also:

SequenceInputStream, nextElement, Hashtable, elements, keys , Vector, elements

______________________________________________________________________________

 	hasMoreElements()

 Tests if this enumeration contains more elements.

 	nextElement()

 Returns the next element of this enumeration.

 hasMoreElements

  public abstract boolean hasMoreElements()

 Tests if this enumeration contains more elements.

Returns:

true if this enumeration contains more elements;  false otherwise.

 nextElement

  public abstract Object nextElement()

 Returns the next element of this enumeration.

Returns:

 the next element of this enumeration.

Throws: NoSuchElementException

 if no more elements exist.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.util.EventListener

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.util.EventListener

 public interface EventListener

A tagging interface that all event listener interfaces must extend

______________________________________________________________________________
______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.EventObject

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.EventObject

java.lang.Object
   |
   +----java.util.EventObject

______________________________________________________________________________

 public class EventObject

 extends Object

 implements Serializable

______________________________________________________________________________

 	source

 	EventObject(Object)

 	getSource()

  	toString()

 Returns a string representation of the object.

 source

  protected transient Object source

 EventObject

  public EventObject(Object source)

 getSource

  public Object getSource()

 toString

  public String toString()

 Returns a string representation of the object.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.GregorianCalendar

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.GregorianCalendar

java.lang.Object
   |
   +----java.util.Calendar
           |
           +----java.util.GregorianCalendar

______________________________________________________________________________

 public class GregorianCalendar

 extends Calendar

GregorianCalendar is a concrete subclass of  Calendar  and provides the standard calendar used by most of the world.

 The standard (Gregorian) calendar has 2 eras, AD and BC.

 This implementation handles a single discontinuity, which corresponds  by default to the date the Gregorian calendar was instituted (October 15,  1582 in some countries, later in others). This cutover date may be changed  by the caller.

 Prior to the institution of the Gregorian calendar, New Year's Day was  March 25. To avoid confusion, this calendar always uses January 1. A manual  adjustment may be made if desired for dates that are prior to the Gregorian  changeover and which fall between January 1 and March 24.

Example:

        // get the supported ids for GMT-08:00 (Pacific Standard Time)
 String[] ids = TimeZone.getAvailableIDs(-8 * 60 * 60 * 1000);
        // if no ids were returned, something is wrong. get out.
 if (ids.length == 0)
     System.exit(0);
        // begin output
 System.out.println("Current Time");
        // create a Pacific Standard Time time zone
 SimpleTimeZone pdt = new SimpleTimeZone(-8 * 60 * 60 * 1000, ids[0]);
        // set up rules for daylight savings time
 pdt.setStartRule(Calendar.APRIL, 1, Calendar.SUNDAY, 2 * 60 * 60 * 1000);
 pdt.setEndRule(Calendar.OCTOBER, -1, Calendar.SUNDAY, 2 * 60 * 60 * 1000);
        // create a GregorianCalendar with the Pacific Daylight time zone
        // and the current date and time
 Calendar calendar = new GregorianCalendar(pdt);
 Date trialTime = new Date();
 calendar.setTime(trialTime);
        // print out a bunch of interesting things
 System.out.println("ERA: " + calendar.get(Calendar.ERA));
 System.out.println("YEAR: " + calendar.get(Calendar.YEAR));
 System.out.println("MONTH: " + calendar.get(Calendar.MONTH));
 System.out.println("WEEK_OF_YEAR: " + calendar.get(Calendar.WEEK_OF_YEAR));
 System.out.println("WEEK_OF_MONTH: " + calendar.get(Calendar.WEEK_OF_MONTH));
 System.out.println("DATE: " + calendar.get(Calendar.DATE));
 System.out.println("DAY_OF_MONTH: " + calendar.get(Calendar.DAY_OF_MONTH));
 System.out.println("DAY_OF_YEAR: " + calendar.get(Calendar.DAY_OF_YEAR));
 System.out.println("DAY_OF_WEEK: " + calendar.get(Calendar.DAY_OF_WEEK));
 System.out.println("DAY_OF_WEEK_IN_MONTH: "
                    + calendar.get(Calendar.DAY_OF_WEEK_IN_MONTH));
 System.out.println("AM_PM: " + calendar.get(Calendar.AM_PM));
 System.out.println("HOUR: " + calendar.get(Calendar.HOUR));
 System.out.println("HOUR_OF_DAY: " + calendar.get(Calendar.HOUR_OF_DAY));
 System.out.println("MINUTE: " + calendar.get(Calendar.MINUTE));
 System.out.println("SECOND: " + calendar.get(Calendar.SECOND));
 System.out.println("MILLISECOND: " + calendar.get(Calendar.MILLISECOND));
 System.out.println("ZONE_OFFSET: "
                    + (calendar.get(Calendar.ZONE_OFFSET)/(60*60*1000)));
 System.out.println("DST_OFFSET: "
                    + (calendar.get(Calendar.DST_OFFSET)/(60*60*1000)));
 System.out.println("Current Time, with hour reset to 3");
 calendar.clear(Calendar.HOUR_OF_DAY); // so doesn't override
 calendar.set(Calendar.HOUR, 3);
 System.out.println("ERA: " + calendar.get(Calendar.ERA));
 System.out.println("YEAR: " + calendar.get(Calendar.YEAR));
 System.out.println("MONTH: " + calendar.get(Calendar.MONTH));
 System.out.println("WEEK_OF_YEAR: " + calendar.get(Calendar.WEEK_OF_YEAR));
 System.out.println("WEEK_OF_MONTH: " + calendar.get(Calendar.WEEK_OF_MONTH));
 System.out.println("DATE: " + calendar.get(Calendar.DATE));
 System.out.println("DAY_OF_MONTH: " + calendar.get(Calendar.DAY_OF_MONTH));
 System.out.println("DAY_OF_YEAR: " + calendar.get(Calendar.DAY_OF_YEAR));
 System.out.println("DAY_OF_WEEK: " + calendar.get(Calendar.DAY_OF_WEEK));
 System.out.println("DAY_OF_WEEK_IN_MONTH: "
                    + calendar.get(Calendar.DAY_OF_WEEK_IN_MONTH));
 System.out.println("AM_PM: " + calendar.get(Calendar.AM_PM));
 System.out.println("HOUR: " + calendar.get(Calendar.HOUR));
 System.out.println("HOUR_OF_DAY: " + calendar.get(Calendar.HOUR_OF_DAY));
 System.out.println("MINUTE: " + calendar.get(Calendar.MINUTE));
 System.out.println("SECOND: " + calendar.get(Calendar.SECOND));
 System.out.println("MILLISECOND: " + calendar.get(Calendar.MILLISECOND));
 System.out.println("ZONE_OFFSET: "
        + (calendar.get(Calendar.ZONE_OFFSET)/(60*60*1000))); // in hours
 System.out.println("DST_OFFSET: "
        + (calendar.get(Calendar.DST_OFFSET)/(60*60*1000))); // in hours

See Also:

Calendar, TimeZone

______________________________________________________________________________

 	AD

 Useful constant for GregorianCalendar.

 	BC

 Useful constant for GregorianCalendar.

 	GregorianCalendar()

 Constructs a default GregorianCalendar using the current time  in the default time zone with the default locale.

 	GregorianCalendar(int, int, int)

 Constructs a GregorianCalendar with the given date set  in the default time zone with the default locale.

 	GregorianCalendar(int, int, int, int, int)

 Constructs a GregorianCalendar with the given date  and time set for the default time zone with the default locale.

 	GregorianCalendar(int, int, int, int, int, int)

 Constructs a GregorianCalendar with the given date  and time set for the default time zone with the default locale.

 	GregorianCalendar(Locale)

 Constructs a GregorianCalendar based on the current time  in the default time zone with the given locale.

 	GregorianCalendar(TimeZone)

 Constructs a GregorianCalendar based on the current time  in the given time zone with the default locale.

 	GregorianCalendar(TimeZone, Locale)

 Constructs a GregorianCalendar based on the current time  in the given time zone with the given locale.

 	add(int, int)

 Overrides Calendar  Date Arithmetic function.

 	after(Object)

 Overrides Calendar  Compares the time field records.

 	before(Object)

 Overrides Calendar  Compares the time field records.

 	clone()

 Overrides Cloneable

 	computeFields()

 Overrides Calendar  Converts UTC as milliseconds to time field values.

 	computeTime()

 Overrides Calendar  Converts time field values to UTC as milliseconds.

 	equals(Object)

 Overrides Calendar  Compares the time field records.

 	getGreatestMinimum(int)

 Returns highest minimum value for the given field if varies.

 	getGregorianChange()

 Gets the Gregorian Calendar change date.

 	getLeastMaximum(int)

 Returns lowest maximum value for the given field if varies.

 	getMaximum(int)

 Returns maximum value for the given field.

 	getMinimum(int)

 Returns minimum value for the given field.

 	hashCode()

 Override hashCode.

 	isLeapYear(int)

 Determines if the given year is a leap year.

 	roll(int, boolean)

 Overrides Calendar  Time Field Rolling function.

 	setGregorianChange(Date)

 Sets the GregorianCalendar change date.

 AD

  public final static int AD

 Useful constant for GregorianCalendar.

 BC

  public final static int BC

 Useful constant for GregorianCalendar.

 GregorianCalendar

  public GregorianCalendar()

 Constructs a default GregorianCalendar using the current time  in the default time zone with the default locale.

 GregorianCalendar

  public GregorianCalendar(TimeZone zone)

 Constructs a GregorianCalendar based on the current time  in the given time zone with the default locale.

Parameters:

 zone - the given time zone.

 GregorianCalendar

  public GregorianCalendar(Locale aLocale)

 Constructs a GregorianCalendar based on the current time  in the default time zone with the given locale.

Parameters:

 aLocale - the given locale.

 GregorianCalendar

  public GregorianCalendar(TimeZone zone,
                           Locale aLocale)

 Constructs a GregorianCalendar based on the current time  in the given time zone with the given locale.

Parameters:

 zone - the given time zone.

 aLocale - the given locale.

 GregorianCalendar

  public GregorianCalendar(int year,
                           int month,
                           int date)

 Constructs a GregorianCalendar with the given date set  in the default time zone with the default locale.

Parameters:

 year - the value used to set the YEAR time field in the calendar.

 month - the value used to set the MONTH time field in the calendar.  Month value is 0-based. e.g., 0 for January.

 date - the value used to set the DATE time field in the calendar.

 GregorianCalendar

  public GregorianCalendar(int year,
                           int month,
                           int date,
                           int hour,
                           int minute)

 Constructs a GregorianCalendar with the given date  and time set for the default time zone with the default locale.

Parameters:

 year - the value used to set the YEAR time field in the calendar.

 month - the value used to set the MONTH time field in the calendar.  Month value is 0-based. e.g., 0 for January.

 date - the value used to set the DATE time field in the calendar.

 hour - the value used to set the HOUR_OF_DAY time field  in the calendar.

 minute - the value used to set the MINUTE time field  in the calendar.

 GregorianCalendar

  public GregorianCalendar(int year,
                           int month,
                           int date,
                           int hour,
                           int minute,
                           int second)

 Constructs a GregorianCalendar with the given date  and time set for the default time zone with the default locale.

Parameters:

 year - the value used to set the YEAR time field in the calendar.

 month - the value used to set the MONTH time field in the calendar.  Month value is 0-based. e.g., 0 for January.

 date - the value used to set the DATE time field in the calendar.

 hour - the value used to set the HOUR_OF_DAY time field  in the calendar.

 minute - the value used to set the MINUTE time field  in the calendar.

 second - the value used to set the SECOND time field  in the calendar.

 setGregorianChange

  public void setGregorianChange(Date date)

 Sets the GregorianCalendar change date. This is the point when the  switch from Julian dates to Gregorian dates occurred. Default is  00:00:00 local time, October 15, 1582. Previous to this time and date  will be Julian dates.

Parameters:

 date - the given Gregorian cutover date.

 getGregorianChange

  public final Date getGregorianChange()

 Gets the Gregorian Calendar change date. This is the point when the  switch from Julian dates to Gregorian dates occurred. Default is  00:00:00 local time, October 15, 1582. Previous to  this time and date will be Julian dates.

Returns:

 the Gregorian cutover time for this calendar.

 isLeapYear

  public boolean isLeapYear(int year)

 Determines if the given year is a leap year. Returns true if the  given year is a leap year.

Parameters:

 year - the given year.

Returns:

 true if the given year is a leap year; false otherwise.

 computeFields

  protected void computeFields()

 Overrides Calendar  Converts UTC as milliseconds to time field values.

Overrides:

computeFields in class Calendar

 computeTime

  protected void computeTime()

 Overrides Calendar  Converts time field values to UTC as milliseconds.

Throws: IllegalArgumentException

 if an unknown field is given.

Overrides:

computeTime in class Calendar

 clone

  public Object clone()

 Overrides Cloneable

Overrides:

clone in class Calendar

 hashCode

  public synchronized int hashCode()

 Override hashCode.  Generates the hash code for the GregorianCalendar object

Overrides:

hashCode in class Object

 equals

  public boolean equals(Object obj)

 Overrides Calendar  Compares the time field records.  Equivalent to comparing result of conversion to UTC.  Please see Calendar.equals for descriptions on parameters and  the return value.

Overrides:

equals in class Calendar

 before

  public boolean before(Object when)

 Overrides Calendar  Compares the time field records.  Equivalent to comparing result of conversion to UTC.  Please see Calendar.before for descriptions on parameters and  the return value.

Overrides:

before in class Calendar

 after

  public boolean after(Object when)

 Overrides Calendar  Compares the time field records.  Equivalent to comparing result of conversion to UTC.  Please see Calendar.after for descriptions on parameters and  the return value.

Overrides:

after in class Calendar

 add

  public void add(int field,
                  int amount)

 Overrides Calendar  Date Arithmetic function.  Adds the specified (signed) amount of time to the given time field,  based on the calendar's rules.

Parameters:

 field - the time field.

 amount - the amount of date or time to be added to the field.

Throws: IllegalArgumentException

 if an unknown field is given.

Overrides:

add in class Calendar

 roll

  public void roll(int field,
                   boolean up)

 Overrides Calendar  Time Field Rolling function.  Rolls (up/down) a single unit of time on the given time field.

Parameters:

 field - the time field.

 up - Indicates if rolling up or rolling down the field value.

Throws: IllegalArgumentException

 if an unknown field value is given.

Overrides:

roll in class Calendar

 getMinimum

  public int getMinimum(int field)

 Returns minimum value for the given field.  e.g. for Gregorian DAY_OF_MONTH, 1  Please see Calendar.getMinimum for descriptions on parameters and  the return value.

Overrides:

getMinimum in class Calendar

 getMaximum

  public int getMaximum(int field)

 Returns maximum value for the given field.  e.g. for Gregorian DAY_OF_MONTH, 31  Please see Calendar.getMaximum for descriptions on parameters and  the return value.

Overrides:

getMaximum in class Calendar

 getGreatestMinimum

  public int getGreatestMinimum(int field)

 Returns highest minimum value for the given field if varies.  Otherwise same as getMinimum(). For Gregorian, no difference.  Please see Calendar.getGreatestMinimum for descriptions on parameters  and the return value.

Overrides:

getGreatestMinimum in class Calendar

 getLeastMaximum

  public int getLeastMaximum(int field)

 Returns lowest maximum value for the given field if varies.  Otherwise same as getMaximum(). For Gregorian DAY_OF_MONTH, 28  Please see Calendar.getLeastMaximum for descriptions on parameters and  the return value.

Overrides:

getLeastMaximum in class Calendar

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.Hashtable

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.Hashtable

java.lang.Object
   |
   +----java.util.Dictionary
           |
           +----java.util.Hashtable

______________________________________________________________________________

 public class Hashtable

 extends Dictionary

 implements Cloneable, Serializable

This class implements a hashtable, which maps keys to values. Any  non-null  object can be used as a key or as a value.

 To successfully store and retrieve objects from a hashtable, the  objects used as keys must implement the hashCode  method and the equals  method.

 An instance of Hashtable has two parameters that  affect its efficiency: its capacity and its load  factor . The load factor should be between 0.0 and 1.0. When  the number of entries in the hashtable exceeds the product of the  load factor and the current capacity, the capacity is increased by  calling the rehash  method. Larger load factors use  memory more efficiently, at the expense of larger expected time  per lookup.

 If many entries are to be made into a Hashtable,  creating it with a sufficiently large capacity may allow the  entries to be inserted more efficiently than letting it perform  automatic rehashing as needed to grow the table.

 This example creates a hashtable of numbers. It uses the names of  the numbers as keys:

     Hashtable numbers = new Hashtable();
     numbers.put("one", new Integer(1));
     numbers.put("two", new Integer(2));
     numbers.put("three", new Integer(3));

 To retrieve a number, use the following code:

     Integer n = (Integer)numbers.get("two");
     if (n != null) {
         System.out.println("two = " + n);
     }

See Also:

equals, hashCode, rehash

______________________________________________________________________________

 	Hashtable()

 Constructs a new, empty hashtable with a default capacity and load  factor.

 	Hashtable(int)

 Constructs a new, empty hashtable with the specified initial capacity  and default load factor.

 	Hashtable(int, float)

 Constructs a new, empty hashtable with the specified initial  capacity and the specified load factor.

 	clear()

 Clears this hashtable so that it contains no keys.

 	clone()

 Creates a shallow copy of this hashtable.

 	contains(Object)

 Tests if some key maps into the specified value in this hashtable.

 	containsKey(Object)

 Tests if the specified object is a key in this hashtable.

 	elements()

 Returns an enumeration of the values in this hashtable.

 	get(Object)

 Returns the value to which the specified key is mapped in this hashtable.

 	isEmpty()

 Tests if this hashtable maps no keys to values.

 	keys()

 Returns an enumeration of the keys in this hashtable.

 	put(Object, Object)

 Maps the specified key to the specified  value in this hashtable.

 	rehash()

 Rehashes the contents of the hashtable into a hashtable with a  larger capacity.

 	remove(Object)

 Removes the key (and its corresponding value) from this  hashtable.

 	size()

 Returns the number of keys in this hashtable.

 	toString()

 Returns a rather long string representation of this hashtable.

 Hashtable

  public Hashtable(int initialCapacity,
                   float loadFactor)

 Constructs a new, empty hashtable with the specified initial  capacity and the specified load factor.

Parameters:

 initialCapacity - the initial capacity of the hashtable.

 loadFactor - a number between 0.0 and 1.0.

Throws: IllegalArgumentException

 if the initial capacity is less  than or equal to zero, or if the load factor is less than  or equal to zero.

 Hashtable

  public Hashtable(int initialCapacity)

 Constructs a new, empty hashtable with the specified initial capacity  and default load factor.

Parameters:

 initialCapacity - the initial capacity of the hashtable.

 Hashtable

  public Hashtable()

 Constructs a new, empty hashtable with a default capacity and load  factor.

 size

  public int size()

 Returns the number of keys in this hashtable.

Returns:

 the number of keys in this hashtable.

Overrides:

size in class Dictionary

 isEmpty

  public boolean isEmpty()

 Tests if this hashtable maps no keys to values.

Returns:

true if this hashtable maps no keys to values;  false otherwise.

Overrides:

isEmpty in class Dictionary

 keys

  public synchronized Enumeration keys()

 Returns an enumeration of the keys in this hashtable.

Returns:

 an enumeration of the keys in this hashtable.

Overrides:

keys in class Dictionary

See Also:

Enumeration, elements

 elements

  public synchronized Enumeration elements()

 Returns an enumeration of the values in this hashtable.  Use the Enumeration methods on the returned object to fetch the elements  sequentially.

Returns:

 an enumeration of the values in this hashtable.

Overrides:

elements in class Dictionary

See Also:

Enumeration, keys

 contains

  public synchronized boolean contains(Object value)

 Tests if some key maps into the specified value in this hashtable.  This operation is more expensive than the containsKey  method.

Parameters:

 value - a value to search for.

Returns:

true if some key maps to the  value argument in this hashtable;  false otherwise.

Throws: NullPointerException

 if the value is null.

See Also:

containsKey

 containsKey

  public synchronized boolean containsKey(Object key)

 Tests if the specified object is a key in this hashtable.

Parameters:

 key - possible key.

Returns:

true if the specified object is a key in this  hashtable; false otherwise.

See Also:

contains

 get

  public synchronized Object get(Object key)

 Returns the value to which the specified key is mapped in this hashtable.

Parameters:

 key - a key in the hashtable.

Returns:

 the value to which the key is mapped in this hashtable;  null  if the key is not mapped to any value in  this hashtable.

Overrides:

get in class Dictionary

See Also:

put

 rehash

  protected void rehash()

 Rehashes the contents of the hashtable into a hashtable with a  larger capacity. This method is called automatically when the  number of keys in the hashtable exceeds this hashtable's capacity  and load factor.

 put

  public synchronized Object put(Object key,
                                 Object value)

 Maps the specified key to the specified  value  in this hashtable. Neither the key nor the  value can be null.

 The value can be retrieved by calling the get method  with a key that is equal to the original key.

Parameters:

 key - the hashtable key.

 value - the value.

Returns:

 the previous value of the specified key in this hashtable,  or null  if it did not have one.

Throws: NullPointerException

 if the key or value is  null.

Overrides:

put in class Dictionary

See Also:

equals, get

 remove

  public synchronized Object remove(Object key)

 Removes the key (and its corresponding value) from this  hashtable. This method does nothing if the key is not in the hashtable.

Parameters:

 key - the key that needs to be removed.

Returns:

 the value to which the key had been mapped in this hashtable,  or null  if the key did not have a mapping.

Overrides:

remove in class Dictionary

 clear

  public synchronized void clear()

 Clears this hashtable so that it contains no keys.

 clone

  public synchronized Object clone()

 Creates a shallow copy of this hashtable. The keys and values  themselves are not cloned.  This is a relatively expensive operation.

Returns:

 a clone of the hashtable.

Overrides:

clone in class Object

 toString

  public synchronized String toString()

 Returns a rather long string representation of this hashtable.

Returns:

 a string representation of this hashtable.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.ListResourceBundle

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.ListResourceBundle

java.lang.Object
   |
   +----java.util.ResourceBundle
           |
           +----java.util.ListResourceBundle

______________________________________________________________________________

 public class ListResourceBundle

 extends ResourceBundle

ListResourceBundle is a abstract subclass of  ResourceBundle  that manages resources for a locale  in a convenient and easy to use list. See ResourceBundle for  more information about resource bundles in general.

 Subclasses must override getContents and provide an array,  where each item in the array is a pair of objects.  The first element of each pair is a String key, and the second  is the value associated with that key.

 In the following example, the keys are of the form "s1"... The actual  keys are entirely up to your choice, so long as they are the same as  the keys you use in your program to retrieve the objects from the bundle.  Keys are case-sensitive. MyResource is the default version  of the bundle family, and MyResource_fr is the french version:

 //====================
 class MyResource extends ListResourceBundle {
        public Object[][] getContents() {
                return contents;
        }
        static final Object[][] contents = {
        // LOCALIZE THIS
                {"s1", "3"},            // starting value in choice field
                {"s2", "MyDisk"},       // starting value in string field
                {"s3", "3 Mar 96"},     // starting value in date field
                {"s4", "The disk '{1}' contained {0} on {2}."}, // initial pattern
                {"s5", "0"},            // first choice number
                {"s6", "no files"},     // first choice value
                {"s7", "1"},            // second choice number
                {"s8", "one file"},     // second choice value
                {"s9", "2"},            // third choice number
                {"s10", "{0}|3 files"}, // third choice value
                {"s11", "format threw an exception: {0}"},      // generic exception message
                {"s12", "ERROR"},       // what to show in field in case of error
                {"s14", "Result"},      // label for formatted stuff
                {"s13", "Dialog"},      // standard font
                {"s15", "Pattern"},     // label for standard pattern
                {"s16", new Dimension(1,5)}     // real object, not just string
        // END OF MATERIAL TO LOCALIZE
        };
 }
 //====================
 class MyResource_fr  extends ListResourceBundle {
        public Object[][] getContents() {
                return contents;
}
        static final Object[][] contents = {
        // LOCALIZE THIS
                {"s1", "3"},            // starting value in choice field
                {"s2", "MonDisk"},      // starting value in string field
                {"s3", "3 Mar 96"},     // starting value in date field
                {"s4", "Le disk '{1}' a {0} a {2}."},   // initial pattern
                {"s5", "0"},            // first choice number
                {"s6", "pas de files"}, // first choice value
                {"s7", "1"},            // second choice number
                {"s8", "une file"},     // second choice value
                {"s9", "2"},            // third choice number
                {"s10", "{0}|3 files"}, // third choice value
                {"s11", "Le format a jete une exception: {0}"}, // generic exception message
                {"s12", "ERROR"},       // what to show in field in case of error
                {"s14", "Resulte"},     // label for formatted stuff
                {"s13", "Dialogue"},    // standard font
                {"s15", "Pattern"},     // label for standard pattern
                {"s16", new Dimension(1,3)}     // real object, not just string
        // END OF MATERIAL TO LOCALIZE
        };
 }

See Also:

ResourceBundle, PropertyResourceBundle

______________________________________________________________________________

 	ListResourceBundle()

 	getContents()

 See class description.

 	getKeys()

 Implementation of ResourceBundle.getKeys.

 	handleGetObject(String)

 Override of ResourceBundle, same semantics

 ListResourceBundle

  public ListResourceBundle()

 handleGetObject

  public final Object handleGetObject(String key)

 Override of ResourceBundle, same semantics

Overrides:

handleGetObject in class ResourceBundle

 getKeys

  public Enumeration getKeys()

 Implementation of ResourceBundle.getKeys.

Overrides:

getKeys in class ResourceBundle

 getContents

  protected abstract Object[][] getContents()

 See class description.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.Locale

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.Locale

java.lang.Object
   |
   +----java.util.Locale

______________________________________________________________________________

 public final class Locale

 extends Object

 implements Cloneable, Serializable

A Locale object represents a specific geographical, political,  or cultural region. An operation that requires a Locale to perform  its task is called locale-sensitive and uses the Locale  to tailor information for the user. For example, displaying a number  is a locale-sensitive operation--the number should be formatted  according to the customs/conventions of the user's native country,  region, or culture.

 You create a Locale object using one of the two constructors in  this class:

 Locale(String language, String country)
 Locale(String language, String country, String variant)

 The first argument to both constructors is a valid ISO  Language Code.  These codes are the lower-case two-letter  codes as defined by ISO-639.  You can find a full list of these codes at a number of sites, such as:
http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt

 The second argument to both constructors is a valid ISO Country  Code.  These codes are the upper-case two-letter codes  as defined by ISO-3166.  You can find a full list of these codes at a number of sites, such as:
http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html

 The second constructor requires a third argument--the Variant.  The Variant codes are vendor and browser-specific.  For example, use WIN for Windows, MAC for Macintosh, and POSIX for POSIX.  Where there are two variants, separate them with an underscore, and  put the most important one first. For  example, a Traditional Spanish collation might be referenced, with  "ES", "ES", "Traditional_WIN".

 Because a Locale object is just an identifier for a region,  no validity check is performed when you construct a Locale.  If you want to see whether particular resources are available for the  Locale  you construct, you must query those resources. For  example, ask the NumberFormat  for the locales it supports  using its getAvailableLocales method.
Note: When you ask for a resource for a particular  locale, you get back the best available match, not necessarily  precisely what you asked for. For more information, look at  ResourceBundle.

 The Locale class provides a number of convenient constants  that you can use to create Locale objects for commonly used  locales. For example, the following creates a Locale object  for the United States:

 Locale.US

 Once you've created a Locale you can query it for information about  itself. Use getCountry to get the ISO Country Code and  getLanguage  to get the ISO Language Code. You can  use getDisplayCountry to get the  name of the country suitable for displaying to the user. Similarly,  you can use getDisplayLanguage to get the name of  the language suitable for displaying to the user. Interestingly,  the getDisplayXXX  methods are themselves locale-sensitive  and have two versions: one that uses the default locale and one  that uses the locale specified as an argument.

 The JDK provides a number of classes that perform locale-sensitive  operations. For example, the NumberFormat class formats  numbers, currency, or percentages in a locale-sensitive manner. Classes  such as NumberFormat have a number of convenience methods  for creating a default object of that type. For example, the  NumberFormat  class provides these three convenience methods  for creating a default NumberFormat  object:

 NumberFormat.getInstance()
 NumberFormat.getCurrencyInstance()
 NumberFormat.getPercentInstance()

 These methods have two variants; one with an explicit locale  and one without; the latter using the default locale.

 NumberFormat.getInstance(myLocale)
 NumberFormat.getCurrencyInstance(myLocale)
 NumberFormat.getPercentInstance(myLocale)

 A Locale is the mechanism for identifying the kind of object  (NumberFormat ) that you would like to get. The locale is  just  a mechanism for identifying objects,  not a container for the objects themselves.

 Each class that performs locale-sensitive operations allows you  to get all the available objects of that type. You can sift  through these objects by language, country, or variant,  and use the display names to present a menu to the user.  For example, you can create a menu of all the collation objects  suitable for a given language. Such classes must implement these  three class methods:

 public static Locale[] getAvailableLocales()
 public static String getDisplayName(Locale objectLocale,
                                     Locale displayLocale)
 public static final String getDisplayName(Locale objectLocale)
     // getDisplayName will throw MissingResourceException if the locale
     // is not one of the available locales.

See Also:

ResourceBundle, Format, NumberFormat, Collation

______________________________________________________________________________

 	CANADA

 Useful constant for country.

 	CANADA_FRENCH

 Useful constant for country.

 	CHINA

 Useful constant for country.

 	CHINESE

 Useful constant for language.

 	ENGLISH

 Useful constant for language.

 	FRANCE

 Useful constant for country.

 	FRENCH

 Useful constant for language.

 	GERMAN

 Useful constant for language.

 	GERMANY

 Useful constant for country.

 	ITALIAN

 Useful constant for language.

 	ITALY

 Useful constant for country.

 	JAPAN

 Useful constant for country.

 	JAPANESE

 Useful constant for language.

 	KOREA

 Useful constant for country.

 	KOREAN

 Useful constant for language.

 	PRC

 Useful constant for country.

 	SIMPLIFIED_CHINESE

 Useful constant for language.

 	TAIWAN

 Useful constant for country.

 	TRADITIONAL_CHINESE

 Useful constant for language.

 	UK

 Useful constant for country.

 	US

 Useful constant for country.

 	Locale(String, String)

 Construct a locale from language, country.

 	Locale(String, String, String)

 Construct a locale from language, country, variant.

 	clone()

 Overrides Cloneable

 	equals(Object)

 Compares two Objects for equality.

 	getCountry()

 Getter for programmatic name of field,  an uppercased two-letter ISO-3166 code.

 	getDefault()

 Common method of getting the current default Locale.

 	getDisplayCountry()

 Getter for display of field to user.

 	getDisplayCountry(Locale)

 Getter for display of field to user.

 	getDisplayLanguage()

 Getter for display of field to user.

 	getDisplayLanguage(Locale)

 Getter for display of field to user.

 	getDisplayName()

 Getter for display of the entire locale to user.

 	getDisplayName(Locale)

 Getter for display of the entire locale to user.

 	getDisplayVariant()

 Getter for display of field to user.

 	getDisplayVariant(Locale)

 Getter for display of field to user  If the localized name is not found, returns the variant code.

 	getISO3Country()

 Getter for the three-letter ISO country abbreviation  of the locale.

 	getISO3Language()

 Getter for the three-letter ISO language abbreviation  of the locale.

 	getLanguage()

 Getter for programmatic name of field,  an lowercased two-letter ISO-639 code.

 	getVariant()

 Getter for programmatic name of field.

 	hashCode()

 Override hashCode.

 	setDefault(Locale)

 Sets the default.

 	toString()

 Getter for the programmatic name of the entire locale,  with the language, country and variant separated by underbars.

 ENGLISH

  public final static Locale ENGLISH

 Useful constant for language.

 FRENCH

  public final static Locale FRENCH

 Useful constant for language.

 GERMAN

  public final static Locale GERMAN

 Useful constant for language.

 ITALIAN

  public final static Locale ITALIAN

 Useful constant for language.

 JAPANESE

  public final static Locale JAPANESE

 Useful constant for language.

 KOREAN

  public final static Locale KOREAN

 Useful constant for language.

 CHINESE

  public final static Locale CHINESE

 Useful constant for language.

 SIMPLIFIED_CHINESE

  public final static Locale SIMPLIFIED_CHINESE

 Useful constant for language.

 TRADITIONAL_CHINESE

  public final static Locale TRADITIONAL_CHINESE

 Useful constant for language.

 FRANCE

  public final static Locale FRANCE

 Useful constant for country.

 GERMANY

  public final static Locale GERMANY

 Useful constant for country.

 ITALY

  public final static Locale ITALY

 Useful constant for country.

 JAPAN

  public final static Locale JAPAN

 Useful constant for country.

 KOREA

  public final static Locale KOREA

 Useful constant for country.

 CHINA

  public final static Locale CHINA

 Useful constant for country.

 PRC

  public final static Locale PRC

 Useful constant for country.

 TAIWAN

  public final static Locale TAIWAN

 Useful constant for country.

 UK

  public final static Locale UK

 Useful constant for country.

 US

  public final static Locale US

 Useful constant for country.

 CANADA

  public final static Locale CANADA

 Useful constant for country.

 CANADA_FRENCH

  public final static Locale CANADA_FRENCH

 Useful constant for country.

 Locale

  public Locale(String language,
                String country,
                String variant)

 Construct a locale from language, country, variant.

Parameters:

 language - lowercase two-letter ISO-639 code.

 country - uppercase two-letter ISO-3166 code.

 variant - vendor and browser specific code. See class description.

 Locale

  public Locale(String language,
                String country)

 Construct a locale from language, country.

Parameters:

 language - lowercase two-letter ISO-639 code.

 country - uppercase two-letter ISO-3166 code.

 getDefault

  public static synchronized Locale getDefault()

 Common method of getting the current default Locale.  Used for the presentation: menus, dialogs, etc.  Generally set once when your applet or application is initialized,  then never reset. (If you do reset the default locale, you  probably want to reload your GUI, so that the change is reflected  in your interface.)

More advanced programs will allow users to use different locales  for different fields, e.g. in a spreadsheet.
Note that the initial setting will match the host system.

 setDefault

  public static synchronized void setDefault(Locale newLocale)

 Sets the default.  Normally set once at the beginning of applet or application,  then never reset. setDefault does not reset the host locale.

Parameters:

 newLocale - Locale to set to.

 getLanguage

  public String getLanguage()

 Getter for programmatic name of field,  an lowercased two-letter ISO-639 code.

See Also:

getDisplayLanguage

 getCountry

  public String getCountry()

 Getter for programmatic name of field,  an uppercased two-letter ISO-3166 code.

See Also:

getDisplayCountry

 getVariant

  public String getVariant()

 Getter for programmatic name of field.

See Also:

getDisplayVariant

 toString

  public final String toString()

 Getter for the programmatic name of the entire locale,  with the language, country and variant separated by underbars.  If a field is missing, at most one underbar will occur.  Example: "EN", "DE_DE", "EN_US_WIN", "DE_POSIX", "FR_MAC"

Overrides:

toString in class Object

See Also:

getDisplayName

 getISO3Language

  public String getISO3Language() throws MissingResourceException

 Getter for the three-letter ISO language abbreviation  of the locale.

Throws: MissingResourceException

 Throws MissingResourceException if the  three-letter language abbreviation is not available for this locale.

 getISO3Country

  public String getISO3Country() throws MissingResourceException

 Getter for the three-letter ISO country abbreviation  of the locale.

Throws: MissingResourceException

 Throws MissingResourceException if the  three-letter language abbreviation is not available for this locale.

 getDisplayLanguage

  public final String getDisplayLanguage()

 Getter for display of field to user.  If the localized name is not found, returns the ISO code.  The desired user language is from the default locale.

 getDisplayLanguage

  public String getDisplayLanguage(Locale inLocale)

 Getter for display of field to user.  If the localized name is not found, returns the ISO codes.  Example: "English (UK)", "Deutch", "Germany"

Parameters:

 inLocale - specifies the desired user language.

 getDisplayCountry

  public final String getDisplayCountry()

 Getter for display of field to user.  If the localized name is not found, returns the ISO code.  The default locale is used for the presentation language.

 getDisplayCountry

  public String getDisplayCountry(Locale inLocale)

 Getter for display of field to user.  If the localized name is not found, returns the ISO code.

Parameters:

 inLocale - specifies the desired user language.

 getDisplayVariant

  public final String getDisplayVariant()

 Getter for display of field to user.  If the localized name is not found, returns the variant code.  The default locale is used for the presentation language.

 getDisplayVariant

  public String getDisplayVariant(Locale inLocale)

 Getter for display of field to user  If the localized name is not found, returns the variant code.

Parameters:

 inLocale - specifies the desired user language.

 getDisplayName

  public final String getDisplayName()

 Getter for display of the entire locale to user.  If the localized name is not found, uses the ISO codes.  The default locale is used for the presentation language.

 getDisplayName

  public String getDisplayName(Locale inLocale)

 Getter for display of the entire locale to user.  If the localized name is not found, uses the ISO codes

Parameters:

 inLocale - specifies the desired user language.

 clone

  public Object clone()

 Overrides Cloneable

Overrides:

clone in class Object

 hashCode

  public synchronized int hashCode()

 Override hashCode.  Since Locales are often used in hashtables, caches the value  for speed.

Overrides:

hashCode in class Object

 equals

  public boolean equals(Object obj)

 Compares two Objects for equality.

Overrides:

equals in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.MissingResourceException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.MissingResourceException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.RuntimeException
                           |
                           +----java.util.MissingResourceException

______________________________________________________________________________

 public class MissingResourceException

 extends RuntimeException

Signals that a resource is missing.

See Also:

 Exception, ResourceBundle

______________________________________________________________________________

 	MissingResourceException(String, String, String)

 Constructs a MissingResourceException with the specified information.

 	getClassName()

 Gets parameter passed by constructor.

 	getKey()

 Gets parameter passed by constructor.

 MissingResourceException

  public MissingResourceException(String s,
                                  String className,
                                  String key)

 Constructs a MissingResourceException with the specified information.  A detail message is a String that describes this particular exception.

Parameters:

 s - the detail message

 classname - the name of the resource class

 key - the key for the missing resource.

 getClassName

  public String getClassName()

 Gets parameter passed by constructor.

 getKey

  public String getKey()

 Gets parameter passed by constructor.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.NoSuchElementException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.NoSuchElementException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.RuntimeException
                           |
                           +----java.util.NoSuchElementException

______________________________________________________________________________

 public class NoSuchElementException

 extends RuntimeException

Thrown by the nextElement method of an  Enumeration  to indicate that there are no more  elements in the enumeration.

See Also:

Enumeration, nextElement

______________________________________________________________________________

 	NoSuchElementException()

 Constructs a NoSuchElementException with no detail message.

 	NoSuchElementException(String)

 Constructs a NoSuchElementException with the  specified detail message.

 NoSuchElementException

  public NoSuchElementException()

 Constructs a NoSuchElementException with no detail message.

 NoSuchElementException

  public NoSuchElementException(String s)

 Constructs a NoSuchElementException with the  specified detail message.

Parameters:

 s - the detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.Observable

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.Observable

java.lang.Object
   |
   +----java.util.Observable

______________________________________________________________________________

 public class Observable

 extends Object

This class represents an observable object, or "data"  in the model-view paradigm. It can be subclassed to represent an  object that the application wants to have observed.

 An observable object can have one or more observers. After an  observable instance changes, an application calling the  Observable's notifyObservers method  causes all of its observers to be notified of the change by a call  to their update method.

See Also:

notifyObservers, notifyObservers, Observer, update

______________________________________________________________________________

 	Observable()

 Creates an observable object with no observers.

 	addObserver(Observer)

 Adds an observer to the set of observers for this object.

 	clearChanged()

 Indicates that this object has no longer changed, or that it has  already notified all of its observers of its most recent change.

 	countObservers()

 Returns the number of observers of this object.

 	deleteObserver(Observer)

 Deletes an observer from the set of observers of this object.

 	deleteObservers()

 Clears the observer list so that this object no longer has any observers.

 	hasChanged()

 Tests if this object has changed.

 	notifyObservers()

 If this object has changed, as indicated by the  hasChanged  method, then notify all of its observers  and then call the clearChanged method to  indicate that this object has no longer changed.

 	notifyObservers(Object)

 If this object has changed, as indicated by the  hasChanged  method, then notify all of its observers  and then call the clearChanged  method to indicate  that this object has no longer changed.

 	setChanged()

 Indicates that this object has changed.

 Observable

  public Observable()

 Creates an observable object with no observers.

 addObserver

  public synchronized void addObserver(Observer o)

 Adds an observer to the set of observers for this object.  If the observer has been added previously, it will not be added again.

Parameters:

 o - an observer to be added.

 deleteObserver

  public synchronized void deleteObserver(Observer o)

 Deletes an observer from the set of observers of this object.

Parameters:

 o - the observer to be deleted.

 notifyObservers

  public void notifyObservers()

 If this object has changed, as indicated by the  hasChanged  method, then notify all of its observers  and then call the clearChanged method to  indicate that this object has no longer changed.

 Each observer has its update method called with two  arguments: this observable object and null.

See Also:

clearChanged, hasChanged, update

 notifyObservers

  public void notifyObservers(Object arg)

 If this object has changed, as indicated by the  hasChanged  method, then notify all of its observers  and then call the clearChanged  method to indicate  that this object has no longer changed.

 Each observer has its update method called with two  arguments: this observable object and the arg argument.

Parameters:

 arg - any object.

See Also:

clearChanged, hasChanged, update

 deleteObservers

  public synchronized void deleteObservers()

 Clears the observer list so that this object no longer has any observers.

 setChanged

  protected synchronized void setChanged()

 Indicates that this object has changed.

 clearChanged

  protected synchronized void clearChanged()

 Indicates that this object has no longer changed, or that it has  already notified all of its observers of its most recent change.  This method is called automatically by the  notifyObservers methods.

See Also:

notifyObservers, notifyObservers

 hasChanged

  public synchronized boolean hasChanged()

 Tests if this object has changed.

Returns:

true if the setChanged method  has been called more recently than the clearChanged  method on this object; false otherwise.

See Also:

clearChanged, setChanged

 countObservers

  public synchronized int countObservers()

 Returns the number of observers of this object.

Returns:

 the number of observers of this object.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.util.Observer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Interface java.util.Observer

 public interface Observer

A class can implement the Observer interface when it  wants to be informed of changes in observable objects.

See Also:

Observable

______________________________________________________________________________

 	update(Observable, Object)

 This method is called whenever the observed object is changed.

 update

  public abstract void update(Observable o,
                              Object arg)

 This method is called whenever the observed object is changed. An  application calls an observable object's  notifyObservers  method to have all the object's  observers notified of the change.

Parameters:

 o - the observable object.

 arg - an argument passed to the notifyObservers  method.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.Properties

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.Properties

java.lang.Object
   |
   +----java.util.Dictionary
           |
           +----java.util.Hashtable
                   |
                   +----java.util.Properties

______________________________________________________________________________

 public class Properties

 extends Hashtable

The Properties class represents a persistent set of  properties. The Properties can be saved to a stream  or loaded from a stream. Each key and its corresponding value in  the property list is a string.

 A property list can contain another property list as its  "defaults"; this second property list is searched if  the property key is not found in the original property list.

______________________________________________________________________________

 	defaults

 A property list that contains default values for any keys not  found in this property list.

 	Properties()

 Creates an empty property list with no default values.

 	Properties(Properties)

 Creates an empty property list with the specified defaults.

 	getProperty(String)

 Searches for the property with the specified key in this property list.

 	getProperty(String, String)

 Searches for the property with the specified key in this property list.

 	list(PrintStream)

 Prints this property list out to the specified output stream.

 	list(PrintWriter)

 Prints this property list out to the specified output stream.

 	load(InputStream)

 Reads a property list from an input stream.

 	propertyNames()

 Returns an enumeration of all the keys in this property list, including  the keys in the default property list.

 	save(OutputStream, String)

 Stores this property list to the specified output stream.

 defaults

  protected Properties defaults

 A property list that contains default values for any keys not  found in this property list.

 Properties

  public Properties()

 Creates an empty property list with no default values.

 Properties

  public Properties(Properties defaults)

 Creates an empty property list with the specified defaults.

Parameters:

 defaults - the defaults.

 load

  public synchronized void load(InputStream in) throws IOException

 Reads a property list from an input stream.

Parameters:

 in - the input stream.

Throws: IOException

 if an error occurred when reading from the  input stream.

 save

  public synchronized void save(OutputStream out,
                                String header)

 Stores this property list to the specified output stream. The  string header is printed as a comment at the beginning of the stream.

Parameters:

 out - an output stream.

 header - a description of the property list.

 getProperty

  public String getProperty(String key)

 Searches for the property with the specified key in this property list.   If the key is not found in this property list, the default property list,  and its defaults, recursively, are then checked. The method returns  null  if the property is not found.

Parameters:

 key - the property key.

Returns:

 the value in this property list with the specified key value.

See Also:

defaults

 getProperty

  public String getProperty(String key,
                            String defaultValue)

 Searches for the property with the specified key in this property list.   If the key is not found in this property list, the default property list,  and its defaults, recursively, are then checked. The method returns the  default value argument if the property is not found.

Parameters:

 key - the hashtable key.

 defaultValue - a default value.

Returns:

 the value in this property list with the specified key value.

See Also:

defaults

 propertyNames

  public Enumeration propertyNames()

 Returns an enumeration of all the keys in this property list, including   the keys in the default property list.

Returns:

 an enumeration of all the keys in this property list, including  the keys in the default property list.

See Also:

Enumeration, defaults

 list

  public void list(PrintStream out)

 Prints this property list out to the specified output stream.  This method is useful for debugging.

Parameters:

 out - an output stream.

 list

  public void list(PrintWriter out)

 Prints this property list out to the specified output stream.  This method is useful for debugging.

Parameters:

 out - an output stream.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.PropertyResourceBundle

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.PropertyResourceBundle

java.lang.Object
   |
   +----java.util.ResourceBundle
           |
           +----java.util.PropertyResourceBundle

______________________________________________________________________________

 public class PropertyResourceBundle

 extends ResourceBundle

PropertyResourceBundle is an abstract subclass of  ResourceBundle  that manages resources for a locale  using a set of static strings from a property file. See  ResourceBundle for more information about resource  bundles in general.

 The property file contains the keys that you use in your source code  in calls to ResourceBundle.getString and similar methods,  and their corresponding values, etc.  The name of the property file indicates the resource bundle's family  and locale.

 In the following example, the keys are of the form "s1"... The actual  keys are entirely up to your choice, so long as they are the same as  the keys you use in your program to retrieve the objects from the bundle.  Keys are case-sensitive.

 s1=3
 s2=MeinDisk
 s3=3 Mar 96
 s4=Der disk '{1}' a {0} a {2}.
 s5=0
 s6=keine Datein
 s7=1
 s8=ein Datei
 s9=2
 s10={0}|3 Datein
 s11=Der Format worf ein Exception: {0}
 s12=ERROR
 s14=Resulte
 s13=Dialogue
 s15=Pattern
 s16=1,3

See Also:

ResourceBundle, ListResourceBundle

______________________________________________________________________________

 	PropertyResourceBundle(InputStream)

 Creates a property resource

 	getKeys()

 Implementation of ResourceBundle.getKeys.

 	handleGetObject(String)

 Override of ResourceBundle, same semantics

 PropertyResourceBundle

  public PropertyResourceBundle(InputStream stream) throws IOException

 Creates a property resource

Parameters:

 file - property file to read from.

 handleGetObject

  public Object handleGetObject(String key)

 Override of ResourceBundle, same semantics

Overrides:

handleGetObject in class ResourceBundle

 getKeys

  public Enumeration getKeys()

 Implementation of ResourceBundle.getKeys.

Overrides:

getKeys in class ResourceBundle

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.Random

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.Random

java.lang.Object
   |
   +----java.util.Random

______________________________________________________________________________

 public class Random

 extends Object

 implements Serializable

An instance of this class is used to generate a stream of  pseudorandom numbers. The class uses a 48-bit seed, which is  modified using a linear congruential formula. (See Donald Knuth,  The Art of Computer Programming, Volume 2, Section 3.2.1.)

 If two instances of Random are created with the same  seed, and the same sequence of method calls is made for each, they  will generate and return identical sequences of numbers.

 Many applications will find the random method in  class Math  simpler to use.

See Also:

random

______________________________________________________________________________

 	Random()

 Creates a new random number generator.

 	Random(long)

 Creates a new random number generator using a single  long seed.

 	next(int)

 Generates the next pseudorandom number.

 	nextBytes(byte[])

 Generates a user specified number of random bytes.

 	nextDouble()

 Returns the next pseudorandom, uniformly distributed  double value between 0.0 and  1.0 from this random number generator's sequence.

 	nextFloat()

 Returns the next pseudorandom, uniformly distributed float  value between 0.0 and 1.0 from this random  number generator's sequence.

 	nextGaussian()

 Returns the next pseudorandom, Gaussian ("normally") distributed  double  value with mean 0.0 and standard  deviation 1.0  from this random number generator's sequence.

 	nextInt()

 Returns the next pseudorandom, uniformly distributed int  value from this random number generator's sequence.

 	nextLong()

 Returns the next pseudorandom, uniformly distributed long  value from this random number generator's sequence.

 	setSeed(long)

 Sets the seed of this random number generator using a single  long seed.

 Random

  public Random()

 Creates a new random number generator. Its seed is initialized to  a value based on the current time.

See Also:

currentTimeMillis

 Random

  public Random(long seed)

 Creates a new random number generator using a single  long  seed.

Parameters:

 seed - the initial seed.

See Also:

setSeed

 setSeed

  public synchronized void setSeed(long seed)

 Sets the seed of this random number generator using a single  long seed.

Parameters:

 seed - the initial seed.

 next

  protected synchronized int next(int bits)

 Generates the next pseudorandom number. Subclass should  override this, as this is used by all other methods.

Parameters:

 bits - random bits

 nextBytes

  public void nextBytes(byte bytes[])

 Generates a user specified number of random bytes.

 nextInt

  public int nextInt()

 Returns the next pseudorandom, uniformly distributed int  value from this random number generator's sequence.

Returns:

 the next pseudorandom, uniformly distributed int  value from this random number generator's sequence.

 nextLong

  public long nextLong()

 Returns the next pseudorandom, uniformly distributed long  value from this random number generator's sequence.

Returns:

 the next pseudorandom, uniformly distributed long  value from this random number generator's sequence.

 nextFloat

  public float nextFloat()

 Returns the next pseudorandom, uniformly distributed float  value between 0.0 and 1.0 from this random  number generator's sequence.

Returns:

 the next pseudorandom, uniformly distributed float  value between 0.0 and 1.0 from this  random number generator's sequence.

 nextDouble

  public double nextDouble()

 Returns the next pseudorandom, uniformly distributed  double  value between 0.0 and  1.0 from this random number generator's sequence.

Returns:

 the next pseudorandom, uniformly distributed  double value between 0.0 and   1.0 from this random number generator's sequence.

 nextGaussian

  public synchronized double nextGaussian()

 Returns the next pseudorandom, Gaussian ("normally") distributed  double value with mean 0.0 and standard  deviation 1.0  from this random number generator's sequence.

Returns:

 the next pseudorandom, Gaussian ("normally") distributed  double value with mean 0.0 and  standard deviation 1.0 from this random number  generator's sequence.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.ResourceBundle

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.ResourceBundle

java.lang.Object
   |
   +----java.util.ResourceBundle

______________________________________________________________________________

 public class ResourceBundle

 extends Object

Resource bundles contain locale-specific objects.  When your program needs a locale-specific resource,  a String  for example, your program can load it  from the resource bundle that is appropriate for the  current user's locale. In this way, you can write  program code that is largely independent of the user's  locale isolating most, if not all, of the locale-specific  information in resource bundles.

 This allows you to write programs that can:

•  be easily localized, or translated, into different languages

•  handle multiple locales at once

•  be easily modified later to support even more locales

 One resource bundle is, conceptually, a set of related classes that  inherit from ResourceBundle. Each related subclass of  ResourceBundle  has the same base name plus an additional  component that identifies its locale. For example, suppose your resource  bundle is named MyResources. The first class you are likely  to write is the default resource bundle which simply has the same name as  its family--MyResources. You can also provide as  many related locale-specific classes as you need: for example, perhaps  you would provide a German one named MyResources_de.

 Each related subclass of ResourceBundle contains the same  items, but the items have been translated for the locale represented by that  ResourceBundle subclass. For example, both MyResources  and MyResources_de  may have a String that's used  on a button for confirming operations. In MyResources the  String may contain OK and in  MyResources_de  it may contain Gut.

 If there are different resources for different countries, you  can make specializations: for example, MyResources_de_CH  for Switzerland. If you want to only modify some of the resources  in the specialization, you can do so.

 When your program needs a locale-specific object, it loads  the ResourceBundle  class using the getBundle  method:

 ResourceBundle myResources =
      ResourceBundle.getBundle("MyResources", currentLocale);

 The first argument specifies the family name of the resource  bundle that contains the object in question. The second argument  indicates the desired locale. getBundle  uses these two arguments to construct the name of the  ResourceBundle subclass it should load as follows.

 The resource bundle lookup searches for classes with various suffixes  on the basis of (1) the desired locale and (2) the default locale (baseclass),  in the following order from lower-level (more specific) to parent-level  (less specific):

 baseclass + "_" + language1 + "_" + country1 + "_" + variant1
 baseclass + "_" + language1 + "_" + country1
 baseclass + "_" + language1
 baseclass
 baseclass + "_" + language2 + "_" + country2 + "_" + variant2
 baseclass + "_" + language2 + "_" + country2
 baseclass + "_" + language2

 The result of the lookup is a class, but that class may be  backed by a property file on disk. If a lookup fails,  getBundle() throws a MissingResourceException.

 The baseclass must be fully  qualified (for example, myPackage.MyResources, not just  MyResources). It must  also be accessable by your code; it cannot be a class that is private  to the package where ResourceBundle.getBundle is called.

 Note: ResourceBundle are used internally in accessing  NumberFormats, Collations, and so on.  The lookup strategy is the same.

 Resource bundles contain key/value pairs. The keys uniquely  identify a locale-specific object in the bundle. Here's an  example of a ListResourceBundle that contains  two key/value pairs:

 class MyResource extends ListResourceBundle {
      public Object[][] getContents() {
              return contents;
      }
      static final Object[][] contents = {
      // LOCALIZE THIS
              {"OkKey", "OK"},
              {"CancelKey", "Cancel"},
      // END OF MATERIAL TO LOCALIZE
      };
 }

 Keys are always Strings.  In this example, the keys are OkKey and CancelKey.  In the above example, the values  are also Strings--OK and Cancel--but  they don't have to be. The values can be any type of object.

 You retrieve an object from resource bundle using the appropriate  getter method. Because OkKey and CancelKey  are both strings, you would use getString  to retrieve them:

 button1 = new Button(myResourceBundle.getString("OkKey"));
 button2 = new Button(myResourceBundle.getString("CancelKey"));

 The getter methods all require the key as an argument and return  the object if found. If the object is not found, the getter method  throws a MissingResourceException.

 Besides getString; ResourceBundle supports a number  of other methods for getting different types of objects: getMenu,  getStringArray, and so on. If you don't have an object that  matches one of these methods, you can use getObject  and cast the result to the appropriate type. For example:

 int[] myIntegers = (int[]) myResources.getObject("intList");

NOTE: You should always supply a baseclass with  no suffixes. This will be the class of "last resort", if a locale  is requested that does not exist. For example, below we have a class  MyResources . It happens to contain US strings,  so we don't have to have an explicit MyResource_en  or  MyResource_en_US.

 The JDK provides two subclasses of ResourceBundle,  ListResourceBundle  and PropertyResourceBundle,  that provide a fairly simple way to create resources. (Once serialization  is fully integrated, we will provide another  way.) As you saw briefly in a prevous example, ListResourceBundle  manages its resource as a List of key/value pairs.  PropertyResourceBundle uses a properties file to manage  its resources.

 If ListResourceBundle or PropertyResourceBundle  do not suit your needs, you can write your own ResourceBundle  subclass. Your subclasses must overrde two methods: handleGetObject  and getKeys().

 The following is a very simple example of a ResourceBundle subclass  that manages only a few resources (for a larger number of resources  you would probably use a Hashtable). Notice that if the key  is not found, handleGetObject  must return null. Notice also  that you don't need to supply a value if a "parent-level"  ResourceBundle handles the same  key with the same value (look at uk below).

Example:

 abstract class MyResources extends ResourceBundle {
     public Object handleGetObject(String key) {
         if (key.equals("okKey")) return "Ok";
         if (key.equals("cancelKey")) return "Cancel";
           return null;
     }
 }
 abstract class MyResources_de extends MyResources {
     public Object handleGetObject(String key) {
         if (key.equals("okKey")) return "Gut";
         if (key.equals("cancelKey")) return "Vernichten";
         return null;
     }
 }
 abstract class MyResources_uk extends MyResources {
     public Object handleGetObject(String key) {
         // don't need okKey, since parent level handles it.
         if (key.equals("cancelKey")) return "Dispose";
           return null;
     }
 }

 You do not have to restrict yourself to using a single family of  ResourceBundle s. For example, you could have a set of bundles for  exception messages, ExceptionResources  (ExceptionResources_fr, ExceptionResources_de, ...),  and one for widgets, WidgetResource (WidgetResources_fr,  WidgetResources_de, ...); breaking up the resources however you like.

See Also:

ListResourceBundle, PropertyResourceBundle, MissingResourceException

______________________________________________________________________________

 	parent

 The parent bundle is consulted by getObject when this bundle  does not contain a particular resource.

 	ResourceBundle()

 	getBundle(String)

 Get the appropriate ResourceBundle subclass.

 	getBundle(String, Locale)

 Get the appropriate ResourceBundle subclass.

 	getKeys()

 Return an enumeration of the keys.

 	getMenu(String)

 Get an object from a ResourceBundle.

 	getMenuBar(String)

 Get an object from a ResourceBundle.

 	getObject(String)

 Get an object from a ResourceBundle.

 	getString(String)

 Get an object from a ResourceBundle.

 	getStringArray(String)

 Get an object from a ResourceBundle.

 	handleGetObject(String)

 Get an object from a ResourceBundle.

 	setParent(ResourceBundle)

 Set the parent bundle of this bundle.

 parent

  protected ResourceBundle parent

 The parent bundle is consulted by getObject when this bundle  does not contain a particular resource.

 ResourceBundle

  public ResourceBundle()

 getMenu

  public final Menu getMenu(String key) throws MissingResourceException

 Get an object from a ResourceBundle.
Convenience method to save casting.

Parameters:

 key - see class description.

 getMenuBar

  public final MenuBar getMenuBar(String key) throws MissingResourceException

 Get an object from a ResourceBundle.
Convenience method to save casting.

Parameters:

 key - see class description.

 getString

  public final String getString(String key) throws MissingResourceException

 Get an object from a ResourceBundle.
Convenience method to save casting.

Parameters:

 key - see class description.

 getStringArray

  public final String[] getStringArray(String key) throws MissingResourceException

 Get an object from a ResourceBundle.
Convenience method to save casting.

Parameters:

 key - see class description.

 getObject

  public final Object getObject(String key) throws MissingResourceException

 Get an object from a ResourceBundle.

Parameters:

 key - see class description.

 getBundle

  public final static ResourceBundle getBundle(String baseName) throws MissingResourceException

 Get the appropriate ResourceBundle subclass.

Parameters:

 baseName - see class description.

 getBundle

  public final static ResourceBundle getBundle(String baseName,
                                               Locale locale)

 Get the appropriate ResourceBundle subclass.

Parameters:

 baseName - see class description.

 locale - see class description.

 setParent

  protected void setParent(ResourceBundle parent)

 Set the parent bundle of this bundle. The parent bundle is  searched by getObject when this bundle does not contain a  particular resource.

Parameters:

 parent - this bundle's parent bundle.

 handleGetObject

  protected abstract Object handleGetObject(String key) throws MissingResourceException

 Get an object from a ResourceBundle.  NOTE:  Subclasses must override.

Parameters:

 key - see class description.

 getKeys

  public abstract Enumeration getKeys()

 Return an enumeration of the keys.  NOTE:  Subclasses must override.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.SimpleTimeZone

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.SimpleTimeZone

java.lang.Object
   |
   +----java.util.TimeZone
           |
           +----java.util.SimpleTimeZone

______________________________________________________________________________

 public class SimpleTimeZone

 extends TimeZone

SimpleTimeZone is a concrete subclass of TimeZone  that represents a time zone for use with a Gregorian  calendar. This simple class does not handle historical  changes, and has limited rules.

 Use a negative value for dayOfWeekInMonth to indicate that  SimpleTimeZone  should count from the end of the month backwards.  For example, Daylight Savings Time ends at the last  (dayOfWeekInMonth = -1) Sunday in October, at 2 AM in standard time.

See Also:

Calendar, GregorianCalendar, TimeZone

______________________________________________________________________________

 	SimpleTimeZone(int, String)

 Constructs a SimpleTimeZone with the given base time zone offset  from GMT and time zone ID.

 	SimpleTimeZone (int, String, int, int, int, int, int, int, int, int)

 Constructs a SimpleTimeZone with the given base time zone offset  from GMT, time zone ID, time to start and end the daylight time.

 	clone()

 Overrides Cloneable

 	equals(Object)

 Compares the equality of two SimpleTimeZone objects.

 	getOffset(int, int, int, int, int, int)

 Overrides TimeZone  Gets offset, for current date, modified in case of daylight savings.

 	getRawOffset()

 Overrides TimeZone  Gets the GMT offset for this time zone.

 	hashCode()

 Override hashCode.

 	inDaylightTime(Date)

 Overrides TimeZone  Queries if the given date is in Daylight Savings Time.

 	setEndRule(int, int, int, int)

 Sets the daylight savings ending rule.

 	setRawOffset(int)

 Overrides TimeZone  Sets the base time zone offset to GMT.

 	setStartRule(int, int, int, int)

 Sets the daylight savings starting rule.

 	setStartYear(int)

 Sets the daylight savings starting year.

 	useDaylightTime()

 Overrides TimeZone  Queries if this time zone uses Daylight Savings Time.

 SimpleTimeZone

  public SimpleTimeZone(int rawOffset,
                        String ID)

 Constructs a SimpleTimeZone with the given base time zone offset  from GMT and time zone ID. Timezone IDs can be obtained from  TimeZone.getAvailableIDs. Normally you should use TimeZone.getDefault  to construct a TimeZone.

Parameters:

 rawOffset - the given base time zone offset to GMT.

 ID - the time zone ID which is obtained from  TimeZone.getAvailableIDs.

 SimpleTimeZone

  public SimpleTimeZone(int rawOffset,
                        String ID,
                        int startMonth,
                        int startDayOfWeekInMonth,
                        int startDayOfWeek,
                        int startTime,
                        int endMonth,
                        int endDayOfWeekInMonth,
                        int endDayOfWeek,
                        int endTime)

 Constructs a SimpleTimeZone with the given base time zone offset  from GMT, time zone ID, time to start and end the daylight time.  Timezone IDs can be obtained from TimeZone.getAvailableIDs.  Normally you should use TimeZone.getDefault to create a TimeZone.  For a time zone that does not use daylight saving time, do not  use this constructor; instead you should use  SimpleTimeZone(rawOffset, ID).

Parameters:

 rawOffset - the given base time zone offset to GMT.

 ID - the time zone ID which is obtained from  TimeZone.getAvailableIDs.

 startMonth - the daylight savings starting month. Month is 0-based.  eg, 0 for January.

 startDayOfWeekInMonth - the daylight savings starting  day-of-week-in-month. Please see the member description for an example.

 startDayOfWeek - the daylight savings starting day-of-week.  Please see the member description for an example.

 startTime - the daylight savings starting time. Please see the  member description for an example.

 endMonth - the daylight savings ending month. Month is 0-based.  eg, 0 for January.

 endDayOfWeekInMonth - the daylight savings ending  day-of-week-in-month. Please see the member description for an example.

 endDayOfWeek - the daylight savings ending day-of-week. Please see  the member description for an example.

 endTime - the daylight savings ending time. Please see the member  description for an example.

 setStartYear

  public void setStartYear(int year)

 Sets the daylight savings starting year.

Parameters:

 year - the daylight savings starting year.

 setStartRule

  public void setStartRule(int month,
                           int dayOfWeekInMonth,
                           int dayOfWeek,
                           int time)

 Sets the daylight savings starting rule. For example, Daylight Savings  Time starts at the first Sunday in April, at 2 AM in standard time.  Therefore, you can set the start rule by calling:  setStartRule(TimeFields.APRIL, 1, TimeFields.SUNDAY, 2*60*60*1000);

Parameters:

 month - the daylight savings starting month. Month is 0-based.  eg, 0 for January.

 dayOfWeekInMonth - the daylight savings starting  day-of-week-in-month. Please see the member description for an example.

 dayOfWeek - the daylight savings starting day-of-week. Please see  the member description for an example.

 time - the daylight savings starting time. Please see the member  description for an example.

 setEndRule

  public void setEndRule(int month,
                         int dayOfWeekInMonth,
                         int dayOfWeek,
                         int time)

 Sets the daylight savings ending rule. For example, Daylight Savings  Time ends at the last (-1) Sunday in October, at 2 AM in standard time.  Therefore, you can set the end rule by calling:  setEndRule(TimeFields.OCTOBER, -1, TimeFields.SUNDAY, 2*60*60*1000);

Parameters:

 month - the daylight savings ending month. Month is 0-based.  eg, 0 for January.

 dayOfWeekInMonth - the daylight savings ending  day-of-week-in-month. Please see the member description for an example.

 dayOfWeek - the daylight savings ending day-of-week. Please see  the member description for an example.

 time - the daylight savings ending time. Please see the member  description for an example.

 getOffset

  public int getOffset(int era,
                       int year,
                       int month,
                       int day,
                       int dayOfWeek,
                       int millis)

 Overrides TimeZone  Gets offset, for current date, modified in case of daylight savings.  This is the offset to add *to* UTC to get local time.  Please see TimeZone.getOffset for descriptions on parameters.

Overrides:

getOffset in class TimeZone

 getRawOffset

  public int getRawOffset()

 Overrides TimeZone  Gets the GMT offset for this time zone.

Overrides:

getRawOffset in class TimeZone

 setRawOffset

  public void setRawOffset(int offsetMillis)

 Overrides TimeZone  Sets the base time zone offset to GMT.  This is the offset to add *to* UTC to get local time.  Please see TimeZone.setRawOffset for descriptions on the parameter.

Overrides:

setRawOffset in class TimeZone

 useDaylightTime

  public boolean useDaylightTime()

 Overrides TimeZone  Queries if this time zone uses Daylight Savings Time.

Overrides:

useDaylightTime in class TimeZone

 inDaylightTime

  public boolean inDaylightTime(Date date)

 Overrides TimeZone  Queries if the given date is in Daylight Savings Time.

Overrides:

inDaylightTime in class TimeZone

 clone

  public Object clone()

 Overrides Cloneable

Overrides:

clone in class TimeZone

 hashCode

  public synchronized int hashCode()

 Override hashCode.  Generates the hash code for the SimpleDateFormat object

Overrides:

hashCode in class Object

 equals

  public boolean equals(Object obj)

 Compares the equality of two SimpleTimeZone objects.

Parameters:

 obj - the SimpleTimeZone object to be compared with.

Returns:

 true if the given obj is the same as this SimpleTimeZone  object; false otherwise.

Overrides:

equals in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.Stack

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.Stack

java.lang.Object
   |
   +----java.util.Vector
           |
           +----java.util.Stack

______________________________________________________________________________

 public class Stack

 extends Vector

The Stack class represents a last-in-first-out  (LIFO) stack of objects.

______________________________________________________________________________

 	Stack()

 	empty()

 Tests if this stack is empty.

 	peek()

 Looks at the object at the top of this stack without removing it  from the stack.

 	pop()

 Removes the object at the top of this stack and returns that  object as the value of this function.

 	push(Object)

 Pushes an item onto the top of this stack.

 	search(Object)

 Returns where an object is on this stack.

 Stack

  public Stack()

 push

  public Object push(Object item)

 Pushes an item onto the top of this stack.

Parameters:

 item - the item to be pushed onto this stack.

Returns:

 the item argument.

 pop

  public synchronized Object pop()

 Removes the object at the top of this stack and returns that  object as the value of this function.

Returns:

 The object at the top of this stack.

Throws: EmptyStackException

 if this stack is empty.

 peek

  public synchronized Object peek()

 Looks at the object at the top of this stack without removing it  from the stack.

Returns:

 the object at the top of this stack.

Throws: EmptyStackException

 if this stack is empty.

 empty

  public boolean empty()

 Tests if this stack is empty.

Returns:

true if this stack is empty;  false otherwise.

 search

  public synchronized int search(Object o)

 Returns where an object is on this stack.

Parameters:

 o - the desired object.

Returns:

 the distance from the top of the stack where the object is]  located; the return value -1 indicates that the  object is not on the stack.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.StringTokenizer

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.StringTokenizer

java.lang.Object
   |
   +----java.util.StringTokenizer

______________________________________________________________________________

 public class StringTokenizer

 extends Object

 implements Enumeration

The string tokenizer class allows an application to break a  string into tokens. The tokenization method is much simpler than  the one used by the StreamTokenizer class. The  StringTokenizer methods do not distinguish among  identifiers, numbers, and quoted strings, nor do they recognize  and skip comments.

 The set of delimiters (the characters that separate tokens) may  be specified either at creation time or on a per-token basis.

 An instance of StringTokenizer behaves in one of two  ways, depending on whether it was created with the  returnTokens  flag having the value true  or false:

• If the flag is false , delimiter characters serve to  separate tokens. A token is a maximal sequence of consecutive  characters that are not delimiters.

• If the flag is true, delimiter characters are considered to  be tokens. A token is either one delimiter character, or a maximal  sequence of consecutive characters that are not delimiters.

 The following is one example of the use of the tokenizer. The code:

     StringTokenizer st = new StringTokenizer("this is a test");
     while (st.hasMoreTokens()) {
         println(st.nextToken());
     }

 prints the following output:

     this
     is
     a
     test

See Also:

StreamTokenizer

______________________________________________________________________________

 	StringTokenizer(String)

 Constructs a string tokenizer for the specified string.

 	StringTokenizer(String, String)

 Constructs a string tokenizer for the specified string.

 	StringTokenizer(String, String, boolean)

 Constructs a string tokenizer for the specified string.

 	countTokens()

 Calculates the number of times that this tokenizer's  nextToken  method can be called before it generates an  exception.

 	hasMoreElements()

 Returns the same value as the hasMoreTokens  method.

 	hasMoreTokens()

 Tests if there are more tokens available from this tokenizer's string.

 	nextElement()

 Returns the same value as the nextToken method,  except that its declared return value is Object rather than  String.

 	nextToken()

 Returns the next token from this string tokenizer.

 	nextToken(String)

 Returns the next token in this string tokenizer's string.

 StringTokenizer

  public StringTokenizer(String str,
                         String delim,
                         boolean returnTokens)

 Constructs a string tokenizer for the specified string. The  characters in the delim argument are the delimiters  for separating tokens.

 If the returnTokens flag is true, then  the delimiter characters are also returned as tokens. Each  delimiter is returned as a string of length one. If the flag is  false , the delimiter characters are skipped and only  serve as separators between tokens.

Parameters:

 str - a string to be parsed.

 delim - the delimiters.

 returnTokens - flag indicating whether to return the delimiters  as tokens.

 StringTokenizer

  public StringTokenizer(String str,
                         String delim)

 Constructs a string tokenizer for the specified string. The  characters in the delim argument are the delimiters  for separating tokens.

Parameters:

 str - a string to be parsed.

 delim - the delimiters.

 StringTokenizer

  public StringTokenizer(String str)

 Constructs a string tokenizer for the specified string. The  tokenizer uses the default delimiter set, which is  "\t\n\r" : the space character, the tab  character, the newline character, and the carriage-return character.

Parameters:

 str - a string to be parsed.

 hasMoreTokens

  public boolean hasMoreTokens()

 Tests if there are more tokens available from this tokenizer's string.

Returns:

true if there are more tokens available from this  tokenizer's string; false  otherwise.

 nextToken

  public String nextToken()

 Returns the next token from this string tokenizer.

Returns:

 the next token from this string tokenizer.

Throws: NoSuchElementException

 if there are no more tokens in this  tokenizer's string.

 nextToken

  public String nextToken(String delim)

 Returns the next token in this string tokenizer's string. The new  delimiter set remains the default after this call.

Parameters:

 delim - the new delimiters.

Returns:

 the next token, after switching to the new delimiter set.

Throws: NoSuchElementException

 if there are no more tokens in this  tokenizer's string.

 hasMoreElements

  public boolean hasMoreElements()

 Returns the same value as the hasMoreTokens  method. It exists so that this class can implement the  Enumeration interface.

Returns:

true if there are more tokens;  false otherwise.

See Also:

Enumeration, hasMoreTokens

 nextElement

  public Object nextElement()

 Returns the same value as the nextToken method,  except that its declared return value is Object rather than  String . It exists so that this class can implement the  Enumeration interface.

Returns:

 the next token in the string.

Throws: NoSuchElementException

 if there are no more tokens in this  tokenizer's string.

See Also:

Enumeration, nextToken

 countTokens

  public int countTokens()

 Calculates the number of times that this tokenizer's  nextToken method can be called before it generates an  exception.

Returns:

 the number of tokens remaining in the string using the current  delimiter set.

See Also:

nextToken

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.TimeZone

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.TimeZone

java.lang.Object
   |
   +----java.util.TimeZone

______________________________________________________________________________

 public class TimeZone

 extends Object

 implements Serializable, Cloneable

TimeZone represents a time zone offset, and also figures out daylight  savings.

 Typically, you get a TimeZone using getDefault  which creates a TimeZone based on the time zone where the program  is running. For example, for a program running in Japan, getDefault  creates a TimeZone object based on Japanese Standard Time.

 You can also get a TimeZone using getTimeZone along  with a time zone ID. For instance, the time zone ID for the Pacific  Standard Time zone is "PST". So, you can get a PST TimeZone object  with:

 TimeZone tz = TimeZone.getTimeZone("PST");

 You can use getAvailableIDs method to iterate through  all the supported time zone IDs. You can then choose a  supported ID to get a favorite TimeZone.

See Also:

Calendar, GregorianCalendar, SimpleTimeZone

______________________________________________________________________________

 	TimeZone()

 	clone()

 Overrides Cloneable

 	getAvailableIDs()

 Gets all the available IDs supported.

 	getAvailableIDs(int)

 Gets the available IDs according to the given time zone offset.

 	getDefault()

 Gets the default TimeZone for this host.

 	getID()

 Gets the ID of this time zone.

 	getOffset(int, int, int, int, int, int)

 Gets the time zone offset, for current date, modified in case of  daylight savings.

 	getRawOffset()

 Gets unmodified offset, NOT modified in case of daylight savings.

 	getTimeZone(String)

 Gets the TimeZone for the given ID.

 	inDaylightTime(Date)

 Queries if the given date is in Daylight Savings Time in  this time zone.

 	setDefault(TimeZone)

 Sets time zone to using the given TimeZone.

 	setID(String)

 Sets the time zone ID.

 	setRawOffset(int)

 Sets the base time zone offset to GMT.

 	useDaylightTime()

 Queries if this time zone uses Daylight Savings Time.

 TimeZone

  public TimeZone()

 getOffset

  public abstract int getOffset(int era,
                                int year,
                                int month,
                                int day,
                                int dayOfWeek,
                                int milliseconds)

 Gets the time zone offset, for current date, modified in case of  daylight savings. This is the offset to add *to* UTC to get local time.

Parameters:

 era - the era of the given date.

 year - the year in the given date.

 month - the month in the given date.  Month is 0-based. e.g., 0 for January.

 day - the day-in-month of the given date.

 dayOfWeek - the day-of-week of the given date.

 milliseconds - the millis in day.

Returns:

 the offset to add *to* GMT to get local time.

 setRawOffset

  public abstract void setRawOffset(int offsetMillis)

 Sets the base time zone offset to GMT.  This is the offset to add *to* UTC to get local time.

Parameters:

 offsetMillis - the given base time zone offset to GMT.

 getRawOffset

  public abstract int getRawOffset()

 Gets unmodified offset, NOT modified in case of daylight savings.  This is the offset to add *to* UTC to get local time.

Returns:

 the unmodified offset to add *to* UTC to get local time.

 getID

  public String getID()

 Gets the ID of this time zone.

Returns:

 the ID of this time zone.

 setID

  public void setID(String ID)

 Sets the time zone ID. This does not change any other data in  the time zone object.

Parameters:

 ID - the new time zone ID.

 useDaylightTime

  public abstract boolean useDaylightTime()

 Queries if this time zone uses Daylight Savings Time.

Returns:

 true if this time zone uses Daylight Savings Time,  false, otherwise.

 inDaylightTime

  public abstract boolean inDaylightTime(Date date)

 Queries if the given date is in Daylight Savings Time in  this time zone.

Parameters:

 date - the given Date.

Returns:

 true if the given date is in Daylight Savings Time,  false, otherwise.

 getTimeZone

  public static synchronized TimeZone getTimeZone(String ID)

 Gets the TimeZone for the given ID.

Parameters:

 ID - the given ID.

Returns:

 a TimeZone.

 getAvailableIDs

  public static synchronized String[] getAvailableIDs(int rawOffset)

 Gets the available IDs according to the given time zone offset.

Parameters:

 rawOffset - the given time zone GMT offset.

Returns:

 an array of IDs, where the time zone for that ID has  the specified GMT offset. For example, {"Phoenix", "Denver"},  since both have GMT-07:00, but differ in daylight savings behavior.

 getAvailableIDs

  public static synchronized String[] getAvailableIDs()

 Gets all the available IDs supported.

Returns:

 an array of IDs.

 getDefault

  public static synchronized TimeZone getDefault()

 Gets the default TimeZone for this host.

Returns:

 a default TimeZone.

 setDefault

  public static synchronized void setDefault(TimeZone zone)

 Sets time zone to using the given TimeZone.

Parameters:

 zone - the given time zone.

 clone

  public Object clone()

 Overrides Cloneable

Overrides:

clone in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.TooManyListenersException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.TooManyListenersException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.util.TooManyListenersException

______________________________________________________________________________

 public class TooManyListenersException

 extends Exception

 The  TooManyListenersException  Exception is used as part of  the Java Event model to annotate and implement a unicast special case of  a multicast Event Source.

 The presence of a  throws TooManyListenersException  clause  on any given concrete implementation of the normally multicast semantic   void add < EventListenerType > ()  event listener  registration pattern is used to annotate that interface as implementing  a unicast Listener special case, that is, that one and only one Listener  may be registered on the particular event listener source concurrently.

See Also:

EventObject, EventListener

______________________________________________________________________________

 	TooManyListenersException()

 Constructs a TooManyListenersException with no detail message.

 	TooManyListenersException(String)

 Constructs a TooManyListenersException with the specified detail message.

 TooManyListenersException

  public TooManyListenersException()

 Constructs a TooManyListenersException with no detail message.  A detail message is a String that describes this particular exception.

 TooManyListenersException

  public TooManyListenersException(String s)

 Constructs a TooManyListenersException with the specified detail message.  A detail message is a String that describes this particular exception.

Parameters:

 s - the detail message

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.Vector

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.Vector

java.lang.Object
   |
   +----java.util.Vector

______________________________________________________________________________

 public class Vector

 extends Object

 implements Cloneable, Serializable

The Vector class implements a growable array of  objects. Like an array, it contains components that can be  accessed using an integer index. However, the size of a  Vector  can grow or shrink as needed to accommodate  adding and removing items after the Vector  has been created.

 Each vector tries to optimize storage management by maintaining a  capacity and a capacityIncrement. The  capacity is always at least as large as the vector  size; it is usually larger because as components are added to the  vector, the vector's storage increases in chunks the size of  capacityIncrement . An application can increase the  capacity of a vector before inserting a large number of  components; this reduces the amount of incremental reallocation.

______________________________________________________________________________

 	capacityIncrement

 The amount by which the capacity of the vector is automatically  incremented when its size becomes greater than its capacity.

 	elementCount

 The number of valid components in the vector.

 	elementData

 The array buffer into which the components of the vector are  stored.

 	Vector()

 Constructs an empty vector.

 	Vector(int)

 Constructs an empty vector with the specified initial capacity.

 	Vector(int, int)

 Constructs an empty vector with the specified initial capacity and  capacity increment.

 	addElement(Object)

 Adds the specified component to the end of this vector,  increasing its size by one.

 	capacity()

 Returns the current capacity of this vector.

 	clone()

 Returns a clone of this vector.

 	contains(Object)

 Tests if the specified object is a component in this vector.

 	copyInto(Object[])

 Copies the components of this vector into the specified array.

 	elementAt(int)

 Returns the component at the specified index.

 	elements()

 Returns an enumeration of the components of this vector.

 	ensureCapacity(int)

 Increases the capacity of this vector, if necessary, to ensure  that it can hold at least the number of components specified by  the minimum capacity argument.

 	firstElement()

 Returns the first component of this vector.

 	indexOf(Object)

 Searches for the first occurence of the given argument, testing  for equality using the equals method.

 	indexOf(Object, int)

 Searches for the first occurence of the given argument, beginning  the search at index , and testing for equality using  the equals method.

 	insertElementAt(Object, int)

 Inserts the specified object as a component in this vector at the  specified index.

 	isEmpty()

 Tests if this vector has no components.

 	lastElement()

 Returns the last component of the vector.

 	lastIndexOf(Object)

 Returns the index of the last occurrence of the specified object in  this vector.

 	lastIndexOf(Object, int)

 Searches backwards for the specified object, starting from the  specified index, and returns an index to it.

 	removeAllElements()

 Removes all components from this vector and sets its size to zero.

 	removeElement(Object)

 Removes the first occurrence of the argument from this vector.

 	removeElementAt(int)

 Deletes the component at the specified index.

 	setElementAt(Object, int)

 Sets the component at the specified index of this  vector to be the specified object.

 	setSize(int)

 Sets the size of this vector.

 	size()

 Returns the number of components in this vector.

 	toString()

 Returns a string representation of this vector.

 	trimToSize()

 Trims the capacity of this vector to be the vector's current  size.

 elementData

  protected Object elementData[]

 The array buffer into which the components of the vector are  stored. The capacity of the vector is the length of this array buffer.

 elementCount

  protected int elementCount

 The number of valid components in the vector.

 capacityIncrement

  protected int capacityIncrement

 The amount by which the capacity of the vector is automatically  incremented when its size becomes greater than its capacity. If  the capacity is 0 , the capacity of the vector is  doubled each time it needs to grow.

 Vector

  public Vector(int initialCapacity,
                int capacityIncrement)

 Constructs an empty vector with the specified initial capacity and  capacity increment.

Parameters:

 initialCapacity - the initial capacity of the vector.

 capacityIncrement - the amount by which the capacity is  increased when the vector overflows.

 Vector

  public Vector(int initialCapacity)

 Constructs an empty vector with the specified initial capacity.

Parameters:

 initialCapacity - the initial capacity of the vector.

 Vector

  public Vector()

 Constructs an empty vector.

 copyInto

  public final synchronized void copyInto(Object anArray[])

 Copies the components of this vector into the specified array.  The array must be big enough to hold all the objects in this vector.

Parameters:

 anArray - the array into which the components get copied.

 trimToSize

  public final synchronized void trimToSize()

 Trims the capacity of this vector to be the vector's current  size. An application can use this operation to minimize the  storage of a vector.

 ensureCapacity

  public final synchronized void ensureCapacity(int minCapacity)

 Increases the capacity of this vector, if necessary, to ensure  that it can hold at least the number of components specified by  the minimum capacity argument.

Parameters:

 minCapacity - the desired minimum capacity.

 setSize

  public final synchronized void setSize(int newSize)

 Sets the size of this vector. If the new size is greater than the  current size, new null items are added to the end of  the vector. If the new size is less than the current size, all  components at index newSize and greater are discarded.

Parameters:

 newSize - the new size of this vector.

 capacity

  public final int capacity()

 Returns the current capacity of this vector.

Returns:

 the current capacity of this vector.

 size

  public final int size()

 Returns the number of components in this vector.

Returns:

 the number of components in this vector.

 isEmpty

  public final boolean isEmpty()

 Tests if this vector has no components.

Returns:

true if this vector has no components;  false otherwise.

 elements

  public final synchronized Enumeration elements()

 Returns an enumeration of the components of this vector.

Returns:

 an enumeration of the components of this vector.

See Also:

Enumeration

 contains

  public final boolean contains(Object elem)

 Tests if the specified object is a component in this vector.

Parameters:

 elem - an object.

Returns:

true if the specified object is a component in  this vector; false  otherwise.

 indexOf

  public final int indexOf(Object elem)

 Searches for the first occurence of the given argument, testing  for equality using the equals method.

Parameters:

 elem - an object.

Returns:

 the index of the first occurrence of the argument in this  vector; returns -1  if the object is not found.

See Also:

equals

 indexOf

  public final synchronized int indexOf(Object elem,
                                        int index)

 Searches for the first occurence of the given argument, beginning  the search at index, and testing for equality using  the equals method.

Parameters:

 elem - an object.

 index - the index to start searching from.

Returns:

 the index of the first occurrence of the object argument in  this vector at position index or later in the  vector; returns -1 if the object is not found.

See Also:

equals

 lastIndexOf

  public final int lastIndexOf(Object elem)

 Returns the index of the last occurrence of the specified object in  this vector.

Parameters:

 elem - the desired component.

Returns:

 the index of the last occurrence of the specified object in  this vector; returns -1  if the object is not found.

 lastIndexOf

  public final synchronized int lastIndexOf(Object elem,
                                            int index)

 Searches backwards for the specified object, starting from the  specified index, and returns an index to it.

Parameters:

 elem - the desired component.

 index - the index to start searching from.

Returns:

 the index of the last occurrence of the specified object in this  vector at position less than index in the vector;  -1 if the object is not found.

 elementAt

  public final synchronized Object elementAt(int index)

 Returns the component at the specified index.

Parameters:

 index - an index into this vector.

Returns:

 the component at the specified index.

Throws: ArrayIndexOutOfBoundsException

 if an invalid index was  given.

 firstElement

  public final synchronized Object firstElement()

 Returns the first component of this vector.

Returns:

 the first component of this vector.

Throws: NoSuchElementException

 if this vector has no components.

 lastElement

  public final synchronized Object lastElement()

 Returns the last component of the vector.

Returns:

 the last component of the vector, i.e., the component at index  size() - 1.

Throws: NoSuchElementException

 if this vector is empty.

 setElementAt

  public final synchronized void setElementAt(Object obj,
                                              int index)

 Sets the component at the specified index of this  vector to be the specified object. The previous component at that  position is discarded.

 The index must be a value greater than or equal to 0  and less than the current size of the vector.

Parameters:

 obj - what the component is to be set to.

 index - the specified index.

Throws: ArrayIndexOutOfBoundsException

 if the index was invalid.

See Also:

size

 removeElementAt

  public final synchronized void removeElementAt(int index)

 Deletes the component at the specified index. Each component in  this vector with an index greater or equal to the specified  index  is shifted downward to have an index one  smaller than the value it had previously.

 The index must be a value greater than or equal to 0  and less than the current size of the vector.

Parameters:

 index - the index of the object to remove.

Throws: ArrayIndexOutOfBoundsException

 if the index was invalid.

See Also:

size

 insertElementAt

  public final synchronized void insertElementAt(Object obj,
                                                 int index)

 Inserts the specified object as a component in this vector at the  specified index. Each component in this vector with  an index greater or equal to the specified index is  shifted upward to have an index one greater than the value it had  previously.

 The index must be a value greater than or equal to 0  and less than or equal to the current size of the vector.

Parameters:

 obj - the component to insert.

 index - where to insert the new component.

Throws: ArrayIndexOutOfBoundsException

 if the index was invalid.

See Also:

size

 addElement

  public final synchronized void addElement(Object obj)

 Adds the specified component to the end of this vector,  increasing its size by one. The capacity of this vector is  increased if its size becomes greater than its capacity.

Parameters:

 obj - the component to be added.

 removeElement

  public final synchronized boolean removeElement(Object obj)

 Removes the first occurrence of the argument from this vector. If  the object is found in this vector, each component in the vector  with an index greater or equal to the object's index is shifted  downward to have an index one smaller than the value it had previously.

Parameters:

 obj - the component to be removed.

Returns:

true if the argument was a component of this  vector; false otherwise.

 removeAllElements

  public final synchronized void removeAllElements()

 Removes all components from this vector and sets its size to zero.

 clone

  public synchronized Object clone()

 Returns a clone of this vector.

Returns:

 a clone of this vector.

Overrides:

clone in class Object

 toString

  public final synchronized String toString()

 Returns a string representation of this vector.

Returns:

 a string representation of this vector.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.zip.Adler32

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.zip.Adler32

java.lang.Object
   |
   +----java.util.zip.Adler32

______________________________________________________________________________

 public class Adler32

 extends Object

 implements Checksum

A class that can be used to compute the Adler-32 checksum of a data  stream. An Adler-32 checksum is almost as reliable as a CRC-32 but  can be computed much faster.

See Also:

Checksum

______________________________________________________________________________

 	Adler32()

 	getValue()

 Returns checksum value.

 	reset()

 Resets checksum to initial value.

 	update(byte[])

 Updates checksum with specified array of bytes.

 	update(byte[], int, int)

 Updates checksum with specified array of bytes.

 	update(int)

 Updates checksum with specified byte.

 Adler32

  public Adler32()

 update

  public void update(int b)

 Updates checksum with specified byte.

 update

  public void update(byte b[],
                     int off,
                     int len)

 Updates checksum with specified array of bytes.

 update

  public void update(byte b[])

 Updates checksum with specified array of bytes.

 reset

  public void reset()

 Resets checksum to initial value.

 getValue

  public long getValue()

 Returns checksum value.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.zip.CheckedInputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.zip.CheckedInputStream

java.lang.Object
   |
   +----java.io.InputStream
           |
           +----java.io.FilterInputStream
                   |
                   +----java.util.zip.CheckedInputStream

______________________________________________________________________________

 public class CheckedInputStream

 extends FilterInputStream

An input stream that also maintains a checksum of the data being read.  The checksum can then be used to verify the integrity of the input data.

See Also:

Checksum

______________________________________________________________________________

 	CheckedInputStream(InputStream, Checksum)

 Creates an input stream using the specified Checksum.

 	getChecksum()

 Returns the Checksum for this input stream.

 	read()

 Reads a byte.

 	read(byte[], int, int)

 Reads into an array of bytes.

 	skip(long)

 Skips specified number of bytes of input.

 CheckedInputStream

  public CheckedInputStream(InputStream in,
                            Checksum cksum)

 Creates an input stream using the specified Checksum.

Parameters:

 in - the input stream

 cksum - the Checksum

 read

  public int read() throws IOException

 Reads a byte. Will block if no input is available.

Returns:

 the byte read, or -1 if the end of the stream is reached.

Throws: IOException

 if an I/O error has occurred

Overrides:

read in class FilterInputStream

 read

  public int read(byte buf[],
                  int off,
                  int len) throws IOException

 Reads into an array of bytes. Will block until some input  is available.

Parameters:

 buf - the buffer into which the data is read

 off - the start offset of the data

 len - the maximum number of bytes read

Returns:

 the actual number of bytes read, or -1 if the end 	of the stream is reached.

Throws: IOException

 if an I/O error has occurred

Overrides:

read in class FilterInputStream

 skip

  public long skip(long n) throws IOException

 Skips specified number of bytes of input.

Parameters:

 n - the number of bytes to skip

Returns:

 the actual number of bytes skipped

Throws: IOException

 if an I/O error has occurred

Overrides:

skip in class FilterInputStream

 getChecksum

  public Checksum getChecksum()

 Returns the Checksum for this input stream.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.zip.CheckedOutputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.zip.CheckedOutputStream

java.lang.Object
   |
   +----java.io.OutputStream
           |
           +----java.io.FilterOutputStream
                   |
                   +----java.util.zip.CheckedOutputStream

______________________________________________________________________________

 public class CheckedOutputStream

 extends FilterOutputStream

An output stream that also maintains a checksum of the data being  written. The checksum can then be used to verify the integrity of  the output data.

See Also:

Checksum

______________________________________________________________________________

 	CheckedOutputStream(OutputStream, Checksum)

 Creates an output stream with the specified Checksum.

 	getChecksum()

 Returns the Checksum for this output stream.

 	write(byte[], int, int)

 Writes an array of bytes.

 	write(int)

 Writes a byte.

 CheckedOutputStream

  public CheckedOutputStream(OutputStream out,
                             Checksum cksum)

 Creates an output stream with the specified Checksum.

Parameters:

 out - the output stream

 cksum - the checksum

 write

  public void write(int b) throws IOException

 Writes a byte. Will block until the byte is actually written.

Parameters:

 b - the byte to be written

Throws: IOException

 if an I/O error has occurred

Overrides:

write in class FilterOutputStream

 write

  public void write(byte b[],
                    int off,
                    int len) throws IOException

 Writes an array of bytes. Will block until the bytes are  actually written.

Parameters:

 buf - the data to be written

 off - the start offset of the data

 len - the number of bytes to be written

Throws: IOException

 if an I/O error has occurred

Overrides:

write in class FilterOutputStream

 getChecksum

  public Checksum getChecksum()

 Returns the Checksum for this output stream.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface java.util.zip.Checksum

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Interface java.util.zip.Checksum

 public interface Checksum

An interface representing a data checksum.

______________________________________________________________________________

 	getValue()

 Returns the current checksum value.

 	reset()

 Resets the checksum to its initial value.

 	update(byte[], int, int)

 Updates the current checksum with the specified array of bytes.

 	update(int)

 Updates the current checksum with the specified byte.

 update

  public abstract void update(int b)

 Updates the current checksum with the specified byte.

 update

  public abstract void update(byte b[],
                              int off,
                              int len)

 Updates the current checksum with the specified array of bytes.

 getValue

  public abstract long getValue()

 Returns the current checksum value.

 reset

  public abstract void reset()

 Resets the checksum to its initial value.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.zip.CRC32

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.zip.CRC32

java.lang.Object
   |
   +----java.util.zip.CRC32

______________________________________________________________________________

 public class CRC32

 extends Object

 implements Checksum

A class that can be used to compute the CRC-32 of a data stream.

See Also:

Checksum

______________________________________________________________________________

 	CRC32()

 	getValue()

 Returns CRC-32 value.

 	reset()

 Resets CRC-32 to initial value.

 	update(byte[])

 Updates CRC-32 with specified array of bytes.

 	update(byte[], int, int)

 Updates CRC-32 with specified array of bytes.

 	update(int)

 Updates CRC-32 with specified byte.

 CRC32

  public CRC32()

 update

  public void update(int b)

 Updates CRC-32 with specified byte.

 update

  public void update(byte b[],
                     int off,
                     int len)

 Updates CRC-32 with specified array of bytes.

 update

  public void update(byte b[])

 Updates CRC-32 with specified array of bytes.

 reset

  public void reset()

 Resets CRC-32 to initial value.

 getValue

  public long getValue()

 Returns CRC-32 value.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.zip.DataFormatException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.zip.DataFormatException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.util.zip.DataFormatException

______________________________________________________________________________

 public class DataFormatException

 extends Exception

Signals that a data format error has occurred.

______________________________________________________________________________

 	DataFormatException()

 Constructs a DataFormatException with no detail message.

 	DataFormatException(String)

 Constructs a DataFormatException with the specified detail message.

 DataFormatException

  public DataFormatException()

 Constructs a DataFormatException with no detail message.

 DataFormatException

  public DataFormatException(String s)

 Constructs a DataFormatException with the specified detail message.  A detail message is a String that describes this particular exception.

Parameters:

 s - the String containing a detail message

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.zip.Deflater

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.zip.Deflater

java.lang.Object
   |
   +----java.util.zip.Deflater

______________________________________________________________________________

 public class Deflater

 extends Object

This class provides support for general purpose decompression using  the popular ZLIB compression library. The ZLIB compression library  was initially developed as part of the PNG graphics standard and is  not protected by patents. It is fully described in RFCs 1950, 1951,  and 1952, which can be found at  ftp://ds.internic.net/rfc  in the files rfc1950.txt (zlib format),  rfc1951.txt (deflate format) and rfc1952.txt (gzip format).

See Also:

Inflater

______________________________________________________________________________

 	BEST_COMPRESSION

 Compression level for best compression.

 	BEST_SPEED

 Compression level for fastest compression.

 	DEFAULT_COMPRESSION

 Default compression level.

 	DEFAULT_STRATEGY

 Default compression strategy.

 	DEFLATED

 Compression method for the deflate algorithm (the only one currently  supported).

 	FILTERED

 Compression strategy best used for data consisting mostly of small  values with a somewhat random distribution.

 	HUFFMAN_ONLY

 Compression strategy for Huffman coding only.

 	NO_COMPRESSION

 Compression level for no compression.

 	Deflater()

 Creates a new compressor with the default compression level.

 	Deflater(int)

 Creates a new compressor using the specified compression level.

 	Deflater(int, boolean)

 Creates a new compressor using the specified compression level.

 	deflate(byte[])

 Fills specified buffer with compressed data.

 	deflate(byte[], int, int)

 Fills specified buffer with compressed data.

 	end()

 Discards unprocessed input and frees internal data.

 	finalize()

 Frees the compressor when garbage is collected.

 	finish()

 When called, indicates that compression should end with the current  contents of the input buffer.

 	finished()

 Returns true if the end of the compressed data output stream has  been reached.

 	getAdler()

 Returns the ADLER-32 value of the uncompressed data.

 	getTotalIn()

 Returns the total number of bytes input so far.

 	getTotalOut()

 Returns the total number of bytes output so far.

 	needsInput()

 Returns true if the input data buffer is empty and setInput()  should be called in order to provide more input.

 	reset()

 Resets deflater so that a new set of input data can be processed.

 	setDictionary(byte[])

 Sets preset dictionary for compression.

 	setDictionary(byte[], int, int)

 Sets preset dictionary for compression.

 	setInput(byte[])

 Sets input data for compression.

 	setInput(byte[], int, int)

 Sets input data for compression.

 	setLevel(int)

 Sets the current compression level to the specified value.

 	setStrategy(int)

 Sets the compression strategy to the specified value.

 DEFLATED

  public final static int DEFLATED

 Compression method for the deflate algorithm (the only one currently  supported).

 NO_COMPRESSION

  public final static int NO_COMPRESSION

 Compression level for no compression.

 BEST_SPEED

  public final static int BEST_SPEED

 Compression level for fastest compression.

 BEST_COMPRESSION

  public final static int BEST_COMPRESSION

 Compression level for best compression.

 DEFAULT_COMPRESSION

  public final static int DEFAULT_COMPRESSION

 Default compression level.

 FILTERED

  public final static int FILTERED

 Compression strategy best used for data consisting mostly of small  values with a somewhat random distribution. Forces more Huffman coding  and less string matching.

 HUFFMAN_ONLY

  public final static int HUFFMAN_ONLY

 Compression strategy for Huffman coding only.

 DEFAULT_STRATEGY

  public final static int DEFAULT_STRATEGY

 Default compression strategy.

 Deflater

  public Deflater(int level,
                  boolean nowrap)

 Creates a new compressor using the specified compression level.  If 'nowrap' is true then the ZLIB header and checksum fields will  not be used in order to support the compression format used in  both GZIP and PKZIP.

Parameters:

 level - the compression level (0-9)

 nowrap - if true then use GZIP compatible compression

 Deflater

  public Deflater(int level)

 Creates a new compressor using the specified compression level.  Compressed data will be generated in ZLIB format.

Parameters:

 level - the compression level (0-9)

 Deflater

  public Deflater()

 Creates a new compressor with the default compression level.  Compressed data will be generated in ZLIB format.

 setInput

  public synchronized void setInput(byte b[],
                                    int off,
                                    int len)

 Sets input data for compression. This should be called whenever  needsInput() returns true indicating that more input data is required.

Parameters:

 b - the input data bytes

 off - the start offset of the data

 len - the length of the data

See Also:

needsInput

 setInput

  public void setInput(byte b[])

 Sets input data for compression. This should be called whenever  needsInput() returns true indicating that more input data is required.

Parameters:

 b - the input data bytes

See Also:

needsInput

 setDictionary

  public synchronized void setDictionary(byte b[],
                                         int off,
                                         int len)

 Sets preset dictionary for compression. A preset dictionary is used  when the history buffer can be predetermined. When the data is later  uncompressed with Inflater.inflate(), Inflater.getAdler() can be called  in order to get the Adler-32 value of the dictionary required for  decompression.

Parameters:

 b - the dictionary data bytes

 off - the start offset of the data

 len - the length of the data

See Also:

inflate, getAdler

 setDictionary

  public void setDictionary(byte b[])

 Sets preset dictionary for compression. A preset dictionary is used  when the history buffer can be predetermined. When the data is later  uncompressed with Inflater.inflate(), Inflater.getAdler() can be called  in order to get the Adler-32 value of the dictionary required for  decompression.

Parameters:

 b - the dictionary data bytes

See Also:

inflate, getAdler

 setStrategy

  public synchronized void setStrategy(int strategy)

 Sets the compression strategy to the specified value.

Parameters:

 strategy - the new compression strategy

Throws: IllegalArgumentException

 if the compression strategy is 	invalid

 setLevel

  public synchronized void setLevel(int Level)

 Sets the current compression level to the specified value.

Parameters:

 level - the new compression level (0-9)

Throws: IllegalArgumentException

 if the compression level is invalid

 needsInput

  public boolean needsInput()

 Returns true if the input data buffer is empty and setInput()  should be called in order to provide more input.

 finish

  public synchronized void finish()

 When called, indicates that compression should end with the current  contents of the input buffer.

 finished

  public synchronized boolean finished()

 Returns true if the end of the compressed data output stream has  been reached.

 deflate

  public synchronized int deflate(byte b[],
                                  int off,
                                  int len)

 Fills specified buffer with compressed data. Returns actual number  of bytes of compressed data. A return value of 0 indicates that  needsInput() should be called in order to determine if more input  data is required.

Parameters:

 b - the buffer for the compressed data

 off - the start offset of the data

 len - the maximum number of bytes of compressed data

Returns:

 the actual number of bytes of compressed data

 deflate

  public int deflate(byte b[])

 Fills specified buffer with compressed data. Returns actual number  of bytes of compressed data. A return value of 0 indicates that  needsInput() should be called in order to determine if more input  data is required.

Parameters:

 b - the buffer for the compressed data

Returns:

 the actual number of bytes of compressed data

 getAdler

  public synchronized int getAdler()

 Returns the ADLER-32 value of the uncompressed data.

 getTotalIn

  public synchronized int getTotalIn()

 Returns the total number of bytes input so far.

 getTotalOut

  public synchronized int getTotalOut()

 Returns the total number of bytes output so far.

 reset

  public synchronized void reset()

 Resets deflater so that a new set of input data can be processed.  Keeps current compression level and strategy settings.

 end

  public synchronized void end()

 Discards unprocessed input and frees internal data.

 finalize

  protected void finalize()

 Frees the compressor when garbage is collected.

Overrides:

finalize in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.zip.DeflaterOutputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.zip.DeflaterOutputStream

java.lang.Object
   |
   +----java.io.OutputStream
           |
           +----java.io.FilterOutputStream
                   |
                   +----java.util.zip.DeflaterOutputStream

______________________________________________________________________________

 public class DeflaterOutputStream

 extends FilterOutputStream

This class implements an output stream filter for compressing data in  the "deflate" compression format. It is also used as the basis for other  types of compression filters, such as GZIPOutputStream.

See Also:

Deflater

______________________________________________________________________________

 	buf

 Output buffer for writing compressed data.

 	def

 Compressor for this stream.

 	DeflaterOutputStream(OutputStream)

 Creates a new output stream with a defaul compressor and buffer size.

 	DeflaterOutputStream(OutputStream, Deflater)

 Creates a new output stream with the specified compressor and  a default buffer size.

 	DeflaterOutputStream(OutputStream, Deflater, int)

 Creates a new output stream with the specified compressor and  buffer size.

 	close()

 Writes remaining compressed data to the output stream and closes the  underlying stream.

 	deflate()

 Writes next block of compressed data to the output stream.

 	finish()

 Finishes writing compressed data to the output stream without closing  the underlying stream.

 	write(byte[], int, int)

 Writes an array of bytes to the compressed output stream.

 	write(int)

 Writes a byte to the compressed output stream.

 def

  protected Deflater def

 Compressor for this stream.

 buf

  protected byte buf[]

 Output buffer for writing compressed data.

 DeflaterOutputStream

  public DeflaterOutputStream(OutputStream out,
                              Deflater def,
                              int size)

 Creates a new output stream with the specified compressor and  buffer size.

Parameters:

 out - the output stream

 def - the compressor ("deflater")

 len - the output buffer size

 DeflaterOutputStream

  public DeflaterOutputStream(OutputStream out,
                              Deflater def)

 Creates a new output stream with the specified compressor and  a default buffer size.

Parameters:

 out - the output stream

 def - the compressor ("deflater")

 DeflaterOutputStream

  public DeflaterOutputStream(OutputStream out)

 Creates a new output stream with a defaul compressor and buffer size.

 write

  public void write(int b) throws IOException

 Writes a byte to the compressed output stream. This method will  block until the byte can be written.

Parameters:

 b - the byte to be written

Throws: IOException

 if an I/O error has occurred

Overrides:

write in class FilterOutputStream

 write

  public void write(byte b[],
                    int off,
                    int len) throws IOException

 Writes an array of bytes to the compressed output stream. This  method will block until all the bytes are written.

Parameters:

 buf - the data to be written

 off - the start offset of the data

 len - the length of the data

Throws: IOException

 if an I/O error has occurred

Overrides:

write in class FilterOutputStream

 finish

  public void finish() throws IOException

 Finishes writing compressed data to the output stream without closing  the underlying stream. Use this method when applying multiple filters  in succession to the same output stream.

Throws: IOException

 if an I/O error has occurred

 close

  public void close() throws IOException

 Writes remaining compressed data to the output stream and closes the  underlying stream.

Throws: IOException

 if an I/O error has occurred

Overrides:

close in class FilterOutputStream

 deflate

  protected void deflate() throws IOException

 Writes next block of compressed data to the output stream.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.zip.GZIPInputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.zip.GZIPInputStream

java.lang.Object
   |
   +----java.io.InputStream
           |
           +----java.io.FilterInputStream
                   |
                   +----java.util.zip.InflaterInputStream
                           |
                           +----java.util.zip.GZIPInputStream

______________________________________________________________________________

 public class GZIPInputStream

 extends InflaterInputStream

This class implements a stream filter for reading compressed data in  the GZIP format.

See Also:

InflaterInputStream

______________________________________________________________________________

 	crc

 CRC-32 for uncompressed data.

 	eos

 Indicates end of input stream.

 	GZIP_MAGIC

 GZIP header magic number.

 	GZIPInputStream(InputStream)

 Creates a new input stream with a default buffer size.

 	GZIPInputStream(InputStream, int)

 Creates a new input stream with the specified buffer size.

 	close()

 Closes the input stream.

 	read(byte[], int, int)

 Reads uncompressed data into an array of bytes.

 crc

  protected CRC32 crc

 CRC-32 for uncompressed data.

 eos

  protected boolean eos

 Indicates end of input stream.

 GZIP_MAGIC

  public final static int GZIP_MAGIC

 GZIP header magic number.

 GZIPInputStream

  public GZIPInputStream(InputStream in,
                         int size) throws IOException

 Creates a new input stream with the specified buffer size.

Parameters:

 in - the input stream

 size - the input buffer size

Throws: IOException

 if an I/O error has occurred

 GZIPInputStream

  public GZIPInputStream(InputStream in) throws IOException

 Creates a new input stream with a default buffer size.

Parameters:

 in - the input stream

Throws: IOException

 if an I/O error has occurred

 read

  public int read(byte buf[],
                  int off,
                  int len) throws IOException

 Reads uncompressed data into an array of bytes. Blocks until enough  input is available for decompression.

Parameters:

 buf - the buffer into which the data is read

 off - the start offset of the data

 len - the maximum number of bytes read

Returns:

 the actual number of bytes read, or -1 if the end of the 	compressed input stream is reached

Throws: IOException

 if an I/O error has occurred or the compressed 	input data is corrupt

Overrides:

read in class InflaterInputStream

 close

  public void close() throws IOException

 Closes the input stream.

Throws: IOException

 if an I/O error has occurred

Overrides:

close in class FilterInputStream

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.zip.GZIPOutputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.zip.GZIPOutputStream

java.lang.Object
   |
   +----java.io.OutputStream
           |
           +----java.io.FilterOutputStream
                   |
                   +----java.util.zip.DeflaterOutputStream
                           |
                           +----java.util.zip.GZIPOutputStream

______________________________________________________________________________

 public class GZIPOutputStream

 extends DeflaterOutputStream

This class implements a stream filter for writing compressed data in  the GZIP file format.

______________________________________________________________________________

 	crc

 CRC-32 of uncompressed data.

 	GZIPOutputStream(OutputStream)

 Creates a new output stream with a default buffer size.

 	GZIPOutputStream(OutputStream, int)

 Creates a new output stream with the specified buffer size.

 	close()

 Writes remaining compressed data to the output stream and closes the  underlying stream.

 	finish()

 Finishes writing compressed data to the output stream without closing  the underlying stream.

 	write(byte[], int, int)

 Writes array of bytes to the compressed output stream.

 crc

  protected CRC32 crc

 CRC-32 of uncompressed data.

 GZIPOutputStream

  public GZIPOutputStream(OutputStream out,
                          int size) throws IOException

 Creates a new output stream with the specified buffer size.

Parameters:

 out - the output stream

 size - the output buffer size

Throws: IOException

 If an I/O error has occurred.

 GZIPOutputStream

  public GZIPOutputStream(OutputStream out) throws IOException

 Creates a new output stream with a default buffer size.

Parameters:

 out - the output stream

Throws: IOException

 If an I/O error has occurred.

 write

  public synchronized void write(byte buf[],
                                 int off,
                                 int len) throws IOException

 Writes array of bytes to the compressed output stream. This method  will block until all the bytes are written.

Parameters:

 buf - the data to be written

 off - the start offset of the data

 len - the length of the data

Throws: IOException

 If an I/O error has occurred.

Overrides:

write in class DeflaterOutputStream

 finish

  public void finish() throws IOException

 Finishes writing compressed data to the output stream without closing  the underlying stream. Use this method when applying multiple filters  in succession to the same output stream.

Throws: IOException

 if an I/O error has occurred

Overrides:

finish in class DeflaterOutputStream

 close

  public void close() throws IOException

 Writes remaining compressed data to the output stream and closes the  underlying stream.

Throws: IOException

 if an I/O error has occurred

Overrides:

close in class DeflaterOutputStream

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.zip.Inflater

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.zip.Inflater

java.lang.Object
   |
   +----java.util.zip.Inflater

______________________________________________________________________________

 public class Inflater

 extends Object

This class provides support for general purpose decompression using  the popular ZLIB compression library. The ZLIB compression library  was initially developed as part of the PNG graphics standard and is  not protected by patents. It is fully described in RFCs 1950, 1951,  and 1952, which can be found at  ftp://ds.internic.net/rfc  in the files rfc1950.txt (zlib format),  rfc1951.txt (deflate format) and rfc1952.txt (gzip format).

See Also:

Deflater

______________________________________________________________________________

 	Inflater()

 Creates a new decompressor.

 	Inflater(boolean)

 Creates a new decompressor.

 	end()

 Discards unprocessed input and frees internal data.

 	finalize()

 Frees the decompressor when garbage is collected.

 	finished()

 Return true if the end of the compressed data stream has been  reached.

 	getAdler()

 Returns the ADLER-32 value of the uncompressed data.

 	getRemaining()

 Returns the total number of bytes remaining in the input buffer.

 	getTotalIn()

 Returns the total number of bytes input so far.

 	getTotalOut()

 Returns the total number of bytes output so far.

 	inflate(byte[])

 Uncompresses bytes into specified buffer.

 	inflate(byte[], int, int)

 Uncompresses bytes into specified buffer.

 	needsDictionary()

 Returns true if a preset dictionary is needed for decompression.

 	needsInput()

 Returns true if no data remains in the input buffer.

 	reset()

 Resets inflater so that a new set of input data can be processed.

 	setDictionary(byte[])

 Sets the preset dictionary to the given array of bytes.

 	setDictionary(byte[], int, int)

 Sets the preset dictionary to the given array of bytes.

 	setInput(byte[])

 Sets input data for decompression.

 	setInput(byte[], int, int)

 Sets input data for decompression.

 Inflater

  public Inflater(boolean nowrap)

 Creates a new decompressor. If the parameter 'nowrap' is true then  the ZLIB header and checksum fields will not be used in order to  support the compression format used by both GZIP and PKZIP.

Parameters:

 nowrap - if true then support GZIP compatible compression

 Inflater

  public Inflater()

 Creates a new decompressor.

 setInput

  public synchronized void setInput(byte b[],
                                    int off,
                                    int len)

 Sets input data for decompression. Should be called whenever  needsInput() returns true indicating that more input data is  required.

Parameters:

 b - the input data bytes

 off - the start offset of the input data

 len - the length of the input data

See Also:

needsInput

 setInput

  public void setInput(byte b[])

 Sets input data for decompression. Should be called whenever  needsInput() returns true indicating that more input data is  required.

Parameters:

 b - the input data bytes

See Also:

needsInput

 setDictionary

  public synchronized void setDictionary(byte b[],
                                         int off,
                                         int len)

 Sets the preset dictionary to the given array of bytes. Should be  called when inflate() returns 0 and needsDictionary() returns true  indicating that a preset dictionary is required. The method getAdler()  can be used to get the Adler-32 value of the dictionary needed.

Parameters:

 b - the dictionary data bytes

 off - the start offset of the data

 len - the length of the data

See Also:

needsDictionary, getAdler

 setDictionary

  public void setDictionary(byte b[])

 Sets the preset dictionary to the given array of bytes. Should be  called when inflate() returns 0 and needsDictionary() returns true  indicating that a preset dictionary is required. The method getAdler()  can be used to get the Adler-32 value of the dictionary needed.

Parameters:

 b - the dictionary data bytes

See Also:

needsDictionary, getAdler

 getRemaining

  public synchronized int getRemaining()

 Returns the total number of bytes remaining in the input buffer.  This can be used to find out what bytes still remain in the input  buffer after decompression has finished.

 needsInput

  public synchronized boolean needsInput()

 Returns true if no data remains in the input buffer. This can  be used to determine if #setInput should be called in order  to provide more input.

 needsDictionary

  public synchronized boolean needsDictionary()

 Returns true if a preset dictionary is needed for decompression.

See Also:

 InflatesetDictionary

 finished

  public synchronized boolean finished()

 Return true if the end of the compressed data stream has been  reached.

 inflate

  public synchronized int inflate(byte b[],
                                  int off,
                                  int len) throws DataFormatException

 Uncompresses bytes into specified buffer. Returns actual number  of bytes uncompressed. A return value of 0 indicates that  needsInput() or needsDictionary() should be called in order to  determine if more input data or a preset dictionary is required.  In the later case, getAdler() can be used to get the Adler-32  value of the dictionary required.

Parameters:

 b - the buffer for the uncompressed data

 off - the start offset of the data

 len - the maximum number of uncompressed bytes

Returns:

 the actual number of uncompressed bytes

Throws: DataFormatException

 if the compressed data format is invalid

See Also:

needsInput, needsDictionary

 inflate

  public int inflate(byte b[]) throws DataFormatException

 Uncompresses bytes into specified buffer. Returns actual number  of bytes uncompressed. A return value of 0 indicates that  needsInput() or needsDictionary() should be called in order to  determine if more input data or a preset dictionary is required.  In the later case, getAdler() can be used to get the Adler-32  value of the dictionary required.

Parameters:

 b - the buffer for the uncompressed data

Returns:

 the actual number of uncompressed bytes

Throws: DataFormatException

 if the compressed data format is invalid

See Also:

needsInput, needsDictionary

 getAdler

  public synchronized int getAdler()

 Returns the ADLER-32 value of the uncompressed data.

 getTotalIn

  public synchronized int getTotalIn()

 Returns the total number of bytes input so far.

 getTotalOut

  public synchronized int getTotalOut()

 Returns the total number of bytes output so far.

 reset

  public synchronized void reset()

 Resets inflater so that a new set of input data can be processed.

 end

  public synchronized void end()

 Discards unprocessed input and frees internal data.

 finalize

  protected void finalize()

 Frees the decompressor when garbage is collected.

Overrides:

finalize in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.zip.InflaterInputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.zip.InflaterInputStream

java.lang.Object
   |
   +----java.io.InputStream
           |
           +----java.io.FilterInputStream
                   |
                   +----java.util.zip.InflaterInputStream

______________________________________________________________________________

 public class InflaterInputStream

 extends FilterInputStream

This class implements a stream filter for uncompressing data in the  "deflate" compression format. It is also used as the basis for other  decompression filters, such as GZIPInputStream.

See Also:

Inflater

______________________________________________________________________________

 	buf

 Input buffer for decompression.

 	inf

 Decompressor for this stream.

 	len

 Length of input buffer.

 	InflaterInputStream(InputStream)

 Creates a new input stream with a default decompressor and buffer size.

 	InflaterInputStream(InputStream, Inflater)

 Creates a new input stream with the specified decompressor and a  default buffer size.

 	InflaterInputStream(InputStream, Inflater, int)

 Creates a new input stream with the specified decompressor and  buffer size.

 	fill()

 Fills input buffer with more data to decompress.

 	read()

 Reads a byte of uncompressed data.

 	read(byte[], int, int)

 Reads uncompressed data into an array of bytes.

 	skip(long)

 Skips specified number of bytes of uncompressed data.

 inf

  protected Inflater inf

 Decompressor for this stream.

 buf

  protected byte buf[]

 Input buffer for decompression.

 len

  protected int len

 Length of input buffer.

 InflaterInputStream

  public InflaterInputStream(InputStream in,
                             Inflater inf,
                             int size)

 Creates a new input stream with the specified decompressor and  buffer size.

Parameters:

 in - the input stream

 inf - the decompressor ("inflater")

 len - the input buffer size

 InflaterInputStream

  public InflaterInputStream(InputStream in,
                             Inflater inf)

 Creates a new input stream with the specified decompressor and a  default buffer size.

Parameters:

 in - the input stream

 inf - the decompressor ("inflater")

 InflaterInputStream

  public InflaterInputStream(InputStream in)

 Creates a new input stream with a default decompressor and buffer size.

 read

  public int read() throws IOException

 Reads a byte of uncompressed data. This method will block until  enough input is available for decompression.

Returns:

 the byte read, or -1 if end of compressed input is reached

Throws: IOException

 if an I/O error has occurred

Overrides:

read in class FilterInputStream

 read

  public int read(byte b[],
                  int off,
                  int len) throws IOException

 Reads uncompressed data into an array of bytes. This method will  block until some input can be decompressed.

Parameters:

 b - the buffer into which the data is read

 off - the start offset of the data

 len - the maximum number of bytes read

Returns:

 the actual number of bytes read, or -1 if the end of the  compressed input is reached or a preset dictionary is needed

Throws: ZipException

 if a ZIP format error has occurred

Throws: IOException

 if an I/O error has occurred

Overrides:

read in class FilterInputStream

 skip

  public long skip(long n) throws IOException

 Skips specified number of bytes of uncompressed data.

Parameters:

 n - the number of bytes to skip

Returns:

 the actual number of bytes skipped.

Throws: IOException

 if an I/O error has occurred

Overrides:

skip in class FilterInputStream

 fill

  protected void fill() throws IOException

 Fills input buffer with more data to decompress.

Throws: IOException

 if an I/O error has occurred

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.zip.ZipEntry

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.zip.ZipEntry

java.lang.Object
   |
   +----java.util.zip.ZipEntry

______________________________________________________________________________

 public class ZipEntry

 extends Object

 implements ZipConstants

This class is used to represent a ZIP file entry.

______________________________________________________________________________

 	DEFLATED

 Compression method for compressed (deflated) entries.

 	STORED

 Compression method for uncompressed entries.

 	ZipEntry(String)

 Creates a new ZIP file entry with the specified name.

 	getComment()

 Returns the comment string for the entry, or null if none.

 	getCompressedSize()

 Returns the compressed size of the entry data, or -1 if not known.

 	getCrc()

 Returns the CRC-32 checksum of the uncompressed entry data, or -1 if  not known.

 	getExtra()

 Returns the extra field data for the entry, or null if none.

 	getMethod()

 Returns the compression method of the entry, or -1 if not specified.

 	getName()

 Returns the name of the entry.

 	getSize()

 Returns the uncompressed size of the entry data, or -1 if not known.

 	getTime()

 Returns the modification time of the entry, or -1 if not specified.

 	isDirectory()

 Returns true if this is a directory entry.

 	setComment(String)

 Sets the optional comment string for the entry.

 	setCrc(long)

 Sets the CRC-32 checksum of the uncompressed entry data.

 	setExtra(byte[])

 Sets the optional extra field data for the entry.

 	setMethod(int)

 Sets the compression method for the entry.

 	setSize(long)

 Sets the uncompressed size of the entry data.

 	setTime(long)

 Sets the modification time of the entry.

 	toString()

 Returns a string representation of the ZIP entry.

 STORED

  public final static int STORED

 Compression method for uncompressed entries.

 DEFLATED

  public final static int DEFLATED

 Compression method for compressed (deflated) entries.

 ZipEntry

  public ZipEntry(String name)

 Creates a new ZIP file entry with the specified name.

Parameters:

 name - the entry name

Throws: NullPointerException

 if the entry name is null

Throws: IllegalArgumentException

 if the entry name is longer than 	0xFFFF bytes

 getName

  public String getName()

 Returns the name of the entry.

 setTime

  public void setTime(long time)

 Sets the modification time of the entry.

Parameters:

 time - the entry modification time in number of milliseconds 	since the epoch

 getTime

  public long getTime()

 Returns the modification time of the entry, or -1 if not specified.

 setSize

  public void setSize(long size)

 Sets the uncompressed size of the entry data.

Parameters:

 size - the uncompressed size in bytes

Throws: IllegalArgumentException

 if the specified size is less 	than 0 or greater than 0xFFFFFFFF bytes

 getSize

  public long getSize()

 Returns the uncompressed size of the entry data, or -1 if not known.

 setCrc

  public void setCrc(long crc)

 Sets the CRC-32 checksum of the uncompressed entry data.

Parameters:

 crc - the CRC-32 value

Throws: IllegalArgumentException

 if the specified CRC-32 value is 	less than 0 or greater than 0xFFFFFFFF

 getCrc

  public long getCrc()

 Returns the CRC-32 checksum of the uncompressed entry data, or -1 if  not known.

 setMethod

  public void setMethod(int method)

 Sets the compression method for the entry.

Parameters:

 method - the compression method, either STORED or DEFLATED

Throws: IllegalArgumentException

 if the specified compression 	method is invalid

 getMethod

  public int getMethod()

 Returns the compression method of the entry, or -1 if not specified.

 setExtra

  public void setExtra(byte extra[])

 Sets the optional extra field data for the entry.

Parameters:

 extra - the extra field data bytes

Throws: IllegalArgumentException

 if the length of the specified 	extra field data is greater than 0xFFFFF bytes

 getExtra

  public byte[] getExtra()

 Returns the extra field data for the entry, or null if none.

 setComment

  public void setComment(String comment)

 Sets the optional comment string for the entry.

Parameters:

 comment - the comment string

Throws: IllegalArgumentException

 if the length of the specified 	comment string is greater than 0xFFFF bytes

 getComment

  public String getComment()

 Returns the comment string for the entry, or null if none.

 getCompressedSize

  public long getCompressedSize()

 Returns the compressed size of the entry data, or -1 if not known.  In the case of a stored entry, the compressed size will be the same  as the uncompressed size of the entry.

 isDirectory

  public boolean isDirectory()

 Returns true if this is a directory entry. A directory entry is  defined to be one whose name ends with a '/'.

 toString

  public String toString()

 Returns a string representation of the ZIP entry.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.zip.ZipException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.zip.ZipException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.io.IOException
                           |
                           +----java.util.zip.ZipException

______________________________________________________________________________

 public class ZipException

 extends IOException

______________________________________________________________________________

 	ZipException()

  	ZipException(String)

 ZipException

  public ZipException()

 ZipException

  public ZipException(String s)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.zip.ZipFile

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.zip.ZipFile

java.lang.Object
   |
   +----java.util.zip.ZipFile

______________________________________________________________________________

 public class ZipFile

 extends Object

 implements ZipConstants

This class can be used to read the contents of a ZIP file. It uses  RandomAccessFile for quick access to ZIP file entries, and supports  both compressed and uncompressed entries.

______________________________________________________________________________

 	ZipFile(File)

 Opens a ZIP file for reading given the specified File object.

 	ZipFile(String)

 Opens a ZIP file for reading given the specified file name.

 	close()

 Closes the ZIP file.

 	entries()

 Returns an enumeration of the ZIP file entries.

 	getEntry(String)

 Returns the ZIP file entry for the given path name.

 	getInputStream(ZipEntry)

 Returns an input stream for reading the contents of the specified  ZIP file entry.

 	getName()

 Returns the path name of the ZIP file.

 ZipFile

  public ZipFile(String name) throws IOException

 Opens a ZIP file for reading given the specified file name.

Parameters:

 name - the name of the zip file

Throws: ZipException

 if a ZIP format error has occurred

Throws: IOException

 if an I/O error has occurred

 ZipFile

  public ZipFile(File file) throws ZipException, IOException

 Opens a ZIP file for reading given the specified File object.

Parameters:

 file - the ZIP file to be opened for reading

Throws: ZipException

 if a ZIP error has occurred

Throws: IOException

 if an I/O error has occurred

 getEntry

  public ZipEntry getEntry(String name)

 Returns the ZIP file entry for the given path name. Returns null if  there is no entry corresponding to the given name.

Parameters:

 name - the name of the entry

Returns:

 the ZIP file entry

 getInputStream

  public InputStream getInputStream(ZipEntry ze) throws IOException

 Returns an input stream for reading the contents of the specified  ZIP file entry.

Parameters:

 ze - the zip file entry

Throws: ZipException

 if a ZIP format error has occurred

Throws: IOException

 if an I/O error has occurred

 getName

  public String getName()

 Returns the path name of the ZIP file.

 entries

  public Enumeration entries()

 Returns an enumeration of the ZIP file entries.

 close

  public void close() throws IOException

 Closes the ZIP file.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.zip.ZipInputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.zip.ZipInputStream

java.lang.Object
   |
   +----java.io.InputStream
           |
           +----java.io.FilterInputStream
                   |
                   +----java.util.zip.InflaterInputStream
                           |
                           +----java.util.zip.ZipInputStream

______________________________________________________________________________

 public class ZipInputStream

 extends InflaterInputStream

 implements ZipConstants

This class implements an input stream filter for reading files in the  ZIP file format. Includes support for both compressed and uncompressed  entries.

______________________________________________________________________________

 	ZipInputStream(InputStream)

 Creates a new ZIP input stream.

 	close()

 Closes the ZIP input stream.

 	closeEntry()

 Closes the current ZIP entry and positions the stream for reading the  next entry.

 	getNextEntry()

 Reads the next ZIP file entry and positions stream at the beginning  of the entry data.

 	read(byte[], int, int)

 Reads from the current ZIP entry into an array of bytes.

 	skip(long)

 Skips specified number of bytes in the current ZIP entry.

 ZipInputStream

  public ZipInputStream(InputStream in)

 Creates a new ZIP input stream.

Parameters:

 in - the actual input stream

 getNextEntry

  public ZipEntry getNextEntry() throws IOException

 Reads the next ZIP file entry and positions stream at the beginning  of the entry data.

Throws: ZipException

 if a ZIP file error has occurred

Throws: IOException

 if an I/O error has occurred

 closeEntry

  public void closeEntry() throws IOException

 Closes the current ZIP entry and positions the stream for reading the  next entry.

Throws: ZipException

 if a ZIP file error has occurred

Throws: IOException

 if an I/O error has occurred

 read

  public int read(byte b[],
                  int off,
                  int len) throws IOException

 Reads from the current ZIP entry into an array of bytes. Blocks until  some input is available.

Parameters:

 b - the buffer into which the data is read

 off - the start offset of the data

 len - the maximum number of bytes read

Returns:

 the actual number of bytes read, or -1 if the end of the  entry is reached

Throws: ZipException

 if a ZIP file error has occurred

Throws: IOException

 if an I/O error has occurred

Overrides:

read in class InflaterInputStream

 skip

  public long skip(long n) throws IOException

 Skips specified number of bytes in the current ZIP entry.

Parameters:

 n - the number of bytes to skip

Returns:

 the actual number of bytes skipped

Throws: ZipException

 if a ZIP file error has occurred

Throws: IOException

 if an I/O error has occurred

Overrides:

skip in class InflaterInputStream

 close

  public void close() throws IOException

 Closes the ZIP input stream.

Throws: IOException

 if an I/O error has occurred

Overrides:

close in class FilterInputStream

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class java.util.zip.ZipOutputStream

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class java.util.zip.ZipOutputStream

java.lang.Object
   |
   +----java.io.OutputStream
           |
           +----java.io.FilterOutputStream
                   |
                   +----java.util.zip.DeflaterOutputStream
                           |
                           +----java.util.zip.ZipOutputStream

______________________________________________________________________________

 public class ZipOutputStream

 extends DeflaterOutputStream

 implements ZipConstants

This class implements an output stream filter for writing files in the  ZIP file format. Includes support for both compressed and uncompressed  entries.

______________________________________________________________________________

 	DEFLATED

 Compression method for compressed (DEFLATED) entries.

 	STORED

 Compression method for uncompressed (STORED) entries.

 	ZipOutputStream(OutputStream)

 Creates a new ZIP output stream.

 	close()

 Closes the ZIP output stream as well as the stream being filtered.

 	closeEntry()

 Closes the current ZIP entry and positions the stream for writing  the next entry.

 	finish()

 Finishes writing the contents of the ZIP output stream without closing  the underlying stream.

 	putNextEntry(ZipEntry)

 Begins writing a new ZIP file entry and positions the stream to the  start of the entry data.

 	setComment(String)

 Sets the ZIP file comment.

 	setLevel(int)

 Sets the compression level for subsequent entries which are DEFLATED.

 	setMethod(int)

 Sets the default compression method for subsequent entries.

 	write(byte[], int, int)

 Writes an array of bytes to the current ZIP entry data.

 STORED

  public final static int STORED

 Compression method for uncompressed (STORED) entries.

 DEFLATED

  public final static int DEFLATED

 Compression method for compressed (DEFLATED) entries.

 ZipOutputStream

  public ZipOutputStream(OutputStream out)

 Creates a new ZIP output stream.

Parameters:

 out - the actual output stream

 setComment

  public void setComment(String comment)

 Sets the ZIP file comment.

Parameters:

 comment - the comment string

Throws: IllegalArgumentException

 if the length of the specified 	ZIP file comment is greater than 0xFFFF bytes

 setMethod

  public void setMethod(int method)

 Sets the default compression method for subsequent entries. This  default will be used whenever the compression method is not specified  for an individual ZIP file entry, and is initially set to DEFLATED.

Parameters:

 method - the default compression method

Throws: IllegalArgumentException

 if the specified compression method 	is invalid

 setLevel

  public void setLevel(int level)

 Sets the compression level for subsequent entries which are DEFLATED.  The default setting is DEFAULT_COMPRESSION.

Parameters:

 level - the compression level (0-9)

Throws: IllegalArgumentException

 if the compression level is invalid

 putNextEntry

  public void putNextEntry(ZipEntry e) throws IOException

 Begins writing a new ZIP file entry and positions the stream to the  start of the entry data. Closes the current entry if still active.  The default compression method will be used if no compression method  was specified for the entry, and the current time will be used if  the entry has no set modification time.

Parameters:

 e - the ZIP entry to be written

Throws: ZipException

 if a ZIP format error has occurred

Throws: IOException

 if an I/O error has occurred

 closeEntry

  public void closeEntry() throws IOException

 Closes the current ZIP entry and positions the stream for writing  the next entry.

Throws: ZipException

 if a ZIP format error has occurred

Throws: IOException

 if an I/O error has occurred

 write

  public synchronized void write(byte b[],
                                 int off,
                                 int len) throws IOException

 Writes an array of bytes to the current ZIP entry data. This method  will block until all the bytes are written.

Parameters:

 b - the data to be written

 off - the start offset in the data

 len - the number of bytes that are written

Throws: ZipException

 if a ZIP file error has occurred

Throws: IOException

 if an I/O error has occurred

Overrides:

write in class DeflaterOutputStream

 finish

  public void finish() throws IOException

 Finishes writing the contents of the ZIP output stream without closing  the underlying stream. Use this method when applying multiple filters  in succession to the same output stream.

Throws: ZipException

 if a ZIP file error has occurred

Throws: IOException

 if an I/O exception has occurred

Overrides:

finish in class DeflaterOutputStream

 close

  public void close() throws IOException

 Closes the ZIP output stream as well as the stream being filtered.

Throws: ZipException

 if a ZIP file error has occurred

Throws: IOException

 if an I/O error has occurred

Overrides:

close in class DeflaterOutputStream

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Package java.applet

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package java.applet

•  AppletContext

•  AppletStub

•  AudioClip

•  Applet

Generated using an evaluation version of HyperAct HTMheLp


  Package java.awt.datatransfer

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package java.awt.datatransfer

•  ClipboardOwner

•  Transferable

•  Clipboard

•  DataFlavor

•  StringSelection

•  UnsupportedFlavorException

Generated using an evaluation version of HyperAct HTMheLp


  Package java.awt.event

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package java.awt.event

•  ActionListener

•  AdjustmentListener

•  ComponentListener

•  ContainerListener

•  FocusListener

•  ItemListener

•  KeyListener

•  MouseListener

•  MouseMotionListener

•  TextListener

•  WindowListener

•  ActionEvent

•  AdjustmentEvent

•  ComponentAdapter

•  ComponentEvent

•  ContainerAdapter

•  ContainerEvent

•  FocusAdapter

•  FocusEvent

•  InputEvent

•  ItemEvent

•  KeyAdapter

•  KeyEvent

•  MouseAdapter

•  MouseEvent

•  MouseMotionAdapter

•  PaintEvent

•  TextEvent

•  WindowAdapter

•  WindowEvent

Generated using an evaluation version of HyperAct HTMheLp


  Package java.awt

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package java.awt

•  Adjustable

•  ItemSelectable

•  LayoutManager

•  LayoutManager2

•  MenuContainer

•  PrintGraphics

•  Shape

•  AWTEvent

•  AWTEventMulticaster

•  BorderLayout

•  Button

•  Canvas

•  CardLayout

•  Checkbox

•  CheckboxGroup

•  CheckboxMenuItem

•  Choice

•  Color

•  Component

•  Container

•  Cursor

•  Dialog

•  Dimension

•  Event

•  EventQueue

•  FileDialog

•  FlowLayout

•  Font

•  FontMetrics

•  Frame

•  Graphics

•  GridBagConstraints

•  GridBagLayout

•  GridLayout

•  Image

•  Insets

•  Label

•  List

•  MediaTracker

•  Menu

•  MenuBar

•  MenuComponent

•  MenuItem

•  MenuShortcut

•  Panel

•  Point

•  Polygon

•  PopupMenu

•  PrintJob

•  Rectangle

•  ScrollPane

•  Scrollbar

•  SystemColor

•  TextArea

•  TextComponent

•  TextField

•  Toolkit

•  Window

•  AWTException

•  IllegalComponentStateException

•  AWTError

Generated using an evaluation version of HyperAct HTMheLp


  Package java.awt.image

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package java.awt.image

•  ImageConsumer

•  ImageObserver

•  ImageProducer

•  AreaAveragingScaleFilter

•  ColorModel

•  CropImageFilter

•  DirectColorModel

•  FilteredImageSource

•  ImageFilter

•  IndexColorModel

•  MemoryImageSource

•  PixelGrabber

•  RGBImageFilter

•  ReplicateScaleFilter

Generated using an evaluation version of HyperAct HTMheLp


  Package java.awt.peer

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package java.awt.peer

•  ButtonPeer

•  CanvasPeer

•  CheckboxMenuItemPeer

•  CheckboxPeer

•  ChoicePeer

•  ComponentPeer

•  ContainerPeer

•  DialogPeer

•  FileDialogPeer

•  FontPeer

•  FramePeer

•  LabelPeer

•  LightweightPeer

•  ListPeer

•  MenuBarPeer

•  MenuComponentPeer

•  MenuItemPeer

•  MenuPeer

•  PanelPeer

•  PopupMenuPeer

•  ScrollPanePeer

•  ScrollbarPeer

•  TextAreaPeer

•  TextComponentPeer

•  TextFieldPeer

•  WindowPeer

Generated using an evaluation version of HyperAct HTMheLp


  Package java.beans

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package java.beans

•  BeanInfo

•  Customizer

•  PropertyChangeListener

•  PropertyEditor

•  VetoableChangeListener

•  Visibility

•  BeanDescriptor

•  Beans

•  EventSetDescriptor

•  FeatureDescriptor

•  IndexedPropertyDescriptor

•  Introspector

•  MethodDescriptor

•  ParameterDescriptor

•  PropertyChangeEvent

•  PropertyChangeSupport

•  PropertyDescriptor

•  PropertyEditorManager

•  PropertyEditorSupport

•  SimpleBeanInfo

•  VetoableChangeSupport

•  IntrospectionException

•  PropertyVetoException

Generated using an evaluation version of HyperAct HTMheLp


  Package java.io

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package java.io

•  DataInput

•  DataOutput

•  Externalizable

•  FilenameFilter

•  ObjectInput

•  ObjectInputValidation

•  ObjectOutput

•  Serializable

•  BufferedInputStream

•  BufferedOutputStream

•  BufferedReader

•  BufferedWriter

•  ByteArrayInputStream

•  ByteArrayOutputStream

•  CharArrayReader

•  CharArrayWriter

•  DataInputStream

•  DataOutputStream

•  File

•  FileDescriptor

•  FileInputStream

•  FileOutputStream

•  FileReader

•  FileWriter

•  FilterInputStream

•  FilterOutputStream

•  FilterReader

•  FilterWriter

•  InputStream

•  InputStreamReader

•  LineNumberInputStream

•  LineNumberReader

•  ObjectInputStream

•  ObjectOutputStream

•  ObjectStreamClass

•  OutputStream

•  OutputStreamWriter

•  PipedInputStream

•  PipedOutputStream

•  PipedReader

•  PipedWriter

•  PrintStream

•  PrintWriter

•  PushbackInputStream

•  PushbackReader

•  RandomAccessFile

•  Reader

•  SequenceInputStream

•  StreamTokenizer

•  StringBufferInputStream

•  StringReader

•  StringWriter

•  Writer

•  CharConversionException

•  EOFException

•  FileNotFoundException

•  IOException

•  InterruptedIOException

•  InvalidClassException

•  InvalidObjectException

•  NotActiveException

•  NotSerializableException

•  ObjectStreamException

•  OptionalDataException

•  StreamCorruptedException

•  SyncFailedException

•  UTFDataFormatException

•  UnsupportedEncodingException

•  WriteAbortedException

Generated using an evaluation version of HyperAct HTMheLp


  Package java.lang

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package java.lang

•  Cloneable

•  Runnable

•  Boolean

•  Byte

•  Character

•  Class

•  ClassLoader

•  Compiler

•  Double

•  Float

•  Integer

•  Long

•  Math

•  Number

•  Object

•  Process

•  Runtime

•  SecurityManager

•  Short

•  String

•  StringBuffer

•  System

•  Thread

•  ThreadGroup

•  Throwable

•  Void

•  ArithmeticException

•  ArrayIndexOutOfBoundsException

•  ArrayStoreException

•  ClassCastException

•  ClassNotFoundException

•  CloneNotSupportedException

•  Exception

•  IllegalAccessException

•  IllegalArgumentException

•  IllegalMonitorStateException

•  IllegalStateException

•  IllegalThreadStateException

•  IndexOutOfBoundsException

•  InstantiationException

•  InterruptedException

•  NegativeArraySizeException

•  NoSuchFieldException

•  NoSuchMethodException

•  NullPointerException

•  NumberFormatException

•  RuntimeException

•  SecurityException

•  StringIndexOutOfBoundsException

•  AbstractMethodError

•  ClassCircularityError

•  ClassFormatError

•  Error

•  ExceptionInInitializerError

•  IllegalAccessError

•  IncompatibleClassChangeError

•  InstantiationError

•  InternalError

•  LinkageError

•  NoClassDefFoundError

•  NoSuchFieldError

•  NoSuchMethodError

•  OutOfMemoryError

•  StackOverflowError

•  ThreadDeath

•  UnknownError

•  UnsatisfiedLinkError

•  VerifyError

•  VirtualMachineError

Generated using an evaluation version of HyperAct HTMheLp


  Package java.lang.reflect

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package java.lang.reflect

•  Member

•  Array

•  Constructor

•  Field

•  Method

•  Modifier

•  InvocationTargetException

Generated using an evaluation version of HyperAct HTMheLp


  Package java.math

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package java.math

•  BigDecimal

•  BigInteger

Generated using an evaluation version of HyperAct HTMheLp


  Package java.net

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package java.net

•  ContentHandlerFactory

•  FileNameMap

•  SocketImplFactory

•  URLStreamHandlerFactory

•  ContentHandler

•  DatagramPacket

•  DatagramSocket

•  DatagramSocketImpl

•  HttpURLConnection

•  InetAddress

•  MulticastSocket

•  ServerSocket

•  Socket

•  SocketImpl

•  URL

•  URLConnection

•  URLEncoder

•  URLStreamHandler

•  BindException

•  ConnectException

•  MalformedURLException

•  NoRouteToHostException

•  ProtocolException

•  SocketException

•  UnknownHostException

•  UnknownServiceException

Generated using an evaluation version of HyperAct HTMheLp


  Package java.rmi.dgc

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package java.rmi.dgc

•  DGC

•  Lease

•  VMID

Generated using an evaluation version of HyperAct HTMheLp


  Package java.rmi

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package java.rmi

•  Remote

•  Naming

•  RMISecurityManager

•  AccessException

•  AlreadyBoundException

•  ConnectException

•  ConnectIOException

•  MarshalException

•  NoSuchObjectException

•  NotBoundException

•  RMISecurityException

•  RemoteException

•  ServerError

•  ServerException

•  ServerRuntimeException

•  StubNotFoundException

•  UnexpectedException

•  UnknownHostException

•  UnmarshalException

Generated using an evaluation version of HyperAct HTMheLp


  Package java.rmi.registry

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package java.rmi.registry

•  Registry

•  RegistryHandler

•  LocateRegistry

Generated using an evaluation version of HyperAct HTMheLp


  Package java.rmi.server

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package java.rmi.server

•  LoaderHandler

•  RMIFailureHandler

•  RemoteCall

•  RemoteRef

•  ServerRef

•  Skeleton

•  Unreferenced

•  LogStream

•  ObjID

•  Operation

•  RMIClassLoader

•  RMISocketFactory

•  RemoteObject

•  RemoteServer

•  RemoteStub

•  UID

•  UnicastRemoteObject

•  ExportException

•  ServerCloneException

•  ServerNotActiveException

•  SkeletonMismatchException

•  SkeletonNotFoundException

•  SocketSecurityException

Generated using an evaluation version of HyperAct HTMheLp


  Package java.security.acl

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package java.security.acl

•  Acl

•  AclEntry

•  Group

•  Owner

•  Permission

•  AclNotFoundException

•  LastOwnerException

•  NotOwnerException

Generated using an evaluation version of HyperAct HTMheLp


  Package java.security

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package java.security

•  Certificate

•  Key

•  Principal

•  PrivateKey

•  PublicKey

•  DigestInputStream

•  DigestOutputStream

•  Identity

•  IdentityScope

•  KeyPair

•  KeyPairGenerator

•  MessageDigest

•  Provider

•  SecureRandom

•  Security

•  Signature

•  Signer

•  DigestException

•  InvalidKeyException

•  InvalidParameterException

•  KeyException

•  KeyManagementException

•  NoSuchAlgorithmException

•  NoSuchProviderException

•  ProviderException

•  SignatureException

Generated using an evaluation version of HyperAct HTMheLp


  Package java.security.interfaces

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package java.security.interfaces

•  DSAKey

•  DSAKeyPairGenerator

•  DSAParams

•  DSAPrivateKey

•  DSAPublicKey

Generated using an evaluation version of HyperAct HTMheLp


  Package java.sql

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package java.sql

•  CallableStatement

•  Connection

•  DatabaseMetaData

•  Driver

•  PreparedStatement

•  ResultSet

•  ResultSetMetaData

•  Statement

•  Date

•  DriverManager

•  DriverPropertyInfo

•  Time

•  Timestamp

•  Types

•  DataTruncation

•  SQLException

•  SQLWarning

Generated using an evaluation version of HyperAct HTMheLp


  Package java.text

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package java.text

•  CharacterIterator

•  BreakIterator

•  ChoiceFormat

•  CollationElementIterator

•  CollationKey

•  Collator

•  DateFormat

•  DateFormatSymbols

•  DecimalFormat

•  DecimalFormatSymbols

•  FieldPosition

•  Format

•  MessageFormat

•  NumberFormat

•  ParsePosition

•  RuleBasedCollator

•  SimpleDateFormat

•  StringCharacterIterator

•  FormatException

•  ParseException

Generated using an evaluation version of HyperAct HTMheLp


  Package java.util

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package java.util

•  Enumeration

•  EventListener

•  Observer

•  BitSet

•  Calendar

•  Date

•  Dictionary

•  EventObject

•  GregorianCalendar

•  Hashtable

•  ListResourceBundle

•  Locale

•  Observable

•  Properties

•  PropertyResourceBundle

•  Random

•  ResourceBundle

•  SimpleTimeZone

•  Stack

•  StringTokenizer

•  TimeZone

•  Vector

•  EmptyStackException

•  MissingResourceException

•  NoSuchElementException

•  TooManyListenersException

Generated using an evaluation version of HyperAct HTMheLp


  Package java.util.zip

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package java.util.zip

•  Checksum

•  Adler32

•  CRC32

•  CheckedInputStream

•  CheckedOutputStream

•  Deflater

•  DeflaterOutputStream

•  GZIPInputStream

•  GZIPOutputStream

•  Inflater

•  InflaterInputStream

•  ZipEntry

•  ZipFile

•  ZipInputStream

•  ZipOutputStream

•  DataFormatException

•  ZipException

Generated using an evaluation version of HyperAct HTMheLp


  Java Platform API

API User's Guide  Class Hierarchy  Index
______________________________________________________________________________

JavaTM Platform API 1.1

 Java API Packages

•  package java.applet

•  package java.awt

•  package java.awt.datatransfer

•  package java.awt.event

•  package java.awt.image

•  package java.awt.peer

•  package java.beans

•  package java.io

•  package java.lang

•  package java.lang.reflect

•  package java.math

•  package java.net

•  package java.rmi

•  package java.rmi.dgc

•  package java.rmi.registry

•  package java.rmi.server

•  package java.security

•  package java.security.acl

•  package java.security.interfaces

•  package java.sql

•  package java.text

•  package java.util

•  package java.util.zip

 Other Packages

•  package sun.tools.debug

•  package sunw.io

•  package sunw.util

Copyright 1996, 1997 Sun Microsystems, Inc.

Generated using an evaluation version of HyperAct HTMheLp


  Package sun.tools.debug

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package sun.tools.debug

•  DebuggerCallback

•  RemoteArray

•  RemoteBoolean

•  RemoteByte

•  RemoteChar

•  RemoteClass

•  RemoteDebugger

•  RemoteDouble

•  RemoteField

•  RemoteFloat

•  RemoteInt

•  RemoteLong

•  RemoteObject

•  RemoteShort

•  RemoteStackFrame

•  RemoteStackVariable

•  RemoteString

•  RemoteThread

•  RemoteThreadGroup

•  RemoteValue

•  StackFrame

•  NoSessionException

•  NoSuchLineNumberException

Generated using an evaluation version of HyperAct HTMheLp


  Package sunw.io

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package sunw.io

•  Serializable

Generated using an evaluation version of HyperAct HTMheLp


  Package sunw.util

All Packages  Class Hierarchy  Index
______________________________________________________________________________

  package sunw.util

•  EventListener

•  EventObject

Generated using an evaluation version of HyperAct HTMheLp


  Interface sun.tools.debug.DebuggerCallback

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Interface sun.tools.debug.DebuggerCallback

 public interface DebuggerCallback

The DebuggerCallback interface is used to communicate asynchronous  information from the debugger to its client. This may be the actual  client object, or a delegate of its choosing.

______________________________________________________________________________

 	breakpointEvent(RemoteThread)

 A breakpoint has been hit in the specified thread.

 	exceptionEvent(RemoteThread, String)

 An exception has occurred.

 	printToConsole(String)

 Print text to the debugger's console window.

 	quitEvent()

 The client interpreter has exited, either by returning from its  main thread, or by calling System.exit().

 	threadDeathEvent(RemoteThread)

 A thread has died.

 printToConsole

  public abstract void printToConsole(String text) throws Exception

 Print text to the debugger's console window.

Throws: Exception

 if a general exception occurs.

 breakpointEvent

  public abstract void breakpointEvent(RemoteThread t) throws Exception

 A breakpoint has been hit in the specified thread.

Throws: Exception

 if a general exception occurs.

 exceptionEvent

  public abstract void exceptionEvent(RemoteThread t,
                                      String errorText) throws Exception

 An exception has occurred.

Throws: Exception

 if a general exception occurs.

 threadDeathEvent

  public abstract void threadDeathEvent(RemoteThread t) throws Exception

 A thread has died.

Throws: Exception

 if a general exception occurs.

 quitEvent

  public abstract void quitEvent() throws Exception

 The client interpreter has exited, either by returning from its  main thread, or by calling System.exit().

Throws: Exception

 if a general exception occurs.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.tools.debug.NoSessionException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class sun.tools.debug.NoSessionException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----sun.tools.debug.NoSessionException

______________________________________________________________________________

 public class NoSessionException

 extends Exception

Signals that the remote session is closed.

______________________________________________________________________________

 	NoSessionException()

 Constructor.

 	NoSessionException(String)

 Constructor with a detail message.

 NoSessionException

  public NoSessionException()

 Constructor.

 NoSessionException

  public NoSessionException(String s)

 Constructor with a detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.tools.debug.NoSuchLineNumberException

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class sun.tools.debug.NoSuchLineNumberException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----sun.tools.debug.NoSuchLineNumberException

______________________________________________________________________________

 public class NoSuchLineNumberException

 extends Exception

Signals that no code is associated with a specified line number in a  Java source file.

______________________________________________________________________________

 	NoSuchLineNumberException()

 Constructor.

 	NoSuchLineNumberException(String)

 Constructor with a detail message.

 NoSuchLineNumberException

  public NoSuchLineNumberException()

 Constructor.

 NoSuchLineNumberException

  public NoSuchLineNumberException(String s)

 Constructor with a detail message.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.tools.debug.RemoteArray

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class sun.tools.debug.RemoteArray

java.lang.Object
   |
   +----sun.tools.debug.RemoteValue
           |
           +----sun.tools.debug.RemoteObject
                   |
                   +----sun.tools.debug.RemoteArray

______________________________________________________________________________

 public class RemoteArray

 extends RemoteObject

The RemoteArray class allows remote debugging of arrays.

See Also:

RemoteValue, RemoteDebugger

______________________________________________________________________________

 	arrayTypeName(int)

 Return the element type as a string.

 	description()

 Return a description of the array.

 	getElement(int)

 Return an array element.

 	getElements()

 Returns a copy of the array as instances of RemoteValue.

 	getElements(int, int)

 Returns a copy of a portion of the array as instances of RemoteValue.

 	getElementType()

 Return the element type as a "TC_" constant, such as "TC_CHAR".

 	getSize()

 Return the number of elements in the array.

 	toString()

 Return a string version of the array.

 	typeName()

 Return this RemoteValue's type ("array").

 getSize

  public final int getSize()

 Return the number of elements in the array.

 typeName

  public String typeName()

 Return this RemoteValue's type ("array").

Overrides:

typeName in class RemoteObject

 arrayTypeName

  public String arrayTypeName(int type)

 Return the element type as a string.

 getElementType

  public final int getElementType() throws Exception

 Return the element type as a "TC_" constant, such as "TC_CHAR".

Throws: Exception

 if a general exception occurs.

 getElement

  public final RemoteValue getElement(int index) throws Exception

 Return an array element.

Parameters:

 index - the index of the element

Returns:

 the element as a RemoteValue

Throws: ArrayIndexOutOfBoundsException

 when the index is greater than the size of the array

Throws: Exception

 if a general exception occurs.

 getElements

  public final RemoteValue[] getElements() throws Exception

 Returns a copy of the array as instances of RemoteValue.

Throws: Exception

 if a general exception occurs.

 getElements

  public final RemoteValue[] getElements(int beginIndex,
                                         int endIndex) throws Exception

 Returns a copy of a portion of the array as instances of RemoteValue.

Parameters:

 beginIndex - the beginning array index

 endIndex - the final array index

Throws: ArrayIndexOutOfBoundsException

 when the index is greater than the size of the array

Throws: Exception

 if a general exception occurs.

 description

  public String description()

 Return a description of the array.

Overrides:

description in class RemoteObject

 toString

  public String toString()

 Return a string version of the array.

Overrides:

toString in class RemoteObject

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.tools.debug.RemoteBoolean

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class sun.tools.debug.RemoteBoolean

java.lang.Object
   |
   +----sun.tools.debug.RemoteValue
           |
           +----sun.tools.debug.RemoteBoolean

______________________________________________________________________________

 public class RemoteBoolean

 extends RemoteValue

The RemoteBoolean class extends RemoteValue for booleans.

See Also:

RemoteValue, RemoteDebugger

______________________________________________________________________________

 	get()

 Return the boolean's value.

 	toString()

 Return the boolean's value as a string.

 	typeName()

 Print this RemoteValue's type ("boolean").

 get

  public boolean get()

 Return the boolean's value.

 typeName

  public String typeName()

 Print this RemoteValue's type ("boolean").

Overrides:

typeName in class RemoteValue

 toString

  public String toString()

 Return the boolean's value as a string.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.tools.debug.RemoteByte

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class sun.tools.debug.RemoteByte

java.lang.Object
   |
   +----sun.tools.debug.RemoteValue
           |
           +----sun.tools.debug.RemoteByte

______________________________________________________________________________

 public class RemoteByte

 extends RemoteValue

The RemoteByte class extends RemoteValue for bytes.

See Also:

RemoteValue, RemoteDebugger

______________________________________________________________________________

 	get()

 Return the byte's value.

 	toString()

 Return the byte's value as a string.

 	typeName()

 Print this RemoteValue's type ("byte").

 get

  public byte get()

 Return the byte's value.

 typeName

  public String typeName()

 Print this RemoteValue's type ("byte").

Overrides:

typeName in class RemoteValue

 toString

  public String toString()

 Return the byte's value as a string.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.tools.debug.RemoteChar

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class sun.tools.debug.RemoteChar

java.lang.Object
   |
   +----sun.tools.debug.RemoteValue
           |
           +----sun.tools.debug.RemoteChar

______________________________________________________________________________

 public class RemoteChar

 extends RemoteValue

The RemoteChar class extends RemoteValue for chars.

See Also:

RemoteValue, RemoteDebugger

______________________________________________________________________________

 	get()

 Return the char's value.

 	toString()

 Return the char's value as a string.

 	typeName()

 Print this RemoteValue's type ("char").

 get

  public char get()

 Return the char's value.

 typeName

  public String typeName()

 Print this RemoteValue's type ("char").

Overrides:

typeName in class RemoteValue

 toString

  public String toString()

 Return the char's value as a string.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.tools.debug.RemoteClass

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class sun.tools.debug.RemoteClass

java.lang.Object
   |
   +----sun.tools.debug.RemoteValue
           |
           +----sun.tools.debug.RemoteObject
                   |
                   +----sun.tools.debug.RemoteClass

______________________________________________________________________________

 public class RemoteClass

 extends RemoteObject

The RemoteClass class allows access to a class in a remote Java  interpreter.

See Also:

RemoteDebugger

______________________________________________________________________________

 	catchExceptions()

 Enter the debugger when an instance of this class is thrown.

 	clearBreakpoint(int)

 Clear a breakpoint at a specific address in a class.

 	clearBreakpointLine(int)

 Clear a breakpoint at a specified line.

 	clearBreakpointMethod(RemoteField)

 Clear a breakpoint at the start of a specified method.

 	description()

 Return a (somewhat verbose) description.

 	getClassLoader()

 Return the classloader for this class.

 	getField(int)

 Return the static field, specified by index.

 	getField(String)

 Return the static field, specified by name.

 	getFields()

 Return all the static fields for this class.

 	getFieldValue(int)

 Return the value of a static field, specified by its index.

 	getFieldValue(String)

 Return the value of a static field, specified by name.

 	getInstanceField(int)

 Return the instance field, specified by its index.

 	getInstanceFields()

 Return all the instance fields for this class.

 	getInterfaces()

 Return the interfaces for this class.

 	getLineNumbers()

 Return an array of all the class's source file line numbers which  have code associated with them.

 	getMethod(String)

 Return the method, specified by name.

 	getMethodLineNumber(int)

 Return the first line number of the specified method, or throws  NoSuchLineNumber exception.

 	getMethodLineNumber(String)

 Return the first line number of the specified method, or throws  NoSuchLineNumber exception.

 	getMethodNames()

 Return the names of all methods supported by this class.

 	getMethods()

 Return the class's methods.

 	getName()

 Returns the name of the class.

 	getSourceFile()

 Get the source file referenced by this stackframe.

 	getSourceFileName()

 Get the name of the source file referenced by this stackframe.

 	getStaticFields()

 Return all the static fields for this class.

 	getSuperclass()

 Return the superclass for this class.

 	ignoreExceptions()

 Don't enter the debugger when an instance of this class is thrown.

 	isInterface()

 Is this RemoteClass an interface?

 	setBreakpointLine(int)

 Set a breakpoint at a specified source line number in a class.

 	setBreakpointMethod(RemoteField)

 Set a breakpoint at the first line of a class method.

 	toString()

 Return a (somewhat verbose) description.

 	typeName()

 Returns the name of the class as its type.

 getName

  public String getName() throws Exception

 Returns the name of the class.

Throws: Exception

 if a general exception occurs.

 typeName

  public String typeName() throws Exception

 Returns the name of the class as its type.

Throws: Exception

 if a general exception occurs.

Overrides:

typeName in class RemoteObject

 isInterface

  public boolean isInterface() throws Exception

 Is this RemoteClass an interface?

Throws: Exception

 if a general exception occurs.

 getSuperclass

  public RemoteClass getSuperclass() throws Exception

 Return the superclass for this class.

Throws: Exception

 if a general exception occurs.

 getClassLoader

  public RemoteObject getClassLoader() throws Exception

 Return the classloader for this class.

Throws: Exception

 if a general exception occurs.

 getInterfaces

  public RemoteClass[] getInterfaces() throws Exception

 Return the interfaces for this class.

Throws: Exception

 if a general exception occurs.

 getSourceFileName

  public String getSourceFileName() throws Exception

 Get the name of the source file referenced by this stackframe.

Throws: Exception

 if a general exception occurs.

 getSourceFile

  public InputStream getSourceFile() throws Exception

 Get the source file referenced by this stackframe.

Throws: Exception

 if a general exception occurs.

 getFields

  public RemoteField[] getFields() throws Exception

 Return all the static fields for this class.

Throws: Exception

 if a general exception occurs.

Overrides:

getFields in class RemoteObject

 getStaticFields

  public RemoteField[] getStaticFields() throws Exception

 Return all the static fields for this class.

Throws: Exception

 if a general exception occurs.

 getInstanceFields

  public RemoteField[] getInstanceFields() throws Exception

 Return all the instance fields for this class.  Note: because this is a RemoteClass method, only the name and  type methods will be valid, not the data.

Throws: Exception

 if a general exception occurs.

 getField

  public RemoteField getField(int n) throws Exception

 Return the static field, specified by index.

Throws: ArrayIndexOutOfBoundsException

 when the index is greater than the number of instance variables

Throws: Exception

 if a general exception occurs.

Overrides:

getField in class RemoteObject

 getField

  public RemoteField getField(String name) throws NoSuchFieldException , Exception

 Return the static field, specified by name.

Throws: Exception

 if a general exception occurs.

Throws: NoSuchFieldException

 if a field with the specified  name is not found.

Overrides:

getField in class RemoteObject

 getInstanceField

  public RemoteField getInstanceField(int n) throws Exception

 Return the instance field, specified by its index.  Note: because this is a RemoteClass method, only the name and  type information is valid, not the data.

Throws: ArrayIndexOutOfBoundsException

 when the index is greater than the number of instance variables

Throws: Exception

 if a general exception occurs.

 getFieldValue

  public RemoteValue getFieldValue(int n) throws Exception

 Return the value of a static field, specified by its index.

Throws: Exception

 if a general exception occurs.

Overrides:

getFieldValue in class RemoteObject

 getFieldValue

  public RemoteValue getFieldValue(String name) throws NoSuchFieldException , Exception

 Return the value of a static field, specified by name.

Throws: Exception

 if a general exception occurs.

Throws: NoSuchFieldException

 if a field with the specified  name is not found.

Overrides:

getFieldValue in class RemoteObject

 getMethod

  public RemoteField getMethod(String name) throws NoSuchMethodException , Exception

 Return the method, specified by name.

Throws: Exception

 if a general exception occurs.

Throws: NoSuchMethodException

 if a matching method is  not found.

 getMethods

  public RemoteField[] getMethods() throws Exception

 Return the class's methods.

Throws: Exception

 if a general exception occurs.

 getMethodNames

  public String[] getMethodNames() throws Exception

 Return the names of all methods supported by this class.

Throws: Exception

 if a general exception occurs.

 getMethodLineNumber

  public int getMethodLineNumber(String name) throws NoSuchMethodException, NoSuchLineNumberException, Exception

 Return the first line number of the specified method, or throws  NoSuchLineNumber exception.

Parameters:

 name - the name of the method

Returns:

 the method's beginning line number

Throws: Exception

 if a general exception occurs.

Throws: NoSuchLineNumberException

 if no code is associated with the  specified line number in a Java source file.

Throws: NoSuchMethodException

 if a matching method is  not found.

 getMethodLineNumber

  public int getMethodLineNumber(int index) throws IndexOutOfBoundsException, NoSuchLineNumberException, Exception

 Return the first line number of the specified method, or throws  NoSuchLineNumber exception.

Parameters:

 index - the index of the method, as found in the array  returned from getMethods().

Returns:

 the method's beginning line number

Throws: Exception

 if a general exception occurs.

Throws: NoSuchLineNumberException

 if no code is associated with the  specified line number in a Java source file.

 setBreakpointLine

  public String setBreakpointLine(int lineno) throws Exception

 Set a breakpoint at a specified source line number in a class.

Parameters:

 lineno - the line number where the breakpoint is set

Returns:

 an empty string if successful, otherwise a description of the error.

Throws: Exception

 if a general exception occurs.

 setBreakpointMethod

  public String setBreakpointMethod(RemoteField method) throws Exception

 Set a breakpoint at the first line of a class method.

Parameters:

 method - the method where the breakpoint is set

Returns:

 an empty string if successful, otherwise a description of the error.

Throws: Exception

 if a general exception occurs.

 clearBreakpoint

  public String clearBreakpoint(int pc) throws Exception

 Clear a breakpoint at a specific address in a class.

Parameters:

 pc - the address of the breakpoint to be cleared

Returns:

 an empty string if successful, otherwise a description of the error.

Throws: Exception

 if a general exception occurs.

 clearBreakpointLine

  public String clearBreakpointLine(int lineno) throws Exception

 Clear a breakpoint at a specified line.

Parameters:

 lineno - the line number of the breakpoint to be cleared

Returns:

 an empty string if successful, otherwise a description of the error.

Throws: Exception

 if a general exception occurs.

 clearBreakpointMethod

  public String clearBreakpointMethod(RemoteField method) throws Exception

 Clear a breakpoint at the start of a specified method.

Parameters:

 method - the method of the breakpoint to be cleared

Returns:

 an empty string if successful, otherwise a description of the error.

Throws: Exception

 if a general exception occurs.

 catchExceptions

  public void catchExceptions() throws Exception

 Enter the debugger when an instance of this class is thrown.

Throws: ClassCastException

 when this class isn't an exception class

Throws: Exception

 if a general exception occurs.

 ignoreExceptions

  public void ignoreExceptions() throws Exception

 Don't enter the debugger when an instance of this class is thrown.

Throws: ClassCastException

 when this class isn't an exception class

Throws: Exception

 if a general exception occurs.

 getLineNumbers

  public int[] getLineNumbers() throws Exception

 Return an array of all the class's source file line numbers which  have code associated with them. This array may be zero-length, as  the class may not have been compiled with line number information.

Returns:

 an array of integers of valid line numbers.

Throws: Exception

 if a general exception occurs.

 description

  public String description()

 Return a (somewhat verbose) description.

Overrides:

description in class RemoteObject

 toString

  public String toString()

 Return a (somewhat verbose) description.

Overrides:

toString in class RemoteObject

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.tools.debug.RemoteDebugger

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class sun.tools.debug.RemoteDebugger

java.lang.Object
   |
   +----sun.tools.debug.RemoteDebugger

______________________________________________________________________________

 public class RemoteDebugger

 extends Object

The RemoteDebugger class defines a client interface to the Java debugging  classes. It is used to instantiate a connection with the Java interpreter  being debugged.

______________________________________________________________________________

 	RemoteDebugger(String, DebuggerCallback, boolean)

 Create a remote debugger.

  	RemoteDebugger (String, String, DebuggerCallback, boolean)

 Create a remote debugger, connecting it with a running Java  interpreter.

To connect to a running interpreter, it must be  started with the "-debug" option, whereupon it will print out  the password for that debugging session.

 	addSystemThread()

 Add the calling thread to the list of threads which aren't  suspended by the RemoteDebugger.

 	addSystemThread(Thread)

 Add the specified thread to the list of threads which aren't  suspended by the RemoteDebugger.

 	close()

 Close the connection to the remote debugging agent.

 	findClass(String)

 Find a specified class.

 	freeMemory()

 Report the free memory available to the Java interpreter being debugged.

 	gc(RemoteObject[])

 Free all objects referenced by the debugger.

 	get(Integer)

 Get an object from the remote object cache.

 	getExceptionCatchList()

 Return the list of the exceptions the debugger will stop on.

 	getSourcePath()

 Return the source file path the Agent is currently using.

 	itrace(boolean)

 Turn on/off instruction tracing.

 	listBreakpoints()

 Return a list of the breakpoints which are currently set.

 	listClasses()

 List the currently known classes.

 	listThreadGroups(RemoteThreadGroup)

 List threadgroups

 	run(int, String[])

 Load and run a runnable Java class, with any optional parameters.

 	setSourcePath(String)

 Specify the list of paths to use when searching for a source file.

 	totalMemory()

 Report the total memory usage of the Java interpreter being debugged.

 	trace(boolean)

 Turn on/off method call tracing.

 RemoteDebugger

  public RemoteDebugger(String host,
                        String password,
                        DebuggerCallback client,
                        boolean verbose) throws Exception

 Create a remote debugger, connecting it with a running Java  interpreter.

To connect to a running interpreter, it must be  started with the "-debug" option, whereupon it will print out  the password for that debugging session.

Parameters:

 host - the name of the system where a debuggable Java instance is running (default is localhost).

  password - the password reported by the debuggable Java instance. This should be null when starting a client interpreter.

  client - the object to which notification messages are sent (it must support the DebuggerCallback interface)

 verbose - turn on internal debugger message text

Throws: Exception

 if a general exception occurs.

 RemoteDebugger

  public RemoteDebugger(String javaArgs,
                        DebuggerCallback client,
                        boolean verbose) throws Exception

 Create a remote debugger.

Parameters:

 javaArgs - optional java command-line parameters, such as -classpath

  client - the object to which notification messages are sent (it must support the DebuggerCallback interface)

 verbose - turn on internal debugger message text

Throws: Exception

 if a general exception occurs.

 close

  public void close()

 Close the connection to the remote debugging agent.

 get

  public RemoteObject get(Integer id)

 Get an object from the remote object cache.

Parameters:

 id - the remote object's id

Returns:

 the specified RemoteObject, or null if not cached.

 listClasses

  public RemoteClass[] listClasses() throws Exception

 List the currently known classes.

Throws: Exception

 if a general exception occurs.

 findClass

  public RemoteClass findClass(String name) throws Exception

 Find a specified class. If the class isn't already known by the  remote debugger, the lookup request will be passed to the Java  interpreter being debugged.  NOTE: Substrings, such as "String" for "java.lang.String" will  return with the first match, and will not be successfully found  if the request is passed to the remote interpreter.

Parameters:

 name - the name (or a substring of the name)of the class

Returns:

 the specified (Remote)Class, or null if not found.

Throws: Exception

 if a general exception occurs.

 listThreadGroups

  public RemoteThreadGroup[] listThreadGroups(RemoteThreadGroup tg) throws Exception

 List threadgroups

Parameters:

 tg - the threadgroup which hold the groups to be listed, or null for all threadgroups

Throws: Exception

 if a general exception occurs.

 gc

  public void gc(RemoteObject save_list[]) throws Exception

 Free all objects referenced by the debugger.  The remote debugger maintains a copy of each object it has examined,  so that references won't become invalidated by the garbage collector  of the Java interpreter being debugged. The gc() method frees all  all of these references, except those specified to save.

Parameters:

 save_list - the list of objects to save.

Throws: Exception

 if a general exception occurs.

 trace

  public void trace(boolean traceOn) throws Exception

 Turn on/off method call tracing.  When turned on, each method call is reported to the stdout of the  Java interpreter being debugged. This output is not captured in  any way by the remote debugger.

Parameters:

 traceOn - turn tracing on or off

Throws: Exception

 if a general exception occurs.

 itrace

  public void itrace(boolean traceOn) throws Exception

 Turn on/off instruction tracing.  When turned on, each Java instruction is reported to the stdout of the  Java interpreter being debugged. This output is not captured in  any way by the remote debugger.

Parameters:

 traceOn - turn tracing on or off

Throws: Exception

 if a general exception occurs.

 totalMemory

  public int totalMemory() throws Exception

 Report the total memory usage of the Java interpreter being debugged.

Throws: Exception

 if a general exception occurs.

 freeMemory

  public int freeMemory() throws Exception

 Report the free memory available to the Java interpreter being debugged.

Throws: Exception

 if a general exception occurs.

 run

  public RemoteThreadGroup run(int argc,
                               String argv[]) throws Exception

 Load and run a runnable Java class, with any optional parameters.  The class is started inside a new threadgroup in the Java interpreter  being debugged.  NOTE: Although it is possible to run multiple runnable classes from  the same Java interpreter, there is no guarantee that all applets  will work cleanly with each other. For example, two applets may want  exclusive access to the same shared resource,such as a specific port.

Parameters:

 argc - the number of parameters

 argv - the array of parameters: the class to be run is  first, followed by any optional parameters used by that class.

Returns:

 the new ThreadGroup the class is running in, or null on error

Throws: Exception

 if a general exception occurs.

 listBreakpoints

  public String[] listBreakpoints() throws Exception

 Return a list of the breakpoints which are currently set.

Returns:

 an array of Strings of the form "class_name:line_number".

Throws: Exception

 if a general exception occurs.

 getExceptionCatchList

  public String[] getExceptionCatchList() throws Exception

 Return the list of the exceptions the debugger will stop on.

Returns:

 an array of exception class names, which may be zero-length.

Throws: Exception

 if a general exception occurs.

 getSourcePath

  public String getSourcePath() throws Exception

 Return the source file path the Agent is currently using.

Returns:

 a string consisting of a list of colon-delineated paths.

Throws: Exception

 if a general exception occurs.

 setSourcePath

  public void setSourcePath(String pathList) throws Exception

 Specify the list of paths to use when searching for a source file.

Parameters:

 pathList - a string consisting of a list of colon-delineated paths.

Throws: Exception

 if a general exception occurs.

 addSystemThread

  public void addSystemThread()

 Add the calling thread to the list of threads which aren't  suspended by the RemoteDebugger. Typically these are only  threads used by a debugger client. The thread which created  the RemoteDebugger instance is automatically added, as is  the AgentIn and other debugger-specific threads.

 addSystemThread

  public void addSystemThread(Thread t)

 Add the specified thread to the list of threads which aren't  suspended by the RemoteDebugger. Typically these are only  threads used by a debugger client. The thread which created  the RemoteDebugger instance is automatically added, as is  the AgentIn and other debugger-specific threads.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.tools.debug.RemoteDouble

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class sun.tools.debug.RemoteDouble

java.lang.Object
   |
   +----sun.tools.debug.RemoteValue
           |
           +----sun.tools.debug.RemoteDouble

______________________________________________________________________________

 public class RemoteDouble

 extends RemoteValue

The RemoteDouble class extends RemoteValue for doubles.

See Also:

RemoteValue, RemoteDebugger

______________________________________________________________________________

 	get()

 Return the double's value.

 	toString()

 Return the double's value as a string.

 	typeName()

 Print this RemoteValue's type ("double").

 get

  public double get()

 Return the double's value.

 typeName

  public String typeName()

 Print this RemoteValue's type ("double").

Overrides:

typeName in class RemoteValue

 toString

  public String toString()

 Return the double's value as a string.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.tools.debug.RemoteField

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class sun.tools.debug.RemoteField

java.lang.Object
   |
   +----sun.tools.debug.Field
           |
           +----sun.tools.debug.RemoteField

______________________________________________________________________________

 public class RemoteField

 extends Field

 implements AgentConstants

A RemoteField allows access to a variable or method of an object  or class in a remote Java interpreter.

See Also:

RemoteStackVariable

______________________________________________________________________________

 	getModifiers()

 Returns a string with the field's modifiers, such as "public",  "static", "final", etc.

 	getName()

 Returns the name of the field.

 	getType()

 Returns a Type object for the field.

 	getTypedName()

 Returns a string describing the field with its full type.

 	isStatic()

 Returns whether the field is static (a class variable or method).

 	toString()

 Returns a string representation of the object.

 getName

  public String getName()

 Returns the name of the field.

 getType

  public Type getType()

 Returns a Type object for the field.

 getTypedName

  public String getTypedName()

 Returns a string describing the field with its full type.  This string is similar to the one defining the field or  its source code, such as "int enumerate(Thread[])" or  "char name[]".

 getModifiers

  public String getModifiers()

 Returns a string with the field's modifiers, such as "public",  "static", "final", etc. If the field has no modifiers, an empty  String is returned.

 isStatic

  public boolean isStatic()

 Returns whether the field is static (a class variable or method).

 toString

  public String toString()

 Returns a string representation of the object.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.tools.debug.RemoteFloat

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class sun.tools.debug.RemoteFloat

java.lang.Object
   |
   +----sun.tools.debug.RemoteValue
           |
           +----sun.tools.debug.RemoteFloat

______________________________________________________________________________

 public class RemoteFloat

 extends RemoteValue

The RemoteFloat class extends RemoteValue for floats.

See Also:

RemoteValue, RemoteDebugger

______________________________________________________________________________

 	get()

 Return the float's value.

 	toString()

 Return the float's value as a string.

 	typeName()

 Print this RemoteValue's type ("float").

 get

  public float get()

 Return the float's value.

 typeName

  public String typeName()

 Print this RemoteValue's type ("float").

Overrides:

typeName in class RemoteValue

 toString

  public String toString()

 Return the float's value as a string.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.tools.debug.RemoteInt

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class sun.tools.debug.RemoteInt

java.lang.Object
   |
   +----sun.tools.debug.RemoteValue
           |
           +----sun.tools.debug.RemoteInt

______________________________________________________________________________

 public class RemoteInt

 extends RemoteValue

The RemoteInt class extends RemoteValue for ints.

See Also:

RemoteValue, RemoteDebugger

______________________________________________________________________________

 	RemoteInt(int)

 	get()

 Return the int's value.

 	toString()

 Return the int's value as a string.

 	typeName()

 Print this RemoteValue's type ("int").

 RemoteInt

  public RemoteInt(int i)

 get

  public int get()

 Return the int's value.

 typeName

  public String typeName()

 Print this RemoteValue's type ("int").

Overrides:

typeName in class RemoteValue

 toString

  public String toString()

 Return the int's value as a string.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.tools.debug.RemoteLong

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class sun.tools.debug.RemoteLong

java.lang.Object
   |
   +----sun.tools.debug.RemoteValue
           |
           +----sun.tools.debug.RemoteLong

______________________________________________________________________________

 public class RemoteLong

 extends RemoteValue

The RemoteLong class extends RemoteValue for longs.

See Also:

RemoteValue, RemoteDebugger

______________________________________________________________________________

 	get()

 Return the long's value.

 	toString()

 Return the long's value as a string.

 	typeName()

 Print this RemoteValue's type ("long").

 get

  public long get()

 Return the long's value.

 typeName

  public String typeName()

 Print this RemoteValue's type ("long").

Overrides:

typeName in class RemoteValue

 toString

  public String toString()

 Return the long's value as a string.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.tools.debug.RemoteObject

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class sun.tools.debug.RemoteObject

java.lang.Object
   |
   +----sun.tools.debug.RemoteValue
           |
           +----sun.tools.debug.RemoteObject

______________________________________________________________________________

 public class RemoteObject

 extends RemoteValue

The RemoteObject class allows access to an object in a remote  Java interpreter.  Remote objects are not created by the local debugger, but are returned  by the remote debugging agent when queried for the values of instance  or static variables of known objects (such as classes), or from local  (stack) variables.  Each remote object has a reference cached by the remote Java interpreter,  so that the object will not be garbage-collected during examination. The  RemoteDebugger's gc() operation frees references to objects that are no  longer being examined.

See Also:

RemoteDebugger, RemoteClass, RemoteString, RemoteThread, RemoteThreadGroup

______________________________________________________________________________

 	description()

 Return a description of the object.

 	finalize()

  	getClazz()

 Returns the object's class.

 	getField(int)

 Return an instance variable, specified by slot number.

 	getField(String)

 Return an instance variable, specified by name.

 	getFields()

 Return the instance (non-static) fields of an object.

 	getFieldValue(int)

 Returns the value of an object's instance variable.

 	getFieldValue(String)

 Returns the value of an object's instance variable.

 	getId()

 Returns the id of the object.

 	setField(int, boolean)

 Set a boolean instance variable, specified by slot.

 	setField(int, char)

 Set a char instance variable, specified by slot.

 	setField(int, double)

 Set a double instance variable, specified by slot.

 	setField(int, float)

 Set a float instance variable, specified by slot.

 	setField(int, int)

 Set an int instance variable, specified by slot.

 	setField(int, long)

 Set a long instance variable, specified by slot.

 	setField(int, RemoteObject)

 Set an object instance variable, specified by slot.

 	setField(String, boolean)

 Set a boolean instance variable, specified by name.

 	setField(String, char)

 Set a char instance variable, specified by name.

 	setField(String, double)

 Set a double instance variable, specified by name.

 	setField(String, float)

 Set a float instance variable, specified by name.

 	setField(String, int)

 Set an int instance variable, specified by name.

 	setField(String, long)

 Set a long instance variable, specified by name.

 	setField(String, RemoteObject)

 Set an object instance variable, specified by name.

 	toString()

 Return object as a string.

 	typeName()

 Returns the RemoteValue's type name ("Object").

 typeName

  public String typeName() throws Exception

 Returns the RemoteValue's type name ("Object").

Throws: Exception

 if a general exception occurs.

Overrides:

typeName in class RemoteValue

 getId

  public final int getId()

 Returns the id of the object.

 getClazz

  public final RemoteClass getClazz()

 Returns the object's class.

 getFieldValue

  public RemoteValue getFieldValue(int n) throws Exception

 Returns the value of an object's instance variable.

Parameters:

 n - the slot number of the variable to be returned.

Throws: Exception

 if a general exception occurs.

 getFieldValue

  public RemoteValue getFieldValue(String name) throws Exception

 Returns the value of an object's instance variable.

Parameters:

 name - the name of the instance variable

Returns:

 the variable as a RemoteValue, or null if name not found.

Throws: Exception

 if a general exception occurs.

 getFields

  public RemoteField[] getFields() throws Exception

 Return the instance (non-static) fields of an object.

Throws: Exception

 if a general exception occurs.

 getField

  public RemoteField getField(int n) throws Exception

 Return an instance variable, specified by slot number.

Parameters:

 n - the slot number of the variable to be returned.

Throws: Exception

 if a general exception occurs.

 getField

  public RemoteField getField(String name) throws Exception

 Return an instance variable, specified by name.

Parameters:

 name - the name of the instance variable

Returns:

 the variable as a RemoteField, or null if name not found.

Throws: Exception

 if a general exception occurs.

 setField

  public void setField(String name,
                       boolean value) throws Exception

 Set a boolean instance variable, specified by name. If the instance  variable doesn't exist, an IllegalAccessException is thrown.

Parameters:

 name - the name of the instance variable

 value - the value to use

Throws: Exception

 if a general exception occurs.

 setField

  public void setField(String name,
                       int value) throws Exception

 Set an int instance variable, specified by name. If the instance  variable doesn't exist, an IllegalAccessException is thrown.

Parameters:

 name - the name of the instance variable

 value - the value to use

Throws: Exception

 if a general exception occurs.

 setField

  public void setField(String name,
                       char value) throws Exception

 Set a char instance variable, specified by name. If the instance  variable doesn't exist, an IllegalAccessException is thrown.

Parameters:

 name - the name of the instance variable

 value - the value to use

Throws: Exception

 if a general exception occurs.

 setField

  public void setField(String name,
                       long value) throws Exception

 Set a long instance variable, specified by name. If the instance  variable doesn't exist, an IllegalAccessException is thrown.

Parameters:

 name - the name of the instance variable

 value - the value to use

Throws: Exception

 if a general exception occurs.

 setField

  public void setField(String name,
                       float value) throws Exception

 Set a float instance variable, specified by name. If the instance  variable doesn't exist, an IllegalAccessException is thrown.

Parameters:

 name - the name of the instance variable

 value - the value to use

Throws: Exception

 if a general exception occurs.

 setField

  public void setField(String name,
                       double value) throws Exception

 Set a double instance variable, specified by name. If the instance  variable doesn't exist, an IllegalAccessException is thrown.

Parameters:

 name - the name of the instance variable

 value - the value to use

Throws: Exception

 if a general exception occurs.

 setField

  public void setField(String name,
                       RemoteObject object) throws Exception

 Set an object instance variable, specified by name. This isn't  currently supported, so an IllegalAccessException is always thrown.  (The API is defined so that this feature can be implemented in  future releases.)

Parameters:

 name - the name of the instance variable

 object - the RemoteObject to use

Throws: Exception

 if a general exception occurs.

 setField

  public void setField(int slot,
                       boolean value) throws Exception

 Set a boolean instance variable, specified by slot. If the instance  variable doesn't exist, an IllegalAccessException is thrown.

Parameters:

 slot - the slot number of the instance variable

 value - the value to use

Throws: Exception

 if a general exception occurs.

 setField

  public void setField(int slot,
                       int value) throws Exception

 Set an int instance variable, specified by slot. If the instance  variable doesn't exist, an IllegalAccessException is thrown.

Parameters:

 slot - the slot number of the instance variable

 value - the value to use

Throws: Exception

 if a general exception occurs.

 setField

  public void setField(int slot,
                       char value) throws Exception

 Set a char instance variable, specified by slot. If the instance  variable doesn't exist, an IllegalAccessException is thrown.

Parameters:

 slot - the slot number of the instance variable

 value - the value to use

Throws: Exception

 if a general exception occurs.

 setField

  public void setField(int slot,
                       long value) throws Exception

 Set a long instance variable, specified by slot. If the instance  variable doesn't exist, an IllegalAccessException is thrown.

Parameters:

 slot - the slot number of the instance variable

 value - the value to use

Throws: Exception

 if a general exception occurs.

 setField

  public void setField(int slot,
                       float value) throws Exception

 Set a float instance variable, specified by slot. If the instance  variable doesn't exist, an IllegalAccessException is thrown.

Parameters:

 slot - the slot number of the instance variable

 value - the value to use

Throws: Exception

 if a general exception occurs.

 setField

  public void setField(int slot,
                       double value) throws Exception

 Set a double instance variable, specified by slot. If the instance  variable doesn't exist, an IllegalAccessException is thrown.

Parameters:

 slot - the slot number of the instance variable

 value - the value to use

Throws: Exception

 if a general exception occurs.

 setField

  public void setField(int slot,
                       RemoteObject object) throws Exception

 Set an object instance variable, specified by slot. This isn't  currently supported, so an IllegalAccessException is always thrown.  (The API is defined so that this feature can be implemented in  future releases.)

Parameters:

 slot - the slot number of the instance variable

 object - the RemoteObject to use

Throws: Exception

 if a general exception occurs.

 description

  public String description()

 Return a description of the object.

Overrides:

description in class RemoteValue

 toString

  public String toString()

 Return object as a string.

Overrides:

toString in class Object

 finalize

  protected void finalize() throws Exception

Throws: Exception

 if a general exception occurs.

Overrides:

finalize in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.tools.debug.RemoteShort

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class sun.tools.debug.RemoteShort

java.lang.Object
   |
   +----sun.tools.debug.RemoteValue
           |
           +----sun.tools.debug.RemoteShort

______________________________________________________________________________

 public class RemoteShort

 extends RemoteValue

The RemoteShort class extends RemoteValue for shorts.

See Also:

RemoteValue, RemoteDebugger

______________________________________________________________________________

 	get()

 Return the short's value.

 	toString()

 Return the short's value as a string.

 	typeName()

 Print this RemoteValue's type ("short").

 get

  public short get()

 Return the short's value.

 typeName

  public String typeName()

 Print this RemoteValue's type ("short").

Overrides:

typeName in class RemoteValue

 toString

  public String toString()

 Return the short's value as a string.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.tools.debug.RemoteStackFrame

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class sun.tools.debug.RemoteStackFrame

java.lang.Object
   |
   +----sun.tools.debug.StackFrame
           |
           +----sun.tools.debug.RemoteStackFrame

______________________________________________________________________________

 public class RemoteStackFrame

 extends StackFrame

The RemoteStackFrame class provides access to a stackframe of a  suspended thread.

See Also:

RemoteDebugger, RemoteThread

______________________________________________________________________________

 	getLineNumber()

 Return the source file line number.

 	getLocalVariable(String)

 Return a specific (named) stack variable.

 	getLocalVariables()

 Return an array of all valid local variables and method arguments  for this stack frame.

 	getMethodName()

 Get the method name referenced by this stackframe.

 	getPC()

 Get the program counter referenced by this stackframe.

 	getRemoteClass()

 Get the class this stackframe references.

 getLocalVariable

  public RemoteStackVariable getLocalVariable(String name) throws Exception

 Return a specific (named) stack variable. A slot number of -1  indicates that the variable is not currently in scope.

Throws: Exception

 if a general exception occurs.

 getLocalVariables

  public RemoteStackVariable[] getLocalVariables() throws Exception

 Return an array of all valid local variables and method arguments  for this stack frame.

Throws: Exception

 if a general exception occurs.

 getLineNumber

  public int getLineNumber()

 Return the source file line number.

 getMethodName

  public String getMethodName()

 Get the method name referenced by this stackframe.

 getPC

  public int getPC()

 Get the program counter referenced by this stackframe.

 getRemoteClass

  public RemoteClass getRemoteClass()

 Get the class this stackframe references.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.tools.debug.RemoteStackVariable

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class sun.tools.debug.RemoteStackVariable

java.lang.Object
   |
   +----sun.tools.debug.LocalVariable
           |
           +----sun.tools.debug.RemoteStackVariable

______________________________________________________________________________

 public class RemoteStackVariable

 extends LocalVariable

 implements AgentConstants

A RemoteStackVariable represents a method argument or local variable.  It is similar to a RemoteField, but is much more transient in nature.

See Also:

RemoteField

______________________________________________________________________________

 	getName()

 Return the name of a stack variable or argument.

 	getType()

 Returns a Type object for the field.

 	getValue()

 Return the value of a stack variable or argument.

 	inScope()

 Return whether variable is in scope.

 	methodArgument()

 Return whether variable is a method argument.

 getName

  public String getName()

 Return the name of a stack variable or argument.

 getValue

  public RemoteValue getValue()

 Return the value of a stack variable or argument.

 inScope

  public boolean inScope()

 Return whether variable is in scope.

 methodArgument

  public boolean methodArgument()

 Return whether variable is a method argument.

 getType

  public Type getType()

 Returns a Type object for the field.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.tools.debug.RemoteString

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class sun.tools.debug.RemoteString

java.lang.Object
   |
   +----sun.tools.debug.RemoteValue
           |
           +----sun.tools.debug.RemoteObject
                   |
                   +----sun.tools.debug.RemoteString

______________________________________________________________________________

 public class RemoteString

 extends RemoteObject

The RemoteString class allows access to a string in a remote Java  interpreter.

See Also:

RemoteDebugger

______________________________________________________________________________

 	description()

 Return the string value, or "null"

 	toString()

 Return the string value, or "null"

 	typeName()

 Print this RemoteValue's type ("String").

 typeName

  public String typeName()

 Print this RemoteValue's type ("String").

Overrides:

typeName in class RemoteObject

 description

  public String description()

 Return the string value, or "null"

Overrides:

description in class RemoteObject

 toString

  public String toString()

 Return the string value, or "null"

Overrides:

toString in class RemoteObject

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.tools.debug.RemoteThread

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class sun.tools.debug.RemoteThread

java.lang.Object
   |
   +----sun.tools.debug.RemoteValue
           |
           +----sun.tools.debug.RemoteObject
                   |
                   +----sun.tools.debug.RemoteThread

______________________________________________________________________________

 public class RemoteThread

 extends RemoteObject

The RemoteThread class allows access to a thread in a remote Java  interpreter.

See Also:

RemoteDebugger, RemoteThreadGroup

______________________________________________________________________________

 	cont()

 Resume this thread from a breakpoint, unless it previously suspended.

 	down(int)

 Change the current stackframe to be one or more frames lower  (as in, toward the current program counter).

 	dumpStack()

 Dump the stack.

 	getCurrentFrame()

 Get the current stack frame.

 	getCurrentFrameIndex()

 Return the current stackframe index

 	getName()

 Return the name of the thread.

 	getStackVariable(String)

 Return a stack variable from the current stackframe.

 	getStackVariables()

 Return the arguments and local variable from the current stackframe.

 	getStatus()

 Return the thread status description

 	isSuspended()

 Return whether this thread is suspended.

 	next()

 Continue execution of this thread to the next line, but don't step  into a method call.

 	resetCurrentFrameIndex()

 Reset the current stackframe

 	resume()

 Resume execution of this thread.

 	setCurrentFrameIndex(int)

 Set the current stackframe index

 	step(boolean)

 Continue execution of this thread to the next instruction or line.

 	stop()

 Stop the remote thread.

 	suspend()

 Suspend execution of this thread.

 	up(int)

 Change the current stackframe to be one or more frames higher  (as in, away from the current program counter).

 getName

  public String getName() throws Exception

 Return the name of the thread.

 getCurrentFrameIndex

  public int getCurrentFrameIndex()

 Return the current stackframe index

 setCurrentFrameIndex

  public void setCurrentFrameIndex(int iFrame)

 Set the current stackframe index

 resetCurrentFrameIndex

  public void resetCurrentFrameIndex()

 Reset the current stackframe

 up

  public void up(int nFrames) throws Exception

 Change the current stackframe to be one or more frames higher  (as in, away from the current program counter).

Parameters:

 nFrames - the number of stackframes

Throws: IllegalAccessError

 when the thread isn't suspended or waiting at a breakpoint

Throws: ArrayIndexOutOfBoundsException

 when the requested frame is beyond the stack boundary

 down

  public void down(int nFrames) throws Exception

 Change the current stackframe to be one or more frames lower  (as in, toward the current program counter).

Parameters:

 nFrames - the number of stackframes

Throws: IllegalAccessError

 when the thread isn't suspended or waiting at a breakpoint

Throws: ArrayIndexOutOfBoundsException

 when the requested frame is beyond the stack boundary

 getStatus

  public String getStatus() throws Exception

 Return the thread status description

 dumpStack

  public RemoteStackFrame[] dumpStack() throws Exception

 Dump the stack.

 getCurrentFrame

  public RemoteStackFrame getCurrentFrame() throws Exception

 Get the current stack frame.

Throws: IllegalAccessError

 when the thread isn't suspended or waiting at a breakpoint

 suspend

  public void suspend() throws Exception

 Suspend execution of this thread.

 resume

  public void resume() throws Exception

 Resume execution of this thread.

 step

  public void step(boolean skipLine) throws Exception

 Continue execution of this thread to the next instruction or line.

Parameters:

 skipLine - true to execute to next source line, false to  next instruction.

Throws: IllegalAccessError

 when the thread isn't suspended or waiting at a breakpoint

 next

  public void next() throws Exception

 Continue execution of this thread to the next line, but don't step  into a method call. If no line information is available, next()  is equivalent to step().

Throws: IllegalAccessError

 when the thread isn't suspended or waiting at a breakpoint

 isSuspended

  public boolean isSuspended()

 Return whether this thread is suspended.

 cont

  public void cont() throws Exception

 Resume this thread from a breakpoint, unless it previously suspended.

 stop

  public void stop() throws Exception

 Stop the remote thread.

 getStackVariable

  public RemoteStackVariable getStackVariable(String name) throws Exception

 Return a stack variable from the current stackframe.

Returns:

 the variable as a RemoteValue, or null if not found.

 getStackVariables

  public RemoteStackVariable[] getStackVariables() throws Exception

 Return the arguments and local variable from the current stackframe.

Returns:

 an array of RemoteValues.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.tools.debug.RemoteThreadGroup

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class sun.tools.debug.RemoteThreadGroup

java.lang.Object
   |
   +----sun.tools.debug.RemoteValue
           |
           +----sun.tools.debug.RemoteObject
                   |
                   +----sun.tools.debug.RemoteThreadGroup

______________________________________________________________________________

 public class RemoteThreadGroup

 extends RemoteObject

The RemoteThreadGroup class allows access to a threadgroup in a  remote Java interpreter.

See Also:

RemoteDebugger, RemoteThreadGroup

______________________________________________________________________________

 	getName()

 Return the threadgroup's name.

 	listThreads(boolean)

 List a threadgroup's threads

 	stop()

 Stop the remote threadgroup.

 getName

  public String getName() throws Exception

 Return the threadgroup's name.

 stop

  public void stop() throws Exception

 Stop the remote threadgroup.

 listThreads

  public RemoteThread[] listThreads(boolean recurse) throws Exception

 List a threadgroup's threads

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.tools.debug.RemoteValue

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class sun.tools.debug.RemoteValue

java.lang.Object
   |
   +----sun.tools.debug.RemoteValue

______________________________________________________________________________

 public class RemoteValue

 extends Object

 implements AgentConstants

The RemoteValue class allows access to a copy of a value in the  remote Java interpreter. This value may be a primitive type, such  as a boolean or float, or an object, class, array, etc.  Remote values are not created by the local debugger, but are returned  by the remote debugging agent when queried for the values of instance  or static variables of known objects, or from local (stack) variables.

See Also:

RemoteDebugger, RemoteArray, RemoteBoolean, RemoteByte, RemoteChar, RemoteClass, RemoteDouble, RemoteFloat, RemoteInt, RemoteLong, RemoteObject, RemoteShort, RemoteString, RemoteThread, RemoteThreadGroup

______________________________________________________________________________

 	description()

 Return a description of the RemoteValue.

 	fromHex(String)

 Convert hexadecimal strings to ints.

 	getType()

 Returns the RemoteValue's type.

 	isObject()

 Returns whether the RemoteValue is an Object (as opposed to  a primitive type, such as int).

 	isString()

 Returns whether the RemoteValue is an instance of java.lang.String.

 	toHex(int)

 Convert an int to a hexadecimal string.

 	typeName()

 Returns the RemoteValue's type as a string.

 getType

  public final int getType()

 Returns the RemoteValue's type.

 isObject

  public final boolean isObject()

 Returns whether the RemoteValue is an Object (as opposed to  a primitive type, such as int).

 isString

  public final boolean isString()

 Returns whether the RemoteValue is an instance of java.lang.String.

 typeName

  public abstract String typeName() throws Exception

 Returns the RemoteValue's type as a string.

 description

  public String description()

 Return a description of the RemoteValue.

 toHex

  public static String toHex(int n)

 Convert an int to a hexadecimal string.

 fromHex

  public static int fromHex(String hexStr)

 Convert hexadecimal strings to ints.

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sun.tools.debug.StackFrame

All Packages  Class Hierarchy  This Package  Previous  Next   Index
______________________________________________________________________________

  Class sun.tools.debug.StackFrame

java.lang.Object
   |
   +----sun.tools.debug.StackFrame

______________________________________________________________________________

 public class StackFrame

 extends Object

The StackFrame class represents a stack frame of a suspended thread.

See Also:

RemoteDebugger, RemoteStackFrame, RemoteThread

______________________________________________________________________________

 	StackFrame()

 	toString()

 Returns a string representation of the object.

 StackFrame

  public StackFrame()

 toString

  public String toString()

 Returns a string representation of the object.

Overrides:

toString in class Object

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next   Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface sunw.io.Serializable

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Interface sunw.io.Serializable

 public interface Serializable

 extends Serializable

 Note: Serializable is deprecated. This is a compatibility type to allow Java Beans that  were developed under JDK 1.0.2 to run correctly under JDK 1.1. The  corresponding JDK1.1 type is java.util.Serializable

FOR BACKWARD COMPATIBILITY ONLY - DO NOT USE.

 This is a backwards compatibility class to allow Java Beans that  were developed under JDK 1.0.2 to run correctly under JDK 1.1

 To allow beans development under JDK 1.0.2, JavaSoft delivered three  no-op interfaces/classes (sunw.io.Serializable, sunw.util.EventObject  and sunw.util.EventListener) that could be downloaded into JDK 1.0.2  systems and which would act as placeholders for the real JDK 1.1  classes.

 Now under JDK 1.1 we provide versions of these classes and interfaces  that inherit from the real version in java.util and java.io. These  mean that beans developed under JDK 1.0.2 against the sunw.* classes  will now continue to work on JDK 1.1 and will (indirectly) inherit  from the approrpiate java.* interfaces/classes.

See Also:

Serializable

______________________________________________________________________________
______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Interface sunw.util.EventListener

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Interface sunw.util.EventListener

 public interface EventListener

 extends EventListener

 Note: EventListener is deprecated. This is a compatibility type to allow Java Beans that  were developed under JDK 1.0.2 to run correctly under JDK 1.1. The  corresponding JDK1.1 type is java.util.EventListener

FOR BACKWARD COMPATIBILITY ONLY - DO NOT USE.

 This is a backwards compatibility class to allow Java Beans that  were developed under JDK 1.0.2 to run correctly under JDK 1.1

 To allow beans development under JDK 1.0.2, JavaSoft delivered three  no-op interfaces/classes (sunw.io.Serializable, sunw.util.EventObject  and sunw.util.EventListener) that could be downloaded into JDK 1.0.2  systems and which would act as placeholders for the real JDK 1.1  classes.

 Now under JDK 1.1 we provide versions of these classes and interfaces  that inherit from the real version in java.util and java.io. These  mean that beans developed under JDK 1.0.2 against the sunw.* classes  will now continue to work on JDK 1.1 and will (indirectly) inherit  from the approrpiate java.* interfaces/classes.

See Also:

EventListener

______________________________________________________________________________
______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class sunw.util.EventObject

All Packages  Class Hierarchy  This Package  Previous  Next  Index
______________________________________________________________________________

  Class sunw.util.EventObject

java.lang.Object
   |
   +----java.util.EventObject
           |
           +----sunw.util.EventObject

______________________________________________________________________________

 public class EventObject

 extends EventObject

 Note: EventObject is deprecated. This is a compatibility type to allow Java Beans that  were developed under JDK 1.0.2 to run correctly under JDK 1.1. The  corresponding JDK1.1 type is java.util.EventObject

FOR BACKWARD COMPATIBILITY ONLY - DO NOT USE.

 This is a backwards compatibility class to allow Java Beans that  were developed under JDK 1.0.2 to run correctly under JDK 1.1

 To allow beans development under JDK 1.0.2, JavaSoft delivered three  no-op interfaces/classes (sunw.io.Serializable, sunw.util.EventObject  and sunw.util.EventListener) that could be downloaded into JDK 1.0.2  systems and which would act as placeholders for the real JDK 1.1  classes.

 Now under JDK 1.1 we provide versions of these classes and interfaces  that inherit from the real version in java.util and java.io. These  mean that beans developed under JDK 1.0.2 against the sunw.* classes  will now continue to work on JDK 1.1 and will (indirectly) inherit  from the approrpiate java.* interfaces/classes.

See Also:

EventObject

______________________________________________________________________________

 	EventObject(Object)

 EventObject

  public EventObject(Object source)

______________________________________________________________________________

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Generated using an evaluation version of HyperAct HTMheLp


  Class Hierarchy

All Packages  Index
______________________________________________________________________________

  Class Hierarchy

•  class java.lang.Object

•  class java.awt.AWTEventMulticaster  (implements java.awt.event.ComponentListener, java.awt.event.ContainerListener , java.awt.event.FocusListener, java.awt.event.KeyListener, java.awt.event. MouseListener, java.awt.event.MouseMotionListener, java.awt.event. WindowListener, java.awt.event.ActionListener, java.awt.event.ItemListener , java.awt.event.AdjustmentListener, java.awt.event.TextListener)

•  interface java.security.acl.Acl (extends java.security.acl.Owner)

•  interface java.security.acl.AclEntry (extends java.lang.Cloneable)

•  interface java.awt.event.ActionListener (extends java.util.EventListener )

•  interface java.awt.Adjustable

•  interface java.awt.event.AdjustmentListener (extends java.util.EventListener )

•  class java.util.zip.Adler32 (implements java.util.zip.Checksum)

•  interface java.applet.AppletContext

•  interface java.applet.AppletStub

•  class java.lang.reflect.Array

•  interface java.applet.AudioClip

•  interface java.beans.BeanInfo

•  class java.beans.Beans

•  class java.util.BitSet (implements java.lang.Cloneable, java.io. Serializable)

•  class java.lang.Boolean (implements java.io.Serializable)

•  class java.awt.BorderLayout (implements java.awt.LayoutManager2 , java.io.Serializable)

•  class java.text.BreakIterator (implements java.lang.Cloneable , java.io.Serializable)

•  interface java.awt.peer.ButtonPeer (extends java.awt.peer.ComponentPeer )

•  class java.util.zip.CRC32 (implements java.util.zip.Checksum)

•  class java.util.Calendar (implements java.io.Serializable , java.lang.Cloneable)

•  class java.util.GregorianCalendar

•  interface java.sql.CallableStatement  (extends java.sql.PreparedStatement)

•  interface java.awt.peer.CanvasPeer (extends java.awt.peer.ComponentPeer )

•  class java.awt.CardLayout (implements java.awt.LayoutManager2 , java.io.Serializable)

•  interface java.security.Certificate

•  class java.lang.Character (implements java.io.Serializable)

•  interface java.text.CharacterIterator (extends java.lang.Cloneable )

•  class java.awt.CheckboxGroup (implements java.io.Serializable)

•  interface java.awt.peer.CheckboxMenuItemPeer (extends java.awt.peer. MenuItemPeer)

•  interface java.awt.peer.CheckboxPeer (extends java.awt.peer.ComponentPeer )

•  interface java.util.zip.Checksum

•  interface java.awt.peer.ChoicePeer (extends java.awt.peer.ComponentPeer )

•  class java.lang.Class (implements java.io.Serializable)

•  class java.lang.ClassLoader

•  class java.awt.datatransfer.Clipboard

•  interface java.awt.datatransfer.ClipboardOwner

•  interface java.lang.Cloneable

•  class java.text.CollationElementIterator

•  class java.text.CollationKey

•  class java.text.Collator (implements java.lang.Cloneable, java.io. Serializable)

•  class java.text.RuleBasedCollator

•  class java.awt.Color (implements java.io. Serializable)

•  class java.awt.SystemColor (implements java.io. Serializable)

•  class java.awt.image.ColorModel

•  class java.awt.image.DirectColorModel

•  class java.awt.image.IndexColorModel

•  class java.lang.Compiler

•  class java.awt.Component (implements java.awt.image.ImageObserver , java.awt.MenuContainer, java.io.Serializable)

•  class java.awt.Button

•  class java.awt.Canvas

•  class java.awt.Checkbox (implements java.awt.ItemSelectable)

•  class java.awt.Choice (implements java.awt.ItemSelectable)

•  class java.awt.Container

•  class java.awt.Panel

•  class java.applet.Applet

•  class java.awt.ScrollPane

•  class java.awt.Window

•  class java.awt.Dialog

•  class java.awt.FileDialog

•  class java.awt.Frame (implements java.awt. MenuContainer)

•  class java.awt.Label

•  class java.awt.List (implements java.awt.ItemSelectable)

•  class java.awt.Scrollbar (implements java.awt.Adjustable)

•  class java.awt.TextComponent

•  class java.awt.TextArea

•  class java.awt.TextField

•  class java.awt.event.ComponentAdapter  (implements java.awt.event.ComponentListener)

•  interface java.awt.event.ComponentListener (extends java.util.EventListener )

•  interface java.awt.peer.ComponentPeer

•  interface java.sql.Connection

•  class java.lang.reflect.Constructor (implements java.lang.reflect.Member )

•  class java.awt.event.ContainerAdapter (implements java.awt.event. ContainerListener)

•  interface java.awt.event.ContainerListener (extends java.util.EventListener )

•  interface java.awt.peer.ContainerPeer (extends java.awt.peer.ComponentPeer )

•  class java.net.ContentHandler

•  interface java.net.ContentHandlerFactory

•  class java.awt.Cursor (implements java.io.Serializable)

•  interface java.beans.Customizer

•  interface java.rmi.dgc.DGC (extends java.rmi.Remote)

•  interface java.security.interfaces.DSAKey

•  interface java.security.interfaces.DSAKeyPairGenerator

•  interface java.security.interfaces.DSAParams

•  interface java.security.interfaces.DSAPrivateKey  (extends java.security.interfaces.DSAKey, java.security.PrivateKey)

•  interface java.security.interfaces.DSAPublicKey  (extends java.security.interfaces.DSAKey, java.security.PublicKey)

•  class java.awt.datatransfer.DataFlavor

•  interface java.io.DataInput

•  interface java.io.DataOutput

•  interface java.sql.DatabaseMetaData

•  class java.net.DatagramPacket

•  class java.net.DatagramSocket

•  class java.net.MulticastSocket

•  class java.net.DatagramSocketImpl  (implements java.net.SocketOptions)

•  class java.util.Date (implements java.io.Serializable, java.lang. Cloneable)

•  class java.sql.Date

•  class java.sql.Time

•  class java.sql.Timestamp

•  class java.text.DateFormatSymbols  (implements java.io.Serializable, java.lang.Cloneable)

•  interface sun.tools.debug.DebuggerCallback

•  class java.text.DecimalFormatSymbols (implements java.lang.Cloneable , java.io.Serializable)

•  class java.util.zip.Deflater

•  interface java.awt.peer.DialogPeer (extends java.awt.peer.WindowPeer )

•  class java.util.Dictionary

•  class java.util.Hashtable (implements java.lang. Cloneable, java.io.Serializable)

•  class java.util.Properties

•  class java.security.Provider

•  class java.awt.Dimension (implements java.io. Serializable)

•  interface java.sql.Driver

•  class java.sql.DriverManager

•  class java.sql.DriverPropertyInfo

•  interface java.util.Enumeration

•  class java.awt.Event (implements java.io.Serializable)

•  interface java.util.EventListener

•  interface sunw.util.EventListener (extends java.util.EventListener )

•  class java.util.EventObject (implements java.io.Serializable)

•  class java.awt.AWTEvent

•  class java.awt.event.ActionEvent

•  class java.awt.event.AdjustmentEvent

•  class java.awt.event.ComponentEvent

•  class java.awt.event.ContainerEvent

•  class java.awt.event.FocusEvent

•  class java.awt.event.InputEvent

•  class java.awt.event.KeyEvent

•  class java.awt.event.MouseEvent

•  class java.awt.event.PaintEvent

•  class java.awt.event.WindowEvent

•  class java.awt.event.ItemEvent

•  class java.awt.event.TextEvent

•  class sunw.util.EventObject

•  class java.beans.PropertyChangeEvent

•  class java.awt.EventQueue

•  interface java.io.Externalizable (extends java.io.Serializable)

•  class java.beans.FeatureDescriptor

•  class java.beans.BeanDescriptor

•  class java.beans.EventSetDescriptor

•  class java.beans.MethodDescriptor

•  class java.beans.ParameterDescriptor

•  class java.beans.PropertyDescriptor

•  class java.beans.IndexedPropertyDescriptor

•  class java.lang.reflect.Field  (implements java.lang.reflect.Member)

•  class sun.tools.debug.Field

•  class sun.tools.debug.RemoteField  (implements sun.tools.debug.AgentConstants)

•  class java.text.FieldPosition

•  class java.io.File (implements java.io.Serializable)

•  class java.io.FileDescriptor

•  interface java.awt.peer.FileDialogPeer (extends java.awt.peer.DialogPeer )

•  interface java.net.FileNameMap

•  interface java.io.FilenameFilter

•  class java.awt.image.FilteredImageSource (implements java.awt.image. ImageProducer)

•  class java.awt.FlowLayout (implements java.awt.LayoutManager , java.io.Serializable)

•  class java.awt.event.FocusAdapter (implements java.awt.event.FocusListener )

•  interface java.awt.event.FocusListener (extends java.util.EventListener )

•  class java.awt.Font (implements java.io.Serializable)

•  class java.awt.FontMetrics (implements java.io.Serializable)

•  interface java.awt.peer.FontPeer

•  class java.text.Format (implements java.io.Serializable , java.lang.Cloneable)

•  class java.text.DateFormat  (implements java.lang.Cloneable)

•  class java.text.SimpleDateFormat

•  class java.text.MessageFormat

•  class java.text.NumberFormat (implements java.lang.Cloneable)

•  class java.text.ChoiceFormat

•  class java.text.DecimalFormat

•  interface java.awt.peer.FramePeer  (extends java.awt.peer.WindowPeer)

•  class java.awt.Graphics

•  class java.awt.GridBagConstraints (implements java.lang.Cloneable , java.io.Serializable)

•  class java.awt.GridBagLayout (implements java.awt.LayoutManager2 , java.io.Serializable)

•  class java.awt.GridLayout (implements java.awt.LayoutManager , java.io.Serializable)

•  interface java.security.acl.Group (extends java.security.Principal )

•  class java.security.Identity (implements java.security.Principal , java.io.Serializable)

•  class java.security.IdentityScope

•  class java.security.Signer

•  class java.awt.Image

•  interface java.awt.image.ImageConsumer

•  class java.awt.image.ImageFilter (implements java.awt.image.ImageConsumer , java.lang.Cloneable)

•  class java.awt.image.CropImageFilter

•  class java.awt.image.RGBImageFilter

•  class java.awt.image.ReplicateScaleFilter

•  class java.awt.image.AreaAveragingScaleFilter

•  interface java.awt.image.ImageObserver

•  interface java.awt.image.ImageProducer

•  class java.net.InetAddress (implements java.io.Serializable)

•  class java.util.zip.Inflater

•  class java.io.InputStream

•  class java.io.ByteArrayInputStream

•  class java.io.FileInputStream

•  class java.io.FilterInputStream

•  class java.io.BufferedInputStream

•  class java.util.zip.CheckedInputStream

•  class java.io.DataInputStream (implements java.io.DataInput)

•  class java.security.DigestInputStream

•  class java.util.zip.InflaterInputStream

•  class java.util.zip.GZIPInputStream

•  class java.util.zip.ZipInputStream (implements java.util.zip.ZipConstants)

•  class java.io.LineNumberInputStream

•  class java.io.PushbackInputStream

•  class java.io.ObjectInputStream  (implements java.io.ObjectInput, java.io.ObjectStreamConstants)

•  class java.io.PipedInputStream

•  class java.io.SequenceInputStream

•  class java.io.StringBufferInputStream

•  class java.awt.Insets (implements java.lang. Cloneable, java.io.Serializable)

•  class java.beans.Introspector

•  interface java.awt.event.ItemListener (extends java.util.EventListener )

•  interface java.awt.ItemSelectable

•  interface java.security.Key (extends java.io.Serializable)

•  class java.awt.event.KeyAdapter (implements java.awt.event.KeyListener )

•  interface java.awt.event.KeyListener (extends java.util.EventListener )

•  class java.security.KeyPair

•  class java.security.KeyPairGenerator

•  interface java.awt.peer.LabelPeer (extends java.awt.peer.ComponentPeer )

•  interface java.awt.LayoutManager

•  interface java.awt.LayoutManager2 (extends java.awt.LayoutManager)

•  class java.rmi.dgc.Lease (implements java.io.Serializable)

•  interface java.awt.peer.LightweightPeer (extends java.awt.peer.ComponentPeer )

•  interface java.awt.peer.ListPeer (extends java.awt.peer.ComponentPeer )

•  interface java.rmi.server.LoaderHandler

•  class sun.tools.debug.LocalVariable

•  class sun.tools.debug.RemoteStackVariable  (implements sun.tools.debug.AgentConstants)

•  class java.util.Locale (implements java.lang. Cloneable, java.io.Serializable)

•  class java.rmi.registry.LocateRegistry

•  class java.lang.Math

•  class java.awt.MediaTracker (implements java.io.Serializable)

•  interface java.lang.reflect.Member

•  class java.awt.image.MemoryImageSource (implements java.awt.image. ImageProducer)

•  interface java.awt.peer.MenuBarPeer (extends java.awt.peer.MenuComponentPeer )

•  class java.awt.MenuComponent (implements java.io.Serializable)

•  class java.awt.MenuBar (implements java.awt. MenuContainer)

•  class java.awt.MenuItem

•  class java.awt.CheckboxMenuItem  (implements java.awt.ItemSelectable)

•  class java.awt.Menu (implements java.awt.MenuContainer)

•  class java.awt.PopupMenu

•  interface java.awt.peer.MenuComponentPeer

•  interface java.awt.MenuContainer

•  interface java.awt.peer.MenuItemPeer (extends java.awt.peer. MenuComponentPeer)

•  interface java.awt.peer.MenuPeer (extends java.awt.peer.MenuItemPeer )

•  class java.awt.MenuShortcut (implements java.io.Serializable)

•  class java.security.MessageDigest

•  class java.lang.reflect.Method (implements java.lang.reflect.Member )

•  class java.lang.reflect.Modifier

•  class java.awt.event.MouseAdapter (implements java.awt.event.MouseListener )

•  interface java.awt.event.MouseListener (extends java.util.EventListener )

•  class java.awt.event.MouseMotionAdapter (implements java.awt.event. MouseMotionListener)

•  interface java.awt.event.MouseMotionListener (extends java.util. EventListener)

•  class java.rmi.Naming

•  class java.lang.Number (implements java.io.Serializable)

•  class java.math.BigDecimal

•  class java.math.BigInteger

•  class java.lang.Byte

•  class java.lang.Double

•  class java.lang.Float

•  class java.lang.Integer

•  class java.lang.Long

•  class java.lang.Short

•  class java.rmi.server.ObjID (implements java.io. Serializable)

•  interface java.io.ObjectInput (extends java.io.DataInput)

•  interface java.io.ObjectInputValidation

•  interface java.io.ObjectOutput (extends java.io.DataOutput)

•  class java.io.ObjectStreamClass (implements java.io.Serializable)

•  class java.util.Observable

•  interface java.util.Observer

•  class java.rmi.server.Operation

•  class java.io.OutputStream

•  class java.io.ByteArrayOutputStream

•  class java.io.FileOutputStream

•  class java.io.FilterOutputStream

•  class java.io.BufferedOutputStream

•  class java.util.zip.CheckedOutputStream

•  class java.io.DataOutputStream (implements java.io.DataOutput)

•  class java.util.zip.DeflaterOutputStream

•  class java.util.zip.GZIPOutputStream

•  class java.util.zip.ZipOutputStream (implements java.util.zip.ZipConstants)

•  class java.security.DigestOutputStream

•  class java.io.PrintStream

•  class java.rmi.server.LogStream

•  class java.io.ObjectOutputStream  (implements java.io.ObjectOutput, java.io.ObjectStreamConstants)

•  class java.io.PipedOutputStream

•  interface java.security.acl.Owner

•  interface java.awt.peer.PanelPeer (extends java.awt.peer.ContainerPeer )

•  class java.text.ParsePosition

•  interface java.security.acl.Permission

•  class java.awt.image.PixelGrabber (implements java.awt.image.ImageConsumer )

•  class java.awt.Point (implements java.io.Serializable)

•  class java.awt.Polygon (implements java.awt.Shape, java.io. Serializable)

•  interface java.awt.peer.PopupMenuPeer (extends java.awt.peer.MenuPeer )

•  interface java.sql.PreparedStatement (extends java.sql.Statement)

•  interface java.security.Principal

•  interface java.awt.PrintGraphics

•  class java.awt.PrintJob

•  interface java.security.PrivateKey (extends java.security.Key)

•  class java.lang.Process

•  interface java.beans.PropertyChangeListener (extends java.util.EventListener )

•  class java.beans.PropertyChangeSupport (implements java.io.Serializable )

•  interface java.beans.PropertyEditor

•  class java.beans.PropertyEditorManager

•  class java.beans.PropertyEditorSupport (implements java.beans.PropertyEditor )

•  interface java.security.PublicKey (extends java.security.Key)

•  class java.rmi.server.RMIClassLoader

•  interface java.rmi.server.RMIFailureHandler

•  class java.rmi.server.RMISocketFactory

•  class java.util.Random (implements java.io.Serializable)

•  class java.security.SecureRandom

•  class java.io.RandomAccessFile  (implements java.io.DataOutput, java.io.DataInput)

•  class java.io.Reader

•  class java.io.BufferedReader

•  class java.io.LineNumberReader

•  class java.io.CharArrayReader

•  class java.io.FilterReader

•  class java.io.PushbackReader

•  class java.io.InputStreamReader

•  class java.io.FileReader

•  class java.io.PipedReader

•  class java.io.StringReader

•  class java.awt.Rectangle (implements java.awt. Shape, java.io.Serializable)

•  interface java.rmi.registry.Registry (extends java.rmi.Remote)

•  interface java.rmi.registry.RegistryHandler

•  interface java.rmi.Remote

•  interface java.rmi.server.RemoteCall

•  class sun.tools.debug.RemoteDebugger

•  class java.rmi.server.RemoteObject (implements java.rmi.Remote , java.io.Serializable)

•  class java.rmi.server.RemoteServer

•  class java.rmi.server.UnicastRemoteObject

•  class java.rmi.server.RemoteStub

•  interface java.rmi.server.RemoteRef  (extends java.io.Externalizable)

•  class sun.tools.debug.RemoteValue  (implements sun.tools.debug.AgentConstants)

•  class sun.tools.debug.RemoteBoolean

•  class sun.tools.debug.RemoteByte

•  class sun.tools.debug.RemoteChar

•  class sun.tools.debug.RemoteDouble

•  class sun.tools.debug.RemoteFloat

•  class sun.tools.debug.RemoteInt

•  class sun.tools.debug.RemoteLong

•  class sun.tools.debug.RemoteObject

•  class sun.tools.debug.RemoteArray

•  class sun.tools.debug.RemoteClass

•  class sun.tools.debug.RemoteString

•  class sun.tools.debug.RemoteThread

•  class sun.tools.debug.RemoteThreadGroup

•  class sun.tools.debug.RemoteShort

•  class java.util.ResourceBundle

•  class java.util.ListResourceBundle

•  class java.util.PropertyResourceBundle

•  interface java.sql.ResultSet

•  interface java.sql.ResultSetMetaData

•  interface java.lang.Runnable

•  class java.lang.Runtime

•  interface java.awt.peer.ScrollPanePeer (extends java.awt.peer.ContainerPeer )

•  interface java.awt.peer.ScrollbarPeer (extends java.awt.peer.ComponentPeer )

•  class java.security.Security

•  class java.lang.SecurityManager

•  class java.rmi.RMISecurityManager

•  interface java.io.Serializable

•  interface sunw.io.Serializable (extends java.io.Serializable)

•  interface java.rmi.server.ServerRef (extends java.rmi.server.RemoteRef )

•  class java.net.ServerSocket

•  interface java.awt.Shape

•  class java.security.Signature

•  class java.beans.SimpleBeanInfo (implements java.beans.BeanInfo)

•  interface java.rmi.server.Skeleton

•  class java.net.Socket

•  class java.net.SocketImpl (implements java.net.SocketOptions)

•  interface java.net.SocketImplFactory

•  class sun.tools.debug.StackFrame

•  class sun.tools.debug.RemoteStackFrame

•  interface java.sql.Statement

•  class java.io.StreamTokenizer

•  class java.lang.String (implements java.io.Serializable)

•  class java.lang.StringBuffer (implements java.io.Serializable)

•  class java.text.StringCharacterIterator (implements java.text. CharacterIterator)

•  class java.awt.datatransfer.StringSelection  (implements java.awt.datatransfer.Transferable, java.awt.datatransfer.ClipboardOwner )

•  class java.util.StringTokenizer (implements java.util.Enumeration)

•  class java.lang.System

•  interface java.awt.peer.TextAreaPeer (extends java.awt.peer. TextComponentPeer)

•  interface java.awt.peer.TextComponentPeer (extends java.awt.peer. ComponentPeer)

•  interface java.awt.peer.TextFieldPeer (extends java.awt.peer. TextComponentPeer)

•  interface java.awt.event.TextListener (extends java.util.EventListener )

•  class java.lang.Thread (implements java.lang.Runnable)

•  class java.lang.ThreadGroup

•  class java.lang.Throwable (implements java.io.Serializable)

•  class java.lang.Error

•  class java.awt.AWTError

•  class java.lang.LinkageError

•  class java.lang.ClassCircularityError

•  class java.lang.ClassFormatError

•  class java.lang.ExceptionInInitializerError

•  class java.lang.IncompatibleClassChangeError

•  class java.lang.AbstractMethodError

•  class java.lang.IllegalAccessError

•  class java.lang.InstantiationError

•  class java.lang.NoSuchFieldError

•  class java.lang.NoSuchMethodError

•  class java.lang.NoClassDefFoundError

•  class java.lang.UnsatisfiedLinkError

•  class java.lang.VerifyError

•  class java.lang.ThreadDeath

•  class java.lang.VirtualMachineError

•  class java.lang.InternalError

•  class java.lang.OutOfMemoryError

•  class java.lang.StackOverflowError

•  class java.lang.UnknownError

•  class java.lang.Exception

•  class java.awt.AWTException

•  class java.security.acl.AclNotFoundException

•  class java.rmi.AlreadyBoundException

•  class java.lang.ClassNotFoundException

•  class java.lang.CloneNotSupportedException

•  class java.rmi.server.ServerCloneException

•  class java.util.zip.DataFormatException

•  class java.security.DigestException

•  class java.io.IOException

•  class java.io.CharConversionException

•  class java.io.EOFException

•  class java.io.FileNotFoundException

•  class java.io.InterruptedIOException

•  class java.net.MalformedURLException

•  class java.io.ObjectStreamException

•  class java.io.InvalidClassException

•  class java.io.InvalidObjectException

•  class java.io.NotActiveException

•  class java.io.NotSerializableException

•  class java.io.OptionalDataException

•  class java.io.StreamCorruptedException

•  class java.io.WriteAbortedException

•  class java.net.ProtocolException

•  class java.rmi.RemoteException

•  class java.rmi.AccessException

•  class java.rmi.ConnectException

•  class java.rmi.ConnectIOException

•  class java.rmi.server.ExportException

•  class java.rmi.server.SocketSecurityException

•  class java.rmi.MarshalException

•  class java.rmi.NoSuchObjectException

•  class java.rmi.ServerError

•  class java.rmi.ServerException

•  class java.rmi.ServerRuntimeException

•  class java.rmi.server.SkeletonMismatchException

•  class java.rmi.server.SkeletonNotFoundException

•  class java.rmi.StubNotFoundException

•  class java.rmi.UnexpectedException

•  class java.rmi.UnknownHostException

•  class java.rmi.UnmarshalException

•  class java.net.SocketException

•  class java.net.BindException

•  class java.net.ConnectException

•  class java.net.NoRouteToHostException

•  class java.io.SyncFailedException

•  class java.io.UTFDataFormatException

•  class java.net.UnknownHostException

•  class java.net.UnknownServiceException

•  class java.io.UnsupportedEncodingException

•  class java.util.zip.ZipException

•  class java.lang.IllegalAccessException

•  class java.lang.InstantiationException

•  class java.lang.InterruptedException

•  class java.beans.IntrospectionException

•  class java.lang.reflect.InvocationTargetException

•  class java.security.KeyException

•  class java.security.InvalidKeyException

•  class java.security.KeyManagementException

•  class java.security.acl.LastOwnerException

•  class sun.tools.debug.NoSessionException

•  class java.security.NoSuchAlgorithmException

•  class java.lang.NoSuchFieldException

•  class sun.tools.debug.NoSuchLineNumberException

•  class java.lang.NoSuchMethodException

•  class java.security.NoSuchProviderException

•  class java.rmi.NotBoundException

•  class java.security.acl.NotOwnerException

•  class java.text.ParseException

•  class java.beans.PropertyVetoException

•  class java.lang.RuntimeException

•  class java.lang.ArithmeticException

•  class java.lang.ArrayStoreException

•  class java.lang.ClassCastException

•  class java.util.EmptyStackException

•  class java.lang.IllegalArgumentException

•  class java.text.FormatException

•  class java.lang.IllegalThreadStateException

•  class java.security.InvalidParameterException

•  class java.lang.NumberFormatException

•  class java.lang.IllegalMonitorStateException

•  class java.lang.IllegalStateException

•  class java.awt.IllegalComponentStateException

•  class java.lang.IndexOutOfBoundsException

•  class java.lang.ArrayIndexOutOfBoundsException

•  class java.lang.StringIndexOutOfBoundsException

•  class java.util.MissingResourceException

•  class java.lang.NegativeArraySizeException

•  class java.util.NoSuchElementException

•  class java.lang.NullPointerException

•  class java.security.ProviderException

•  class java.lang.SecurityException

•  class java.rmi.RMISecurityException

•  class java.sql.SQLException

•  class java.sql.SQLWarning

•  class java.sql.DataTruncation

•  class java.rmi.server.ServerNotActiveException

•  class java.security.SignatureException

•  class java.util.TooManyListenersException

•  class java.awt.datatransfer.UnsupportedFlavorException

•  class java.util.TimeZone (implements java.io. Serializable, java.lang.Cloneable)

•  class java.util.SimpleTimeZone

•  class java.awt.Toolkit

•  interface java.awt.datatransfer.Transferable

•  class java.sql.Types

•  class java.rmi.server.UID (implements java.io.Serializable)

•  class java.net.URL (implements java.io.Serializable)

•  class java.net.URLConnection

•  class java.net.HttpURLConnection

•  class java.net.URLEncoder

•  class java.net.URLStreamHandler

•  interface java.net.URLStreamHandlerFactory

•  interface java.rmi.server.Unreferenced

•  class java.rmi.dgc.VMID (implements java.io.Serializable)

•  class java.util.Vector (implements java.lang.Cloneable, java.io. Serializable)

•  class java.util.Stack

•  interface java.beans.VetoableChangeListener  (extends java.util.EventListener)

•  class java.beans.VetoableChangeSupport (implements java.io.Serializable )

•  interface java.beans.Visibility

•  class java.lang.Void

•  class java.awt.event.WindowAdapter (implements java.awt.event.WindowListener )

•  interface java.awt.event.WindowListener (extends java.util.EventListener )

•  interface java.awt.peer.WindowPeer (extends java.awt.peer.ContainerPeer )

•  class java.io.Writer

•  class java.io.BufferedWriter

•  class java.io.CharArrayWriter

•  class java.io.FilterWriter

•  class java.io.OutputStreamWriter

•  class java.io.FileWriter

•  class java.io.PipedWriter

•  class java.io.PrintWriter

•  class java.io.StringWriter

•  class java.util.zip.ZipEntry  (implements java.util.zip.ZipConstants)

•  class java.util.zip.ZipFile (implements java.util.zip.ZipConstants)

Generated using an evaluation version of HyperAct HTMheLp


URL Not Available

file:/C|/Temp/api/AllNames.html#state


URL Not Available

file:/C|/Temp/api/AllNames.html#Thumb-Z


URL Not Available

file:/C|/Temp/api/java.awt.Color.html#getBlue(int)


URL Not Available

file:/C|/Temp/api/java.awt.Color.html#getGreen(int)


URL Not Available

file:/C|/Temp/api/java.awt.Color.html#getRed(int)


URL Not Available

file:/C|/Temp/api/java.awt.Graphics.html#setClip(Shape)


URL Not Available

file:/C|/Temp/api/java.awt.MediaTracker.html#removeImage(java.awt.Image, int id)


URL Not Available

file:/C|/Temp/api/java.awt.MediaTracker.html#removeImage(java.awt.Image, int id, int width, int height)


URL Not Available

file:/C|/Temp/api/java.io.PrintStream.html#print(Object)


URL Not Available

file:/C|/Temp/api/java.io.PrintStream.html#print(String)


URL Not Available

file:/C|/Temp/api/java.lang.Character.html#forDigit(char)


URL Not Available

file:/C|/Temp/api/java.lang.Class.html#getConstructor()


URL Not Available

file:/C|/Temp/api/java.lang.Class.html#getDeclaredField()


URL Not Available

file:/C|/Temp/api/java.lang.Class.html#getDeclaredMethod()


URL Not Available

file:/C|/Temp/api/java.lang.Class.html#getField()


URL Not Available

file:/C|/Temp/api/java.lang.Class.html#getMethod()


URL Not Available

file:/C|/Temp/api/java.lang.String.html#equalsIgnoreCase(java.lang.String


URL Not Available

file:/C|/Temp/api/java.net.DatagramSocketImpl.html#getOption(int)


URL Not Available

file:/C|/Temp/api/java.net.DatagramSocketImpl.html#setOption(int, java.lang.Object)


URL Not Available

file:/C|/Temp/api/java.net.SocketImpl.html#getOption(int)


URL Not Available

file:/C|/Temp/api/java.net.SocketImpl.html#setOption(int, java.lang.Object)


URL Not Available

file:/C|/Temp/api/java.test.CollationKey.html


URL Not Available

file:/C|/Temp/api/java.text.DateFormat.html#parse(String, ParsePosition)


URL Not Available

file:/C|/Temp/api/java.text.MessageFormat.html#setPattern


URL Not Available

file:/C|/Temp/api/MessageDigest


URL Not Available

file:/C|/Temp/guide/security/Acl.html


URL Not Available

file:/C|/Temp/guide/security/cert2.html


URL Not Available

file:/C|/Temp/guide/security/CryptoSpec.html


URL Not Available

file:/C|/Temp/guide/security/CryptoSpec.html#AppA


URL Not Available

file:/C|/Temp/guide/security/CryptoSpec.html#KPG


URL Not Available

file:/C|/Temp/guide/security/CryptoSpec.html#Provider


URL Not Available

file:/C|/Temp/guide/security/CryptoSpec.html#SysIdScope


URL Not Available

file:/d|/Java/BDK10/doc/javadoc/AllNames.html#Thumb-Z


URL Not Available

file:/d|/Java/BDK10/doc/javadoc/API_users_guide.html


URL Not Available

file:/d|/Java/BDK10/doc/javadoc/java.awt.Canvas.html


URL Not Available

file:/d|/Java/BDK10/doc/javadoc/java.awt.Canvas.html#paint(java.awt.Graphics)


URL Not Available

file:/d|/Java/BDK10/doc/javadoc/java.awt.Component.html


URL Not Available

file:/d|/Java/BDK10/doc/javadoc/java.awt.Component.html#handleEvent(java.awt.Event)


URL Not Available

file:/d|/Java/BDK10/doc/javadoc/java.awt.Component.html#reshape(int, int, int, int)


URL Not Available

file:/d|/Java/BDK10/doc/javadoc/java.awt.Container.html


URL Not Available

file:/d|/Java/BDK10/doc/javadoc/java.awt.Container.html#layout()


URL Not Available

file:/d|/Java/BDK10/doc/javadoc/java.awt.Container.html#paint(java.awt.Graphics)


URL Not Available

file:/d|/Java/BDK10/doc/javadoc/java.awt.Container.html#preferredSize()


URL Not Available

file:/d|/Java/BDK10/doc/javadoc/java.io.ObjectInputStream.html


URL Not Available

file:/d|/Java/BDK10/doc/javadoc/java.io.ObjectInputStream.html#resolveClass(java.io.ObjectStreamClass)


URL Not Available

file:/d|/Java/BDK10/doc/javadoc/java.lang.ClassLoader.html


URL Not Available

file:/d|/Java/BDK10/doc/javadoc/java.lang.ClassLoader.html#getResource(java.lang.String)


URL Not Available

file:/d|/Java/BDK10/doc/javadoc/java.lang.ClassLoader.html#getResourceAsStream(java.lang.String)


URL Not Available

file:/d|/Java/BDK10/doc/javadoc/java.lang.ClassLoader.html#loadClass(java.lang.String, boolean)


URL Not Available

file:/d|/Java/BDK10/doc/javadoc/java.lang.Object.html


URL Not Available

file:/d|/Java/BDK10/doc/javadoc/java.lang.Object.html#toString()


URL Not Available

file:/d|/Java/BDK10/doc/javadoc/Package-java.util.html


URL Not Available

file:/d|/Java/BDK10/doc/javadoc/Package-sun.demo.*.html


URL Not Available

file:/d|/Java/BDK10/doc/javadoc/sun.beanbox.InputStreamProducer.html


URL Not Available

file:/d|/Java/BDK10/doc/javadoc/sun.beanbox.InputStreamProducer.html#getInputStream()


URL Not Available

file:/d|/Java/BDK10/doc/javadoc/sun.beanbox.InputStreamProducer.html#_top_


URL Not Available

ftp://ds.internic.net/rfc


URL Not Available

http://tycho.usno.navy.mil/


URL Not Available

http://tycho.usno.navy.mil/systime.html


URL Not Available

http://www.aw.com/devpress


URL Not Available

http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html


URL Not Available

http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt


URL Not Available

http://www.w3.org/pub/WWW/Protocols/