home *** CD-ROM | disk | FTP | other *** search
Text File | 1996-07-01 | 185.7 KB | 7,704 lines |
- DEF_COMPONENTNAME
- Scrollbar
- DEF_SUPERCLASS
- Component
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- awt
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // A Scrollbar component.
- DEF_ENDLIST
- DEF_METHOD
- public Scrollbar()
- // Constructs a new vertical Scrollbar.
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int getOrientation()
- // Returns the orientation for this Scrollbar.
- //
- DEF_ENDLIST
- DEF_METHOD
- public int getValue()
- // Returns the current value of this Scrollbar.
- //
- // See Also:
- // getMinimum, getMaximum
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void setValue(int value)
- // 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, it becomes the
- // new one of those values, respectively.
- // See Also:
- // getValue
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int getMinimum()
- // Returns the minimum value of this Scrollbar.
- //
- // See Also:
- // getMaximum, getValue
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int getMaximum()
- // Returns the maximum value of this Scrollbar.
- //
- // See Also:
- // getMinimum, getValue
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int getVisible()
- // Returns the visible amount of the Scrollbar.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void setLineIncrement(int l)
- // Sets the line increment for this scrollbar. This is the value
- // that will be added (subtracted) when the user hits the line down
- // (up) gadgets.
- //
- DEF_ENDLIST
- DEF_METHOD
- public int getLineIncrement()
- // Gets the line increment for this scrollbar.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void setPageIncrement(int l)
- // Sets the page increment for this scrollbar. This is the value
- // that will be added (subtracted) when the user hits the page down
- // (up) gadgets.
- //
- DEF_ENDLIST
- DEF_METHOD
- public int getPageIncrement()
- // Gets the page increment for this scrollbar.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void setValues(int value,
- int visible,
- int minimum,
- int maximum)
- // Sets the values for this Scrollbar.
- //
- // 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- protected String paramString()
- // Returns the String parameters for this Scrollbar.
- //
- // Overrides:
- // paramString in class Component
- //
- //
- DEF_ENDLIST
- DEF_PROPERTY
- LineIncrement
- int
- setLineIncrement(AVALUE);
- AVALUE = getLineIncrement();
- 0
- DEF_ENDLIST
- DEF_PROPERTY
- PageIncrement
- int
- setPageIncrement(AVALUE);
- AVALUE = getPageIncrement();
- 0
- DEF_ENDLIST
- DEF_PROPERTY
- Position
- int
- setValue(AVALUE);
- AVALUE = getValue();
- 0
- DEF_ENDLIST
- DEF_PROPERTY
- AmountVisible
- int
- setValues(getValue(), AVALUE, getMinimum(), getMaximum());
- AVALUE = getVisible();
- DEF_ENDLIST
- DEF_PROPERTY
- MinimumValue
- int
- setValues(getValue(), getVisible(), AVALUE, getMaximum());
- AVALUE = getMinimum();
- DEF_ENDLIST
- DEF_PROPERTY
- MaximumValue
- int
- setValues(getValue(), getVisible(), getMinimum(), AVALUE);
- AVALUE = getMaximum();
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- TextComponent
- DEF_SUPERCLASS
- Component
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- awt
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // A TextComponent is a component that allows the editing of some text.
- DEF_ENDLIST
- DEF_METHOD
- public synchronized 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String getText()
- // Returns the text contained in this TextComponent.
- //
- // See Also:
- // setText
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String getSelectedText()
- // Returns the selected text contained in this TextComponent.
- //
- // See Also:
- // setText
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public boolean isEditable()
- // Returns the boolean indicating whether this TextComponent is editable or not.
- //
- // See Also:
- // setEditable
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void setEditable(boolean t)
- // Sets the specified boolean to indicate whether or not this TextComponent should be
- // editable.
- //
- // Parameters:
- // t - the boolean to be set
- // See Also:
- // isEditable
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int getSelectionStart()
- // Returns the selected text's start position.
- //
- DEF_ENDLIST
- DEF_METHOD
- public int getSelectionEnd()
- // Returns the selected text's end position.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void select(int selStart,
- int selEnd)
- // Selects the text found between the specified start and end locations.
- //
- // Parameters:
- // selStart - the start position of the text
- // selEnd - the end position of the text
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void selectAll()
- // Selects all the text in the TextComponent.
- //
- DEF_ENDLIST
- DEF_METHOD
- protected String paramString()
- // Returns the String of parameters for this TextComponent.
- //
- // Overrides:
- // paramString in class Component
- //
- //
- DEF_ENDLIST
- DEF_PROPERTY
- Text
- String
- setText(AVALUE);
- AVALUE = getText();
- ""
- DEF_ENDLIST
- DEF_PROPERTY
- Editable
- boolean
- setEditable(AVALUE);
- AVALUE = isEditable();
- true
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- Toolkit
- DEF_SUPERCLASS
- Object
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- awt
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // An AWT toolkit. It is used to bind the abstract AWT classes
- // to a particular native toolkit implementation.
- DEF_ENDLIST
- DEF_METHOD
- public Toolkit()
- // Uses the specified Peer interface to create a new Button.
- //
- // Parameters:
- // target - the Button to be created
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- protected abstract TextFieldPeer createTextField(TextField target)
- // Uses the specified Peer interface to create a new TextField.
- //
- // Parameters:
- // target - the TextField to be created
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- protected abstract LabelPeer createLabel(Label target)
- // Uses the specified Peer interface to create a new Label.
- //
- // Parameters:
- // target - the Label to be created
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- protected abstract ListPeer createList(List target)
- // Uses the specified Peer interface to create a new List.
- //
- // Parameters:
- // target - the List to be created
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- protected abstract CheckboxPeer createCheckbox(Checkbox target)
- // Uses the specified Peer interface to create a new Checkbox.
- //
- // Parameters:
- // target - the Checkbox to be created
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- protected abstract ScrollbarPeer createScrollbar(Scrollbar target)
- // Uses the specified Peer interface to create a new Scrollbar.
- //
- // Parameters:
- // target - the Scrollbar to be created
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- protected abstract TextAreaPeer createTextArea(TextArea target)
- // Uses the specified Peer interface to create a new TextArea.
- //
- // Parameters:
- // target - the TextArea to be created
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- protected abstract ChoicePeer createChoice(Choice target)
- // Uses the specified Peer interface to create a new Choice.
- //
- // Parameters:
- // target - the Choice to be created
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- protected abstract FramePeer createFrame(Frame target)
- // Uses the specified Peer interface to create a new Frame.
- //
- // Parameters:
- // target - the Frame to be created
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- protected abstract CanvasPeer createCanvas(Canvas target)
- // Uses the specified Peer interface to create a new Canvas.
- //
- // Parameters:
- // target - the Canvas to be created
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- protected abstract PanelPeer createPanel(Panel target)
- // Uses the specified Peer interface to create a new Panel.
- //
- // Parameters:
- // target - the Panel to be created
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- protected abstract WindowPeer createWindow(Window target)
- // Uses the specified Peer interface to create a new Window.
- //
- // Parameters:
- // target - the Window to be created
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- protected abstract DialogPeer createDialog(Dialog target)
- // Uses the specified Peer interface to create a new Dialog.
- //
- // Parameters:
- // target - the Dialog to be created
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- protected abstract MenuBarPeer createMenuBar(MenuBar target)
- // Uses the specified Peer interface to create a new MenuBar.
- //
- // Parameters:
- // target - the MenuBar to be created
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- protected abstract MenuPeer createMenu(Menu target)
- // Uses the specified Peer interface to create a new Menu.
- //
- // Parameters:
- // target - the Menu to be created
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- protected abstract MenuItemPeer createMenuItem(MenuItem target)
- // Uses the specified Peer interface to create a new MenuItem.
- //
- // Parameters:
- // target - the MenuItem to be created
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- protected abstract FileDialogPeer createFileDialog(FileDialog target)
- // Uses the specified Peer interface to create a new FileDialog.
- //
- // Parameters:
- // target - the FileDialog to be created
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- protected abstract CheckboxMenuItemPeer createCheckboxMenuItem(CheckboxMenuItem target)
- // Uses the specified Peer interface to create a new CheckboxMenuItem.
- //
- // Parameters:
- // target - the CheckboxMenuItem to be created
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public abstract Dimension getScreenSize()
- // Gets the size of the screen.
- //
- DEF_ENDLIST
- DEF_METHOD
- public abstract int getScreenResolution()
- // Returns the screen resolution in dots-per-inch.
- //
- DEF_ENDLIST
- DEF_METHOD
- public abstract ColorModel getColorModel()
- // Returns the ColorModel of the screen.
- //
- DEF_ENDLIST
- DEF_METHOD
- public abstract String[] getFontList()
- // Returns the names of the available fonts.
- //
- DEF_ENDLIST
- DEF_METHOD
- public abstract FontMetrics getFontMetrics(Font font)
- // Returns the screen metrics of the font.
- //
- DEF_ENDLIST
- DEF_METHOD
- public abstract void sync()
- // Syncs the graphics state; useful when doing animation.
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- DEF_ENDLIST
- DEF_METHOD
- public abstract Image createImage(ImageProducer producer)
- // Creates an image with the specified image producer.
- //
- // Parameters:
- // producer - the image producer to be used
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- Window
- DEF_SUPERCLASS
- Container
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- awt
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // 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.
- DEF_ENDLIST
- DEF_METHOD
- 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:
- // resize, show
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized void pack()
- // Packs the components of the Window.
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized void dispose()
- // Disposes of the Window. This method must
- // be called to release the resources that
- // are used for the window.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void toFront()
- // Brings the frame to the front of the Window.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void toBack()
- // Sends the frame to the back of the Window.
- //
- DEF_ENDLIST
- DEF_METHOD
- public Toolkit getToolkit()
- // Returns the toolkit of this frame.
- //
- // Overrides:
- // getToolkit in class Component
- // See Also:
- // Toolkit
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- SequenceInputStream
- DEF_SUPERCLASS
- InputStream
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- io
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- java.io.SequenceInputStream
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // Converts a sequence of input streams into an InputStream.
- DEF_ENDLIST
- DEF_METHOD
- public SequenceInputStream(Enumeration e)
- // Constructs a new SequenceInputStream initialized to the
- // specified list.
- //
- // Parameters:
- // e - the list
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public SequenceInputStream(InputStream s1,
- InputStream s2)
- // Constructs a new SequenceInputStream initialized to the two
- // specified input streams.
- //
- // Parameters:
- // s1 - the first input stream
- // s2 - the second input stream
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int read() throws IOException
- // Reads a stream, and upon reaching an EOF, flips to the next
- // stream.
- //
- // Overrides:
- // read in class InputStream
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int read(byte buf[],
- int pos,
- int len) throws IOException
- // Reads data into an array of bytes, and upon reaching an EOF,
- // flips to the next stream.
- //
- // Parameters:
- // buf - the buffer into which the data is read
- // pos - the start position of the data
- // len - the maximum number of bytes read
- // Throws: IOException
- // If an I/O error has occurred.
- // Overrides:
- // read in class InputStream
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void close() throws IOException
- // Closes the input stream; flipping to the next stream,
- // if an EOF is reached. 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 InputStream
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- StreamTokenizer
- DEF_SUPERCLASS
- Object
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- io
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- java.io.StreamTokenizer
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // A class to turn an input stream into a stream of tokens.
- // There are a number of methods that define the lexical
- // syntax of tokens.
- DEF_ENDLIST
- DEF_METHOD
- public StreamTokenizer(InputStream I)
- // Creates a stream tokenizer that parses the specified input
- // stream.
- // By default, it recognizes numbers, Strings quoted with
- // single and double quotes, and all the alphabetics.
- //
- // Parameters:
- // I - the input stream
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void resetSyntax()
- // Resets the syntax table so that all characters are special.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void wordChars(int low,
- int hi)
- // Specifies that characters in this range are word characters.
- //
- // Parameters:
- // low - the low end of the range
- // hi - the high end of the range
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void whitespaceChars(int low,
- int hi)
- // Specifies that characters in this range are whitespace
- // characters.
- //
- // Parameters:
- // low - the low end of the range
- // hi - the high end of the range
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void ordinaryChars(int low,
- int hi)
- // Specifies that characters in this range are 'ordinary'.
- // Ordinary characters mean that any significance as words,
- // comments, strings, whitespaces or number characters are removed.
- // When these characters are encountered by the
- // parser, they return a ttype equal to the character.
- //
- // Parameters:
- // low - the low end of the range
- // hi - the high end of the range
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void ordinaryChar(int ch)
- // Specifies that this character is 'ordinary': it removes any
- // significance as a word, comment, string, whitespace or number
- // character. When encountered by the parser, it returns a ttype
- // equal to the character.
- //
- // Parameters:
- // ch - the character
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void commentChar(int ch)
- // Specifies that this character starts a single line comment.
- //
- // Parameters:
- // ch - the character
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void quoteChar(int ch)
- // Specifies that matching pairs of this character delimit String
- // constants. When a String constant is recognized, ttype will be
- // the character that delimits the String, and sval will have
- // the body of the String.
- //
- // Parameters:
- // ch - the character
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void parseNumbers()
- // Specifies that numbers should be parsed. This method accepts
- // double precision floating point numbers and returns a ttype of
- // TT_NUMBER with the value in nval.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void eolIsSignificant(boolean flag)
- // If the flag is true, end-of-lines are significant (TT_EOL will
- // be returned by nexttoken). If false, they will be treated
- // as whitespace.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void slashStarComments(boolean flag)
- // If the flag is true, recognize C style( /* ) comments.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void slashSlashComments(boolean flag)
- // If the flag is true, recognize C++ style( // ) comments.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void lowerCaseMode(boolean fl)
- // Examines a boolean to decide whether TT_WORD tokens are
- // forced to be lower case.
- //
- // Parameters:
- // fl - the boolean flag
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int nextToken() throws IOException
- // Parses a token from the input stream. The return value is
- // the same as the value of ttype. 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.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void pushBack()
- // Pushes back a stream token.
- //
- DEF_ENDLIST
- DEF_METHOD
- public int lineno()
- // Return the current line number.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toString()
- // Returns the String representation of the stream token.
- //
- // Overrides:
- // toString in class Object
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- StringBufferInputStream
- DEF_SUPERCLASS
- InputStream
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- io
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- java.io.StringBufferInputStream
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // This class implements a String buffer that can be
- // used as an InputStream.
- DEF_ENDLIST
- DEF_METHOD
- public StringBufferInputStream(String s)
- // Creates an StringBufferInputStream from the specified array of
- // bytes.
- //
- // Parameters:
- // s - the input buffer (not copied)
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized int read()
- // Reads a byte of data.
- //
- // Returns:
- // the byte read, or -1 if the end of the
- // stream is reached.
- // Overrides:
- // read in class InputStream
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized int read(byte b[],
- int off,
- int len)
- // Reads into an array of bytes.
- //
- // 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.
- // Overrides:
- // read in class InputStream
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized long skip(long n)
- // Skips n bytes of input.
- //
- // Parameters:
- // n - the number of bytes to be skipped
- // Returns:
- // the actual number of bytes skipped.
- // Overrides:
- // skip in class InputStream
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized int available()
- // Returns the number of available bytes in the buffer.
- //
- // Overrides:
- // available in class InputStream
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized void reset()
- // Resets the buffer to the beginning.
- //
- // Overrides:
- // reset in class InputStream
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- UTFDataFormatException
- DEF_SUPERCLASS
- IOException
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- io
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- java.io.UTFDataFormatException
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // Signals that a malformed UTF-8 string has been read in a DataInput stream.
- //
- // See Also:
- // IOException, DataInput
- //
- DEF_ENDLIST
- DEF_METHOD
- public UTFDataFormatException()
- // Constructs an UTFDataFormatException with no detail message.
- // A detail message is a String that describes this particular exception.
- //
- DEF_ENDLIST
- DEF_METHOD
- public UTFDataFormatException(String s)
- // Constructs an UTFDataFormatException with the specified detail message.
- // A detail message is a String that describes this particular exception.
- //
- // Parameters:
- // s - the detail message
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- RemoteArray
- DEF_SUPERCLASS
- RemoteObject
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // The RemoteArray class allows remote debugging of arrays.
- //
- // See Also:
- // RemoteValue, RemoteDebugger
- //
- DEF_ENDLIST
- DEF_METHOD
- public final int getSize()
- // Return the number of elements in the array.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String typeName()
- // Return this RemoteValue's type ("array").
- //
- // Overrides:
- // typeName in class RemoteObject
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String arrayTypeName(int type)
- // Return the element type as a string.
- //
- DEF_ENDLIST
- DEF_METHOD
- public final int getElementType() throws Exception
- // Return the element type as a "TC_" constant, such as "TC_CHAR".
- //
- DEF_ENDLIST
- DEF_METHOD
- 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final RemoteValue[] getElements() throws Exception
- // Returns a copy of the array as instances of RemoteValue.
- //
- DEF_ENDLIST
- DEF_METHOD
- 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String description()
- // Return a description of the array.
- //
- // Overrides:
- // description in class RemoteObject
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toString()
- // Return a string version of the array.
- //
- // Overrides:
- // toString in class RemoteObject
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- RemoteBoolean
- DEF_SUPERCLASS
- RemoteValue
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // The RemoteBoolean class extends RemoteValue for booleans.
- //
- // See Also:
- // RemoteValue, RemoteDebugger
- //
- DEF_ENDLIST
- DEF_METHOD
- public boolean get()
- // Return the boolean's value.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String typeName()
- // Print this RemoteValue's type ("boolean").
- //
- // Overrides:
- // typeName in class RemoteValue
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toString()
- // Return the boolean's value as a string.
- //
- // Overrides:
- // toString in class Object
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- RemoteByte
- DEF_SUPERCLASS
- RemoteValue
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // The RemoteByte class extends RemoteValue for bytes.
- //
- // See Also:
- // RemoteValue, RemoteDebugger
- //
- DEF_ENDLIST
- DEF_METHOD
- public byte get()
- // Return the byte's value.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String typeName()
- // Print this RemoteValue's type ("byte").
- //
- // Overrides:
- // typeName in class RemoteValue
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toString()
- // Return the byte's value as a string.
- //
- // Overrides:
- // toString in class Object
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- RemoteChar
- DEF_SUPERCLASS
- RemoteValue
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // The RemoteChar class extends RemoteValue for chars.
- //
- // See Also:
- // RemoteValue, RemoteDebugger
- //
- DEF_ENDLIST
- DEF_METHOD
- public char get()
- // Return the char's value.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String typeName()
- // Print this RemoteValue's type ("char").
- //
- // Overrides:
- // typeName in class RemoteValue
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toString()
- // Return the char's value as a string.
- //
- // Overrides:
- // toString in class Object
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- RemoteClass
- DEF_SUPERCLASS
- RemoteObject
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // The RemoteClass class allows access to a class in a remote Java
- // interpreter.
- //
- // See Also:
- // RemoteDebugger
- //
- DEF_ENDLIST
- DEF_METHOD
- public String getName() throws Exception
- // Returns the name of the class.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String typeName() throws Exception
- // Returns the name of the class as its type.
- //
- // Overrides:
- // typeName in class RemoteObject
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public boolean isInterface() throws Exception
- // Is this RemoteClass an interface?
- //
- DEF_ENDLIST
- DEF_METHOD
- public RemoteClass getSuperclass() throws Exception
- // Return the superclass for this class.
- //
- DEF_ENDLIST
- DEF_METHOD
- public RemoteObject getClassLoader() throws Exception
- // Return the classloader for this class.
- //
- DEF_ENDLIST
- DEF_METHOD
- public RemoteClass[] getInterfaces() throws Exception
- // Return the interfaces for this class.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String getSourceFileName()
- // Get the name of the source file referenced by this stackframe.
- //
- DEF_ENDLIST
- DEF_METHOD
- public InputStream getSourceFile() throws Exception
- // Get the source file referenced by this stackframe.
- //
- DEF_ENDLIST
- DEF_METHOD
- public RemoteField[] getFields() throws Exception
- // Return all the static fields for this class.
- //
- // Overrides:
- // getFields in class RemoteObject
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public RemoteField[] getStaticFields() throws Exception
- // Return all the static fields for this class.
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- DEF_ENDLIST
- DEF_METHOD
- 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
- // Overrides:
- // getField in class RemoteObject
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public RemoteField getField(String name) throws Exception
- // Return the static field, specified by name.
- //
- // Overrides:
- // getField in class RemoteObject
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public RemoteValue getFieldValue(int n) throws Exception
- // Return the value of a static field, specified by its index
- //
- // Overrides:
- // getFieldValue in class RemoteObject
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public RemoteValue getFieldValue(String name) throws Exception
- // Return the value of a static field, specified by name.
- //
- // Overrides:
- // getFieldValue in class RemoteObject
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public RemoteField getMethod(String name) throws Exception
- // Return the method, specified by name.
- //
- DEF_ENDLIST
- DEF_METHOD
- public RemoteField[] getMethods() throws Exception
- // Return the class's methods.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String[] getMethodNames() throws Exception
- // Return the names of all methods supported by this class.
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String description()
- // Return a (somewhat verbose) description.
- //
- // Overrides:
- // description in class RemoteObject
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toString()
- // Return a (somewhat verbose) description.
- //
- // Overrides:
- // toString in class RemoteObject
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- RemoteDebugger
- DEF_SUPERCLASS
- Object
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // 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.
- DEF_ENDLIST
- DEF_METHOD
- 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public RemoteDebugger(String javaArgs,
- DebuggerCallback client,
- boolean verbose) throws Exception
- // Create a remote debugger, and connect it to a new client interpreter.
- //
- // 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void close()
- // Close the connection to the remote debugging agent.
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public RemoteClass[] listClasses() throws Exception
- // List the currently known classes.
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int totalMemory() throws Exception
- // Report the total memory usage of the Java interpreter being debugged.
- //
- DEF_ENDLIST
- DEF_METHOD
- public int freeMemory() throws Exception
- // Report the free memory available to the Java interpreter being debugged.
- //
- DEF_ENDLIST
- DEF_METHOD
- 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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".
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- RemoteDouble
- DEF_SUPERCLASS
- RemoteValue
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // The RemoteDouble class extends RemoteValue for doubles.
- //
- // See Also:
- // RemoteValue, RemoteDebugger
- //
- DEF_ENDLIST
- DEF_METHOD
- public double get()
- // Return the double's value.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String typeName()
- // Print this RemoteValue's type ("double").
- //
- // Overrides:
- // typeName in class RemoteValue
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toString()
- // Return the double's value as a string.
- //
- // Overrides:
- // toString in class Object
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- RemoteField
- DEF_SUPERCLASS
- Field
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- AgentConstants
- DEF_ENDLIST
- DEF_DECLARATION
- // A RemoteField allows access to a variable or method of an object
- // or class in a remote Java interpreter.
- //
- // See Also:
- // RemoteStackVariable
- //
- DEF_ENDLIST
- DEF_METHOD
- public String getName()
- // Returns the name of the field.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String getType()
- // Returns a type string describing the field.
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- DEF_ENDLIST
- DEF_METHOD
- public boolean isStatic()
- // Returns whether the field is static (a class variable or method).
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toString()
- // Returns a String that represents the value of this Object.
- //
- // Overrides:
- // toString in class Object
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- RemoteFloat
- DEF_SUPERCLASS
- RemoteValue
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // The RemoteFloat class extends RemoteValue for floats.
- //
- // See Also:
- // RemoteValue, RemoteDebugger
- //
- DEF_ENDLIST
- DEF_METHOD
- public float get()
- // Return the float's value.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String typeName()
- // Print this RemoteValue's type ("float").
- //
- // Overrides:
- // typeName in class RemoteValue
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toString()
- // Return the float's value as a string.
- //
- // Overrides:
- // toString in class Object
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- RemoteInt
- DEF_SUPERCLASS
- RemoteValue
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // The RemoteInt class extends RemoteValue for ints.
- //
- // See Also:
- // RemoteValue, RemoteDebugger
- //
- DEF_ENDLIST
- DEF_METHOD
- public RemoteInt(int i)
- // Return the int's value.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String typeName()
- // Print this RemoteValue's type ("int").
- //
- // Overrides:
- // typeName in class RemoteValue
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toString()
- // Return the int's value as a string.
- //
- // Overrides:
- // toString in class Object
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- RemoteLong
- DEF_SUPERCLASS
- RemoteValue
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // The RemoteLong class extends RemoteValue for longs.
- //
- // See Also:
- // RemoteValue, RemoteDebugger
- //
- DEF_ENDLIST
- DEF_METHOD
- public long get()
- // Return the long's value.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String typeName()
- // Print this RemoteValue's type ("long").
- //
- // Overrides:
- // typeName in class RemoteValue
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toString()
- // Return the long's value as a string.
- //
- // Overrides:
- // toString in class Object
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- RemoteObject
- DEF_SUPERCLASS
- RemoteValue
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // 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
- //
- DEF_ENDLIST
- DEF_METHOD
- public String typeName() throws Exception
- // Returns the RemoteValue's type name ("Object").
- //
- // Overrides:
- // typeName in class RemoteValue
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final int getId()
- // Returns the id of the object.
- //
- DEF_ENDLIST
- DEF_METHOD
- public final RemoteClass getClazz()
- // Returns the object's class.
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public RemoteField[] getFields() throws Exception
- // Return the instance (non-static) fields of an object.
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String description()
- // Return a description of the object.
- //
- // Overrides:
- // description in class RemoteValue
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toString()
- // Return object as a string.
- //
- // Overrides:
- // toString in class Object
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- RemoteShort
- DEF_SUPERCLASS
- RemoteValue
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // The RemoteShort class extends RemoteValue for shorts.
- //
- // See Also:
- // RemoteValue, RemoteDebugger
- //
- DEF_ENDLIST
- DEF_METHOD
- public short get()
- // Return the short's value.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String typeName()
- // Print this RemoteValue's type ("short").
- //
- // Overrides:
- // typeName in class RemoteValue
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toString()
- // Return the short's value as a string.
- //
- // Overrides:
- // toString in class Object
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- RemoteStackFrame
- DEF_SUPERCLASS
- StackFrame
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // The RemoteStackFrame class provides access to a stackframe of a
- // suspended thread.
- //
- // See Also:
- // RemoteDebugger, RemoteThread
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- DEF_ENDLIST
- DEF_METHOD
- public RemoteStackVariable[] getLocalVariables() throws Exception
- // Return an array of all valid local variables and method arguments
- // for this stack frame.
- //
- DEF_ENDLIST
- DEF_METHOD
- public int getLineNumber()
- // Return the source file line number.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String getMethodName()
- // Get the method name referenced by this stackframe.
- //
- DEF_ENDLIST
- DEF_METHOD
- public int getPC()
- // Get the program counter referenced by this stackframe.
- //
- DEF_ENDLIST
- DEF_METHOD
- public RemoteClass getRemoteClass()
- // Get the class this stackframe references.
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- RemoteStackVariable
- DEF_SUPERCLASS
- LocalVariable
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // 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
- //
- DEF_ENDLIST
- DEF_METHOD
- public String getName()
- // Return the name of a stack variable or argument.
- //
- DEF_ENDLIST
- DEF_METHOD
- public RemoteValue getValue()
- // Return the value of a stack variable or argument.
- //
- DEF_ENDLIST
- DEF_METHOD
- public boolean inScope()
- // Return whether variable is in scope.
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- RemoteString
- DEF_SUPERCLASS
- RemoteObject
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // The RemoteString class allows access to a string in a remote Java
- // interpreter.
- //
- // See Also:
- // RemoteDebugger
- //
- DEF_ENDLIST
- DEF_METHOD
- public String typeName()
- // Print this RemoteValue's type ("String").
- //
- // Overrides:
- // typeName in class RemoteObject
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String description()
- // Return the string value, or "null"
- //
- // Overrides:
- // description in class RemoteObject
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toString()
- // Return the string value, or "null"
- //
- // Overrides:
- // toString in class RemoteObject
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- RemoteThread
- DEF_SUPERCLASS
- RemoteObject
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // The RemoteThread class allows access to a thread in a remote Java
- // interpreter.
- //
- // See Also:
- // RemoteDebugger, RemoteThreadGroup
- //
- DEF_ENDLIST
- DEF_METHOD
- public String getName() throws Exception
- // Return the name of the thread.
- //
- DEF_ENDLIST
- DEF_METHOD
- public int getCurrentFrameIndex()
- // Return the current stackframe index
- //
- DEF_ENDLIST
- DEF_METHOD
- public void setCurrentFrameIndex(int iFrame)
- // Set the current stackframe index
- //
- DEF_ENDLIST
- DEF_METHOD
- public void resetCurrentFrameIndex()
- // Reset the current stackframe
- //
- DEF_ENDLIST
- DEF_METHOD
- 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String getStatus() throws Exception
- // Return the thread status description
- //
- DEF_ENDLIST
- DEF_METHOD
- public RemoteStackFrame[] dumpStack() throws Exception
- // Dump the stack.
- //
- DEF_ENDLIST
- DEF_METHOD
- public RemoteStackFrame getCurrentFrame() throws Exception
- // Get the current stack frame.
- //
- // Throws: IllegalAccessError
- // when the thread isn't suspended or waiting at a breakpoint
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void suspend() throws Exception
- // Suspend execution of this thread.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void resume() throws Exception
- // Resume execution of this thread.
- //
- DEF_ENDLIST
- DEF_METHOD
- 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public boolean isSuspended()
- // Return whether this thread is suspended.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void cont() throws Exception
- // Resume this thread from a breakpoint, unless it previously suspended.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void stop() throws Exception
- // Stop the remote thread.
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public RemoteStackVariable[] getStackVariables() throws Exception
- // Return the arguments and local variable from the current stackframe.
- //
- // Returns:
- // an array of RemoteValues.
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- RemoteThreadGroup
- DEF_SUPERCLASS
- RemoteObject
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // The RemoteThreadGroup class allows access to a threadgroup in a
- // remote Java interpreter.
- //
- // See Also:
- // RemoteDebugger, RemoteThreadGroup
- //
- DEF_ENDLIST
- DEF_METHOD
- public String getName() throws Exception
- // Return the threadgroup's name.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void stop() throws Exception
- // Stop the remote threadgroup.
- //
- DEF_ENDLIST
- DEF_METHOD
- public RemoteThread[] listThreads(boolean recurse) throws Exception
- // List a threadgroup's threads
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- RemoteValue
- DEF_SUPERCLASS
- Object
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- AgentConstants
- DEF_ENDLIST
- DEF_DECLARATION
- // 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
- //
- DEF_ENDLIST
- DEF_METHOD
- public final int getType()
- // Returns the RemoteValue's type.
- //
- DEF_ENDLIST
- DEF_METHOD
- public final boolean isObject()
- // Returns whether the RemoteValue is an Object (as opposed to
- // a primitive type, such as int).
- //
- DEF_ENDLIST
- DEF_METHOD
- public abstract String typeName() throws Exception
- // Returns the RemoteValue's type as a string.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String description()
- // Return a description of the RemoteValue.
- //
- DEF_ENDLIST
- DEF_METHOD
- public static String toHex(int n)
- // Convert an int to a hexadecimal string.
- //
- DEF_ENDLIST
- DEF_METHOD
- public static int fromHex(String hexStr)
- // Convert hexadecimal strings to ints.
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- Runtime
- DEF_SUPERCLASS
- Object
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- DEF_ENDLIST
- DEF_METHOD
- public static Runtime getRuntime()
- // Returns the runtime.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void exit(int status)
- // Exits the virtual machine with an exit code. This method does
- // not return, use with caution.
- //
- // Parameters:
- // status - exit status, 0 if successful, other values indicate
- // various error types.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public Process exec(String command) throws IOException
- // Executes the system command specified in the parameter.
- // Returns a Process which has methods for optaining the stdin,
- // stdout, and stderr of the subprocess. This method fails if
- // executed by untrusted code.
- //
- // Parameters:
- // command - a specified system command
- // Returns:
- // an instance of class Process
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public Process exec(String command,
- String envp[]) throws IOException
- // Executes the system command specified in the parameter.
- // Returns a Process which has methods for optaining the stdin,
- // stdout, and stderr of the subprocess. This method fails if
- // executed by untrusted code.
- //
- // Parameters:
- // command - a specified system command
- // Returns:
- // an instance of class Process
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public Process exec(String cmdarray[]) throws IOException
- // Executes the system command specified by cmdarray[0] with arguments
- // specified by the strings in the rest of the array.
- // Returns a Process which has methods for optaining the stdin,
- // stdout, and stderr of the subprocess. This method fails if
- // executed by untrusted code.
- //
- // Parameters:
- // an - array containing the command to call and its arguments
- // envp - array containing environment in format name=value
- // Returns:
- // an instance of class Process
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public Process exec(String cmdarray[],
- String envp[]) throws IOException
- // Executes the system command specified by cmdarray[0] with arguments
- // specified by the strings in the rest of the array.
- // Returns a Process which has methods for optaining the stdin,
- // stdout, and stderr of the subprocess. This method fails if
- // executed by untrusted code.
- //
- // Parameters:
- // an - array containing the command to call and its arguments
- // envp - array containing environment in format name=value
- // Returns:
- // an instance of class Process
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public long freeMemory()
- // Returns the number of free bytes in system memory. This number
- // is not always accurate because it is just an estimation of the available
- // memory. More memory may be freed by calling System.gc() .
- //
- DEF_ENDLIST
- DEF_METHOD
- public long totalMemory()
- // Returns the total number of bytes in system memory.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void gc()
- // Runs the garbage collector.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void runFinalization()
- // Runs the finalization methods of any objects pending finalization.
- // Usually you will not need to call this method since finalization
- // methods will be called asynchronously by the finalization thread.
- // However, under some circumstances (like running out of a finalized
- // resource) it can be useful to run finalization methods synchronously.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void traceInstructions(boolean on)
- // Enables/Disables tracing of instructions.
- //
- // Parameters:
- // on - start tracing if true
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void traceMethodCalls(boolean on)
- // Enables/Disables tracing of method calls.
- //
- // Parameters:
- // on - start tracing if true
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized void load(String filename)
- // Loads a dynamic library, given a complete path name. If you use this
- // from java_g it will automagically insert "_g" before the ".so".
- // Example: Runtime.getRuntime().load("/home/avh/lib/libX11.so");
- //
- // Parameters:
- // filename - the file to load
- // Throws: UnsatisfiedLinkError
- // If the file does not exist.
- // See Also:
- // getRuntime
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized void loadLibrary(String libname)
- // Loads a dynamic library with the specified library name. The
- // call to LoadLibrary() should be made in the static
- // initializer of the first class that is loaded. Linking in the
- // same library more than once is ignored.
- //
- // Parameters:
- // libname - the name of the library
- // Throws: UnsatisfiedLinkError
- // If the library does not exist.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public InputStream getLocalizedInputStream(InputStream in)
- // Localize an input stream. A localized input stream will automatically
- // translate the input from the local format to UNICODE.
- //
- DEF_ENDLIST
- DEF_METHOD
- public OutputStream getLocalizedOutputStream(OutputStream out)
- // Localize an output stream. A localized output stream will automatically
- // translate the output from UNICODE to the local format.
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- RuntimeException
- DEF_SUPERCLASS
- Exception
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // An exception that can reasonably occur during the execution of a Java
- // program by the Virtual machine.
- DEF_ENDLIST
- DEF_METHOD
- public RuntimeException()
- // Constructs a RuntimeException with no detail message.
- // A detail message is a String that describes this particular exception.
- //
- DEF_ENDLIST
- DEF_METHOD
- public RuntimeException(String s)
- // Constructs a RuntimeException with the specified detail message.
- // A detail message is a String that describes this particular exception.
- //
- // Parameters:
- // s - the detail message
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- SecurityException
- DEF_SUPERCLASS
- RuntimeException
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // Signals that a security exception has occurred.
- DEF_ENDLIST
- DEF_METHOD
- public SecurityException()
- // Constructs a SecurityException with no detail message.
- // A detail message is a String that describes this particular exception.
- //
- DEF_ENDLIST
- DEF_METHOD
- public SecurityException(String s)
- // Constructs a SecurityException with the specified detail message.
- // A detail message is a String that describes this particular exception.
- //
- // Parameters:
- // s - the detail message
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- SecurityManager
- DEF_SUPERCLASS
- Object
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // An abstract class that can be subclassed
- // to implement a security policy. It allows the inspection of
- // the classloaders on the execution stack.
- DEF_ENDLIST
- DEF_METHOD
- public boolean getInCheck()
- // Returns whether there is a security check in progress.
- //
- DEF_ENDLIST
- DEF_METHOD
- protected Class[] getClassContext()
- // Gets the context of this Class.
- //
- DEF_ENDLIST
- DEF_METHOD
- protected ClassLoader currentClassLoader()
- // The current ClassLoader on the execution stack.
- //
- DEF_ENDLIST
- DEF_METHOD
- protected int classDepth(String name)
- // Return the position of the stack frame containing the
- // first occurrence of the named class.
- //
- // Parameters:
- // name - classname of the class to search for
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- protected int classLoaderDepth()
- //
- DEF_ENDLIST
- DEF_METHOD
- protected boolean inClass(String name)
- // Returns true if the specified String is in this Class.
- //
- // Parameters:
- // name - the name of the class
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- protected boolean inClassLoader()
- // Returns a boolean indicating whether or not the current ClassLoader
- // is equal to null.
- //
- DEF_ENDLIST
- DEF_METHOD
- public Object getSecurityContext()
- // Returns an implementation-dependent Object which encapsulates
- // enough information about the current execution environment
- // to perform some of the security checks later.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void checkCreateClassLoader()
- // Checks to see if the ClassLoader has been created.
- //
- // Throws: SecurityException
- // If a security error has occurred.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void checkAccess(Thread g)
- // Checks to see if the specified Thread is allowed to modify
- // the Thread group.
- //
- // Parameters:
- // g - the Thread to be checked
- // Throws: SecurityException
- // If the current Thread is not
- // allowed to access this Thread group.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void checkAccess(ThreadGroup g)
- // Checks to see if the specified Thread group is allowed to
- // modify this group.
- //
- // Parameters:
- // g - the Thread group to be checked
- // Throws: SecurityException
- // If the current Thread group is
- // not allowed to access this Thread group.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void checkExit(int status)
- // Checks to see if the system has exited the virtual
- // machine with an exit code.
- //
- // Parameters:
- // status - exit status, 0 if successful, other values
- // indicate various error types.
- // Throws: SecurityException
- // If a security error has occurred.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void checkExec(String cmd)
- // Checks to see if the system command is executed by
- // trusted code.
- //
- // Parameters:
- // cmd - the specified system command
- // Throws: SecurityException
- // If a security error has occurred.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void checkLink(String lib)
- // Checks to see if the specified linked library exists.
- //
- // Parameters:
- // lib - the name of the library
- // Throws: SecurityException
- // If the library does not exist.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void checkRead(FileDescriptor fd)
- // Checks to see if an input file with the specified
- // file descriptor object gets created.
- //
- // Parameters:
- // fd - the system dependent file descriptor
- // Throws: SecurityException
- // If a security error has occurred.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void checkRead(String file)
- // Checks to see if an input file with the specified system dependent
- // file name gets created.
- //
- // Parameters:
- // file - the system dependent file name
- // Throws: SecurityException
- // If the file is not found.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void checkRead(String file,
- Object context)
- // Checks to see if the current context or the indicated context are
- // both allowed to read the given file name.
- //
- // Parameters:
- // file - the system dependent file name
- // context - the alternate execution context which must also
- // be checked
- // Throws: SecurityException
- // If the file is not found.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void checkWrite(FileDescriptor fd)
- // Checks to see if an output file with the specified
- // file descriptor object gets created.
- //
- // Parameters:
- // fd - the system dependent file descriptor
- // Throws: SecurityException
- // If a security error has occurred.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void checkWrite(String file)
- // Checks to see if an output file with the specified system dependent
- // file name gets created.
- //
- // Parameters:
- // file - the system dependent file name
- // Throws: SecurityException
- // If the file is not found.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void checkDelete(String file)
- // Checks to see 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.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void checkConnect(String host,
- int port)
- // Checks to see if a socket has connected to the specified port on the
- // the specified host.
- //
- // Parameters:
- // host - the host name port to connect to
- // port - the protocol port to connect to
- // Throws: SecurityException
- // If a security error has occurred.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void checkConnect(String host,
- int port,
- Object context)
- // Checks to see if the current execution context and the indicated
- // execution context are both allowed to connect to the indicated
- // host and port.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void checkListen(int port)
- // Checks to see if a server socket is listening to the specified local
- // port that it is bounded to.
- //
- // Parameters:
- // port - the protocol port to connect to
- // Throws: SecurityException
- // If a security error has occurred.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void checkAccept(String host,
- int port)
- // Checks to see if a socket connection to the specified port on the
- // specified host has been accepted.
- //
- // Parameters:
- // host - the host name to connect to
- // port - the protocol port to connect to
- // Throws: SecurityException
- // If a security error has occurred.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void checkPropertiesAccess()
- // Checks to see who has access to the System properties.
- //
- // Throws: SecurityException
- // If a security error has occurred.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void checkPropertyAccess(String key)
- // Checks to see who has access to the System property named by key.
- //
- // Parameters:
- // key - the System property that the caller wants to examine
- // Throws: SecurityException
- // If a security error has occurred.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void checkPropertyAccess(String key,
- String def)
- // Checks to see who has access to the System property named by key
- // and def.
- //
- // Parameters:
- // key - the System property that the caller wants to examine
- // def - default value to return if this property is not defined
- // Throws: SecurityException
- // If a security error has occurred.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public boolean checkTopLevelWindow(Object window)
- // Checks to see if top-level windows can be created by the
- // caller. A return of false means that the window creation is
- // allowed but the window should indicate some sort of visual
- // warning. Returning true means the creation is allowed with no
- // special restrictions. To disallow the creation entirely, this
- // method should throw a SecurityException.
- //
- // Parameters:
- // window - the new window that's being created.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void checkPackageAccess(String pkg)
- // Checks to see if an applet can access a package.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void checkPackageDefinition(String pkg)
- // Checks to see if an applet can define classes in a package.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void checkSetFactory()
- // Checks to see if an applet can set a networking-related object factory.
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- StackOverflowError
- DEF_SUPERCLASS
- VirtualMachineError
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // Signals that a stack overflow has occurred.
- DEF_ENDLIST
- DEF_METHOD
- public StackOverflowError()
- // Constructs a StackOverflowError with no detail message.
- // A detail message is a String that describes this particular exception.
- //
- DEF_ENDLIST
- DEF_METHOD
- public StackOverflowError(String s)
- // Constructs a StackOverflowError with the specified detail message.
- // A detail message is a String that describes this particular exception.
- //
- // Parameters:
- // s - the detail message
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- String
- DEF_SUPERCLASS
- Object
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // A general class of objects to represent character Strings.
- // Strings are constant, their values cannot be changed after creation.
- // The compiler makes sure that each String constant actually results
- // in a String object. 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);
- //
- //
- // See Also:
- // StringBuffer
- //
- DEF_ENDLIST
- DEF_METHOD
- public String()
- // Constructs a new empty String.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String(String value)
- // Constructs a new String that is a copy of the specified String.
- //
- // Parameters:
- // value - the initial value of the String
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String(char value[])
- // Constructs a new String whose initial value is the specified array
- // of characters.
- //
- // Parameters:
- // value - the initial value of the String
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String(char value[],
- int offset,
- int count)
- // Constructs a new String whose initial value is the specified sub array of characters.
- // The length of the new string will be count characters
- // starting at offset within the specified character array.
- //
- // Parameters:
- // value - the initial value of the String, an array of characters
- // offset - the offset into the value of the String
- // count - the length of the value of the String
- // Throws: StringIndexOutOfBoundsException
- // If the offset and count arguments are invalid.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String(byte ascii[],
- int hibyte,
- int offset,
- int count)
- // Constructs a new String whose initial value is the specified sub array of bytes.
- // The high-byte of each character can be specified, it should usually be 0.
- // The length of the new String will be count characters
- // starting at offset within the specified character array.
- //
- // Parameters:
- // ascii - the bytes that will be converted to characters
- // hibyte - the high byte of each Unicode character
- // offset - the offset into the ascii array
- // count - the length of the String
- // Throws: StringIndexOutOfBoundsException
- // If the offset and count arguments are invalid.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String(byte ascii[],
- int hibyte)
- // Constructs a new String whose value is the specified array of bytes.
- // The byte array transformed into Unicode chars using hibyte
- // as the upper byte of each character.
- //
- // Parameters:
- // ascii - the byte that will be converted to characters
- // hibyte - the top 8 bits of each 16 bit Unicode character
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String(StringBuffer buffer)
- // Construct a new string whose value is the current contents of the
- // given string buffer
- //
- // Parameters:
- // buffer - the stringbuffer to be converted
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int length()
- // Returns the length of the String.
- // The length of the String is equal to the number of 16 bit
- // Unicode characters in the String.
- //
- DEF_ENDLIST
- DEF_METHOD
- 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 desired character
- // Throws: StringIndexOutOfBoundsException
- // If the index is not
- // in the range 0 to length()-1.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void getChars(int srcBegin,
- int srcEnd,
- char dst[],
- int dstBegin)
- // Copies characters from this String into the specified character array.
- // The characters of the specified substring (determined by
- // srcBegin and srcEnd) are copied into the character array,
- // starting at the array's dstBegin location.
- //
- // Parameters:
- // srcBegin - index of the first character in the string
- // srcEnd - end of the characters that are copied
- // dst - the destination array
- // dstBegin - the start offset in the destination array
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void getBytes(int srcBegin,
- int srcEnd,
- byte dst[],
- int dstBegin)
- // Copies characters from this String into the specified byte array.
- // Copies the characters of the specified substring (determined by
- // srcBegin and srcEnd) into the byte array, starting at the
- // array's dstBegin location.
- //
- // Parameters:
- // srcBegin - index of the first character in the String
- // srcEnd - end of the characters that are copied
- // dst - the destination array
- // dstBegin - the start offset in the destination array
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public boolean equals(Object anObject)
- // Compares this String to the specified object.
- // Returns true if the object is equal to this String; that is,
- // has the same length and the same characters in the same sequence.
- //
- // Parameters:
- // anObject - the object to compare this String against
- // Returns:
- // true if the Strings are equal; false otherwise.
- // Overrides:
- // equals in class Object
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public boolean equalsIgnoreCase(String anotherString)
- // Compares this String to another object.
- // Returns true if the object is equal to this String; that is,
- // has the same length and the same characters in the same sequence.
- // Upper case characters are folded to lower case before
- // they are compared.
- //
- // Parameters:
- // anotherString - the String to compare this String against
- // Returns:
- // true if the Strings are equal, ignoring case; false otherwise.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int compareTo(String anotherString)
- // Compares this String to another specified String.
- // Returns an integer that is less than, equal to, or greater than zero.
- // The integer's value depends on whether this String is less than, equal to, or greater
- // than anotherString.
- //
- // Parameters:
- // anotherString - the String to be compared
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public boolean regionMatches(int toffset,
- String other,
- int ooffset,
- int len)
- // Determines whether a region of this String matches the specified region
- // of the specified String.
- //
- // Parameters:
- // toffset - where to start looking in this String
- // other - the other String
- // ooffset - where to start looking in the other String
- // len - the number of characters to compare
- // Returns:
- // true if the region matches with the other; false otherwise.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public boolean regionMatches(boolean ignoreCase,
- int toffset,
- String other,
- int ooffset,
- int len)
- // Determines whether a region of this String matches the specified region
- // of the specified String. If the boolean ignoreCase is true, upper case characters are
- // considered equivalent to lower case letters.
- //
- // Parameters:
- // ignoreCase - if true, case is ignored
- // toffset - where to start looking in this String
- // other - the other String
- // ooffset - where to start looking in the other String
- // len - the number of characters to compare
- // Returns:
- // true if the region matches with the other; false otherwise.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public boolean startsWith(String prefix,
- int toffset)
- // Determines whether this String starts with some prefix.
- //
- // Parameters:
- // prefix - the prefix
- // toffset - where to begin looking in the the String
- // Returns:
- // true if the String starts with the specified prefix; false otherwise.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public boolean startsWith(String prefix)
- // Determines whether this String starts with some prefix.
- //
- // Parameters:
- // prefix - the prefix
- // Returns:
- // true if the String starts with the specified prefix; false otherwise.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public boolean endsWith(String suffix)
- // Determines whether the String ends with some suffix.
- //
- // Parameters:
- // suffix - the suffix
- // Returns:
- // true if the String ends with the specified suffix; false otherwise.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int hashCode()
- // Returns a hashcode for this String. This is a large
- // number composed of the character values in the String.
- //
- // Overrides:
- // hashCode in class Object
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int indexOf(int ch)
- // Returns the index within this String of the first occurrence of the specified
- // character. This method returns -1 if the index is not found.
- //
- // Parameters:
- // ch - the character to search for
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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 fromIndex. This method
- // returns -1 if the index is not found.
- //
- // Parameters:
- // ch - the character to search for
- // fromIndex - the index to start the search from
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- // This method returns -1 if the index is not found.
- //
- // Parameters:
- // ch - the character to search for
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int lastIndexOf(int ch,
- int fromIndex)
- // Returns the index within this String of the last occurrence of the specified character.
- // The String is searched backwards starting at fromIndex.
- // This method returns -1 if the index is not found.
- //
- // Parameters:
- // ch - the character to search for
- // fromIndex - the index to start the search from
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int indexOf(String str)
- // Returns the index within this String of the first occurrence of the specified substring.
- // This method returns -1 if the index is not found.
- //
- // Parameters:
- // str - the substring to search for
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int indexOf(String str,
- int fromIndex)
- // Returns the index within this String of the first occurrence of the specified substring.
- // The search is started at fromIndex.
- // This method returns -1 if the index is not found.
- //
- // Parameters:
- // str - the substring to search for
- // fromIndex - the index to start the search from
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int lastIndexOf(String str)
- // Returns the index within this String of the last occurrence of the specified substring.
- // The String is searched backwards.
- // This method returns -1 if the index is not found.
- //
- // Parameters:
- // str - the substring to search for
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int lastIndexOf(String str,
- int fromIndex)
- // Returns the index within this String of the last occurrence of the specified substring.
- // The String is searched backwards starting at fromIndex.
- // This method returns -1 if the index is not found.
- //
- // Parameters:
- // str - the substring to search for
- // fromIndex - the index to start the search from
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String substring(int beginIndex)
- // Returns the substring of this String. The substring is specified
- // by a beginIndex (inclusive) and the end of the string.
- //
- // Parameters:
- // beginIndex - the beginning index, inclusive
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String substring(int beginIndex,
- int endIndex)
- // Returns the substring of a String. The substring is specified
- // by a beginIndex (inclusive) and an endIndex (exclusive).
- //
- // Parameters:
- // beginIndex - the beginning index, inclusive
- // endIndex - the ending index, exclusive
- // Throws: StringIndexOutOfBoundsException
- // If the beginIndex or the endIndex is out
- // of range.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String concat(String str)
- // Concatenates the specified string to the end of this String.
- //
- // Parameters:
- // str - the String which is concatenated to the end of this String
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String replace(char oldChar,
- char newChar)
- // Converts this String by replacing all occurences of oldChar with newChar.
- //
- // Parameters:
- // oldChar - the old character
- // newChar - the new character
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toLowerCase()
- // Converts all of the characters in this String to lower case.
- //
- // Returns:
- // the String, converted to lowercase.
- // See Also:
- // toLowerCase, toUpperCase
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toUpperCase()
- // Converts all of the characters in this String to upper case.
- //
- // Returns:
- // the String, converted to uppercase.
- // See Also:
- // toUpperCase, toLowerCase
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String trim()
- // Trims leading and trailing whitespace from this String.
- //
- // Returns:
- // the String, with whitespace removed.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toString()
- // Converts this String to a String.
- //
- // Returns:
- // the String itself.
- // Overrides:
- // toString in class Object
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public char[] toCharArray()
- // Converts this String to a character array. This creates a new array.
- //
- // Returns:
- // an array of characters.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static String valueOf(Object obj)
- // Returns a String that represents the String value of the object.
- // The object may choose how to represent itself by implementing
- // the toString() method.
- //
- // Parameters:
- // obj - the object to be converted
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static String valueOf(char data[])
- // Returns a String that is equivalent to the specified character array.
- // Uses the original array as the body of the String (ie. it does not
- // copy it to a new array).
- //
- // Parameters:
- // data - the character array
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static String valueOf(char data[],
- int offset,
- int count)
- // Returns a String that is equivalent to the specified character array.
- //
- // Parameters:
- // data - the character array
- // offset - the offset into the value of the String
- // count - the length of the value of the String
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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 - the offset into the value of the String
- // count - the length of the value of the String
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static String valueOf(boolean b)
- // Returns a String object that represents the state of the specified boolean.
- //
- // Parameters:
- // b - the boolean
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static String valueOf(char c)
- // Returns a String object that contains a single character
- //
- // Parameters:
- // c - the character
- // Returns:
- // the resulting String.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static String valueOf(int i)
- // Returns a String object that represents the value of the specified integer.
- //
- // Parameters:
- // i - the integer
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static String valueOf(long l)
- // Returns a String object that represents the value of the specified long.
- //
- // Parameters:
- // l - the long
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static String valueOf(float f)
- // Returns a String object that represents the value of the specified float.
- //
- // Parameters:
- // f - the float
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static String valueOf(double d)
- // Returns a String object that represents the value of the specified double.
- //
- // Parameters:
- // d - the double
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String intern()
- // Returns a String that is equal to this String
- // but which is guaranteed to be from the unique String pool. For example:
- // s1.intern() == s2.intern() s1.equals(s2).
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- StringBuffer
- DEF_SUPERCLASS
- Object
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // This Class is a growable buffer for characters. It is mainly used
- // to create Strings. The compiler uses it to implement the "+" operator.
- // For example:
- //
- // "a" + 4 + "c"
- //
- // is compiled to:
- //
- // new StringBuffer().append("a").append(4).append("c").toString()
- //
- // Note that the method toString() does not create a copy of the internal buffer. Instead
- // the buffer is marked as shared. Any further changes to the buffer will
- // cause a copy to be made.
- //
- // See Also:
- // String, ByteArrayOutputStream
- //
- DEF_ENDLIST
- DEF_METHOD
- public StringBuffer()
- // Constructs an empty String buffer.
- //
- DEF_ENDLIST
- DEF_METHOD
- public StringBuffer(int length)
- // Constructs an empty String buffer with the specified initial length.
- //
- // Parameters:
- // length - the initial length
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public StringBuffer(String str)
- // Constructs a String buffer with the specified initial value.
- //
- // Parameters:
- // str - the initial value of the buffer
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int length()
- // Returns the length (character count) of the buffer.
- //
- DEF_ENDLIST
- DEF_METHOD
- 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.
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized void ensureCapacity(int minimumCapacity)
- // Ensures that the capacity of the buffer is at least equal to the
- // specified minimum.
- //
- // Parameters:
- // minimumCapacity - the minimum desired capacity
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized void setLength(int newLength)
- // Sets the length of the String. If the length is reduced, characters
- // are lost. If the length is extended, the values of the new characters
- // are set to 0.
- //
- // Parameters:
- // newLength - the new length of the buffer
- // Throws: StringIndexOutOfBoundsException
- // If the length is invalid.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized char charAt(int index)
- // Returns the character at the specified index. An index ranges
- // from 0..length()-1.
- //
- // Parameters:
- // index - the index of the desired character
- // Throws: StringIndexOutOfBoundsException
- // If the index is invalid.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized void getChars(int srcBegin,
- int srcEnd,
- char dst[],
- int dstBegin)
- // Copies the characters of the specified substring (determined by
- // srcBegin and srcEnd) into the character array, starting at the
- // array's dstBegin location. Both srcBegin and srcEnd must be legal
- // indexes into the buffer.
- //
- // Parameters:
- // srcBegin - begin copy at this offset in the String
- // srcEnd - stop copying at this offset in the String
- // dst - the array to copy the data into
- // dstBegin - offset into dst
- // Throws: StringIndexOutOfBoundsException
- // If there is an invalid index into the buffer.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized void setCharAt(int index,
- char ch)
- // Changes the character at the specified index to be ch.
- //
- // Parameters:
- // index - the index of the character
- // ch - the new character
- // Throws: StringIndexOutOfBoundsException
- // If the index is invalid.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized StringBuffer append(Object obj)
- // Appends an object to the end of this buffer.
- //
- // Parameters:
- // obj - the object to be appended
- // Returns:
- // the StringBuffer itself, NOT a new one.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized StringBuffer append(String str)
- // Appends a String to the end of this buffer.
- //
- // Parameters:
- // str - the String to be appended
- // Returns:
- // the StringBuffer itself, NOT a new one.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized StringBuffer append(char str[])
- // Appends an array of characters to the end of this buffer.
- //
- // Parameters:
- // str - the characters to be appended
- // Returns:
- // the StringBuffer itself, NOT a new one.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized StringBuffer append(char str[],
- int offset,
- int len)
- // Appends a part of an array of characters to the end of this buffer.
- //
- // Parameters:
- // str - the characters to be appended
- // offset - where to start
- // len - the number of characters to add
- // Returns:
- // the StringBuffer itself, NOT a new one.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public StringBuffer append(boolean b)
- // Appends a boolean to the end of this buffer.
- //
- // Parameters:
- // b - the boolean to be appended
- // Returns:
- // the StringBuffer itself, NOT a new one.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized StringBuffer append(char c)
- // Appends a character to the end of this buffer.
- //
- // Parameters:
- // ch - the character to be appended
- // Returns:
- // the StringBuffer itself, NOT a new one.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public StringBuffer append(int i)
- // Appends an integer to the end of this buffer.
- //
- // Parameters:
- // i - the integer to be appended
- // Returns:
- // the StringBuffer itself, NOT a new one.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public StringBuffer append(long l)
- // Appends a long to the end of this buffer.
- //
- // Parameters:
- // l - the long to be appended
- // Returns:
- // the StringBuffer itself, NOT a new one.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public StringBuffer append(float f)
- // Appends a float to the end of this buffer.
- //
- // Parameters:
- // f - the float to be appended
- // Returns:
- // the StringBuffer itself, NOT a new one.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public StringBuffer append(double d)
- // Appends a double to the end of this buffer.
- //
- // Parameters:
- // d - the double to be appended
- // Returns:
- // the StringBuffer itself, NOT a new one.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized StringBuffer insert(int offset,
- Object obj)
- // Inserts an object into the String buffer.
- //
- // Parameters:
- // offset - the offset at which to insert
- // obj - the object to insert
- // Returns:
- // the StringBuffer itself, NOT a new one.
- // Throws: StringIndexOutOfBoundsException
- // If the offset is invalid.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized StringBuffer insert(int offset,
- String str)
- // Inserts a String into the String buffer.
- //
- // Parameters:
- // offset - the offset at which to insert
- // str - the String to insert
- // Returns:
- // the StringBuffer itself, NOT a new one.
- // Throws: StringIndexOutOfBoundsException
- // If the offset is invalid.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized StringBuffer insert(int offset,
- char str[])
- // Inserts an array of characters into the String buffer.
- //
- // Parameters:
- // offset - the offset at which to insert
- // str - the characters to insert
- // Returns:
- // the StringBuffer itself, NOT a new one.
- // Throws: StringIndexOutOfBoundsException
- // If the offset is invalid.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public StringBuffer insert(int offset,
- boolean b)
- // Inserts a boolean into the String buffer.
- //
- // Parameters:
- // offset - the offset at which to insert
- // b - the boolean to insert
- // Returns:
- // the StringBuffer itself, NOT a new one.
- // Throws: StringIndexOutOfBoundsException
- // If the offset is invalid.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized StringBuffer insert(int offset,
- char c)
- // Inserts a character into the String buffer.
- //
- // Parameters:
- // offset - the offset at which to insert
- // ch - the character to insert
- // Returns:
- // the StringBuffer itself, NOT a new one.
- // Throws: StringIndexOutOfBoundsException
- // If the offset invalid.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public StringBuffer insert(int offset,
- int i)
- // Inserts an integer into the String buffer.
- //
- // Parameters:
- // offset - the offset at which to insert
- // i - the integer to insert
- // Returns:
- // the StringBuffer itself, NOT a new one.
- // Throws: StringIndexOutOfBoundsException
- // If the offset is invalid.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public StringBuffer insert(int offset,
- long l)
- // Inserts a long into the String buffer.
- //
- // Parameters:
- // offset - the offset at which to insert
- // l - the long to insert
- // Returns:
- // the StringBuffer itself, NOT a new one.
- // Throws: StringIndexOutOfBoundsException
- // If the offset is invalid.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public StringBuffer insert(int offset,
- float f)
- // Inserts a float into the String buffer.
- //
- // Parameters:
- // offset - the offset at which to insert
- // f - the float to insert
- // Returns:
- // the StringBuffer itself, NOT a new one.
- // Throws: StringIndexOutOfBoundsException
- // If the offset is invalid.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public StringBuffer insert(int offset,
- double d)
- // Inserts a double into the String buffer.
- //
- // Parameters:
- // offset - the offset at which to insert
- // d - the double to insert
- // Returns:
- // the StringBuffer itself, NOT a new one.
- // Throws: StringIndexOutOfBoundsException
- // If the offset is invalid.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toString()
- // Converts to a String representing the data in the buffer.
- //
- // Overrides:
- // toString in class Object
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- StringIndexOutOfBoundsException
- DEF_SUPERCLASS
- IndexOutOfBoundsException
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- IndexOutOfBoundsException
- DEF_ENDLIST
- DEF_DECLARATION
- // Signals that a String index is out of range.
- //
- // See Also:
- // charAt
- //
- DEF_ENDLIST
- DEF_METHOD
- public StringIndexOutOfBoundsException()
- // Constructs a StringIndexOutOfBoundsException with no detail message.
- // A detail message is a String that describes this particular exception.
- //
- DEF_ENDLIST
- DEF_METHOD
- public StringIndexOutOfBoundsException(String s)
- // Constructs a StringIndexOutOfBoundsException with the specified detail message.
- // A detail message is a String that describes this particular exception.
- //
- // Parameters:
- // s - the String containing a detail message about the error
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public StringIndexOutOfBoundsException(int index)
- // Constructs a StringIndexOutOfBoundsException initialized with
- // the specified index.
- //
- // Parameters:
- // index - the offending index
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- System
- DEF_SUPERCLASS
- Object
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // This Class provides a system-independent interface to system
- // functionality. One of the more useful things provided by this Class
- // are the standard input and output streams. The standard input streams are
- // used for reading character data. The standard output streams are used for
- // printing. For example:
- //
- // System.out.println("Hello World!");
- //
- // This Class cannot be instantiated or subclassed because all of the methods
- // and variables are static.
- DEF_ENDLIST
- DEF_METHOD
- public static void setSecurityManager(SecurityManager s)
- // Sets the System security. This value can only be set once.
- //
- // Parameters:
- // s - the security manager
- // Throws: SecurityException
- // If the SecurityManager has already been set.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static SecurityManager getSecurityManager()
- // Gets the system security interface.
- //
- DEF_ENDLIST
- DEF_METHOD
- public static long currentTimeMillis()
- // Returns the current time in milliseconds GMT since the epoch (00:00:00
- // UTC, January 1, 1970). It is a signed 64 bit integer, and so it will
- // not overflow until the year 292280995.
- //
- // See Also:
- // Date
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static void arraycopy(Object src,
- int src_position,
- Object dst,
- int dst_position,
- int length)
- // Copies an array from the source array, beginning at the
- // specified position, to the specified position of the destination array.
- // This method does not allocate memory for the destination array. The
- // memory must already be allocated.
- //
- // Parameters:
- // src - the source data
- // srcpos - start position in the source data
- // dest - the destination
- // destpos - start position in the destination data
- // length - the number of array elements to be copied
- // Throws: ArrayIndexOutOfBoundsException
- // If copy would cause
- // access of data outside array bounds.
- // Throws: ArrayStoreException
- // If an element in the src array could
- // could not be stored into the destination array due
- // to a type mismatch
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static Properties getProperties()
- // Gets the System properties.
- //
- DEF_ENDLIST
- DEF_METHOD
- public static void setProperties(Properties props)
- // Sets the System properties to the specified properties.
- //
- // Parameters:
- // props - the properties to be set
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static String getProperty(String key)
- // Gets the System property indicated by the specified key.
- //
- // Parameters:
- // key - the name of the system property
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static String getProperty(String key,
- String def)
- // Gets the System property indicated by the specified key and def.
- //
- // Parameters:
- // key - the name of the system property
- // def - the default value to use if this property is not set
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static String getenv(String name)
- // Obsolete.
- // Gets an environment variable. An environment variable is a
- // system dependent external variable that has a string value.
- //
- // Parameters:
- // name - the name of the environment variable
- // Returns:
- // the value of the variable, or null if the variable is
- // not defined.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static void exit(int status)
- // Exits the virtual machine with an exit code. This method does
- // not return, use with caution.
- //
- // Parameters:
- // status - exit status, 0 if successful, other values indicate
- // various error types.
- // See Also:
- // exit
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static void gc()
- // Runs the garbage collector.
- //
- // See Also:
- // gc
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static void runFinalization()
- // Runs the finalization methods of any objects pending finalization.
- //
- // See Also:
- // gc
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static void load(String filename)
- // Loads a dynamic library, given a complete path name.
- //
- // Parameters:
- // filename - the file to load
- // Throws: UnsatisfiedLinkError
- // If the file does not exist.
- // See Also:
- // load
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static void loadLibrary(String libname)
- // Loads a dynamic library with the specified library name.
- //
- // Parameters:
- // libname - the name of the library
- // Throws: UnsatisfiedLinkError
- // If the library does not exist.
- // See Also:
- // loadLibrary
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- Thread
- DEF_SUPERCLASS
- Object
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- Runnable
- DEF_ENDLIST
- DEF_DECLARATION
- // A Thread is a single sequential flow of control within a process. This simply means
- // that while executing within a program, each thread has a beginning, a sequence, a
- // point of execution occurring at any time during runtime of the thread and of course, an ending.
- // Thread objects are the basis for multi-threaded programming. Multi-threaded programming
- // allows a single program to conduct concurrently running threads that perform different tasks.
- //
- // To create a new thread of execution, declare a new class which is a
- // subclass of Thread and then override the run() method with code that you
- // want executed in this Thread. An instance of the Thread subclass should be created next
- // with a call to the start() method following the instance. The start() method will create the
- // thread and execute the run() method.
- // For example:
- //
- // class PrimeThread extends Thread {
- // public void run() {
- // // compute primes...
- // }
- // }
- //
- // To start this thread you need to do the following:
- //
- // PrimeThread p = new PrimeThread();
- // p.start();
- // ...
- //
- // Another way to create a thread is by using the Runnable interface.
- // This way any object that implements the Runnable interface can be
- // run in a thread. For example:
- //
- // class Primes implements Runnable {
- // public void run() {
- // // compute primes...
- // }
- // }
- //
- // To start this thread you need to do the following:
- //
- // Primes p = new Primes();
- // new Thread(p).start();
- // ...
- //
- // The virtual machine runs until all Threads that are not daemon Threads
- // have died. A Thread dies when its run() method returns, or when the
- // stop() method is called.
- //
- // When a new Thread is created, it inherits the priority and the
- // daemon flag from its parent (i.e.: the Thread that created it).
- //
- // See Also:
- // Runnable
- //
- DEF_ENDLIST
- DEF_METHOD
- public Thread()
- // Constructs a new Thread. Threads created this way must have
- // overridden their run() method to actually do anything. An example
- // illustrating this method being used is shown.
- //
- // 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++;
- // }
- // }
- //
- DEF_ENDLIST
- DEF_METHOD
- public Thread(Runnable target)
- // Constructs a new Thread which applies the run() method of
- // the specified target.
- //
- // Parameters:
- // target - the object whose run() method is called
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public Thread(ThreadGroup group,
- Runnable target)
- // Constructs a new Thread in the specified Thread group that applies the run() method of
- // the specified target.
- //
- // Parameters:
- // group - the Thread group
- // target - the object whose run() method is called
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public Thread(String name)
- // Constructs a new Thread with the specified name.
- //
- // Parameters:
- // name - the name of the new Thread
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public Thread(ThreadGroup group,
- String name)
- // Constructs a new Thread in the specified Thread group with the specified name.
- //
- // Parameters:
- // group - the Thread group
- // name - the name of the new Thread
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public Thread(Runnable target,
- String name)
- // Constructs a new Thread with the specified name and applies
- // the run() method of the specified target.
- //
- // Parameters:
- // target - the object whose run() method is called
- // name - the name of the new Thread
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public Thread(ThreadGroup group,
- Runnable target,
- String name)
- // Constructs a new Thread in the specified Thread group with the specified name and
- // applies the run() method of the specified target.
- //
- // Parameters:
- // group - the Thread group
- // target - the object whose run() method is called
- // name - the name of the new Thread
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static Thread currentThread()
- // Returns a reference to the currently executing Thread object.
- //
- DEF_ENDLIST
- DEF_METHOD
- public static void yield()
- // Causes the currently executing Thread object to yield.
- // If there are other runnable Threads they will be
- // scheduled next.
- //
- DEF_ENDLIST
- DEF_METHOD
- public static void sleep(long millis) throws InterruptedException
- // Causes the currently executing Thread to sleep for the specified
- // number of milliseconds.
- //
- // Parameters:
- // millis - the length of time to sleep in milliseconds
- // Throws: InterruptedException
- // Another thread has interrupted this thread.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static void sleep(long millis,
- int nanos) throws InterruptedException
- // Sleep, in milliseconds and additional nanosecond.
- //
- // Parameters:
- // millis - the length of time to sleep in milliseconds
- // nanos - 0-999999 additional nanoseconds to sleep
- // Throws: InterruptedException
- // Another thread has interrupted this thread.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized void start()
- // Starts this Thread. This will cause the run() method to
- // be called. This method will return immediately.
- //
- // Throws: IllegalThreadStateException
- // If the thread was already started.
- // See Also:
- // run, stop
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void run()
- // The actual body of this Thread. This method is called after
- // the Thread is started. You must either override this
- // method by subclassing class Thread, or you must create
- // the Thread with a Runnable target.
- //
- // See Also:
- // start, stop
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final void stop()
- // Stops a Thread by tossing an object. By default this
- // routine tosses a new instance of ThreadDeath to the target
- // Thread. ThreadDeath is not actually a subclass of Exception,
- // but is a subclass of Object. Users should not normally try
- // to catch ThreadDeath unless they must do some extraordinary
- // cleanup operation. If ThreadDeath is caught it is important
- // to rethrow the object so that the thread will actually die.
- // The top-level error handler will not print out a message if
- // ThreadDeath falls through.
- //
- // See Also:
- // start, run
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized void stop(Throwable o)
- // Stops a Thread by tossing an object. Normally, users should
- // just call the stop() method without any argument. However, in some
- // exceptional circumstances used by the stop() method to kill a Thread,
- // another object is tossed. ThreadDeath, is not actually a subclass
- // of Exception, but is a subclass of Throwable
- //
- // Parameters:
- // o - the Throwable object to be thrown
- // See Also:
- // start, run
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void interrupt()
- // Send an interrupt to a thread.
- //
- DEF_ENDLIST
- DEF_METHOD
- public static boolean interrupted()
- // Ask if you have been interrupted.
- //
- DEF_ENDLIST
- DEF_METHOD
- public boolean isInterrupted()
- // Ask if another thread has been interrupted.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void destroy()
- // Destroy a thread, without any cleanup, i.e. just toss its state;
- // any monitors it has locked remain locked. A last resort.
- //
- DEF_ENDLIST
- DEF_METHOD
- public final boolean isAlive()
- // Returns a boolean indicating if the Thread is active. Having an
- // active Thread means that the Thread has been started and has not
- // been stopped.
- //
- DEF_ENDLIST
- DEF_METHOD
- public final void suspend()
- // Suspends this Thread's execution.
- //
- DEF_ENDLIST
- DEF_METHOD
- public final void resume()
- // Resumes this Thread execution. This method is only valid after suspend()
- // has been invoked.
- //
- DEF_ENDLIST
- DEF_METHOD
- public final void setPriority(int newPriority)
- // Sets the Thread's priority.
- //
- // Throws: IllegalArgumentException
- // If the priority is not within the
- // range MIN_PRIORITY, MAX_PRIORITY.
- // See Also:
- // MIN_PRIORITY, MAX_PRIORITY, getPriority
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final int getPriority()
- // Gets and returns the Thread's priority.
- //
- // See Also:
- // setPriority
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final void setName(String name)
- // Sets the Thread's name.
- //
- // Parameters:
- // name - the new name of the Thread
- // See Also:
- // getName
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final String getName()
- // Gets and returns this Thread's name.
- //
- // See Also:
- // setName
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final ThreadGroup getThreadGroup()
- // Gets and returns this Thread group.
- //
- DEF_ENDLIST
- DEF_METHOD
- public static int activeCount()
- // Returns the current number of active Threads in this Thread group.
- //
- DEF_ENDLIST
- DEF_METHOD
- public static int enumerate(Thread tarray[])
- // Copies, into the specified array, references to every active Thread in this
- // Thread's group.
- //
- // Returns:
- // the number of Threads put into the array.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int countStackFrames()
- // Returns the number of stack frames in this Thread. The Thread
- // must be suspended when this method is called.
- //
- // Throws: IllegalThreadStateException
- // If the Thread is not suspended.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized void join(long millis) throws InterruptedException
- // Waits for this Thread to die. A timeout in milliseconds can
- // be specified. A timeout of 0 milliseconds means to wait
- // forever.
- //
- // Parameters:
- // millis - the time to wait in milliseconds
- // Throws: InterruptedException
- // Another thread has interrupted this thread.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized void join(long millis,
- int nanos) throws InterruptedException
- // Waits for the Thread to die, with more precise time.
- //
- // Throws: InterruptedException
- // Another thread has interrupted this thread.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final void join() throws InterruptedException
- // Waits forever for this Thread to die.
- //
- // Throws: InterruptedException
- // Another thread has interrupted this thread.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static void dumpStack()
- // A debugging procedure to print a stack trace for the
- // current Thread.
- //
- // See Also:
- // printStackTrace
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final void setDaemon(boolean on)
- // Marks this Thread as a daemon Thread or a user Thread.
- // When there are only daemon Threads left running in the
- // system, Java exits.
- //
- // Parameters:
- // on - determines whether the Thread will be a daemon Thread
- // Throws: IllegalThreadStateException
- // If the Thread is active.
- // See Also:
- // isDaemon
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final boolean isDaemon()
- // Returns the daemon flag of the Thread.
- //
- // See Also:
- // setDaemon
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void checkAccess()
- // Checks whether the current Thread is allowed to modify this Thread.
- //
- // Throws: SecurityException
- // If the current Thread is not allowed
- // to access this Thread group.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toString()
- // Returns a String representation of the Thread, including the
- // thread's name, priority and thread group.
- //
- // Overrides:
- // toString in class Object
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- ThreadDeath
- DEF_SUPERCLASS
- Error
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // An instance of ThreadDeath is thrown in the victim thread when
- // thread.stop() is called. This is not a subclass of Exception,
- // but rather a subclass of Error because too many people
- // already catch Exception. Instances of this class should be caught
- // explicitly only if you are interested in cleaning up when being
- // asynchronously terminated. If ThreadDeath is caught, it is important
- // to rethrow the object so that the Thread will actually die. The top-level
- // error handler will not print out a message if ThreadDeath falls through.
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- ThreadGroup
- DEF_SUPERCLASS
- Object
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // A group of Threads. A Thread group can contain a set of Threads
- // as well as a set of other Thread groups. A Thread can access its
- // Thread group, but it can't access the parent of its Thread group.
- // This makes it possible to encapsulate a Thread in a Thread group
- // and stop it from manipulating Threads in the parent group.
- DEF_ENDLIST
- DEF_METHOD
- public ThreadGroup(String name)
- // Creates a new ThreadGroup. Its parent will be the Thread group
- // of the current Thread.
- //
- // Parameters:
- // name - the name of the new Thread group created
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public ThreadGroup(ThreadGroup parent,
- String name)
- // Creates a new ThreadGroup with a specified name in the specified Thread group.
- //
- // Parameters:
- // parent - the specified parent Thread group
- // name - the name of the new Thread group being created
- // Throws: NullPointerException
- // If the given thread group is equal to null.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final String getName()
- // Gets the name of this Thread group.
- //
- DEF_ENDLIST
- DEF_METHOD
- public final ThreadGroup getParent()
- // Gets the parent of this Thread group.
- //
- DEF_ENDLIST
- DEF_METHOD
- public final int getMaxPriority()
- // Gets the maximum priority of the group. Threads that are
- // part of this group cannot have a higher priority than the maximum priority.
- //
- DEF_ENDLIST
- DEF_METHOD
- public final boolean isDaemon()
- // Returns the daemon flag of the Thread group. A daemon Thread group
- // is automatically destroyed when it is found empty after a Thread
- // group or Thread is removed from it.
- //
- DEF_ENDLIST
- DEF_METHOD
- public final void setDaemon(boolean daemon)
- // Changes the daemon status of this group.
- //
- // Parameters:
- // daemon - the daemon boolean which is to be set.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized void setMaxPriority(int pri)
- // Sets the maximum priority of the group. Threads
- // that are already in the group can have a higher priority than the
- // set maximum.
- //
- // Parameters:
- // pri - the priority of the Thread group
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final boolean parentOf(ThreadGroup g)
- // Checks to see if this Thread group is a parent of or is equal to
- // another Thread group.
- //
- // Parameters:
- // g - the Thread group to be checked
- // Returns:
- // true if this Thread group is equal to or is the parent of another Thread
- // group; false otherwise.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final void checkAccess()
- // Checks to see if the current Thread is allowed to modify this group.
- //
- // Throws: SecurityException
- // If the current Thread is not allowed
- // to access this Thread group.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized int activeCount()
- // Returns an estimate of the number of active Threads in the
- // Thread group.
- //
- DEF_ENDLIST
- DEF_METHOD
- public int enumerate(Thread list[])
- // Copies, into the specified array, references to every active Thread in this Thread group.
- // You can use the activeCount() method to get an estimate of how big
- // the array should be.
- //
- // Parameters:
- // list - an array of Threads
- // Returns:
- // the number of Threads put into the array
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int enumerate(Thread list[],
- boolean recurse)
- // Copies, into the specified array, references to every active Thread in this Thread group.
- // You can use the activeCount() method to get an estimate of how big
- // the array should be.
- //
- // Parameters:
- // list - an array list of Threads
- // recurse - a boolean indicating whether a Thread has reapearred
- // Returns:
- // the number of Threads placed into the array.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized int activeGroupCount()
- // Returns an estimate of the number of active groups in the
- // Thread group.
- //
- DEF_ENDLIST
- DEF_METHOD
- public int enumerate(ThreadGroup list[])
- // Copies, into the specified array, references to every active Thread group in this Thread
- // group. You can use the activeGroupCount() method to get an estimate of how big
- // the array should be.
- //
- // Parameters:
- // list - an array of Thread groups
- // Returns:
- // the number of Thread groups placed into the array.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int enumerate(ThreadGroup list[],
- boolean recurse)
- // Copies, into the specified array, references to every active Thread group in this Thread
- // group. You can use the activeGroupCount() method to get an estimate of how big
- // the array should be.
- //
- // Parameters:
- // list - an array list of Thread groups
- // recurse - a boolean indicating if a Thread group has reappeared
- // Returns:
- // the number of Thread groups placed into the array.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized void stop()
- // Stops all the Threads in this Thread group and all of its sub groups.
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized void suspend()
- // Suspends all the Threads in this Thread group and all of its sub groups.
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized void resume()
- // Resumes all the Threads in this Thread group and all of its sub groups.
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized void destroy()
- // Destroys a Thread group. This does NOT stop the Threads
- // in the Thread group.
- //
- // Throws: IllegalThreadStateException
- // If the Thread group is not empty
- // or if the Thread group was already destroyed.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized void list()
- // Lists this Thread group. Useful for debugging only.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void uncaughtException(Thread t,
- Throwable e)
- // Called when a thread in this group exists because of
- // an uncaught exception.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toString()
- // Returns a String representation of the Thread group.
- //
- // Overrides:
- // toString in class Object
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- Throwable
- DEF_SUPERCLASS
- Object
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // An object signalling that an exceptional condition has occurred.
- // All exceptions are a subclass of Exception. An exception contains
- // a snapshot of the execution stack, this snapshot is used to print
- // a stack backtrace. An exception also contains a message string.
- // Here is an example of how to catch an exception:
- //
- // try {
- // int a[] = new int[2];
- // a[4];
- // } catch (ArrayIndexOutOfBoundsException e) {
- // System.out.println("an exception occurred: " + e.getMessage());
- // e.printStackTrace();
- // }
- //
- DEF_ENDLIST
- DEF_METHOD
- public Throwable()
- // Constructs a new Throwable with no detail message. The stack
- // trace is automatically filled in.
- //
- DEF_ENDLIST
- DEF_METHOD
- public Throwable(String message)
- // Constructs a new Throwable with the specified detail message.
- // The stack trace is automatically filled in.
- //
- // Parameters:
- // message - the detailed message
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String getMessage()
- // Gets the detail message of the Throwable. A detail message
- // is a String that describes the Throwable that has taken place.
- //
- // Returns:
- // the detail message of the throwable.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toString()
- // Returns a short description of the Throwable.
- //
- // Overrides:
- // toString in class Object
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void printStackTrace()
- // Prints the Throwable and the Throwable's stack trace.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void printStackTrace(PrintStream s)
- // Fills in the excecution stack trace. This is useful only
- // when rethrowing a Throwable. For example:
- //
- //
- // try {
- // a = b / c;
- // } catch(ArithmeticThrowable e) {
- // a = Number.MAX_VALUE;
- // throw e.fillInStackTrace();
- // }
- //
- //
- // Returns:
- // the Throwable itself.
- // See Also:
- // printStackTrace
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- UnknownError
- DEF_SUPERCLASS
- VirtualMachineError
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // Signals that an unknown but serious exception has occurred.
- DEF_ENDLIST
- DEF_METHOD
- public UnknownError()
- // Constructs an UnknownError with no detail message.
- // A detail message is a String that describes this particular exception.
- //
- DEF_ENDLIST
- DEF_METHOD
- public UnknownError(String s)
- // Constructs an UnknownError with the specified detail message.
- // A detail message is a String that describes this particular exception.
- //
- // Parameters:
- // s - the detail message
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- UnsatisfiedLinkError
- DEF_SUPERCLASS
- LinkageError
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // Signals an unsatisfied link.
- //
- // See Also:
- // Runtime
- //
- DEF_ENDLIST
- DEF_METHOD
- public UnsatisfiedLinkError()
- // Constructs an UnsatisfiedLinkError with no detail message.
- // A detail message is a String that describes this particular exception.
- //
- DEF_ENDLIST
- DEF_METHOD
- public UnsatisfiedLinkError(String s)
- // Constructs an UnsatisfiedLinkError with the specified detail message.
- // A detail message is a String that describes this particular exception.
- //
- // Parameters:
- // s - the detail message
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- VerifyError
- DEF_SUPERCLASS
- LinkageError
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // Signals that a Verification Error occured.
- DEF_ENDLIST
- DEF_METHOD
- public VerifyError()
- // Constructor.
- //
- DEF_ENDLIST
- DEF_METHOD
- public VerifyError(String s)
- // Constructor with a detail message.
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- VirtualMachineError
- DEF_SUPERCLASS
- Error
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- lang
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // A VirtualMachineError indicates that the virtual machine is broken
- // or has run out of resources.
- //
- DEF_ENDLIST
- DEF_METHOD
- public VirtualMachineError()
- // Constructs a VirtualMachineError with no detail message.
- // A detail message is a String that describes this particular exception.
- //
- DEF_ENDLIST
- DEF_METHOD
- public VirtualMachineError(String s)
- // Constructs a VirtualMachineError with the specified detail message.
- // A detail message is a String that describes this particular exception.
- //
- // Parameters:
- // s - the detail message
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- ServerSocket
- DEF_SUPERCLASS
- Object
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- net
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- java.net.ServerSocket
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // The server Socket class. It uses a SocketImpl
- // to implement the actual socket operations. It is done this way
- // so that you are able to change socket implementations depending
- // on the kind of firewall being used. You can change socket
- // implementations by setting the SocketImplFactory.
- DEF_ENDLIST
- DEF_METHOD
- public ServerSocket(int port) throws IOException
- // Creates a server socket on a specified port.
- //
- // Parameters:
- // port - the port
- // Throws: IOException
- // IO error when opening the socket.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public ServerSocket(int port,
- int count) throws IOException
- // Creates a server socket, binds it to the specified local port
- // and listens to it. You can connect to an annonymous port by
- // specifying the port number to be 0.
- //
- // Parameters:
- // port - the specified port
- // count - the amountt of time to listen for a connection
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public InetAddress getInetAddress()
- // Gets the address to which the socket is connected.
- //
- DEF_ENDLIST
- DEF_METHOD
- public int getLocalPort()
- // Gets the port on which the socket is listening.
- //
- DEF_ENDLIST
- DEF_METHOD
- public Socket accept() throws IOException
- // Accepts a connection. This method will block until the
- // connection is made.
- //
- // Throws: IOException
- // IO error when waiting for the connection.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void close() throws IOException
- // Closes the server socket.
- //
- // Throws: IOException
- // IO error when closing the socket.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toString()
- // Returns the implementation address and implementation port of
- // this ServerSocket as a String.
- //
- // Overrides:
- // toString in class Object
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static synchronized void setSocketFactory(SocketImplFactory fac) throws IOException
- // Sets the system's server SocketImplFactory. The factory can
- // be specified only once.
- //
- // Parameters:
- // fac - the desired factory
- // Throws: SocketException
- // If the factory has already been
- // defined.
- // Throws: IOException
- // IO error when setting the socket factor.
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- Socket
- DEF_SUPERCLASS
- Object
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- net
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- java.net.Socket
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // The client Socket class. It uses a SocketImpl
- // to implement the actual socket operations. It is done this way
- // so that you are able to change socket implementations depending
- // on the kind of firewall that is used. You can change socket
- // implementations by setting the SocketImplFactory.
- DEF_ENDLIST
- DEF_METHOD
- public Socket(String host,
- int port) throws UnknownHostException, IOException
- // Creates a stream socket and connects it to the specified port on
- // the specified host.
- //
- // Parameters:
- // host - the host
- // port - the port
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public Socket(String host,
- int port,
- boolean stream) throws IOException
- // Creates a socket and connects it to the specified port on
- // the specified host. The last argument lets you specify whether
- // you want a stream or datagram socket.
- //
- // Parameters:
- // host - the specified host
- // port - the specified port
- // stream - a boolean indicating whether this is a stream
- // or datagram socket
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public Socket(InetAddress address,
- int port) throws IOException
- // Creates a stream socket and connects it to the specified address on
- // the specified port.
- //
- // Parameters:
- // address - the specified address
- // port - the specified port
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public Socket(InetAddress address,
- int port,
- boolean stream) throws IOException
- // Creates a socket and connects it to the specified address on
- // the specified port. The last argument lets you specify whether
- // you want a stream or datagram socket.
- //
- // Parameters:
- // address - the specified address
- // port - the specified port
- // stream - a boolean indicating whether this is a stream
- // or datagram socket
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public InetAddress getInetAddress()
- // Gets the address to which the socket is connected.
- //
- DEF_ENDLIST
- DEF_METHOD
- public int getPort()
- // Gets the remote port to which the socket is connected.
- //
- DEF_ENDLIST
- DEF_METHOD
- public int getLocalPort()
- // Gets the local port to which the socket is connected.
- //
- DEF_ENDLIST
- DEF_METHOD
- public InputStream getInputStream() throws IOException
- // Gets an InputStream for this socket.
- //
- DEF_ENDLIST
- DEF_METHOD
- public OutputStream getOutputStream() throws IOException
- // Gets an OutputStream for this socket.
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized void close() throws IOException
- // Closes the socket.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toString()
- // Converts the Socket to a String.
- //
- // Overrides:
- // toString in class Object
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static synchronized void setSocketImplFactory(SocketImplFactory fac) throws IOException
- // Sets the system's client SocketImplFactory. The factory can
- // be specified only once.
- //
- // Parameters:
- // fac - the desired factory
- // Throws: SocketException
- // If the factory is already defined.
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- SocketException
- DEF_SUPERCLASS
- IOException
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- net
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- java.net.SocketException
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // Signals that an error occurred while attempting to use a socket.
- DEF_ENDLIST
- DEF_METHOD
- public SocketException(String msg)
- // Constructs a new SocketException with the specified detail
- // message.
- // A detail message is a String that gives a specific
- // description of this error.
- //
- // Parameters:
- // msg - the detail message
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public SocketException()
- // Constructs a new SocketException with no detail message.
- // A detail message is a String that gives a specific
- // description of this error.
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- SocketImpl
- DEF_SUPERCLASS
- Object
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- net
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- java.net.SocketImpl
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // This is the Socket implementation class. It is an
- // abstract class that must be subclassed to provide
- // an actual implementation.
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- UnknownHostException
- DEF_SUPERCLASS
- IOException
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- net
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- java.net.UnknownHostException
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // Signals that the address of the server specified by a network client could not
- // be resolved.
- DEF_ENDLIST
- DEF_METHOD
- public UnknownHostException(String host)
- // Constructs a new UnknownHostException with the specified detail message.
- // A detail message is a String that gives a specific description
- // of this error.
- //
- // Parameters:
- // host - the detail message
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public UnknownHostException()
- // Constructs a new UnknownHostException with no detail message.
- // A detail message is a String that gives a specific description
- // of this error.
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- UnknownServiceException
- DEF_SUPERCLASS
- IOException
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- net
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- java.net.UnknownServiceException
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // Signals that an unknown service exception has occurred.
- DEF_ENDLIST
- DEF_METHOD
- public UnknownServiceException()
- // Constructs a new UnknownServiceException with no detail message.
- // A detail message is a String that gives a specific description
- // of this error.
- //
- DEF_ENDLIST
- DEF_METHOD
- public UnknownServiceException(String msg)
- // Constructs a new UnknownServiceException with the specified detail message.
- // A detail message is a String that gives a specific description
- // of this error.
- //
- // Parameters:
- // msg - the detail message
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- URL
- DEF_SUPERCLASS
- Object
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- net
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- java.net.URL
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // Class URL represents a Uniform Reference Locator -- a reference
- // to an object on the World Wide Web. This is a constant object,
- // once it is created, its fields cannot be changed.
- DEF_ENDLIST
- DEF_METHOD
- public URL(String protocol,
- String host,
- int port,
- String file) throws MalformedURLException
- // Creates an absolute URL from the specified protocol,
- // host, port and file.
- //
- // Parameters:
- // protocol - the protocol to use
- // host - the host to connect to
- // port - the port at that host to connect to
- // file - the file on that host
- // Throws: MalformedURLException
- // If an unknown protocol is
- // found.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public URL(String protocol,
- String host,
- String file) throws MalformedURLException
- // Creates an absolute URL from the specified protocol,
- // host, and file. The port number used will be the default for the
- // protocol.
- //
- // 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
- // found.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public URL(String spec) throws MalformedURLException
- // Creates a URL from the unparsed absolute URL.
- //
- // Parameters:
- // spec - the URL String to parse
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public URL(URL context,
- String spec) throws MalformedURLException
- // Creates a URL from the unparsed URL in the specified context.If
- // spec is an absolute URL it is used as is. Otherwise it isparsed
- // in terms of the context. Context may be null (indicating no
- // context).
- //
- // Parameters:
- // context - the context to parse the URL to
- // spec - the URL String to parse
- // Throws: MalformedURLException
- // If the protocol is equal to null.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- 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
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int getPort()
- // Gets the port number. Returns -1 if the port is not set.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String getProtocol()
- // Gets the protocol name.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String getHost()
- // Gets the host name.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String getFile()
- // Gets the file name.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String getRef()
- // Gets the ref.
- //
- DEF_ENDLIST
- DEF_METHOD
- public boolean equals(Object obj)
- // Compares two URLs.
- //
- // Parameters:
- // obj - the URL to compare against.
- // Returns:
- // true if and only if they are equal, false otherwise.
- // Overrides:
- // equals in class Object
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int hashCode()
- // Creates an integer suitable for hash table indexing.
- //
- // Overrides:
- // hashCode in class Object
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public boolean sameFile(URL other)
- // Compares two URLs, excluding the "ref" fields: sameFile is true
- // if the true references the same remote object, but not necessarily
- // the same subpiece of that object.
- //
- // Parameters:
- // other - the URL to compare against.
- // Returns:
- // true if and only if they are equal, false otherwise.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toString()
- // Converts to a human-readable form.
- //
- // Returns:
- // the textual representation.
- // Overrides:
- // toString in class Object
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toExternalForm()
- // Reverses the parsing of the URL.
- //
- // Returns:
- // the textual representation of the fully qualified URL (i.e.
- // after the context and canonicalization have been applied).
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public URLConnection openConnection() throws IOException
- // Creates (if not already in existance) a URLConnection object that
- // contains a connection to the remote object referred to by
- // the URL. Invokes the appropriate protocol handler. Failure is
- // indicated by throwing an exception.
- //
- // Throws: IOException
- // If an I/O exception has occurred.
- // See Also:
- // URLConnection
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final InputStream openStream() throws IOException
- // Opens an input stream.
- //
- // Throws: IOException
- // If an I/O exception has occurred.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final Object getContent() throws IOException
- // Gets the contents from this opened connection.
- //
- // Throws: IOException
- // If an I/O exception has occurred.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static synchronized void setURLStreamHandlerFactory(URLStreamHandlerFactory fac)
- // Sets the URLStreamHandler factory.
- //
- // Parameters:
- // fac - the desired factory
- // Throws: Error
- // If the factory has already been defined.
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- URLConnection
- DEF_SUPERCLASS
- Object
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- net
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- java.net.URLConnection
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // A class to represent an active connection to an object
- // represented by a URL. It is an abstract class that must be
- // subclassed to implement a connection.
- DEF_ENDLIST
- DEF_METHOD
- public abstract void connect() throws IOException
- // 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
- // (eg. doInput, 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. Connecting when already connected
- // does nothing.
- //
- DEF_ENDLIST
- DEF_METHOD
- public URL getURL()
- // Gets the URL for this connection.
- //
- DEF_ENDLIST
- DEF_METHOD
- public int getContentLength()
- // Gets the content length. Returns -1 if not known.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String getContentType()
- // Gets the content type. Returns null if not known.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String getContentEncoding()
- // Gets the content encoding. Returns null if not known.
- //
- DEF_ENDLIST
- DEF_METHOD
- public long getExpiration()
- // Gets the expriation date of the object. Returns 0 if not known.
- //
- DEF_ENDLIST
- DEF_METHOD
- public long getDate()
- // Gets the sending date of the object. Returns 0 if not known.
- //
- DEF_ENDLIST
- DEF_METHOD
- public long getLastModified()
- // Gets the last modified date of the object. Returns 0 if not known.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String getHeaderField(String name)
- // Gets a header field by name. Returns null if not known.
- //
- // Parameters:
- // name - the name of the header field
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int getHeaderFieldInt(String name,
- int Default)
- // Gets a header field by name. Returns null if not known.
- // The field is parsed as an integer. This form of
- // getHeaderField exists because some connection types
- // (e.g. http-ng) have pre-parsed headers and this allows them
- // to override this method and short-circuit the parsing.
- //
- // Parameters:
- // name - the name of the header field
- // Default - the value to return if the field is missing
- // or malformed.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public long getHeaderFieldDate(String name,
- long Default)
- // Gets a header field by name. Returns null if not known.
- // The field will be parsed as a date. This form of
- // getHeaderField exists because some connection types
- // (eg. http-ng) have pre-parsed headers. This allows them
- // to override this method and short-circuit the parsing.
- //
- // Parameters:
- // name - the name of the header field
- // Default - the value to return if the field is missing
- // or malformed.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String getHeaderFieldKey(int n)
- // Returns the key for the nth header field. Returns null if
- // there are fewer than n fields. This can be used to iterate
- // through all the headers in the message.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String getHeaderField(int n)
- // Returns the value for the nth header field. Returns null if
- // there are fewer than n fields. This can be used in conjunction
- // with getHeaderFieldKey to iterate through all the headers in the message.
- //
- DEF_ENDLIST
- DEF_METHOD
- public Object getContent() throws IOException
- // Gets the object referred to by this URL. For example, if it
- // refers to an image the object will be some subclass of
- // Image. The instanceof operator should be used to determine
- // what kind of object was returned.
- //
- // Returns:
- // the object that was fetched.
- // Throws: UnknownServiceException
- // If the protocol does not
- // support content.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public InputStream getInputStream() throws IOException
- // Calls this routine to get an InputStream that reads from the object.
- // Protocol implementors should use this if appropriate.
- //
- // Throws: UnknownServiceException
- // If the protocol does not
- // support input.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public OutputStream getOutputStream() throws IOException
- // Calls this routine to get an OutputStream that writes to the object.
- // Protocol implementors should use this if appropriate.
- //
- // Throws: UnknownServiceException
- // If the protocol does not
- // support output.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String toString()
- // Returns the String representation of the URL connection.
- //
- // Overrides:
- // toString in class Object
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public void setDoInput(boolean doinput)
- // 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.
- //
- DEF_ENDLIST
- DEF_METHOD
- public boolean getDoInput()
- // 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.
- //
- DEF_ENDLIST
- DEF_METHOD
- public boolean getDoOutput()
- // Some URL connections occasionally need to to interactions with the
- // user. For example, the http protocol may need to pop up an authentication
- // dialog. But this is only appropriate if the application is running
- // in a context where there is a user. The allowUserInteraction
- // flag allows these interactions when true. When it is false, they are
- // not allowed and an exception is tossed. The default value can be
- // set/gotten using setDefaultAllowUserInteraction, which defaults to false.
- //
- DEF_ENDLIST
- DEF_METHOD
- public boolean getAllowUserInteraction()
- // Sets/gets the default value of the allowUserInteraction flag. This 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.
- //
- DEF_ENDLIST
- DEF_METHOD
- public static boolean getDefaultAllowUserInteraction()
- // 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.
- //
- DEF_ENDLIST
- DEF_METHOD
- public boolean getUseCaches()
- // Some protocols support skipping fetching unless the object is newer than some amount of time.
- // The ifModifiedSince field may be set/gotten to define this time.
- //
- DEF_ENDLIST
- DEF_METHOD
- public long getIfModifiedSince()
- // Sets/gets the default value of the UseCaches flag. This 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.
- //
- DEF_ENDLIST
- DEF_METHOD
- public void setDefaultUseCaches(boolean defaultusecaches)
- // Sets/gets a general request property.
- //
- // Parameters:
- // key - The keyword by which the request is known (eg "accept")
- // value - The value associated with it.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String getRequestProperty(String key)
- // Sets/gets 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 (eg "accept")
- // value - The value associated with it.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public static String getDefaultRequestProperty(String key)
- // Sets the ContentHandler factory.
- //
- // Parameters:
- // fac - the desired factory
- // Throws: Error
- // If the factory has already been defined.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- protected static String guessContentTypeFromName(String fname)
- // A useful utility routine that tries to guess the content-type
- // of an object based upon its extension.
- //
- DEF_ENDLIST
- DEF_METHOD
- protected static String guessContentTypeFromStream(InputStream is) throws IOException
- // This method is used to check for files that have some type
- // that can be determined by inspection. The bytes at the beginning
- // of the file are examined loosely. In an ideal world, this routine
- // would not be needed, but in a world where http servers lie
- // about content-types and extensions are often non-standard,
- // direct inspection of the bytes can make the system more robust.
- // The stream must support marks (e.g. have a BufferedInputStream
- // somewhere).
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- URLEncoder
- DEF_SUPERCLASS
- Object
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- net
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- java.net.URLEncoder
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // Turns Strings of text into x-www-form-urlencoded format.
- DEF_ENDLIST
- DEF_METHOD
- public static String encode(String s)
- // Translates String into x-www-form-urlencoded format.
- //
- // Parameters:
- // s - String to be translated
- // Returns:
- // the translated String.
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- URLStreamHandler
- DEF_SUPERCLASS
- Object
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- net
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- java.net.URLStreamHandler
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // Abstract class for URL stream openers.
- // Subclasses of this class know how to create streams for particular
- // protocol types.
- DEF_ENDLIST
- DEF_METHOD
- public URLStreamHandler()
- // Opens an input stream to the object referenced by the URL. This method should be
- // overridden by a subclass.
- //
- // Parameters:
- // u - the URL that this connects to
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- protected void parseURL(URL u,
- String spec,
- int start,
- int limit)
- // This method is called to parse the string spec into URL u. If
- // there is any inherited context then it has already been copied
- // into u. The parameters start and
- // limit refer to the range of characters in spec
- // that should be parsed. The default method uses parsing rules
- // that match the http spec, which most URL protocol families
- // follow. If you are writing a protocol handler that has a
- // different syntax, override this routine.
- //
- // Parameters:
- // u - the URL to receive the result of parsing the spec
- // spec - the URL string to parse
- // start - the character position to start parsing at. This is
- // just past the ':' (if there is one).
- // limit - the character position to stop parsing at. This is
- // the end of the string or the position of the "#"
- // character if present (the "#" reference syntax is
- // protocol independent).
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- protected String toExternalForm(URL u)
- // Reverses the parsing of the URL. This should probably be overridden if
- // you override parseURL().
- //
- // Parameters:
- // u - the URL
- // Returns:
- // the textual representation of the fully qualified URL (i.e.
- // after the context and canonicalization have been applied).
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- protected void setURL(URL u,
- String protocol,
- String host,
- int port,
- String file,
- String ref)
- // Calls the (protected) set method out of the URL given. Only
- // classes derived from URLStreamHandler are supposed to be able
- // to call the set() method on a URL.
- //
- // See Also:
- // set
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- Stack
- DEF_SUPERCLASS
- Vector
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- util
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- java.util.Stack
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // A Last-In-First-Out(LIFO) stack of objects.
- DEF_ENDLIST
- DEF_METHOD
- public Stack()
- // Pushes an item onto the stack.
- //
- // Parameters:
- // item - the item to be pushed on.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public Object pop()
- // Pops an item off the stack.
- //
- // Throws: EmptyStackException
- // If the stack is empty.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public Object peek()
- // Peeks at the top of the stack.
- //
- // Throws: EmptyStackException
- // If the stack is empty.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public boolean empty()
- // Returns true if the stack is empty.
- //
- DEF_ENDLIST
- DEF_METHOD
- public int search(Object o)
- // Sees if an object is on the stack.
- //
- // Parameters:
- // o - the desired object
- // Returns:
- // the distance from the top, or -1 if it is not found.
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- StackFrame
- DEF_SUPERCLASS
- Object
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- util
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- java.util.StackFrame
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- DEF_ENDLIST
- DEF_DECLARATION
- // The StackFrame class represents a stack frame of a suspended thread.
- //
- // See Also:
- // RemoteDebugger, RemoteStackFrame, RemoteThread
- //
- DEF_ENDLIST
- DEF_METHOD
- public StackFrame()
- // Returns a String that represents the value of this Object.
- //
- // Overrides:
- // toString in class Object
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- StringTokenizer
- DEF_SUPERCLASS
- Object
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- util
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- java.util.StringTokenizer
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- Enumeration
- DEF_ENDLIST
- DEF_DECLARATION
- // StringTokenizer is a class that controls simple linear tokenization
- // of a String. The set of delimiters, which defaults to common
- // whitespace characters, may be specified at creation time or on a
- // per-token basis.
- // Example usage:
- //
- // String s = "this is a test";
- // StringTokenizer st = new StringTokenizer(s);
- // while (st.hasMoreTokens()) {
- // println(st.nextToken());
- // }
- //
- // Prints the following on the console:
- //
- // this
- // is
- // a
- // test
- //
- DEF_ENDLIST
- DEF_METHOD
- public StringTokenizer(String str,
- String delim,
- boolean returnTokens)
- // Constructs a StringTokenizer on the specified String, using the
- // specified delimiter set.
- //
- // Parameters:
- // str - the input String
- // delim - the delimiter String
- // returnTokens - returns delimiters as tokens or skip them
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public StringTokenizer(String str,
- String delim)
- // Constructs a StringTokenizer on the specified String, using the
- // specified delimiter set.
- //
- // Parameters:
- // str - the input String
- // delim - the delimiter String
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public StringTokenizer(String str)
- // Constructs a StringTokenizer on the specified String, using the
- // default delimiter set (which is " \t\n\r").
- //
- // Parameters:
- // str - the String
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public boolean hasMoreTokens()
- // Returns true if more tokens exist.
- //
- DEF_ENDLIST
- DEF_METHOD
- public String nextToken()
- // Returns the next token of the String.
- //
- // Throws: NoSuchElementException
- // If there are no more
- // tokens in the String.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public String nextToken(String delim)
- // Returns the next token, after switching to the new delimiter set.
- // The new delimiter set remains the default after this call.
- //
- // Parameters:
- // delim - the new delimiters
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public boolean hasMoreElements()
- // Returns true if the Enumeration has more elements.
- //
- DEF_ENDLIST
- DEF_METHOD
- public Object nextElement()
- // Returns the next element in the Enumeration.
- //
- // Throws: NoSuchElementException
- // If there are no more elements
- // in the enumeration.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public int countTokens()
- // Returns the next number of tokens in the String using
- // the current deliminter set. This is the number of times
- // nextToken() can return before it will generate an exception.
- // Use of this routine to count the number of tokens is faster
- // than repeatedly calling nextToken() because the substrings
- // are not constructed and returned for each token.
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
- DEF_COMPONENTNAME
- Vector
- DEF_SUPERCLASS
- Object
- DEF_SUPERCOMPONENT
-
- DEF_PACKAGE
- java
- util
- DEF_ENDLIST
- DEF_SUBCOMPONENTLIST
- DEF_ENDLIST
- DEF_SUBCOMPONENTCLASSLIST
- DEF_ENDLIST
- DEF_CATEGORY
-
- DEF_BITMAP
-
- DEF_THUMBNAIL_UP
-
- DEF_THUMBNAIL_DOWN
-
- DEF_BASE
- DEF_IMPORTS
- java.util.Vector
- DEF_ENDLIST
- DEF_REQUIRES
- DEF_ENDLIST
- DEF_IMPLEMENTS
- Cloneable
- DEF_ENDLIST
- DEF_DECLARATION
- // Vector class (a growable array).
- // 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 elements are added to the vector, the vector's
- // storage increases in chunks the size of capacityIncrement. Setting
- // the capacity to what you want before inserting a large number of
- // objects will reduce the amount of incremental reallocation.
- // You can safely ignore the capacity and the vector will still work
- // correctly.
- DEF_ENDLIST
- DEF_METHOD
- public Vector(int initialCapacity,
- int capacityIncrement)
- // Constructs an empty vector with the specified storage
- // capacity and the specified capacityIncrement.
- //
- // Parameters:
- // initialCapacity - the initial storage capacity of the vector
- // capacityIncrement - how much to increase the element's
- // size by.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public Vector(int initialCapacity)
- // Constructs an empty vector with the specified storage capacity.
- //
- // Parameters:
- // initialCapacity - the initial storage capacity of the vector
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public Vector()
- // Constructs an empty vector.
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized void copyInto(Object anArray[])
- // Copies the elements of this vector into the specified array.
- //
- // Parameters:
- // anArray - the array where elements get copied into
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized void trimToSize()
- // Trims the vector's capacity down to size. Use this operation to
- // minimize the storage of a vector. Subsequent insertions will
- // cause reallocation.
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized void ensureCapacity(int minCapacity)
- // Ensures that the vector has at least the specified capacity.
- //
- // Parameters:
- // minCapacity - the desired minimum capacity
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized void setSize(int newSize)
- // Sets the size of the vector. If the size shrinks, the extra elements
- // (at the end of the vector) are lost; if the size increases, the
- // new elements are set to null.
- //
- // Parameters:
- // newSize - the new size of the vector
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final int capacity()
- // Returns the current capacity of the vector.
- //
- DEF_ENDLIST
- DEF_METHOD
- public final int size()
- // Returns the number of elements in the vector.
- // Note that this is not the same as the vector's capacity.
- //
- DEF_ENDLIST
- DEF_METHOD
- public final boolean isEmpty()
- // Returns true if the collection contains no values.
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized Enumeration elements()
- // Returns an enumeration of the elements. Use the Enumeration methods on
- // the returned object to fetch the elements sequentially.
- //
- DEF_ENDLIST
- DEF_METHOD
- public final boolean contains(Object elem)
- // Returns true if the specified object is a value of the
- // collection.
- //
- // Parameters:
- // elem - the desired element
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final int indexOf(Object elem)
- // Searches for the specified object, starting from the first position
- // and returns an index to it.
- //
- // Parameters:
- // elem - the desired element
- // Returns:
- // the index of the element, or -1 if it was not found.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized int indexOf(Object elem,
- int index)
- // Searches for the specified object, starting at the specified
- // position and returns an index to it.
- //
- // Parameters:
- // elem - the desired element
- // index - the index where to start searching
- // Returns:
- // the index of the element, or -1 if it was not found.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final int lastIndexOf(Object elem)
- // Searches backwards for the specified object, starting from the last
- // position and returns an index to it.
- //
- // Parameters:
- // elem - the desired element
- // Returns:
- // the index of the element, or -1 if it was not found.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized int lastIndexOf(Object elem,
- int index)
- // Searches backwards for the specified object, starting from the specified
- // position and returns an index to it.
- //
- // Parameters:
- // elem - the desired element
- // index - the index where to start searching
- // Returns:
- // the index of the element, or -1 if it was not found.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized Object elementAt(int index)
- // Returns the element at the specified index.
- //
- // Parameters:
- // index - the index of the desired element
- // Throws: ArrayIndexOutOfBoundsException
- // If an invalid
- // index was given.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized Object firstElement()
- // Returns the first element of the sequence.
- //
- // Throws: NoSuchElementException
- // If the sequence is empty.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized Object lastElement()
- // Returns the last element of the sequence.
- //
- // Throws: NoSuchElementException
- // If the sequence is empty.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized void setElementAt(Object obj,
- int index)
- // Sets the element at the specified index to be the specified object.
- // The previous element at that position is discarded.
- //
- // Parameters:
- // obj - what the element is to be set to
- // index - the specified index
- // Throws: ArrayIndexOutOfBoundsException
- // If the index was
- // invalid.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized void removeElementAt(int index)
- // Deletes the element at the specified index. Elements with an index
- // greater than the current index are moved down.
- //
- // Parameters:
- // index - the element to remove
- // Throws: ArrayIndexOutOfBoundsException
- // If the index was invalid.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized void insertElementAt(Object obj,
- int index)
- // Inserts the specified object as an element at the specified index.
- // Elements with an index greater or equal to the current index
- // are shifted up.
- //
- // Parameters:
- // obj - the element to insert
- // index - where to insert the new element
- // Throws: ArrayIndexOutOfBoundsException
- // If the index was invalid.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized void addElement(Object obj)
- // Adds the specified object as the last element of the vector.
- //
- // Parameters:
- // obj - the element to be added
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized boolean removeElement(Object obj)
- // Removes the element from the vector. If the object occurs more
- // than once, only the first is removed. If the object is not an
- // element, returns false.
- //
- // Parameters:
- // obj - the element to be removed
- // Returns:
- // true if the element was actually removed; false otherwise.
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized void removeAllElements()
- // Removes all elements of the vector. The vector becomes empty.
- //
- DEF_ENDLIST
- DEF_METHOD
- public synchronized Object clone()
- // Clones this vector. The elements are not cloned.
- //
- // Overrides:
- // clone in class Object
- //
- //
- DEF_ENDLIST
- DEF_METHOD
- public final synchronized String toString()
- // Converts the vector to a string. Useful for debugging.
- //
- // Overrides:
- // toString in class Object
- //
- //
- DEF_ENDLIST
- DEF_ENDCOMPONENT
-