diff options
| author | green <green@138bc75d-0d04-0410-961f-82ee72b054a4> | 2001-01-08 00:27:51 +0000 |
|---|---|---|
| committer | green <green@138bc75d-0d04-0410-961f-82ee72b054a4> | 2001-01-08 00:27:51 +0000 |
| commit | 9ca3c224d830e3b014bc036414d4b9a1af717dcd (patch) | |
| tree | e6058c157f2a58ea1d1cadda719e0332b688b0ae /libjava | |
| parent | 96df8b7778427c0dba34c27172a73f1d15945281 (diff) | |
| download | gcc-9ca3c224d830e3b014bc036414d4b9a1af717dcd.tar.gz | |
001-01-07 Anthony Green <green@redhat.com>
* Makefile.am (texinfo): Add texinfo target for generating texinfo
documentation.
* Makefile.in: Rebuilt.
* scripts/TexinfoDoclet.java: New file.
* doc/java-applet.texi, doc/java-lang-reflect.texi,
doc/java-awt-color.texi, doc/java-lang.texi,
doc/java-awt-datatransfer.texi, doc/java-math.texi,
doc/java-awt-event.texi, doc/java-net.texi,
doc/java-awt-geom.texi, doc/java-security-spec.texi,
doc/java-awt-image.texi, doc/java-security.texi,
doc/java-awt-peer.texi, doc/java-sql.texi, doc/java-awt.texi,
doc/java-text.texi, doc/java-beans-beancontext.texi,
doc/java-util-jar.texi, doc/java-beans.texi,
doc/java-util-zip.texi, doc/java-io.texi, doc/java-util.texi,
doc/java-lang-ref.texi: New files.
git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@38789 138bc75d-0d04-0410-961f-82ee72b054a4
Diffstat (limited to 'libjava')
27 files changed, 18487 insertions, 2 deletions
diff --git a/libjava/ChangeLog b/libjava/ChangeLog index 5a39de18f88..dbcccecafff 100644 --- a/libjava/ChangeLog +++ b/libjava/ChangeLog @@ -1,5 +1,25 @@ 2001-01-07 Anthony Green <green@redhat.com> + * Makefile.am (texinfo): Add texinfo target for generating texinfo + documentation. + * Makefile.in: Rebuilt. + + * scripts/TexinfoDoclet.java: New file. + + * doc/java-applet.texi, doc/java-lang-reflect.texi, + doc/java-awt-color.texi, doc/java-lang.texi, + doc/java-awt-datatransfer.texi, doc/java-math.texi, + doc/java-awt-event.texi, doc/java-net.texi, + doc/java-awt-geom.texi, doc/java-security-spec.texi, + doc/java-awt-image.texi, doc/java-security.texi, + doc/java-awt-peer.texi, doc/java-sql.texi, doc/java-awt.texi, + doc/java-text.texi, doc/java-beans-beancontext.texi, + doc/java-util-jar.texi, doc/java-beans.texi, + doc/java-util-zip.texi, doc/java-io.texi, doc/java-util.texi, + doc/java-lang-ref.texi: New files. + +2001-01-07 Anthony Green <green@redhat.com> + * java/net/URLConnection.java (setDoOutput): URLConnection's may be used for both input and output, so don't clear doInput. diff --git a/libjava/Makefile.am b/libjava/Makefile.am index 87cef05ecc3..414ae2caade 100644 --- a/libjava/Makefile.am +++ b/libjava/Makefile.am @@ -135,7 +135,7 @@ EXTRA_libgcj_la_SOURCES = boehm.cc nogc.cc posix-threads.cc no-threads.cc \ $(c_source_files) $(java_source_files) $(built_java_source_files) libgcj_la_DEPENDENCIES = libgcj.jar $(javao_files) \ $(c_files) $(GCOBJS) $(THREADOBJS) $(LIBLTDL) - + # Include THREADLIBS here to ensure that the correct version of # certain linuxthread functions get linked: libgcj_la_LIBADD = $(javao_files) $(c_files) $(GCOBJS) \ @@ -1323,6 +1323,44 @@ gnu/gcj/xlib/natXUnmapEvent.cc ## ################################################################ ## +## javadoc to texinfo conversion +## + +TexinfoDoclet.class: $(srcdir)/scripts/TexinfoDoclet.java + javac -d . $(srcdir)/scripts/TexinfoDoclet.java + +texinfo: TexinfoDoclet.class + langsource=`ls $(srcdir)/java/lang/*.java`; \ + lang=`echo $$langsource | sed -e 's/[^ ].*EcosProcess.java//g' | sed -e 's/[^ ].*PosixProcess.java//g'`; \ + javadoc -outfile $(srcdir)/doc/java-lang.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $$lang + javadoc -outfile $(srcdir)/doc/java-lang-ref.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/lang/ref/*.java + javadoc -outfile $(srcdir)/doc/java-lang-reflect.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/lang/reflect/*.java + javadoc -outfile $(srcdir)/doc/java-applet.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/applet/*.java + javadoc -outfile $(srcdir)/doc/java-awt.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/awt/*.java + javadoc -outfile $(srcdir)/doc/java-awt-color.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/awt/color/*.java + javadoc -outfile $(srcdir)/doc/java-awt-datatransfer.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/awt/datatransfer/*.java + javadoc -outfile $(srcdir)/doc/java-awt-event.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/awt/event/*.java + javadoc -outfile $(srcdir)/doc/java-awt-geom.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/awt/geom/*.java + javadoc -outfile $(srcdir)/doc/java-awt-image.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/awt/image/*.java + javadoc -outfile $(srcdir)/doc/java-awt-peer.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/awt/peer/*.java + javadoc -outfile $(srcdir)/doc/java-beans.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/beans/*.java + javadoc -outfile $(srcdir)/doc/java-beans-beancontext.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/beans/beancontext/*.java + javadoc -outfile $(srcdir)/doc/java-io.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/io/*.java + javadoc -outfile $(srcdir)/doc/java-math.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/math/*.java + javadoc -outfile $(srcdir)/doc/java-net.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/net/*.java + javadoc -outfile $(srcdir)/doc/java-security.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/security/*.java + javadoc -outfile $(srcdir)/doc/java-security-cert.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/security-cert/*.java + javadoc -outfile $(srcdir)/doc/java-security-spec.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/security/spec/*.java + javadoc -outfile $(srcdir)/doc/java-security-interfaces.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/security/spec/interfaces/*.java + javadoc -outfile $(srcdir)/doc/java-sql.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/sql/*.java + javadoc -outfile $(srcdir)/doc/java-text.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/text/*.java + javadoc -outfile $(srcdir)/doc/java-util.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/util/*.java + javadoc -outfile $(srcdir)/doc/java-util-jar.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/util/jar/*.java + javadoc -outfile $(srcdir)/doc/java-util-zip.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/util/zip/*.java + +## ################################################################ + +## ## Dependency tracking madness. ## diff --git a/libjava/Makefile.in b/libjava/Makefile.in index 6d28a8852aa..ac5e4934446 100644 --- a/libjava/Makefile.in +++ b/libjava/Makefile.in @@ -1198,7 +1198,7 @@ libgcj-test.spec.in libgcj.spec.in DISTFILES = $(DIST_COMMON) $(SOURCES) $(HEADERS) $(TEXINFOS) $(EXTRA_DIST) -TAR = tar +TAR = gtar GZIP_ENV = --best DIST_SUBDIRS = @DIRLTDL@ testsuite gcj include @DIRLTDL@ gcj include DEP_FILES = .deps/$(srcdir)/$(CONVERT_DIR)/gen-from-JIS.P \ @@ -2494,6 +2494,38 @@ $(CONVERT_DIR)/make-trie.o: $(srcdir)/$(CONVERT_DIR)/make-trie.c @NATIVE_TRUE@@MAINTAINER_MODE_TRUE@$(srcdir)/$(CONVERT_DIR)/Unicode_to_JIS.cc: ./gen-from-JIS$(EXEEXT) @NATIVE_TRUE@@MAINTAINER_MODE_TRUE@ ./gen-from-JIS toJIS>$(srcdir)/$(CONVERT_DIR)/Unicode_to_JIS.cc +TexinfoDoclet.class: $(srcdir)/scripts/TexinfoDoclet.java + javac -d . $(srcdir)/scripts/TexinfoDoclet.java + +texinfo: TexinfoDoclet.class + langsource=`ls $(srcdir)/java/lang/*.java`; \ + lang=`echo $$langsource | sed -e 's/[^ ].*EcosProcess.java//g' | sed -e 's/[^ ].*PosixProcess.java//g'`; \ + javadoc -outfile $(srcdir)/doc/java-lang.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $$lang + javadoc -outfile $(srcdir)/doc/java-lang-ref.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/lang/ref/*.java + javadoc -outfile $(srcdir)/doc/java-lang-reflect.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/lang/reflect/*.java + javadoc -outfile $(srcdir)/doc/java-applet.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/applet/*.java + javadoc -outfile $(srcdir)/doc/java-awt.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/awt/*.java + javadoc -outfile $(srcdir)/doc/java-awt-color.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/awt/color/*.java + javadoc -outfile $(srcdir)/doc/java-awt-datatransfer.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/awt/datatransfer/*.java + javadoc -outfile $(srcdir)/doc/java-awt-event.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/awt/event/*.java + javadoc -outfile $(srcdir)/doc/java-awt-geom.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/awt/geom/*.java + javadoc -outfile $(srcdir)/doc/java-awt-image.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/awt/image/*.java + javadoc -outfile $(srcdir)/doc/java-awt-peer.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/awt/peer/*.java + javadoc -outfile $(srcdir)/doc/java-beans.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/beans/*.java + javadoc -outfile $(srcdir)/doc/java-beans-beancontext.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/beans/beancontext/*.java + javadoc -outfile $(srcdir)/doc/java-io.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/io/*.java + javadoc -outfile $(srcdir)/doc/java-math.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/math/*.java + javadoc -outfile $(srcdir)/doc/java-net.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/net/*.java + javadoc -outfile $(srcdir)/doc/java-security.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/security/*.java + javadoc -outfile $(srcdir)/doc/java-security-cert.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/security-cert/*.java + javadoc -outfile $(srcdir)/doc/java-security-spec.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/security/spec/*.java + javadoc -outfile $(srcdir)/doc/java-security-interfaces.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/security/spec/interfaces/*.java + javadoc -outfile $(srcdir)/doc/java-sql.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/sql/*.java + javadoc -outfile $(srcdir)/doc/java-text.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/text/*.java + javadoc -outfile $(srcdir)/doc/java-util.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/util/*.java + javadoc -outfile $(srcdir)/doc/java-util-jar.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/util/jar/*.java + javadoc -outfile $(srcdir)/doc/java-util-zip.texi -doclet TexinfoDoclet -sourcepath .:$(srcdir) $(srcdir)/java/util/zip/*.java + -include deps.mk all-recursive: $(nat_headers) $(x_nat_headers) diff --git a/libjava/doc/java-applet.texi b/libjava/doc/java-applet.texi new file mode 100644 index 00000000000..bcd4637d233 --- /dev/null +++ b/libjava/doc/java-applet.texi @@ -0,0 +1,141 @@ +@deftypemethod AppletContext {public AudioClip} getAudioClip (java.net.URL@w{ }@var{url}) +Returns an audio clip from the specified URL. +@end deftypemethod +@deftypemethod AppletContext {public Image} getImage (java.net.URL@w{ }@var{url}) +Returns an image from the specified URL. Note that the image is not + actually retrieved until the applet attempts to display it, so this + method returns immediately. +@end deftypemethod +@deftypemethod AppletContext {public Applet} getApplet (java.lang.String@w{ }@var{name}) +Returns the applet in the document for this object that has the + specified name. +@end deftypemethod +@deftypemethod AppletContext {public Enumeration} getApplets () +Returns a list of all the applets in the document for this object. +@end deftypemethod +@deftypemethod AppletContext {public void} showDocument (java.net.URL@w{ }@var{url}) +Displays the web page pointed to by the specified URL in the window + for this object. This page replaces the document that is currently + there. +@end deftypemethod +@deftypemethod AppletContext {public void} showDocument (java.net.URL@w{ }@var{url}, java.lang.String@w{ }@var{target}) +Displays the web page pointed to be the sepcified URL in the window + with the specified name. The standard names "_top", "_blank", + "_parent", and "_self" are allowed. +@end deftypemethod +@deftypemethod AppletContext {public void} showStatus (java.lang.String@w{ }@var{message}) +Displays the specified message in the status window if that window + exists. +@end deftypemethod +@deftypemethod Applet {public URL} getDocumentBase () +Returns the URL of the document this applet is embedded in. +@end deftypemethod +@deftypemethod Applet {public URL} getCodeBase () +Returns the URL of the code base for this applet. +@end deftypemethod +@deftypemethod Applet {public String} getParameter (java.lang.String@w{ }@var{name}) +Returns the value of the specified parameter that was specified in + the <APPLET> tag for this applet. +@end deftypemethod +@deftypemethod Applet {public AppletContext} getAppletContext () +Returns the applet context for this applet. +@end deftypemethod +@deftypemethod Applet {public boolean} isActive () +Tests whether or not this applet is currently active. +@end deftypemethod +@deftypemethod Applet {public void} resize (int@w{ }@var{width}, int@w{ }@var{height}) +Requests that the applet window for this applet be resized. +@end deftypemethod +@deftypemethod Applet {public void} resize (java.awt.Dimension@w{ }@var{dim}) +Requests that the applet window for this applet be resized. +@end deftypemethod +@deftypemethod Applet {public AudioClip} getAudioClip (java.net.URL@w{ }@var{url}) +Returns an audio clip from the specified URL. +@end deftypemethod +@deftypemethod Applet {public AudioClip} getAudioClip (java.net.URL@w{ }@var{url}, java.lang.String@w{ }@var{name}) +Returns an audio clip from the specified URL and name +@end deftypemethod +@deftypemethod Applet {public void} play (java.net.URL@w{ }@var{url}) +Loads and plays the audio clip pointed to by the specified URL. +@end deftypemethod +@deftypemethod Applet {public void} play (java.net.URL@w{ }@var{url}, java.lang.String@w{ }@var{name}) +Loads and plays the audio clip pointed to by the specified URL. +@end deftypemethod +@deftypemethod Applet {public Image} getImage (java.net.URL@w{ }@var{url}) +Returns an image from the specified URL. Note that the image is not + actually retrieved until the applet attempts to display it, so this + method returns immediately. +@end deftypemethod +@deftypemethod Applet {public Image} getImage (java.net.URL@w{ }@var{url}, java.lang.String@w{ }@var{name}) +Returns an image from the specified URL. Note that the image is not + actually retrieved until the applet attempts to display it, so this + method returns immediately. +@end deftypemethod +@deftypemethod Applet {public Locale} getLocale () +Returns the locale for this applet, if it has been set. If no applet + specific locale has been set, the default locale is returned. +@end deftypemethod +@deftypemethod Applet {public String} getAppletInfo () +Returns a descriptive string with applet defined information. The + implementation in this class returns @code{null}. Applets who + wish to return this information should override. +@end deftypemethod +@deftypemethod Applet {public String} getParameterInfo () +Returns a list of parameters this applet supports. Each element of + the array is a list of three strings with the name of the parameter, + the data type or valid values, and a description. This method is + optional and the default implementation returns @code{null}. +@end deftypemethod +@deftypemethod Applet {public void} init () +This method is called when the applet is first loaded. The default + implementation does nothing. Applets that wish to do one time + initialization should override. +@end deftypemethod +@deftypemethod Applet {public void} destroy () +This method is called when the applet is being unloaded. The default + implementation does nothing. Applets that need to clean up resources + on exit should override. +@end deftypemethod +@deftypemethod Applet {public void} start () +This method is called when the applet should start running. This is + normally each time a web page containing it is loaded. The default + implemention does nothing. Subclasses should override. +@end deftypemethod +@deftypemethod Applet {public void} stop () +This method is called when the applet should stop running. This is + normally when the next web page is loaded. The default implementation + does nothing. +@end deftypemethod +@deftypemethod Applet {public final void} setStub (java.applet.AppletStub@w{ }@var{stub}) +The browser calls this method to set the applet's stub, which is the + low level interface to the browser. +@end deftypemethod +@deftypemethod AppletStub {public URL} getDocumentBase () +Returns the URL of the document this applet is embedded in. +@end deftypemethod +@deftypemethod AppletStub {public URL} getCodeBase () +Returns the URL of the code base for this applet. +@end deftypemethod +@deftypemethod AppletStub {public String} getParameter (java.lang.String@w{ }@var{name}) +Returns the value of the specified parameter that was specified in + the <APPLET> tag for this applet. +@end deftypemethod +@deftypemethod AppletStub {public AppletContext} getAppletContext () +Returns the applet context for this applet. +@end deftypemethod +@deftypemethod AppletStub {public boolean} isActive () +Tests whether or not this applet is currently active. +@end deftypemethod +@deftypemethod AppletStub {public void} appletResize (int@w{ }@var{width}, int@w{ }@var{height}) +Requests that the applet window for this applet be resized. +@end deftypemethod +@deftypemethod AudioClip {public void} play () +Plays the audio clip starting from the beginning. +@end deftypemethod +@deftypemethod AudioClip {public void} stop () +Stops playing this audio clip. There is no mechanism for restarting + at the point where the clip is stopped. +@end deftypemethod +@deftypemethod AudioClip {public void} loop () +Plays this audio clip in a continuous loop. +@end deftypemethod diff --git a/libjava/doc/java-awt-color.texi b/libjava/doc/java-awt-color.texi new file mode 100644 index 00000000000..266810784af --- /dev/null +++ b/libjava/doc/java-awt-color.texi @@ -0,0 +1,48 @@ +@deftypemethod ColorSpace {public static ColorSpace} getInstance (int@w{ }@var{colorspace}) + +@end deftypemethod +@deftypemethod ColorSpace {public boolean} isCS_sRGB () + +@end deftypemethod +@deftypemethod ColorSpace {public abstract float} toRGB (float[]@w{ }@var{colorvalue}) + +@end deftypemethod +@deftypemethod ColorSpace {public abstract float} fromRGB (float[]@w{ }@var{rgbvalue}) + +@end deftypemethod +@deftypemethod ColorSpace {public abstract float} toCIEXYZ (float[]@w{ }@var{colorvalue}) + +@end deftypemethod +@deftypemethod ColorSpace {public abstract float} fromCIEXYZ (float[]@w{ }@var{colorvalue}) + +@end deftypemethod +@deftypemethod ColorSpace {public int} getType () + +@end deftypemethod +@deftypemethod ColorSpace {public int} getNumComponents () + +@end deftypemethod +@deftypemethod ColorSpace {public String} getName (int@w{ }@var{idx}) + +@end deftypemethod +@deftypemethod ColorSpace {public String} toString () + +@end deftypemethod +@deftypemethod ICC_ColorSpace {public ICC_Profile} getProfile () + +@end deftypemethod +@deftypemethod ICC_ColorSpace {public float} toRGB (float[]@w{ }@var{colorvalue}) + +@end deftypemethod +@deftypemethod ICC_ColorSpace {public float} fromRGB (float[]@w{ }@var{rgbvalue}) + +@end deftypemethod +@deftypemethod ICC_ColorSpace {public float} toCIEXYZ (float[]@w{ }@var{colorvalue}) + +@end deftypemethod +@deftypemethod ICC_ColorSpace {public float} fromCIEXYZ (float[]@w{ }@var{colorvalue}) + +@end deftypemethod +@deftypemethod ICC_Profile {public int} getNumComponents () + +@end deftypemethod diff --git a/libjava/doc/java-awt-datatransfer.texi b/libjava/doc/java-awt-datatransfer.texi new file mode 100644 index 00000000000..e69de29bb2d --- /dev/null +++ b/libjava/doc/java-awt-datatransfer.texi diff --git a/libjava/doc/java-awt-event.texi b/libjava/doc/java-awt-event.texi new file mode 100644 index 00000000000..e1acf0d3d86 --- /dev/null +++ b/libjava/doc/java-awt-event.texi @@ -0,0 +1,357 @@ +@deftypemethod ActionEvent {public String} getActionCommand () + +@end deftypemethod +@deftypemethod ActionEvent {public int} getModifiers () + +@end deftypemethod +@deftypemethod ActionEvent {public String} paramString () + +@end deftypemethod +@deftypemethod ActionListener {public void} actionPerformed (java.awt.event.ActionEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AdjustmentEvent {public Adjustable} getAdjustable () + +@end deftypemethod +@deftypemethod AdjustmentEvent {public int} getAdjustmentType () + +@end deftypemethod +@deftypemethod AdjustmentEvent {public int} getValue () + +@end deftypemethod +@deftypemethod AdjustmentEvent {public String} paramString () + +@end deftypemethod +@deftypemethod AdjustmentListener {public void} adjustmentValueChanged (java.awt.event.AdjustmentEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventListener {public void} eventDispatched (java.awt.AWTEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod ComponentAdapter {public void} componentHidden (java.awt.event.ComponentEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod ComponentAdapter {public void} componentMoved (java.awt.event.ComponentEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod ComponentAdapter {public void} componentResized (java.awt.event.ComponentEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod ComponentAdapter {public void} componentShown (java.awt.event.ComponentEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod ComponentEvent {public Component} getComponent () + +@end deftypemethod +@deftypemethod ComponentEvent {public String} paramString () + +@end deftypemethod +@deftypemethod ComponentListener {public void} componentHidden (java.awt.event.ComponentEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod ComponentListener {public void} componentMoved (java.awt.event.ComponentEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod ComponentListener {public void} componentResized (java.awt.event.ComponentEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod ComponentListener {public void} componentShown (java.awt.event.ComponentEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod ContainerAdapter {public void} componentAdded (java.awt.event.ContainerEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod ContainerAdapter {public void} componentRemoved (java.awt.event.ContainerEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod ContainerEvent {public Component} getChild () + +@end deftypemethod +@deftypemethod ContainerEvent {public Component} getContainer () + +@end deftypemethod +@deftypemethod ContainerEvent {public String} paramString () + +@end deftypemethod +@deftypemethod ContainerListener {public void} componentAdded (java.awt.event.ContainerEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod ContainerListener {public void} componentRemoved (java.awt.event.ContainerEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod FocusAdapter {public void} focusGained (java.awt.event.FocusEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod FocusAdapter {public void} focusLost (java.awt.event.FocusEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod FocusEvent {public boolean} isTemporary () + +@end deftypemethod +@deftypemethod FocusEvent {public String} paramString () + +@end deftypemethod +@deftypemethod FocusListener {public void} focusGained (java.awt.event.FocusEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod FocusListener {public void} focusLost (java.awt.event.FocusEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod HierarchyBoundsAdapter {public void} ancestorMoved (java.awt.event.HierarchyEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod HierarchyBoundsAdapter {public void} ancestorResized (java.awt.event.HierarchyEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod HierarchyBoundsListener {public void} ancestorMoved (java.awt.event.HierarchyEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod HierarchyBoundsListener {public void} ancestorResized (java.awt.event.HierarchyEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod HierarchyEvent {public Component} getComponent () + +@end deftypemethod +@deftypemethod HierarchyEvent {public Component} getChanged () + +@end deftypemethod +@deftypemethod HierarchyEvent {public Container} getChangedParent () + +@end deftypemethod +@deftypemethod HierarchyEvent {public long} getChangeFlags () + +@end deftypemethod +@deftypemethod HierarchyEvent {public String} paramString () + +@end deftypemethod +@deftypemethod HierarchyListener {public void} hierarchyChanged (java.awt.event.HierarchyEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod InputEvent {public boolean} isShiftDown () + +@end deftypemethod +@deftypemethod InputEvent {public boolean} isControlDown () + +@end deftypemethod +@deftypemethod InputEvent {public boolean} isMetaDown () + +@end deftypemethod +@deftypemethod InputEvent {public boolean} isAltDown () + +@end deftypemethod +@deftypemethod InputEvent {public boolean} isAltGraphDown () + +@end deftypemethod +@deftypemethod InputEvent {public long} getWhen () + +@end deftypemethod +@deftypemethod InputEvent {public int} getModifiers () + +@end deftypemethod +@deftypemethod InputEvent {public boolean} isConsumed () + +@end deftypemethod +@deftypemethod InputEvent {public void} consume () + +@end deftypemethod +@deftypemethod InputMethodListener {public void} caretPositionChanged (java.awt.event.InputMethodEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod InputMethodListener {public void} inputMethodTextChanged (java.awt.event.InputMethodEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod InvocationEvent {public void} dispatch () + +@end deftypemethod +@deftypemethod InvocationEvent {public Exception} getException () + +@end deftypemethod +@deftypemethod InvocationEvent {public String} paramString () + +@end deftypemethod +@deftypemethod ItemEvent {public Object} getItem () + +@end deftypemethod +@deftypemethod ItemEvent {public ItemSelectable} getItemSelectable () + +@end deftypemethod +@deftypemethod ItemEvent {public int} getStateChange () + +@end deftypemethod +@deftypemethod ItemEvent {public String} paramString () + +@end deftypemethod +@deftypemethod ItemListener {public void} itemStateChanged (java.awt.event.ItemEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod KeyAdapter {public void} keyPressed (java.awt.event.KeyEvent@w{ }@var{w}) + +@end deftypemethod +@deftypemethod KeyAdapter {public void} keyReleased (java.awt.event.KeyEvent@w{ }@var{w}) + +@end deftypemethod +@deftypemethod KeyAdapter {public void} keyTyped (java.awt.event.KeyEvent@w{ }@var{w}) + +@end deftypemethod +@deftypemethod KeyEvent {public int} getKeyCode () + +@end deftypemethod +@deftypemethod KeyEvent {public char} getKeyChar () + +@end deftypemethod +@deftypemethod KeyEvent {public void} setKeyCode (int@w{ }@var{keyCode}) + +@end deftypemethod +@deftypemethod KeyEvent {public void} setKeyChar (char@w{ }@var{keyChar}) + +@end deftypemethod +@deftypemethod KeyEvent {public void} setModifiers (int@w{ }@var{modifiers}) + +@end deftypemethod +@deftypemethod KeyEvent {public static String} getKeyText (int@w{ }@var{keyCode}) + +@end deftypemethod +@deftypemethod KeyEvent {public static String} getKeyModifiersText (int@w{ }@var{modifiers}) + +@end deftypemethod +@deftypemethod KeyEvent {public boolean} isActionKey () + +@end deftypemethod +@deftypemethod KeyEvent {public String} paramString () + +@end deftypemethod +@deftypemethod KeyListener {public void} keyPressed (java.awt.event.KeyEvent@w{ }@var{w}) + +@end deftypemethod +@deftypemethod KeyListener {public void} keyReleased (java.awt.event.KeyEvent@w{ }@var{w}) + +@end deftypemethod +@deftypemethod KeyListener {public void} keyTyped (java.awt.event.KeyEvent@w{ }@var{w}) + +@end deftypemethod +@deftypemethod MouseAdapter {public void} mouseClicked (java.awt.event.MouseEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod MouseAdapter {public void} mouseEntered (java.awt.event.MouseEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod MouseAdapter {public void} mouseExited (java.awt.event.MouseEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod MouseAdapter {public void} mousePressed (java.awt.event.MouseEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod MouseAdapter {public void} mouseReleased (java.awt.event.MouseEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod MouseEvent {public int} getClickCount () + +@end deftypemethod +@deftypemethod MouseEvent {public Point} getPoint () + +@end deftypemethod +@deftypemethod MouseEvent {public int} getX () + +@end deftypemethod +@deftypemethod MouseEvent {public int} getY () + +@end deftypemethod +@deftypemethod MouseEvent {public boolean} isPopupTrigger () + +@end deftypemethod +@deftypemethod MouseEvent {public String} paramString () + +@end deftypemethod +@deftypemethod MouseEvent {public void} translatePoint (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod MouseListener {public void} mouseClicked (java.awt.event.MouseEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod MouseListener {public void} mouseEntered (java.awt.event.MouseEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod MouseListener {public void} mouseExited (java.awt.event.MouseEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod MouseListener {public void} mousePressed (java.awt.event.MouseEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod MouseListener {public void} mouseReleased (java.awt.event.MouseEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod MouseMotionAdapter {public void} mouseDragged (java.awt.event.MouseEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod MouseMotionAdapter {public void} mouseMoved (java.awt.event.MouseEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod MouseMotionListener {public void} mouseDragged (java.awt.event.MouseEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod MouseMotionListener {public void} mouseMoved (java.awt.event.MouseEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod PaintEvent {public Rectangle} getUpdateRect () + +@end deftypemethod +@deftypemethod PaintEvent {public String} paramString () + +@end deftypemethod +@deftypemethod PaintEvent {public void} setUpdateRect (java.awt.Rectangle@w{ }@var{updateRect}) + +@end deftypemethod +@deftypemethod TextEvent {public String} paramString () + +@end deftypemethod +@deftypemethod TextListener {public void} textValueChanged (java.awt.event.TextEvent@w{ }@var{w}) + +@end deftypemethod +@deftypemethod WindowAdapter {public void} windowActivated (java.awt.event.WindowEvent@w{ }@var{w}) + +@end deftypemethod +@deftypemethod WindowAdapter {public void} windowClosed (java.awt.event.WindowEvent@w{ }@var{w}) + +@end deftypemethod +@deftypemethod WindowAdapter {public void} windowClosing (java.awt.event.WindowEvent@w{ }@var{w}) + +@end deftypemethod +@deftypemethod WindowAdapter {public void} windowDeactivated (java.awt.event.WindowEvent@w{ }@var{w}) + +@end deftypemethod +@deftypemethod WindowAdapter {public void} windowDeiconified (java.awt.event.WindowEvent@w{ }@var{w}) + +@end deftypemethod +@deftypemethod WindowAdapter {public void} windowIconified (java.awt.event.WindowEvent@w{ }@var{w}) + +@end deftypemethod +@deftypemethod WindowAdapter {public void} windowOpened (java.awt.event.WindowEvent@w{ }@var{w}) + +@end deftypemethod +@deftypemethod WindowEvent {public Window} getWindow () + +@end deftypemethod +@deftypemethod WindowEvent {public String} paramString () + +@end deftypemethod +@deftypemethod WindowListener {public void} windowActivated (java.awt.event.WindowEvent@w{ }@var{w}) + +@end deftypemethod +@deftypemethod WindowListener {public void} windowClosed (java.awt.event.WindowEvent@w{ }@var{w}) + +@end deftypemethod +@deftypemethod WindowListener {public void} windowClosing (java.awt.event.WindowEvent@w{ }@var{w}) + +@end deftypemethod +@deftypemethod WindowListener {public void} windowDeactivated (java.awt.event.WindowEvent@w{ }@var{w}) + +@end deftypemethod +@deftypemethod WindowListener {public void} windowDeiconified (java.awt.event.WindowEvent@w{ }@var{w}) + +@end deftypemethod +@deftypemethod WindowListener {public void} windowIconified (java.awt.event.WindowEvent@w{ }@var{w}) + +@end deftypemethod +@deftypemethod WindowListener {public void} windowOpened (java.awt.event.WindowEvent@w{ }@var{w}) + +@end deftypemethod diff --git a/libjava/doc/java-awt-geom.texi b/libjava/doc/java-awt-geom.texi new file mode 100644 index 00000000000..1913fd0accd --- /dev/null +++ b/libjava/doc/java-awt-geom.texi @@ -0,0 +1,576 @@ +@deftypemethod AffineTransform {public static AffineTransform} getTranslateInstance (double@w{ }@var{tx}, double@w{ }@var{ty}) + +@end deftypemethod +@deftypemethod AffineTransform {public static AffineTransform} getRotateInstance (double@w{ }@var{theta}) + +@end deftypemethod +@deftypemethod AffineTransform {public static AffineTransform} getRotateInstance (double@w{ }@var{theta}, double@w{ }@var{x}, double@w{ }@var{y}) + +@end deftypemethod +@deftypemethod AffineTransform {public static AffineTransform} getScaleInstance (double@w{ }@var{sx}, double@w{ }@var{sy}) + +@end deftypemethod +@deftypemethod AffineTransform {public static AffineTransform} getShearInstance (double@w{ }@var{shx}, double@w{ }@var{shy}) + +@end deftypemethod +@deftypemethod AffineTransform {public int} getType () + +@end deftypemethod +@deftypemethod AffineTransform {public double} getDeterminant () + +@end deftypemethod +@deftypemethod AffineTransform {public void} getMatrix (double[]@w{ }@var{flatmatrix}) + +@end deftypemethod +@deftypemethod AffineTransform {public double} getScaleX () + +@end deftypemethod +@deftypemethod AffineTransform {public double} getScaleY () + +@end deftypemethod +@deftypemethod AffineTransform {public double} getShearX () + +@end deftypemethod +@deftypemethod AffineTransform {public double} getShearY () + +@end deftypemethod +@deftypemethod AffineTransform {public double} getTranslateX () + +@end deftypemethod +@deftypemethod AffineTransform {public double} getTranslateY () + +@end deftypemethod +@deftypemethod AffineTransform {public void} translate (double@w{ }@var{tx}, double@w{ }@var{ty}) + +@end deftypemethod +@deftypemethod AffineTransform {public void} rotate (double@w{ }@var{theta}) + +@end deftypemethod +@deftypemethod AffineTransform {public void} rotate (double@w{ }@var{theta}, double@w{ }@var{x}, double@w{ }@var{y}) + +@end deftypemethod +@deftypemethod AffineTransform {public void} scale (double@w{ }@var{sx}, double@w{ }@var{sy}) + +@end deftypemethod +@deftypemethod AffineTransform {public void} shear (double@w{ }@var{shx}, double@w{ }@var{shy}) + +@end deftypemethod +@deftypemethod AffineTransform {public void} setToIdentity () + +@end deftypemethod +@deftypemethod AffineTransform {public void} setToTranslation (double@w{ }@var{tx}, double@w{ }@var{ty}) + +@end deftypemethod +@deftypemethod AffineTransform {public void} setToRotation (double@w{ }@var{theta}) + +@end deftypemethod +@deftypemethod AffineTransform {public void} setToScale (double@w{ }@var{sx}, double@w{ }@var{sy}) + +@end deftypemethod +@deftypemethod AffineTransform {public void} setToShear (double@w{ }@var{shx}, double@w{ }@var{shy}) + +@end deftypemethod +@deftypemethod AffineTransform {public void} setTransform (java.awt.geom.AffineTransform@w{ }@var{tx}) + +@end deftypemethod +@deftypemethod AffineTransform {public void} setTransform (double@w{ }@var{m00}, double@w{ }@var{m10}, double@w{ }@var{m01}, double@w{ }@var{m11}, double@w{ }@var{m02}, double@w{ }@var{m12}) + +@end deftypemethod +@deftypemethod AffineTransform {public void} concatenate (java.awt.geom.AffineTransform@w{ }@var{tx}) + +@end deftypemethod +@deftypemethod AffineTransform {public void} preConcatenate (java.awt.geom.AffineTransform@w{ }@var{tx}) + +@end deftypemethod +@deftypemethod AffineTransform {public AffineTransform} createInverse () @*throws NoninvertibleTransformException + +@end deftypemethod +@deftypemethod AffineTransform {public Point2D} transform (java.awt.geom.Point2D@w{ }@var{src}, java.awt.geom.Point2D@w{ }@var{dst}) + +@end deftypemethod +@deftypemethod AffineTransform {public void} transform (java.awt.geom.Point2D[]@w{ }@var{src}, int@w{ }@var{srcOff}, java.awt.geom.Point2D[]@w{ }@var{dst}, int@w{ }@var{dstOff}, int@w{ }@var{num}) + +@end deftypemethod +@deftypemethod AffineTransform {public void} transform (float[]@w{ }@var{srcPts}, int@w{ }@var{srcOff}, float[]@w{ }@var{dstPts}, int@w{ }@var{dstOff}, int@w{ }@var{num}) + +@end deftypemethod +@deftypemethod AffineTransform {public void} transform (double[]@w{ }@var{srcPts}, int@w{ }@var{srcOff}, double[]@w{ }@var{dstPts}, int@w{ }@var{dstOff}, int@w{ }@var{num}) + +@end deftypemethod +@deftypemethod AffineTransform {public void} transform (float[]@w{ }@var{srcPts}, int@w{ }@var{srcOff}, double[]@w{ }@var{dstPts}, int@w{ }@var{dstOff}, int@w{ }@var{num}) + +@end deftypemethod +@deftypemethod AffineTransform {public void} transform (double[]@w{ }@var{srcPts}, int@w{ }@var{srcOff}, float[]@w{ }@var{dstPts}, int@w{ }@var{dstOff}, int@w{ }@var{num}) + +@end deftypemethod +@deftypemethod AffineTransform {public Point2D} inverseTransform (java.awt.geom.Point2D@w{ }@var{src}, java.awt.geom.Point2D@w{ }@var{dst}) @*throws NoninvertibleTransformException + +@end deftypemethod +@deftypemethod AffineTransform {public void} inverseTransform (double[]@w{ }@var{srcPts}, int@w{ }@var{srcOff}, double[]@w{ }@var{dstPts}, int@w{ }@var{dstOff}, int@w{ }@var{num}) @*throws NoninvertibleTransformException + +@end deftypemethod +@deftypemethod AffineTransform {public Point2D} deltaTransform (java.awt.geom.Point2D@w{ }@var{src}, java.awt.geom.Point2D@w{ }@var{dst}) + +@end deftypemethod +@deftypemethod AffineTransform {public void} deltaTransform (double[]@w{ }@var{srcPts}, int@w{ }@var{srcOff}, double[]@w{ }@var{dstPts}, int@w{ }@var{dstOff}, int@w{ }@var{num}) + +@end deftypemethod +@deftypemethod AffineTransform {public Shape} createTransformedShape (java.awt.Shape@w{ }@var{pSrc}) + +@end deftypemethod +@deftypemethod AffineTransform {public String} toString () + +@end deftypemethod +@deftypemethod AffineTransform {public boolean} isIdentity () + +@end deftypemethod +@deftypemethod AffineTransform {public Object} clone () + +@end deftypemethod +@deftypemethod AffineTransform {public int} hashCode () + +@end deftypemethod +@deftypemethod AffineTransform {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod Dimension2D {public abstract double} getWidth () + +@end deftypemethod +@deftypemethod Dimension2D {public abstract double} getHeight () + +@end deftypemethod +@deftypemethod Dimension2D {public abstract void} setSize (double@w{ }@var{width}, double@w{ }@var{height}) + +@end deftypemethod +@deftypemethod Dimension2D {public void} setSize (java.awt.geom.Dimension2D@w{ }@var{dim}) + +@end deftypemethod +@deftypemethod Dimension2D {public Object} clone () + +@end deftypemethod +@deftypemethod Ellipse2D {public boolean} contains (double@w{ }@var{x}, double@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Ellipse2D {public boolean} contains (double@w{ }@var{x}, double@w{ }@var{y}, double@w{ }@var{w}, double@w{ }@var{h}) + +@end deftypemethod +@deftypemethod Ellipse2D {public PathIterator} getPathIterator (java.awt.geom.AffineTransform@w{ }@var{at}) + +@end deftypemethod +@deftypemethod Ellipse2D {public boolean} intersects (double@w{ }@var{x}, double@w{ }@var{y}, double@w{ }@var{w}, double@w{ }@var{h}) + +@end deftypemethod +@deftypemethod Ellipse2D.Double {public Rectangle2D} getBounds2D () + +@end deftypemethod +@deftypemethod Ellipse2D.Double {public double} getHeight () + +@end deftypemethod +@deftypemethod Ellipse2D.Double {public double} getWidth () + +@end deftypemethod +@deftypemethod Ellipse2D.Double {public double} getX () + +@end deftypemethod +@deftypemethod Ellipse2D.Double {public double} getY () + +@end deftypemethod +@deftypemethod Ellipse2D.Double {public boolean} isEmpty () + +@end deftypemethod +@deftypemethod Ellipse2D.Double {public void} setFrame (double@w{ }@var{x}, double@w{ }@var{y}, double@w{ }@var{w}, double@w{ }@var{h}) + +@end deftypemethod +@deftypemethod Ellipse2D.Float {public Rectangle2D} getBounds2D () + +@end deftypemethod +@deftypemethod Ellipse2D.Float {public double} getHeight () + +@end deftypemethod +@deftypemethod Ellipse2D.Float {public double} getWidth () + +@end deftypemethod +@deftypemethod Ellipse2D.Float {public double} getX () + +@end deftypemethod +@deftypemethod Ellipse2D.Float {public double} getY () + +@end deftypemethod +@deftypemethod Ellipse2D.Float {public boolean} isEmpty () + +@end deftypemethod +@deftypemethod Ellipse2D.Float {public void} setFrame (float@w{ }@var{x}, float@w{ }@var{y}, float@w{ }@var{w}, float@w{ }@var{h}) + +@end deftypemethod +@deftypemethod Ellipse2D.Float {public void} setFrame (double@w{ }@var{x}, double@w{ }@var{y}, double@w{ }@var{w}, double@w{ }@var{h}) + +@end deftypemethod +@deftypemethod PathIterator {public int} currentSegment (double[]@w{ }@var{coords}) + +@end deftypemethod +@deftypemethod PathIterator {public int} currentSegment (float[]@w{ }@var{coords}) + +@end deftypemethod +@deftypemethod PathIterator {public int} getWindingRule () + +@end deftypemethod +@deftypemethod PathIterator {public boolean} isDone () + +@end deftypemethod +@deftypemethod PathIterator {public void} next () + +@end deftypemethod +@deftypemethod Point2D {public abstract double} getX () + +@end deftypemethod +@deftypemethod Point2D {public abstract double} getY () + +@end deftypemethod +@deftypemethod Point2D {public abstract void} setLocation (double@w{ }@var{x}, double@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Point2D {public void} setLocation (java.awt.geom.Point2D@w{ }@var{pt}) + +@end deftypemethod +@deftypemethod Point2D {public static double} distanceSq (double@w{ }@var{X1}, double@w{ }@var{Y1}, double@w{ }@var{X2}, double@w{ }@var{Y2}) + +@end deftypemethod +@deftypemethod Point2D {public static double} distance (double@w{ }@var{X1}, double@w{ }@var{Y1}, double@w{ }@var{X2}, double@w{ }@var{Y2}) + +@end deftypemethod +@deftypemethod Point2D {public double} distanceSq (double@w{ }@var{PX}, double@w{ }@var{PY}) + +@end deftypemethod +@deftypemethod Point2D {public double} distance (double@w{ }@var{PX}, double@w{ }@var{PY}) + +@end deftypemethod +@deftypemethod Point2D {public double} distanceSq (java.awt.geom.Point2D@w{ }@var{pt}) + +@end deftypemethod +@deftypemethod Point2D {public double} distance (java.awt.geom.Point2D@w{ }@var{pt}) + +@end deftypemethod +@deftypemethod Point2D {public int} hashCode () + +@end deftypemethod +@deftypemethod Point2D {public Object} clone () + +@end deftypemethod +@deftypemethod Point2D {public boolean} equals (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod Point2D.Double {public double} getX () + +@end deftypemethod +@deftypemethod Point2D.Double {public double} getY () + +@end deftypemethod +@deftypemethod Point2D.Double {public void} setLocation (double@w{ }@var{x}, double@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Point2D.Double {public String} toString () + +@end deftypemethod +@deftypemethod Point2D.Float {public double} getX () + +@end deftypemethod +@deftypemethod Point2D.Float {public double} getY () + +@end deftypemethod +@deftypemethod Point2D.Float {public void} setLocation (double@w{ }@var{x}, double@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Point2D.Float {public void} setLocation (float@w{ }@var{x}, float@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Point2D.Float {public String} toString () + +@end deftypemethod +@deftypemethod Rectangle2D {public abstract void} setRect (double@w{ }@var{x}, double@w{ }@var{y}, double@w{ }@var{w}, double@w{ }@var{h}) +Set the bounding box of this rectangle. +@end deftypemethod +@deftypemethod Rectangle2D {public void} setRect (java.awt.geom.Rectangle2D@w{ }@var{r}) +Set the bounding box of this rectangle. +@end deftypemethod +@deftypemethod Rectangle2D {public boolean} intersectsLine (double@w{ }@var{x1}, double@w{ }@var{y1}, double@w{ }@var{x2}, double@w{ }@var{y2}) +Returns true if line segment intersects interior of this + rectangle. +@end deftypemethod +@deftypemethod Rectangle2D {public abstract int} outcode (double@w{ }@var{x}, double@w{ }@var{y}) +Return true if line segment intersects interior of this + rectangle. +@end deftypemethod +@deftypemethod Rectangle2D {public int} outcode (java.awt.geom.Point2D@w{ }@var{p}) + +@end deftypemethod +@deftypemethod Rectangle2D {public void} setFrame (double@w{ }@var{x}, double@w{ }@var{y}, double@w{ }@var{w}, double@w{ }@var{h}) +Set bounding frame for this rectangle. +@end deftypemethod +@deftypemethod Rectangle2D {public Rectangle2D} getBounds2D () + +@end deftypemethod +@deftypemethod Rectangle2D {public boolean} contains (double@w{ }@var{x}, double@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Rectangle2D {public boolean} intersects (double@w{ }@var{x}, double@w{ }@var{y}, double@w{ }@var{w}, double@w{ }@var{h}) + +@end deftypemethod +@deftypemethod Rectangle2D {public boolean} contains (double@w{ }@var{x}, double@w{ }@var{y}, double@w{ }@var{w}, double@w{ }@var{h}) + +@end deftypemethod +@deftypemethod Rectangle2D {public abstract Rectangle2D} createIntersection (java.awt.geom.Rectangle2D@w{ }@var{r}) + +@end deftypemethod +@deftypemethod Rectangle2D {public static void} intersect (java.awt.geom.Rectangle2D@w{ }@var{src1}, java.awt.geom.Rectangle2D@w{ }@var{src2}, java.awt.geom.Rectangle2D@w{ }@var{dest}) + +@end deftypemethod +@deftypemethod Rectangle2D {public abstract Rectangle2D} createUnion (java.awt.geom.Rectangle2D@w{ }@var{r}) + +@end deftypemethod +@deftypemethod Rectangle2D {public static void} union (java.awt.geom.Rectangle2D@w{ }@var{src1}, java.awt.geom.Rectangle2D@w{ }@var{src2}, java.awt.geom.Rectangle2D@w{ }@var{dest}) + +@end deftypemethod +@deftypemethod Rectangle2D {public void} add (double@w{ }@var{newx}, double@w{ }@var{newy}) + +@end deftypemethod +@deftypemethod Rectangle2D {public void} add (java.awt.geom.Point2D@w{ }@var{p}) + +@end deftypemethod +@deftypemethod Rectangle2D {public void} add (java.awt.geom.Rectangle2D@w{ }@var{r}) + +@end deftypemethod +@deftypemethod Rectangle2D {public PathIterator} getPathIterator (java.awt.geom.AffineTransform@w{ }@var{at}) + +@end deftypemethod +@deftypemethod Rectangle2D.Double {public double} getX () + +@end deftypemethod +@deftypemethod Rectangle2D.Double {public double} getY () + +@end deftypemethod +@deftypemethod Rectangle2D.Double {public double} getWidth () + +@end deftypemethod +@deftypemethod Rectangle2D.Double {public double} getHeight () + +@end deftypemethod +@deftypemethod Rectangle2D.Double {public boolean} isEmpty () + +@end deftypemethod +@deftypemethod Rectangle2D.Double {public void} setRect (double@w{ }@var{x}, double@w{ }@var{y}, double@w{ }@var{w}, double@w{ }@var{h}) + +@end deftypemethod +@deftypemethod Rectangle2D.Double {public void} setRect (java.awt.geom.Rectangle2D@w{ }@var{r}) + +@end deftypemethod +@deftypemethod Rectangle2D.Double {public int} outcode (double@w{ }@var{x}, double@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Rectangle2D.Double {public Rectangle2D} getBounds2D () + +@end deftypemethod +@deftypemethod Rectangle2D.Double {public Rectangle2D} createIntersection (java.awt.geom.Rectangle2D@w{ }@var{r}) + +@end deftypemethod +@deftypemethod Rectangle2D.Double {public Rectangle2D} createUnion (java.awt.geom.Rectangle2D@w{ }@var{r}) + +@end deftypemethod +@deftypemethod Rectangle2D.Double {public String} toString () + +@end deftypemethod +@deftypemethod Rectangle2D.Float {public double} getX () + +@end deftypemethod +@deftypemethod Rectangle2D.Float {public double} getY () + +@end deftypemethod +@deftypemethod Rectangle2D.Float {public double} getWidth () + +@end deftypemethod +@deftypemethod Rectangle2D.Float {public double} getHeight () + +@end deftypemethod +@deftypemethod Rectangle2D.Float {public boolean} isEmpty () + +@end deftypemethod +@deftypemethod Rectangle2D.Float {public void} setRect (double@w{ }@var{x}, double@w{ }@var{y}, double@w{ }@var{w}, double@w{ }@var{h}) + +@end deftypemethod +@deftypemethod Rectangle2D.Float {public void} setRect (java.awt.geom.Rectangle2D@w{ }@var{r}) + +@end deftypemethod +@deftypemethod Rectangle2D.Float {public int} outcode (double@w{ }@var{x}, double@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Rectangle2D.Float {public Rectangle2D} getBounds2D () + +@end deftypemethod +@deftypemethod Rectangle2D.Float {public Rectangle2D} createIntersection (java.awt.geom.Rectangle2D@w{ }@var{r}) + +@end deftypemethod +@deftypemethod Rectangle2D.Float {public Rectangle2D} createUnion (java.awt.geom.Rectangle2D@w{ }@var{r}) + +@end deftypemethod +@deftypemethod Rectangle2D.Float {public String} toString () + +@end deftypemethod +@deftypemethod RectangularShape {public abstract double} getX () + +@end deftypemethod +@deftypemethod RectangularShape {public abstract double} getY () + +@end deftypemethod +@deftypemethod RectangularShape {public abstract double} getWidth () + +@end deftypemethod +@deftypemethod RectangularShape {public abstract double} getHeight () + +@end deftypemethod +@deftypemethod RectangularShape {public double} getMinX () + +@end deftypemethod +@deftypemethod RectangularShape {public double} getMinY () + +@end deftypemethod +@deftypemethod RectangularShape {public double} getMaxX () + +@end deftypemethod +@deftypemethod RectangularShape {public double} getMaxY () + +@end deftypemethod +@deftypemethod RectangularShape {public double} getCenterX () + +@end deftypemethod +@deftypemethod RectangularShape {public double} getCenterY () + +@end deftypemethod +@deftypemethod RectangularShape {public Rectangle2D} getFrame () + +@end deftypemethod +@deftypemethod RectangularShape {public abstract boolean} isEmpty () + +@end deftypemethod +@deftypemethod RectangularShape {public abstract void} setFrame (double@w{ }@var{x}, double@w{ }@var{y}, double@w{ }@var{w}, double@w{ }@var{h}) + +@end deftypemethod +@deftypemethod RectangularShape {public void} setFrame (java.awt.geom.Point2D@w{ }@var{loc}, java.awt.geom.Dimension2D@w{ }@var{size}) + +@end deftypemethod +@deftypemethod RectangularShape {public void} setFrame (java.awt.geom.Rectangle2D@w{ }@var{r}) + +@end deftypemethod +@deftypemethod RectangularShape {public void} setFrameFromDiagonal (double@w{ }@var{x1}, double@w{ }@var{y1}, double@w{ }@var{x2}, double@w{ }@var{y2}) + +@end deftypemethod +@deftypemethod RectangularShape {public void} setFrameFromDiagonal (java.awt.geom.Point2D@w{ }@var{p1}, java.awt.geom.Point2D@w{ }@var{p2}) + +@end deftypemethod +@deftypemethod RectangularShape {public void} setFrameFromCenter (double@w{ }@var{centerX}, double@w{ }@var{centerY}, double@w{ }@var{cornerX}, double@w{ }@var{cornerY}) + +@end deftypemethod +@deftypemethod RectangularShape {public void} setFrameFromCenter (java.awt.geom.Point2D@w{ }@var{center}, java.awt.geom.Point2D@w{ }@var{corner}) + +@end deftypemethod +@deftypemethod RectangularShape {public boolean} contains (java.awt.geom.Point2D@w{ }@var{p}) + +@end deftypemethod +@deftypemethod RectangularShape {public boolean} intersects (java.awt.geom.Rectangle2D@w{ }@var{r}) + +@end deftypemethod +@deftypemethod RectangularShape {public boolean} contains (java.awt.geom.Rectangle2D@w{ }@var{r}) + +@end deftypemethod +@deftypemethod RectangularShape {public Rectangle} getBounds () + +@end deftypemethod +@deftypemethod RectangularShape {public PathIterator} getPathIterator (java.awt.geom.AffineTransform@w{ }@var{at}, double@w{ }@var{flatness}) + +@end deftypemethod +@deftypemethod RectangularShape {public Object} clone () + +@end deftypemethod +@deftypemethod RoundRectangle2D {public abstract double} getArcHeight () +Return the arc height of this round rectangle. +@end deftypemethod +@deftypemethod RoundRectangle2D {public abstract double} getArcWidth () +Return the arc width of this round rectangle. +@end deftypemethod +@deftypemethod RoundRectangle2D {public abstract void} setRoundRect (double@w{ }@var{x}, double@w{ }@var{y}, double@w{ }@var{w}, double@w{ }@var{h}, double@w{ }@var{arcWidth}, double@w{ }@var{arcHeight}) +Set the values of this round rectangle +@end deftypemethod +@deftypemethod RoundRectangle2D {public boolean} contains (double@w{ }@var{x}, double@w{ }@var{y}) +Return true if this object contains the specified point. +@end deftypemethod +@deftypemethod RoundRectangle2D {public boolean} contains (double@w{ }@var{x}, double@w{ }@var{y}, double@w{ }@var{w}, double@w{ }@var{h}) +Return true if this object contains the specified rectangle +@end deftypemethod +@deftypemethod RoundRectangle2D {public PathIterator} getPathIterator (java.awt.geom.AffineTransform@w{ }@var{at}) +Return a new path iterator which iterates over this rectangle. +@end deftypemethod +@deftypemethod RoundRectangle2D {public boolean} intersects (double@w{ }@var{x}, double@w{ }@var{y}, double@w{ }@var{w}, double@w{ }@var{h}) +Return true if the given rectangle intersects this shape. +@end deftypemethod +@deftypemethod RoundRectangle2D {public void} setFrame (double@w{ }@var{x}, double@w{ }@var{y}, double@w{ }@var{w}, double@w{ }@var{h}) +Set the boundary of this round rectangle. +@end deftypemethod +@deftypemethod RoundRectangle2D {public void} setRoundRect (java.awt.geom.RoundRectangle2D@w{ }@var{rr}) +Set the values of this round rectangle to be the same as those + of the argument. +@end deftypemethod +@deftypemethod RoundRectangle2D.Float {public double} getArcHeight () + +@end deftypemethod +@deftypemethod RoundRectangle2D.Float {public double} getArcWidth () + +@end deftypemethod +@deftypemethod RoundRectangle2D.Float {public Rectangle2D} getBounds2D () + +@end deftypemethod +@deftypemethod RoundRectangle2D.Float {public double} getX () + +@end deftypemethod +@deftypemethod RoundRectangle2D.Float {public double} getY () + +@end deftypemethod +@deftypemethod RoundRectangle2D.Float {public double} getWidth () + +@end deftypemethod +@deftypemethod RoundRectangle2D.Float {public double} getHeight () + +@end deftypemethod +@deftypemethod RoundRectangle2D.Float {public boolean} isEmpty () + +@end deftypemethod +@deftypemethod RoundRectangle2D.Float {public void} setRoundRect (float@w{ }@var{x}, float@w{ }@var{y}, float@w{ }@var{w}, float@w{ }@var{h}, float@w{ }@var{arcWidth}, float@w{ }@var{arcHeight}) + +@end deftypemethod +@deftypemethod RoundRectangle2D.Float {public void} setRoundRect (double@w{ }@var{x}, double@w{ }@var{y}, double@w{ }@var{w}, double@w{ }@var{h}, double@w{ }@var{arcWidth}, double@w{ }@var{arcHeight}) + +@end deftypemethod +@deftypemethod RoundRectangle2D.Double {public double} getArcHeight () + +@end deftypemethod +@deftypemethod RoundRectangle2D.Double {public double} getArcWidth () + +@end deftypemethod +@deftypemethod RoundRectangle2D.Double {public Rectangle2D} getBounds2D () + +@end deftypemethod +@deftypemethod RoundRectangle2D.Double {public double} getX () + +@end deftypemethod +@deftypemethod RoundRectangle2D.Double {public double} getY () + +@end deftypemethod +@deftypemethod RoundRectangle2D.Double {public double} getWidth () + +@end deftypemethod +@deftypemethod RoundRectangle2D.Double {public double} getHeight () + +@end deftypemethod +@deftypemethod RoundRectangle2D.Double {public boolean} isEmpty () + +@end deftypemethod +@deftypemethod RoundRectangle2D.Double {public void} setRoundRect (double@w{ }@var{x}, double@w{ }@var{y}, double@w{ }@var{w}, double@w{ }@var{h}, double@w{ }@var{arcWidth}, double@w{ }@var{arcHeight}) + +@end deftypemethod diff --git a/libjava/doc/java-awt-image.texi b/libjava/doc/java-awt-image.texi new file mode 100644 index 00000000000..a658628376c --- /dev/null +++ b/libjava/doc/java-awt-image.texi @@ -0,0 +1,1149 @@ +@deftypemethod BufferedImage {public void} coerceData (boolean@w{ }@var{premultiplied}) + +@end deftypemethod +@deftypemethod BufferedImage {public WritableRaster} copyData (java.awt.image.WritableRaster@w{ }@var{dest}) + +@end deftypemethod +@deftypemethod BufferedImage {public Graphics2D} createGraphics () + +@end deftypemethod +@deftypemethod BufferedImage {public void} flush () + +@end deftypemethod +@deftypemethod BufferedImage {public WritableRaster} getAlphaRaster () + +@end deftypemethod +@deftypemethod BufferedImage {public ColorModel} getColorModel () + +@end deftypemethod +@deftypemethod BufferedImage {public Raster} getData () + +@end deftypemethod +@deftypemethod BufferedImage {public Raster} getData (java.awt.Rectangle@w{ }@var{rectangle}) + +@end deftypemethod +@deftypemethod BufferedImage {public Graphics} getGraphics () + +@end deftypemethod +@deftypemethod BufferedImage {public int} getHeight () + +@end deftypemethod +@deftypemethod BufferedImage {public int} getHeight (java.awt.image.ImageObserver@w{ }@var{imageobserver}) + +@end deftypemethod +@deftypemethod BufferedImage {public int} getMinTileX () + +@end deftypemethod +@deftypemethod BufferedImage {public int} getMinTileY () + +@end deftypemethod +@deftypemethod BufferedImage {public int} getMinX () + +@end deftypemethod +@deftypemethod BufferedImage {public int} getMinY () + +@end deftypemethod +@deftypemethod BufferedImage {public int} getNumXTiles () + +@end deftypemethod +@deftypemethod BufferedImage {public int} getNumYTiles () + +@end deftypemethod +@deftypemethod BufferedImage {public Object} getProperty (java.lang.String@w{ }@var{string}) + +@end deftypemethod +@deftypemethod BufferedImage {public Object} getProperty (java.lang.String@w{ }@var{string}, java.awt.image.ImageObserver@w{ }@var{imageobserver}) + +@end deftypemethod +@deftypemethod BufferedImage {public String} getPropertyNames () + +@end deftypemethod +@deftypemethod BufferedImage {public int} getRGB (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod BufferedImage {public int} getRGB (int@w{ }@var{startX}, int@w{ }@var{startY}, int@w{ }@var{w}, int@w{ }@var{h}, int[]@w{ }@var{rgbArray}, int@w{ }@var{offset}, int@w{ }@var{scanlineStride}) + +@end deftypemethod +@deftypemethod BufferedImage {public WritableRaster} getRaster () + +@end deftypemethod +@deftypemethod BufferedImage {public SampleModel} getSampleModel () + +@end deftypemethod +@deftypemethod BufferedImage {public ImageProducer} getSource () + +@end deftypemethod +@deftypemethod BufferedImage {public Vector} getSources () + +@end deftypemethod +@deftypemethod BufferedImage {public BufferedImage} getSubimage (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}) + +@end deftypemethod +@deftypemethod BufferedImage {public Raster} getTile (int@w{ }@var{tileX}, int@w{ }@var{tileY}) + +@end deftypemethod +@deftypemethod BufferedImage {public int} getTileGridXOffset () + +@end deftypemethod +@deftypemethod BufferedImage {public int} getTileGridYOffset () + +@end deftypemethod +@deftypemethod BufferedImage {public int} getTileHeight () + +@end deftypemethod +@deftypemethod BufferedImage {public int} getTileWidth () + +@end deftypemethod +@deftypemethod BufferedImage {public int} getType () + +@end deftypemethod +@deftypemethod BufferedImage {public int} getWidth () + +@end deftypemethod +@deftypemethod BufferedImage {public int} getWidth (java.awt.image.ImageObserver@w{ }@var{imageobserver}) + +@end deftypemethod +@deftypemethod BufferedImage {public WritableRaster} getWritableTile (int@w{ }@var{tileX}, int@w{ }@var{tileY}) + +@end deftypemethod +@deftypemethod BufferedImage {public Point} getWritableTileIndices () + +@end deftypemethod +@deftypemethod BufferedImage {public boolean} hasTileWriters () + +@end deftypemethod +@deftypemethod BufferedImage {public boolean} isAlphaPremultiplied () + +@end deftypemethod +@deftypemethod BufferedImage {public boolean} isTileWritable (int@w{ }@var{tileX}, int@w{ }@var{tileY}) + +@end deftypemethod +@deftypemethod BufferedImage {public void} releaseWritableTile (int@w{ }@var{tileX}, int@w{ }@var{tileY}) + +@end deftypemethod +@deftypemethod BufferedImage {public void} setData (java.awt.image.Raster@w{ }@var{src}) + +@end deftypemethod +@deftypemethod BufferedImage {public void} setRGB (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{argb}) + +@end deftypemethod +@deftypemethod BufferedImage {public void} setRGB (int@w{ }@var{startX}, int@w{ }@var{startY}, int@w{ }@var{w}, int@w{ }@var{h}, int[]@w{ }@var{argbArray}, int@w{ }@var{offset}, int@w{ }@var{scanlineStride}) + +@end deftypemethod +@deftypemethod BufferedImage {public String} toString () + +@end deftypemethod +@deftypemethod ColorModel {public static ColorModel} getRGBdefault () + +@end deftypemethod +@deftypemethod ColorModel {public final boolean} hasAlpha () + +@end deftypemethod +@deftypemethod ColorModel {public final boolean} isAlphaPremultiplied () + +@end deftypemethod +@deftypemethod ColorModel {public int} getPixelSize () + +@end deftypemethod +@deftypemethod ColorModel {public int} getComponentSize (int@w{ }@var{componentIdx}) + +@end deftypemethod +@deftypemethod ColorModel {public int} getComponentSize () + +@end deftypemethod +@deftypemethod ColorModel {public int} getTransparency () + +@end deftypemethod +@deftypemethod ColorModel {public int} getNumComponents () + +@end deftypemethod +@deftypemethod ColorModel {public int} getNumColorComponents () + +@end deftypemethod +@deftypemethod ColorModel {public abstract int} getRed (int@w{ }@var{pixel}) +Converts pixel value to sRGB and extract red int sample scaled + to range [0, 255]. +@end deftypemethod +@deftypemethod ColorModel {public abstract int} getGreen (int@w{ }@var{pixel}) +Converts pixel value to sRGB and extract green int sample + scaled to range [0, 255]. +@end deftypemethod +@deftypemethod ColorModel {public abstract int} getBlue (int@w{ }@var{pixel}) +Converts pixel value to sRGB and extract blue int sample + scaled to range [0, 255]. +@end deftypemethod +@deftypemethod ColorModel {public abstract int} getAlpha (int@w{ }@var{pixel}) +Extract alpha int sample from pixel value, scaled to [0, 255]. +@end deftypemethod +@deftypemethod ColorModel {public int} getRGB (int@w{ }@var{pixel}) +Converts a pixel int value of the color space of the color + model to a sRGB pixel int value. + + This method is typically overriden in subclasses to provide a + more efficient implementation. +@end deftypemethod +@deftypemethod ColorModel {public int} getRed (java.lang.Object@w{ }@var{inData}) +Converts pixel in the given array to sRGB and extract blue int + sample scaled to range [0-255]. + + This method is typically overriden in subclasses to provide a + more efficient implementation. +@end deftypemethod +@deftypemethod ColorModel {public int} getGreen (java.lang.Object@w{ }@var{inData}) + +@end deftypemethod +@deftypemethod ColorModel {public int} getBlue (java.lang.Object@w{ }@var{inData}) + +@end deftypemethod +@deftypemethod ColorModel {public int} getAlpha (java.lang.Object@w{ }@var{inData}) + +@end deftypemethod +@deftypemethod ColorModel {public int} getRGB (java.lang.Object@w{ }@var{inData}) +Converts a pixel in the given array of the color space of the + color model to an sRGB pixel int value. + + + +This method performs the inverse function of + @code{getDataElements(int rgb, Object pixel)}. + I.e. @code{(rgb == cm.getRGB(cm.getDataElements(rgb, + null)))}. +@end deftypemethod +@deftypemethod ColorModel {public Object} getDataElements (int@w{ }@var{rgb}, java.lang.Object@w{ }@var{pixel}) +Converts an sRGB pixel int value to an array containing a + single pixel of the color space of the color model. + + + +This method performs the inverse function of + @code{getRGB(Object inData)}. + + Outline of conversion process: + + +@itemize @bullet + + + +@item +Convert rgb to normalized [0.0, 1.0] sRGB values. + + + +@item +Convert to color space components using fromRGB in + ColorSpace. + + + +@item +If color model has alpha and should be premultiplied, + multiply color space components with alpha value + + + +@item +Scale the components to the correct number of bits. + + + +@item +Arrange the components in the output array + + + +@end itemize + +@end deftypemethod +@deftypemethod ColorModel {public int} getComponents (int@w{ }@var{pixel}, int[]@w{ }@var{components}, int@w{ }@var{offset}) +Fills an array with the unnormalized component samples from a + pixel value. I.e. decompose the pixel, but not perform any + color conversion. + + This method is typically overriden in subclasses to provide a + more efficient implementation. +@end deftypemethod +@deftypemethod ColorModel {public int} getComponents (java.lang.Object@w{ }@var{pixel}, int[]@w{ }@var{components}, int@w{ }@var{offset}) +Fills an array with the unnormalized component samples from an + array of transferType containing a single pixel. I.e. decompose + the pixel, but not perform any color conversion. + + This method is typically overriden in subclasses to provide a + more efficient implementation. +@end deftypemethod +@deftypemethod ColorModel {public int} getUnnormalizedComponents (float[]@w{ }@var{normComponents}, int@w{ }@var{normOffset}, int[]@w{ }@var{components}, int@w{ }@var{offset}) +Convert normalized components to unnormalized components. +@end deftypemethod +@deftypemethod ColorModel {public float} getNormalizedComponents (int[]@w{ }@var{components}, int@w{ }@var{offset}, float[]@w{ }@var{normComponents}, int@w{ }@var{normOffset}) +Convert unnormalized components to normalized components. +@end deftypemethod +@deftypemethod ColorModel {public int} getDataElement (int[]@w{ }@var{components}, int@w{ }@var{offset}) +Converts the unnormalized component samples from an array to a + pixel value. I.e. composes the pixel from component samples, but + does not perform any color conversion or scaling of the samples. + + This method performs the inverse function of + @code{getComponents(int pixel, int[] components, + int offset)}. I.e. + + @code{(pixel == cm.getDataElement(cm.getComponents(pixel, null, + 0), 0))}. + + This method is typically overriden in subclasses to provide a + more efficient implementation. +@end deftypemethod +@deftypemethod ColorModel {public Object} getDataElements (int[]@w{ }@var{components}, int@w{ }@var{offset}, java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod ColorModel {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod ColorModel {public final ColorSpace} getColorSpace () + +@end deftypemethod +@deftypemethod ColorModel {public ColorModel} coerceData (java.awt.image.WritableRaster@w{ }@var{raster}, boolean@w{ }@var{isAlphaPremultiplied}) + +@end deftypemethod +@deftypemethod ColorModel {public boolean} isCompatibleRaster (java.awt.image.Raster@w{ }@var{raster}) + +@end deftypemethod +@deftypemethod ColorModel {public WritableRaster} createCompatibleWritableRaster (int@w{ }@var{w}, int@w{ }@var{h}) + +@end deftypemethod +@deftypemethod ColorModel {public SampleModel} createCompatibleSampleModel (int@w{ }@var{w}, int@w{ }@var{h}) + +@end deftypemethod +@deftypemethod ColorModel {public boolean} isCompatibleSampleModel (java.awt.image.SampleModel@w{ }@var{sm}) + +@end deftypemethod +@deftypemethod ColorModel {public void} finalize () + +@end deftypemethod +@deftypemethod ColorModel {public WritableRaster} getAlphaRaster (java.awt.image.WritableRaster@w{ }@var{raster}) +Subclasses must override this method if it is possible for the + color model to have an alpha channel. +@end deftypemethod +@deftypemethod ColorModel {public String} toString () + +@end deftypemethod +@deftypemethod ComponentColorModel {public int} getRed (int@w{ }@var{pixel}) + +@end deftypemethod +@deftypemethod ComponentColorModel {public int} getGreen (int@w{ }@var{pixel}) + +@end deftypemethod +@deftypemethod ComponentColorModel {public int} getBlue (int@w{ }@var{pixel}) + +@end deftypemethod +@deftypemethod ComponentColorModel {public int} getAlpha (int@w{ }@var{pixel}) + +@end deftypemethod +@deftypemethod ComponentColorModel {public int} getRGB (int@w{ }@var{pixel}) + +@end deftypemethod +@deftypemethod ComponentColorModel {public int} getRed (java.lang.Object@w{ }@var{inData}) + +@end deftypemethod +@deftypemethod ComponentColorModel {public int} getGreen (java.lang.Object@w{ }@var{inData}) + +@end deftypemethod +@deftypemethod ComponentColorModel {public int} getBlue (java.lang.Object@w{ }@var{inData}) + +@end deftypemethod +@deftypemethod ComponentColorModel {public int} getAlpha (java.lang.Object@w{ }@var{inData}) + +@end deftypemethod +@deftypemethod ComponentColorModel {public int} getRGB (java.lang.Object@w{ }@var{inData}) + +@end deftypemethod +@deftypemethod ComponentColorModel {public Object} getDataElements (int@w{ }@var{rgb}, java.lang.Object@w{ }@var{pixel}) + +@end deftypemethod +@deftypemethod ComponentColorModel {public int} getComponents (int@w{ }@var{pixel}, int[]@w{ }@var{components}, int@w{ }@var{offset}) + +@end deftypemethod +@deftypemethod ComponentColorModel {public int} getComponents (java.lang.Object@w{ }@var{pixel}, int[]@w{ }@var{components}, int@w{ }@var{offset}) + +@end deftypemethod +@deftypemethod ComponentColorModel {public int} getDataElement (int[]@w{ }@var{components}, int@w{ }@var{offset}) + +@end deftypemethod +@deftypemethod ComponentColorModel {public Object} getDataElements (int[]@w{ }@var{components}, int@w{ }@var{offset}, java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod ComponentColorModel {public ColorModel} coerceData (java.awt.image.WritableRaster@w{ }@var{raster}, boolean@w{ }@var{isAlphaPremultiplied}) + +@end deftypemethod +@deftypemethod ComponentColorModel {public boolean} isCompatibleRaster (java.awt.image.Raster@w{ }@var{raster}) + +@end deftypemethod +@deftypemethod ComponentColorModel {public WritableRaster} createCompatibleWritableRaster (int@w{ }@var{w}, int@w{ }@var{h}) + +@end deftypemethod +@deftypemethod ComponentColorModel {public SampleModel} createCompatibleSampleModel (int@w{ }@var{w}, int@w{ }@var{h}) + +@end deftypemethod +@deftypemethod ComponentColorModel {public boolean} isCompatibleSampleModel (java.awt.image.SampleModel@w{ }@var{sm}) + +@end deftypemethod +@deftypemethod ComponentColorModel {public WritableRaster} getAlphaRaster (java.awt.image.WritableRaster@w{ }@var{raster}) + +@end deftypemethod +@deftypemethod ComponentColorModel {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod ComponentSampleModel {public SampleModel} createCompatibleSampleModel (int@w{ }@var{w}, int@w{ }@var{h}) + +@end deftypemethod +@deftypemethod ComponentSampleModel {public SampleModel} createSubsetSampleModel (int[]@w{ }@var{bands}) + +@end deftypemethod +@deftypemethod ComponentSampleModel {public DataBuffer} createDataBuffer () + +@end deftypemethod +@deftypemethod ComponentSampleModel {public int} getOffset (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod ComponentSampleModel {public int} getOffset (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{b}) + +@end deftypemethod +@deftypemethod ComponentSampleModel {public final int} getSampleSize () + +@end deftypemethod +@deftypemethod ComponentSampleModel {public final int} getSampleSize (int@w{ }@var{band}) + +@end deftypemethod +@deftypemethod ComponentSampleModel {public final int} getBankIndices () + +@end deftypemethod +@deftypemethod ComponentSampleModel {public final int} getBandOffsets () + +@end deftypemethod +@deftypemethod ComponentSampleModel {public final int} getScanlineStride () + +@end deftypemethod +@deftypemethod ComponentSampleModel {public final int} getPixelStride () + +@end deftypemethod +@deftypemethod ComponentSampleModel {public final int} getNumDataElements () + +@end deftypemethod +@deftypemethod ComponentSampleModel {public Object} getDataElements (int@w{ }@var{x}, int@w{ }@var{y}, java.lang.Object@w{ }@var{obj}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod ComponentSampleModel {public Object} getDataElements (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, java.lang.Object@w{ }@var{obj}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod ComponentSampleModel {public void} setDataElements (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, java.lang.Object@w{ }@var{obj}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod ComponentSampleModel {public int} getPixel (int@w{ }@var{x}, int@w{ }@var{y}, int[]@w{ }@var{iArray}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod ComponentSampleModel {public int} getPixels (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, int[]@w{ }@var{iArray}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod ComponentSampleModel {public int} getSample (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{b}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod ComponentSampleModel {public void} setDataElements (int@w{ }@var{x}, int@w{ }@var{y}, java.lang.Object@w{ }@var{obj}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod ComponentSampleModel {public void} setPixel (int@w{ }@var{x}, int@w{ }@var{y}, int[]@w{ }@var{iArray}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod ComponentSampleModel {public void} setSample (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{b}, int@w{ }@var{s}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod DataBufferByte {public byte} getData () + +@end deftypemethod +@deftypemethod DataBufferByte {public byte} getData (int@w{ }@var{bank}) + +@end deftypemethod +@deftypemethod DataBufferByte {public byte} getBankData () + +@end deftypemethod +@deftypemethod DataBufferByte {public int} getElem (int@w{ }@var{i}) + +@end deftypemethod +@deftypemethod DataBufferByte {public int} getElem (int@w{ }@var{bank}, int@w{ }@var{i}) + +@end deftypemethod +@deftypemethod DataBufferByte {public void} setElem (int@w{ }@var{i}, int@w{ }@var{val}) + +@end deftypemethod +@deftypemethod DataBufferByte {public void} setElem (int@w{ }@var{bank}, int@w{ }@var{i}, int@w{ }@var{val}) + +@end deftypemethod +@deftypemethod DataBufferInt {public int} getData () + +@end deftypemethod +@deftypemethod DataBufferInt {public int} getData (int@w{ }@var{bank}) + +@end deftypemethod +@deftypemethod DataBufferInt {public int} getBankData () + +@end deftypemethod +@deftypemethod DataBufferInt {public int} getElem (int@w{ }@var{i}) + +@end deftypemethod +@deftypemethod DataBufferInt {public int} getElem (int@w{ }@var{bank}, int@w{ }@var{i}) + +@end deftypemethod +@deftypemethod DataBufferInt {public void} setElem (int@w{ }@var{i}, int@w{ }@var{val}) + +@end deftypemethod +@deftypemethod DataBufferInt {public void} setElem (int@w{ }@var{bank}, int@w{ }@var{i}, int@w{ }@var{val}) + +@end deftypemethod +@deftypemethod DataBuffer {public static int} getDataTypeSize (int@w{ }@var{dataType}) + +@end deftypemethod +@deftypemethod DataBuffer {public int} getDataType () + +@end deftypemethod +@deftypemethod DataBuffer {public int} getSize () + +@end deftypemethod +@deftypemethod DataBuffer {public int} getOffset () + +@end deftypemethod +@deftypemethod DataBuffer {public int} getOffsets () + +@end deftypemethod +@deftypemethod DataBuffer {public int} getNumBanks () + +@end deftypemethod +@deftypemethod DataBuffer {public int} getElem (int@w{ }@var{i}) + +@end deftypemethod +@deftypemethod DataBuffer {public abstract int} getElem (int@w{ }@var{bank}, int@w{ }@var{i}) + +@end deftypemethod +@deftypemethod DataBuffer {public void} setElem (int@w{ }@var{i}, int@w{ }@var{val}) + +@end deftypemethod +@deftypemethod DataBuffer {public abstract void} setElem (int@w{ }@var{bank}, int@w{ }@var{i}, int@w{ }@var{val}) + +@end deftypemethod +@deftypemethod DataBuffer {public float} getElemFloat (int@w{ }@var{i}) + +@end deftypemethod +@deftypemethod DataBuffer {public float} getElemFloat (int@w{ }@var{bank}, int@w{ }@var{i}) + +@end deftypemethod +@deftypemethod DataBuffer {public void} setElemFloat (int@w{ }@var{i}, float@w{ }@var{val}) + +@end deftypemethod +@deftypemethod DataBuffer {public void} setElemFloat (int@w{ }@var{bank}, int@w{ }@var{i}, float@w{ }@var{val}) + +@end deftypemethod +@deftypemethod DataBuffer {public double} getElemDouble (int@w{ }@var{i}) + +@end deftypemethod +@deftypemethod DataBuffer {public double} getElemDouble (int@w{ }@var{bank}, int@w{ }@var{i}) + +@end deftypemethod +@deftypemethod DataBuffer {public void} setElemDouble (int@w{ }@var{i}, double@w{ }@var{val}) + +@end deftypemethod +@deftypemethod DataBuffer {public void} setElemDouble (int@w{ }@var{bank}, int@w{ }@var{i}, double@w{ }@var{val}) + +@end deftypemethod +@deftypemethod DataBufferUShort {public short} getData () + +@end deftypemethod +@deftypemethod DataBufferUShort {public short} getData (int@w{ }@var{bank}) + +@end deftypemethod +@deftypemethod DataBufferUShort {public short} getBankData () + +@end deftypemethod +@deftypemethod DataBufferUShort {public int} getElem (int@w{ }@var{i}) + +@end deftypemethod +@deftypemethod DataBufferUShort {public int} getElem (int@w{ }@var{bank}, int@w{ }@var{i}) + +@end deftypemethod +@deftypemethod DataBufferUShort {public void} setElem (int@w{ }@var{i}, int@w{ }@var{val}) + +@end deftypemethod +@deftypemethod DataBufferUShort {public void} setElem (int@w{ }@var{bank}, int@w{ }@var{i}, int@w{ }@var{val}) + +@end deftypemethod +@deftypemethod DirectColorModel {public final int} getRedMask () + +@end deftypemethod +@deftypemethod DirectColorModel {public final int} getGreenMask () + +@end deftypemethod +@deftypemethod DirectColorModel {public final int} getBlueMask () + +@end deftypemethod +@deftypemethod DirectColorModel {public final int} getAlphaMask () + +@end deftypemethod +@deftypemethod DirectColorModel {public final int} getRed (int@w{ }@var{pixel}) + +@end deftypemethod +@deftypemethod DirectColorModel {public final int} getGreen (int@w{ }@var{pixel}) + +@end deftypemethod +@deftypemethod DirectColorModel {public final int} getBlue (int@w{ }@var{pixel}) + +@end deftypemethod +@deftypemethod DirectColorModel {public final int} getAlpha (int@w{ }@var{pixel}) + +@end deftypemethod +@deftypemethod DirectColorModel {public final int} getRGB (int@w{ }@var{pixel}) + +@end deftypemethod +@deftypemethod DirectColorModel {public int} getRed (java.lang.Object@w{ }@var{inData}) + +@end deftypemethod +@deftypemethod DirectColorModel {public int} getGreen (java.lang.Object@w{ }@var{inData}) + +@end deftypemethod +@deftypemethod DirectColorModel {public int} getBlue (java.lang.Object@w{ }@var{inData}) + +@end deftypemethod +@deftypemethod DirectColorModel {public int} getAlpha (java.lang.Object@w{ }@var{inData}) + +@end deftypemethod +@deftypemethod DirectColorModel {public int} getRGB (java.lang.Object@w{ }@var{inData}) + +@end deftypemethod +@deftypemethod DirectColorModel {public Object} getDataElements (int@w{ }@var{rgb}, java.lang.Object@w{ }@var{pixel}) +Converts a normalized pixel int value in the sRGB color + space to an array containing a single pixel of the color space + of the color model. + + + +This method performs the inverse function of + @code{getRGB(Object inData)}. +@end deftypemethod +@deftypemethod DirectColorModel {public final int} getComponents (int@w{ }@var{pixel}, int[]@w{ }@var{components}, int@w{ }@var{offset}) +Fills an array with the unnormalized component samples from a + pixel value. I.e. decompose the pixel, but not perform any + color conversion. +@end deftypemethod +@deftypemethod DirectColorModel {public final int} getComponents (java.lang.Object@w{ }@var{pixel}, int[]@w{ }@var{components}, int@w{ }@var{offset}) + +@end deftypemethod +@deftypemethod DirectColorModel {public final WritableRaster} createCompatibleWritableRaster (int@w{ }@var{w}, int@w{ }@var{h}) + +@end deftypemethod +@deftypemethod DirectColorModel {public int} getDataElement (int[]@w{ }@var{components}, int@w{ }@var{offset}) + +@end deftypemethod +@deftypemethod DirectColorModel {public Object} getDataElements (int[]@w{ }@var{components}, int@w{ }@var{offset}, java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod DirectColorModel {public ColorModel} coerceData (java.awt.image.WritableRaster@w{ }@var{raster}, boolean@w{ }@var{isAlphaPremultiplied}) + +@end deftypemethod +@deftypemethod DirectColorModel {public boolean} isCompatibleRaster (java.awt.image.Raster@w{ }@var{raster}) + +@end deftypemethod +@deftypemethod DirectColorModel {public String} toString () + +@end deftypemethod +@deftypemethod ImageConsumer {public void} setDimensions (int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod ImageConsumer {public void} setProperties (java.util.Hashtable@w{ }@var{props}) + +@end deftypemethod +@deftypemethod ImageConsumer {public void} setColorModel (java.awt.image.ColorModel@w{ }@var{model}) + +@end deftypemethod +@deftypemethod ImageConsumer {public void} setHints (int@w{ }@var{hintflags}) + +@end deftypemethod +@deftypemethod ImageConsumer {public void} setPixels (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, java.awt.image.ColorModel@w{ }@var{model}, byte[]@w{ }@var{pixels}, int@w{ }@var{off}, int@w{ }@var{scansize}) + +@end deftypemethod +@deftypemethod ImageConsumer {public void} setPixels (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, java.awt.image.ColorModel@w{ }@var{model}, int[]@w{ }@var{pixels}, int@w{ }@var{off}, int@w{ }@var{scansize}) + +@end deftypemethod +@deftypemethod ImageConsumer {public void} imageComplete (int@w{ }@var{status}) + +@end deftypemethod +@deftypemethod ImageObserver {public boolean} imageUpdate (java.awt.Image@w{ }@var{image}, int@w{ }@var{infoFlags}, int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod ImageProducer {public void} addConsumer (java.awt.image.ImageConsumer@w{ }@var{ic}) + +@end deftypemethod +@deftypemethod ImageProducer {public boolean} isConsumer (java.awt.image.ImageConsumer@w{ }@var{ic}) + +@end deftypemethod +@deftypemethod ImageProducer {public void} removeConsumer (java.awt.image.ImageConsumer@w{ }@var{ic}) + +@end deftypemethod +@deftypemethod ImageProducer {public void} startProduction (java.awt.image.ImageConsumer@w{ }@var{ic}) + +@end deftypemethod +@deftypemethod ImageProducer {public void} requestTopDownLeftRightResend (java.awt.image.ImageConsumer@w{ }@var{ic}) + +@end deftypemethod +@deftypemethod IndexColorModel {public final int} getMapSize () + +@end deftypemethod +@deftypemethod IndexColorModel {public final int} getTransparentPixel () + +@end deftypemethod +@deftypemethod IndexColorModel {public final void} getReds (byte[]@w{ }@var{r}) + +@end deftypemethod +@deftypemethod IndexColorModel {public final void} getGreens (byte[]@w{ }@var{g}) + +@end deftypemethod +@deftypemethod IndexColorModel {public final void} getBlues (byte[]@w{ }@var{b}) + +@end deftypemethod +@deftypemethod IndexColorModel {public final void} getAlphas (byte[]@w{ }@var{a}) + +@end deftypemethod +@deftypemethod IndexColorModel {public final void} getRGBs (int[]@w{ }@var{rgb}) + +@end deftypemethod +@deftypemethod IndexColorModel {public int} getRed (int@w{ }@var{pixel}) + +@end deftypemethod +@deftypemethod IndexColorModel {public int} getGreen (int@w{ }@var{pixel}) + +@end deftypemethod +@deftypemethod IndexColorModel {public int} getBlue (int@w{ }@var{pixel}) + +@end deftypemethod +@deftypemethod IndexColorModel {public int} getAlpha (int@w{ }@var{pixel}) + +@end deftypemethod +@deftypemethod IndexColorModel {public int} getRed (java.lang.Object@w{ }@var{inData}) + +@end deftypemethod +@deftypemethod IndexColorModel {public int} getGreen (java.lang.Object@w{ }@var{inData}) + +@end deftypemethod +@deftypemethod IndexColorModel {public int} getBlue (java.lang.Object@w{ }@var{inData}) + +@end deftypemethod +@deftypemethod IndexColorModel {public int} getAlpha (java.lang.Object@w{ }@var{inData}) + +@end deftypemethod +@deftypemethod IndexColorModel {public int} getRGB (java.lang.Object@w{ }@var{inData}) + +@end deftypemethod +@deftypemethod IndexColorModel {public Object} getDataElements (int@w{ }@var{rgb}, java.lang.Object@w{ }@var{pixel}) + +@end deftypemethod +@deftypemethod IndexColorModel {public int} getComponents (int@w{ }@var{pixel}, int[]@w{ }@var{components}, int@w{ }@var{offset}) + +@end deftypemethod +@deftypemethod IndexColorModel {public final int} getComponents (java.lang.Object@w{ }@var{pixel}, int[]@w{ }@var{components}, int@w{ }@var{offset}) + +@end deftypemethod +@deftypemethod IndexColorModel {public int} getDataElement (int[]@w{ }@var{components}, int@w{ }@var{offset}) + +@end deftypemethod +@deftypemethod IndexColorModel {public Object} getDataElements (int[]@w{ }@var{components}, int@w{ }@var{offset}, java.lang.Object@w{ }@var{pixel}) + +@end deftypemethod +@deftypemethod IndexColorModel {public SampleModel} createCompatibleSampleModel (int@w{ }@var{w}, int@w{ }@var{h}) + +@end deftypemethod +@deftypemethod PackedColorModel {public final int} getMask (int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod PackedColorModel {public final int} getMasks () + +@end deftypemethod +@deftypemethod PackedColorModel {public SampleModel} createCompatibleSampleModel (int@w{ }@var{w}, int@w{ }@var{h}) + +@end deftypemethod +@deftypemethod PackedColorModel {public boolean} isCompatibleSampleModel (java.awt.image.SampleModel@w{ }@var{sm}) + +@end deftypemethod +@deftypemethod PackedColorModel {public WritableRaster} getAlphaRaster (java.awt.image.WritableRaster@w{ }@var{raster}) + +@end deftypemethod +@deftypemethod PackedColorModel {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod Raster {public static WritableRaster} createInterleavedRaster (int@w{ }@var{dataType}, int@w{ }@var{w}, int@w{ }@var{h}, int@w{ }@var{bands}, java.awt.Point@w{ }@var{location}) + +@end deftypemethod +@deftypemethod Raster {public static WritableRaster} createInterleavedRaster (int@w{ }@var{dataType}, int@w{ }@var{w}, int@w{ }@var{h}, int@w{ }@var{scanlineStride}, int@w{ }@var{pixelStride}, int[]@w{ }@var{bandOffsets}, java.awt.Point@w{ }@var{location}) + +@end deftypemethod +@deftypemethod Raster {public static WritableRaster} createBandedRaster (int@w{ }@var{dataType}, int@w{ }@var{w}, int@w{ }@var{h}, int@w{ }@var{bands}, java.awt.Point@w{ }@var{location}) + +@end deftypemethod +@deftypemethod Raster {public static WritableRaster} createBandedRaster (int@w{ }@var{dataType}, int@w{ }@var{w}, int@w{ }@var{h}, int@w{ }@var{scanlineStride}, int[]@w{ }@var{bankIndices}, int[]@w{ }@var{bandOffsets}, java.awt.Point@w{ }@var{location}) + +@end deftypemethod +@deftypemethod Raster {public static WritableRaster} createPackedRaster (int@w{ }@var{dataType}, int@w{ }@var{w}, int@w{ }@var{h}, int[]@w{ }@var{bandMasks}, java.awt.Point@w{ }@var{location}) + +@end deftypemethod +@deftypemethod Raster {public static WritableRaster} createInterleavedRaster (java.awt.image.DataBuffer@w{ }@var{dataBuffer}, int@w{ }@var{w}, int@w{ }@var{h}, int@w{ }@var{scanlineStride}, int@w{ }@var{pixelStride}, int[]@w{ }@var{bandOffsets}, java.awt.Point@w{ }@var{location}) + +@end deftypemethod +@deftypemethod Raster {public static WritableRaster} createBandedRaster (java.awt.image.DataBuffer@w{ }@var{dataBuffer}, int@w{ }@var{w}, int@w{ }@var{h}, int@w{ }@var{scanlineStride}, int[]@w{ }@var{bankIndices}, int[]@w{ }@var{bandOffsets}, java.awt.Point@w{ }@var{location}) + +@end deftypemethod +@deftypemethod Raster {public static WritableRaster} createPackedRaster (java.awt.image.DataBuffer@w{ }@var{dataBuffer}, int@w{ }@var{w}, int@w{ }@var{h}, int@w{ }@var{scanlineStride}, int[]@w{ }@var{bandMasks}, java.awt.Point@w{ }@var{location}) + +@end deftypemethod +@deftypemethod Raster {public static Raster} createRaster (java.awt.image.SampleModel@w{ }@var{sm}, java.awt.image.DataBuffer@w{ }@var{db}, java.awt.Point@w{ }@var{location}) + +@end deftypemethod +@deftypemethod Raster {public static WritableRaster} createWritableRaster (java.awt.image.SampleModel@w{ }@var{sm}, java.awt.Point@w{ }@var{location}) + +@end deftypemethod +@deftypemethod Raster {public static WritableRaster} createWritableRaster (java.awt.image.SampleModel@w{ }@var{sm}, java.awt.image.DataBuffer@w{ }@var{db}, java.awt.Point@w{ }@var{location}) + +@end deftypemethod +@deftypemethod Raster {public Raster} getParent () + +@end deftypemethod +@deftypemethod Raster {public final int} getSampleModelTranslateX () + +@end deftypemethod +@deftypemethod Raster {public final int} getSampleModelTranslateY () + +@end deftypemethod +@deftypemethod Raster {public WritableRaster} createCompatibleWritableRaster () + +@end deftypemethod +@deftypemethod Raster {public WritableRaster} createCompatibleWritableRaster (int@w{ }@var{w}, int@w{ }@var{h}) + +@end deftypemethod +@deftypemethod Raster {public WritableRaster} createCompatibleWritableRaster (java.awt.Rectangle@w{ }@var{rect}) + +@end deftypemethod +@deftypemethod Raster {public WritableRaster} createCompatibleWritableRaster (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}) + +@end deftypemethod +@deftypemethod Raster {public Raster} createTranslatedChild (int@w{ }@var{childMinX}, int@w{ }@var{childMinY}) + +@end deftypemethod +@deftypemethod Raster {public Raster} createChild (int@w{ }@var{parentX}, int@w{ }@var{parentY}, int@w{ }@var{width}, int@w{ }@var{height}, int@w{ }@var{childMinX}, int@w{ }@var{childMinY}, int[]@w{ }@var{bandList}) + +@end deftypemethod +@deftypemethod Raster {public Rectangle} getBounds () + +@end deftypemethod +@deftypemethod Raster {public final int} getMinX () + +@end deftypemethod +@deftypemethod Raster {public final int} getMinY () + +@end deftypemethod +@deftypemethod Raster {public final int} getWidth () + +@end deftypemethod +@deftypemethod Raster {public final int} getHeight () + +@end deftypemethod +@deftypemethod Raster {public final int} getNumDataElements () + +@end deftypemethod +@deftypemethod Raster {public final int} getTransferType () + +@end deftypemethod +@deftypemethod Raster {public DataBuffer} getDataBuffer () + +@end deftypemethod +@deftypemethod Raster {public SampleModel} getSampleModel () + +@end deftypemethod +@deftypemethod Raster {public Object} getDataElements (int@w{ }@var{x}, int@w{ }@var{y}, java.lang.Object@w{ }@var{outData}) + +@end deftypemethod +@deftypemethod Raster {public Object} getDataElements (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, java.lang.Object@w{ }@var{outData}) + +@end deftypemethod +@deftypemethod Raster {public int} getPixel (int@w{ }@var{x}, int@w{ }@var{y}, int[]@w{ }@var{iArray}) + +@end deftypemethod +@deftypemethod Raster {public float} getPixel (int@w{ }@var{x}, int@w{ }@var{y}, float[]@w{ }@var{fArray}) + +@end deftypemethod +@deftypemethod Raster {public double} getPixel (int@w{ }@var{x}, int@w{ }@var{y}, double[]@w{ }@var{dArray}) + +@end deftypemethod +@deftypemethod Raster {public int} getPixels (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, int[]@w{ }@var{iArray}) + +@end deftypemethod +@deftypemethod Raster {public float} getPixels (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, float[]@w{ }@var{fArray}) + +@end deftypemethod +@deftypemethod Raster {public double} getPixels (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, double[]@w{ }@var{dArray}) + +@end deftypemethod +@deftypemethod Raster {public int} getSample (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{b}) + +@end deftypemethod +@deftypemethod Raster {public float} getSampleFloat (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{b}) + +@end deftypemethod +@deftypemethod Raster {public double} getSampleDouble (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{b}) + +@end deftypemethod +@deftypemethod Raster {public int} getSamples (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, int@w{ }@var{b}, int[]@w{ }@var{iArray}) + +@end deftypemethod +@deftypemethod Raster {public float} getSamples (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, int@w{ }@var{b}, float[]@w{ }@var{fArray}) + +@end deftypemethod +@deftypemethod Raster {public double} getSamples (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, int@w{ }@var{b}, double[]@w{ }@var{dArray}) + +@end deftypemethod +@deftypemethod RasterOp {public WritableRaster} filter (java.awt.image.Raster@w{ }@var{src}, java.awt.image.WritableRaster@w{ }@var{dest}) + +@end deftypemethod +@deftypemethod RasterOp {public Rectangle2D} getBounds2D (java.awt.image.Raster@w{ }@var{src}) + +@end deftypemethod +@deftypemethod RasterOp {public WritableRaster} createCompatibleDestRaster (java.awt.image.Raster@w{ }@var{src}) + +@end deftypemethod +@deftypemethod RasterOp {public Point2D} getPoint2D (java.awt.geom.Point2D@w{ }@var{srcPoint}, java.awt.geom.Point2D@w{ }@var{destPoint}) + +@end deftypemethod +@deftypemethod RasterOp {public RenderingHints} getRenderingHints () + +@end deftypemethod +@deftypemethod SampleModel {public final int} getWidth () + +@end deftypemethod +@deftypemethod SampleModel {public final int} getHeight () + +@end deftypemethod +@deftypemethod SampleModel {public final int} getNumBands () + +@end deftypemethod +@deftypemethod SampleModel {public abstract int} getNumDataElements () + +@end deftypemethod +@deftypemethod SampleModel {public final int} getDataType () + +@end deftypemethod +@deftypemethod SampleModel {public int} getTransferType () + +@end deftypemethod +@deftypemethod SampleModel {public int} getPixel (int@w{ }@var{x}, int@w{ }@var{y}, int[]@w{ }@var{iArray}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public abstract Object} getDataElements (int@w{ }@var{x}, int@w{ }@var{y}, java.lang.Object@w{ }@var{obj}, java.awt.image.DataBuffer@w{ }@var{data}) +This method is provided as a faster alternative to getPixel(), + that can be used when there is no need to decode the pixel into + seperate sample values. +@end deftypemethod +@deftypemethod SampleModel {public Object} getDataElements (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, java.lang.Object@w{ }@var{obj}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public abstract void} setDataElements (int@w{ }@var{x}, int@w{ }@var{y}, java.lang.Object@w{ }@var{obj}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public void} setDataElements (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, java.lang.Object@w{ }@var{obj}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public float} getPixel (int@w{ }@var{x}, int@w{ }@var{y}, float[]@w{ }@var{fArray}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public double} getPixel (int@w{ }@var{x}, int@w{ }@var{y}, double[]@w{ }@var{dArray}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public int} getPixels (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, int[]@w{ }@var{iArray}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public float} getPixels (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, float[]@w{ }@var{fArray}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public double} getPixels (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, double[]@w{ }@var{dArray}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public abstract int} getSample (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{b}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public float} getSampleFloat (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{b}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public double} getSampleDouble (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{b}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public int} getSamples (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, int@w{ }@var{b}, int[]@w{ }@var{iArray}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public float} getSamples (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, int@w{ }@var{b}, float[]@w{ }@var{fArray}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public double} getSamples (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, int@w{ }@var{b}, double[]@w{ }@var{dArray}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public void} setPixel (int@w{ }@var{x}, int@w{ }@var{y}, int[]@w{ }@var{iArray}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public void} setPixel (int@w{ }@var{x}, int@w{ }@var{y}, float[]@w{ }@var{fArray}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public void} setPixel (int@w{ }@var{x}, int@w{ }@var{y}, double[]@w{ }@var{dArray}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public void} setPixels (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, int[]@w{ }@var{iArray}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public void} setPixels (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, float[]@w{ }@var{fArray}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public void} setPixels (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, double[]@w{ }@var{dArray}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public abstract void} setSample (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{b}, int@w{ }@var{s}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public void} setSample (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{b}, float@w{ }@var{s}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public void} setSample (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{b}, double@w{ }@var{s}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public void} setSamples (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, int@w{ }@var{b}, int[]@w{ }@var{iArray}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public void} setSamples (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, int@w{ }@var{b}, float[]@w{ }@var{fArray}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public void} setSamples (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, int@w{ }@var{b}, double[]@w{ }@var{dArray}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SampleModel {public abstract SampleModel} createCompatibleSampleModel (int@w{ }@var{w}, int@w{ }@var{h}) + +@end deftypemethod +@deftypemethod SampleModel {public abstract SampleModel} createSubsetSampleModel (int[]@w{ }@var{bands}) + +@end deftypemethod +@deftypemethod SampleModel {public abstract DataBuffer} createDataBuffer () + +@end deftypemethod +@deftypemethod SampleModel {public abstract int} getSampleSize () + +@end deftypemethod +@deftypemethod SampleModel {public abstract int} getSampleSize (int@w{ }@var{band}) + +@end deftypemethod +@deftypemethod SinglePixelPackedSampleModel {public int} getNumDataElements () + +@end deftypemethod +@deftypemethod SinglePixelPackedSampleModel {public SampleModel} createCompatibleSampleModel (int@w{ }@var{w}, int@w{ }@var{h}) + +@end deftypemethod +@deftypemethod SinglePixelPackedSampleModel {public DataBuffer} createDataBuffer () + +@end deftypemethod +@deftypemethod SinglePixelPackedSampleModel {public int} getSampleSize () + +@end deftypemethod +@deftypemethod SinglePixelPackedSampleModel {public int} getSampleSize (int@w{ }@var{band}) + +@end deftypemethod +@deftypemethod SinglePixelPackedSampleModel {public int} getOffset (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod SinglePixelPackedSampleModel {public int} getBitOffsets () + +@end deftypemethod +@deftypemethod SinglePixelPackedSampleModel {public int} getBitMasks () + +@end deftypemethod +@deftypemethod SinglePixelPackedSampleModel {public int} getScanlineStride () + +@end deftypemethod +@deftypemethod SinglePixelPackedSampleModel {public SampleModel} createSubsetSampleModel (int[]@w{ }@var{bands}) + +@end deftypemethod +@deftypemethod SinglePixelPackedSampleModel {public Object} getDataElements (int@w{ }@var{x}, int@w{ }@var{y}, java.lang.Object@w{ }@var{obj}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SinglePixelPackedSampleModel {public int} getPixel (int@w{ }@var{x}, int@w{ }@var{y}, int[]@w{ }@var{iArray}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SinglePixelPackedSampleModel {public int} getPixels (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, int[]@w{ }@var{iArray}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SinglePixelPackedSampleModel {public int} getSample (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{b}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SinglePixelPackedSampleModel {public void} setDataElements (int@w{ }@var{x}, int@w{ }@var{y}, java.lang.Object@w{ }@var{obj}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SinglePixelPackedSampleModel {public void} setPixel (int@w{ }@var{x}, int@w{ }@var{y}, int[]@w{ }@var{iArray}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod SinglePixelPackedSampleModel {public void} setSample (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{b}, int@w{ }@var{s}, java.awt.image.DataBuffer@w{ }@var{data}) + +@end deftypemethod +@deftypemethod WritableRaster {public WritableRaster} getWritableParent () + +@end deftypemethod +@deftypemethod WritableRaster {public WritableRaster} createWritableTranslatedChild (int@w{ }@var{childMinX}, int@w{ }@var{childMinY}) + +@end deftypemethod +@deftypemethod WritableRaster {public WritableRaster} createWritableChild (int@w{ }@var{parentX}, int@w{ }@var{parentY}, int@w{ }@var{w}, int@w{ }@var{h}, int@w{ }@var{childMinX}, int@w{ }@var{childMinY}, int[]@w{ }@var{bandList}) + +@end deftypemethod +@deftypemethod WritableRaster {public void} setDataElements (int@w{ }@var{x}, int@w{ }@var{y}, java.lang.Object@w{ }@var{inData}) + +@end deftypemethod +@deftypemethod WritableRaster {public void} setDataElements (int@w{ }@var{x}, int@w{ }@var{y}, java.awt.image.Raster@w{ }@var{inRaster}) + +@end deftypemethod +@deftypemethod WritableRaster {public void} setDataElements (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, java.lang.Object@w{ }@var{inData}) + +@end deftypemethod +@deftypemethod WritableRaster {public void} setRect (java.awt.image.Raster@w{ }@var{srcRaster}) + +@end deftypemethod +@deftypemethod WritableRaster {public void} setRect (java.awt.image.Raster@w{ }@var{srcRaster}, int@w{ }@var{dx}, int@w{ }@var{dy}) + +@end deftypemethod +@deftypemethod WritableRaster {public void} setPixel (int@w{ }@var{x}, int@w{ }@var{y}, int[]@w{ }@var{iArray}) + +@end deftypemethod +@deftypemethod WritableRaster {public void} setPixel (int@w{ }@var{x}, int@w{ }@var{y}, float[]@w{ }@var{fArray}) + +@end deftypemethod +@deftypemethod WritableRaster {public void} setPixel (int@w{ }@var{x}, int@w{ }@var{y}, double[]@w{ }@var{dArray}) + +@end deftypemethod +@deftypemethod WritableRaster {public void} setPixels (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, int[]@w{ }@var{iArray}) + +@end deftypemethod +@deftypemethod WritableRaster {public void} setPixels (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, float[]@w{ }@var{fArray}) + +@end deftypemethod +@deftypemethod WritableRaster {public void} setPixels (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, double[]@w{ }@var{dArray}) + +@end deftypemethod +@deftypemethod WritableRaster {public void} setSample (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{b}, int@w{ }@var{s}) + +@end deftypemethod +@deftypemethod WritableRaster {public void} setSample (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{b}, float@w{ }@var{s}) + +@end deftypemethod +@deftypemethod WritableRaster {public void} setSample (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{b}, double@w{ }@var{s}) + +@end deftypemethod +@deftypemethod WritableRaster {public void} setSamples (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, int@w{ }@var{b}, int[]@w{ }@var{iArray}) + +@end deftypemethod +@deftypemethod WritableRaster {public void} setSamples (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, int@w{ }@var{b}, float[]@w{ }@var{fArray}) + +@end deftypemethod +@deftypemethod WritableRaster {public void} setSamples (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}, int@w{ }@var{b}, double[]@w{ }@var{dArray}) + +@end deftypemethod diff --git a/libjava/doc/java-awt-peer.texi b/libjava/doc/java-awt-peer.texi new file mode 100644 index 00000000000..c065026213f --- /dev/null +++ b/libjava/doc/java-awt-peer.texi @@ -0,0 +1,265 @@ +@deftypemethod ButtonPeer {public void} setLabel (java.lang.String@w{ }@var{label}) + +@end deftypemethod +@deftypemethod CheckboxMenuItemPeer {public void} setState (boolean@w{ }@var{state}) + +@end deftypemethod +@deftypemethod CheckboxPeer {public void} setCheckboxGroup (java.awt.CheckboxGroup@w{ }@var{group}) + +@end deftypemethod +@deftypemethod CheckboxPeer {public void} setLabel (java.lang.String@w{ }@var{label}) + +@end deftypemethod +@deftypemethod CheckboxPeer {public void} setState (boolean@w{ }@var{state}) + +@end deftypemethod +@deftypemethod ChoicePeer {public void} add (java.lang.String@w{ }@var{item}, int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod ChoicePeer {public void} remove (int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod ChoicePeer {public void} select (int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod ComponentPeer {public int} checkImage (java.awt.Image@w{ }@var{img}, int@w{ }@var{width}, int@w{ }@var{height}, java.awt.image.ImageObserver@w{ }@var{o}) + +@end deftypemethod +@deftypemethod ComponentPeer {public Image} createImage (java.awt.image.ImageProducer@w{ }@var{prod}) + +@end deftypemethod +@deftypemethod ComponentPeer {public Image} createImage (int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod ComponentPeer {public void} dispose () + +@end deftypemethod +@deftypemethod ComponentPeer {public GraphicsConfiguration} getGraphicsConfiguration () +Get the graphics configuration of the component. The color model + of the component can be derived from the configuration. +@end deftypemethod +@deftypemethod ComponentPeer {public FontMetrics} getFontMetrics (java.awt.Font@w{ }@var{f}) + +@end deftypemethod +@deftypemethod ComponentPeer {public Graphics} getGraphics () + +@end deftypemethod +@deftypemethod ComponentPeer {public Point} getLocationOnScreen () + +@end deftypemethod +@deftypemethod ComponentPeer {public Dimension} getMinimumSize () + +@end deftypemethod +@deftypemethod ComponentPeer {public Dimension} getPreferredSize () + +@end deftypemethod +@deftypemethod ComponentPeer {public Toolkit} getToolkit () + +@end deftypemethod +@deftypemethod ComponentPeer {public void} handleEvent (java.awt.AWTEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod ComponentPeer {public boolean} isFocusTraversable () + +@end deftypemethod +@deftypemethod ComponentPeer {public void} paint (java.awt.Graphics@w{ }@var{graphics}) + +@end deftypemethod +@deftypemethod ComponentPeer {public boolean} prepareImage (java.awt.Image@w{ }@var{img}, int@w{ }@var{width}, int@w{ }@var{height}, java.awt.image.ImageObserver@w{ }@var{o}) + +@end deftypemethod +@deftypemethod ComponentPeer {public void} print (java.awt.Graphics@w{ }@var{graphics}) + +@end deftypemethod +@deftypemethod ComponentPeer {public void} repaint (long@w{ }@var{tm}, int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod ComponentPeer {public void} requestFocus () + +@end deftypemethod +@deftypemethod ComponentPeer {public void} setBackground (java.awt.Color@w{ }@var{color}) + +@end deftypemethod +@deftypemethod ComponentPeer {public void} setBounds (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod ComponentPeer {public void} setCursor (java.awt.Cursor@w{ }@var{cursor}) + +@end deftypemethod +@deftypemethod ComponentPeer {public void} setEnabled (boolean@w{ }@var{enabled}) + +@end deftypemethod +@deftypemethod ComponentPeer {public void} setEventMask (long@w{ }@var{eventMask}) + +@end deftypemethod +@deftypemethod ComponentPeer {public void} setFont (java.awt.Font@w{ }@var{font}) + +@end deftypemethod +@deftypemethod ComponentPeer {public void} setForeground (java.awt.Color@w{ }@var{color}) + +@end deftypemethod +@deftypemethod ComponentPeer {public void} setVisible (boolean@w{ }@var{visible}) + +@end deftypemethod +@deftypemethod ContainerPeer {public Insets} getInsets () + +@end deftypemethod +@deftypemethod ContainerPeer {public void} beginValidate () + +@end deftypemethod +@deftypemethod ContainerPeer {public void} endValidate () + +@end deftypemethod +@deftypemethod DialogPeer {public void} setResizable (boolean@w{ }@var{resizeable}) + +@end deftypemethod +@deftypemethod DialogPeer {public void} setTitle (java.lang.String@w{ }@var{title}) + +@end deftypemethod +@deftypemethod FileDialogPeer {public void} setDirectory (java.lang.String@w{ }@var{dir}) + +@end deftypemethod +@deftypemethod FileDialogPeer {public void} setFile (java.lang.String@w{ }@var{file}) + +@end deftypemethod +@deftypemethod FileDialogPeer {public void} setFilenameFilter (java.io.FilenameFilter@w{ }@var{filter}) + +@end deftypemethod +@deftypemethod FramePeer {public void} setIconImage (java.awt.Image@w{ }@var{image}) + +@end deftypemethod +@deftypemethod FramePeer {public void} setMenuBar (java.awt.MenuBar@w{ }@var{mb}) + +@end deftypemethod +@deftypemethod FramePeer {public void} setResizable (boolean@w{ }@var{resizable}) + +@end deftypemethod +@deftypemethod FramePeer {public void} setTitle (java.lang.String@w{ }@var{title}) + +@end deftypemethod +@deftypemethod LabelPeer {public void} setAlignment (int@w{ }@var{alignment}) + +@end deftypemethod +@deftypemethod LabelPeer {public void} setText (java.lang.String@w{ }@var{text}) + +@end deftypemethod +@deftypemethod ListPeer {public void} add (java.lang.String@w{ }@var{item}, int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod ListPeer {public void} delItems (int@w{ }@var{start_index}, int@w{ }@var{end_index}) + +@end deftypemethod +@deftypemethod ListPeer {public void} deselect (int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod ListPeer {public int} getSelectedIndexes () + +@end deftypemethod +@deftypemethod ListPeer {public void} makeVisible (int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod ListPeer {public void} removeAll () + +@end deftypemethod +@deftypemethod ListPeer {public void} select (int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod ListPeer {public void} setMultipleMode (boolean@w{ }@var{multipleMode}) + +@end deftypemethod +@deftypemethod MenuBarPeer {public void} addHelpMenu (java.awt.Menu@w{ }@var{menu}) + +@end deftypemethod +@deftypemethod MenuBarPeer {public void} add (java.awt.Menu@w{ }@var{menu}) + +@end deftypemethod +@deftypemethod MenuBarPeer {public void} remove (int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod MenuComponentPeer {public void} dispose () + +@end deftypemethod +@deftypemethod MenuItemPeer {public void} setEnabled (boolean@w{ }@var{enabled}) + +@end deftypemethod +@deftypemethod MenuItemPeer {public void} setLabel (java.lang.String@w{ }@var{text}) + +@end deftypemethod +@deftypemethod MenuPeer {public void} add (java.awt.MenuItem@w{ }@var{item}) + +@end deftypemethod +@deftypemethod MenuPeer {public void} addSeparator () + +@end deftypemethod +@deftypemethod MenuPeer {public void} remove (int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod PopupMenuPeer {public void} show (java.awt.Event@w{ }@var{e}) + +@end deftypemethod +@deftypemethod ScrollbarPeer {public void} setLineIncrement (int@w{ }@var{increment}) + +@end deftypemethod +@deftypemethod ScrollbarPeer {public void} setPageIncrement (int@w{ }@var{increment}) + +@end deftypemethod +@deftypemethod ScrollbarPeer {public void} setValues (int@w{ }@var{value}, int@w{ }@var{visible}, int@w{ }@var{minimum}, int@w{ }@var{maximum}) + +@end deftypemethod +@deftypemethod ScrollPanePeer {public void} childResized (int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod ScrollPanePeer {public int} getHScrollbarHeight () + +@end deftypemethod +@deftypemethod ScrollPanePeer {public int} getVScrollbarWidth () + +@end deftypemethod +@deftypemethod ScrollPanePeer {public void} setScrollPosition (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod ScrollPanePeer {public void} setUnitIncrement (java.awt.Adjustable@w{ }@var{adj}, int@w{ }@var{increment}) + +@end deftypemethod +@deftypemethod ScrollPanePeer {public void} setValue (java.awt.Adjustable@w{ }@var{adj}, int@w{ }@var{value}) + +@end deftypemethod +@deftypemethod TextAreaPeer {public void} insert (java.lang.String@w{ }@var{text}, int@w{ }@var{pos}) + +@end deftypemethod +@deftypemethod TextAreaPeer {public void} replaceRange (java.lang.String@w{ }@var{text}, int@w{ }@var{start}, int@w{ }@var{end}) + +@end deftypemethod +@deftypemethod TextComponentPeer {public int} getCaretPosition () + +@end deftypemethod +@deftypemethod TextComponentPeer {public int} getSelectionEnd () + +@end deftypemethod +@deftypemethod TextComponentPeer {public int} getSelectionStart () + +@end deftypemethod +@deftypemethod TextComponentPeer {public String} getText () + +@end deftypemethod +@deftypemethod TextComponentPeer {public void} select (int@w{ }@var{start}, int@w{ }@var{end}) + +@end deftypemethod +@deftypemethod TextComponentPeer {public void} setCaretPosition (int@w{ }@var{pos}) + +@end deftypemethod +@deftypemethod TextComponentPeer {public void} setEditable (boolean@w{ }@var{editable}) + +@end deftypemethod +@deftypemethod TextComponentPeer {public void} setText (java.lang.String@w{ }@var{text}) + +@end deftypemethod +@deftypemethod TextFieldPeer {public void} setEchoChar (char@w{ }@var{echo}) + +@end deftypemethod +@deftypemethod WindowPeer {public void} toBack () + +@end deftypemethod +@deftypemethod WindowPeer {public void} toFront () + +@end deftypemethod diff --git a/libjava/doc/java-awt.texi b/libjava/doc/java-awt.texi new file mode 100644 index 00000000000..071cd4144c5 --- /dev/null +++ b/libjava/doc/java-awt.texi @@ -0,0 +1,2757 @@ +@deftypemethod ActiveEvent {public void} dispatch () + +@end deftypemethod +@deftypemethod Adjustable {public void} addAdjustmentListener (java.awt.event.AdjustmentListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Adjustable {public int} getBlockIncrement () + +@end deftypemethod +@deftypemethod Adjustable {public int} getMaximum () + +@end deftypemethod +@deftypemethod Adjustable {public int} getMinimum () + +@end deftypemethod +@deftypemethod Adjustable {public int} getOrientation () + +@end deftypemethod +@deftypemethod Adjustable {public int} getUnitIncrement () + +@end deftypemethod +@deftypemethod Adjustable {public int} getValue () + +@end deftypemethod +@deftypemethod Adjustable {public int} getVisibleAmount () + +@end deftypemethod +@deftypemethod Adjustable {public void} removeAdjustmentListener (java.awt.event.AdjustmentListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Adjustable {public void} setBlockIncrement (int@w{ }@var{b}) + +@end deftypemethod +@deftypemethod Adjustable {public void} setMaximum (int@w{ }@var{max}) + +@end deftypemethod +@deftypemethod Adjustable {public void} setMinimum (int@w{ }@var{min}) + +@end deftypemethod +@deftypemethod Adjustable {public void} setUnitIncrement (int@w{ }@var{u}) + +@end deftypemethod +@deftypemethod Adjustable {public void} setValue (int@w{ }@var{v}) + +@end deftypemethod +@deftypemethod Adjustable {public void} setVisibleAmount (int@w{ }@var{v}) + +@end deftypemethod +@deftypemethod AWTEvent {public int} getID () + +@end deftypemethod +@deftypemethod AWTEvent {public String} paramString () + +@end deftypemethod +@deftypemethod AWTEvent {public String} toString () + +@end deftypemethod +@deftypemethod AWTEvent {protected void} consume () + +@end deftypemethod +@deftypemethod AWTEvent {protected boolean} isConsumed () + +@end deftypemethod +@deftypemethod AWTEventMulticaster {protected static EventListener} addInternal (java.util.EventListener@w{ }@var{a}, java.util.EventListener@w{ }@var{b}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {protected static EventListener} removeInternal (java.util.EventListener@w{ }@var{l}, java.util.EventListener@w{ }@var{oldl}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {protected EventListener} remove (java.util.EventListener@w{ }@var{oldl}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static ActionListener} add (java.awt.event.ActionListener@w{ }@var{a}, java.awt.event.ActionListener@w{ }@var{b}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static AdjustmentListener} add (java.awt.event.AdjustmentListener@w{ }@var{a}, java.awt.event.AdjustmentListener@w{ }@var{b}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static ComponentListener} add (java.awt.event.ComponentListener@w{ }@var{a}, java.awt.event.ComponentListener@w{ }@var{b}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static ContainerListener} add (java.awt.event.ContainerListener@w{ }@var{a}, java.awt.event.ContainerListener@w{ }@var{b}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static FocusListener} add (java.awt.event.FocusListener@w{ }@var{a}, java.awt.event.FocusListener@w{ }@var{b}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static HierarchyBoundsListener} add (java.awt.event.HierarchyBoundsListener@w{ }@var{a}, java.awt.event.HierarchyBoundsListener@w{ }@var{b}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static HierarchyListener} add (java.awt.event.HierarchyListener@w{ }@var{a}, java.awt.event.HierarchyListener@w{ }@var{b}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static InputMethodListener} add (java.awt.event.InputMethodListener@w{ }@var{a}, java.awt.event.InputMethodListener@w{ }@var{b}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static ItemListener} add (java.awt.event.ItemListener@w{ }@var{a}, java.awt.event.ItemListener@w{ }@var{b}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static KeyListener} add (java.awt.event.KeyListener@w{ }@var{a}, java.awt.event.KeyListener@w{ }@var{b}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static MouseListener} add (java.awt.event.MouseListener@w{ }@var{a}, java.awt.event.MouseListener@w{ }@var{b}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static MouseMotionListener} add (java.awt.event.MouseMotionListener@w{ }@var{a}, java.awt.event.MouseMotionListener@w{ }@var{b}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static TextListener} add (java.awt.event.TextListener@w{ }@var{a}, java.awt.event.TextListener@w{ }@var{b}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static WindowListener} add (java.awt.event.WindowListener@w{ }@var{a}, java.awt.event.WindowListener@w{ }@var{b}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static ActionListener} remove (java.awt.event.ActionListener@w{ }@var{l}, java.awt.event.ActionListener@w{ }@var{oldl}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static AdjustmentListener} remove (java.awt.event.AdjustmentListener@w{ }@var{l}, java.awt.event.AdjustmentListener@w{ }@var{oldl}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static ComponentListener} remove (java.awt.event.ComponentListener@w{ }@var{l}, java.awt.event.ComponentListener@w{ }@var{oldl}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static ContainerListener} remove (java.awt.event.ContainerListener@w{ }@var{l}, java.awt.event.ContainerListener@w{ }@var{oldl}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static FocusListener} remove (java.awt.event.FocusListener@w{ }@var{l}, java.awt.event.FocusListener@w{ }@var{oldl}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static HierarchyBoundsListener} remove (java.awt.event.HierarchyBoundsListener@w{ }@var{l}, java.awt.event.HierarchyBoundsListener@w{ }@var{oldl}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static HierarchyListener} remove (java.awt.event.HierarchyListener@w{ }@var{l}, java.awt.event.HierarchyListener@w{ }@var{oldl}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static InputMethodListener} remove (java.awt.event.InputMethodListener@w{ }@var{l}, java.awt.event.InputMethodListener@w{ }@var{oldl}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static ItemListener} remove (java.awt.event.ItemListener@w{ }@var{l}, java.awt.event.ItemListener@w{ }@var{oldl}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static KeyListener} remove (java.awt.event.KeyListener@w{ }@var{l}, java.awt.event.KeyListener@w{ }@var{oldl}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static MouseListener} remove (java.awt.event.MouseListener@w{ }@var{l}, java.awt.event.MouseListener@w{ }@var{oldl}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static MouseMotionListener} remove (java.awt.event.MouseMotionListener@w{ }@var{l}, java.awt.event.MouseMotionListener@w{ }@var{oldl}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static TextListener} remove (java.awt.event.TextListener@w{ }@var{l}, java.awt.event.TextListener@w{ }@var{oldl}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public static WindowListener} remove (java.awt.event.WindowListener@w{ }@var{l}, java.awt.event.WindowListener@w{ }@var{oldl}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} actionPerformed (java.awt.event.ActionEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} adjustmentValueChanged (java.awt.event.AdjustmentEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} componentHidden (java.awt.event.ComponentEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} componentMoved (java.awt.event.ComponentEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} componentResized (java.awt.event.ComponentEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} componentShown (java.awt.event.ComponentEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} componentAdded (java.awt.event.ContainerEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} componentRemoved (java.awt.event.ContainerEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} focusGained (java.awt.event.FocusEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} focusLost (java.awt.event.FocusEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} ancestorMoved (java.awt.event.HierarchyEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} ancestorResized (java.awt.event.HierarchyEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} hierarchyChanged (java.awt.event.HierarchyEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} caretPositionChanged (java.awt.event.InputMethodEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} inputMethodTextChanged (java.awt.event.InputMethodEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} itemStateChanged (java.awt.event.ItemEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} keyPressed (java.awt.event.KeyEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} keyReleased (java.awt.event.KeyEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} keyTyped (java.awt.event.KeyEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} mouseClicked (java.awt.event.MouseEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} mouseEntered (java.awt.event.MouseEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} mouseExited (java.awt.event.MouseEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} mousePressed (java.awt.event.MouseEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} mouseReleased (java.awt.event.MouseEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} mouseDragged (java.awt.event.MouseEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} mouseMoved (java.awt.event.MouseEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} textValueChanged (java.awt.event.TextEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} windowActivated (java.awt.event.WindowEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} windowClosed (java.awt.event.WindowEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} windowClosing (java.awt.event.WindowEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} windowDeactivated (java.awt.event.WindowEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} windowDeiconified (java.awt.event.WindowEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} windowIconified (java.awt.event.WindowEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {public void} windowOpened (java.awt.event.WindowEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {protected static void} save (java.io.ObjectOutputStream@w{ }@var{s}, java.lang.String@w{ }@var{k}, java.util.EventListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod AWTEventMulticaster {protected void} saveInternal (java.io.ObjectOutputStream@w{ }@var{s}, java.lang.String@w{ }@var{k}) + +@end deftypemethod +@deftypemethod BorderLayout {public int} getHgap () + +@end deftypemethod +@deftypemethod BorderLayout {public void} setHgap (int@w{ }@var{hgap}) + +@end deftypemethod +@deftypemethod BorderLayout {public int} getVgap () + +@end deftypemethod +@deftypemethod BorderLayout {public void} setVgap (int@w{ }@var{vgap}) + +@end deftypemethod +@deftypemethod BorderLayout {public void} addLayoutComponent (java.awt.Component@w{ }@var{comp}, java.lang.Object@w{ }@var{constraints}) + +@end deftypemethod +@deftypemethod BorderLayout {public void} addLayoutComponent (java.lang.String@w{ }@var{name}, java.awt.Component@w{ }@var{comp}) + +@end deftypemethod +@deftypemethod BorderLayout {public void} removeLayoutComponent (java.awt.Component@w{ }@var{comp}) + +@end deftypemethod +@deftypemethod BorderLayout {public Dimension} minimumLayoutSize (java.awt.Container@w{ }@var{target}) + +@end deftypemethod +@deftypemethod BorderLayout {public Dimension} preferredLayoutSize (java.awt.Container@w{ }@var{target}) + +@end deftypemethod +@deftypemethod BorderLayout {public Dimension} maximumLayoutSize (java.awt.Container@w{ }@var{target}) +Completely disregards the requested maximum sizes of the + components, and states that the container has no upper size + limit. +@end deftypemethod +@deftypemethod BorderLayout {public float} getLayoutAlignmentX (java.awt.Container@w{ }@var{parent}) + +@end deftypemethod +@deftypemethod BorderLayout {public float} getLayoutAlignmentY (java.awt.Container@w{ }@var{parent}) + +@end deftypemethod +@deftypemethod BorderLayout {public void} invalidateLayout (java.awt.Container@w{ }@var{target}) + +@end deftypemethod +@deftypemethod BorderLayout {public void} layoutContainer (java.awt.Container@w{ }@var{target}) + +@end deftypemethod +@deftypemethod BorderLayout {public String} toString () + +@end deftypemethod +@deftypemethod Button {public void} addActionListener (java.awt.event.ActionListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Button {public void} addNotify () + +@end deftypemethod +@deftypemethod Button {public String} getActionCommand () + +@end deftypemethod +@deftypemethod Button {public String} getLabel () + +@end deftypemethod +@deftypemethod Button {protected String} paramString () + +@end deftypemethod +@deftypemethod Button {protected void} processActionEvent (java.awt.event.ActionEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod Button {protected void} processEvent (java.awt.AWTEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod Button {public void} removeActionListener (java.awt.event.ActionListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Button {public EventListener} getListeners (java.lang.Class@w{ }@var{listenerType}) + +@end deftypemethod +@deftypemethod Button {public void} setActionCommand (java.lang.String@w{ }@var{command}) + +@end deftypemethod +@deftypemethod Button {public void} setLabel (java.lang.String@w{ }@var{label}) + +@end deftypemethod +@deftypemethod Canvas {public void} addNotify () + +@end deftypemethod +@deftypemethod Canvas {public void} paint (java.awt.Graphics@w{ }@var{gfx}) +Override this to create components with custom painting. +Defaults to filling the component with the background color. +@end deftypemethod +@deftypemethod CardLayout {public void} addLayoutComponent (java.awt.Component@w{ }@var{comp}, java.lang.Object@w{ }@var{constraints}) +Add a new component to the layout. The constraint must be a + string which is used to name the component. This string can + later be used to refer to the particular component. +@end deftypemethod +@deftypemethod CardLayout {public void} addLayoutComponent (java.lang.String@w{ }@var{name}, java.awt.Component@w{ }@var{comp}) +Add a new component to the layout. The name can be used later + to refer to the component. +@end deftypemethod +@deftypemethod CardLayout {public void} first (java.awt.Container@w{ }@var{parent}) +Cause the first component in the container to be displayed. +@end deftypemethod +@deftypemethod CardLayout {public int} getHgap () +Return this layout manager's horizontal gap. +@end deftypemethod +@deftypemethod CardLayout {public float} getLayoutAlignmentX (java.awt.Container@w{ }@var{parent}) +Return this layout manager's x alignment. This method always + returns Component.CENTER_ALIGNMENT. +@end deftypemethod +@deftypemethod CardLayout {public float} getLayoutAlignmentY (java.awt.Container@w{ }@var{parent}) +Returns this layout manager's y alignment. This method always + returns Component.CENTER_ALIGNMENT. +@end deftypemethod +@deftypemethod CardLayout {public int} getVgap () +Return this layout manager's vertical gap. +@end deftypemethod +@deftypemethod CardLayout {public void} invalidateLayout (java.awt.Container@w{ }@var{target}) +Invalidate this layout manager's state. +@end deftypemethod +@deftypemethod CardLayout {public void} last (java.awt.Container@w{ }@var{parent}) +Cause the last component in the container to be displayed. +@end deftypemethod +@deftypemethod CardLayout {public void} layoutContainer (java.awt.Container@w{ }@var{parent}) +Lay out the container's components based on the current + settings. +@end deftypemethod +@deftypemethod CardLayout {public Dimension} maximumLayoutSize (java.awt.Container@w{ }@var{target}) +Get the maximum layout size of the container. +@end deftypemethod +@deftypemethod CardLayout {public Dimension} minimumLayoutSize (java.awt.Container@w{ }@var{target}) +Get the minimum layout size of the container. +@end deftypemethod +@deftypemethod CardLayout {public void} next (java.awt.Container@w{ }@var{parent}) +Cause the next component in the container to be displayed. +@end deftypemethod +@deftypemethod CardLayout {public Dimension} preferredLayoutSize (java.awt.Container@w{ }@var{parent}) +Get the preferred layout size of the container. +@end deftypemethod +@deftypemethod CardLayout {public void} previous (java.awt.Container@w{ }@var{parent}) +Cause the previous component in the container to be displayed. +@end deftypemethod +@deftypemethod CardLayout {public void} removeLayoutComponent (java.awt.Component@w{ }@var{comp}) +Remove the indicated component from this layout manager. +@end deftypemethod +@deftypemethod CardLayout {public void} setHgap (int@w{ }@var{hgap}) +Set this layout manager's horizontal gap. +@end deftypemethod +@deftypemethod CardLayout {public void} setVgap (int@w{ }@var{vgap}) +Set this layout manager's vertical gap. +@end deftypemethod +@deftypemethod CardLayout {public void} show (java.awt.Container@w{ }@var{parent}, java.lang.String@w{ }@var{name}) +Cause the named component to be shown. If the component name is + unknown, this method does nothing. +@end deftypemethod +@deftypemethod CardLayout {public String} toString () + +@end deftypemethod +@deftypemethod CheckboxGroup {public Checkbox} getCurrent () +Returns the currently selected checkbox in the group. +@end deftypemethod +@deftypemethod CheckboxGroup {public Checkbox} getSelectedCheckbox () +Returns the currently selected checkbox in the group. +@end deftypemethod +@deftypemethod CheckboxGroup {public synchronized void} setCurrent (java.awt.Checkbox@w{ }@var{checkbox}) +Set the selected checkbox. +@end deftypemethod +@deftypemethod CheckboxGroup {public synchronized void} setSelectedCheckbox (java.awt.Checkbox@w{ }@var{checkbox}) +Set the selected checkbox. +@end deftypemethod +@deftypemethod CheckboxGroup {public String} toString () +Return String representation of this class and current Checkbox. +@end deftypemethod +@deftypemethod Checkbox {public synchronized void} addItemListener (java.awt.event.ItemListener@w{ }@var{listener}) +Add a listener for item events. +@end deftypemethod +@deftypemethod Checkbox {public void} addNotify () +This creates the component's peer. +@end deftypemethod +@deftypemethod Checkbox {public CheckboxGroup} getCheckboxGroup () +Returns the current CheckboxGroup associated with this + Checkbox. +@end deftypemethod +@deftypemethod Checkbox {public String} getLabel () +Returns the current label; might be null. +@end deftypemethod +@deftypemethod Checkbox {public Object} getSelectedObjects () +Returns this checkbox's label if this checkbox is selected. +@end deftypemethod +@deftypemethod Checkbox {public boolean} getState () +Returns the current state of this checkbox. +@end deftypemethod +@deftypemethod Checkbox {protected String} paramString () +Generates a String representation of this Checkbox's state. +@end deftypemethod +@deftypemethod Checkbox {protected void} processEvent (java.awt.AWTEvent@w{ }@var{event}) +Process an event for this Checkbox. +@end deftypemethod +@deftypemethod Checkbox {protected void} processItemEvent (java.awt.event.ItemEvent@w{ }@var{event}) +Process an item event for this Checkbox. +@end deftypemethod +@deftypemethod Checkbox {public synchronized void} removeItemListener (java.awt.event.ItemListener@w{ }@var{listener}) +Remove an item listener. +@end deftypemethod +@deftypemethod Checkbox {public void} setCheckboxGroup (java.awt.CheckboxGroup@w{ }@var{group}) +Set this checkbox's group. +@end deftypemethod +@deftypemethod Checkbox {public synchronized void} setLabel (java.lang.String@w{ }@var{label}) +Set the checkbox's label. +@end deftypemethod +@deftypemethod Checkbox {public void} setState (boolean@w{ }@var{state}) +Set the checkbox's state. +@end deftypemethod +@deftypemethod CheckboxMenuItem {public synchronized void} addItemListener (java.awt.event.ItemListener@w{ }@var{listener}) +Add a listener for item events. +@end deftypemethod +@deftypemethod CheckboxMenuItem {public void} addNotify () +This creates the component's peer. +@end deftypemethod +@deftypemethod CheckboxMenuItem {public Object} getSelectedObjects () +Returns this checkbox's label if this checkbox is selected. +@end deftypemethod +@deftypemethod CheckboxMenuItem {public boolean} getState () +Returns the current state of this checkbox. +@end deftypemethod +@deftypemethod CheckboxMenuItem {public String} paramString () +Generates a String representation of this Checkbox's state. +@end deftypemethod +@deftypemethod CheckboxMenuItem {protected void} processEvent (java.awt.AWTEvent@w{ }@var{event}) +Process an event for this Checkbox. +@end deftypemethod +@deftypemethod CheckboxMenuItem {protected void} processItemEvent (java.awt.event.ItemEvent@w{ }@var{event}) +Process an item event for this Checkbox. +@end deftypemethod +@deftypemethod CheckboxMenuItem {public synchronized void} removeItemListener (java.awt.event.ItemListener@w{ }@var{listener}) +Remove an item listener. +@end deftypemethod +@deftypemethod CheckboxMenuItem {public void} setState (boolean@w{ }@var{state}) +Set the checkbox's state. +@end deftypemethod +@deftypemethod Choice {public synchronized void} add (java.lang.String@w{ }@var{item}) +Add a new item to this Choice object. If the item is the first + item on the list, then it is selected. +@end deftypemethod +@deftypemethod Choice {public void} addItem (java.lang.String@w{ }@var{item}) +Add a new item to this Choice object. This is the same as the + add method. +@end deftypemethod +@deftypemethod Choice {public synchronized void} addItemListener (java.awt.event.ItemListener@w{ }@var{listener}) +Add a listener for item events. +@end deftypemethod +@deftypemethod Choice {public void} addNotify () +This creates the component's peer. +@end deftypemethod +@deftypemethod Choice {public int} countItems () +Returns number of items. +@end deftypemethod +@deftypemethod Choice {public String} getItem (int@w{ }@var{index}) +Returns an item from this choice. +@end deftypemethod +@deftypemethod Choice {public int} getItemCount () +Returns number of items in Choice. +@end deftypemethod +@deftypemethod Choice {public int} getSelectedIndex () +Returns index of selected item; -1 if no item is selected. +@end deftypemethod +@deftypemethod Choice {public synchronized String} getSelectedItem () +Returns currently selected item; null if no item is selected. +@end deftypemethod +@deftypemethod Choice {public synchronized Object} getSelectedObjects () +Returns the currently selected item. +@end deftypemethod +@deftypemethod Choice {public synchronized void} insert (java.lang.String@w{ }@var{item}, int@w{ }@var{index}) +Inserts an item into this Choice. Existing items are shifted + upwards. If the new item is the only item, then it is selected. + If the currently selected item is shifted, then the first item is + selected. If the currently selected item is not shifted, then it + remains selected. +@end deftypemethod +@deftypemethod Choice {protected String} paramString () +Generates a String representation of this Choice's state. +@end deftypemethod +@deftypemethod Choice {protected void} processEvent (java.awt.AWTEvent@w{ }@var{event}) +Process an event for this Choice +@end deftypemethod +@deftypemethod Choice {protected void} processItemEvent (java.awt.event.ItemEvent@w{ }@var{event}) +Process an item event for this Choice. +@end deftypemethod +@deftypemethod Choice {public synchronized void} remove (java.lang.String@w{ }@var{item}) +Remove an item from this Choice. If several matches exist, the + first one is removed. If the removed item is selected, the the + first item is selected. +@end deftypemethod +@deftypemethod Choice {public synchronized void} remove (int@w{ }@var{index}) +Remove an item from this Choice. If the removed item is + selected, the the first item is selected. +@end deftypemethod +@deftypemethod Choice {public synchronized void} removeAll () +Remove all items from this choice. +@end deftypemethod +@deftypemethod Choice {public synchronized void} removeItemListener (java.awt.event.ItemListener@w{ }@var{listener}) +Remove an item listener. +@end deftypemethod +@deftypemethod Choice {public synchronized void} select (java.lang.String@w{ }@var{item}) +Select an item in this Choice. +@end deftypemethod +@deftypemethod Choice {public synchronized void} select (int@w{ }@var{index}) +Select an item in this choice. +@end deftypemethod +@deftypemethod Color {public int} getRed () + +@end deftypemethod +@deftypemethod Color {public int} getGreen () + +@end deftypemethod +@deftypemethod Color {public int} getBlue () + +@end deftypemethod +@deftypemethod Color {public int} getAlpha () + +@end deftypemethod +@deftypemethod Color {public int} getRGB () + +@end deftypemethod +@deftypemethod Color {public Color} brighter () + +@end deftypemethod +@deftypemethod Color {public Color} darker () + +@end deftypemethod +@deftypemethod Color {public int} hashCode () + +@end deftypemethod +@deftypemethod Color {public int} getTransparency () + +@end deftypemethod +@deftypemethod Component {public String} getName () + +@end deftypemethod +@deftypemethod Component {public void} setName (java.lang.String@w{ }@var{name}) + +@end deftypemethod +@deftypemethod Component {public Container} getParent () + +@end deftypemethod +@deftypemethod Component {public ComponentPeer} getPeer () + +@end deftypemethod +@deftypemethod Component {public GraphicsConfiguration} getGraphicsConfiguration () + +@end deftypemethod +@deftypemethod Component {public final Object} getTreeLock () + +@end deftypemethod +@deftypemethod Component {public Toolkit} getToolkit () + +@end deftypemethod +@deftypemethod Component {public boolean} isValid () + +@end deftypemethod +@deftypemethod Component {public boolean} isDisplayable () + +@end deftypemethod +@deftypemethod Component {public boolean} isVisible () + +@end deftypemethod +@deftypemethod Component {public boolean} isShowing () + +@end deftypemethod +@deftypemethod Component {public boolean} isEnabled () + +@end deftypemethod +@deftypemethod Component {public void} setEnabled (boolean@w{ }@var{b}) + +@end deftypemethod +@deftypemethod Component {public void} enable () + +@end deftypemethod +@deftypemethod Component {public void} enable (boolean@w{ }@var{b}) + +@end deftypemethod +@deftypemethod Component {public void} disable () + +@end deftypemethod +@deftypemethod Component {public boolean} isDoubleBuffered () + +@end deftypemethod +@deftypemethod Component {public void} enableInputMethods (boolean@w{ }@var{enable}) + +@end deftypemethod +@deftypemethod Component {public void} setVisible (boolean@w{ }@var{b}) + +@end deftypemethod +@deftypemethod Component {public void} show () + +@end deftypemethod +@deftypemethod Component {public void} show (boolean@w{ }@var{b}) + +@end deftypemethod +@deftypemethod Component {public void} hide () + +@end deftypemethod +@deftypemethod Component {public Color} getForeground () + +@end deftypemethod +@deftypemethod Component {public void} setForeground (java.awt.Color@w{ }@var{c}) + +@end deftypemethod +@deftypemethod Component {public Color} getBackground () + +@end deftypemethod +@deftypemethod Component {public void} setBackground (java.awt.Color@w{ }@var{c}) + +@end deftypemethod +@deftypemethod Component {public Font} getFont () + +@end deftypemethod +@deftypemethod Component {public void} setFont (java.awt.Font@w{ }@var{f}) + +@end deftypemethod +@deftypemethod Component {public Locale} getLocale () @*throws IllegalComponentStateException + +@end deftypemethod +@deftypemethod Component {public void} setLocale (java.util.Locale@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Component {public ColorModel} getColorModel () + +@end deftypemethod +@deftypemethod Component {public Point} getLocation () + +@end deftypemethod +@deftypemethod Component {public Point} getLocationOnScreen () + +@end deftypemethod +@deftypemethod Component {public Point} location () + +@end deftypemethod +@deftypemethod Component {public void} setLocation (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Component {public void} move (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Component {public void} setLocation (java.awt.Point@w{ }@var{p}) + +@end deftypemethod +@deftypemethod Component {public Dimension} getSize () + +@end deftypemethod +@deftypemethod Component {public Dimension} size () + +@end deftypemethod +@deftypemethod Component {public void} setSize (int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod Component {public void} resize (int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod Component {public void} setSize (java.awt.Dimension@w{ }@var{d}) + +@end deftypemethod +@deftypemethod Component {public void} resize (java.awt.Dimension@w{ }@var{d}) + +@end deftypemethod +@deftypemethod Component {public Rectangle} getBounds () + +@end deftypemethod +@deftypemethod Component {public Rectangle} bounds () + +@end deftypemethod +@deftypemethod Component {public void} setBounds (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}) + +@end deftypemethod +@deftypemethod Component {public void} reshape (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod Component {public void} setBounds (java.awt.Rectangle@w{ }@var{r}) + +@end deftypemethod +@deftypemethod Component {public int} getX () + +@end deftypemethod +@deftypemethod Component {public int} getY () + +@end deftypemethod +@deftypemethod Component {public int} getWidth () + +@end deftypemethod +@deftypemethod Component {public int} getHeight () + +@end deftypemethod +@deftypemethod Component {public Rectangle} getBounds (java.awt.Rectangle@w{ }@var{r}) + +@end deftypemethod +@deftypemethod Component {public Dimension} getSize (java.awt.Dimension@w{ }@var{d}) + +@end deftypemethod +@deftypemethod Component {public Point} getLocation (java.awt.Point@w{ }@var{p}) + +@end deftypemethod +@deftypemethod Component {public boolean} isOpaque () + +@end deftypemethod +@deftypemethod Component {public boolean} isLightweight () +Return whether the component is lightweight. +@end deftypemethod +@deftypemethod Component {public Dimension} getPreferredSize () + +@end deftypemethod +@deftypemethod Component {public Dimension} preferredSize () + +@end deftypemethod +@deftypemethod Component {public Dimension} getMinimumSize () + +@end deftypemethod +@deftypemethod Component {public Dimension} minimumSize () + +@end deftypemethod +@deftypemethod Component {public Dimension} getMaximumSize () + +@end deftypemethod +@deftypemethod Component {public float} getAlignmentX () + +@end deftypemethod +@deftypemethod Component {public float} getAlignmentY () + +@end deftypemethod +@deftypemethod Component {public void} doLayout () + +@end deftypemethod +@deftypemethod Component {public void} layout () + +@end deftypemethod +@deftypemethod Component {public void} validate () + +@end deftypemethod +@deftypemethod Component {public void} invalidate () + +@end deftypemethod +@deftypemethod Component {public Graphics} getGraphics () + +@end deftypemethod +@deftypemethod Component {public FontMetrics} getFontMetrics (java.awt.Font@w{ }@var{font}) + +@end deftypemethod +@deftypemethod Component {public void} setCursor (java.awt.Cursor@w{ }@var{cursor}) + +@end deftypemethod +@deftypemethod Component {public Cursor} getCursor () + +@end deftypemethod +@deftypemethod Component {public void} paint (java.awt.Graphics@w{ }@var{g}) + +@end deftypemethod +@deftypemethod Component {public void} update (java.awt.Graphics@w{ }@var{g}) + +@end deftypemethod +@deftypemethod Component {public void} paintAll (java.awt.Graphics@w{ }@var{g}) + +@end deftypemethod +@deftypemethod Component {public void} repaint () + +@end deftypemethod +@deftypemethod Component {public void} repaint (long@w{ }@var{tm}) + +@end deftypemethod +@deftypemethod Component {public void} repaint (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod Component {public void} repaint (long@w{ }@var{tm}, int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod Component {public void} print (java.awt.Graphics@w{ }@var{g}) + +@end deftypemethod +@deftypemethod Component {public void} printAll (java.awt.Graphics@w{ }@var{g}) + +@end deftypemethod +@deftypemethod Component {public boolean} imageUpdate (java.awt.Image@w{ }@var{img}, int@w{ }@var{infoflags}, int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}) + +@end deftypemethod +@deftypemethod Component {public Image} createImage (java.awt.image.ImageProducer@w{ }@var{producer}) + +@end deftypemethod +@deftypemethod Component {public Image} createImage (int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod Component {public boolean} prepareImage (java.awt.Image@w{ }@var{image}, java.awt.image.ImageObserver@w{ }@var{observer}) + +@end deftypemethod +@deftypemethod Component {public boolean} prepareImage (java.awt.Image@w{ }@var{image}, int@w{ }@var{width}, int@w{ }@var{height}, java.awt.image.ImageObserver@w{ }@var{observer}) + +@end deftypemethod +@deftypemethod Component {public int} checkImage (java.awt.Image@w{ }@var{image}, java.awt.image.ImageObserver@w{ }@var{observer}) + +@end deftypemethod +@deftypemethod Component {public int} checkImage (java.awt.Image@w{ }@var{image}, int@w{ }@var{width}, int@w{ }@var{height}, java.awt.image.ImageObserver@w{ }@var{observer}) + +@end deftypemethod +@deftypemethod Component {public boolean} contains (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Component {public boolean} inside (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Component {public boolean} contains (java.awt.Point@w{ }@var{p}) + +@end deftypemethod +@deftypemethod Component {public Component} getComponentAt (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Component {public Component} locate (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Component {public Component} getComponentAt (java.awt.Point@w{ }@var{p}) + +@end deftypemethod +@deftypemethod Component {public void} deliverEvent (java.awt.Event@w{ }@var{e}) + +@end deftypemethod +@deftypemethod Component {public final void} dispatchEvent (java.awt.AWTEvent@w{ }@var{e}) +Forward AWT events to processEvent() if: + - Events have been enabled for this type of event via enableEvents(), + OR: + - There is at least one registered listener for this type of event +@end deftypemethod +@deftypemethod Component {public boolean} postEvent (java.awt.Event@w{ }@var{e}) + +@end deftypemethod +@deftypemethod Component {public synchronized void} addComponentListener (java.awt.event.ComponentListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Component {public synchronized void} removeComponentListener (java.awt.event.ComponentListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Component {public synchronized void} addFocusListener (java.awt.event.FocusListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Component {public synchronized void} removeFocusListener (java.awt.event.FocusListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Component {public synchronized void} addHierarchyListener (java.awt.event.HierarchyListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Component {public synchronized void} removeHierarchyListener (java.awt.event.HierarchyListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Component {public synchronized void} addHierarchyBoundsListener (java.awt.event.HierarchyBoundsListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Component {public synchronized void} removeHierarchyBoundsListener (java.awt.event.HierarchyBoundsListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Component {public synchronized void} addKeyListener (java.awt.event.KeyListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Component {public synchronized void} removeKeyListener (java.awt.event.KeyListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Component {public synchronized void} addMouseListener (java.awt.event.MouseListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Component {public synchronized void} removeMouseListener (java.awt.event.MouseListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Component {public synchronized void} addMouseMotionListener (java.awt.event.MouseMotionListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Component {public synchronized void} removeMouseMotionListener (java.awt.event.MouseMotionListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Component {public synchronized void} addInputMethodListener (java.awt.event.InputMethodListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Component {public synchronized void} removeInputMethodListener (java.awt.event.InputMethodListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Component {public EventListener} getListeners (java.lang.Class@w{ }@var{listenerType}) +Returns all registered EventListers of the given listenerType. + listenerType must be a subclass of EventListener, or a + ClassClassException is thrown. +@end deftypemethod +@deftypemethod Component {protected final void} enableEvents (long@w{ }@var{eventsToEnable}) + +@end deftypemethod +@deftypemethod Component {protected final void} disableEvents (long@w{ }@var{eventsToDisable}) + +@end deftypemethod +@deftypemethod Component {protected AWTEvent} coalesceEvents (java.awt.AWTEvent@w{ }@var{existingEvent}, java.awt.AWTEvent@w{ }@var{newEvent}) +coalesceEvents is called by the EventQueue if two events with the same + event id are queued. Returns a new combined event, or null if no + combining is done. +@end deftypemethod +@deftypemethod Component {protected void} processEvent (java.awt.AWTEvent@w{ }@var{e}) +Forward event to the appropriate processXXXEvent method based on the + event type. +@end deftypemethod +@deftypemethod Component {protected void} processComponentEvent (java.awt.event.ComponentEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod Component {protected void} processFocusEvent (java.awt.event.FocusEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod Component {protected void} processKeyEvent (java.awt.event.KeyEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod Component {protected void} processMouseEvent (java.awt.event.MouseEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod Component {protected void} processMouseMotionEvent (java.awt.event.MouseEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod Component {protected void} processInputMethodEvent (java.awt.event.InputMethodEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod Component {protected void} processHierarchyEvent (java.awt.event.HierarchyEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod Component {protected void} processHierarchyBoundsEvent (java.awt.event.HierarchyEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod Component {public boolean} handleEvent (java.awt.Event@w{ }@var{evt}) + +@end deftypemethod +@deftypemethod Component {public boolean} mouseDown (java.awt.Event@w{ }@var{evt}, int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Component {public boolean} mouseDrag (java.awt.Event@w{ }@var{evt}, int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Component {public boolean} mouseUp (java.awt.Event@w{ }@var{evt}, int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Component {public boolean} mouseMove (java.awt.Event@w{ }@var{evt}, int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Component {public boolean} mouseEnter (java.awt.Event@w{ }@var{evt}, int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Component {public boolean} mouseExit (java.awt.Event@w{ }@var{evt}, int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Component {public boolean} keyDown (java.awt.Event@w{ }@var{evt}, int@w{ }@var{key}) + +@end deftypemethod +@deftypemethod Component {public boolean} keyUp (java.awt.Event@w{ }@var{evt}, int@w{ }@var{key}) + +@end deftypemethod +@deftypemethod Component {public boolean} action (java.awt.Event@w{ }@var{evt}, java.lang.Object@w{ }@var{what}) + +@end deftypemethod +@deftypemethod Component {public void} addNotify () + +@end deftypemethod +@deftypemethod Component {public void} removeNotify () + +@end deftypemethod +@deftypemethod Component {public boolean} gotFocus (java.awt.Event@w{ }@var{evt}, java.lang.Object@w{ }@var{what}) + +@end deftypemethod +@deftypemethod Component {public boolean} lostFocus (java.awt.Event@w{ }@var{evt}, java.lang.Object@w{ }@var{what}) + +@end deftypemethod +@deftypemethod Component {public boolean} isFocusTraversable () + +@end deftypemethod +@deftypemethod Component {public void} requestFocus () + +@end deftypemethod +@deftypemethod Component {public void} transferFocus () + +@end deftypemethod +@deftypemethod Component {public void} nextFocus () + +@end deftypemethod +@deftypemethod Component {public boolean} hasFocus () + +@end deftypemethod +@deftypemethod Component {public synchronized void} add (java.awt.PopupMenu@w{ }@var{popup}) + +@end deftypemethod +@deftypemethod Component {public synchronized void} remove (java.awt.MenuComponent@w{ }@var{popup}) + +@end deftypemethod +@deftypemethod Component {protected String} paramString () + +@end deftypemethod +@deftypemethod Component {public String} toString () + +@end deftypemethod +@deftypemethod Component {public void} list () + +@end deftypemethod +@deftypemethod Component {public void} list (java.io.PrintStream@w{ }@var{out}) + +@end deftypemethod +@deftypemethod Component {public void} list (java.io.PrintStream@w{ }@var{out}, int@w{ }@var{indent}) + +@end deftypemethod +@deftypemethod Component {public void} list (java.io.PrintWriter@w{ }@var{out}) + +@end deftypemethod +@deftypemethod Component {public void} list (java.io.PrintWriter@w{ }@var{out}, int@w{ }@var{indent}) + +@end deftypemethod +@deftypemethod Component {public void} addPropertyChangeListener (java.beans.PropertyChangeListener@w{ }@var{listener}) + +@end deftypemethod +@deftypemethod Component {public void} removePropertyChangeListener (java.beans.PropertyChangeListener@w{ }@var{listener}) + +@end deftypemethod +@deftypemethod Component {public void} addPropertyChangeListener (java.lang.String@w{ }@var{propertyName}, java.beans.PropertyChangeListener@w{ }@var{listener}) + +@end deftypemethod +@deftypemethod Component {public void} removePropertyChangeListener (java.lang.String@w{ }@var{propertyName}, java.beans.PropertyChangeListener@w{ }@var{listener}) + +@end deftypemethod +@deftypemethod Component {protected void} firePropertyChange (java.lang.String@w{ }@var{propertyName}, java.lang.Object@w{ }@var{oldValue}, java.lang.Object@w{ }@var{newValue}) + +@end deftypemethod +@deftypemethod Component {public void} setComponentOrientation (java.awt.ComponentOrientation@w{ }@var{o}) + +@end deftypemethod +@deftypemethod Component {public ComponentOrientation} getComponentOrientation () + +@end deftypemethod +@deftypemethod ComponentOrientation {public boolean} isHorizontal () + +@end deftypemethod +@deftypemethod ComponentOrientation {public boolean} isLeftToRight () + +@end deftypemethod +@deftypemethod ComponentOrientation {public static ComponentOrientation} getOrientation (java.util.Locale@w{ }@var{locale}) + +@end deftypemethod +@deftypemethod ComponentOrientation {public static ComponentOrientation} getOrientation (java.util.ResourceBundle@w{ }@var{bdl}) + +@end deftypemethod +@deftypemethod Container {public int} getComponentCount () + +@end deftypemethod +@deftypemethod Container {public int} countComponents () + +@end deftypemethod +@deftypemethod Container {public Component} getComponent (int@w{ }@var{n}) + +@end deftypemethod +@deftypemethod Container {public Component} getComponents () + +@end deftypemethod +@deftypemethod Container {public Insets} getInsets () + +@end deftypemethod +@deftypemethod Container {public Insets} insets () + +@end deftypemethod +@deftypemethod Container {public Component} add (java.awt.Component@w{ }@var{comp}) + +@end deftypemethod +@deftypemethod Container {public Component} add (java.lang.String@w{ }@var{name}, java.awt.Component@w{ }@var{comp}) + +@end deftypemethod +@deftypemethod Container {public Component} add (java.awt.Component@w{ }@var{comp}, int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod Container {public void} add (java.awt.Component@w{ }@var{comp}, java.lang.Object@w{ }@var{constraints}) + +@end deftypemethod +@deftypemethod Container {public void} add (java.awt.Component@w{ }@var{comp}, java.lang.Object@w{ }@var{constraints}, int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod Container {protected void} addImpl (java.awt.Component@w{ }@var{comp}, java.lang.Object@w{ }@var{constraints}, int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod Container {public void} remove (int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod Container {public void} remove (java.awt.Component@w{ }@var{comp}) + +@end deftypemethod +@deftypemethod Container {public void} removeAll () + +@end deftypemethod +@deftypemethod Container {public LayoutManager} getLayout () + +@end deftypemethod +@deftypemethod Container {public void} setLayout (java.awt.LayoutManager@w{ }@var{mgr}) + +@end deftypemethod +@deftypemethod Container {public void} doLayout () + +@end deftypemethod +@deftypemethod Container {public void} layout () + +@end deftypemethod +@deftypemethod Container {public void} invalidate () + +@end deftypemethod +@deftypemethod Container {public void} validate () + +@end deftypemethod +@deftypemethod Container {protected void} validateTree () + +@end deftypemethod +@deftypemethod Container {public void} setFont (java.awt.Font@w{ }@var{f}) + +@end deftypemethod +@deftypemethod Container {public Dimension} getPreferredSize () + +@end deftypemethod +@deftypemethod Container {public Dimension} preferredSize () + +@end deftypemethod +@deftypemethod Container {public Dimension} getMinimumSize () + +@end deftypemethod +@deftypemethod Container {public Dimension} minimumSize () + +@end deftypemethod +@deftypemethod Container {public Dimension} getMaximumSize () + +@end deftypemethod +@deftypemethod Container {public float} getAlignmentX () + +@end deftypemethod +@deftypemethod Container {public float} getAlignmentY () + +@end deftypemethod +@deftypemethod Container {public void} paint (java.awt.Graphics@w{ }@var{g}) + +@end deftypemethod +@deftypemethod Container {public void} update (java.awt.Graphics@w{ }@var{g}) + +@end deftypemethod +@deftypemethod Container {public void} print (java.awt.Graphics@w{ }@var{g}) + +@end deftypemethod +@deftypemethod Container {public void} paintComponents (java.awt.Graphics@w{ }@var{g}) + +@end deftypemethod +@deftypemethod Container {public void} printComponents (java.awt.Graphics@w{ }@var{g}) + +@end deftypemethod +@deftypemethod Container {public void} addContainerListener (java.awt.event.ContainerListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Container {public void} removeContainerListener (java.awt.event.ContainerListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Container {public EventListener} getListeners (java.lang.Class@w{ }@var{listenerType}) + +@end deftypemethod +@deftypemethod Container {protected void} processEvent (java.awt.AWTEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod Container {protected void} processContainerEvent (java.awt.event.ContainerEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod Container {public void} deliverEvent (java.awt.Event@w{ }@var{e}) + +@end deftypemethod +@deftypemethod Container {public Component} getComponentAt (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Container {public Component} locate (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Container {public Component} getComponentAt (java.awt.Point@w{ }@var{p}) + +@end deftypemethod +@deftypemethod Container {public Component} findComponentAt (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Container {public Component} findComponentAt (java.awt.Point@w{ }@var{p}) + +@end deftypemethod +@deftypemethod Container {public void} addNotify () + +@end deftypemethod +@deftypemethod Container {public void} removeNotify () + +@end deftypemethod +@deftypemethod Container {public boolean} isAncestorOf (java.awt.Component@w{ }@var{comp}) + +@end deftypemethod +@deftypemethod Container {protected String} paramString () + +@end deftypemethod +@deftypemethod Container {public void} list (java.io.PrintStream@w{ }@var{out}, int@w{ }@var{indent}) + +@end deftypemethod +@deftypemethod Container {public void} list (java.io.PrintWriter@w{ }@var{out}, int@w{ }@var{indent}) + +@end deftypemethod +@deftypemethod Cursor {public static Cursor} getPredefinedCursor (int@w{ }@var{type}) + +@end deftypemethod +@deftypemethod Cursor {public static Cursor} getSystemCustomCursor (java.lang.String@w{ }@var{name}) @*throws AWTException + +@end deftypemethod +@deftypemethod Cursor {public static Cursor} getDefaultCursor () + +@end deftypemethod +@deftypemethod Cursor {public int} getType () + +@end deftypemethod +@deftypemethod Cursor {public String} getName () + +@end deftypemethod +@deftypemethod Cursor {public String} toString () + +@end deftypemethod +@deftypemethod Dimension {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod Dimension {public Dimension} getSize () + +@end deftypemethod +@deftypemethod Dimension {public void} setSize (java.awt.Dimension@w{ }@var{dim}) + +@end deftypemethod +@deftypemethod Dimension {public void} setSize (int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod Dimension {public String} toString () + +@end deftypemethod +@deftypemethod Dimension {public double} getWidth () + +@end deftypemethod +@deftypemethod Dimension {public double} getHeight () + +@end deftypemethod +@deftypemethod Dimension {public void} setSize (double@w{ }@var{width}, double@w{ }@var{height}) + +@end deftypemethod +@deftypemethod Event {public boolean} controlDown () + +@end deftypemethod +@deftypemethod Event {public boolean} metaDown () + +@end deftypemethod +@deftypemethod Event {protected String} paramString () + +@end deftypemethod +@deftypemethod Event {public boolean} shiftDown () + +@end deftypemethod +@deftypemethod Event {public String} toString () + +@end deftypemethod +@deftypemethod Event {public void} translate (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod EventQueue {public synchronized AWTEvent} getNextEvent () @*throws InterruptedException + +@end deftypemethod +@deftypemethod EventQueue {public synchronized AWTEvent} peekEvent () + +@end deftypemethod +@deftypemethod EventQueue {public synchronized AWTEvent} peekEvent (int@w{ }@var{id}) + +@end deftypemethod +@deftypemethod EventQueue {public synchronized void} postEvent (java.awt.AWTEvent@w{ }@var{evt}) + +@end deftypemethod +@deftypemethod EventQueue {public static void} invokeAndWait (java.lang.Runnable@w{ }@var{runnable}) @*throws InterruptedException, InvocationTargetException + +@end deftypemethod +@deftypemethod EventQueue {public synchronized void} push (java.awt.EventQueue@w{ }@var{newEventQueue}) +Allows a custom EventQueue implementation to replace this one. + All pending events are transferred to the new queue. Calls to postEvent, + getNextEvent, and peekEvent are forwarded to the pushed queue until it + is removed with a pop(). +@end deftypemethod +@deftypemethod EventQueue {protected void} pop () @*throws EmptyStackException +Transfer any pending events from this queue back to the parent queue that + was previously push()ed. Event dispatch from this queue is suspended. +@end deftypemethod +@deftypemethod EventQueue {protected void} dispatchEvent (java.awt.AWTEvent@w{ }@var{evt}) + +@end deftypemethod +@deftypemethod FlowLayout {public void} addLayoutComponent (java.lang.String@w{ }@var{name}, java.awt.Component@w{ }@var{comp}) +Add a new component to the layout. This particular implementation + does nothing. +@end deftypemethod +@deftypemethod FlowLayout {public int} getAlignment () +Return the alignment. +@end deftypemethod +@deftypemethod FlowLayout {public int} getHgap () +Return the horizontal gap. +@end deftypemethod +@deftypemethod FlowLayout {public int} getVgap () +Return the vertical gap. +@end deftypemethod +@deftypemethod FlowLayout {public void} layoutContainer (java.awt.Container@w{ }@var{parent}) +Lay out the container's components based on current settings. +@end deftypemethod +@deftypemethod FlowLayout {public Dimension} minimumLayoutSize (java.awt.Container@w{ }@var{cont}) +Get the minimum layout size of the container. +@end deftypemethod +@deftypemethod FlowLayout {public Dimension} preferredLayoutSize (java.awt.Container@w{ }@var{cont}) +Get the preferred layout size of the container. +@end deftypemethod +@deftypemethod FlowLayout {public void} removeLayoutComponent (java.awt.Component@w{ }@var{comp}) +Remove the indicated component from this layout manager. + This particular implementation does nothing. +@end deftypemethod +@deftypemethod FlowLayout {public void} setAlignment (int@w{ }@var{align}) +Set the alignment. +@end deftypemethod +@deftypemethod FlowLayout {public void} setHgap (int@w{ }@var{hgap}) +Set the horizontal gap +@end deftypemethod +@deftypemethod FlowLayout {public void} setVgap (int@w{ }@var{vgap}) +Set the vertical gap. +@end deftypemethod +@deftypemethod FlowLayout {public String} toString () +Return String description of this object. +@end deftypemethod +@deftypemethod Font {public boolean} isPlain () + +@end deftypemethod +@deftypemethod Font {public boolean} isBold () + +@end deftypemethod +@deftypemethod Font {public boolean} isItalic () + +@end deftypemethod +@deftypemethod Font {public String} getName () + +@end deftypemethod +@deftypemethod Font {public String} getFamily () + +@end deftypemethod +@deftypemethod Font {public String} getFamily (java.util.Locale@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Font {public int} getStyle () + +@end deftypemethod +@deftypemethod Font {public int} getSize () + +@end deftypemethod +@deftypemethod Font {public float} getSize2D () + +@end deftypemethod +@deftypemethod Font {public static Font} decode (java.lang.String@w{ }@var{str}) + +@end deftypemethod +@deftypemethod Font {public String} toString () + +@end deftypemethod +@deftypemethod FontMetrics {public Font} getFont () + +@end deftypemethod +@deftypemethod FontMetrics {public int} getLeading () + +@end deftypemethod +@deftypemethod FontMetrics {public int} getAscent () + +@end deftypemethod +@deftypemethod FontMetrics {public int} getDescent () + +@end deftypemethod +@deftypemethod FontMetrics {public int} getHeight () + +@end deftypemethod +@deftypemethod FontMetrics {public int} getMaxAscent () + +@end deftypemethod +@deftypemethod FontMetrics {public int} getMaxDescent () + +@end deftypemethod +@deftypemethod FontMetrics {public int} getMaxDecent () + +@end deftypemethod +@deftypemethod FontMetrics {public int} getMaxAdvance () + +@end deftypemethod +@deftypemethod FontMetrics {public int} charWidth (int@w{ }@var{ch}) + +@end deftypemethod +@deftypemethod FontMetrics {public int} charWidth (char@w{ }@var{ch}) + +@end deftypemethod +@deftypemethod FontMetrics {public int} stringWidth (java.lang.String@w{ }@var{str}) + +@end deftypemethod +@deftypemethod FontMetrics {public int} charsWidth (char[]@w{ }@var{data}, int@w{ }@var{off}, int@w{ }@var{len}) + +@end deftypemethod +@deftypemethod FontMetrics {public int} bytesWidth (byte[]@w{ }@var{data}, int@w{ }@var{off}, int@w{ }@var{len}) + +@end deftypemethod +@deftypemethod FontMetrics {public int} getWidths () + +@end deftypemethod +@deftypemethod FontMetrics {public boolean} hasUniformLineMetrics () + +@end deftypemethod +@deftypemethod FontMetrics {public String} toString () + +@end deftypemethod +@deftypemethod Frame {public String} getTitle () + +@end deftypemethod +@deftypemethod Frame {public void} setTitle (java.lang.String@w{ }@var{title}) + +@end deftypemethod +@deftypemethod Frame {public Image} getIconImage () + +@end deftypemethod +@deftypemethod Frame {public void} setIconImage (java.awt.Image@w{ }@var{image}) + +@end deftypemethod +@deftypemethod Frame {protected void} finalize () @*throws Throwable + +@end deftypemethod +@deftypemethod Frame {public synchronized void} setMenuBar (java.awt.MenuBar@w{ }@var{menuBar}) + +@end deftypemethod +@deftypemethod Frame {public boolean} isResizable () + +@end deftypemethod +@deftypemethod Frame {public void} setResizable (boolean@w{ }@var{resizable}) + +@end deftypemethod +@deftypemethod Frame {public int} getState () + +@end deftypemethod +@deftypemethod Frame {public synchronized void} addNotify () + +@end deftypemethod +@deftypemethod Frame {public boolean} postEvent (java.awt.Event@w{ }@var{evt}) + +@end deftypemethod +@deftypemethod Frame {public void} remove (java.awt.MenuComponent@w{ }@var{m}) + +@end deftypemethod +@deftypemethod Frame {public void} removeNotify () + +@end deftypemethod +@deftypemethod Frame {public static Frame} getFrames () + +@end deftypemethod +@deftypemethod Graphics2D {public void} draw3DRect (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}, boolean@w{ }@var{raised}) + +@end deftypemethod +@deftypemethod Graphics2D {public void} fill3DRect (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}, boolean@w{ }@var{raised}) + +@end deftypemethod +@deftypemethod Graphics2D {public abstract void} draw (java.awt.Shape@w{ }@var{shape}) + +@end deftypemethod +@deftypemethod Graphics2D {public abstract boolean} drawImage (java.awt.Image@w{ }@var{image}, java.awt.geom.AffineTransform@w{ }@var{xform}, java.awt.image.ImageObserver@w{ }@var{obs}) + +@end deftypemethod +@deftypemethod Graphics2D {public abstract void} drawString (java.lang.String@w{ }@var{text}, int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Graphics2D {public abstract void} drawString (java.lang.String@w{ }@var{text}, float@w{ }@var{x}, float@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Graphics2D {public abstract void} fill (java.awt.Shape@w{ }@var{shape}) + +@end deftypemethod +@deftypemethod Graphics2D {public abstract boolean} hit (java.awt.Rectangle@w{ }@var{rect}, java.awt.Shape@w{ }@var{text}, boolean@w{ }@var{onStroke}) + +@end deftypemethod +@deftypemethod Graphics2D {public abstract GraphicsConfiguration} getDeviceConfiguration () + +@end deftypemethod +@deftypemethod Graphics2D {public abstract void} setPaint (java.awt.Paint@w{ }@var{paint}) + +@end deftypemethod +@deftypemethod Graphics2D {public abstract void} setRenderingHint (java.awt.RenderingHints.Key@w{ }@var{hintKey}, java.lang.Object@w{ }@var{hintValue}) + +@end deftypemethod +@deftypemethod Graphics2D {public abstract Object} getRenderingHint (java.awt.RenderingHints.Key@w{ }@var{hintKey}) + +@end deftypemethod +@deftypemethod Graphics2D {public abstract RenderingHints} getRenderingHints () + +@end deftypemethod +@deftypemethod Graphics2D {public abstract void} translate (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Graphics2D {public abstract void} translate (double@w{ }@var{tx}, double@w{ }@var{ty}) + +@end deftypemethod +@deftypemethod Graphics2D {public abstract void} rotate (double@w{ }@var{theta}) + +@end deftypemethod +@deftypemethod Graphics2D {public abstract void} rotate (double@w{ }@var{theta}, double@w{ }@var{x}, double@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Graphics2D {public abstract void} scale (double@w{ }@var{scaleX}, double@w{ }@var{scaleY}) + +@end deftypemethod +@deftypemethod Graphics2D {public abstract void} shear (double@w{ }@var{shearX}, double@w{ }@var{shearY}) + +@end deftypemethod +@deftypemethod Graphics2D {public abstract void} transform (java.awt.geom.AffineTransform@w{ }@var{Tx}) + +@end deftypemethod +@deftypemethod Graphics2D {public abstract void} setTransform (java.awt.geom.AffineTransform@w{ }@var{Tx}) + +@end deftypemethod +@deftypemethod Graphics2D {public abstract AffineTransform} getTransform () + +@end deftypemethod +@deftypemethod Graphics2D {public abstract Paint} getPaint () + +@end deftypemethod +@deftypemethod Graphics2D {public abstract void} setBackground (java.awt.Color@w{ }@var{color}) + +@end deftypemethod +@deftypemethod Graphics2D {public abstract Color} getBackground () + +@end deftypemethod +@deftypemethod Graphics2D {public abstract void} clip (java.awt.Shape@w{ }@var{s}) + +@end deftypemethod +@deftypemethod GraphicsConfiguration {public abstract BufferedImage} createCompatibleImage (int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod GraphicsConfiguration {public abstract BufferedImage} createCompatibleImage (int@w{ }@var{width}, int@w{ }@var{height}, int@w{ }@var{transparency}) + +@end deftypemethod +@deftypemethod GraphicsConfiguration {public abstract ColorModel} getColorModel () + +@end deftypemethod +@deftypemethod GraphicsConfiguration {public abstract ColorModel} getColorModel (int@w{ }@var{transparency}) + +@end deftypemethod +@deftypemethod GraphicsConfiguration {public abstract AffineTransform} getDefaultTransform () + +@end deftypemethod +@deftypemethod GraphicsConfiguration {public abstract AffineTransform} getNormalizingTransform () + +@end deftypemethod +@deftypemethod GraphicsConfiguration {public abstract Rectangle} getBounds () + +@end deftypemethod +@deftypemethod Graphics {public abstract Graphics} create () + +@end deftypemethod +@deftypemethod Graphics {public Graphics} create (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod Graphics {public abstract void} translate (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Graphics {public abstract Color} getColor () + +@end deftypemethod +@deftypemethod Graphics {public abstract void} setColor (java.awt.Color@w{ }@var{color}) + +@end deftypemethod +@deftypemethod Graphics {public abstract void} setPaintMode () + +@end deftypemethod +@deftypemethod Graphics {public abstract void} setXORMode (java.awt.Color@w{ }@var{altColor}) + +@end deftypemethod +@deftypemethod Graphics {public abstract Font} getFont () + +@end deftypemethod +@deftypemethod Graphics {public abstract void} setFont (java.awt.Font@w{ }@var{font}) + +@end deftypemethod +@deftypemethod Graphics {public FontMetrics} getFontMetrics () + +@end deftypemethod +@deftypemethod Graphics {public abstract FontMetrics} getFontMetrics (java.awt.Font@w{ }@var{font}) + +@end deftypemethod +@deftypemethod Graphics {public abstract Rectangle} getClipBounds () + +@end deftypemethod +@deftypemethod Graphics {public abstract void} clipRect (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod Graphics {public abstract void} setClip (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod Graphics {public abstract Shape} getClip () + +@end deftypemethod +@deftypemethod Graphics {public abstract void} setClip (java.awt.Shape@w{ }@var{clip}) + +@end deftypemethod +@deftypemethod Graphics {public abstract void} copyArea (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}, int@w{ }@var{dx}, int@w{ }@var{dy}) + +@end deftypemethod +@deftypemethod Graphics {public abstract void} drawLine (int@w{ }@var{x1}, int@w{ }@var{y1}, int@w{ }@var{x2}, int@w{ }@var{y2}) + +@end deftypemethod +@deftypemethod Graphics {public abstract void} fillRect (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod Graphics {public void} drawRect (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod Graphics {public abstract void} clearRect (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod Graphics {public abstract void} drawRoundRect (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}, int@w{ }@var{arcWidth}, int@w{ }@var{arcHeight}) + +@end deftypemethod +@deftypemethod Graphics {public abstract void} fillRoundRect (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}, int@w{ }@var{arcWidth}, int@w{ }@var{arcHeight}) + +@end deftypemethod +@deftypemethod Graphics {public void} draw3DRect (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}, boolean@w{ }@var{raised}) + +@end deftypemethod +@deftypemethod Graphics {public void} fill3DRect (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}, boolean@w{ }@var{raised}) + +@end deftypemethod +@deftypemethod Graphics {public abstract void} drawOval (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod Graphics {public abstract void} fillOval (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod Graphics {public abstract void} drawArc (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}, int@w{ }@var{startAngle}, int@w{ }@var{arcAngle}) + +@end deftypemethod +@deftypemethod Graphics {public abstract void} fillArc (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}, int@w{ }@var{startAngle}, int@w{ }@var{arcAngle}) + +@end deftypemethod +@deftypemethod Graphics {public abstract void} drawPolyline (int[]@w{ }@var{xPoints}, int[]@w{ }@var{yPoints}, int@w{ }@var{nPoints}) + +@end deftypemethod +@deftypemethod Graphics {public abstract void} drawPolygon (int[]@w{ }@var{xPoints}, int[]@w{ }@var{yPoints}, int@w{ }@var{nPoints}) + +@end deftypemethod +@deftypemethod Graphics {public abstract void} fillPolygon (int[]@w{ }@var{xPoints}, int[]@w{ }@var{yPoints}, int@w{ }@var{nPoints}) + +@end deftypemethod +@deftypemethod Graphics {public abstract void} drawString (java.lang.String@w{ }@var{str}, int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Graphics {public void} drawChars (char[]@w{ }@var{data}, int@w{ }@var{offset}, int@w{ }@var{length}, int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Graphics {public void} drawBytes (byte[]@w{ }@var{data}, int@w{ }@var{offset}, int@w{ }@var{length}, int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Graphics {public abstract boolean} drawImage (java.awt.Image@w{ }@var{img}, int@w{ }@var{x}, int@w{ }@var{y}, java.awt.image.ImageObserver@w{ }@var{observer}) + +@end deftypemethod +@deftypemethod Graphics {public abstract boolean} drawImage (java.awt.Image@w{ }@var{img}, int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}, java.awt.image.ImageObserver@w{ }@var{observer}) + +@end deftypemethod +@deftypemethod Graphics {public abstract boolean} drawImage (java.awt.Image@w{ }@var{img}, int@w{ }@var{x}, int@w{ }@var{y}, java.awt.Color@w{ }@var{bgcolor}, java.awt.image.ImageObserver@w{ }@var{observer}) + +@end deftypemethod +@deftypemethod Graphics {public abstract boolean} drawImage (java.awt.Image@w{ }@var{img}, int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}, java.awt.Color@w{ }@var{bgcolor}, java.awt.image.ImageObserver@w{ }@var{observer}) + +@end deftypemethod +@deftypemethod Graphics {public abstract boolean} drawImage (java.awt.Image@w{ }@var{img}, int@w{ }@var{dx1}, int@w{ }@var{dy1}, int@w{ }@var{dx2}, int@w{ }@var{dy2}, int@w{ }@var{sx1}, int@w{ }@var{sy1}, int@w{ }@var{sx2}, int@w{ }@var{sy2}, java.awt.image.ImageObserver@w{ }@var{observer}) + +@end deftypemethod +@deftypemethod Graphics {public abstract boolean} drawImage (java.awt.Image@w{ }@var{img}, int@w{ }@var{dx1}, int@w{ }@var{dy1}, int@w{ }@var{dx2}, int@w{ }@var{dy2}, int@w{ }@var{sx1}, int@w{ }@var{sy1}, int@w{ }@var{sx2}, int@w{ }@var{sy2}, java.awt.Color@w{ }@var{bgcolor}, java.awt.image.ImageObserver@w{ }@var{observer}) + +@end deftypemethod +@deftypemethod Graphics {public abstract void} dispose () + +@end deftypemethod +@deftypemethod Graphics {public void} finalize () + +@end deftypemethod +@deftypemethod Graphics {public String} toString () + +@end deftypemethod +@deftypemethod Graphics {public Rectangle} getClipRect () + +@end deftypemethod +@deftypemethod Graphics {public boolean} hitClip (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod Graphics {public Rectangle} getClipBounds (java.awt.Rectangle@w{ }@var{r}) + +@end deftypemethod +@deftypemethod GridBagConstraints {public Object} clone () +Create a copy of this object. +@end deftypemethod +@deftypemethod GridLayout {public void} addLayoutComponent (java.lang.String@w{ }@var{name}, java.awt.Component@w{ }@var{comp}) +Add a new component to the layout. This particular implementation + does nothing. +@end deftypemethod +@deftypemethod GridLayout {public int} getColumns () +Return the number of columns in this layout. +@end deftypemethod +@deftypemethod GridLayout {public int} getHgap () +Return the horizontal gap. +@end deftypemethod +@deftypemethod GridLayout {public int} getRows () +Return the number of rows in this layout. +@end deftypemethod +@deftypemethod GridLayout {public int} getVgap () +Return the vertical gap. +@end deftypemethod +@deftypemethod GridLayout {public void} layoutContainer (java.awt.Container@w{ }@var{parent}) +Lay out the container's components based on current settings. +@end deftypemethod +@deftypemethod GridLayout {public Dimension} minimumLayoutSize (java.awt.Container@w{ }@var{cont}) +Get the minimum layout size of the container. +@end deftypemethod +@deftypemethod GridLayout {public Dimension} preferredLayoutSize (java.awt.Container@w{ }@var{cont}) +Get the preferred layout size of the container. +@end deftypemethod +@deftypemethod GridLayout {public void} removeLayoutComponent (java.awt.Component@w{ }@var{comp}) +Remove the indicated component from this layout manager. + This particular implementation does nothing. +@end deftypemethod +@deftypemethod GridLayout {public void} setColumns (int@w{ }@var{newCols}) +Set the number of columns. +@end deftypemethod +@deftypemethod GridLayout {public void} setHgap (int@w{ }@var{hgap}) +Set the horizontal gap +@end deftypemethod +@deftypemethod GridLayout {public void} setRows (int@w{ }@var{newRows}) +Set the number of rows +@end deftypemethod +@deftypemethod GridLayout {public void} setVgap (int@w{ }@var{vgap}) +Set the vertical gap. +@end deftypemethod +@deftypemethod GridLayout {public String} toString () +Return String description of this object. +@end deftypemethod +@deftypemethod Image {public abstract int} getWidth (java.awt.image.ImageObserver@w{ }@var{observer}) + +@end deftypemethod +@deftypemethod Image {public abstract int} getHeight (java.awt.image.ImageObserver@w{ }@var{observer}) + +@end deftypemethod +@deftypemethod Image {public abstract ImageProducer} getSource () + +@end deftypemethod +@deftypemethod Image {public abstract Graphics} getGraphics () + +@end deftypemethod +@deftypemethod Image {public abstract Object} getProperty (java.lang.String@w{ }@var{name}, java.awt.image.ImageObserver@w{ }@var{observer}) + +@end deftypemethod +@deftypemethod Image {public Image} getScaledInstance (int@w{ }@var{width}, int@w{ }@var{height}, int@w{ }@var{hints}) + +@end deftypemethod +@deftypemethod Image {public abstract void} flush () + +@end deftypemethod +@deftypemethod Insets {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod Insets {public int} hashCode () + +@end deftypemethod +@deftypemethod Insets {public String} toString () + +@end deftypemethod +@deftypemethod Insets {public Object} clone () + +@end deftypemethod +@deftypemethod ItemSelectable {public void} addItemListener (java.awt.event.ItemListener@w{ }@var{l}) +This method adds a listener to receive item events fired by the + component. +@end deftypemethod +@deftypemethod ItemSelectable {public Object} getSelectedObjects () +This method returns the items in this component which are + currently selected. +@end deftypemethod +@deftypemethod ItemSelectable {public void} removeItemListener (java.awt.event.ItemListener@w{ }@var{l}) +This method removes an item listener. +@end deftypemethod +@deftypemethod Label {public void} addNotify () + +@end deftypemethod +@deftypemethod Label {public int} getAlignment () + +@end deftypemethod +@deftypemethod Label {public String} getText () + +@end deftypemethod +@deftypemethod Label {protected String} paramString () + +@end deftypemethod +@deftypemethod Label {public void} setAlignment (int@w{ }@var{alignment}) + +@end deftypemethod +@deftypemethod Label {public void} setText (java.lang.String@w{ }@var{text}) + +@end deftypemethod +@deftypemethod LayoutManager2 {public void} addLayoutComponent (java.awt.Component@w{ }@var{comp}, java.lang.Object@w{ }@var{constraints}) + +@end deftypemethod +@deftypemethod LayoutManager2 {public float} getLayoutAlignmentX (java.awt.Container@w{ }@var{target}) + +@end deftypemethod +@deftypemethod LayoutManager2 {public float} getLayoutAlignmentY (java.awt.Container@w{ }@var{target}) + +@end deftypemethod +@deftypemethod LayoutManager2 {public void} invalidateLayout (java.awt.Container@w{ }@var{target}) + +@end deftypemethod +@deftypemethod LayoutManager2 {public Dimension} maximumLayoutSize (java.awt.Container@w{ }@var{target}) + +@end deftypemethod +@deftypemethod LayoutManager {public void} addLayoutComponent (java.lang.String@w{ }@var{name}, java.awt.Component@w{ }@var{comp}) + +@end deftypemethod +@deftypemethod LayoutManager {public void} layoutContainer (java.awt.Container@w{ }@var{parent}) + +@end deftypemethod +@deftypemethod LayoutManager {public Dimension} minimumLayoutSize (java.awt.Container@w{ }@var{parent}) + +@end deftypemethod +@deftypemethod LayoutManager {public Dimension} preferredLayoutSize (java.awt.Container@w{ }@var{parent}) + +@end deftypemethod +@deftypemethod LayoutManager {public void} removeLayoutComponent (java.awt.Component@w{ }@var{comp}) + +@end deftypemethod +@deftypemethod MenuBar {public synchronized Menu} add (java.awt.Menu@w{ }@var{menu}) +Add a menu to this MenuBar. If the menu has already has a + parent, it is first removed from its old parent before being + added. +@end deftypemethod +@deftypemethod MenuBar {public void} addNotify () +This creates the component's peer. +@end deftypemethod +@deftypemethod MenuBar {public int} countMenus () + +@end deftypemethod +@deftypemethod MenuBar {public void} deleteShortcut (java.awt.MenuShortcut@w{ }@var{shortcut}) +Delete a keyboard shortcut. +@end deftypemethod +@deftypemethod MenuBar {public Menu} getHelpMenu () +Returns the current Help menu. +@end deftypemethod +@deftypemethod MenuBar {public Menu} getMenu (int@w{ }@var{index}) +Returns a menu from this object. +@end deftypemethod +@deftypemethod MenuBar {public int} getMenuCount () +Returns the number of menus on this MenuBar. +@end deftypemethod +@deftypemethod MenuBar {public MenuItem} getShortcutMenuItem (java.awt.MenuShortcut@w{ }@var{shortcut}) +Returns the menu item on this MenuBar with the specified + shortcut. +@end deftypemethod +@deftypemethod MenuBar {public synchronized void} remove (java.awt.MenuComponent@w{ }@var{menu}) +Remove a menu from the menu bar. If the menu is specified by + component (and not index), and does not exist on the menu, then + the method does nothing. If the removed menu has a peer, it is + destroyed. +@end deftypemethod +@deftypemethod MenuBar {public synchronized void} remove (int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod MenuBar {public synchronized void} setHelpMenu (java.awt.Menu@w{ }@var{menu}) +Set the Help menu for this MenuBar. If a Help menu already + exists, it is first removed. +@end deftypemethod +@deftypemethod MenuBar {public synchronized Enumeration} shortcuts () +Returns an Enumeration which lists the keyboard shortcuts + associated with menu items on this MenuBar. +@end deftypemethod +@deftypemethod MenuComponent {public String} getName () + +@end deftypemethod +@deftypemethod MenuComponent {public void} setName (java.lang.String@w{ }@var{name}) + +@end deftypemethod +@deftypemethod MenuComponent {public MenuContainer} getParent () + +@end deftypemethod +@deftypemethod MenuComponent {public MenuComponentPeer} getPeer () + +@end deftypemethod +@deftypemethod MenuComponent {public Font} getFont () + +@end deftypemethod +@deftypemethod MenuComponent {public void} setFont (java.awt.Font@w{ }@var{f}) + +@end deftypemethod +@deftypemethod MenuComponent {public void} removeNotify () + +@end deftypemethod +@deftypemethod MenuComponent {public boolean} postEvent (java.awt.Event@w{ }@var{evt}) + +@end deftypemethod +@deftypemethod MenuComponent {public final void} dispatchEvent (java.awt.AWTEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod MenuComponent {protected void} processEvent (java.awt.AWTEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod MenuComponent {protected String} paramString () + +@end deftypemethod +@deftypemethod MenuComponent {public String} toString () + +@end deftypemethod +@deftypemethod MenuComponent {protected final Object} getTreeLock () + +@end deftypemethod +@deftypemethod MenuContainer {public Font} getFont () + +@end deftypemethod +@deftypemethod MenuContainer {public boolean} postEvent (java.awt.Event@w{ }@var{evt}) + +@end deftypemethod +@deftypemethod MenuContainer {public void} remove (java.awt.MenuComponent@w{ }@var{comp}) + +@end deftypemethod +@deftypemethod MenuItem {public String} getLabel () + +@end deftypemethod +@deftypemethod MenuItem {public synchronized void} setLabel (java.lang.String@w{ }@var{label}) + +@end deftypemethod +@deftypemethod MenuItem {public boolean} isEnabled () + +@end deftypemethod +@deftypemethod MenuItem {public synchronized void} setEnabled (boolean@w{ }@var{b}) + +@end deftypemethod +@deftypemethod MenuItem {public void} enable () + +@end deftypemethod +@deftypemethod MenuItem {public void} enable (boolean@w{ }@var{b}) + +@end deftypemethod +@deftypemethod MenuItem {public void} disable () + +@end deftypemethod +@deftypemethod MenuItem {public MenuShortcut} getShortcut () + +@end deftypemethod +@deftypemethod MenuItem {public void} setShortcut (java.awt.MenuShortcut@w{ }@var{s}) + +@end deftypemethod +@deftypemethod MenuItem {public void} deleteShortcut () + +@end deftypemethod +@deftypemethod MenuItem {protected final void} enableEvents (long@w{ }@var{eventsToEnable}) + +@end deftypemethod +@deftypemethod MenuItem {protected final void} disableEvents (long@w{ }@var{eventsToDisable}) + +@end deftypemethod +@deftypemethod MenuItem {public void} setActionCommand (java.lang.String@w{ }@var{command}) + +@end deftypemethod +@deftypemethod MenuItem {public String} getActionCommand () + +@end deftypemethod +@deftypemethod MenuItem {public synchronized void} addActionListener (java.awt.event.ActionListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod MenuItem {public synchronized void} removeActionListener (java.awt.event.ActionListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod MenuItem {public void} addNotify () + +@end deftypemethod +@deftypemethod MenuItem {public EventListener} getListeners (java.lang.Class@w{ }@var{listenerType}) +Returns all registered EventListers of the given listenerType. + listenerType must be a subclass of EventListener, or a + ClassClassException is thrown. +@end deftypemethod +@deftypemethod MenuItem {protected void} processEvent (java.awt.AWTEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod MenuItem {protected void} processActionEvent (java.awt.event.ActionEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod MenuItem {public String} paramString () + +@end deftypemethod +@deftypemethod Menu {public void} addNotify () + +@end deftypemethod +@deftypemethod Menu {public void} removeNotify () + +@end deftypemethod +@deftypemethod Menu {public boolean} isTearOff () + +@end deftypemethod +@deftypemethod Menu {public int} getItemCount () + +@end deftypemethod +@deftypemethod Menu {public int} countItems () + +@end deftypemethod +@deftypemethod Menu {public MenuItem} getItem (int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod Menu {public synchronized MenuItem} add (java.awt.MenuItem@w{ }@var{mi}) + +@end deftypemethod +@deftypemethod Menu {public void} add (java.lang.String@w{ }@var{label}) + +@end deftypemethod +@deftypemethod Menu {public synchronized void} insert (java.awt.MenuItem@w{ }@var{menuitem}, int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod Menu {public void} insert (java.lang.String@w{ }@var{label}, int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod Menu {public void} addSeparator () + +@end deftypemethod +@deftypemethod Menu {public void} insertSeparator (int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod Menu {public synchronized void} remove (int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod Menu {public synchronized void} remove (java.awt.MenuComponent@w{ }@var{item}) + +@end deftypemethod +@deftypemethod Menu {public synchronized void} removeAll () + +@end deftypemethod +@deftypemethod Menu {public String} paramString () + +@end deftypemethod +@deftypemethod MenuShortcut {public int} getKey () + +@end deftypemethod +@deftypemethod MenuShortcut {public boolean} usesShiftModifier () + +@end deftypemethod +@deftypemethod MenuShortcut {public boolean} equals (java.awt.MenuShortcut@w{ }@var{ms}) + +@end deftypemethod +@deftypemethod MenuShortcut {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod MenuShortcut {public int} hashCode () + +@end deftypemethod +@deftypemethod MenuShortcut {public String} toString () + +@end deftypemethod +@deftypemethod MenuShortcut {protected String} paramString () + +@end deftypemethod +@deftypemethod PaintContext {public void} dispose () + +@end deftypemethod +@deftypemethod Panel {public void} addNotify () + +@end deftypemethod +@deftypemethod Point {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod Point {public int} hashCode () + +@end deftypemethod +@deftypemethod Point {public Point} getLocation () + +@end deftypemethod +@deftypemethod Point {public void} move (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Point {public void} setLocation (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Point {public void} setLocation (java.awt.Point@w{ }@var{pt}) + +@end deftypemethod +@deftypemethod Point {public void} translate (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Point {public String} toString () + +@end deftypemethod +@deftypemethod Point {public double} getX () + +@end deftypemethod +@deftypemethod Point {public double} getY () + +@end deftypemethod +@deftypemethod Point {public void} setLocation (double@w{ }@var{x}, double@w{ }@var{y}) + +@end deftypemethod +@deftypemethod PopupMenu {public void} addNotify () + +@end deftypemethod +@deftypemethod PopupMenu {public void} show (java.awt.Component@w{ }@var{origin}, int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Rectangle {public Rectangle} getBounds () + +@end deftypemethod +@deftypemethod Rectangle {public void} add (int@w{ }@var{newx}, int@w{ }@var{newy}) + +@end deftypemethod +@deftypemethod Rectangle {public void} add (java.awt.Point@w{ }@var{pt}) + +@end deftypemethod +@deftypemethod Rectangle {public void} add (java.awt.Rectangle@w{ }@var{r}) + +@end deftypemethod +@deftypemethod Rectangle {public boolean} contains (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Rectangle {public boolean} contains (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{w}, int@w{ }@var{h}) + +@end deftypemethod +@deftypemethod Rectangle {public boolean} contains (java.awt.Point@w{ }@var{p}) + +@end deftypemethod +@deftypemethod Rectangle {public boolean} contains (java.awt.Rectangle@w{ }@var{r}) + +@end deftypemethod +@deftypemethod Rectangle {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod Rectangle {public double} getHeight () + +@end deftypemethod +@deftypemethod Rectangle {public Point} getLocation () + +@end deftypemethod +@deftypemethod Rectangle {public PathIterator} getPathIterator (java.awt.geom.AffineTransform@w{ }@var{t}) + +@end deftypemethod +@deftypemethod Rectangle {public Dimension} getSize () + +@end deftypemethod +@deftypemethod Rectangle {public double} getWidth () + +@end deftypemethod +@deftypemethod Rectangle {public double} getX () + +@end deftypemethod +@deftypemethod Rectangle {public double} getY () + +@end deftypemethod +@deftypemethod Rectangle {public void} grow (int@w{ }@var{h}, int@w{ }@var{v}) + +@end deftypemethod +@deftypemethod Rectangle {public boolean} inside (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Rectangle {public Rectangle} intersection (java.awt.Rectangle@w{ }@var{r}) + +@end deftypemethod +@deftypemethod Rectangle {public boolean} intersects (java.awt.Rectangle@w{ }@var{r}) + +@end deftypemethod +@deftypemethod Rectangle {public boolean} isEmpty () + +@end deftypemethod +@deftypemethod Rectangle {public void} move (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Rectangle {public int} outcode (double@w{ }@var{x}, double@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Rectangle {public void} reshape (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod Rectangle {public void} resize (int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod Rectangle {public void} setBounds (int@w{ }@var{x}, int@w{ }@var{y}, int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod Rectangle {public void} setBounds (java.awt.Rectangle@w{ }@var{r}) + +@end deftypemethod +@deftypemethod Rectangle {public void} setLocation (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Rectangle {public void} setLocation (java.awt.Point@w{ }@var{p}) + +@end deftypemethod +@deftypemethod Rectangle {public void} setRect (double@w{ }@var{x}, double@w{ }@var{y}, double@w{ }@var{width}, double@w{ }@var{height}) + +@end deftypemethod +@deftypemethod Rectangle {public void} setSize (java.awt.Dimension@w{ }@var{d}) + +@end deftypemethod +@deftypemethod Rectangle {public void} setSize (int@w{ }@var{width}, int@w{ }@var{height}) + +@end deftypemethod +@deftypemethod Rectangle {public void} translate (int@w{ }@var{x}, int@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Rectangle {public Rectangle} union (java.awt.Rectangle@w{ }@var{r}) + +@end deftypemethod +@deftypemethod Rectangle {public Rectangle2D} createIntersection (java.awt.geom.Rectangle2D@w{ }@var{r}) + +@end deftypemethod +@deftypemethod Rectangle {public Rectangle2D} createUnion (java.awt.geom.Rectangle2D@w{ }@var{r}) + +@end deftypemethod +@deftypemethod Rectangle {public Rectangle2D} getBounds2D () + +@end deftypemethod +@deftypemethod Rectangle {public String} toString () + +@end deftypemethod +@deftypemethod RenderingHints {public int} size () + +@end deftypemethod +@deftypemethod RenderingHints {public boolean} isEmpty () + +@end deftypemethod +@deftypemethod RenderingHints {public boolean} containsKey (java.lang.Object@w{ }@var{key}) + +@end deftypemethod +@deftypemethod RenderingHints {public boolean} containsValue (java.lang.Object@w{ }@var{value}) + +@end deftypemethod +@deftypemethod RenderingHints {public Object} get (java.lang.Object@w{ }@var{key}) + +@end deftypemethod +@deftypemethod RenderingHints {public Object} put (java.lang.Object@w{ }@var{key}, java.lang.Object@w{ }@var{value}) + +@end deftypemethod +@deftypemethod RenderingHints {public void} add (java.awt.RenderingHints@w{ }@var{hints}) + +@end deftypemethod +@deftypemethod RenderingHints {public void} clear () + +@end deftypemethod +@deftypemethod RenderingHints {public Object} remove (java.lang.Object@w{ }@var{key}) + +@end deftypemethod +@deftypemethod RenderingHints {public boolean} equals (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod RenderingHints {public int} hashCode () + +@end deftypemethod +@deftypemethod RenderingHints {public Object} clone () + +@end deftypemethod +@deftypemethod RenderingHints {public String} toString () + +@end deftypemethod +@deftypemethod Scrollbar {public void} addNotify () + +@end deftypemethod +@deftypemethod Scrollbar {public int} getOrientation () + +@end deftypemethod +@deftypemethod Scrollbar {public void} setOrientation (int@w{ }@var{orientation}) + +@end deftypemethod +@deftypemethod Scrollbar {public int} getValue () + +@end deftypemethod +@deftypemethod Scrollbar {public void} setValue (int@w{ }@var{value}) + +@end deftypemethod +@deftypemethod Scrollbar {public int} getMinimum () + +@end deftypemethod +@deftypemethod Scrollbar {public void} setMinimum (int@w{ }@var{minimum}) + +@end deftypemethod +@deftypemethod Scrollbar {public int} getMaximum () + +@end deftypemethod +@deftypemethod Scrollbar {public void} setMaximum (int@w{ }@var{maximum}) + +@end deftypemethod +@deftypemethod Scrollbar {public int} getVisibleAmount () + +@end deftypemethod +@deftypemethod Scrollbar {public int} getVisible () + +@end deftypemethod +@deftypemethod Scrollbar {public void} setVisibleAmount (int@w{ }@var{visible}) + +@end deftypemethod +@deftypemethod Scrollbar {public void} setUnitIncrement (int@w{ }@var{v}) + +@end deftypemethod +@deftypemethod Scrollbar {public void} setLineIncrement (int@w{ }@var{v}) + +@end deftypemethod +@deftypemethod Scrollbar {public int} getUnitIncrement () + +@end deftypemethod +@deftypemethod Scrollbar {public int} getLineIncrement () + +@end deftypemethod +@deftypemethod Scrollbar {public void} setBlockIncrement (int@w{ }@var{v}) + +@end deftypemethod +@deftypemethod Scrollbar {public void} setPageIncrement (int@w{ }@var{v}) + +@end deftypemethod +@deftypemethod Scrollbar {public int} getBlockIncrement () + +@end deftypemethod +@deftypemethod Scrollbar {public int} getPageIncrement () + +@end deftypemethod +@deftypemethod Scrollbar {public synchronized void} setValues (int@w{ }@var{value}, int@w{ }@var{visible}, int@w{ }@var{minimum}, int@w{ }@var{maximum}) + +@end deftypemethod +@deftypemethod Scrollbar {public void} addAdjustmentListener (java.awt.event.AdjustmentListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Scrollbar {public void} removeAdjustmentListener (java.awt.event.AdjustmentListener@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Scrollbar {protected void} processEvent (java.awt.AWTEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod Scrollbar {protected void} processAdjustmentEvent (java.awt.event.AdjustmentEvent@w{ }@var{e}) + +@end deftypemethod +@deftypemethod Scrollbar {protected String} paramString () + +@end deftypemethod +@deftypemethod ScrollPane {protected final void} addImpl (java.awt.Component@w{ }@var{comp}, java.lang.Object@w{ }@var{constraints}, int@w{ }@var{pos}) +Add a component to this ScrollPane. +@end deftypemethod +@deftypemethod ScrollPane {public void} addNotify () +This creates the component's peer. +@end deftypemethod +@deftypemethod ScrollPane {public void} doLayout () +Lays out the components in this container. +@end deftypemethod +@deftypemethod ScrollPane {public Adjustable} getHAdjustable () +Returns an Adjustable representing the horizontal scrollbar. + The methods setMaximum, setMinimum, and setVisibleAmount should + not be called on this Adjustable. They will throw AWTError if + called. +@end deftypemethod +@deftypemethod ScrollPane {public int} getHScrollbarHeight () +Returns the height of the horizontal scrollbar. +@end deftypemethod +@deftypemethod ScrollPane {public int} getScrollbarDisplayPolicy () +Returns the scrollbar display policy. +@end deftypemethod +@deftypemethod ScrollPane {public Point} getScrollPosition () +Returns the viewport's scroll position. +@end deftypemethod +@deftypemethod ScrollPane {public Adjustable} getVAdjustable () +Returns an Adjustable representing the vertical scrollbar. + The methods setMaximum, setMinimum, and setVisibleAmount should + not be called on this Adjustable. They will throw AWTError if + called. +@end deftypemethod +@deftypemethod ScrollPane {public Dimension} getViewportSize () +Returns the size of the viewport. +@end deftypemethod +@deftypemethod ScrollPane {public int} getVScrollbarWidth () +Returns the width of the vertical scrollbar. +@end deftypemethod +@deftypemethod ScrollPane {public String} paramString () +Generates a String representation of this ScrollPane's state. +@end deftypemethod +@deftypemethod ScrollPane {public final void} setLayout (java.awt.LayoutManager@w{ }@var{m}) +Set the layout manager for this component. ScrollPane has its + own layout manager and overrides this method so that the layout + manager cannot be changed. +@end deftypemethod +@deftypemethod ScrollPane {public void} setScrollPosition (int@w{ }@var{x}, int@w{ }@var{y}) +Sets the scroll position for this ScrollPane. If the point if + out of range it is silently moved within range. +@end deftypemethod +@deftypemethod ScrollPane {public void} setScrollPosition (java.awt.Point@w{ }@var{p}) +Sets the scroll position for this ScrollPane. If the point if + out of range it is silently moved within range. +@end deftypemethod +@deftypemethod Shape {public boolean} contains (double@w{ }@var{x}, double@w{ }@var{y}) + +@end deftypemethod +@deftypemethod Shape {public boolean} contains (double@w{ }@var{x}, double@w{ }@var{y}, double@w{ }@var{w}, double@w{ }@var{h}) + +@end deftypemethod +@deftypemethod Shape {public boolean} contains (java.awt.geom.Point2D@w{ }@var{p}) + +@end deftypemethod +@deftypemethod Shape {public boolean} contains (java.awt.geom.Rectangle2D@w{ }@var{r}) + +@end deftypemethod +@deftypemethod Shape {public Rectangle} getBounds () + +@end deftypemethod +@deftypemethod Shape {public Rectangle2D} getBounds2D () + +@end deftypemethod +@deftypemethod Shape {public PathIterator} getPathIterator (java.awt.geom.AffineTransform@w{ }@var{at}) + +@end deftypemethod +@deftypemethod Shape {public PathIterator} getPathIterator (java.awt.geom.AffineTransform@w{ }@var{at}, double@w{ }@var{flatness}) + +@end deftypemethod +@deftypemethod Shape {public boolean} intersects (double@w{ }@var{x}, double@w{ }@var{y}, double@w{ }@var{w}, double@w{ }@var{h}) + +@end deftypemethod +@deftypemethod Shape {public boolean} intersects (java.awt.geom.Rectangle2D@w{ }@var{r}) + +@end deftypemethod +@deftypemethod SystemColor {public int} getRGB () + +@end deftypemethod +@deftypemethod SystemColor {public String} toString () + +@end deftypemethod +@deftypemethod TextArea {public synchronized void} append (java.lang.String@w{ }@var{str}) + +@end deftypemethod +@deftypemethod TextArea {public synchronized void} insert (java.lang.String@w{ }@var{str}, int@w{ }@var{pos}) + +@end deftypemethod +@deftypemethod TextArea {public synchronized void} replaceRange (java.lang.String@w{ }@var{str}, int@w{ }@var{start}, int@w{ }@var{end}) + +@end deftypemethod +@deftypemethod TextComponent {public synchronized String} getText () + +@end deftypemethod +@deftypemethod TextComponent {public synchronized void} setText (java.lang.String@w{ }@var{text}) + +@end deftypemethod +@deftypemethod TextComponent {public synchronized void} addTextListener (java.awt.event.TextListener@w{ }@var{listener}) + +@end deftypemethod +@deftypemethod TextComponent {public int} getCaretPosition () + +@end deftypemethod +@deftypemethod TextComponent {public void} setCaretPosition (int@w{ }@var{pos}) + +@end deftypemethod +@deftypemethod Toolkit {public static Toolkit} getDefaultToolkit () + +@end deftypemethod +@deftypemethod Toolkit {protected abstract ButtonPeer} createButton (java.awt.Button@w{ }@var{target}) + +@end deftypemethod +@deftypemethod Toolkit {protected abstract TextFieldPeer} createTextField (java.awt.TextField@w{ }@var{target}) + +@end deftypemethod +@deftypemethod Toolkit {protected abstract LabelPeer} createLabel (java.awt.Label@w{ }@var{target}) + +@end deftypemethod +@deftypemethod Toolkit {protected abstract ListPeer} createList (java.awt.List@w{ }@var{target}) + +@end deftypemethod +@deftypemethod Toolkit {protected abstract CheckboxPeer} createCheckbox (java.awt.Checkbox@w{ }@var{target}) + +@end deftypemethod +@deftypemethod Toolkit {protected abstract ScrollbarPeer} createScrollbar (java.awt.Scrollbar@w{ }@var{target}) + +@end deftypemethod +@deftypemethod Toolkit {protected abstract ScrollPanePeer} createScrollPane (java.awt.ScrollPane@w{ }@var{target}) + +@end deftypemethod +@deftypemethod Toolkit {protected abstract TextAreaPeer} createTextArea (java.awt.TextArea@w{ }@var{target}) + +@end deftypemethod +@deftypemethod Toolkit {protected abstract ChoicePeer} createChoice (java.awt.Choice@w{ }@var{target}) + +@end deftypemethod +@deftypemethod Toolkit {protected abstract FramePeer} createFrame (java.awt.Frame@w{ }@var{target}) + +@end deftypemethod +@deftypemethod Toolkit {protected abstract CanvasPeer} createCanvas (java.awt.Canvas@w{ }@var{target}) + +@end deftypemethod +@deftypemethod Toolkit {protected abstract PanelPeer} createPanel (java.awt.Panel@w{ }@var{target}) + +@end deftypemethod +@deftypemethod Toolkit {protected abstract WindowPeer} createWindow (java.awt.Window@w{ }@var{target}) + +@end deftypemethod +@deftypemethod Toolkit {protected abstract DialogPeer} createDialog (java.awt.Dialog@w{ }@var{target}) + +@end deftypemethod +@deftypemethod Toolkit {protected abstract MenuBarPeer} createMenuBar (java.awt.MenuBar@w{ }@var{target}) + +@end deftypemethod +@deftypemethod Toolkit {protected abstract MenuPeer} createMenu (java.awt.Menu@w{ }@var{target}) + +@end deftypemethod +@deftypemethod Toolkit {protected abstract PopupMenuPeer} createPopupMenu (java.awt.PopupMenu@w{ }@var{target}) + +@end deftypemethod +@deftypemethod Toolkit {protected abstract MenuItemPeer} createMenuItem (java.awt.MenuItem@w{ }@var{target}) + +@end deftypemethod +@deftypemethod Toolkit {protected abstract FileDialogPeer} createFileDialog (java.awt.FileDialog@w{ }@var{target}) + +@end deftypemethod +@deftypemethod Toolkit {protected abstract CheckboxMenuItemPeer} createCheckboxMenuItem (java.awt.CheckboxMenuItem@w{ }@var{target}) + +@end deftypemethod +@deftypemethod Toolkit {protected LightweightPeer} createComponent (java.awt.Component@w{ }@var{target}) + +@end deftypemethod +@deftypemethod Toolkit {protected abstract FontPeer} getFontPeer (java.lang.String@w{ }@var{name}, int@w{ }@var{style}) + +@end deftypemethod +@deftypemethod Toolkit {protected void} loadSystemColors (int[]@w{ }@var{systemColors}) + +@end deftypemethod +@deftypemethod Toolkit {public abstract Dimension} getScreenSize () + +@end deftypemethod +@deftypemethod Toolkit {public abstract int} getScreenResolution () + +@end deftypemethod +@deftypemethod Toolkit {public abstract ColorModel} getColorModel () + +@end deftypemethod +@deftypemethod Toolkit {public abstract String} getFontList () + +@end deftypemethod +@deftypemethod Toolkit {public abstract FontMetrics} getFontMetrics (java.awt.Font@w{ }@var{font}) + +@end deftypemethod +@deftypemethod Toolkit {public abstract void} sync () + +@end deftypemethod +@deftypemethod Toolkit {public abstract Image} getImage (java.lang.String@w{ }@var{filename}) + +@end deftypemethod +@deftypemethod Toolkit {public abstract Image} getImage (java.net.URL@w{ }@var{url}) + +@end deftypemethod +@deftypemethod Toolkit {public abstract Image} createImage (java.lang.String@w{ }@var{filename}) + +@end deftypemethod +@deftypemethod Toolkit {public abstract Image} createImage (java.net.URL@w{ }@var{url}) + +@end deftypemethod +@deftypemethod Toolkit {public abstract boolean} prepareImage (java.awt.Image@w{ }@var{image}, int@w{ }@var{width}, int@w{ }@var{height}, java.awt.image.ImageObserver@w{ }@var{observer}) + +@end deftypemethod +@deftypemethod Toolkit {public abstract int} checkImage (java.awt.Image@w{ }@var{image}, int@w{ }@var{width}, int@w{ }@var{height}, java.awt.image.ImageObserver@w{ }@var{observer}) + +@end deftypemethod +@deftypemethod Toolkit {public abstract Image} createImage (java.awt.image.ImageProducer@w{ }@var{producer}) + +@end deftypemethod +@deftypemethod Toolkit {public Image} createImage (byte[]@w{ }@var{imagedata}) + +@end deftypemethod +@deftypemethod Toolkit {public abstract Image} createImage (byte[]@w{ }@var{imagedata}, int@w{ }@var{imageoffset}, int@w{ }@var{imagelength}) + +@end deftypemethod +@deftypemethod Toolkit {public abstract void} beep () + +@end deftypemethod +@deftypemethod Toolkit {public abstract Clipboard} getSystemClipboard () + +@end deftypemethod +@deftypemethod Toolkit {public int} getMenuShortcutKeyMask () + +@end deftypemethod +@deftypemethod Toolkit {public boolean} getLockingKeyState (int@w{ }@var{keyCode}) + +@end deftypemethod +@deftypemethod Toolkit {public void} setLockingKeyState (int@w{ }@var{keyCode}, boolean@w{ }@var{on}) + +@end deftypemethod +@deftypemethod Toolkit {protected static Container} getNativeContainer (java.awt.Component@w{ }@var{c}) + +@end deftypemethod +@deftypemethod Toolkit {public Cursor} createCustomCursor (java.awt.Image@w{ }@var{cursor}, java.awt.Point@w{ }@var{hotSpot}, java.lang.String@w{ }@var{name}) @*throws IndexOutOfBoundsException + +@end deftypemethod +@deftypemethod Toolkit {public Dimension} getBestCursorSize (int@w{ }@var{preferredWidth}, int@w{ }@var{preferredHeight}) + +@end deftypemethod +@deftypemethod Toolkit {public int} getMaximumCursorColors () + +@end deftypemethod +@deftypemethod Toolkit {public static String} getProperty (java.lang.String@w{ }@var{key}, java.lang.String@w{ }@var{defaultValue}) + +@end deftypemethod +@deftypemethod Toolkit {public final EventQueue} getSystemEventQueue () + +@end deftypemethod +@deftypemethod Toolkit {protected abstract EventQueue} getSystemEventQueueImpl () + +@end deftypemethod +@deftypemethod Toolkit {public final Object} getDesktopProperty (java.lang.String@w{ }@var{propertyName}) + +@end deftypemethod +@deftypemethod Toolkit {protected final void} setDesktopProperty (java.lang.String@w{ }@var{name}, java.lang.Object@w{ }@var{newValue}) + +@end deftypemethod +@deftypemethod Toolkit {protected Object} lazilyLoadDesktopProperty (java.lang.String@w{ }@var{name}) + +@end deftypemethod +@deftypemethod Toolkit {protected void} initializeDesktopProperties () + +@end deftypemethod +@deftypemethod Toolkit {public void} addPropertyChangeListener (java.lang.String@w{ }@var{name}, java.beans.PropertyChangeListener@w{ }@var{pcl}) + +@end deftypemethod +@deftypemethod Toolkit {public void} removePropertyChangeListener (java.lang.String@w{ }@var{name}, java.beans.PropertyChangeListener@w{ }@var{pcl}) + +@end deftypemethod +@deftypemethod Toolkit {public void} addAWTEventListener (java.awt.event.AWTEventListener@w{ }@var{listener}, long@w{ }@var{eventMask}) + +@end deftypemethod +@deftypemethod Toolkit {public void} removeAWTEventListener (java.awt.event.AWTEventListener@w{ }@var{listener}) + +@end deftypemethod +@deftypemethod Transparency {public int} getTransparency () + +@end deftypemethod +@deftypemethod Window {protected void} finalize () @*throws Throwable + +@end deftypemethod +@deftypemethod Window {public void} addNotify () + +@end deftypemethod +@deftypemethod Window {public void} pack () + +@end deftypemethod +@deftypemethod Window {public void} show () + +@end deftypemethod +@deftypemethod Window {public void} hide () + +@end deftypemethod +@deftypemethod Window {public void} dispose () + +@end deftypemethod +@deftypemethod Window {public void} toBack () + +@end deftypemethod +@deftypemethod Window {public void} toFront () + +@end deftypemethod +@deftypemethod Window {public Toolkit} getToolkit () + +@end deftypemethod +@deftypemethod Window {public final String} getWarningString () + +@end deftypemethod +@deftypemethod Window {public Locale} getLocale () + +@end deftypemethod +@deftypemethod Window {public void} setCursor (java.awt.Cursor@w{ }@var{cursor}) + +@end deftypemethod +@deftypemethod Window {public Window} getOwner () + +@end deftypemethod +@deftypemethod Window {public Window} getOwnedWindows () + +@end deftypemethod +@deftypemethod Window {public synchronized void} addWindowListener (java.awt.event.WindowListener@w{ }@var{listener}) + +@end deftypemethod +@deftypemethod Window {public synchronized void} removeWindowListener (java.awt.event.WindowListener@w{ }@var{listener}) + +@end deftypemethod +@deftypemethod Window {public EventListener} getListeners (java.lang.Class@w{ }@var{listenerType}) + +@end deftypemethod +@deftypemethod Window {protected void} processEvent (java.awt.AWTEvent@w{ }@var{evt}) + +@end deftypemethod +@deftypemethod Window {protected void} processWindowEvent (java.awt.event.WindowEvent@w{ }@var{evt}) + +@end deftypemethod +@deftypemethod Window {public Component} getFocusOwner () + +@end deftypemethod +@deftypemethod Window {public boolean} postEvent (java.awt.Event@w{ }@var{e}) + +@end deftypemethod +@deftypemethod Window {public boolean} isShowing () + +@end deftypemethod +@deftypemethod Window {public void} applyResourceBundle (java.util.ResourceBundle@w{ }@var{rb}) + +@end deftypemethod +@deftypemethod Window {public void} applyResourceBundle (java.lang.String@w{ }@var{rbName}) + +@end deftypemethod +@deftypemethod Window {public GraphicsConfiguration} getGraphicsConfiguration () +Get graphics configuration. The implementation for Window will + not ask any parent containers, since Window is a toplevel + window and not actually embedded in the parent component. +@end deftypemethod diff --git a/libjava/doc/java-beans-beancontext.texi b/libjava/doc/java-beans-beancontext.texi new file mode 100644 index 00000000000..f67328600aa --- /dev/null +++ b/libjava/doc/java-beans-beancontext.texi @@ -0,0 +1,543 @@ +@deftypemethod BeanContextChildComponentProxy {public Component} getComponent () +Get the @code{Component} associated with this @code{BeanContextChild}. +@end deftypemethod +@deftypemethod BeanContextChild {public void} setBeanContext (java.beans.beancontext.BeanContext@w{ }@var{parent}) @*throws PropertyVetoException +Set the parent @code{BeanContext}. + + + + + This method is called from @code{BeanContext.add()} and + should not be called directly. + + + + + When this Object is being added to a new BeanContext or moved + from an old one, a non-null value will be passed in. + + + + + When this Object is being removed from the current + @code{BeanContext}, @code{setBeanContext()} will + receive the parameter @code{null}. + + + + + When being removed from the current @code{BeanContext}, + it is the @code{BeanContextChild}'s responsibility to + release all services it has obtained. + + + + + This change should generate @code{PropertyChangeEvent} + and @code{VetoableChangeEvent}s with the property name + "beanContext". If the change is vetoed, it must re-throw the + exception and not change anything. In this way, the parent + @code{BeanContextChild}, who has registered himself with + you, will have a chance to remove this child from its + collection. + + + + + If the Bean does not wish to change the parent or be removed + from one, it may throw the @code{PropertyVetoException}. + If you veto a @code{setBeanContext(null)} call, then you + should try your hardest to remedy whatever problem is keeping + you from being removed from the @code{BeanContext} so + that you can <em>not</em> veto it the next time. + Otherwise, nasty pathological recursion stuff could occur in + certain situations. + + + + + If you do veto the change, you must first back out any changes + you made prior to the veto. Best not to make any such changes + prior to the veto in the first place. + + + + + This method is called from @code{BeanContext.add()} and + should not be called directly. +@end deftypemethod +@deftypemethod BeanContextChild {public BeanContext} getBeanContext () +Get the parent @code{BeanContext}. +@end deftypemethod +@deftypemethod BeanContextChild {public void} addPropertyChangeListener (java.lang.String@w{ }@var{prop}, java.beans.PropertyChangeListener@w{ }@var{listener}) +Add a listener that will be notified when a specific property changes. +@end deftypemethod +@deftypemethod BeanContextChild {public void} removePropertyChangeListener (java.lang.String@w{ }@var{prop}, java.beans.PropertyChangeListener@w{ }@var{listener}) +Remove a listener to a certain property. +@end deftypemethod +@deftypemethod BeanContextChild {public void} addVetoableChangeListener (java.lang.String@w{ }@var{prop}, java.beans.VetoableChangeListener@w{ }@var{listener}) +Add a listener that will be notified when a specific property + change is requested (a PropertyVetoException may be thrown) as + well as after the change is successfully made. +@end deftypemethod +@deftypemethod BeanContextChild {public void} removeVetoableChangeListener (java.lang.String@w{ }@var{prop}, java.beans.VetoableChangeListener@w{ }@var{listener}) +Remove a listener to a certain property. +@end deftypemethod +@deftypemethod BeanContextChildSupport {public void} setBeanContext (java.beans.beancontext.BeanContext@w{ }@var{newBeanContext}) @*throws PropertyVetoException +Set the parent @code{BeanContext}. + + + + + When this Object is being added to a new BeanContext or moved + from an old one, a non-null value will be passed in. + + + + + When this Object is being removed from the current + @code{BeanContext}, @code{setBeanContext()} will + receive the parameter @code{null}. + + + + + Order of events: + +@itemize @bullet + + +@item + + If the new @code{BeanContext} is the same as the old + one, nothing happens. + + + +@item + + If the change has not been rejected or vetoed before, call + @code{validatePendingSetBeanContext()}. If this call + returns @code{false}, the change is rejected and a + @code{PropertyVetoException} is thrown. + + + +@item + + If the change has not been rejected or vetoed before, + @code{VetoableChangeEvent}s are fired with the name + @code{"beanContext"}, using the + @code{fireVetoableChange()} method. If a veto + occurs, reversion events are fired using the same method, + the change is rejected, and the veto is rethrown. + + + +@item + + @code{releaseBeanContextResources()} is called. + + + +@item + + The change is made. + + + +@item + + @code{PropertyChangeEvent}s are fired using the + @code{firePropertyChange()} method. + + + +@item + + @code{initializeBeanContextResources()} is called. + + + +@end itemize + + + + +@end deftypemethod +@deftypemethod BeanContextChildSupport {public BeanContext} getBeanContext () +Get the parent @code{BeanContext}. +@end deftypemethod +@deftypemethod BeanContextChildSupport {public BeanContextChild} getBeanContextChildPeer () +Get the peer (or @code{this} if there is no peer). +@end deftypemethod +@deftypemethod BeanContextChildSupport {public boolean} isDelegated () +Determine whether there is a peer. + This is true iff @code{getBeanContextChildPeer() == this}. +@end deftypemethod +@deftypemethod BeanContextChildSupport {public void} addPropertyChangeListener (java.lang.String@w{ }@var{propertyName}, java.beans.PropertyChangeListener@w{ }@var{listener}) +Add a listener that will be notified when a specific property changes. +@end deftypemethod +@deftypemethod BeanContextChildSupport {public void} removePropertyChangeListener (java.lang.String@w{ }@var{propertyName}, java.beans.PropertyChangeListener@w{ }@var{listener}) +Remove a listener to a certain property. +@end deftypemethod +@deftypemethod BeanContextChildSupport {public void} addVetoableChangeListener (java.lang.String@w{ }@var{propertyName}, java.beans.VetoableChangeListener@w{ }@var{listener}) +Add a listener that will be notified when a specific property + change is requested (a PropertyVetoException may be thrown) as + well as after the change is successfully made. +@end deftypemethod +@deftypemethod BeanContextChildSupport {public void} removeVetoableChangeListener (java.lang.String@w{ }@var{propertyName}, java.beans.VetoableChangeListener@w{ }@var{listener}) +Remove a listener to a certain property. +@end deftypemethod +@deftypemethod BeanContextChildSupport {public void} firePropertyChange (java.lang.String@w{ }@var{propertyName}, java.lang.Object@w{ }@var{oldVal}, java.lang.Object@w{ }@var{newVal}) +Fire a property change. +@end deftypemethod +@deftypemethod BeanContextChildSupport {public void} fireVetoableChange (java.lang.String@w{ }@var{propertyName}, java.lang.Object@w{ }@var{oldVal}, java.lang.Object@w{ }@var{newVal}) @*throws PropertyVetoException +Fire a vetoable property change. +@end deftypemethod +@deftypemethod BeanContextChildSupport {public void} serviceRevoked (java.beans.beancontext.BeanContextServiceRevokedEvent@w{ }@var{event}) +Called by @code{BeanContextServices.revokeService()} to indicate that a service has been revoked. + If you have a reference to such a service, it should be + discarded and may no longer function properly. + @code{getService()} will no longer work on the specified + service class after this event has been fired. + + + + + <EM>This method is meant to be overriden.</EM> + @code{BeanContextChildSupport}'s implementation does + nothing. +@end deftypemethod +@deftypemethod BeanContextChildSupport {public void} serviceAvailable (java.beans.beancontext.BeanContextServiceAvailableEvent@w{ }@var{event}) +Called by @code{BeanContextServices} whenever a service is made available. + + + + + <EM>This method is meant to be overriden.</EM> + @code{BeanContextChildSupport}'s implementation does + nothing. +@end deftypemethod +@deftypemethod BeanContextChildSupport {public boolean} validatePendingSetBeanContext (java.beans.beancontext.BeanContext@w{ }@var{newBeanContext}) +Called by @code{setBeanContext()} to determine whether the set should be rejected. + + + + + <EM>This method is meant to be overriden.</EM> + @code{BeanContextChildSupport}'s implementation simply + returns @code{true}. +@end deftypemethod +@deftypemethod BeanContextChildSupport {protected void} releaseBeanContextResources () +Called by @code{setBeanContext()} to release resources of a what will soon no longer be the parent. + + + + + <EM>This method is meant to be overriden.</EM> + @code{BeanContextChildSupport}'s implementation does + nothing. +@end deftypemethod +@deftypemethod BeanContextChildSupport {protected void} initializeBeanContextResources () +Called by @code{setBeanContext()} to grab resources when the parent has been set. + + + + + <EM>This method is meant to be overriden.</EM> + @code{BeanContextChildSupport}'s implementation does + nothing. +@end deftypemethod +@deftypemethod BeanContextContainerProxy {public Container} getContainer () +Get the @code{Container} associated with this @code{BeanContext}. +@end deftypemethod +@deftypemethod BeanContextEvent {public BeanContext} getBeanContext () +Get the @code{BeanContext} that originated this event. +@end deftypemethod +@deftypemethod BeanContextEvent {public BeanContext} getPropagatedFrom () +Get the most recent propagator of this event. + If this value is @code{null}, you have received the event + straight from the source. +@end deftypemethod +@deftypemethod BeanContextEvent {public boolean} isPropagated () +Tell whether this event has been propagated. +@end deftypemethod +@deftypemethod BeanContextEvent {public void} setPropagatedFrom (java.beans.beancontext.BeanContext@w{ }@var{propagator}) +Set the most recent propagator of this event. +@end deftypemethod +@deftypemethod BeanContext {public Object} instantiateChild (java.lang.String@w{ }@var{beanName}) @*throws IOException, ClassNotFoundException +Instantiate a Bean using this Bean's @code{ClassLoader} + and this @code{BeanContext} as the parent. + + + + + This method exists mainly so that @code{BeanContext} + implementations can perform extra actions on Beans that are + created within them. +@end deftypemethod +@deftypemethod BeanContext {public URL} getResource (java.lang.String@w{ }@var{resourceName}, java.beans.beancontext.BeanContextChild@w{ }@var{requestor}) +Get a resource. The @code{BeanContext} will typically + call @code{ClassLoader.getResource()}, but may do it any + way it wants to. This allows a @code{BeanContext} to + have its own set of resources separate from the rest of the + system. + + + + + Beans should call this method on their parent rather than the + associated @code{ClassLoader} method. + + + + + I am assuming, but am not entirely sure, that if a + @code{BeanContext} cannot find a resource, its + responsibility is to call the @code{getResource} method + of its parent @code{BeanContext}. +@end deftypemethod +@deftypemethod BeanContext {public InputStream} getResourceAsStream (java.lang.String@w{ }@var{resourceName}, java.beans.beancontext.BeanContextChild@w{ }@var{requestor}) +Get a resource as a stream. The @code{BeanContext} will + typically call @code{ClassLoader.getResourceAsStream()}, + but may do it any way it wants to. This allows a + @code{BeanContext}'s children to have their own set of + resources separate from the rest of the system. + + + + + Beans should call this method on their parent rather than the + associated @code{ClassLoader} method. + + + + + I am assuming, but am not entirely sure, that if a + @code{BeanContext} cannot find a resource, its + responsibility is to call the @code{getResourceAsStream} + method of its parent @code{BeanContext}. +@end deftypemethod +@deftypemethod BeanContext {public void} addBeanContextMembershipListener (java.beans.beancontext.BeanContextMembershipListener@w{ }@var{listener}) +Add a listener on changes to the membership of this + @code{BeanContext} object. +@end deftypemethod +@deftypemethod BeanContext {public void} removeBeanContextMembershipListener (java.beans.beancontext.BeanContextMembershipListener@w{ }@var{listener}) +Remove a listener on changes to the membership of this + @code{BeanContext} object. +@end deftypemethod +@deftypemethod BeanContextMembershipEvent {public int} size () +The number of children removed or added. +@end deftypemethod +@deftypemethod BeanContextMembershipEvent {public Iterator} iterator () +An iterator that will step through all the children. +@end deftypemethod +@deftypemethod BeanContextMembershipEvent {public Object} toArray () +An array of the children. +@end deftypemethod +@deftypemethod BeanContextMembershipEvent {public boolean} contains (java.lang.Object@w{ }@var{child}) +Tell whether the @code{Object} is one of the children added or removed. +@end deftypemethod +@deftypemethod BeanContextMembershipListener {public void} childrenAdded (java.beans.beancontext.BeanContextMembershipEvent@w{ }@var{event}) +When beans are added to a @code{BeanContext}, + this method is called to fire the event. +@end deftypemethod +@deftypemethod BeanContextMembershipListener {public void} childrenRemoved (java.beans.beancontext.BeanContextMembershipEvent@w{ }@var{event}) +When beans are removed from a @code{BeanContext}, + this method is called to fire the event. +@end deftypemethod +@deftypemethod BeanContextProxy {public BeanContextChild} getBeanContextProxy () +Return the @code{BeanContextChild} associated with this + @code{Object}. +@end deftypemethod +@deftypemethod BeanContextServiceAvailableEvent {public Iterator} getCurrentServiceSelectors () +Get the current service selectors of the service class. + This is identical to @code{getSourceAsBeanContextServices().getCurrentServiceSelectors(getServiceClass())} +@end deftypemethod +@deftypemethod BeanContextServiceAvailableEvent {public Class} getServiceClass () +Get the newly available service class. +@end deftypemethod +@deftypemethod BeanContextServiceAvailableEvent {public BeanContextServices} getSourceAsBeanContextServices () +Get the @code{BeanContextServices} through which the new service is available. +@end deftypemethod +@deftypemethod BeanContextServiceProviderBeanInfo {public BeanInfo} getServicesBeanInfo () +Get @code{BeanInfo}s for all of the service classes of this @code{BeanInfoServiceProvider}. +@end deftypemethod +@deftypemethod BeanContextServiceProvider {public Object} getService (java.beans.beancontext.BeanContextServices@w{ }@var{services}, java.lang.Object@w{ }@var{requestor}, java.lang.Class@w{ }@var{serviceClass}, java.lang.Object@w{ }@var{serviceSelector}) +Get a service. + Called from @code{BeanContextServices.getService(). + + + + + If the requested service class is not available, or if this + @code{BeanContextServiceProvider} chooses not honor the + request for some reason, then this method will return + @code{null}. + + + + + This method may throw unchecked exceptions, so watch out. +@end deftypemethod +@deftypemethod BeanContextServiceProvider {public void} releaseService (java.beans.beancontext.BeanContextServices@w{ }@var{services}, java.lang.Object@w{ }@var{requestor}, java.lang.Object@w{ }@var{service}) +Release the service. + + + + + Called by @code{BeanContextServices.releaseService()}. + + + + + Most @code{BeanContextServiceProvider}s won't have to do + anything here. +@end deftypemethod +@deftypemethod BeanContextServiceProvider {public Iterator} getCurrentServiceSelectors (java.beans.beancontext.BeanContextServices@w{ }@var{services}, java.lang.Class@w{ }@var{serviceClass}) +Get a list of valid service selectors for the specified service class. + This method is called from + @code{BeanContextServices.getCurrentServiceSelectors()}. + + + + + If the specified service class does not have a finite number of + valid service selectors, it should return @code{null}. + If it takes a general @code{Integer} parameter, for + example, you may as well return @code{null} or the poor + soul who called this method will be iterating all day. + + + + + If it has no valid service selectors, it should still return an empty + @code{Iterator}. +@end deftypemethod +@deftypemethod BeanContextServiceRevokedEvent {public Class} getServiceClass () +Get the revoked service class. +@end deftypemethod +@deftypemethod BeanContextServiceRevokedEvent {public boolean} isServiceClass (java.lang.Class@w{ }@var{c}) +Tell whether the revoked service class is the same as the specified class. + Identical to @code{getServiceClass().equals(c)}. +@end deftypemethod +@deftypemethod BeanContextServiceRevokedEvent {public BeanContextServices} getSourceAsBeanContextServices () +Get the @code{BeanContextServices} through which the service was available. +@end deftypemethod +@deftypemethod BeanContextServiceRevokedEvent {public boolean} isCurrentServiceInvalidNow () +Tell whether current instances of the revoked service are usable or not. + This is determined by whether the service was revoked + immediately. +@end deftypemethod +@deftypemethod BeanContextServiceRevokedListener {public void} serviceRevoked (java.beans.beancontext.BeanContextServiceRevokedEvent@w{ }@var{event}) +Called by @code{BeanContextServices.revokeService()} to indicate that a service has been revoked. + If you have a reference to such a service, it should be + discarded and may no longer function properly. + @code{getService()} will no longer work on the specified + service class after this event has been fired. +@end deftypemethod +@deftypemethod BeanContextServices {public boolean} addService (java.lang.Class@w{ }@var{serviceClass}, java.beans.beancontext.BeanContextServiceProvider@w{ }@var{provider}) +Register a service to make it available to others. + This class may refuse to add the service based on whatever + information it can gather, including whether the service + provider is trusted. +@end deftypemethod +@deftypemethod BeanContextServices {public void} revokeService (java.lang.Class@w{ }@var{serviceClass}, java.beans.beancontext.BeanContextServiceProvider@w{ }@var{provider}, boolean@w{ }@var{revokeNow}) +Make it so that no one else can use this service. + + + + + If @code{revokeNow} is @code{false}, the only + effect of this method is to make all subsequent calls to + @code{getService()} on this service class fail. + + + + + If it is @code{true}, a message is also sent out to all + listeners on the service and all references to it are released. +@end deftypemethod +@deftypemethod BeanContextServices {public void} releaseService (java.beans.beancontext.BeanContextChild@w{ }@var{requestorChild}, java.lang.Object@w{ }@var{requestor}, java.lang.Object@w{ }@var{service}) +Release your copy of this service. + + + + + If all copies of the service's class have been relinquished by + the requestor, the @code{BeanContextServiceRevokedListener} + previously registered by @code{getService()} will be + unregistered. +@end deftypemethod +@deftypemethod BeanContextServices {public Object} getService (java.beans.beancontext.BeanContextChild@w{ }@var{requestorChild}, java.lang.Object@w{ }@var{requestor}, java.lang.Class@w{ }@var{serviceClass}, java.lang.Object@w{ }@var{serviceSelector}, java.beans.beancontext.BeanContextServiceRevokedListener@w{ }@var{listener}) +Get a service from this @code{BeanContextServices}. + + + + + The specified listener will be registered to receive a + revocation notice for the specified serviceClass. One + notification per service class per requestor object will be + sent. + + + + + The listener will be unregistered when all services that were + obtained by that requestor for that service class are released. + + + + + If the requested service class is not available, or if this + @code{BeanContextServices} object chooses not honor the + request because the service class has been revoked or for some + other reason, then this method will return @code{null}. + + + + + This method may throw unchecked exceptions, so watch out. +@end deftypemethod +@deftypemethod BeanContextServices {public Iterator} getCurrentServiceClasses () +Get a list of all service classes supported. + + + + + This method must synchronize on + @code{BeanContext.globalHierarchyLock}. +@end deftypemethod +@deftypemethod BeanContextServices {public Iterator} getCurrentServiceSelectors (java.lang.Class@w{ }@var{serviceClass}) +Get a list of valid service selectors for the specified service class. + + + + + If the specified service class does not have a finite number of + valid service selectors, it should return @code{null}. + If it takes a general @code{Integer} parameter, for + example, you may as well return @code{null} or the poor + soul who called this method will be iterating all day. + + + + + If it has no valid service selectors, it should still return an empty + @code{Iterator}. +@end deftypemethod +@deftypemethod BeanContextServices {public boolean} hasService (java.lang.Class@w{ }@var{serviceClass}) +Tell whether the specified service class is available. + Iff getService() could return a non-null value for the + specified service, this method will return @code{true}. +@end deftypemethod +@deftypemethod BeanContextServices {public void} addBeanContextServicesListener (java.beans.beancontext.BeanContextServicesListener@w{ }@var{listener}) +Add a listener on all adds and removes of services. +@end deftypemethod +@deftypemethod BeanContextServices {public void} removeBeanContextServicesListener (java.beans.beancontext.BeanContextServicesListener@w{ }@var{listener}) +Remove a listener on all adds and removes of services. +@end deftypemethod +@deftypemethod BeanContextServicesListener {public void} serviceAvailable (java.beans.beancontext.BeanContextServiceAvailableEvent@w{ }@var{event}) +Called by @code{BeanContextServices} whenever a service is made available. +@end deftypemethod diff --git a/libjava/doc/java-beans.texi b/libjava/doc/java-beans.texi new file mode 100644 index 00000000000..2b8887181ee --- /dev/null +++ b/libjava/doc/java-beans.texi @@ -0,0 +1,810 @@ +@deftypemethod BeanDescriptor {public Class} getBeanClass () +Get the Bean's class. +@end deftypemethod +@deftypemethod BeanDescriptor {public Class} getCustomizerClass () +Get the Bean's customizer's class. +@end deftypemethod +@deftypemethod BeanInfo {public BeanDescriptor} getBeanDescriptor () +Get the general description of this Bean type. +@end deftypemethod +@deftypemethod BeanInfo {public EventSetDescriptor} getEventSetDescriptors () +Get the events this Bean type fires. +@end deftypemethod +@deftypemethod BeanInfo {public int} getDefaultEventIndex () +Get the "default" event, basically the one a RAD tool + user is most likely to select. +@end deftypemethod +@deftypemethod BeanInfo {public PropertyDescriptor} getPropertyDescriptors () +Get the properties (get/set method pairs) this Bean + type supports. +@end deftypemethod +@deftypemethod BeanInfo {public int} getDefaultPropertyIndex () +Get the "default" property, basically the one a RAD + tool user is most likely to select. +@end deftypemethod +@deftypemethod BeanInfo {public MethodDescriptor} getMethodDescriptors () +Get the methods this Bean type supports. +@end deftypemethod +@deftypemethod BeanInfo {public BeanInfo} getAdditionalBeanInfo () +Get additional BeanInfos representing this Bean. + In this version of JavaBeans, this method is used so + that space and time can be saved by reading a BeanInfo + for each class in the hierarchy (super, super(super), + and so on). + + + + The order of precedence when two pieces of BeanInfo + conflict (such as two PropertyDescriptors that have + the same name), in order from highest precedence to + lowest, is: + +@itemize @bullet + + +@item +This BeanInfo object. + + +@item +@code{getAdditionalBeanInfo()[getAdditionalBeanInfo().length]} + + +@item + ... + + +@item +@code{getAdditionalBeanInfo()[1]} + + +@item +@code{getAdditionalBeanInfo()[0]} + + +@end itemize + + + + + <STRONG>Spec Note:</STRONG> It is possible that + returning @code{null} from this method could + stop Introspection in its tracks, but it is unclear + from the spec whether this is the case. +@end deftypemethod +@deftypemethod BeanInfo {public Image} getIcon (int@w{ }@var{iconType}) +Get a visual icon for this Bean. + A Bean does not have to support icons, and if it does + support icons, it does not have to support every single + type. Sun recommends that if you only support one + type, you support 16x16 color. Sun also notes that you + should try to use a type (like GIF) that allows for + transparent pixels, so that the background of the RAD + tool can show through. + + + + <STRONG>Spec Note:</STRONG> If you do not support the + type of icon that is being asked for, but you do + support another type, it is unclear whether you should + return the other type or not. I would presume not. +@end deftypemethod +@deftypemethod Beans {public static Object} instantiate (java.lang.ClassLoader@w{ }@var{cl}, java.lang.String@w{ }@var{beanName}) @*throws IOException, ClassNotFoundException +Allows you to instantiate a Bean. This method takes + a ClassLoader from which to read the Bean and the + name of the Bean. + + + + The Bean name should be a dotted name, like a class. + It can represent several things. Beans will search + for the Bean using the name like this: + + + +@itemize @bullet + + +@item +Searches for a serialized instance of the Bean + using getResource(), mangling the Bean name by + replacing the dots with slashes and appending .ser + (for example, gnu.beans.BlahDeBlah would cause + Beans to search for gnu/beans/BlahDeBlah.ser using + getResource()). + + +@item +Searches for the Bean class using the beanName, + and then instantiates it with the no-arg constructor. + At that point, if it is an Applet, it provides it + with AppletContext and AppletStub, and then calls + init(). + + +@end itemize + +@end deftypemethod +@deftypemethod Beans {public static Object} getInstanceOf (java.lang.Object@w{ }@var{bean}, java.lang.Class@w{ }@var{newClass}) +Get the Bean as a different class type. + This should be used instead of casting to get a new + type view of a Bean, because in the future there may + be new types of Bean, even Beans spanning multiple + Objects. +@end deftypemethod +@deftypemethod Beans {public static boolean} isInstanceOf (java.lang.Object@w{ }@var{bean}, java.lang.Class@w{ }@var{newBeanClass}) +Determine whether the Bean can be cast to a different + class type. + This should be used instead of instanceof to determine + a Bean's castability, because in the future there may + be new types of Bean, even Beans spanning multiple + Objects. +@end deftypemethod +@deftypemethod Beans {public static boolean} isGuiAvailable () +Find out whether the GUI is available to use. + Defaults to true. +@end deftypemethod +@deftypemethod Beans {public static boolean} isDesignTime () +Find out whether it is design time. Design time means + we are in a RAD tool. + Defaults to false. +@end deftypemethod +@deftypemethod Beans {public static void} setGuiAvailable (boolean@w{ }@var{guiAvailable}) @*throws SecurityException +Set whether the GUI is available to use. +@end deftypemethod +@deftypemethod Beans {public static void} setDesignTime (boolean@w{ }@var{designTime}) @*throws SecurityException +Set whether it is design time. Design time means we + are in a RAD tool. +@end deftypemethod +@deftypemethod Customizer {public void} setObject (java.lang.Object@w{ }@var{bean}) +Set the object to Customize. This will always be a + Bean that had a BeanDescriptor indicating this + Customizer. +@end deftypemethod +@deftypemethod Customizer {public void} addPropertyChangeListener (java.beans.PropertyChangeListener@w{ }@var{l}) +Add a PropertyChangeListener. +@end deftypemethod +@deftypemethod Customizer {public void} removePropertyChangeListener (java.beans.PropertyChangeListener@w{ }@var{l}) +Remove a PropertyChangeListener. +@end deftypemethod +@deftypemethod DesignMode {public void} setDesignTime (boolean@w{ }@var{designTime}) +The environment will call this method on your + @code{BeanContextChild} when it is registered in a parent + @code{BeanContext} or when behavior needs to switch from + design time to runtime behavior (or vice versa). + + + + + @code{BeanContext}s are required to fire + @code{PropertyChangeEvent}s when properties change. + @code{designTime} is a property, and therefore when you + implement @code{setDesignTime()}, you need to fire a + @code{PropertyChangeEvent} with the old value, the new + value and using @code{PROPERTYNAME} as the property name. +@end deftypemethod +@deftypemethod DesignMode {public boolean} isDesignTime () +This method should tell whether it is design time or runtime. +@end deftypemethod +@deftypemethod EventSetDescriptor {public Class} getListenerType () +Get the class that contains the event firing methods. +@end deftypemethod +@deftypemethod EventSetDescriptor {public Method} getListenerMethods () +Get the event firing methods. +@end deftypemethod +@deftypemethod EventSetDescriptor {public MethodDescriptor} getListenerMethodDescriptors () +Get the event firing methods as MethodDescriptors. +@end deftypemethod +@deftypemethod EventSetDescriptor {public Method} getAddListenerMethod () +Get the add listener method. +@end deftypemethod +@deftypemethod EventSetDescriptor {public Method} getRemoveListenerMethod () +Get the remove listener method. +@end deftypemethod +@deftypemethod EventSetDescriptor {public void} setUnicast (boolean@w{ }@var{unicast}) +Set whether or not multiple listeners may be added. +@end deftypemethod +@deftypemethod EventSetDescriptor {public boolean} isUnicast () +Get whether or not multiple listeners may be added. (Defaults to false.) +@end deftypemethod +@deftypemethod EventSetDescriptor {public void} setInDefaultEventSet (boolean@w{ }@var{inDefaultEventSet}) +Set whether or not this is in the default event set. +@end deftypemethod +@deftypemethod EventSetDescriptor {public boolean} isInDefaultEventSet () +Get whether or not this is in the default event set. (Defaults to true.) +@end deftypemethod +@deftypemethod FeatureDescriptor {public String} getName () +Get the programmatic name of this feature. +@end deftypemethod +@deftypemethod FeatureDescriptor {public void} setName (java.lang.String@w{ }@var{name}) +Set the programmatic name of this feature. +@end deftypemethod +@deftypemethod FeatureDescriptor {public String} getDisplayName () +Get the localized (display) name of this feature. +@end deftypemethod +@deftypemethod FeatureDescriptor {public void} setDisplayName (java.lang.String@w{ }@var{displayName}) +Set the localized (display) name of this feature. +@end deftypemethod +@deftypemethod FeatureDescriptor {public String} getShortDescription () +Get the localized short description for this feature. +@end deftypemethod +@deftypemethod FeatureDescriptor {public void} setShortDescription (java.lang.String@w{ }@var{shortDescription}) +Set the localized short description for this feature. +@end deftypemethod +@deftypemethod FeatureDescriptor {public boolean} isExpert () +Indicates whether this feature is for expert use only. +@end deftypemethod +@deftypemethod FeatureDescriptor {public void} setExpert (boolean@w{ }@var{expert}) +Set whether this feature is for expert use only. +@end deftypemethod +@deftypemethod FeatureDescriptor {public boolean} isHidden () +Indicates whether this feature is for use by tools only. + If it is for use by tools only, then it should not be displayed. +@end deftypemethod +@deftypemethod FeatureDescriptor {public void} setHidden (boolean@w{ }@var{hidden}) +Set whether this feature is for use by tools only. + If it is for use by tools only, then it should not be displayed. +@end deftypemethod +@deftypemethod FeatureDescriptor {public Object} getValue (java.lang.String@w{ }@var{name}) +Get an arbitrary value set with setValue(). +@end deftypemethod +@deftypemethod FeatureDescriptor {public void} setValue (java.lang.String@w{ }@var{name}, java.lang.Object@w{ }@var{value}) +Set an arbitrary string-value pair with this feature. +@end deftypemethod +@deftypemethod FeatureDescriptor {public Enumeration} attributeNames () +Get a list of the programmatic key names set with setValue(). +@end deftypemethod +@deftypemethod IndexedPropertyDescriptor {public Class} getIndexedPropertyType () + +@end deftypemethod +@deftypemethod IndexedPropertyDescriptor {public Method} getIndexedReadMethod () + +@end deftypemethod +@deftypemethod IndexedPropertyDescriptor {public Method} getIndexedWriteMethod () + +@end deftypemethod +@deftypemethod Introspector {public static BeanInfo} getBeanInfo (java.lang.Class@w{ }@var{beanClass}) @*throws IntrospectionException +Get the BeanInfo for class @code{beanClass}, + first by looking for explicit information, next by + using standard design patterns to determine + information about the class. +@end deftypemethod +@deftypemethod Introspector {public static BeanInfo} getBeanInfo (java.lang.Class@w{ }@var{beanClass}, java.lang.Class@w{ }@var{stopClass}) @*throws IntrospectionException +Get the BeanInfo for class @code{beanClass}, + first by looking for explicit information, next by + using standard design patterns to determine + information about the class. It crawls up the + inheritance tree until it hits @code{topClass}. +@end deftypemethod +@deftypemethod Introspector {public static String} getBeanInfoSearchPath () +Get the search path for BeanInfo classes. +@end deftypemethod +@deftypemethod Introspector {public static void} setBeanInfoSearchPath (java.lang.String[]@w{ }@var{beanInfoSearchPath}) +Set the search path for BeanInfo classes. +@end deftypemethod +@deftypemethod Introspector {public static String} decapitalize (java.lang.String@w{ }@var{name}) +A helper method to convert a name to standard Java + naming conventions: anything with two capitals as the + first two letters remains the same, otherwise the + first letter is decapitalized. URL = URL, I = i, + MyMethod = myMethod. +@end deftypemethod +@deftypemethod MethodDescriptor {public ParameterDescriptor} getParameterDescriptors () +Get the parameter descriptors from this method. + Since MethodDescriptor has no way of determining what + the parameter names were, this defaults to null. +@end deftypemethod +@deftypemethod MethodDescriptor {public Method} getMethod () +Get the method this MethodDescriptor represents. +@end deftypemethod +@deftypemethod PropertyChangeEvent {public String} getPropertyName () +Get the property name. +@end deftypemethod +@deftypemethod PropertyChangeEvent {public Object} getOldValue () +Get the property's old value. +@end deftypemethod +@deftypemethod PropertyChangeEvent {public Object} getNewValue () +Get the property's new value. +@end deftypemethod +@deftypemethod PropertyChangeEvent {public void} setPropagationId (java.lang.Object@w{ }@var{propagationId}) +Set the propagation ID. This is a way for the event + to be passed from hand to hand and retain a little + extra state. Right now it is unused, but it should + be propagated anyway so that future versions of + JavaBeans can use it, for God knows what. +@end deftypemethod +@deftypemethod PropertyChangeEvent {public Object} getPropagationId () +Get the propagation ID. +@end deftypemethod +@deftypemethod PropertyChangeListener {public void} propertyChange (java.beans.PropertyChangeEvent@w{ }@var{e}) +Fired after a Bean's property has changed. +@end deftypemethod +@deftypemethod PropertyChangeSupport {public void} addPropertyChangeListener (java.beans.PropertyChangeListener@w{ }@var{l}) +Adds a PropertyChangeListener to the list of listeners. + All property change events will be sent to this listener. + + + + + The listener add is not unique: that is, <em>n</em> adds with + the same listener will result in <em>n</em> events being sent + to that listener for every property change. + + + + + Adding a null listener will cause undefined behavior. +@end deftypemethod +@deftypemethod PropertyChangeSupport {public void} addPropertyChangeListener (java.lang.String@w{ }@var{propertyName}, java.beans.PropertyChangeListener@w{ }@var{l}) +Adds a PropertyChangeListener listening on the specified property. + Events will be sent to the listener for that particular property. + + + + + The listener add is not unique; that is, <em>n</em> adds on a + particular property for a particular listener will result in + <em>n</em> events being sent to that listener when that + property is changed. + + + + + The effect is cumulative, too; if you are registered to listen + to receive events on all property changes, and then you + register on a particular property, you will receive change + events for that property twice. + + + + + Adding a null listener will cause undefined behavior. +@end deftypemethod +@deftypemethod PropertyChangeSupport {public void} removePropertyChangeListener (java.beans.PropertyChangeListener@w{ }@var{l}) +Removes a PropertyChangeListener from the list of listeners. + If any specific properties are being listened on, they must + be deregistered by themselves; this will only remove the + general listener to all properties. + + + + + If @code{add()} has been called multiple times for a + particular listener, @code{remove()} will have to be + called the same number of times to deregister it. +@end deftypemethod +@deftypemethod PropertyChangeSupport {public void} removePropertyChangeListener (java.lang.String@w{ }@var{propertyName}, java.beans.PropertyChangeListener@w{ }@var{l}) +Removes a PropertyChangeListener from listening to a specific property. + + + + + If @code{add()} has been called multiple times for a + particular listener on a property, @code{remove()} will + have to be called the same number of times to deregister it. +@end deftypemethod +@deftypemethod PropertyChangeSupport {public void} firePropertyChange (java.beans.PropertyChangeEvent@w{ }@var{event}) +Fire a PropertyChangeEvent to all the listeners. +@end deftypemethod +@deftypemethod PropertyChangeSupport {public void} firePropertyChange (java.lang.String@w{ }@var{propertyName}, java.lang.Object@w{ }@var{oldVal}, java.lang.Object@w{ }@var{newVal}) +Fire a PropertyChangeEvent containing the old and new values of the property to all the listeners. +@end deftypemethod +@deftypemethod PropertyChangeSupport {public void} firePropertyChange (java.lang.String@w{ }@var{propertyName}, boolean@w{ }@var{oldVal}, boolean@w{ }@var{newVal}) +Fire a PropertyChangeEvent containing the old and new values of the property to all the listeners. +@end deftypemethod +@deftypemethod PropertyChangeSupport {public void} firePropertyChange (java.lang.String@w{ }@var{propertyName}, int@w{ }@var{oldVal}, int@w{ }@var{newVal}) +Fire a PropertyChangeEvent containing the old and new values of the property to all the listeners. +@end deftypemethod +@deftypemethod PropertyChangeSupport {public boolean} hasListeners (java.lang.String@w{ }@var{propertyName}) +Tell whether the specified property is being listened on or not. + This will only return @code{true} if there are listeners + on all properties or if there is a listener specifically on this + property. +@end deftypemethod +@deftypemethod PropertyDescriptor {public Class} getPropertyType () +Get the property type. + This is the type the get method returns and the set method + takes in. +@end deftypemethod +@deftypemethod PropertyDescriptor {public Method} getReadMethod () +Get the get method. Why they call it readMethod here and + get everywhere else is beyond me. +@end deftypemethod +@deftypemethod PropertyDescriptor {public Method} getWriteMethod () +Get the set method. Why they call it writeMethod here and + set everywhere else is beyond me. +@end deftypemethod +@deftypemethod PropertyDescriptor {public boolean} isBound () +Get whether the property is bound. Defaults to false. +@end deftypemethod +@deftypemethod PropertyDescriptor {public void} setBound (boolean@w{ }@var{bound}) +Set whether the property is bound. + As long as the the bean implements addPropertyChangeListener() and + removePropertyChangeListener(), setBound(true) may safely be called. + + + If these things are not true, then the behavior of the system + will be undefined. + + + + When a property is bound, its set method is required to fire the + @code{PropertyChangeListener.propertyChange())} event + after the value has changed. +@end deftypemethod +@deftypemethod PropertyDescriptor {public boolean} isConstrained () +Get whether the property is constrained. Defaults to false. +@end deftypemethod +@deftypemethod PropertyDescriptor {public void} setConstrained (boolean@w{ }@var{constrained}) +Set whether the property is constrained. + If the set method throws @code{java.beans.PropertyVetoException} + (or subclass thereof) and the bean implements addVetoableChangeListener() + and removeVetoableChangeListener(), then setConstrained(true) may safely + be called. Otherwise, the system behavior is undefined. + <B>Spec note:</B> given those strict parameters, it would be nice if it + got set automatically by detection, but oh well. + + + When a property is constrained, its set method is required to: + + + +@itemize @bullet + + +@item +Fire the @code{VetoableChangeListener.vetoableChange()} + event notifying others of the change and allowing them a chance to + say it is a bad thing. + + +@item +If any of the listeners throws a PropertyVetoException, then + it must fire another vetoableChange() event notifying the others + of a reversion to the old value (though, of course, the change + was never made). Then it rethrows the PropertyVetoException and + exits. + + +@item +If all has gone well to this point, the value may be changed. + + +@end itemize + +@end deftypemethod +@deftypemethod PropertyDescriptor {public Class} getPropertyEditorClass () +Get the PropertyEditor class. Defaults to null. +@end deftypemethod +@deftypemethod PropertyDescriptor {public void} setPropertyEditorClass (java.lang.Class@w{ }@var{propertyEditorClass}) +Set the PropertyEditor class. If the class does not implement + the PropertyEditor interface, you will likely get an exception + late in the game. +@end deftypemethod +@deftypemethod PropertyEditor {public void} setValue (java.lang.Object@w{ }@var{value}) +Called by the RAD tool to set the value of this property for the PropertyEditor. + If the property type is native, it should be wrapped in the appropriate + wrapper type. +@end deftypemethod +@deftypemethod PropertyEditor {public Object} getValue () +Accessor method to get the current value the PropertyEditor is working with. + If the property type is native, it will be wrapped in the appropriate + wrapper type. +@end deftypemethod +@deftypemethod PropertyEditor {public void} setAsText (java.lang.String@w{ }@var{text}) @*throws IllegalArgumentException +Set the value of this property using a String. + Whether or not this PropertyEditor is editing a String type, this converts + the String into the type of the PropertyEditor. +@end deftypemethod +@deftypemethod PropertyEditor {public String} getAsText () +Get the value of this property in String format. + Many times this can simply use Object.toString(). + + + Return null if you do not support getAsText()/setAsText(). + @code{setAsText(getAsText())} should be valid; i.e. the stuff you spit out in + getAsText() should be able to go into setAsText(). +@end deftypemethod +@deftypemethod PropertyEditor {public String} getTags () +Get a list of possible Strings which this property type can have. + The value of these will be used by the RAD tool to construct some sort + of list box or to check text box input, and the resulting String passed + to setAsText() should be one of these. Note, however, that like most things + with this mammoth, unwieldy interface, this is not guaranteed. Thus, you + must check the value in setAsText() anyway. +@end deftypemethod +@deftypemethod PropertyEditor {public boolean} isPaintable () +The RAD tool calls this to find out whether the PropertyEditor can paint itself. +@end deftypemethod +@deftypemethod PropertyEditor {public void} paintValue (java.awt.Graphics@w{ }@var{g}, java.awt.Rectangle@w{ }@var{bounds}) +The RAD tool calls this to paint the actual value of the property. + The Graphics context will have the same current font, color, etc. as the + parent Container. You may safely change the font, color, etc. and not + change them back. + + + This method should do a silent no-op if isPaintable() is false. +@end deftypemethod +@deftypemethod PropertyEditor {public boolean} supportsCustomEditor () +The RAD tool calls this to find out whether the PropertyEditor supports a custom component to edit and display itself. +@end deftypemethod +@deftypemethod PropertyEditor {public Component} getCustomEditor () +The RAD tool calls this to grab the component that can edit this type. + The component may be painted anywhere the RAD tool wants to paint it-- + even in its own window. + + + The component must hook up with the PropertyEditor and, whenever a + change to the value is made, fire a PropertyChangeEvent to the source. + + +@end deftypemethod +@deftypemethod PropertyEditor {public void} addPropertyChangeListener (java.beans.PropertyChangeListener@w{ }@var{listener}) +Adds a property change listener to this PropertyEditor. +@end deftypemethod +@deftypemethod PropertyEditor {public void} removePropertyChangeListener (java.beans.PropertyChangeListener@w{ }@var{listener}) +Removes a property change listener from this PropertyEditor. +@end deftypemethod +@deftypemethod PropertyEditor {public String} getJavaInitializationString () +Get a Java language-specific String which could be used to create an Object + of the specified type. Every PropertyEditor must support this. + + + The reason for this is that while most RAD tools will serialize the Beans + and deserialize them at runtime, some RAD tools will generate code that + creates the Beans. Examples of Java initialization strings would be: + + + +@itemize @bullet + + +@item +@code{2} + + +@item +@code{"I am a String"} + + +@item +@code{new MyObject(2, "String", new StringBuffer())} + + +@end itemize + +@end deftypemethod +@deftypemethod PropertyEditorManager {public static void} registerEditor (java.lang.Class@w{ }@var{editedClass}, java.lang.Class@w{ }@var{editorClass}) +Register an editor for a class. Replaces old editor + if there was one registered before. +@end deftypemethod +@deftypemethod PropertyEditorManager {public static PropertyEditor} findEditor (java.lang.Class@w{ }@var{editedClass}) +Returns a new instance of the property editor for the + specified class. +@end deftypemethod +@deftypemethod PropertyEditorManager {public static String} getEditorSearchPath () +Get the editor search path. + As a minor departure from the spec, the default value + for the editor search path is "gnu.java.beans.editors", + "sun.beans.editors". +@end deftypemethod +@deftypemethod PropertyEditorManager {public static void} setEditorSearchPath (java.lang.String[]@w{ }@var{editorSearchPath}) +Set the editor search path. +@end deftypemethod +@deftypemethod PropertyEditorSupport {public void} setValue (java.lang.Object@w{ }@var{val}) +Set the current value of the property. + <STRONG>Implementation Note</STRONG> Sun does not + state what exactly this version of the method does. + Thus, in this implementation, it sets the value, and + then if the old and new values are different, it + fires a property change event with no property name + and the old and new values. +@end deftypemethod +@deftypemethod PropertyEditorSupport {public Object} getValue () +Get the current value of the property. +@end deftypemethod +@deftypemethod PropertyEditorSupport {public boolean} isPaintable () +Get whether this object is paintable or not. +@end deftypemethod +@deftypemethod PropertyEditorSupport {public void} paintValue (java.awt.Graphics@w{ }@var{g}, java.awt.Rectangle@w{ }@var{r}) +Paint this object. This class does nothing in + this method. +@end deftypemethod +@deftypemethod PropertyEditorSupport {public String} getJavaInitializationString () +Get the Java initialization String for the current + value of the Object. This class returns gibberish or + null (though the spec does not say which). + + + <STRONG>Implementation Note:</STRONG> This class + returns the string "@$#^" to make sure the code will + be broken, so that you will know to override it when + you create your own property editor. +@end deftypemethod +@deftypemethod PropertyEditorSupport {public String} getAsText () +Get the value as text. + In this class, you cannot count on getAsText() doing + anything useful, although in this implementation I + do toString(). +@end deftypemethod +@deftypemethod PropertyEditorSupport {public void} setAsText (java.lang.String@w{ }@var{s}) @*throws IllegalArgumentException +Set the value as text. + In this class, you cannot count on setAsText() doing + anything useful across implementations. + <STRONG>Implementation Note:</STRONG> In this + implementation it checks if the String is "null", and + if it is, sets the value to null, otherwise it throws + an IllegalArgumentException. +@end deftypemethod +@deftypemethod PropertyEditorSupport {public String} getTags () +Returns a list of possible choices for the value. +@end deftypemethod +@deftypemethod PropertyEditorSupport {public Component} getCustomEditor () +Return a custom component to edit the value. +@end deftypemethod +@deftypemethod PropertyEditorSupport {public boolean} supportsCustomEditor () +Find out whether this property editor supports a + custom component to edit its value. +@end deftypemethod +@deftypemethod PropertyEditorSupport {public void} addPropertyChangeListener (java.beans.PropertyChangeListener@w{ }@var{l}) +Add a property change listener to this property editor. +@end deftypemethod +@deftypemethod PropertyEditorSupport {public void} removePropertyChangeListener (java.beans.PropertyChangeListener@w{ }@var{l}) +Remove a property change listener from this property editor. +@end deftypemethod +@deftypemethod PropertyEditorSupport {public void} firePropertyChange () +Notify people that we've changed, although we don't + tell them just how. The only thing I can think of to + send in the event is the new value (since the old value + is unavailable and there is no property name). + I confess I do not understand the point of this method. +@end deftypemethod +@deftypemethod PropertyVetoException {public PropertyChangeEvent} getPropertyChangeEvent () +Get the PropertyChange event that was vetoed. +@end deftypemethod +@deftypemethod SimpleBeanInfo {public BeanDescriptor} getBeanDescriptor () +Force Introspection of the general bean info. +@end deftypemethod +@deftypemethod SimpleBeanInfo {public EventSetDescriptor} getEventSetDescriptors () +Force Introspection of the events this Bean type + fires. +@end deftypemethod +@deftypemethod SimpleBeanInfo {public int} getDefaultEventIndex () +Say that there is no "default" event set. +@end deftypemethod +@deftypemethod SimpleBeanInfo {public PropertyDescriptor} getPropertyDescriptors () +Force Introspection of the Bean properties. +@end deftypemethod +@deftypemethod SimpleBeanInfo {public int} getDefaultPropertyIndex () +Say that there is no "default" property. +@end deftypemethod +@deftypemethod SimpleBeanInfo {public MethodDescriptor} getMethodDescriptors () +Force Introspection of the Bean's methods. +@end deftypemethod +@deftypemethod SimpleBeanInfo {public BeanInfo} getAdditionalBeanInfo () +Tell the Introspector to go look for other BeanInfo + itself. +@end deftypemethod +@deftypemethod SimpleBeanInfo {public Image} getIcon (int@w{ }@var{iconType}) +Say that this Bean has no icons. +@end deftypemethod +@deftypemethod SimpleBeanInfo {public Image} loadImage (java.lang.String@w{ }@var{location}) +Helper method to load an image using the Bean class + getResource() method on the BeanInfo class (using + getClass(), since you'll extend this class to get + the BeanInfo). Basically it's assumed that the Bean + and its BeanInfo are both loaded by the same + ClassLoader, generally a reasonable assumption. +@end deftypemethod +@deftypemethod VetoableChangeListener {public void} vetoableChange (java.beans.PropertyChangeEvent@w{ }@var{e}) @*throws PropertyVetoException +Fired before a Bean's property changes. +@end deftypemethod +@deftypemethod VetoableChangeSupport {public void} addVetoableChangeListener (java.beans.VetoableChangeListener@w{ }@var{l}) +Adds a VetoableChangeListener to the list of listeners. + All property change events will be sent to this listener. + + + + + The listener add is not unique: that is, <em>n</em> adds with + the same listener will result in <em>n</em> events being sent + to that listener for every property change. + + + + + Adding a null listener will cause undefined behavior. +@end deftypemethod +@deftypemethod VetoableChangeSupport {public void} addVetoableChangeListener (java.lang.String@w{ }@var{propertyName}, java.beans.VetoableChangeListener@w{ }@var{l}) +Adds a VetoableChangeListener listening on the specified property. + Events will be sent to the listener for that particular property. + + + + + The listener add is not unique; that is, <em>n</em> adds on a + particular property for a particular listener will result in + <em>n</em> events being sent to that listener when that + property is changed. + + + + + The effect is cumulative, too; if you are registered to listen + to receive events on all property changes, and then you + register on a particular property, you will receive change + events for that property twice. + + + + + Adding a null listener will cause undefined behavior. +@end deftypemethod +@deftypemethod VetoableChangeSupport {public void} removeVetoableChangeListener (java.beans.VetoableChangeListener@w{ }@var{l}) +Removes a VetoableChangeListener from the list of listeners. + If any specific properties are being listened on, they must + be deregistered by themselves; this will only remove the + general listener to all properties. + + + + + If @code{add()} has been called multiple times for a + particular listener, @code{remove()} will have to be + called the same number of times to deregister it. +@end deftypemethod +@deftypemethod VetoableChangeSupport {public void} removeVetoableChangeListener (java.lang.String@w{ }@var{propertyName}, java.beans.VetoableChangeListener@w{ }@var{l}) +Removes a VetoableChangeListener from listening to a specific property. + + + + + If @code{add()} has been called multiple times for a + particular listener on a property, @code{remove()} will + have to be called the same number of times to deregister it. +@end deftypemethod +@deftypemethod VetoableChangeSupport {public void} fireVetoableChange (java.beans.PropertyChangeEvent@w{ }@var{proposedChange}) @*throws PropertyVetoException +Fire a VetoableChangeEvent to all the listeners. + If any listener objects, a reversion event will be sent to + those listeners who received the initial event. +@end deftypemethod +@deftypemethod VetoableChangeSupport {public void} fireVetoableChange (java.lang.String@w{ }@var{propertyName}, java.lang.Object@w{ }@var{oldVal}, java.lang.Object@w{ }@var{newVal}) @*throws PropertyVetoException +Fire a VetoableChangeEvent containing the old and new values of the property to all the listeners. + If any listener objects, a reversion event will be sent to + those listeners who received the initial event. +@end deftypemethod +@deftypemethod VetoableChangeSupport {public void} fireVetoableChange (java.lang.String@w{ }@var{propertyName}, boolean@w{ }@var{oldVal}, boolean@w{ }@var{newVal}) @*throws PropertyVetoException +Fire a VetoableChangeEvent containing the old and new values of the property to all the listeners. + If any listener objects, a reversion event will be sent to + those listeners who received the initial event. +@end deftypemethod +@deftypemethod VetoableChangeSupport {public void} fireVetoableChange (java.lang.String@w{ }@var{propertyName}, int@w{ }@var{oldVal}, int@w{ }@var{newVal}) @*throws PropertyVetoException +Fire a VetoableChangeEvent containing the old and new values of the property to all the listeners. + If any listener objects, a reversion event will be sent to + those listeners who received the initial event. +@end deftypemethod +@deftypemethod VetoableChangeSupport {public boolean} hasListeners (java.lang.String@w{ }@var{propertyName}) +Tell whether the specified property is being listened on or not. + This will only return @code{true} if there are listeners + on all properties or if there is a listener specifically on this + property. +@end deftypemethod +@deftypemethod Visibility {public boolean} needsGui () +Tells whether the Bean can run without a GUI or not. +@end deftypemethod +@deftypemethod Visibility {public boolean} avoidingGui () +Tells whether Bean is trying not to use the GUI. + If needsGui() is true, this method should always return false. +@end deftypemethod +@deftypemethod Visibility {public void} dontUseGui () +Tells the Bean not to use GUI methods. + If needsGUI() is false, then after this method is called, + avoidingGui() should return true. +@end deftypemethod +@deftypemethod Visibility {public void} okToUseGui () +Tells the Bean it may use the GUI. + The Bean is not required to use the GUI in this case, it is + merely being <EM>permitted</EM> to use it. If needsGui() is + false, avoidingGui() may return true or false after this method + is called. +@end deftypemethod diff --git a/libjava/doc/java-io.texi b/libjava/doc/java-io.texi new file mode 100644 index 00000000000..753bf96639e --- /dev/null +++ b/libjava/doc/java-io.texi @@ -0,0 +1,2592 @@ +@deftypemethod BufferedInputStream {public synchronized int} available () @*throws IOException + +@end deftypemethod +@deftypemethod BufferedInputStream {public void} close () @*throws IOException + +@end deftypemethod +@deftypemethod BufferedInputStream {public synchronized void} mark (int@w{ }@var{readlimit}) + +@end deftypemethod +@deftypemethod BufferedInputStream {public boolean} markSupported () + +@end deftypemethod +@deftypemethod BufferedInputStream {public synchronized int} read () @*throws IOException + +@end deftypemethod +@deftypemethod BufferedInputStream {public synchronized int} read (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException + +@end deftypemethod +@deftypemethod BufferedInputStream {public synchronized void} reset () @*throws IOException + +@end deftypemethod +@deftypemethod BufferedInputStream {public synchronized long} skip (long@w{ }@var{n}) @*throws IOException + +@end deftypemethod +@deftypemethod BufferedOutputStream {public synchronized void} flush () @*throws IOException +This method causes any currently buffered bytes to be immediately + written to the underlying output stream. +@end deftypemethod +@deftypemethod BufferedOutputStream {public synchronized void} write (int@w{ }@var{b}) @*throws IOException +This method writes a single byte of data. This will be written to the + buffer instead of the underlying data source. However, if the buffer + is filled as a result of this write request, it will be flushed to the + underlying output stream. +@end deftypemethod +@deftypemethod BufferedOutputStream {public synchronized void} write (byte[]@w{ }@var{buf}, int@w{ }@var{offset}, int@w{ }@var{len}) @*throws IOException +This method writes @code{len} bytes from the byte array + @code{buf} starting at position @code{offset} in the buffer. + These bytes will be written to the internal buffer. However, if this + write operation fills the buffer, the buffer will be flushed to the + underlying output stream. +@end deftypemethod +@deftypemethod BufferedReader {public void} close () @*throws IOException +This method closes the stream +@end deftypemethod +@deftypemethod BufferedReader {public boolean} markSupported () +Returns @code{true} to indicate that this class supports mark/reset + functionality. +@end deftypemethod +@deftypemethod BufferedReader {public void} mark (int@w{ }@var{readLimit}) @*throws IOException +Mark a position in the input to which the stream can be + "reset" by calling the @code{reset()} method. The parameter + @code{readlimit} is the number of chars that can be read from the + stream after setting the mark before the mark becomes invalid. For + example, if @code{mark()} is called with a read limit of 10, then + when 11 chars of data are read from the stream before the + @code{reset()} method is called, then the mark is invalid and the + stream object instance is not required to remember the mark. + + + + Note that the number of chars that can be remembered by this method + can be greater than the size of the internal read buffer. It is also + not dependent on the subordinate stream supporting mark/reset + functionality. +@end deftypemethod +@deftypemethod BufferedReader {public void} reset () @*throws IOException +Reset the stream to the point where the @code{mark()} method + was called. Any chars that were read after the mark point was set will + be re-read during subsequent reads. + + + + This method will throw an IOException if the number of chars read from + the stream since the call to @code{mark()} exceeds the mark limit + passed when establishing the mark. +@end deftypemethod +@deftypemethod BufferedReader {public boolean} ready () @*throws IOException +This method determines whether or not a stream is ready to be read. If + This method returns @code{false} then this stream could (but is + not guaranteed to) block on the next read attempt. +@end deftypemethod +@deftypemethod BufferedReader {public int} read (char[]@w{ }@var{buf}, int@w{ }@var{offset}, int@w{ }@var{count}) @*throws IOException +This method read chars from a stream and stores them into a caller + supplied buffer. It starts storing the data at index @code{offset} into + the buffer and attempts to read @code{len} chars. This method can + return before reading the number of chars requested. The actual number + of chars read is returned as an int. A -1 is returned to indicate the + end of the stream. + + + + This method will block until some data can be read. +@end deftypemethod +@deftypemethod BufferedReader {public int} read () @*throws IOException + +@end deftypemethod +@deftypemethod BufferedReader {public String} readLine () @*throws IOException +This method reads a single line of text from the input stream, returning + it as a @code{String}. A line is terminated by "\n", a "\r", or + an "\r\n" sequence. The system dependent line separator is not used. + The line termination characters are not returned in the resulting + @code{String}. +@end deftypemethod +@deftypemethod BufferedReader {public long} skip (long@w{ }@var{count}) @*throws IOException +This method skips the specified number of chars in the stream. It + returns the actual number of chars skipped, which may be less than the + requested amount. + + + + This method first discards chars in the buffer, then calls the + @code{skip} method on the underlying stream to skip the remaining chars. +@end deftypemethod +@deftypemethod BufferedWriter {public void} close () @*throws IOException +This method flushes any remaining buffered chars then closes the + underlying output stream. Any further attempts to write to this stream + may throw an exception +@end deftypemethod +@deftypemethod BufferedWriter {public void} flush () @*throws IOException +This method causes any currently buffered chars to be immediately + written to the underlying output stream. +@end deftypemethod +@deftypemethod BufferedWriter {public void} newLine () @*throws IOException +This method writes out a system depedent line separator sequence. The + actual value written is detemined from the <xmp>line.separator</xmp> + system property. +@end deftypemethod +@deftypemethod BufferedWriter {public void} write (int@w{ }@var{oneChar}) @*throws IOException +This method writes a single char of data. This will be written to the + buffer instead of the underlying data source. However, if the buffer + is filled as a result of this write request, it will be flushed to the + underlying output stream. +@end deftypemethod +@deftypemethod BufferedWriter {public void} write (char[]@w{ }@var{buf}, int@w{ }@var{offset}, int@w{ }@var{len}) @*throws IOException +This method writes @code{len} chars from the char array + @code{buf} starting at position @code{offset} in the buffer. + These chars will be written to the internal buffer. However, if this + write operation fills the buffer, the buffer will be flushed to the + underlying output stream. +@end deftypemethod +@deftypemethod BufferedWriter {public void} write (java.lang.String@w{ }@var{str}, int@w{ }@var{offset}, int@w{ }@var{len}) @*throws IOException +This method writes @code{len} chars from the @code{String} + @code{str} starting at position @code{offset} in the string. + These chars will be written to the internal buffer. However, if this + write operation fills the buffer, the buffer will be flushed to the + underlying output stream. +@end deftypemethod +@deftypemethod ByteArrayInputStream {public synchronized int} available () + +@end deftypemethod +@deftypemethod ByteArrayInputStream {public synchronized void} mark (int@w{ }@var{readAheadLimit}) + +@end deftypemethod +@deftypemethod ByteArrayInputStream {public boolean} markSupported () + +@end deftypemethod +@deftypemethod ByteArrayInputStream {public synchronized int} read () + +@end deftypemethod +@deftypemethod ByteArrayInputStream {public synchronized int} read (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) + +@end deftypemethod +@deftypemethod ByteArrayInputStream {public synchronized void} reset () + +@end deftypemethod +@deftypemethod ByteArrayInputStream {public synchronized long} skip (long@w{ }@var{n}) + +@end deftypemethod +@deftypemethod ByteArrayOutputStream {public synchronized void} reset () +This method discards all of the bytes that have been written to + the internal buffer so far by setting the @code{count} + variable to 0. The internal buffer remains at its currently + allocated size. +@end deftypemethod +@deftypemethod ByteArrayOutputStream {public int} size () +This method returns the number of bytes that have been written to + the buffer so far. This is the same as the value of the protected + @code{count} variable. If the @code{reset} method is + called, then this value is reset as well. Note that this method does + not return the length of the internal buffer, but only the number + of bytes that have been written to it. +@end deftypemethod +@deftypemethod ByteArrayOutputStream {public synchronized byte} toByteArray () +This method returns a byte array containing the bytes that have been + written to this stream so far. This array is a copy of the valid + bytes in the internal buffer and its length is equal to the number of + valid bytes, not necessarily to the the length of the current + internal buffer. Note that since this method allocates a new array, + it should be used with caution when the internal buffer is very large. +@end deftypemethod +@deftypemethod ByteArrayOutputStream {public String} toString () +Returns the bytes in the internal array as a @code{String}. The + bytes in the buffer are converted to characters using the system default + encoding. There is an overloaded @code{toString()} method that + allows an application specified character encoding to be used. +@end deftypemethod +@deftypemethod ByteArrayOutputStream {public String} toString (java.lang.String@w{ }@var{enc}) @*throws UnsupportedEncodingException +Returns the bytes in the internal array as a @code{String}. The + bytes in the buffer are converted to characters using the specified + encoding. +@end deftypemethod +@deftypemethod ByteArrayOutputStream {public String} toString (int@w{ }@var{hibyte}) +This method returns the bytes in the internal array as a + @code{String}. It uses each byte in the array as the low + order eight bits of the Unicode character value and the passed in + parameter as the high eight bits. + + + + This method does not convert bytes to characters in the proper way and + so is deprecated in favor of the other overloaded @code{toString} + methods which use a true character encoding. +@end deftypemethod +@deftypemethod ByteArrayOutputStream {public synchronized void} write (int@w{ }@var{oneByte}) +This method writes the writes the specified byte into the internal + buffer. +@end deftypemethod +@deftypemethod ByteArrayOutputStream {public synchronized void} write (byte[]@w{ }@var{buffer}, int@w{ }@var{offset}, int@w{ }@var{add}) +This method writes @code{len} bytes from the passed in array + @code{buf} starting at index @code{offset} into the + internal buffer. +@end deftypemethod +@deftypemethod ByteArrayOutputStream {public synchronized void} writeTo (java.io.OutputStream@w{ }@var{out}) @*throws IOException +This method writes all the bytes that have been written to this stream + from the internal buffer to the specified @code{OutputStream}. +@end deftypemethod +@deftypemethod CharArrayReader {public void} close () + +@end deftypemethod +@deftypemethod CharArrayReader {public void} mark (int@w{ }@var{readAheadLimit}) + +@end deftypemethod +@deftypemethod CharArrayReader {public boolean} markSupported () + +@end deftypemethod +@deftypemethod CharArrayReader {public int} read () @*throws IOException + +@end deftypemethod +@deftypemethod CharArrayReader {public int} read (char[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException + +@end deftypemethod +@deftypemethod CharArrayReader {public boolean} ready () @*throws IOException + +@end deftypemethod +@deftypemethod CharArrayReader {public void} reset () @*throws IOException + +@end deftypemethod +@deftypemethod CharArrayReader {public long} skip (long@w{ }@var{n}) @*throws IOException + +@end deftypemethod +@deftypemethod CharArrayWriter {public void} close () + +@end deftypemethod +@deftypemethod CharArrayWriter {public void} flush () + +@end deftypemethod +@deftypemethod CharArrayWriter {public synchronized void} reset () + +@end deftypemethod +@deftypemethod CharArrayWriter {public int} size () + +@end deftypemethod +@deftypemethod CharArrayWriter {public char} toCharArray () + +@end deftypemethod +@deftypemethod CharArrayWriter {public String} toString () + +@end deftypemethod +@deftypemethod CharArrayWriter {public void} write (int@w{ }@var{oneChar}) + +@end deftypemethod +@deftypemethod CharArrayWriter {public void} write (char[]@w{ }@var{buffer}, int@w{ }@var{offset}, int@w{ }@var{len}) + +@end deftypemethod +@deftypemethod CharArrayWriter {public void} write (java.lang.String@w{ }@var{str}, int@w{ }@var{offset}, int@w{ }@var{len}) + +@end deftypemethod +@deftypemethod CharArrayWriter {public void} writeTo (java.io.Writer@w{ }@var{out}) @*throws IOException + +@end deftypemethod +@deftypemethod DataInput {public boolean} readBoolean () @*throws IOException + +@end deftypemethod +@deftypemethod DataInput {public byte} readByte () @*throws IOException + +@end deftypemethod +@deftypemethod DataInput {public char} readChar () @*throws IOException + +@end deftypemethod +@deftypemethod DataInput {public double} readDouble () @*throws IOException + +@end deftypemethod +@deftypemethod DataInput {public float} readFloat () @*throws IOException + +@end deftypemethod +@deftypemethod DataInput {public void} readFully (byte[]@w{ }@var{b}) @*throws IOException, NullPointerException + +@end deftypemethod +@deftypemethod DataInput {public void} readFully (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException, NullPointerException, IndexOutOfBoundsException + +@end deftypemethod +@deftypemethod DataInput {public int} readInt () @*throws IOException + +@end deftypemethod +@deftypemethod DataInput {public String} readLine () @*throws IOException + +@end deftypemethod +@deftypemethod DataInput {public long} readLong () @*throws IOException + +@end deftypemethod +@deftypemethod DataInput {public short} readShort () @*throws IOException + +@end deftypemethod +@deftypemethod DataInput {public int} readUnsignedByte () @*throws IOException + +@end deftypemethod +@deftypemethod DataInput {public int} readUnsignedShort () @*throws IOException + +@end deftypemethod +@deftypemethod DataInput {public String} readUTF () @*throws IOException + +@end deftypemethod +@deftypemethod DataInput {public int} skipBytes (int@w{ }@var{n}) @*throws IOException + +@end deftypemethod +@deftypemethod DataInputStream {public final int} read (byte[]@w{ }@var{b}) @*throws IOException +This method reads bytes from the underlying stream into the specified + byte array buffer. It will attempt to fill the buffer completely, but + may return a short count if there is insufficient data remaining to be + read to fill the buffer. +@end deftypemethod +@deftypemethod DataInputStream {public final int} read (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException +This method reads bytes from the underlying stream into the specified + byte array buffer. It will attempt to read @code{len} bytes and + will start storing them at position @code{off} into the buffer. + This method can return a short count if there is insufficient data + remaining to be read to complete the desired read length. +@end deftypemethod +@deftypemethod DataInputStream {public final boolean} readBoolean () @*throws IOException +This method reads a Java boolean value from an input stream. It does + so by reading a single byte of data. If that byte is zero, then the + value returned is @code{false}. If the byte is non-zero, then + the value returned is @code{true}. + + + + This method can read a @code{boolean} written by an object + implementing the @code{writeBoolean()} method in the + @code{DataOutput} interface. +@end deftypemethod +@deftypemethod DataInputStream {public final byte} readByte () @*throws IOException +This method reads a Java byte value from an input stream. The value + is in the range of -128 to 127. + + + + This method can read a @code{byte} written by an object + implementing the @code{writeByte()} method in the + @code{DataOutput} interface. +@end deftypemethod +@deftypemethod DataInputStream {public final char} readChar () @*throws IOException +This method reads a Java @code{char} value from an input stream. + It operates by reading two bytes from the stream and converting them to + a single 16-bit Java @code{char}. The two bytes are stored most + significant byte first (i.e., "big endian") regardless of the native + host byte ordering. + + + + As an example, if @code{byte1} and @code{byte2} + represent the first and second byte read from the stream + respectively, they will be transformed to a @code{char} in + the following manner: + + + + @code{(char)(((byte1 & 0xFF) << 8) | (byte2 & 0xFF)} + + + + This method can read a @code{char} written by an object + implementing the @code{writeChar()} method in the + @code{DataOutput} interface. +@end deftypemethod +@deftypemethod DataInputStream {public final double} readDouble () @*throws IOException +This method reads a Java double value from an input stream. It operates + by first reading a @code{long} value from the stream by calling the + @code{readLong()} method in this interface, then converts + that @code{long} to a @code{double} using the + @code{longBitsToDouble} method in the class + @code{java.lang.Double} + + + + This method can read a @code{double} written by an object + implementing the @code{writeDouble()} method in the + @code{DataOutput} interface. +@end deftypemethod +@deftypemethod DataInputStream {public final float} readFloat () @*throws IOException +This method reads a Java float value from an input stream. It + operates by first reading an @code{int} value from the + stream by calling the @code{readInt()} method in this + interface, then converts that @code{int} to a + @code{float} using the @code{intBitsToFloat} method + in the class @code{java.lang.Float} + + + + This method can read a @code{float} written by an object + implementing the * @code{writeFloat()} method in the + @code{DataOutput} interface. +@end deftypemethod +@deftypemethod DataInputStream {public final void} readFully (byte[]@w{ }@var{b}) @*throws IOException +This method reads raw bytes into the passed array until the array is + full. Note that this method blocks until the data is available and + throws an exception if there is not enough data left in the stream to + fill the buffer +@end deftypemethod +@deftypemethod DataInputStream {public final void} readFully (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException +This method reads raw bytes into the passed array + @code{buf} starting @code{offset} bytes into the + buffer. The number of bytes read will be exactly + @code{len} Note that this method blocks until the data is + available and * throws an exception if there is not enough data + left in the stream to read @code{len} bytes. +@end deftypemethod +@deftypemethod DataInputStream {public final int} readInt () @*throws IOException +This method reads a Java @code{int} value from an input + stream It operates by reading four bytes from the stream and + converting them to a single Java @code{int} The bytes are + stored most significant byte first (i.e., "big endian") + regardless of the native host byte ordering. + + + + As an example, if @code{byte1} through @code{byte4} + represent the first four bytes read from the stream, they will be + transformed to an @code{int} in the following manner: + + + + @code{(int)(((byte1 & 0xFF) << 24) + ((byte2 & 0xFF) << 16) + + ((byte3 & 0xFF) << 8) + (byte4 & 0xFF)))} + + + + The value returned is in the range of 0 to 65535. + + + + This method can read an @code{int} written by an object + implementing the @code{writeInt()} method in the + @code{DataOutput} interface. +@end deftypemethod +@deftypemethod DataInputStream {public final String} readLine () @*throws IOException +This method reads the next line of text data from an input + stream. It operates by reading bytes and converting those bytes + to @code{char} values by treating the byte read as the low + eight bits of the @code{char} and using 0 as the high eight + bits. Because of this, it does not support the full 16-bit + Unicode character set. + + + + The reading of bytes ends when either the end of file or a line + terminator is encountered. The bytes read are then returned as a + @code{String} A line terminator is a byte sequence + consisting of either @code{\r}, @code{\n} or + @code{\r\n}. These termination charaters are discarded and + are not returned as part of the string. + + + + This method can read data that was written by an object implementing the + @code{writeLine()} method in @code{DataOutput}. +@end deftypemethod +@deftypemethod DataInputStream {public final long} readLong () @*throws IOException +This method reads a Java long value from an input stream + It operates by reading eight bytes from the stream and converting them to + a single Java @code{long} The bytes are stored most + significant byte first (i.e., "big endian") regardless of the native + host byte ordering. + + + + As an example, if @code{byte1} through @code{byte8} + represent the first eight bytes read from the stream, they will + be transformed to an @code{long} in the following manner: + + + + @code{(long)((((long)byte1 & 0xFF) << 56) + (((long)byte2 & 0xFF) << 48) + + (((long)byte3 & 0xFF) << 40) + (((long)byte4 & 0xFF) << 32) + + (((long)byte5 & 0xFF) << 24) + (((long)byte6 & 0xFF) << 16) + + (((long)byte7 & 0xFF) << 8) + ((long)byte9 & 0xFF)))} + + + + The value returned is in the range of 0 to 65535. + + + + This method can read an @code{long} written by an object + implementing the @code{writeLong()} method in the + @code{DataOutput} interface. +@end deftypemethod +@deftypemethod DataInputStream {public final short} readShort () @*throws IOException +This method reads a signed 16-bit value into a Java in from the + stream. It operates by reading two bytes from the stream and + converting them to a single 16-bit Java @code{short}. The + two bytes are stored most significant byte first (i.e., "big + endian") regardless of the native host byte ordering. + + + + As an example, if @code{byte1} and @code{byte2} + represent the first and second byte read from the stream + respectively, they will be transformed to a @code{short}. in + the following manner: + + + + @code{(short)(((byte1 & 0xFF) << 8) | (byte2 & 0xFF)} + + + + The value returned is in the range of -32768 to 32767. + + + + This method can read a @code{short} written by an object + implementing the @code{writeShort()} method in the + @code{DataOutput} interface. +@end deftypemethod +@deftypemethod DataInputStream {public final int} readUnsignedByte () @*throws IOException +This method reads 8 unsigned bits into a Java @code{int} + value from the stream. The value returned is in the range of 0 to + 255. + + + + This method can read an unsigned byte written by an object + implementing the @code{writeUnsignedByte()} method in the + @code{DataOutput} interface. +@end deftypemethod +@deftypemethod DataInputStream {public final int} readUnsignedShort () @*throws IOException +This method reads 16 unsigned bits into a Java int value from the stream. + It operates by reading two bytes from the stream and converting them to + a single Java @code{int} The two bytes are stored most + significant byte first (i.e., "big endian") regardless of the native + host byte ordering. + + + + As an example, if @code{byte1} and @code{byte2} + represent the first and second byte read from the stream + respectively, they will be transformed to an @code{int} in + the following manner: + + + + @code{(int)(((byte1 & 0xFF) << 8) + (byte2 & 0xFF))} + + + + The value returned is in the range of 0 to 65535. + + + + This method can read an unsigned short written by an object + implementing the @code{writeUnsignedShort()} method in the + @code{DataOutput} interface. +@end deftypemethod +@deftypemethod DataInputStream {public final String} readUTF () @*throws IOException +This method reads a @code{String} from an input stream that + is encoded in a modified UTF-8 format. This format has a leading + two byte sequence that contains the remaining number of bytes to + read. This two byte sequence is read using the + @code{readUnsignedShort()} method of this interface. + + + + After the number of remaining bytes have been determined, these + bytes are read an transformed into @code{char} values. + These @code{char} values are encoded in the stream using + either a one, two, or three byte format. The particular format + in use can be determined by examining the first byte read. + + + + If the first byte has a high order bit of 0, then that character + consists on only one byte. This character value consists of + seven bits that are at positions 0 through 6 of the byte. As an + example, if @code{byte1} is the byte read from the stream, + it would be converted to a @code{char} like so: + + + + @code{(char)byte1} + + + + If the first byte has 110 as its high order bits, then the + character consists of two bytes. The bits that make up the character + value are in positions 0 through 4 of the first byte and bit positions + 0 through 5 of the second byte. (The second byte should have + 10 as its high order bits). These values are in most significant + byte first (i.e., "big endian") order. + + + + As an example, if @code{byte1} and @code{byte2} are + the first two bytes read respectively, and the high order bits of + them match the patterns which indicate a two byte character + encoding, then they would be converted to a Java + @code{char} like so: + + + + @code{(char)(((byte1 & 0x1F) << 6) | (byte2 & 0x3F))} + + + + If the first byte has a 1110 as its high order bits, then the + character consists of three bytes. The bits that make up the character + value are in positions 0 through 3 of the first byte and bit positions + 0 through 5 of the other two bytes. (The second and third bytes should + have 10 as their high order bits). These values are in most + significant byte first (i.e., "big endian") order. + + + + As an example, if @code{byte1} @code{byte2} and + @code{byte3} are the three bytes read, and the high order + bits of them match the patterns which indicate a three byte + character encoding, then they would be converted to a Java + @code{char} like so: + + + + @code{(char)(((byte1 & 0x0F) << 12) | ((byte2 & 0x3F) << 6) | (byte3 & 0x3F))} + + + + Note that all characters are encoded in the method that requires + the fewest number of bytes with the exception of the character + with the value of @code{\u0000} which is encoded as two + bytes. This is a modification of the UTF standard used to + prevent C language style @code{NUL} values from appearing + in the byte stream. + + + + This method can read data that was written by an object implementing the + @code{writeUTF()} method in @code{DataOutput} +@end deftypemethod +@deftypemethod DataInputStream {public static final String} readUTF (java.io.DataInput@w{ }@var{in}) @*throws IOException +This method reads a String encoded in UTF-8 format from the + specified @code{DataInput} source. +@end deftypemethod +@deftypemethod DataInputStream {public final int} skipBytes (int@w{ }@var{n}) @*throws IOException +This method attempts to skip and discard the specified number of bytes + in the input stream. It may actually skip fewer bytes than requested. + This method will not skip any bytes if passed a negative number of bytes + to skip. +@end deftypemethod +@deftypemethod DataOutput {public void} write (int@w{ }@var{b}) @*throws IOException + +@end deftypemethod +@deftypemethod DataOutput {public void} write (byte[]@w{ }@var{b}) @*throws IOException, NullPointerException + +@end deftypemethod +@deftypemethod DataOutput {public void} write (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException, NullPointerException, IndexOutOfBoundsException + +@end deftypemethod +@deftypemethod DataOutput {public void} writeBoolean (boolean@w{ }@var{v}) @*throws IOException + +@end deftypemethod +@deftypemethod DataOutput {public void} writeByte (int@w{ }@var{v}) @*throws IOException + +@end deftypemethod +@deftypemethod DataOutput {public void} writeShort (int@w{ }@var{v}) @*throws IOException + +@end deftypemethod +@deftypemethod DataOutput {public void} writeChar (int@w{ }@var{v}) @*throws IOException + +@end deftypemethod +@deftypemethod DataOutput {public void} writeInt (int@w{ }@var{v}) @*throws IOException + +@end deftypemethod +@deftypemethod DataOutput {public void} writeLong (long@w{ }@var{v}) @*throws IOException + +@end deftypemethod +@deftypemethod DataOutput {public void} writeFloat (float@w{ }@var{v}) @*throws IOException + +@end deftypemethod +@deftypemethod DataOutput {public void} writeDouble (double@w{ }@var{v}) @*throws IOException + +@end deftypemethod +@deftypemethod DataOutput {public void} writeBytes (java.lang.String@w{ }@var{s}) @*throws IOException, NullPointerException + +@end deftypemethod +@deftypemethod DataOutput {public void} writeChars (java.lang.String@w{ }@var{s}) @*throws IOException, NullPointerException + +@end deftypemethod +@deftypemethod DataOutput {public void} writeUTF (java.lang.String@w{ }@var{s}) @*throws IOException, NullPointerException + +@end deftypemethod +@deftypemethod DataOutputStream {public void} flush () @*throws IOException + +@end deftypemethod +@deftypemethod DataOutputStream {public final int} size () + +@end deftypemethod +@deftypemethod DataOutputStream {public synchronized void} write (int@w{ }@var{b}) @*throws IOException + +@end deftypemethod +@deftypemethod DataOutputStream {public synchronized void} write (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException, NullPointerException, IndexOutOfBoundsException + +@end deftypemethod +@deftypemethod DataOutputStream {public final void} writeBoolean (boolean@w{ }@var{v}) @*throws IOException + +@end deftypemethod +@deftypemethod DataOutputStream {public final void} writeByte (int@w{ }@var{v}) @*throws IOException + +@end deftypemethod +@deftypemethod DataOutputStream {public final void} writeShort (int@w{ }@var{v}) @*throws IOException + +@end deftypemethod +@deftypemethod DataOutputStream {public final void} writeChar (int@w{ }@var{v}) @*throws IOException + +@end deftypemethod +@deftypemethod DataOutputStream {public final void} writeInt (int@w{ }@var{v}) @*throws IOException + +@end deftypemethod +@deftypemethod DataOutputStream {public final void} writeLong (long@w{ }@var{v}) @*throws IOException + +@end deftypemethod +@deftypemethod DataOutputStream {public final void} writeFloat (float@w{ }@var{v}) @*throws IOException + +@end deftypemethod +@deftypemethod DataOutputStream {public final void} writeDouble (double@w{ }@var{v}) @*throws IOException + +@end deftypemethod +@deftypemethod DataOutputStream {public final void} writeBytes (java.lang.String@w{ }@var{s}) @*throws IOException + +@end deftypemethod +@deftypemethod DataOutputStream {public final void} writeChars (java.lang.String@w{ }@var{s}) @*throws IOException + +@end deftypemethod +@deftypemethod DataOutputStream {public final void} writeUTF (java.lang.String@w{ }@var{s}) @*throws IOException + +@end deftypemethod +@deftypemethod Externalizable {public void} readExternal (java.io.ObjectInput@w{ }@var{in}) @*throws ClassNotFoundException, IOException +This method restores an object's state by reading in the instance data + for the object from the passed in stream. Note that this stream is not + a subclass of @code{InputStream}, but rather is a class that implements + the @code{ObjectInput} interface. That interface provides a mechanism for + reading in Java data types from a stream. + + + + Note that this method must be compatible with @code{writeExternal}. + It must read back the exact same types that were written by that + method in the exact order they were written. + + + + If this method needs to read back an object instance, then the class + for that object must be found and loaded. If that operation fails, + then this method throws a @code{ClassNotFoundException} +@end deftypemethod +@deftypemethod Externalizable {public void} writeExternal (java.io.ObjectOutput@w{ }@var{out}) @*throws IOException +This method is responsible for writing the instance data of an object + to the passed in stream. Note that this stream is not a subclass of + @code{OutputStream}, but rather is a class that implements the + @code{ObjectOutput} interface. That interface provides a number of methods + for writing Java data values to a stream. + + + + Not that the implementation of this method must be coordinated with + the implementation of @code{readExternal}. +@end deftypemethod +@deftypemethod FileDescriptor {public native void} sync () @*throws SyncFailedException + +@end deftypemethod +@deftypemethod FileDescriptor {public native boolean} valid () + +@end deftypemethod +@deftypemethod FileDescriptor {protected void} finalize () @*throws IOException + +@end deftypemethod +@deftypemethod FileFilter {public boolean} accept (java.io.File@w{ }@var{pathname}) +This method determines whether or not a given pathname should be included + in a pathname listing. +@end deftypemethod +@deftypemethod FileInputStream {public int} available () @*throws IOException + +@end deftypemethod +@deftypemethod FileInputStream {public void} close () @*throws IOException + +@end deftypemethod +@deftypemethod FileInputStream {protected void} finalize () @*throws IOException + +@end deftypemethod +@deftypemethod FileInputStream {public final FileDescriptor} getFD () @*throws IOException + +@end deftypemethod +@deftypemethod FileInputStream {public int} read () @*throws IOException + +@end deftypemethod +@deftypemethod FileInputStream {public int} read (byte[]@w{ }@var{b}) @*throws IOException + +@end deftypemethod +@deftypemethod FileInputStream {public int} read (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException + +@end deftypemethod +@deftypemethod FileInputStream {public long} skip (long@w{ }@var{n}) @*throws IOException + +@end deftypemethod +@deftypemethod File {public boolean} canRead () + +@end deftypemethod +@deftypemethod File {public boolean} canWrite () + +@end deftypemethod +@deftypemethod File {public boolean} delete () + +@end deftypemethod +@deftypemethod File {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod File {public boolean} exists () + +@end deftypemethod +@deftypemethod File {public String} getAbsolutePath () + +@end deftypemethod +@deftypemethod File {public native String} getCanonicalPath () @*throws IOException + +@end deftypemethod +@deftypemethod File {public String} getName () + +@end deftypemethod +@deftypemethod File {public String} getParent () + +@end deftypemethod +@deftypemethod File {public File} getParentFile () + +@end deftypemethod +@deftypemethod File {public String} getPath () + +@end deftypemethod +@deftypemethod File {public int} hashCode () + +@end deftypemethod +@deftypemethod File {public native boolean} isAbsolute () + +@end deftypemethod +@deftypemethod File {public boolean} isDirectory () + +@end deftypemethod +@deftypemethod File {public boolean} isFile () + +@end deftypemethod +@deftypemethod File {public long} lastModified () + +@end deftypemethod +@deftypemethod File {public long} length () + +@end deftypemethod +@deftypemethod File {public String} list (java.io.FilenameFilter@w{ }@var{filter}) + +@end deftypemethod +@deftypemethod File {public String} list () + +@end deftypemethod +@deftypemethod File {public String} toString () + +@end deftypemethod +@deftypemethod File {public boolean} mkdir () + +@end deftypemethod +@deftypemethod File {public boolean} mkdirs () + +@end deftypemethod +@deftypemethod File {public static File} createTempFile (java.lang.String@w{ }@var{prefix}, java.lang.String@w{ }@var{suffix}, java.io.File@w{ }@var{directory}) @*throws IOException + +@end deftypemethod +@deftypemethod File {public static File} createTempFile (java.lang.String@w{ }@var{prefix}, java.lang.String@w{ }@var{suffix}) @*throws IOException + +@end deftypemethod +@deftypemethod File {public boolean} renameTo (java.io.File@w{ }@var{dest}) + +@end deftypemethod +@deftypemethod File {public void} deleteOnExit () + +@end deftypemethod +@deftypemethod FilenameFilter {public boolean} accept (java.io.File@w{ }@var{dir}, java.lang.String@w{ }@var{name}) + +@end deftypemethod +@deftypemethod FileOutputStream {protected void} finalize () @*throws IOException + +@end deftypemethod +@deftypemethod FileOutputStream {public final FileDescriptor} getFD () @*throws IOException + +@end deftypemethod +@deftypemethod FileOutputStream {public void} write (int@w{ }@var{b}) @*throws IOException + +@end deftypemethod +@deftypemethod FileOutputStream {public void} write (byte[]@w{ }@var{b}) @*throws IOException, NullPointerException + +@end deftypemethod +@deftypemethod FileOutputStream {public void} write (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException, NullPointerException, IndexOutOfBoundsException + +@end deftypemethod +@deftypemethod FileOutputStream {public void} close () @*throws IOException + +@end deftypemethod +@deftypemethod FilePermission {public String} getActions () +Get the actions this FilePermission supports. +@end deftypemethod +@deftypemethod FilePermission {public int} hashCode () +Get the hash code for this Object. + + + FilePermission's hash code is calculated as the exclusive or of the target + String's hash code and the action String's hash code. +@end deftypemethod +@deftypemethod FilePermission {public boolean} equals (java.lang.Object@w{ }@var{o}) +Check two FilePermissions for semantic equality. + Two FilePermissions are exactly equivalent if they have identical path + expressions and have exactly the same access permissions. +@end deftypemethod +@deftypemethod FilePermission {public boolean} implies (java.security.Permission@w{ }@var{p}) +Check to see if this permission implies another. + Permission A implies permission B if these things are all true: + +@itemize @bullet + + +@item +A and B are both FilePermissions. + + +@item +All possible files in B are included in A (possibly more are in A). + + +@item +All actions B supports, A also supports. + + +@end itemize + +@end deftypemethod +@deftypemethod FilterInputStream {public int} available () @*throws IOException + +@end deftypemethod +@deftypemethod FilterInputStream {public void} close () @*throws IOException + +@end deftypemethod +@deftypemethod FilterInputStream {public synchronized void} mark (int@w{ }@var{readlimit}) + +@end deftypemethod +@deftypemethod FilterInputStream {public boolean} markSupported () + +@end deftypemethod +@deftypemethod FilterInputStream {public int} read () @*throws IOException + +@end deftypemethod +@deftypemethod FilterInputStream {public int} read (byte[]@w{ }@var{b}) @*throws IOException + +@end deftypemethod +@deftypemethod FilterInputStream {public int} read (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException + +@end deftypemethod +@deftypemethod FilterInputStream {public synchronized void} reset () @*throws IOException + +@end deftypemethod +@deftypemethod FilterInputStream {public long} skip (long@w{ }@var{n}) @*throws IOException + +@end deftypemethod +@deftypemethod FilterOutputStream {public void} close () @*throws IOException + +@end deftypemethod +@deftypemethod FilterOutputStream {public void} flush () @*throws IOException + +@end deftypemethod +@deftypemethod FilterOutputStream {public void} write (int@w{ }@var{b}) @*throws IOException + +@end deftypemethod +@deftypemethod FilterOutputStream {public void} write (byte[]@w{ }@var{b}) @*throws IOException, NullPointerException + +@end deftypemethod +@deftypemethod FilterOutputStream {public void} write (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException, NullPointerException, IndexOutOfBoundsException + +@end deftypemethod +@deftypemethod FilterReader {public void} close () @*throws IOException + +@end deftypemethod +@deftypemethod FilterReader {public synchronized void} mark (int@w{ }@var{readlimit}) @*throws IOException + +@end deftypemethod +@deftypemethod FilterReader {public boolean} markSupported () + +@end deftypemethod +@deftypemethod FilterReader {public int} read () @*throws IOException + +@end deftypemethod +@deftypemethod FilterReader {public int} read (char[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException + +@end deftypemethod +@deftypemethod FilterReader {public boolean} ready () @*throws IOException + +@end deftypemethod +@deftypemethod FilterReader {public synchronized void} reset () @*throws IOException + +@end deftypemethod +@deftypemethod FilterReader {public long} skip (long@w{ }@var{n}) @*throws IOException + +@end deftypemethod +@deftypemethod FilterWriter {public void} close () @*throws IOException + +@end deftypemethod +@deftypemethod FilterWriter {public void} flush () @*throws IOException + +@end deftypemethod +@deftypemethod FilterWriter {public void} write (int@w{ }@var{oneChar}) @*throws IOException + +@end deftypemethod +@deftypemethod FilterWriter {public void} write (char[]@w{ }@var{buffer}, int@w{ }@var{offset}, int@w{ }@var{count}) @*throws IOException + +@end deftypemethod +@deftypemethod FilterWriter {public void} write (java.lang.String@w{ }@var{str}, int@w{ }@var{offset}, int@w{ }@var{count}) @*throws IOException + +@end deftypemethod +@deftypemethod InputStream {public int} available () @*throws IOException + +@end deftypemethod +@deftypemethod InputStream {public void} close () @*throws IOException + +@end deftypemethod +@deftypemethod InputStream {public void} mark (int@w{ }@var{readlimit}) + +@end deftypemethod +@deftypemethod InputStream {public boolean} markSupported () + +@end deftypemethod +@deftypemethod InputStream {public abstract int} read () @*throws IOException + +@end deftypemethod +@deftypemethod InputStream {public int} read (byte[]@w{ }@var{b}) @*throws IOException + +@end deftypemethod +@deftypemethod InputStream {public int} read (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException + +@end deftypemethod +@deftypemethod InputStream {public void} reset () @*throws IOException + +@end deftypemethod +@deftypemethod InputStream {public long} skip (long@w{ }@var{n}) @*throws IOException + +@end deftypemethod +@deftypemethod InputStreamReader {public void} close () @*throws IOException + +@end deftypemethod +@deftypemethod InputStreamReader {public String} getEncoding () + +@end deftypemethod +@deftypemethod InputStreamReader {public boolean} ready () @*throws IOException + +@end deftypemethod +@deftypemethod InputStreamReader {public int} read (char[]@w{ }@var{buf}, int@w{ }@var{offset}, int@w{ }@var{length}) @*throws IOException + +@end deftypemethod +@deftypemethod InputStreamReader {public int} read () @*throws IOException + +@end deftypemethod +@deftypemethod InvalidClassException {public String} getMessage () +Returns the descriptive error message for this exception. It will + include the class name that caused the problem if known. This method + overrides Throwable.getMessage() +@end deftypemethod +@deftypemethod LineNumberInputStream {public int} available () @*throws IOException + +@end deftypemethod +@deftypemethod LineNumberInputStream {public int} getLineNumber () + +@end deftypemethod +@deftypemethod LineNumberInputStream {public void} mark (int@w{ }@var{readlimit}) + +@end deftypemethod +@deftypemethod LineNumberInputStream {public int} read () @*throws IOException + +@end deftypemethod +@deftypemethod LineNumberInputStream {public int} read (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException + +@end deftypemethod +@deftypemethod LineNumberInputStream {public void} reset () @*throws IOException + +@end deftypemethod +@deftypemethod LineNumberInputStream {public void} setLineNumber (int@w{ }@var{lineNumber}) + +@end deftypemethod +@deftypemethod LineNumberInputStream {public long} skip (long@w{ }@var{n}) @*throws IOException + +@end deftypemethod +@deftypemethod LineNumberReader {public int} getLineNumber () + +@end deftypemethod +@deftypemethod LineNumberReader {public void} setLineNumber (int@w{ }@var{lineNumber}) + +@end deftypemethod +@deftypemethod LineNumberReader {public void} mark (int@w{ }@var{readLimit}) @*throws IOException + +@end deftypemethod +@deftypemethod LineNumberReader {public void} reset () @*throws IOException + +@end deftypemethod +@deftypemethod LineNumberReader {public int} read () @*throws IOException + +@end deftypemethod +@deftypemethod LineNumberReader {public int} read (char[]@w{ }@var{buf}, int@w{ }@var{offset}, int@w{ }@var{count}) @*throws IOException + +@end deftypemethod +@deftypemethod LineNumberReader {public String} readLine () @*throws IOException + +@end deftypemethod +@deftypemethod LineNumberReader {public long} skip (long@w{ }@var{count}) @*throws IOException + +@end deftypemethod +@deftypemethod ObjectInput {public int} available () @*throws IOException +This method returns the number of bytes that can be read without + blocking. +@end deftypemethod +@deftypemethod ObjectInput {public int} read () @*throws IOException +This method reading a byte of data from a stream. It returns that byte + as an int. This method blocks if no data is available to be read. +@end deftypemethod +@deftypemethod ObjectInput {public int} read (byte[]@w{ }@var{buf}) @*throws IOException +This method reads raw bytes and stores them them a byte array buffer. + Note that this method will block if no data is available. However, + it will not necessarily block until it fills the entire buffer. That is, + a "short count" is possible. +@end deftypemethod +@deftypemethod ObjectInput {public int} read (byte[]@w{ }@var{buf}, int@w{ }@var{offset}, int@w{ }@var{len}) @*throws IOException +This method reads raw bytes and stores them in a byte array buffer + @code{buf} starting at position @code{offset} into the buffer. A + maximum of @code{len} bytes will be read. Note that this method + blocks if no data is available, but will not necessarily block until + it can read @code{len} bytes of data. That is, a "short count" is + possible. +@end deftypemethod +@deftypemethod ObjectInput {public Object} readObject () @*throws ClassNotFoundException, IOException +Reads an object instance and returns it. If the class for the object + being read cannot be found, then a ClassNotFoundException will + be thrown. +@end deftypemethod +@deftypemethod ObjectInput {public long} skip (long@w{ }@var{num_bytes}) @*throws IOException +This method causes the specified number of bytes to be read and + discarded. It is possible that fewer than the requested number of bytes + will actually be skipped. +@end deftypemethod +@deftypemethod ObjectInput {public void} close () @*throws IOException +This method closes the input source +@end deftypemethod +@deftypemethod ObjectInputStream {public final Object} readObject () @*throws ClassNotFoundException, IOException +Returns the next deserialized object read from the underlying stream. + +This method can be overriden by a class by implementing +@code{private void readObject (ObjectInputStream)}. + +If an exception is thrown from this method, the stream is left in +an undefined state. +@end deftypemethod +@deftypemethod ObjectInputStream {public void} defaultReadObject () @*throws ClassNotFoundException, IOException, NotActiveException +Reads the current objects non-transient, non-static fields from +the current class from the underlying output stream. + +This method is intended to be called from within a object's +@code{private void readObject (ObjectInputStream)} +method. +@end deftypemethod +@deftypemethod ObjectInputStream {public void} registerValidation (java.io.ObjectInputValidation@w{ }@var{validator}, int@w{ }@var{priority}) @*throws InvalidObjectException, NotActiveException +Registers a @code{ObjectInputValidation} to be carried out +on the object graph currently being deserialized before it is +returned to the original caller of @code{readObject ()}. +The order of validation for multiple +@code{ObjectInputValidation}s can be controled using +@code{priority}. Validators with higher priorities are +called first. +@end deftypemethod +@deftypemethod ObjectInputStream {protected Class} resolveClass (java.io.ObjectStreamClass@w{ }@var{osc}) @*throws ClassNotFoundException, IOException +Called when a class is being deserialized. This is a hook to +allow subclasses to read in information written by the +@code{annotateClass (Class)} method of an +@code{ObjectOutputStream}. + +This implementation looks up the active call stack for a +@code{ClassLoader}; if a @code{ClassLoader} is found, +it is used to load the class associated with @code{osc}, +otherwise, the default system @code{ClassLoader} is used. +@end deftypemethod +@deftypemethod ObjectInputStream {protected Object} resolveObject (java.lang.Object@w{ }@var{obj}) @*throws IOException +Allows subclasses to resolve objects that are read from the +stream with other objects to be returned in their place. This +method is called the first time each object is encountered. + +This method must be enabled before it will be called in the +serialization process. +@end deftypemethod +@deftypemethod ObjectInputStream {protected boolean} enableResolveObject (boolean@w{ }@var{enable}) @*throws SecurityException +If @code{enable} is @code{true} and this object is +trusted, then @code{resolveObject (Object)} will be called +in subsequent calls to @code{readObject (Object)}. +Otherwise, @code{resolveObject (Object)} will not be called. +@end deftypemethod +@deftypemethod ObjectInputStream {protected void} readStreamHeader () @*throws IOException, StreamCorruptedException +Reads stream magic and stream version information from the +underlying stream. +@end deftypemethod +@deftypemethod ObjectInputStream {public int} read () @*throws IOException + +@end deftypemethod +@deftypemethod ObjectInputStream {public int} read (byte[]@w{ }@var{data}, int@w{ }@var{offset}, int@w{ }@var{length}) @*throws IOException + +@end deftypemethod +@deftypemethod ObjectInputStream {public int} available () @*throws IOException + +@end deftypemethod +@deftypemethod ObjectInputStream {public void} close () @*throws IOException + +@end deftypemethod +@deftypemethod ObjectInputStream {public boolean} readBoolean () @*throws IOException + +@end deftypemethod +@deftypemethod ObjectInputStream {public byte} readByte () @*throws IOException + +@end deftypemethod +@deftypemethod ObjectInputStream {public int} readUnsignedByte () @*throws IOException + +@end deftypemethod +@deftypemethod ObjectInputStream {public short} readShort () @*throws IOException + +@end deftypemethod +@deftypemethod ObjectInputStream {public int} readUnsignedShort () @*throws IOException + +@end deftypemethod +@deftypemethod ObjectInputStream {public char} readChar () @*throws IOException + +@end deftypemethod +@deftypemethod ObjectInputStream {public int} readInt () @*throws IOException + +@end deftypemethod +@deftypemethod ObjectInputStream {public long} readLong () @*throws IOException + +@end deftypemethod +@deftypemethod ObjectInputStream {public float} readFloat () @*throws IOException + +@end deftypemethod +@deftypemethod ObjectInputStream {public double} readDouble () @*throws IOException + +@end deftypemethod +@deftypemethod ObjectInputStream {public void} readFully (byte[]@w{ }@var{data}) @*throws IOException + +@end deftypemethod +@deftypemethod ObjectInputStream {public void} readFully (byte[]@w{ }@var{data}, int@w{ }@var{offset}, int@w{ }@var{size}) @*throws IOException + +@end deftypemethod +@deftypemethod ObjectInputStream {public int} skipBytes (int@w{ }@var{len}) @*throws IOException + +@end deftypemethod +@deftypemethod ObjectInputStream {public String} readLine () @*throws IOException + +@end deftypemethod +@deftypemethod ObjectInputStream {public String} readUTF () @*throws IOException + +@end deftypemethod +@deftypemethod ObjectInputStream {public ObjectInputStream.GetField} readFields () @*throws IOException, ClassNotFoundException, NotActiveException + +@end deftypemethod +@deftypemethod ObjectInputStream {protected Object} readObjectOverride () @*throws ClassNotFoundException, IOException, OptionalDataException +This method allows subclasses to override the default +de serialization mechanism provided by +@code{ObjectInputStream}. To make this method be used for +writing objects, subclasses must invoke the 0-argument +constructor on this class from there constructor. +@end deftypemethod +@deftypemethod ObjectInputStream.GetField {public abstract ObjectStreamClass} getObjectStreamClass () + +@end deftypemethod +@deftypemethod ObjectInputStream.GetField {public abstract boolean} defaulted (java.lang.String@w{ }@var{name}) @*throws IOException, IllegalArgumentException + +@end deftypemethod +@deftypemethod ObjectInputStream.GetField {public abstract boolean} get (java.lang.String@w{ }@var{name}, boolean@w{ }@var{defvalue}) @*throws IOException, IllegalArgumentException + +@end deftypemethod +@deftypemethod ObjectInputStream.GetField {public abstract char} get (java.lang.String@w{ }@var{name}, char@w{ }@var{defvalue}) @*throws IOException, IllegalArgumentException + +@end deftypemethod +@deftypemethod ObjectInputStream.GetField {public abstract byte} get (java.lang.String@w{ }@var{name}, byte@w{ }@var{defvalue}) @*throws IOException, IllegalArgumentException + +@end deftypemethod +@deftypemethod ObjectInputStream.GetField {public abstract short} get (java.lang.String@w{ }@var{name}, short@w{ }@var{defvalue}) @*throws IOException, IllegalArgumentException + +@end deftypemethod +@deftypemethod ObjectInputStream.GetField {public abstract int} get (java.lang.String@w{ }@var{name}, int@w{ }@var{defvalue}) @*throws IOException, IllegalArgumentException + +@end deftypemethod +@deftypemethod ObjectInputStream.GetField {public abstract long} get (java.lang.String@w{ }@var{name}, long@w{ }@var{defvalue}) @*throws IOException, IllegalArgumentException + +@end deftypemethod +@deftypemethod ObjectInputStream.GetField {public abstract float} get (java.lang.String@w{ }@var{name}, float@w{ }@var{defvalue}) @*throws IOException, IllegalArgumentException + +@end deftypemethod +@deftypemethod ObjectInputStream.GetField {public abstract double} get (java.lang.String@w{ }@var{name}, double@w{ }@var{defvalue}) @*throws IOException, IllegalArgumentException + +@end deftypemethod +@deftypemethod ObjectInputStream.GetField {public abstract Object} get (java.lang.String@w{ }@var{name}, java.lang.Object@w{ }@var{defvalue}) @*throws IOException, IllegalArgumentException + +@end deftypemethod +@deftypemethod ObjectInputValidation {public void} validateObject () @*throws InvalidObjectException +This method is called to validate an object. If the object is invalid + an exception is thrown. +@end deftypemethod +@deftypemethod ObjectOutput {public void} write (int@w{ }@var{b}) @*throws IOException +This method writes the specified byte to the output stream. +@end deftypemethod +@deftypemethod ObjectOutput {public void} write (byte[]@w{ }@var{buf}) @*throws IOException +This method writes all the bytes in the specified byte array to the + output stream. +@end deftypemethod +@deftypemethod ObjectOutput {public void} write (byte[]@w{ }@var{buf}, int@w{ }@var{offset}, int@w{ }@var{len}) @*throws IOException +This method writes @code{len} bytes from the specified array + starting at index @code{offset} into that array. +@end deftypemethod +@deftypemethod ObjectOutput {public void} writeObject (java.lang.Object@w{ }@var{obj}) @*throws IOException +This method writes a object instance to a stream. The format of the + data written is determined by the actual implementation of this method +@end deftypemethod +@deftypemethod ObjectOutput {public void} flush () @*throws IOException +This method causes any buffered data to be flushed out to the underlying + stream +@end deftypemethod +@deftypemethod ObjectOutput {public void} close () @*throws IOException +This method closes the underlying stream. +@end deftypemethod +@deftypemethod ObjectOutputStream {public final void} writeObject (java.lang.Object@w{ }@var{obj}) @*throws IOException +Writes a representation of @code{obj} to the underlying +output stream by writing out information about its class, then +writing out each of the objects non-transient, non-static +fields. If any of these fields are other objects, +they are written out in the same manner. + +This method can be overriden by a class by implementing +@code{private void writeObject (ObjectOutputStream)}. + +If an exception is thrown from this method, the stream is left in +an undefined state. +@end deftypemethod +@deftypemethod ObjectOutputStream {public void} defaultWriteObject () @*throws IOException, NotActiveException +Writes the current objects non-transient, non-static fields from +the current class to the underlying output stream. + +This method is intended to be called from within a object's +@code{private void writeObject (ObjectOutputStream)} +method. +@end deftypemethod +@deftypemethod ObjectOutputStream {public void} reset () @*throws IOException +Resets stream to state equivalent to the state just after it was +constructed. + +Causes all objects previously written to the stream to be +forgotten. A notification of this reset is also written to the +underlying stream. +@end deftypemethod +@deftypemethod ObjectOutputStream {public void} useProtocolVersion (int@w{ }@var{version}) @*throws IOException +Informs this @code{ObjectOutputStream} to write data +according to the specified protocol. There are currently two +different protocols, specified by @code{PROTOCOL_VERSION_1} +and @code{PROTOCOL_VERSION_2}. This implementation writes +data using @code{PROTOCOL_VERSION_1} by default, as is done +by the JDK 1.1. + +A non-portable method, @code{setDefaultProtocolVersion (int +version)} is provided to change the default protocol +version. + +For an explination of the differences beween the two protocols +see XXX: the Java ObjectSerialization Specification. +@end deftypemethod +@deftypemethod ObjectOutputStream {public static void} setDefaultProtocolVersion (int@w{ }@var{version}) @*throws IOException +<em>GNU $classpath specific</em> + +Changes the default stream protocol used by all +@code{ObjectOutputStream}s. There are currently two +different protocols, specified by @code{PROTOCOL_VERSION_1} +and @code{PROTOCOL_VERSION_2}. The default default is +@code{PROTOCOL_VERSION_1}. +@end deftypemethod +@deftypemethod ObjectOutputStream {protected void} annotateClass (java.lang.Class@w{ }@var{cl}) @*throws IOException +An empty hook that allows subclasses to write extra information +about classes to the stream. This method is called the first +time each class is seen, and after all of the standard +information about the class has been written. +@end deftypemethod +@deftypemethod ObjectOutputStream {protected Object} replaceObject (java.lang.Object@w{ }@var{obj}) @*throws IOException +Allows subclasses to replace objects that are written to the +stream with other objects to be written in their place. This +method is called the first time each object is encountered +(modulo reseting of the stream). + +This method must be enabled before it will be called in the +serialization process. +@end deftypemethod +@deftypemethod ObjectOutputStream {protected boolean} enableReplaceObject (boolean@w{ }@var{enable}) @*throws SecurityException +If @code{enable} is @code{true} and this object is +trusted, then @code{replaceObject (Object)} will be called +in subsequent calls to @code{writeObject (Object)}. +Otherwise, @code{replaceObject (Object)} will not be called. +@end deftypemethod +@deftypemethod ObjectOutputStream {protected void} writeStreamHeader () @*throws IOException +Writes stream magic and stream version information to the +underlying stream. +@end deftypemethod +@deftypemethod ObjectOutputStream {protected void} writeObjectOverride (java.lang.Object@w{ }@var{obj}) @*throws NotActiveException, IOException +This method allows subclasses to override the default +serialization mechanism provided by +@code{ObjectOutputStream}. To make this method be used for +writing objects, subclasses must invoke the 0-argument +constructor on this class from there constructor. +@end deftypemethod +@deftypemethod ObjectOutputStream {public void} write (int@w{ }@var{data}) @*throws IOException + +@end deftypemethod +@deftypemethod ObjectOutputStream {public void} write (byte[]@w{ }@var{b}) @*throws IOException + +@end deftypemethod +@deftypemethod ObjectOutputStream {public void} write (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException + +@end deftypemethod +@deftypemethod ObjectOutputStream {public void} flush () @*throws IOException + +@end deftypemethod +@deftypemethod ObjectOutputStream {protected void} drain () @*throws IOException +Causes the block-data buffer to be written to the underlying +stream, but does not flush underlying stream. +@end deftypemethod +@deftypemethod ObjectOutputStream {public void} close () @*throws IOException + +@end deftypemethod +@deftypemethod ObjectOutputStream {public void} writeBoolean (boolean@w{ }@var{data}) @*throws IOException + +@end deftypemethod +@deftypemethod ObjectOutputStream {public void} writeByte (int@w{ }@var{data}) @*throws IOException + +@end deftypemethod +@deftypemethod ObjectOutputStream {public void} writeShort (int@w{ }@var{data}) @*throws IOException + +@end deftypemethod +@deftypemethod ObjectOutputStream {public void} writeChar (int@w{ }@var{data}) @*throws IOException + +@end deftypemethod +@deftypemethod ObjectOutputStream {public void} writeInt (int@w{ }@var{data}) @*throws IOException + +@end deftypemethod +@deftypemethod ObjectOutputStream {public void} writeLong (long@w{ }@var{data}) @*throws IOException + +@end deftypemethod +@deftypemethod ObjectOutputStream {public void} writeFloat (float@w{ }@var{data}) @*throws IOException + +@end deftypemethod +@deftypemethod ObjectOutputStream {public void} writeDouble (double@w{ }@var{data}) @*throws IOException + +@end deftypemethod +@deftypemethod ObjectOutputStream {public void} writeBytes (java.lang.String@w{ }@var{data}) @*throws IOException + +@end deftypemethod +@deftypemethod ObjectOutputStream {public void} writeChars (java.lang.String@w{ }@var{data}) @*throws IOException + +@end deftypemethod +@deftypemethod ObjectOutputStream {public void} writeUTF (java.lang.String@w{ }@var{data}) @*throws IOException + +@end deftypemethod +@deftypemethod ObjectOutputStream {public ObjectOutputStream.PutField} putFields () @*throws IOException + +@end deftypemethod +@deftypemethod ObjectOutputStream {public void} writeFields () @*throws IOException + +@end deftypemethod +@deftypemethod ObjectOutputStream.PutField {public abstract void} put (java.lang.String@w{ }@var{name}, boolean@w{ }@var{value}) @*throws IOException, IllegalArgumentException + +@end deftypemethod +@deftypemethod ObjectOutputStream.PutField {public abstract void} put (java.lang.String@w{ }@var{name}, byte@w{ }@var{value}) @*throws IOException, IllegalArgumentException + +@end deftypemethod +@deftypemethod ObjectOutputStream.PutField {public abstract void} put (java.lang.String@w{ }@var{name}, char@w{ }@var{value}) @*throws IOException, IllegalArgumentException + +@end deftypemethod +@deftypemethod ObjectOutputStream.PutField {public abstract void} put (java.lang.String@w{ }@var{name}, double@w{ }@var{value}) @*throws IOException, IllegalArgumentException + +@end deftypemethod +@deftypemethod ObjectOutputStream.PutField {public abstract void} put (java.lang.String@w{ }@var{name}, float@w{ }@var{value}) @*throws IOException, IllegalArgumentException + +@end deftypemethod +@deftypemethod ObjectOutputStream.PutField {public abstract void} put (java.lang.String@w{ }@var{name}, int@w{ }@var{value}) @*throws IOException, IllegalArgumentException + +@end deftypemethod +@deftypemethod ObjectOutputStream.PutField {public abstract void} put (java.lang.String@w{ }@var{name}, long@w{ }@var{value}) @*throws IOException, IllegalArgumentException + +@end deftypemethod +@deftypemethod ObjectOutputStream.PutField {public abstract void} put (java.lang.String@w{ }@var{name}, short@w{ }@var{value}) @*throws IOException, IllegalArgumentException + +@end deftypemethod +@deftypemethod ObjectOutputStream.PutField {public abstract void} put (java.lang.String@w{ }@var{name}, java.lang.Object@w{ }@var{value}) @*throws IOException, IllegalArgumentException + +@end deftypemethod +@deftypemethod ObjectOutputStream.PutField {public abstract void} write (java.io.ObjectOutput@w{ }@var{out}) @*throws IOException + +@end deftypemethod +@deftypemethod ObjectStreamClass {public static ObjectStreamClass} lookup (java.lang.Class@w{ }@var{cl}) +Returns the @code{ObjectStreamClass} for @code{cl}. +If @code{cl} is null, or is not @code{Serializable}, +null is returned. @code{ObjectStreamClass}'s are memorized; +later calls to this method with the same class will return the +same @code{ObjectStreamClass} object and no recalculation +will be done. +@end deftypemethod +@deftypemethod ObjectStreamClass {public String} getName () +Returns the name of the class that this +@code{ObjectStreamClass} represents. +@end deftypemethod +@deftypemethod ObjectStreamClass {public Class} forClass () +Returns the class that this @code{ObjectStreamClass} +represents. Null could be returned if this +@code{ObjectStreamClass} was read from an +@code{ObjectInputStream} and the class it represents cannot +be found or loaded. +@end deftypemethod +@deftypemethod ObjectStreamClass {public long} getSerialVersionUID () +Returns the serial version stream-unique identifier for the class +represented by this @code{ObjectStreamClass}. This SUID is +either defined by the class as @code{static final long +serialVersionUID} or is calculated as specified in +Javasoft's "Object Serialization Specification" XXX: add reference +@end deftypemethod +@deftypemethod ObjectStreamClass {public ObjectStreamField} getFields () + +@end deftypemethod +@deftypemethod ObjectStreamClass {public ObjectStreamField} getField (java.lang.String@w{ }@var{name}) + +@end deftypemethod +@deftypemethod ObjectStreamClass {public String} toString () +Returns a textual representation of this +@code{ObjectStreamClass} object including the name of the +class it represents as well as that class's serial version +stream-unique identifier. +@end deftypemethod +@deftypemethod ObjectStreamField {public String} getName () + +@end deftypemethod +@deftypemethod ObjectStreamField {public Class} getType () + +@end deftypemethod +@deftypemethod ObjectStreamField {public char} getTypeCode () + +@end deftypemethod +@deftypemethod ObjectStreamField {public String} getTypeString () + +@end deftypemethod +@deftypemethod ObjectStreamField {public int} getOffset () + +@end deftypemethod +@deftypemethod ObjectStreamField {protected void} setOffset (int@w{ }@var{off}) + +@end deftypemethod +@deftypemethod ObjectStreamField {public boolean} isPrimitive () + +@end deftypemethod +@deftypemethod ObjectStreamField {public int} compareTo (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod ObjectStreamField {public String} toString () + +@end deftypemethod +@deftypemethod OutputStream {public abstract void} write (int@w{ }@var{b}) @*throws IOException + +@end deftypemethod +@deftypemethod OutputStream {public void} write (byte[]@w{ }@var{b}) @*throws IOException, NullPointerException + +@end deftypemethod +@deftypemethod OutputStream {public void} write (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException, NullPointerException, IndexOutOfBoundsException + +@end deftypemethod +@deftypemethod OutputStream {public void} flush () @*throws IOException + +@end deftypemethod +@deftypemethod OutputStream {public void} close () @*throws IOException + +@end deftypemethod +@deftypemethod OutputStreamWriter {public String} getEncoding () + +@end deftypemethod +@deftypemethod OutputStreamWriter {public void} close () @*throws IOException + +@end deftypemethod +@deftypemethod OutputStreamWriter {public void} flush () @*throws IOException + +@end deftypemethod +@deftypemethod OutputStreamWriter {public void} write (char[]@w{ }@var{buf}, int@w{ }@var{offset}, int@w{ }@var{count}) @*throws IOException + +@end deftypemethod +@deftypemethod OutputStreamWriter {public void} write (java.lang.String@w{ }@var{str}, int@w{ }@var{offset}, int@w{ }@var{count}) @*throws IOException + +@end deftypemethod +@deftypemethod OutputStreamWriter {public void} write (int@w{ }@var{ch}) @*throws IOException + +@end deftypemethod +@deftypemethod PipedInputStream {public void} connect (java.io.PipedOutputStream@w{ }@var{source}) @*throws IOException +This method connects this stream to the passed in @code{PipedOutputStream}. + This stream is then ready for reading. If this stream is already + connected or has been previously closed, then an exception is thrown +@end deftypemethod +@deftypemethod PipedInputStream {protected synchronized void} receive (int@w{ }@var{b}) @*throws IOException +This method receives a byte of input from the source PipedOutputStream. + If the internal circular buffer is full, this method blocks. +@end deftypemethod +@deftypemethod PipedInputStream {public int} read () @*throws IOException +This method reads bytes from the stream into a caller supplied buffer. + It starts storing bytes at position @code{offset} into the buffer and + reads a maximum of @code{len} bytes. Note that this method can actually + read fewer than @code{len} bytes. The actual number of bytes read is + returned. A -1 is returned to indicated that no bytes can be read + because the end of the stream was reached. If the stream is already + closed, a -1 will again be returned to indicate the end of the stream. + + + + This method will block if no bytes are available to be read. +@end deftypemethod +@deftypemethod PipedInputStream {public synchronized int} read (byte[]@w{ }@var{buf}, int@w{ }@var{offset}, int@w{ }@var{len}) @*throws IOException +This method reads bytes from the stream into a caller supplied buffer. + It starts storing bytes at position @code{offset} into the buffer and + reads a maximum of @code{len} bytes. Note that this method can actually + read fewer than @code{len} bytes. The actual number of bytes read is + returned. A -1 is returned to indicated that no bytes can be read + because the end of the stream was reached - ie close() was called on the + connected PipedOutputStream. + + + + This method will block if no bytes are available to be read. +@end deftypemethod +@deftypemethod PipedInputStream {public synchronized int} available () @*throws IOException +This method returns the number of bytes that can be read from this stream + before blocking could occur. This is the number of bytes that are + currently unread in the internal circular buffer. Note that once this + many additional bytes are read, the stream may block on a subsequent + read, but it not guaranteed to block. +@end deftypemethod +@deftypemethod PipedInputStream {public synchronized void} close () @*throws IOException +This methods closes the stream so that no more data can be read + from it. +@end deftypemethod +@deftypemethod PipedOutputStream {public void} connect (java.io.PipedInputStream@w{ }@var{sink}) @*throws IOException +Connects this object to the specified @code{PipedInputStream} + object. This stream will then be ready for writing. +@end deftypemethod +@deftypemethod PipedOutputStream {public void} write (int@w{ }@var{b}) @*throws IOException +Write a single byte of date to the stream. Note that this method will + block if the @code{PipedInputStream} to which this object is + connected has a full buffer. +@end deftypemethod +@deftypemethod PipedOutputStream {public void} write (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException +This method writes @code{len} bytes of data from the byte array + @code{buf} starting at index @code{offset} in the array + to the stream. Note that this method will block if the + @code{PipedInputStream} to which this object is connected has + a buffer that cannot hold all of the bytes to be written. +@end deftypemethod +@deftypemethod PipedOutputStream {public void} flush () +This method does nothing. +@end deftypemethod +@deftypemethod PipedOutputStream {public void} close () +This method closes this stream so that no more data can be written + to it. Any further attempts to write to this stream may throw an + exception +@end deftypemethod +@deftypemethod PipedReader {public void} connect (java.io.PipedWriter@w{ }@var{source}) @*throws IOException +This method connects this stream to the passed in @code{PipedWriter}. + This stream is then ready for reading. If this stream is already + connected or has been previously closed, then an exception is thrown +@end deftypemethod +@deftypemethod PipedReader {public int} read () @*throws IOException +This method reads chars from the stream into a caller supplied buffer. + It starts storing chars at position @code{offset} into the buffer and + reads a maximum of @code{len} chars. Note that this method can actually + read fewer than @code{len} chars. The actual number of chars read is + returned. A -1 is returned to indicated that no chars can be read + because the end of the stream was reached. If the stream is already + closed, a -1 will again be returned to indicate the end of the stream. + + + + This method will block if no chars are available to be read. +@end deftypemethod +@deftypemethod PipedReader {public int} read (char[]@w{ }@var{buf}, int@w{ }@var{offset}, int@w{ }@var{len}) @*throws IOException +This method reads characters from the stream into a caller supplied buffer. + It starts storing chars at position @code{offset} into the buffer and + reads a maximum of @code{len} chars. Note that this method can actually + read fewer than @code{len} chars. The actual number of chars read is + returned. A -1 is returned to indicated that no chars can be read + because the end of the stream was reached - ie close() was called on the + connected PipedWriter. + + + + This method will block if no chars are available to be read. +@end deftypemethod +@deftypemethod PipedReader {public boolean} ready () @*throws IOException + +@end deftypemethod +@deftypemethod PipedReader {public void} close () @*throws IOException +This methods closes the stream so that no more data can be read + from it. +@end deftypemethod +@deftypemethod PipedWriter {public void} connect (java.io.PipedReader@w{ }@var{sink}) @*throws IOException +Connects this object to the specified @code{PipedReader} + object. This stream will then be ready for writing. +@end deftypemethod +@deftypemethod PipedWriter {public void} write (char@w{ }@var{b}) @*throws IOException +Write a single char of date to the stream. Note that this method will + block if the @code{PipedReader} to which this object is + connected has a full buffer. +@end deftypemethod +@deftypemethod PipedWriter {public void} write (char[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException +This method writes @code{len} chars of data from the char array + @code{buf} starting at index @code{offset} in the array + to the stream. Note that this method will block if the + @code{PipedReader} to which this object is connected has + a buffer that cannot hold all of the chars to be written. +@end deftypemethod +@deftypemethod PipedWriter {public void} flush () +This method does nothing. +@end deftypemethod +@deftypemethod PipedWriter {public void} close () +This method closes this stream so that no more data can be written + to it. Any further attempts to write to this stream may throw an + exception +@end deftypemethod +@deftypemethod PrintStream {public boolean} checkError () + +@end deftypemethod +@deftypemethod PrintStream {public void} close () + +@end deftypemethod +@deftypemethod PrintStream {public void} flush () + +@end deftypemethod +@deftypemethod PrintStream {public void} print (boolean@w{ }@var{bool}) + +@end deftypemethod +@deftypemethod PrintStream {public void} print (int@w{ }@var{inum}) + +@end deftypemethod +@deftypemethod PrintStream {public void} print (long@w{ }@var{lnum}) + +@end deftypemethod +@deftypemethod PrintStream {public void} print (float@w{ }@var{fnum}) + +@end deftypemethod +@deftypemethod PrintStream {public void} print (double@w{ }@var{dnum}) + +@end deftypemethod +@deftypemethod PrintStream {public void} print (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod PrintStream {public void} print (java.lang.String@w{ }@var{str}) + +@end deftypemethod +@deftypemethod PrintStream {public synchronized void} print (char@w{ }@var{ch}) + +@end deftypemethod +@deftypemethod PrintStream {public void} print (char[]@w{ }@var{charArray}) + +@end deftypemethod +@deftypemethod PrintStream {public void} println () + +@end deftypemethod +@deftypemethod PrintStream {public void} println (boolean@w{ }@var{bool}) + +@end deftypemethod +@deftypemethod PrintStream {public void} println (int@w{ }@var{inum}) + +@end deftypemethod +@deftypemethod PrintStream {public void} println (long@w{ }@var{lnum}) + +@end deftypemethod +@deftypemethod PrintStream {public void} println (float@w{ }@var{fnum}) + +@end deftypemethod +@deftypemethod PrintStream {public void} println (double@w{ }@var{dnum}) + +@end deftypemethod +@deftypemethod PrintStream {public void} println (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod PrintStream {public void} println (java.lang.String@w{ }@var{str}) + +@end deftypemethod +@deftypemethod PrintStream {public synchronized void} println (char@w{ }@var{ch}) + +@end deftypemethod +@deftypemethod PrintStream {public void} println (char[]@w{ }@var{charArray}) + +@end deftypemethod +@deftypemethod PrintStream {protected void} setError () + +@end deftypemethod +@deftypemethod PrintStream {public void} write (int@w{ }@var{oneByte}) + +@end deftypemethod +@deftypemethod PrintStream {public void} write (byte[]@w{ }@var{buffer}, int@w{ }@var{offset}, int@w{ }@var{count}) + +@end deftypemethod +@deftypemethod PrintWriter {protected void} setError () +This method can be called by subclasses to indicate that an error + has occurred and should be reported by @code{checkError}. +@end deftypemethod +@deftypemethod PrintWriter {public boolean} checkError () +This method checks to see if an error has occurred on this stream. Note + that once an error has occurred, this method will continue to report + @code{true} forever for this stream. Before checking for an + error condition, this method flushes the stream. +@end deftypemethod +@deftypemethod PrintWriter {public void} flush () +This method flushes any buffered chars to the underlying stream and + then flushes that stream as well. +@end deftypemethod +@deftypemethod PrintWriter {public void} close () +This method closes this stream and all underlying streams. +@end deftypemethod +@deftypemethod PrintWriter {public void} print (java.lang.String@w{ }@var{str}) +This method prints a @code{String} to the stream. The actual + value printed depends on the system default encoding. +@end deftypemethod +@deftypemethod PrintWriter {public void} print (char@w{ }@var{ch}) +This method prints a char to the stream. The actual value printed is + determined by the character encoding in use. +@end deftypemethod +@deftypemethod PrintWriter {public void} print (char[]@w{ }@var{charArray}) +This method prints an array of characters to the stream. The actual + value printed depends on the system default encoding. +@end deftypemethod +@deftypemethod PrintWriter {public void} print (boolean@w{ }@var{bool}) +This methods prints a boolean value to the stream. @code{true} + values are printed as "true" and @code{false} values are printed + as "false". +@end deftypemethod +@deftypemethod PrintWriter {public void} print (int@w{ }@var{inum}) +This method prints an integer to the stream. The value printed is + determined using the @code{String.valueOf()} method. +@end deftypemethod +@deftypemethod PrintWriter {public void} print (long@w{ }@var{lnum}) +This method prints a long to the stream. The value printed is + determined using the @code{String.valueOf()} method. +@end deftypemethod +@deftypemethod PrintWriter {public void} print (float@w{ }@var{fnum}) +This method prints a float to the stream. The value printed is + determined using the @code{String.valueOf()} method. +@end deftypemethod +@deftypemethod PrintWriter {public void} print (double@w{ }@var{dnum}) +This method prints a double to the stream. The value printed is + determined using the @code{String.valueOf()} method. +@end deftypemethod +@deftypemethod PrintWriter {public void} print (java.lang.Object@w{ }@var{obj}) +This method prints an @code{Object} to the stream. The actual + value printed is determined by calling the @code{String.valueOf()} + method. +@end deftypemethod +@deftypemethod PrintWriter {public void} println () +This method prints a line separator sequence to the stream. The value + printed is determined by the system property <xmp>line.separator</xmp> + and is not necessarily the Unix '\n' newline character. +@end deftypemethod +@deftypemethod PrintWriter {public void} println (boolean@w{ }@var{bool}) +This methods prints a boolean value to the stream. @code{true} + values are printed as "true" and @code{false} values are printed + as "false". + + This method prints a line termination sequence after printing the value. +@end deftypemethod +@deftypemethod PrintWriter {public void} println (int@w{ }@var{inum}) +This method prints an integer to the stream. The value printed is + determined using the @code{String.valueOf()} method. + + This method prints a line termination sequence after printing the value. +@end deftypemethod +@deftypemethod PrintWriter {public void} println (long@w{ }@var{lnum}) +This method prints a long to the stream. The value printed is + determined using the @code{String.valueOf()} method. + + This method prints a line termination sequence after printing the value. +@end deftypemethod +@deftypemethod PrintWriter {public void} println (float@w{ }@var{fnum}) +This method prints a float to the stream. The value printed is + determined using the @code{String.valueOf()} method. + + This method prints a line termination sequence after printing the value. +@end deftypemethod +@deftypemethod PrintWriter {public void} println (double@w{ }@var{dnum}) +This method prints a double to the stream. The value printed is + determined using the @code{String.valueOf()} method. + + This method prints a line termination sequence after printing the value. +@end deftypemethod +@deftypemethod PrintWriter {public void} println (java.lang.Object@w{ }@var{obj}) +This method prints an @code{Object} to the stream. The actual + value printed is determined by calling the @code{String.valueOf()} + method. + + This method prints a line termination sequence after printing the value. +@end deftypemethod +@deftypemethod PrintWriter {public void} println (java.lang.String@w{ }@var{str}) +This method prints a @code{String} to the stream. The actual + value printed depends on the system default encoding. + + This method prints a line termination sequence after printing the value. +@end deftypemethod +@deftypemethod PrintWriter {public void} println (char@w{ }@var{ch}) +This method prints a char to the stream. The actual value printed is + determined by the character encoding in use. + + This method prints a line termination sequence after printing the value. +@end deftypemethod +@deftypemethod PrintWriter {public void} println (char[]@w{ }@var{charArray}) +This method prints an array of characters to the stream. The actual + value printed depends on the system default encoding. + + This method prints a line termination sequence after printing the value. +@end deftypemethod +@deftypemethod PrintWriter {public void} write (int@w{ }@var{ch}) +This method writes a single char to the stream. +@end deftypemethod +@deftypemethod PrintWriter {public void} write (char[]@w{ }@var{charArray}, int@w{ }@var{offset}, int@w{ }@var{count}) +This method writes @code{count} chars from the specified array + starting at index @code{offset} into the array. +@end deftypemethod +@deftypemethod PrintWriter {public void} write (java.lang.String@w{ }@var{str}, int@w{ }@var{offset}, int@w{ }@var{count}) +This method writes @code{count} chars from the specified + @code{String} to the output starting at character position + @code{offset} into the @code{String} +@end deftypemethod +@deftypemethod PrintWriter {public void} write (char[]@w{ }@var{charArray}) +This method write all the chars in the specified array to the output. +@end deftypemethod +@deftypemethod PrintWriter {public void} write (java.lang.String@w{ }@var{str}) +This method writes the contents of the specified @code{String} + to the underlying stream. +@end deftypemethod +@deftypemethod PushbackInputStream {public int} available () @*throws IOException + +@end deftypemethod +@deftypemethod PushbackInputStream {public void} close () @*throws IOException + +@end deftypemethod +@deftypemethod PushbackInputStream {public boolean} markSupported () + +@end deftypemethod +@deftypemethod PushbackInputStream {public int} read () @*throws IOException + +@end deftypemethod +@deftypemethod PushbackInputStream {public int} read (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException + +@end deftypemethod +@deftypemethod PushbackInputStream {public void} unread (int@w{ }@var{b}) @*throws IOException + +@end deftypemethod +@deftypemethod PushbackInputStream {public void} unread (byte[]@w{ }@var{b}) @*throws IOException + +@end deftypemethod +@deftypemethod PushbackInputStream {public void} unread (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException + +@end deftypemethod +@deftypemethod PushbackInputStream {public long} skip (long@w{ }@var{n}) @*throws IOException + +@end deftypemethod +@deftypemethod PushbackReader {public void} close () @*throws IOException +This method closes the stream and frees any associated resources. +@end deftypemethod +@deftypemethod PushbackReader {public void} mark (int@w{ }@var{read_limit}) @*throws IOException +This method throws an exception when called since this class does + not support mark/reset. +@end deftypemethod +@deftypemethod PushbackReader {public boolean} markSupported () +This method returns @code{false} to indicate that it does not support + mark/reset functionality. +@end deftypemethod +@deftypemethod PushbackReader {public void} reset () @*throws IOException +This method always throws an IOException in this class because + mark/reset functionality is not supported. +@end deftypemethod +@deftypemethod PushbackReader {public boolean} ready () @*throws IOException +This method determines whether or not this stream is ready to be read. + If it returns @code{false} to indicate that the stream is not + ready, any attempt to read from the stream could (but is not + guaranteed to) block. + + + + This stream is ready to read if there are either chars waiting to be + read in the pushback buffer or if the underlying stream is ready to + be read. +@end deftypemethod +@deftypemethod PushbackReader {public long} skip (long@w{ }@var{num_chars}) @*throws IOException +This method skips the specified number of chars in the stream. It + returns the actual number of chars skipped, which may be less than the + requested amount. + + + + This method first discards chars from the buffer, then calls the + @code{skip} method on the underlying @code{Reader} to + skip additional chars if necessary. +@end deftypemethod +@deftypemethod PushbackReader {public int} read () @*throws IOException +This method reads an unsigned char from the input stream and returns it + as an int in the range of 0-65535. This method also will return -1 if + the end of the stream has been reached. The char returned will be read + from the pushback buffer, unless the buffer is empty, in which case + the char will be read from the underlying stream. + + + + This method will block until the char can be read. +@end deftypemethod +@deftypemethod PushbackReader {public synchronized int} read (char[]@w{ }@var{b}, int@w{ }@var{offset}, int@w{ }@var{len}) @*throws IOException +This method read chars from a stream and stores them into a caller + supplied buffer. It starts storing the data at index @code{offset} into + the buffer and attempts to read @code{len} chars. This method can + return before reading the number of chars requested. The actual number + of chars read is returned as an int. A -1 is returned to indicate the + end of the stream. + + + + This method will block until some data can be read. + + + + This method first reads chars from the pushback buffer in order to + satisfy the read request. If the pushback buffer cannot provide all + of the chars requested, the remaining chars are read from the + underlying stream. +@end deftypemethod +@deftypemethod PushbackReader {public void} unread (int@w{ }@var{b}) @*throws IOException +This method pushes a single char of data into the pushback buffer. + The char pushed back is the one that will be returned as the first char + of the next read. + + + + If the pushback buffer is full, this method throws an exception. + + + + The argument to this method is an @code{int}. Only the low eight bits + of this value are pushed back. +@end deftypemethod +@deftypemethod PushbackReader {public synchronized void} unread (char[]@w{ }@var{buf}) @*throws IOException +This method pushes all of the chars in the passed char array into + the pushback buffer. These chars are pushed in reverse order so that + the next char read from the stream after this operation will be + @code{buf[0]} followed by @code{buf[1]}, etc. + + + + If the pushback buffer cannot hold all of the requested chars, an + exception is thrown. +@end deftypemethod +@deftypemethod PushbackReader {public synchronized void} unread (char[]@w{ }@var{b}, int@w{ }@var{offset}, int@w{ }@var{len}) @*throws IOException +This method pushed back chars from the passed in array into the pushback + buffer. The chars from @code{buf[offset]} to @code{buf[offset + len]} + are pushed in reverse order so that the next char read from the stream + after this operation will be @code{buf[offset]} followed by + @code{buf[offset + 1]}, etc. + + + + If the pushback buffer cannot hold all of the requested chars, an + exception is thrown. +@end deftypemethod +@deftypemethod RandomAccessFile {public void} close () @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final FileDescriptor} getFD () @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public long} getFilePointer () @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public long} length () @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public int} read () @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public int} read (byte[]@w{ }@var{buffer}) @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public int} read (byte[]@w{ }@var{buffer}, int@w{ }@var{offset}, int@w{ }@var{count}) @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final boolean} readBoolean () @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final byte} readByte () @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final char} readChar () @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final double} readDouble () @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final float} readFloat () @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final void} readFully (byte[]@w{ }@var{buffer}) @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final void} readFully (byte[]@w{ }@var{buffer}, int@w{ }@var{offset}, int@w{ }@var{count}) @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final int} readInt () @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final String} readLine () @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final long} readLong () @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final short} readShort () @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final int} readUnsignedByte () @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final int} readUnsignedShort () @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final String} readUTF () @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public void} seek (long@w{ }@var{pos}) @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public int} skipBytes (int@w{ }@var{count}) @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public void} write (int@w{ }@var{oneByte}) @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public void} write (byte[]@w{ }@var{buffer}) @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public void} write (byte[]@w{ }@var{buffer}, int@w{ }@var{offset}, int@w{ }@var{count}) @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final void} writeBoolean (boolean@w{ }@var{val}) @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final void} writeByte (int@w{ }@var{v}) @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final void} writeShort (int@w{ }@var{v}) @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final void} writeChar (int@w{ }@var{v}) @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final void} writeInt (int@w{ }@var{v}) @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final void} writeLong (long@w{ }@var{v}) @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final void} writeFloat (float@w{ }@var{v}) @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final void} writeDouble (double@w{ }@var{v}) @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final void} writeBytes (java.lang.String@w{ }@var{s}) @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final void} writeChars (java.lang.String@w{ }@var{s}) @*throws IOException + +@end deftypemethod +@deftypemethod RandomAccessFile {public final void} writeUTF (java.lang.String@w{ }@var{s}) @*throws IOException + +@end deftypemethod +@deftypemethod Reader {public abstract int} read (char[]@w{ }@var{buf}, int@w{ }@var{offset}, int@w{ }@var{count}) @*throws IOException +Read chars from a stream and stores them into a caller + supplied buffer. It starts storing the data at index @code{offset} + into the buffer and attempts to read @code{len} chars. This method + can return before reading the number of chars requested. The actual + number of chars read is returned as an int. A -1 is returned to indicate + the end of the stream. + + + + This method will block until some data can be read. + + + + This method operates by calling the single char @code{read()} method + in a loop until the desired number of chars are read. The read loop + stops short if the end of the stream is encountered or if an IOException + is encountered on any read operation except the first. If the first + attempt to read a chars fails, the IOException is allowed to propagate + upward. And subsequent IOException is caught and treated identically + to an end of stream condition. Subclasses can (and should if possible) + override this method to provide a more efficient implementation. +@end deftypemethod +@deftypemethod Reader {public int} read (char[]@w{ }@var{buf}) @*throws IOException +Reads chars from a stream and stores them into a caller + supplied buffer. This method attempts to completely fill the buffer, + but can return before doing so. The actual number of chars read is + returned as an int. A -1 is returned to indicate the end of the stream. + + + + This method will block until some data can be read. + + + + This method operates by calling an overloaded read method like so: + @code{read(buf, 0, buf.length)} +@end deftypemethod +@deftypemethod Reader {public int} read () @*throws IOException +Reads an char from the input stream and returns it + as an int in the range of 0-65535. This method also will return -1 if + the end of the stream has been reached. + + + + This method will block until the char can be read. +@end deftypemethod +@deftypemethod Reader {public abstract void} close () @*throws IOException +Closes the stream. Any futher attempts to read from the + stream may generate an @code{IOException}. +@end deftypemethod +@deftypemethod Reader {public boolean} markSupported () +Returns a boolean that indicates whether the mark/reset + methods are supported in this class. Those methods can be used to + remember a specific point in the stream and reset the stream to that + point. + + + + This method always returns @code{false} in this class, but + subclasses can override this method to return @code{true} if they + support mark/reset functionality. +@end deftypemethod +@deftypemethod Reader {public void} mark (int@w{ }@var{readLimit}) @*throws IOException +Marks a position in the input to which the stream can be + "reset" by calling the @code{reset()} method. The parameter + @code{readlimit} is the number of chars that can be read from the + stream after setting the mark before the mark becomes invalid. For + example, if @code{mark()} is called with a read limit of 10, then + when 11 chars of data are read from the stream before the + @code{reset()} method is called, then the mark is invalid and the + stream object instance is not required to remember the mark. +@end deftypemethod +@deftypemethod Reader {public void} reset () @*throws IOException +Resets a stream to the point where the @code{mark()} + method was called. Any chars that were read after the mark point was + set will be re-read during subsequent reads. + + + + This method always throws an IOException in this class, but subclasses + can override this method if they provide mark/reset functionality. +@end deftypemethod +@deftypemethod Reader {public boolean} ready () @*throws IOException +Determines whether or not this stream is ready to be + read. If it returns @code{false} the stream may block if a + read is attempted, but it is not guaranteed to do so. + + + + This method always returns @code{false} in this class +@end deftypemethod +@deftypemethod Reader {public long} skip (long@w{ }@var{count}) @*throws IOException +Skips the specified number of chars in the stream. It + returns the actual number of chars skipped, which may be less than the + requested amount. + + + + This method reads and discards chars into a 256 char array until the + specified number of chars were skipped or until either the end of stream + is reached or a read attempt returns a short count. Subclasses can + override this method to provide a more efficient implementation where + one exists. +@end deftypemethod +@deftypemethod SequenceInputStream {public int} available () @*throws IOException + +@end deftypemethod +@deftypemethod SequenceInputStream {public void} close () @*throws IOException + +@end deftypemethod +@deftypemethod SequenceInputStream {public int} read () @*throws IOException + +@end deftypemethod +@deftypemethod SequenceInputStream {public int} read (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException + +@end deftypemethod +@deftypemethod StreamTokenizer {public void} commentChar (int@w{ }@var{ch}) +This method sets the comment attribute on the specified character. +@end deftypemethod +@deftypemethod StreamTokenizer {public void} eolIsSignificant (boolean@w{ }@var{flag}) +This method sets a flag that indicates whether or not the end of line + sequence terminates and is a token. The defaults to @code{false} +@end deftypemethod +@deftypemethod StreamTokenizer {public int} lineno () +This method returns the current line number. Note that if the + @code{pushBack()} method is called, it has no effect on the + line number returned by this method. +@end deftypemethod +@deftypemethod StreamTokenizer {public void} lowerCaseMode (boolean@w{ }@var{flag}) +This method sets a flag that indicates whether or not alphabetic + tokens that are returned should be converted to lower case. +@end deftypemethod +@deftypemethod StreamTokenizer {public int} nextToken () @*throws IOException +This method reads the next token from the stream. It sets the + @code{ttype} variable to the appropriate token type and + returns it. It also can set @code{sval} or @code{nval} + as described below. The parsing strategy is as follows: + +@itemize @bullet + + +@item +Skip any whitespace characters. + +@item +If a numeric character is encountered, attempt to parse a numeric + value. Leading '-' characters indicate a numeric only if followed by + another non-'-' numeric. The value of the numeric token is terminated + by either the first non-numeric encountered, or the second occurrence of + '-' or '.'. The token type returned is TT_NUMBER and @code{nval} + is set to the value parsed. + +@item +If an alphabetic character is parsed, all subsequent characters + are read until the first non-alphabetic or non-numeric character is + encountered. The token type returned is TT_WORD and the value parsed + is stored in @code{sval}. If lower case mode is set, the token + stored in @code{sval} is converted to lower case. The end of line + sequence terminates a word only if EOL signficance has been turned on. + The start of a comment also terminates a word. Any character with a + non-alphabetic and non-numeric attribute (such as white space, a quote, + or a commet) are treated as non-alphabetic and terminate the word. + +@item +If a comment charcters is parsed, then all remaining characters on + the current line are skipped and another token is parsed. Any EOL or + EOF's encountered are not discarded, but rather terminate the comment. + +@item +If a quote character is parsed, then all characters up to the + second occurrence of the same quote character are parsed into a + @code{String}. This @code{String} is stored as + @code{sval}, but is not converted to lower case, even if lower case + mode is enabled. The token type returned is the value of the quote + character encountered. Any escape sequences + (\b (backspace), \t (HTAB), \n (linefeed), \f (form feed), \r + (carriage return), \" (double quote), \' (single quote), \\ + (backslash), \XXX (octal esacpe)) are converted to the appropriate + char values. Invalid esacape sequences are left in untranslated. + Unicode characters like ('\ u0000') are not recognized. + +@item +If the C++ comment sequence "//" is encountered, and the parser + is configured to handle that sequence, then the remainder of the line + is skipped and another token is read exactly as if a character with + the comment attribute was encountered. + +@item +If the C comment sequence "/*" is encountered, and the parser + is configured to handle that sequence, then all characters up to and + including the comment terminator sequence are discarded and another + token is parsed. + +@item +If all cases above are not met, then the character is an ordinary + character that is parsed as a token by itself. The char encountered + is returned as the token type. + +@end itemize + +@end deftypemethod +@deftypemethod StreamTokenizer {public void} ordinaryChar (int@w{ }@var{ch}) +This method makes the specified character an ordinary character. This + means that none of the attributes (whitespace, alphabetic, numeric, + quote, or comment) will be set on this character. This character will + parse as its own token. +@end deftypemethod +@deftypemethod StreamTokenizer {public void} ordinaryChars (int@w{ }@var{low}, int@w{ }@var{hi}) +This method makes all the characters in the specified range, range + terminators included, ordinary. This means the none of the attributes + (whitespace, alphabetic, numeric, quote, or comment) will be set on + any of the characters in the range. This makes each character in this + range parse as its own token. +@end deftypemethod +@deftypemethod StreamTokenizer {public void} parseNumbers () +This method sets the numeric attribute on the characters '0' - '9' and + the characters '.' and '-'. +@end deftypemethod +@deftypemethod StreamTokenizer {public void} pushBack () +This method returns the current line number. Note that if the + @code{pushBack()} method is called, it has no effect on the + line number returned by this method. +@end deftypemethod +@deftypemethod StreamTokenizer {public void} quoteChar (int@w{ }@var{ch}) +This method sets the quote attribute on the specified character. +@end deftypemethod +@deftypemethod StreamTokenizer {public void} resetSyntax () +This method removes all attributes (whitespace, alphabetic, numeric, + quote, and comment) from all characters. It is equivalent to calling + @code{ordinaryChars(0x00, 0xFF)}. +@end deftypemethod +@deftypemethod StreamTokenizer {public void} slashSlashComments (boolean@w{ }@var{flag}) +This method sets a flag that indicates whether or not "C++" language style + comments ("//" comments through EOL ) are handled by the parser. + If this is @code{true} commented out sequences are skipped and + ignored by the parser. This defaults to @code{false}. +@end deftypemethod +@deftypemethod StreamTokenizer {public void} slashStarComments (boolean@w{ }@var{flag}) +This method sets a flag that indicates whether or not "C" language style + comments (with nesting not allowed) are handled by the parser. + If this is @code{true} commented out sequences are skipped and + ignored by the parser. This defaults to @code{false}. +@end deftypemethod +@deftypemethod StreamTokenizer {public String} toString () +This method returns the current token value as a @code{String} in + the form "Token[x], line n", where 'n' is the current line numbers and + 'x' is determined as follows. + + + + +@itemize @bullet + + +@item +If no token has been read, then 'x' is "NOTHING" and 'n' is 0 + +@item +If @code{ttype} is TT_EOF, then 'x' is "EOF" + +@item +If @code{ttype} is TT_EOL, then 'x' is "EOL" + +@item +If @code{ttype} is TT_WORD, then 'x' is @code{sval} + +@item +If @code{ttype} is TT_NUMBER, then 'x' is "n=strnval" where + 'strnval' is @code{String.valueOf(nval)}. + +@item +If @code{ttype} is a quote character, then 'x' is + @code{sval} + +@item +For all other cases, 'x' is @code{ttype} + +@end itemize + +@end deftypemethod +@deftypemethod StreamTokenizer {public void} whitespaceChars (int@w{ }@var{low}, int@w{ }@var{hi}) +This method sets the whitespace attribute for all charcters in the + specified range, range terminators included. +@end deftypemethod +@deftypemethod StreamTokenizer {public void} wordChars (int@w{ }@var{low}, int@w{ }@var{hi}) +This method sets the alphabetic attribute for all charcters in the + specified range, range terminators included. +@end deftypemethod +@deftypemethod StringBufferInputStream {public int} available () + +@end deftypemethod +@deftypemethod StringBufferInputStream {public int} read () + +@end deftypemethod +@deftypemethod StringBufferInputStream {public int} read (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) + +@end deftypemethod +@deftypemethod StringBufferInputStream {public void} reset () + +@end deftypemethod +@deftypemethod StringBufferInputStream {public long} skip (long@w{ }@var{n}) + +@end deftypemethod +@deftypemethod StringReader {public void} close () + +@end deftypemethod +@deftypemethod StringReader {public void} mark (int@w{ }@var{readAheadLimit}) @*throws IOException + +@end deftypemethod +@deftypemethod StringReader {public boolean} markSupported () + +@end deftypemethod +@deftypemethod StringReader {public int} read () @*throws IOException + +@end deftypemethod +@deftypemethod StringReader {public int} read (char[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException + +@end deftypemethod +@deftypemethod StringReader {public boolean} ready () @*throws IOException +This method determines if the stream is ready to be read. This class + is always ready to read and so always returns @code{true}, unless + close() has previously been called in which case an IOException is + thrown. +@end deftypemethod +@deftypemethod StringReader {public void} reset () @*throws IOException +Sets the read position in the stream to the previously + marked position or to 0 (i.e., the beginning of the stream) if the mark + has not already been set. +@end deftypemethod +@deftypemethod StringReader {public long} skip (long@w{ }@var{n}) @*throws IOException +This method attempts to skip the requested number of chars in the + input stream. It does this by advancing the @code{pos} value by + the specified number of chars. It this would exceed the length of the + buffer, then only enough chars are skipped to position the stream at + the end of the buffer. The actual number of chars skipped is returned. +@end deftypemethod +@deftypemethod StringWriter {public void} close () + +@end deftypemethod +@deftypemethod StringWriter {public void} flush () + +@end deftypemethod +@deftypemethod StringWriter {public StringBuffer} getBuffer () + +@end deftypemethod +@deftypemethod StringWriter {public String} toString () + +@end deftypemethod +@deftypemethod StringWriter {public void} write (int@w{ }@var{oneChar}) + +@end deftypemethod +@deftypemethod StringWriter {public void} write (char[]@w{ }@var{chars}, int@w{ }@var{offset}, int@w{ }@var{len}) + +@end deftypemethod +@deftypemethod StringWriter {public void} write (java.lang.String@w{ }@var{str}) + +@end deftypemethod +@deftypemethod StringWriter {public void} write (java.lang.String@w{ }@var{str}, int@w{ }@var{offset}, int@w{ }@var{len}) + +@end deftypemethod +@deftypemethod WriteAbortedException {public String} getMessage () +This method returns a message indicating what went wrong, including + the message text from the initial exception that caused this one to + be thrown +@end deftypemethod +@deftypemethod Writer {public abstract void} close () @*throws IOException + +@end deftypemethod +@deftypemethod Writer {public abstract void} flush () @*throws IOException + +@end deftypemethod +@deftypemethod Writer {public abstract void} write (char[]@w{ }@var{buf}, int@w{ }@var{offset}, int@w{ }@var{count}) @*throws IOException + +@end deftypemethod +@deftypemethod Writer {public void} write (char[]@w{ }@var{buf}) @*throws IOException + +@end deftypemethod +@deftypemethod Writer {public void} write (int@w{ }@var{ch}) @*throws IOException + +@end deftypemethod +@deftypemethod Writer {public void} write (java.lang.String@w{ }@var{str}, int@w{ }@var{offset}, int@w{ }@var{count}) @*throws IOException + +@end deftypemethod +@deftypemethod Writer {public void} write (java.lang.String@w{ }@var{str}) @*throws IOException + +@end deftypemethod diff --git a/libjava/doc/java-lang-ref.texi b/libjava/doc/java-lang-ref.texi new file mode 100644 index 00000000000..4b9d7879538 --- /dev/null +++ b/libjava/doc/java-lang-ref.texi @@ -0,0 +1,34 @@ +@deftypemethod PhantomReference {public Object} get () +Returns the object, this reference refers to. +@end deftypemethod +@deftypemethod Reference {public Object} get () +Returns the object, this reference refers to. +@end deftypemethod +@deftypemethod Reference {public void} clear () +Clears the reference, so that it doesn't refer to its object + anymore. For soft and weak references this is called by the + garbage collection. For phantom references you should call + this when enqueuing the reference. +@end deftypemethod +@deftypemethod Reference {public boolean} isEnqueued () +Tells if the object is enqueued on a reference queue. +@end deftypemethod +@deftypemethod Reference {public boolean} enqueue () +Enqueue an object on a reference queue. This is normally executed + by the garbage collection. +@end deftypemethod +@deftypemethod ReferenceQueue {public synchronized Reference} poll () +Checks if there is a reference on the queue, returning it + immediately. The reference will be dequeued. +@end deftypemethod +@deftypemethod ReferenceQueue {public synchronized Reference} remove (long@w{ }@var{timeout}) @*throws InterruptedException +Removes a reference from the queue, blocking for @code{timeout} + until a reference is enqueued. +@end deftypemethod +@deftypemethod ReferenceQueue {public Reference} remove () @*throws InterruptedException +Removes a reference from the queue, blocking until a reference is + enqueued. +@end deftypemethod +@deftypemethod SoftReference {public Object} get () +Returns the object, this reference refers to. +@end deftypemethod diff --git a/libjava/doc/java-lang-reflect.texi b/libjava/doc/java-lang-reflect.texi new file mode 100644 index 00000000000..3712047747d --- /dev/null +++ b/libjava/doc/java-lang-reflect.texi @@ -0,0 +1,294 @@ +@deftypemethod AccessibleObject {public boolean} isAccessible () + +@end deftypemethod +@deftypemethod AccessibleObject {public static void} setAccessible (java.lang.reflect.AccessibleObject[]@w{ }@var{array}, boolean@w{ }@var{flag}) + +@end deftypemethod +@deftypemethod AccessibleObject {public void} setAccessible (boolean@w{ }@var{flag}) + +@end deftypemethod +@deftypemethod Array {public static native Object} newInstance (java.lang.Class@w{ }@var{componentType}, int@w{ }@var{length}) + +@end deftypemethod +@deftypemethod Array {public static native Object} newInstance (java.lang.Class@w{ }@var{elementType}, int[]@w{ }@var{dimensions}) + +@end deftypemethod +@deftypemethod Array {public static native int} getLength (java.lang.Object@w{ }@var{array}) + +@end deftypemethod +@deftypemethod Array {public static native Object} get (java.lang.Object@w{ }@var{array}, int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod Array {public static native char} getChar (java.lang.Object@w{ }@var{array}, int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod Array {public static native byte} getByte (java.lang.Object@w{ }@var{array}, int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod Array {public static native short} getShort (java.lang.Object@w{ }@var{array}, int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod Array {public static native int} getInt (java.lang.Object@w{ }@var{array}, int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod Array {public static native long} getLong (java.lang.Object@w{ }@var{array}, int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod Array {public static native float} getFloat (java.lang.Object@w{ }@var{array}, int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod Array {public static native double} getDouble (java.lang.Object@w{ }@var{array}, int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod Array {public static native boolean} getBoolean (java.lang.Object@w{ }@var{array}, int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod Array {public static void} set (java.lang.Object@w{ }@var{array}, int@w{ }@var{index}, java.lang.Object@w{ }@var{value}) + +@end deftypemethod +@deftypemethod Array {public static native void} setByte (java.lang.Object@w{ }@var{array}, int@w{ }@var{index}, byte@w{ }@var{value}) + +@end deftypemethod +@deftypemethod Array {public static native void} setShort (java.lang.Object@w{ }@var{array}, int@w{ }@var{index}, short@w{ }@var{value}) + +@end deftypemethod +@deftypemethod Array {public static native void} setInt (java.lang.Object@w{ }@var{array}, int@w{ }@var{index}, int@w{ }@var{value}) + +@end deftypemethod +@deftypemethod Array {public static native void} setLong (java.lang.Object@w{ }@var{array}, int@w{ }@var{index}, long@w{ }@var{value}) + +@end deftypemethod +@deftypemethod Array {public static native void} setFloat (java.lang.Object@w{ }@var{array}, int@w{ }@var{index}, float@w{ }@var{value}) + +@end deftypemethod +@deftypemethod Array {public static native void} setDouble (java.lang.Object@w{ }@var{array}, int@w{ }@var{index}, double@w{ }@var{value}) + +@end deftypemethod +@deftypemethod Array {public static native void} setChar (java.lang.Object@w{ }@var{array}, int@w{ }@var{index}, char@w{ }@var{value}) + +@end deftypemethod +@deftypemethod Array {public static native void} setBoolean (java.lang.Object@w{ }@var{array}, int@w{ }@var{index}, boolean@w{ }@var{value}) + +@end deftypemethod +@deftypemethod Constructor {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod Constructor {public Class} getDeclaringClass () + +@end deftypemethod +@deftypemethod Constructor {public Class} getExceptionTypes () + +@end deftypemethod +@deftypemethod Constructor {public native int} getModifiers () + +@end deftypemethod +@deftypemethod Constructor {public String} getName () + +@end deftypemethod +@deftypemethod Constructor {public Class} getParameterTypes () + +@end deftypemethod +@deftypemethod Constructor {public int} hashCode () + +@end deftypemethod +@deftypemethod Constructor {public native Object} newInstance (java.lang.Object[]@w{ }@var{args}) @*throws InstantiationException, IllegalAccessException, IllegalArgumentException, InvocationTargetException + +@end deftypemethod +@deftypemethod Constructor {public String} toString () + +@end deftypemethod +@deftypemethod Field {public boolean} equals (java.lang.Object@w{ }@var{fld}) + +@end deftypemethod +@deftypemethod Field {public Class} getDeclaringClass () + +@end deftypemethod +@deftypemethod Field {public native String} getName () + +@end deftypemethod +@deftypemethod Field {public native Class} getType () + +@end deftypemethod +@deftypemethod Field {public native int} getModifiers () + +@end deftypemethod +@deftypemethod Field {public int} hashCode () + +@end deftypemethod +@deftypemethod Field {public boolean} getBoolean (java.lang.Object@w{ }@var{obj}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public char} getChar (java.lang.Object@w{ }@var{obj}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public byte} getByte (java.lang.Object@w{ }@var{obj}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public short} getShort (java.lang.Object@w{ }@var{obj}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public int} getInt (java.lang.Object@w{ }@var{obj}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public long} getLong (java.lang.Object@w{ }@var{obj}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public float} getFloat (java.lang.Object@w{ }@var{obj}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public double} getDouble (java.lang.Object@w{ }@var{obj}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public Object} get (java.lang.Object@w{ }@var{obj}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public native Object} get (java.lang.Class@w{ }@var{caller}, java.lang.Object@w{ }@var{obj}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public void} setByte (java.lang.Object@w{ }@var{obj}, byte@w{ }@var{b}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public void} setShort (java.lang.Object@w{ }@var{obj}, short@w{ }@var{s}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public void} setInt (java.lang.Object@w{ }@var{obj}, int@w{ }@var{i}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public void} setLong (java.lang.Object@w{ }@var{obj}, long@w{ }@var{l}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public void} setFloat (java.lang.Object@w{ }@var{obj}, float@w{ }@var{f}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public void} setDouble (java.lang.Object@w{ }@var{obj}, double@w{ }@var{d}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public void} setChar (java.lang.Object@w{ }@var{obj}, char@w{ }@var{c}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public void} setBoolean (java.lang.Object@w{ }@var{obj}, boolean@w{ }@var{b}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public native void} setByte (java.lang.Class@w{ }@var{caller}, java.lang.Object@w{ }@var{obj}, byte@w{ }@var{b}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public native void} setShort (java.lang.Class@w{ }@var{caller}, java.lang.Object@w{ }@var{obj}, short@w{ }@var{s}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public native void} setInt (java.lang.Class@w{ }@var{caller}, java.lang.Object@w{ }@var{obj}, int@w{ }@var{i}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public native void} setLong (java.lang.Class@w{ }@var{caller}, java.lang.Object@w{ }@var{obj}, long@w{ }@var{l}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public native void} setFloat (java.lang.Class@w{ }@var{caller}, java.lang.Object@w{ }@var{obj}, float@w{ }@var{f}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public native void} setDouble (java.lang.Class@w{ }@var{caller}, java.lang.Object@w{ }@var{obj}, double@w{ }@var{d}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public native void} setChar (java.lang.Class@w{ }@var{caller}, java.lang.Object@w{ }@var{obj}, char@w{ }@var{c}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public native void} setBoolean (java.lang.Class@w{ }@var{caller}, java.lang.Object@w{ }@var{obj}, boolean@w{ }@var{b}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public void} set (java.lang.Object@w{ }@var{object}, java.lang.Object@w{ }@var{value}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public void} set (java.lang.Class@w{ }@var{caller}, java.lang.Object@w{ }@var{object}, java.lang.Object@w{ }@var{value}) @*throws IllegalArgumentException, IllegalAccessException + +@end deftypemethod +@deftypemethod Field {public String} toString () + +@end deftypemethod +@deftypemethod InvocationTargetException {public Throwable} getTargetException () + +@end deftypemethod +@deftypemethod InvocationTargetException {public void} printStackTrace () + +@end deftypemethod +@deftypemethod InvocationTargetException {public void} printStackTrace (java.io.PrintStream@w{ }@var{s}) + +@end deftypemethod +@deftypemethod InvocationTargetException {public void} printStackTrace (java.io.PrintWriter@w{ }@var{wr}) + +@end deftypemethod +@deftypemethod Member {public Class} getDeclaringClass () + +@end deftypemethod +@deftypemethod Member {public int} getModifiers () + +@end deftypemethod +@deftypemethod Member {public String} getName () + +@end deftypemethod +@deftypemethod Method {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod Method {public Class} getDeclaringClass () + +@end deftypemethod +@deftypemethod Method {public Class} getExceptionTypes () + +@end deftypemethod +@deftypemethod Method {public native int} getModifiers () + +@end deftypemethod +@deftypemethod Method {public native String} getName () + +@end deftypemethod +@deftypemethod Method {public Class} getParameterTypes () + +@end deftypemethod +@deftypemethod Method {public Class} getReturnType () + +@end deftypemethod +@deftypemethod Method {public int} hashCode () + +@end deftypemethod +@deftypemethod Method {public native Object} invoke (java.lang.Object@w{ }@var{obj}, java.lang.Object[]@w{ }@var{args}) @*throws IllegalAccessException, IllegalArgumentException, InvocationTargetException + +@end deftypemethod +@deftypemethod Method {public String} toString () + +@end deftypemethod +@deftypemethod Modifier {public static boolean} isAbstract (int@w{ }@var{mod}) + +@end deftypemethod +@deftypemethod Modifier {public static boolean} isFinal (int@w{ }@var{mod}) + +@end deftypemethod +@deftypemethod Modifier {public static boolean} isInterface (int@w{ }@var{mod}) + +@end deftypemethod +@deftypemethod Modifier {public static boolean} isNative (int@w{ }@var{mod}) + +@end deftypemethod +@deftypemethod Modifier {public static boolean} isPrivate (int@w{ }@var{mod}) + +@end deftypemethod +@deftypemethod Modifier {public static boolean} isProtected (int@w{ }@var{mod}) + +@end deftypemethod +@deftypemethod Modifier {public static boolean} isPublic (int@w{ }@var{mod}) + +@end deftypemethod +@deftypemethod Modifier {public static boolean} isStatic (int@w{ }@var{mod}) + +@end deftypemethod +@deftypemethod Modifier {public static boolean} isStrict (int@w{ }@var{mod}) + +@end deftypemethod +@deftypemethod Modifier {public static boolean} isSynchronized (int@w{ }@var{mod}) + +@end deftypemethod +@deftypemethod Modifier {public static boolean} isTransient (int@w{ }@var{mod}) + +@end deftypemethod +@deftypemethod Modifier {public static boolean} isVolatile (int@w{ }@var{mod}) + +@end deftypemethod +@deftypemethod Modifier {public static String} toString (int@w{ }@var{mod}) + +@end deftypemethod diff --git a/libjava/doc/java-lang.texi b/libjava/doc/java-lang.texi new file mode 100644 index 00000000000..086e7e1b386 --- /dev/null +++ b/libjava/doc/java-lang.texi @@ -0,0 +1,855 @@ +@deftypemethod Process {public abstract void} destroy () + +@end deftypemethod +@deftypemethod Process {public abstract int} exitValue () + +@end deftypemethod +@deftypemethod Process {public abstract InputStream} getErrorStream () + +@end deftypemethod +@deftypemethod Process {public abstract InputStream} getInputStream () + +@end deftypemethod +@deftypemethod Process {public abstract OutputStream} getOutputStream () + +@end deftypemethod +@deftypemethod Process {public abstract int} waitFor () @*throws InterruptedException + +@end deftypemethod +@deftypemethod Runnable {public void} run () + +@end deftypemethod +@deftypemethod Runtime {public Process} exec (java.lang.String@w{ }@var{prog}) @*throws IOException + +@end deftypemethod +@deftypemethod Runtime {public Process} exec (java.lang.String@w{ }@var{prog}, java.lang.String[]@w{ }@var{envp}) @*throws IOException + +@end deftypemethod +@deftypemethod Runtime {public Process} exec (java.lang.String[]@w{ }@var{progarray}) @*throws IOException + +@end deftypemethod +@deftypemethod Runtime {public Process} exec (java.lang.String[]@w{ }@var{progarray}, java.lang.String[]@w{ }@var{envp}) @*throws IOException + +@end deftypemethod +@deftypemethod Runtime {public native void} exit (int@w{ }@var{status}) + +@end deftypemethod +@deftypemethod Runtime {public native long} freeMemory () + +@end deftypemethod +@deftypemethod Runtime {public native void} gc () + +@end deftypemethod +@deftypemethod Runtime {public InputStream} getLocalizedInputStream (java.io.InputStream@w{ }@var{in}) + +@end deftypemethod +@deftypemethod Runtime {public OutputStream} getLocalizedOutputStream (java.io.OutputStream@w{ }@var{out}) + +@end deftypemethod +@deftypemethod Runtime {public static Runtime} getRuntime () + +@end deftypemethod +@deftypemethod Runtime {public void} load (java.lang.String@w{ }@var{pathname}) + +@end deftypemethod +@deftypemethod Runtime {public void} loadLibrary (java.lang.String@w{ }@var{libname}) + +@end deftypemethod +@deftypemethod Runtime {public native void} runFinalization () + +@end deftypemethod +@deftypemethod Runtime {public static void} runFinalizersOnExit (boolean@w{ }@var{run}) + +@end deftypemethod +@deftypemethod Runtime {public native long} totalMemory () + +@end deftypemethod +@deftypemethod Runtime {public native void} traceInstructions (boolean@w{ }@var{on}) + +@end deftypemethod +@deftypemethod Runtime {public native void} traceMethodCalls (boolean@w{ }@var{on}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkAccept (java.lang.String@w{ }@var{host}, int@w{ }@var{port}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkAccess (java.lang.Thread@w{ }@var{thrd}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkAccess (java.lang.ThreadGroup@w{ }@var{thrdGroup}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkAwtEventQueueAccess () + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkConnect (java.lang.String@w{ }@var{host}, int@w{ }@var{prt}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkConnect (java.lang.String@w{ }@var{host}, int@w{ }@var{prt}, java.lang.Object@w{ }@var{ctx}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkCreateClassLoader () + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkDelete (java.lang.String@w{ }@var{fileName}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkExec (java.lang.String@w{ }@var{prog}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkExit (int@w{ }@var{stat}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkLink (java.lang.String@w{ }@var{lib}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkListen (int@w{ }@var{lport}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkMemberAccess (java.lang.Class@w{ }@var{cl}, int@w{ }@var{mtype}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkMulticast (java.net.InetAddress@w{ }@var{maddr}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkMulticast (java.net.InetAddress@w{ }@var{maddr}, byte@w{ }@var{ttl}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkPackageAccess (java.lang.String@w{ }@var{pkg}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkPackageDefinition (java.lang.String@w{ }@var{pkg}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkPermission (java.security.Permission@w{ }@var{perm}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkPrintJobAccess () + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkPropertiesAccess () + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkPropertyAccess (java.lang.String@w{ }@var{prop}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkPropertyAccess (java.lang.String@w{ }@var{prop}, java.lang.String@w{ }@var{defval}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkRead (java.io.FileDescriptor@w{ }@var{fd}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkRead (java.lang.String@w{ }@var{fileName}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkRead (java.lang.String@w{ }@var{fileName}, java.lang.Object@w{ }@var{ctx}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkSecurityAccess (java.lang.String@w{ }@var{action}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkSetFactory () + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkSystemClipboardAccess () + +@end deftypemethod +@deftypemethod SecurityManager {public boolean} checkTopLevelWindow (java.lang.Object@w{ }@var{window}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkWrite (java.io.FileDescriptor@w{ }@var{fd}) + +@end deftypemethod +@deftypemethod SecurityManager {public void} checkWrite (java.lang.String@w{ }@var{fileName}) + +@end deftypemethod +@deftypemethod SecurityManager {protected int} classDepth (java.lang.String@w{ }@var{className}) + +@end deftypemethod +@deftypemethod SecurityManager {protected int} classLoaderDepth () + +@end deftypemethod +@deftypemethod SecurityManager {protected ClassLoader} currentClassLoader () + +@end deftypemethod +@deftypemethod SecurityManager {protected Class} currentLoadedClass () + +@end deftypemethod +@deftypemethod SecurityManager {protected Class} getClassContext () + +@end deftypemethod +@deftypemethod SecurityManager {public boolean} getInCheck () + +@end deftypemethod +@deftypemethod SecurityManager {public Object} getSecurityContext () + +@end deftypemethod +@deftypemethod SecurityManager {public ThreadGroup} getThreadGroup () + +@end deftypemethod +@deftypemethod SecurityManager {protected boolean} inClass (java.lang.String@w{ }@var{className}) + +@end deftypemethod +@deftypemethod SecurityManager {protected boolean} inClassLoader () + +@end deftypemethod +@deftypemethod Short {public byte} byteValue () + +@end deftypemethod +@deftypemethod Short {public short} shortValue () + +@end deftypemethod +@deftypemethod Short {public int} intValue () + +@end deftypemethod +@deftypemethod Short {public long} longValue () + +@end deftypemethod +@deftypemethod Short {public float} floatValue () + +@end deftypemethod +@deftypemethod Short {public double} doubleValue () + +@end deftypemethod +@deftypemethod Short {public static Short} decode (java.lang.String@w{ }@var{str}) @*throws NumberFormatException + +@end deftypemethod +@deftypemethod Short {public static short} parseShort (java.lang.String@w{ }@var{str}, int@w{ }@var{radix}) @*throws NumberFormatException + +@end deftypemethod +@deftypemethod Short {public static short} parseShort (java.lang.String@w{ }@var{str}) @*throws NumberFormatException + +@end deftypemethod +@deftypemethod Short {public static Short} valueOf (java.lang.String@w{ }@var{str}, int@w{ }@var{radix}) @*throws NumberFormatException + +@end deftypemethod +@deftypemethod Short {public static Short} valueOf (java.lang.String@w{ }@var{str}) @*throws NumberFormatException + +@end deftypemethod +@deftypemethod Short {public int} compareTo (java.lang.Short@w{ }@var{anotherShort}) + +@end deftypemethod +@deftypemethod Short {public int} compareTo (java.lang.Object@w{ }@var{o}) @*throws ClassCastException + +@end deftypemethod +@deftypemethod Short {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod Short {public int} hashCode () + +@end deftypemethod +@deftypemethod Short {public String} toString () + +@end deftypemethod +@deftypemethod Short {public static String} toString (short@w{ }@var{value}) + +@end deftypemethod +@deftypemethod String {public static String} copyValueOf (char[]@w{ }@var{data}) + +@end deftypemethod +@deftypemethod String {public static String} copyValueOf (char[]@w{ }@var{data}, int@w{ }@var{offset}, int@w{ }@var{count}) + +@end deftypemethod +@deftypemethod String {public String} toString () + +@end deftypemethod +@deftypemethod String {public native boolean} equals (java.lang.Object@w{ }@var{anObject}) + +@end deftypemethod +@deftypemethod String {public native int} hashCode () + +@end deftypemethod +@deftypemethod String {public int} length () + +@end deftypemethod +@deftypemethod String {public native char} charAt (int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod String {public native void} getChars (int@w{ }@var{srcBegin}, int@w{ }@var{srcEnd}, char[]@w{ }@var{dst}, int@w{ }@var{dstBegin}) + +@end deftypemethod +@deftypemethod String {public byte} getBytes () + +@end deftypemethod +@deftypemethod String {public native byte} getBytes (java.lang.String@w{ }@var{enc}) @*throws UnsupportedEncodingException + +@end deftypemethod +@deftypemethod String {public native void} getBytes (int@w{ }@var{srcBegin}, int@w{ }@var{srcEnd}, byte[]@w{ }@var{dst}, int@w{ }@var{dstBegin}) + +@end deftypemethod +@deftypemethod String {public native char} toCharArray () + +@end deftypemethod +@deftypemethod String {public native boolean} equalsIgnoreCase (java.lang.String@w{ }@var{anotherString}) + +@end deftypemethod +@deftypemethod String {public native int} compareTo (java.lang.String@w{ }@var{anotherString}) + +@end deftypemethod +@deftypemethod String {public int} compareTo (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod String {public int} compareToIgnoreCase (java.lang.String@w{ }@var{str}) + +@end deftypemethod +@deftypemethod String {public native boolean} regionMatches (int@w{ }@var{toffset}, java.lang.String@w{ }@var{other}, int@w{ }@var{ooffset}, int@w{ }@var{len}) + +@end deftypemethod +@deftypemethod String {public native boolean} regionMatches (boolean@w{ }@var{ignoreCase}, int@w{ }@var{toffset}, java.lang.String@w{ }@var{other}, int@w{ }@var{ooffset}, int@w{ }@var{len}) + +@end deftypemethod +@deftypemethod String {public boolean} startsWith (java.lang.String@w{ }@var{prefix}) + +@end deftypemethod +@deftypemethod String {public native boolean} startsWith (java.lang.String@w{ }@var{prefix}, int@w{ }@var{toffset}) + +@end deftypemethod +@deftypemethod String {public boolean} endsWith (java.lang.String@w{ }@var{suffix}) + +@end deftypemethod +@deftypemethod String {public int} indexOf (int@w{ }@var{ch}) + +@end deftypemethod +@deftypemethod String {public native int} indexOf (int@w{ }@var{ch}, int@w{ }@var{fromIndex}) + +@end deftypemethod +@deftypemethod String {public int} indexOf (java.lang.String@w{ }@var{str}) + +@end deftypemethod +@deftypemethod String {public native int} indexOf (java.lang.String@w{ }@var{str}, int@w{ }@var{fromIndex}) + +@end deftypemethod +@deftypemethod String {public int} lastIndexOf (int@w{ }@var{ch}) + +@end deftypemethod +@deftypemethod String {public native int} lastIndexOf (int@w{ }@var{ch}, int@w{ }@var{fromIndex}) + +@end deftypemethod +@deftypemethod String {public int} lastIndexOf (java.lang.String@w{ }@var{str}) + +@end deftypemethod +@deftypemethod String {public int} lastIndexOf (java.lang.String@w{ }@var{str}, int@w{ }@var{fromIndex}) + +@end deftypemethod +@deftypemethod String {public String} substring (int@w{ }@var{beginIndex}) + +@end deftypemethod +@deftypemethod String {public native String} substring (int@w{ }@var{beginIndex}, int@w{ }@var{endIndex}) + +@end deftypemethod +@deftypemethod String {public native String} concat (java.lang.String@w{ }@var{str}) + +@end deftypemethod +@deftypemethod String {public native String} replace (char@w{ }@var{oldChar}, char@w{ }@var{newChar}) + +@end deftypemethod +@deftypemethod String {public native String} toLowerCase (java.util.Locale@w{ }@var{locale}) + +@end deftypemethod +@deftypemethod String {public native String} toUpperCase (java.util.Locale@w{ }@var{locale}) + +@end deftypemethod +@deftypemethod String {public String} toLowerCase () + +@end deftypemethod +@deftypemethod String {public String} toUpperCase () + +@end deftypemethod +@deftypemethod String {public native String} trim () + +@end deftypemethod +@deftypemethod String {public static String} valueOf (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod String {public static String} valueOf (char[]@w{ }@var{data}) + +@end deftypemethod +@deftypemethod String {public static native String} valueOf (char[]@w{ }@var{data}, int@w{ }@var{offset}, int@w{ }@var{count}) + +@end deftypemethod +@deftypemethod String {public static String} valueOf (boolean@w{ }@var{b}) + +@end deftypemethod +@deftypemethod String {public static native String} valueOf (char@w{ }@var{c}) + +@end deftypemethod +@deftypemethod String {public static String} valueOf (int@w{ }@var{i}) + +@end deftypemethod +@deftypemethod String {public static String} valueOf (long@w{ }@var{l}) + +@end deftypemethod +@deftypemethod String {public static String} valueOf (float@w{ }@var{f}) + +@end deftypemethod +@deftypemethod String {public static String} valueOf (double@w{ }@var{d}) + +@end deftypemethod +@deftypemethod String {public native String} intern () + +@end deftypemethod +@deftypemethod StringBuffer {public StringBuffer} append (boolean@w{ }@var{bool}) +Append the @code{String} value of the argument to this @code{StringBuffer}. + Uses @code{String.valueOf()} to convert to + @code{String}. +@end deftypemethod +@deftypemethod StringBuffer {public synchronized StringBuffer} append (char@w{ }@var{ch}) +Append the @code{char} to this @code{StringBuffer}. +@end deftypemethod +@deftypemethod StringBuffer {public StringBuffer} append (int@w{ }@var{inum}) +Append the @code{String} value of the argument to this @code{StringBuffer}. + Uses @code{String.valueOf()} to convert to + @code{String}. +@end deftypemethod +@deftypemethod StringBuffer {public StringBuffer} append (long@w{ }@var{lnum}) +Append the @code{String} value of the argument to this @code{StringBuffer}. + Uses @code{String.valueOf()} to convert to + @code{String}. +@end deftypemethod +@deftypemethod StringBuffer {public StringBuffer} append (float@w{ }@var{fnum}) +Append the @code{String} value of the argument to this @code{StringBuffer}. + Uses @code{String.valueOf()} to convert to + @code{String}. +@end deftypemethod +@deftypemethod StringBuffer {public StringBuffer} append (double@w{ }@var{dnum}) +Append the @code{String} value of the argument to this @code{StringBuffer}. + Uses @code{String.valueOf()} to convert to + @code{String}. +@end deftypemethod +@deftypemethod StringBuffer {public StringBuffer} append (java.lang.Object@w{ }@var{obj}) +Append the @code{String} value of the argument to this @code{StringBuffer}. + Uses @code{String.valueOf()} to convert to + @code{String}. +@end deftypemethod +@deftypemethod StringBuffer {public synchronized StringBuffer} append (java.lang.String@w{ }@var{str}) +Append the @code{String} to this @code{StringBuffer}. +@end deftypemethod +@deftypemethod StringBuffer {public StringBuffer} append (char[]@w{ }@var{data}) +Append the @code{char} array to this @code{StringBuffer}. +@end deftypemethod +@deftypemethod StringBuffer {public synchronized StringBuffer} append (char[]@w{ }@var{data}, int@w{ }@var{offset}, int@w{ }@var{count}) +Append the @code{char} array to this @code{StringBuffer}. +@end deftypemethod +@deftypemethod StringBuffer {public int} capacity () +Get the total number of characters this @code{StringBuffer} + can support before it must be grown. Not to be confused with + <em>length</em>. +@end deftypemethod +@deftypemethod StringBuffer {public synchronized char} charAt (int@w{ }@var{index}) +Get the character at the specified index. +@end deftypemethod +@deftypemethod StringBuffer {public synchronized StringBuffer} delete (int@w{ }@var{start}, int@w{ }@var{end}) +Delete characters from this @code{StringBuffer}. + @code{delete(10, 12)} will delete 10 and 11, but not 12. +@end deftypemethod +@deftypemethod StringBuffer {public StringBuffer} deleteCharAt (int@w{ }@var{index}) +Delete a character from this @code{StringBuffer}. +@end deftypemethod +@deftypemethod StringBuffer {public synchronized void} ensureCapacity (int@w{ }@var{minimumCapacity}) +Increase the capacity of this @code{StringBuffer}. + This will ensure that an expensive growing operation will not occur + until @code{minimumCapacity} is reached. + If the capacity is actually already greater than @code{minimumCapacity} +@end deftypemethod +@deftypemethod StringBuffer {public synchronized void} getChars (int@w{ }@var{srcOffset}, int@w{ }@var{srcEnd}, char[]@w{ }@var{dst}, int@w{ }@var{dstOffset}) +Get the specified array of characters. + The characters will be copied into the array you pass in. +@end deftypemethod +@deftypemethod StringBuffer {public StringBuffer} insert (int@w{ }@var{offset}, boolean@w{ }@var{bool}) +Insert the @code{String} value of the argument into this @code{StringBuffer}. + Uses @code{String.valueOf()} to convert to + @code{String}. +@end deftypemethod +@deftypemethod StringBuffer {public synchronized StringBuffer} insert (int@w{ }@var{offset}, char@w{ }@var{ch}) +Insert the @code{char} argument into this @code{StringBuffer}. +@end deftypemethod +@deftypemethod StringBuffer {public StringBuffer} insert (int@w{ }@var{offset}, int@w{ }@var{inum}) +Insert the @code{String} value of the argument into this @code{StringBuffer}. + Uses @code{String.valueOf()} to convert to + @code{String}. +@end deftypemethod +@deftypemethod StringBuffer {public StringBuffer} insert (int@w{ }@var{offset}, long@w{ }@var{lnum}) +Insert the @code{String} value of the argument into this @code{StringBuffer}. + Uses @code{String.valueOf()} to convert to + @code{String}. +@end deftypemethod +@deftypemethod StringBuffer {public StringBuffer} insert (int@w{ }@var{offset}, float@w{ }@var{fnum}) +Insert the @code{String} value of the argument into this @code{StringBuffer}. + Uses @code{String.valueOf()} to convert to + @code{String}. +@end deftypemethod +@deftypemethod StringBuffer {public StringBuffer} insert (int@w{ }@var{offset}, double@w{ }@var{dnum}) +Insert the @code{String} value of the argument into this @code{StringBuffer}. + Uses @code{String.valueOf()} to convert to + @code{String}. +@end deftypemethod +@deftypemethod StringBuffer {public StringBuffer} insert (int@w{ }@var{offset}, java.lang.Object@w{ }@var{obj}) +Insert the @code{String} value of the argument into this @code{StringBuffer}. + Uses @code{String.valueOf()} to convert to + @code{String}. +@end deftypemethod +@deftypemethod StringBuffer {public synchronized StringBuffer} insert (int@w{ }@var{offset}, java.lang.String@w{ }@var{str}) +Insert the @code{String} argument into this @code{StringBuffer}. +@end deftypemethod +@deftypemethod StringBuffer {public StringBuffer} insert (int@w{ }@var{offset}, char[]@w{ }@var{data}) +Insert the @code{char[]} argument into this + @code{StringBuffer}. +@end deftypemethod +@deftypemethod StringBuffer {public synchronized StringBuffer} insert (int@w{ }@var{offset}, char[]@w{ }@var{str}, int@w{ }@var{str_offset}, int@w{ }@var{len}) +Insert the @code{char[]} argument into this + @code{StringBuffer}. +@end deftypemethod +@deftypemethod StringBuffer {public int} length () +Get the length of the @code{String} this + @code{StringBuffer} would create. Not to be confused with the + <em>capacity</em> of the @code{StringBuffer}. +@end deftypemethod +@deftypemethod StringBuffer {public synchronized StringBuffer} replace (int@w{ }@var{start}, int@w{ }@var{end}, java.lang.String@w{ }@var{str}) +Replace characters between index @code{start} (inclusive) and + @code{end} (exclusive) with @code{str}. If @code{end} + is larger than the size of this StringBuffer, all characters after + @code{start} are replaced. +@end deftypemethod +@deftypemethod StringBuffer {public synchronized StringBuffer} reverse () +Reverse the characters in this StringBuffer. +@end deftypemethod +@deftypemethod StringBuffer {public synchronized void} setCharAt (int@w{ }@var{index}, char@w{ }@var{ch}) +Set the character at the specified index. +@end deftypemethod +@deftypemethod StringBuffer {public synchronized void} setLength (int@w{ }@var{newLength}) +Set the length of this StringBuffer. + + + + If the new length is greater than the current length, all the new + characters are set to '\0'. + + + + If the new length is less than the current length, the first + @code{newLength} characters of the old array will be +@end deftypemethod +@deftypemethod StringBuffer {public String} substring (int@w{ }@var{beginIndex}) +Creates a substring of this StringBuffer, starting at a specified index + and ending at the end of this StringBuffer. +@end deftypemethod +@deftypemethod StringBuffer {public synchronized String} substring (int@w{ }@var{beginIndex}, int@w{ }@var{endIndex}) +Creates a substring of this StringBuffer, starting at a specified index + and ending at one character before a specified index. +@end deftypemethod +@deftypemethod StringBuffer {public String} toString () +Convert this @code{StringBuffer} to a @code{String}. +@end deftypemethod +@deftypemethod System {public static native void} arraycopy (java.lang.Object@w{ }@var{src}, int@w{ }@var{srcOffset}, java.lang.Object@w{ }@var{dst}, int@w{ }@var{dstOffset}, int@w{ }@var{count}) + +@end deftypemethod +@deftypemethod System {public static native long} currentTimeMillis () + +@end deftypemethod +@deftypemethod System {public static void} exit (int@w{ }@var{status}) + +@end deftypemethod +@deftypemethod System {public static void} gc () + +@end deftypemethod +@deftypemethod System {public static String} getenv (java.lang.String@w{ }@var{name}) + +@end deftypemethod +@deftypemethod System {public static Properties} getProperties () + +@end deftypemethod +@deftypemethod System {public static String} getProperty (java.lang.String@w{ }@var{property}) + +@end deftypemethod +@deftypemethod System {public static String} getProperty (java.lang.String@w{ }@var{property}, java.lang.String@w{ }@var{defval}) + +@end deftypemethod +@deftypemethod System {public static SecurityManager} getSecurityManager () + +@end deftypemethod +@deftypemethod System {public static native int} identityHashCode (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod System {public static void} load (java.lang.String@w{ }@var{pathname}) + +@end deftypemethod +@deftypemethod System {public static void} loadLibrary (java.lang.String@w{ }@var{libname}) + +@end deftypemethod +@deftypemethod System {public static void} runFinalization () + +@end deftypemethod +@deftypemethod System {public static void} runFinalizersOnExit (boolean@w{ }@var{run}) + +@end deftypemethod +@deftypemethod System {public static native void} setErr (java.io.PrintStream@w{ }@var{newErr}) + +@end deftypemethod +@deftypemethod System {public static native void} setIn (java.io.InputStream@w{ }@var{newIn}) + +@end deftypemethod +@deftypemethod System {public static native void} setOut (java.io.PrintStream@w{ }@var{newOut}) + +@end deftypemethod +@deftypemethod System {public static void} setProperties (java.util.Properties@w{ }@var{props}) + +@end deftypemethod +@deftypemethod System {public static String} setProperty (java.lang.String@w{ }@var{key}, java.lang.String@w{ }@var{value}) + +@end deftypemethod +@deftypemethod System {public static void} setSecurityManager (java.lang.SecurityManager@w{ }@var{s}) + +@end deftypemethod +@deftypemethod Thread {public static int} activeCount () + +@end deftypemethod +@deftypemethod Thread {public final void} checkAccess () + +@end deftypemethod +@deftypemethod Thread {public native int} countStackFrames () + +@end deftypemethod +@deftypemethod Thread {public static native Thread} currentThread () + +@end deftypemethod +@deftypemethod Thread {public native void} destroy () + +@end deftypemethod +@deftypemethod Thread {public static void} dumpStack () + +@end deftypemethod +@deftypemethod Thread {public static int} enumerate (java.lang.Thread[]@w{ }@var{threads}) + +@end deftypemethod +@deftypemethod Thread {public final String} getName () + +@end deftypemethod +@deftypemethod Thread {public final int} getPriority () + +@end deftypemethod +@deftypemethod Thread {public final ThreadGroup} getThreadGroup () + +@end deftypemethod +@deftypemethod Thread {public native void} interrupt () + +@end deftypemethod +@deftypemethod Thread {public static boolean} interrupted () + +@end deftypemethod +@deftypemethod Thread {public boolean} isInterrupted () + +@end deftypemethod +@deftypemethod Thread {public final boolean} isAlive () + +@end deftypemethod +@deftypemethod Thread {public final boolean} isDaemon () + +@end deftypemethod +@deftypemethod Thread {public final void} join () @*throws InterruptedException + +@end deftypemethod +@deftypemethod Thread {public final void} join (long@w{ }@var{timeout}) @*throws InterruptedException + +@end deftypemethod +@deftypemethod Thread {public final native void} join (long@w{ }@var{timeout}, int@w{ }@var{nanos}) @*throws InterruptedException + +@end deftypemethod +@deftypemethod Thread {public final native void} resume () + +@end deftypemethod +@deftypemethod Thread {public void} run () + +@end deftypemethod +@deftypemethod Thread {public final void} setDaemon (boolean@w{ }@var{status}) + +@end deftypemethod +@deftypemethod Thread {public synchronized ClassLoader} getContextClassLoader () + +@end deftypemethod +@deftypemethod Thread {public synchronized void} setContextClassLoader (java.lang.ClassLoader@w{ }@var{cl}) + +@end deftypemethod +@deftypemethod Thread {public final void} setName (java.lang.String@w{ }@var{n}) + +@end deftypemethod +@deftypemethod Thread {public final native void} setPriority (int@w{ }@var{newPriority}) + +@end deftypemethod +@deftypemethod Thread {public static void} sleep (long@w{ }@var{timeout}) @*throws InterruptedException + +@end deftypemethod +@deftypemethod Thread {public static native void} sleep (long@w{ }@var{timeout}, int@w{ }@var{nanos}) @*throws InterruptedException + +@end deftypemethod +@deftypemethod Thread {public native synchronized void} start () + +@end deftypemethod +@deftypemethod Thread {public final void} stop () + +@end deftypemethod +@deftypemethod Thread {public final native synchronized void} stop (java.lang.Throwable@w{ }@var{e}) + +@end deftypemethod +@deftypemethod Thread {public final native void} suspend () + +@end deftypemethod +@deftypemethod Thread {public String} toString () + +@end deftypemethod +@deftypemethod Thread {public static native void} yield () + +@end deftypemethod +@deftypemethod ThreadGroup {public final String} getName () +Get the name of this ThreadGroup. +@end deftypemethod +@deftypemethod ThreadGroup {public final ThreadGroup} getParent () +Get the parent of this ThreadGroup. +@end deftypemethod +@deftypemethod ThreadGroup {public final synchronized void} setMaxPriority (int@w{ }@var{maxpri}) +Set the maximum priority for Threads in this ThreadGroup. setMaxPriority + can only be used to reduce the current maximum. If maxpri + is greater than the current Maximum, the current value is not changed. + Calling this does not effect threads already in this ThreadGroup. +@end deftypemethod +@deftypemethod ThreadGroup {public final int} getMaxPriority () +Get the maximum priority of Threads in this ThreadGroup. +@end deftypemethod +@deftypemethod ThreadGroup {public final void} setDaemon (boolean@w{ }@var{daemon}) +Set whether this ThreadGroup is a daemon group. A daemon + group will be destroyed when its last thread is stopped and + its last thread group is destroyed. +@end deftypemethod +@deftypemethod ThreadGroup {public final boolean} isDaemon () +Tell whether this ThreadGroup is a daemon group. A daemon + group will be destroyed when its last thread is stopped and + its last thread group is destroyed. +@end deftypemethod +@deftypemethod ThreadGroup {public synchronized boolean} isDestroyed () +Tell whether this ThreadGroup has been destroyed or not. +@end deftypemethod +@deftypemethod ThreadGroup {public final boolean} parentOf (java.lang.ThreadGroup@w{ }@var{tg}) +Check whether this ThreadGroup is an ancestor of the + specified ThreadGroup, or if they are the same. +@end deftypemethod +@deftypemethod ThreadGroup {public synchronized int} activeCount () +Return the total number of active threads in this ThreadGroup + and all its descendants. + + + + This cannot return an exact number, since the status of threads + may change after they were counted. But it should be pretty + close. + + +@end deftypemethod +@deftypemethod ThreadGroup {public synchronized int} activeGroupCount () +Get the number of active groups in this ThreadGroup. This group + itself is not included in the count. +@end deftypemethod +@deftypemethod ThreadGroup {public int} enumerate (java.lang.Thread[]@w{ }@var{threads}) +Copy all of the active Threads from this ThreadGroup and + its descendants into the specified array. If the array is + not big enough to hold all the Threads, extra Threads will + simply not be copied. +@end deftypemethod +@deftypemethod ThreadGroup {public int} enumerate (java.lang.Thread[]@w{ }@var{threads}, boolean@w{ }@var{useDescendants}) +Copy all of the active Threads from this ThreadGroup and, + if desired, from its descendants, into the specified array. + If the array is not big enough to hold all the Threads, + extra Threads will simply not be copied. +@end deftypemethod +@deftypemethod ThreadGroup {public int} enumerate (java.lang.ThreadGroup[]@w{ }@var{groups}) +Copy all active ThreadGroups that are descendants of this + ThreadGroup into the specified array. If the array is not + large enough to hold all active ThreadGroups, extra + ThreadGroups simply will not be copied. +@end deftypemethod +@deftypemethod ThreadGroup {public int} enumerate (java.lang.ThreadGroup[]@w{ }@var{groups}, boolean@w{ }@var{recurse}) +Copy all active ThreadGroups that are children of this + ThreadGroup into the specified array, and if desired, also + copy all active descendants into the array. If the array + is not large enough to hold all active ThreadGroups, extra + ThreadGroups simply will not be copied. +@end deftypemethod +@deftypemethod ThreadGroup {public final synchronized void} interrupt () +Interrupt all Threads in this ThreadGroup and its sub-groups. +@end deftypemethod +@deftypemethod ThreadGroup {public final synchronized void} stop () +Stop all Threads in this ThreadGroup and its descendants. +@end deftypemethod +@deftypemethod ThreadGroup {public final synchronized void} suspend () +Suspend all Threads in this ThreadGroup and its descendants. +@end deftypemethod +@deftypemethod ThreadGroup {public final synchronized void} resume () +Resume all Threads in this ThreadGroup and its descendants. +@end deftypemethod +@deftypemethod ThreadGroup {public final synchronized void} destroy () +Destroy this ThreadGroup. There can be no Threads in it, + and none of its descendants (sub-groups) may have Threads in them. + All its descendants will be destroyed as well. +@end deftypemethod +@deftypemethod ThreadGroup {public void} list () +Print out information about this ThreadGroup to System.out. +@end deftypemethod +@deftypemethod ThreadGroup {public void} uncaughtException (java.lang.Thread@w{ }@var{thread}, java.lang.Throwable@w{ }@var{t}) +When a Thread in this ThreadGroup does not catch an exception, + this method of the ThreadGroup is called. + + + + ThreadGroup's implementation does the following:<BR> + +@itemize @bullet + + +@item +If there is a parent ThreadGroup, call uncaughtException() + in the parent. + + +@item +If the Throwable passed is a ThreadDeath, don't do + anything. + + +@item +Otherwise, call @code{exception.printStackTrace().} + + +@end itemize + +@end deftypemethod +@deftypemethod ThreadGroup {public boolean} allowThreadSuspension (boolean@w{ }@var{allow}) +Tell the VM whether it may suspend Threads in low memory + situations. +@end deftypemethod +@deftypemethod ThreadGroup {public String} toString () +Get a human-readable representation of this ThreadGroup. +@end deftypemethod +@deftypemethod ThreadGroup {public final void} checkAccess () +Find out if the current Thread can modify this ThreadGroup. + Calls the current SecurityManager's checkAccess() method to + find out. If there is none, it assumes everything's OK. +@end deftypemethod +@deftypemethod Throwable {public native Throwable} fillInStackTrace () + +@end deftypemethod +@deftypemethod Throwable {public String} getLocalizedMessage () + +@end deftypemethod +@deftypemethod Throwable {public String} getMessage () + +@end deftypemethod +@deftypemethod Throwable {public void} printStackTrace () + +@end deftypemethod +@deftypemethod Throwable {public void} printStackTrace (java.io.PrintStream@w{ }@var{ps}) + +@end deftypemethod +@deftypemethod Throwable {public void} printStackTrace (java.io.PrintWriter@w{ }@var{wr}) + +@end deftypemethod +@deftypemethod Throwable {public String} toString () + +@end deftypemethod diff --git a/libjava/doc/java-math.texi b/libjava/doc/java-math.texi new file mode 100644 index 00000000000..0b2c4e29a8b --- /dev/null +++ b/libjava/doc/java-math.texi @@ -0,0 +1,206 @@ +@deftypemethod BigDecimal {public static BigDecimal} valueOf (long@w{ }@var{val}) + +@end deftypemethod +@deftypemethod BigDecimal {public static BigDecimal} valueOf (long@w{ }@var{val}, int@w{ }@var{scale}) @*throws NumberFormatException + +@end deftypemethod +@deftypemethod BigDecimal {public BigDecimal} add (java.math.BigDecimal@w{ }@var{val}) + +@end deftypemethod +@deftypemethod BigDecimal {public BigDecimal} subtract (java.math.BigDecimal@w{ }@var{val}) + +@end deftypemethod +@deftypemethod BigDecimal {public BigDecimal} multiply (java.math.BigDecimal@w{ }@var{val}) + +@end deftypemethod +@deftypemethod BigDecimal {public BigDecimal} divide (java.math.BigDecimal@w{ }@var{val}, int@w{ }@var{roundingMode}) @*throws ArithmeticException, IllegalArgumentException + +@end deftypemethod +@deftypemethod BigDecimal {public BigDecimal} divide (java.math.BigDecimal@w{ }@var{val}, int@w{ }@var{newScale}, int@w{ }@var{roundingMode}) @*throws ArithmeticException, IllegalArgumentException + +@end deftypemethod +@deftypemethod BigDecimal {public int} compareTo (java.math.BigDecimal@w{ }@var{val}) + +@end deftypemethod +@deftypemethod BigDecimal {public int} compareTo (java.lang.Object@w{ }@var{val}) + +@end deftypemethod +@deftypemethod BigDecimal {public boolean} equals (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod BigDecimal {public int} hashCode () + +@end deftypemethod +@deftypemethod BigDecimal {public BigDecimal} max (java.math.BigDecimal@w{ }@var{val}) + +@end deftypemethod +@deftypemethod BigDecimal {public BigDecimal} min (java.math.BigDecimal@w{ }@var{val}) + +@end deftypemethod +@deftypemethod BigDecimal {public BigDecimal} movePointLeft (int@w{ }@var{n}) + +@end deftypemethod +@deftypemethod BigDecimal {public BigDecimal} movePointRight (int@w{ }@var{n}) + +@end deftypemethod +@deftypemethod BigDecimal {public int} signum () + +@end deftypemethod +@deftypemethod BigDecimal {public int} scale () + +@end deftypemethod +@deftypemethod BigDecimal {public BigDecimal} abs () + +@end deftypemethod +@deftypemethod BigDecimal {public BigDecimal} negate () + +@end deftypemethod +@deftypemethod BigDecimal {public String} toString () + +@end deftypemethod +@deftypemethod BigDecimal {public BigInteger} toBigInteger () + +@end deftypemethod +@deftypemethod BigDecimal {public int} intValue () + +@end deftypemethod +@deftypemethod BigDecimal {public long} longValue () + +@end deftypemethod +@deftypemethod BigDecimal {public float} floatValue () + +@end deftypemethod +@deftypemethod BigDecimal {public double} doubleValue () + +@end deftypemethod +@deftypemethod BigInteger {public static BigInteger} valueOf (long@w{ }@var{val}) + +@end deftypemethod +@deftypemethod BigInteger {public int} signum () + +@end deftypemethod +@deftypemethod BigInteger {public int} compareTo (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod BigInteger {public int} compareTo (java.math.BigInteger@w{ }@var{val}) + +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} min (java.math.BigInteger@w{ }@var{val}) + +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} max (java.math.BigInteger@w{ }@var{val}) + +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} add (java.math.BigInteger@w{ }@var{val}) + +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} subtract (java.math.BigInteger@w{ }@var{val}) + +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} multiply (java.math.BigInteger@w{ }@var{y}) + +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} divide (java.math.BigInteger@w{ }@var{val}) + +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} remainder (java.math.BigInteger@w{ }@var{val}) + +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} divideAndRemainder (java.math.BigInteger@w{ }@var{val}) + +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} mod (java.math.BigInteger@w{ }@var{m}) + +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} pow (int@w{ }@var{exponent}) +Calculate the integral power of a BigInteger. +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} modInverse (java.math.BigInteger@w{ }@var{y}) + +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} modPow (java.math.BigInteger@w{ }@var{exponent}, java.math.BigInteger@w{ }@var{m}) + +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} gcd (java.math.BigInteger@w{ }@var{y}) + +@end deftypemethod +@deftypemethod BigInteger {public boolean} isProbablePrime (int@w{ }@var{certainty}) + +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} shiftLeft (int@w{ }@var{n}) + +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} shiftRight (int@w{ }@var{n}) + +@end deftypemethod +@deftypemethod BigInteger {public String} toString () + +@end deftypemethod +@deftypemethod BigInteger {public String} toString (int@w{ }@var{radix}) + +@end deftypemethod +@deftypemethod BigInteger {public int} intValue () + +@end deftypemethod +@deftypemethod BigInteger {public long} longValue () + +@end deftypemethod +@deftypemethod BigInteger {public int} hashCode () + +@end deftypemethod +@deftypemethod BigInteger {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod BigInteger {public double} doubleValue () + +@end deftypemethod +@deftypemethod BigInteger {public float} floatValue () + +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} abs () + +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} negate () + +@end deftypemethod +@deftypemethod BigInteger {public int} bitLength () +Calculates ceiling(log2(this < 0 ? -this : this+1)) + See Common Lisp: the Language, 2nd ed, p. 361. +@end deftypemethod +@deftypemethod BigInteger {public byte} toByteArray () + +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} and (java.math.BigInteger@w{ }@var{y}) +Return the logical (bit-wise) "and" of two BigIntegers. +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} or (java.math.BigInteger@w{ }@var{y}) +Return the logical (bit-wise) "(inclusive) or" of two BigIntegers. +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} xor (java.math.BigInteger@w{ }@var{y}) +Return the logical (bit-wise) "exclusive or" of two BigIntegers. +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} not () +Return the logical (bit-wise) negation of a BigInteger. +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} andNot (java.math.BigInteger@w{ }@var{val}) + +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} clearBit (int@w{ }@var{n}) + +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} setBit (int@w{ }@var{n}) + +@end deftypemethod +@deftypemethod BigInteger {public boolean} testBit (int@w{ }@var{n}) + +@end deftypemethod +@deftypemethod BigInteger {public BigInteger} flipBit (int@w{ }@var{n}) + +@end deftypemethod +@deftypemethod BigInteger {public int} getLowestSetBit () + +@end deftypemethod +@deftypemethod BigInteger {public int} bitCount () +Count one bits in a BigInteger. + If argument is negative, count zero bits instead. +@end deftypemethod diff --git a/libjava/doc/java-net.texi b/libjava/doc/java-net.texi new file mode 100644 index 00000000000..0d172b9c690 --- /dev/null +++ b/libjava/doc/java-net.texi @@ -0,0 +1,558 @@ +@deftypemethod ContentHandlerFactory {public ContentHandler} createContentHandler (java.lang.String@w{ }@var{mimetype}) + +@end deftypemethod +@deftypemethod ContentHandler {public abstract Object} getContent (java.net.URLConnection@w{ }@var{urlc}) @*throws IOException + +@end deftypemethod +@deftypemethod DatagramPacket {public synchronized InetAddress} getAddress () + +@end deftypemethod +@deftypemethod DatagramPacket {public synchronized int} getPort () + +@end deftypemethod +@deftypemethod DatagramPacket {public synchronized byte} getData () + +@end deftypemethod +@deftypemethod DatagramPacket {public synchronized int} getOffset () + +@end deftypemethod +@deftypemethod DatagramPacket {public synchronized int} getLength () + +@end deftypemethod +@deftypemethod DatagramPacket {public synchronized void} setAddress (java.net.InetAddress@w{ }@var{iaddr}) + +@end deftypemethod +@deftypemethod DatagramPacket {public synchronized void} setPort (int@w{ }@var{iport}) + +@end deftypemethod +@deftypemethod DatagramPacket {public synchronized void} setData (byte[]@w{ }@var{buf}) + +@end deftypemethod +@deftypemethod DatagramPacket {public synchronized void} setData (byte[]@w{ }@var{buf}, int@w{ }@var{offset}, int@w{ }@var{length}) + +@end deftypemethod +@deftypemethod DatagramPacket {public synchronized void} setLength (int@w{ }@var{length}) + +@end deftypemethod +@deftypemethod DatagramSocketImpl {protected abstract void} bind (int@w{ }@var{lport}, java.net.InetAddress@w{ }@var{laddr}) @*throws SocketException + +@end deftypemethod +@deftypemethod DatagramSocketImpl {protected abstract void} close () + +@end deftypemethod +@deftypemethod DatagramSocketImpl {protected abstract void} create () @*throws SocketException + +@end deftypemethod +@deftypemethod DatagramSocketImpl {protected abstract int} peek (java.net.InetAddress@w{ }@var{i}) @*throws IOException + +@end deftypemethod +@deftypemethod DatagramSocketImpl {protected abstract void} send (java.net.DatagramPacket@w{ }@var{p}) @*throws IOException + +@end deftypemethod +@deftypemethod DatagramSocketImpl {protected abstract void} receive (java.net.DatagramPacket@w{ }@var{p}) @*throws IOException + +@end deftypemethod +@deftypemethod DatagramSocketImpl {protected abstract void} setTTL (byte@w{ }@var{ttl}) @*throws IOException + +@end deftypemethod +@deftypemethod DatagramSocketImpl {protected abstract byte} getTTL () @*throws IOException + +@end deftypemethod +@deftypemethod DatagramSocketImpl {protected abstract void} setTimeToLive (int@w{ }@var{ttl}) @*throws IOException + +@end deftypemethod +@deftypemethod DatagramSocketImpl {protected abstract int} getTimeToLive () @*throws IOException + +@end deftypemethod +@deftypemethod DatagramSocketImpl {protected abstract void} join (java.net.InetAddress@w{ }@var{inetaddr}) @*throws IOException + +@end deftypemethod +@deftypemethod DatagramSocketImpl {protected abstract void} leave (java.net.InetAddress@w{ }@var{inetaddr}) @*throws IOException + +@end deftypemethod +@deftypemethod DatagramSocketImpl {public abstract Object} getOption (int@w{ }@var{optID}) @*throws SocketException + +@end deftypemethod +@deftypemethod DatagramSocketImpl {public abstract void} setOption (int@w{ }@var{optID}, java.lang.Object@w{ }@var{value}) @*throws SocketException + +@end deftypemethod +@deftypemethod DatagramSocketImpl {protected FileDescriptor} getFileDescriptor () + +@end deftypemethod +@deftypemethod DatagramSocketImpl {protected int} getLocalPort () + +@end deftypemethod +@deftypemethod DatagramSocket {public void} close () + +@end deftypemethod +@deftypemethod DatagramSocket {public InetAddress} getLocalAddress () + +@end deftypemethod +@deftypemethod DatagramSocket {public int} getLocalPort () + +@end deftypemethod +@deftypemethod DatagramSocket {public synchronized int} getSoTimeout () @*throws SocketException + +@end deftypemethod +@deftypemethod DatagramSocket {public synchronized void} receive (java.net.DatagramPacket@w{ }@var{p}) @*throws IOException + +@end deftypemethod +@deftypemethod DatagramSocket {public void} send (java.net.DatagramPacket@w{ }@var{p}) @*throws IOException + +@end deftypemethod +@deftypemethod DatagramSocket {public synchronized void} setSoTimeout (int@w{ }@var{timeout}) @*throws SocketException + +@end deftypemethod +@deftypemethod FileNameMap {public String} getContentTypeFor (java.lang.String@w{ }@var{fileName}) + +@end deftypemethod +@deftypemethod HttpURLConnection {public abstract void} disconnect () + +@end deftypemethod +@deftypemethod HttpURLConnection {public abstract boolean} usingProxy () + +@end deftypemethod +@deftypemethod HttpURLConnection {public static void} setFollowRedirects (boolean@w{ }@var{set}) + +@end deftypemethod +@deftypemethod HttpURLConnection {public static boolean} getFollowRedirects () + +@end deftypemethod +@deftypemethod HttpURLConnection {public void} setRequestMethod (java.lang.String@w{ }@var{method}) @*throws ProtocolException + +@end deftypemethod +@deftypemethod HttpURLConnection {public String} getRequestMethod () + +@end deftypemethod +@deftypemethod HttpURLConnection {public int} getResponseCode () @*throws IOException + +@end deftypemethod +@deftypemethod HttpURLConnection {public String} getResponseMessage () @*throws IOException + +@end deftypemethod +@deftypemethod InetAddress {public boolean} isMulticastAddress () + +@end deftypemethod +@deftypemethod InetAddress {public String} getHostName () + +@end deftypemethod +@deftypemethod InetAddress {public byte} getAddress () + +@end deftypemethod +@deftypemethod InetAddress {public String} getHostAddress () + +@end deftypemethod +@deftypemethod InetAddress {public int} hashCode () + +@end deftypemethod +@deftypemethod InetAddress {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod InetAddress {public String} toString () + +@end deftypemethod +@deftypemethod InetAddress {public static InetAddress} getByName (java.lang.String@w{ }@var{host}) @*throws UnknownHostException + +@end deftypemethod +@deftypemethod InetAddress {public static InetAddress} getAllByName (java.lang.String@w{ }@var{host}) @*throws UnknownHostException + +@end deftypemethod +@deftypemethod InetAddress {public static InetAddress} getLocalHost () @*throws UnknownHostException + +@end deftypemethod +@deftypemethod JarURLConnection {public URL} getJarFileURL () + +@end deftypemethod +@deftypemethod JarURLConnection {public String} getEntryName () + +@end deftypemethod +@deftypemethod JarURLConnection {public synchronized void} connect () @*throws IOException + +@end deftypemethod +@deftypemethod JarURLConnection {public InputStream} getInputStream () @*throws IOException + +@end deftypemethod +@deftypemethod JarURLConnection {public JarEntry} getJarEntry () @*throws IOException + +@end deftypemethod +@deftypemethod JarURLConnection {public abstract JarFile} getJarFile () @*throws IOException + +@end deftypemethod +@deftypemethod JarURLConnection {public String} getHeaderField (java.lang.String@w{ }@var{name}) + +@end deftypemethod +@deftypemethod JarURLConnection {public String} getHeaderField (int@w{ }@var{n}) + +@end deftypemethod +@deftypemethod JarURLConnection {public String} getHeaderFieldKey (int@w{ }@var{n}) + +@end deftypemethod +@deftypemethod MulticastSocket {public InetAddress} getInterface () @*throws SocketException + +@end deftypemethod +@deftypemethod MulticastSocket {public byte} getTTL () @*throws IOException + +@end deftypemethod +@deftypemethod MulticastSocket {public int} getTimeToLive () @*throws IOException + +@end deftypemethod +@deftypemethod MulticastSocket {public void} setInterface (java.net.InetAddress@w{ }@var{inf}) @*throws SocketException + +@end deftypemethod +@deftypemethod MulticastSocket {public void} setTTL (byte@w{ }@var{ttl}) @*throws IOException + +@end deftypemethod +@deftypemethod MulticastSocket {public void} setTimeToLive (int@w{ }@var{ttl}) @*throws IOException + +@end deftypemethod +@deftypemethod MulticastSocket {public void} joinGroup (java.net.InetAddress@w{ }@var{mcastaddr}) @*throws IOException + +@end deftypemethod +@deftypemethod MulticastSocket {public void} leaveGroup (java.net.InetAddress@w{ }@var{mcastaddr}) @*throws IOException + +@end deftypemethod +@deftypemethod MulticastSocket {public synchronized void} send (java.net.DatagramPacket@w{ }@var{p}, byte@w{ }@var{ttl}) @*throws IOException + +@end deftypemethod +@deftypemethod ServerSocket {public InetAddress} getInetAddress () + +@end deftypemethod +@deftypemethod ServerSocket {public int} getLocalPort () + +@end deftypemethod +@deftypemethod ServerSocket {public Socket} accept () @*throws IOException + +@end deftypemethod +@deftypemethod ServerSocket {protected final void} implAccept (java.net.Socket@w{ }@var{s}) @*throws IOException + +@end deftypemethod +@deftypemethod ServerSocket {public void} close () @*throws IOException + +@end deftypemethod +@deftypemethod ServerSocket {public synchronized void} setSoTimeout (int@w{ }@var{timeout}) @*throws SocketException + +@end deftypemethod +@deftypemethod ServerSocket {public synchronized int} getSoTimeout () @*throws SocketException + +@end deftypemethod +@deftypemethod ServerSocket {public String} toString () + +@end deftypemethod +@deftypemethod ServerSocket {public static synchronized void} setSocketFactory (java.net.SocketImplFactory@w{ }@var{fac}) @*throws IOException + +@end deftypemethod +@deftypemethod SocketImplFactory {public SocketImpl} createSocketImpl () + +@end deftypemethod +@deftypemethod SocketImpl {protected abstract void} create (boolean@w{ }@var{stream}) @*throws IOException + +@end deftypemethod +@deftypemethod SocketImpl {protected abstract void} connect (java.lang.String@w{ }@var{host}, int@w{ }@var{port}) @*throws IOException + +@end deftypemethod +@deftypemethod SocketImpl {protected abstract void} connect (java.net.InetAddress@w{ }@var{host}, int@w{ }@var{port}) @*throws IOException + +@end deftypemethod +@deftypemethod SocketImpl {protected abstract void} bind (java.net.InetAddress@w{ }@var{host}, int@w{ }@var{port}) @*throws IOException + +@end deftypemethod +@deftypemethod SocketImpl {protected abstract void} listen (int@w{ }@var{backlog}) @*throws IOException + +@end deftypemethod +@deftypemethod SocketImpl {protected abstract void} accept (java.net.SocketImpl@w{ }@var{s}) @*throws IOException + +@end deftypemethod +@deftypemethod SocketImpl {protected abstract InputStream} getInputStream () @*throws IOException + +@end deftypemethod +@deftypemethod SocketImpl {protected abstract OutputStream} getOutputStream () @*throws IOException + +@end deftypemethod +@deftypemethod SocketImpl {protected abstract int} available () @*throws IOException + +@end deftypemethod +@deftypemethod SocketImpl {protected abstract void} close () @*throws IOException + +@end deftypemethod +@deftypemethod SocketImpl {protected FileDescriptor} getFileDescriptor () + +@end deftypemethod +@deftypemethod SocketImpl {protected InetAddress} getInetAddress () + +@end deftypemethod +@deftypemethod SocketImpl {protected int} getPort () + +@end deftypemethod +@deftypemethod SocketImpl {protected int} getLocalPort () + +@end deftypemethod +@deftypemethod SocketImpl {public abstract Object} getOption (int@w{ }@var{optID}) @*throws SocketException + +@end deftypemethod +@deftypemethod SocketImpl {public abstract void} setOption (int@w{ }@var{optID}, java.lang.Object@w{ }@var{value}) @*throws SocketException + +@end deftypemethod +@deftypemethod SocketImpl {public String} toString () + +@end deftypemethod +@deftypemethod Socket {public InetAddress} getInetAddress () + +@end deftypemethod +@deftypemethod Socket {public InetAddress} getLocalAddress () + +@end deftypemethod +@deftypemethod Socket {public int} getPort () + +@end deftypemethod +@deftypemethod Socket {public int} getLocalPort () + +@end deftypemethod +@deftypemethod Socket {public InputStream} getInputStream () @*throws IOException + +@end deftypemethod +@deftypemethod Socket {public OutputStream} getOutputStream () @*throws IOException + +@end deftypemethod +@deftypemethod Socket {public void} setTcpNoDelay (boolean@w{ }@var{on}) @*throws SocketException + +@end deftypemethod +@deftypemethod Socket {public boolean} getTcpNoDelay () @*throws SocketException + +@end deftypemethod +@deftypemethod Socket {public void} setSoLinger (boolean@w{ }@var{on}, int@w{ }@var{linger}) @*throws SocketException + +@end deftypemethod +@deftypemethod Socket {public int} getSoLinger () @*throws SocketException + +@end deftypemethod +@deftypemethod Socket {public synchronized void} setSoTimeout (int@w{ }@var{timeout}) @*throws SocketException + +@end deftypemethod +@deftypemethod Socket {public synchronized int} getSoTimeout () @*throws SocketException + +@end deftypemethod +@deftypemethod Socket {public void} setSendBufferSize (int@w{ }@var{size}) @*throws SocketException + +@end deftypemethod +@deftypemethod Socket {public int} getSendBufferSize () @*throws SocketException + +@end deftypemethod +@deftypemethod Socket {public void} setReceiveBufferSize (int@w{ }@var{size}) @*throws SocketException + +@end deftypemethod +@deftypemethod Socket {public int} getReceiveBufferSize () @*throws SocketException + +@end deftypemethod +@deftypemethod Socket {public synchronized void} close () @*throws IOException + +@end deftypemethod +@deftypemethod Socket {public String} toString () + +@end deftypemethod +@deftypemethod Socket {public static synchronized void} setSocketImplFactory (java.net.SocketImplFactory@w{ }@var{fac}) @*throws IOException + +@end deftypemethod +@deftypemethod SocketOptions {public void} setOption (int@w{ }@var{optID}, java.lang.Object@w{ }@var{value}) @*throws SocketException + +@end deftypemethod +@deftypemethod SocketOptions {public Object} getOption (int@w{ }@var{optID}) @*throws SocketException + +@end deftypemethod +@deftypemethod URLClassLoader {protected void} addURL (java.net.URL@w{ }@var{url}) + +@end deftypemethod +@deftypemethod URLClassLoader {public URL} getURLs () + +@end deftypemethod +@deftypemethod URLClassLoader {public Enumeration} findResources (java.lang.String@w{ }@var{name}) + +@end deftypemethod +@deftypemethod URLClassLoader {public URL} findResource (java.lang.String@w{ }@var{name}) + +@end deftypemethod +@deftypemethod URLClassLoader {protected Class} findClass (java.lang.String@w{ }@var{name}) @*throws ClassNotFoundException + +@end deftypemethod +@deftypemethod URLConnection {public abstract void} connect () @*throws IOException + +@end deftypemethod +@deftypemethod URLConnection {public URL} getURL () + +@end deftypemethod +@deftypemethod URLConnection {public int} getContentLength () + +@end deftypemethod +@deftypemethod URLConnection {public String} getContentType () + +@end deftypemethod +@deftypemethod URLConnection {public String} getContentEncoding () + +@end deftypemethod +@deftypemethod URLConnection {public long} getExpiration () + +@end deftypemethod +@deftypemethod URLConnection {public long} getDate () + +@end deftypemethod +@deftypemethod URLConnection {public long} getLastModified () + +@end deftypemethod +@deftypemethod URLConnection {public String} getHeaderField (int@w{ }@var{n}) + +@end deftypemethod +@deftypemethod URLConnection {public String} getHeaderField (java.lang.String@w{ }@var{name}) + +@end deftypemethod +@deftypemethod URLConnection {public int} getHeaderFieldInt (java.lang.String@w{ }@var{name}, int@w{ }@var{val}) + +@end deftypemethod +@deftypemethod URLConnection {public long} getHeaderFieldDate (java.lang.String@w{ }@var{name}, long@w{ }@var{val}) + +@end deftypemethod +@deftypemethod URLConnection {public String} getHeaderFieldKey (int@w{ }@var{n}) + +@end deftypemethod +@deftypemethod URLConnection {public Object} getContent () @*throws IOException + +@end deftypemethod +@deftypemethod URLConnection {public InputStream} getInputStream () @*throws IOException + +@end deftypemethod +@deftypemethod URLConnection {public OutputStream} getOutputStream () @*throws IOException + +@end deftypemethod +@deftypemethod URLConnection {public String} toString () + +@end deftypemethod +@deftypemethod URLConnection {public void} setDoInput (boolean@w{ }@var{doinput}) + +@end deftypemethod +@deftypemethod URLConnection {public boolean} getDoInput () + +@end deftypemethod +@deftypemethod URLConnection {public void} setDoOutput (boolean@w{ }@var{dooutput}) + +@end deftypemethod +@deftypemethod URLConnection {public boolean} getDoOutput () + +@end deftypemethod +@deftypemethod URLConnection {public void} setAllowUserInteraction (boolean@w{ }@var{allowuserinteraction}) + +@end deftypemethod +@deftypemethod URLConnection {public boolean} getAllowUserInteraction () + +@end deftypemethod +@deftypemethod URLConnection {public static void} setDefaultAllowUserInteraction (boolean@w{ }@var{defaultallowuserinteraction}) + +@end deftypemethod +@deftypemethod URLConnection {public static boolean} getDefaultAllowUserInteraction () + +@end deftypemethod +@deftypemethod URLConnection {public void} setUseCaches (boolean@w{ }@var{usecaches}) + +@end deftypemethod +@deftypemethod URLConnection {public boolean} getUseCaches () + +@end deftypemethod +@deftypemethod URLConnection {public void} setIfModifiedSince (long@w{ }@var{ifmodifiedsince}) + +@end deftypemethod +@deftypemethod URLConnection {public long} getIfModifiedSince () + +@end deftypemethod +@deftypemethod URLConnection {public boolean} getDefaultUseCaches () + +@end deftypemethod +@deftypemethod URLConnection {public void} setDefaultUseCaches (boolean@w{ }@var{defaultusecaches}) + +@end deftypemethod +@deftypemethod URLConnection {public void} setRequestProperty (java.lang.String@w{ }@var{key}, java.lang.String@w{ }@var{value}) + +@end deftypemethod +@deftypemethod URLConnection {public String} getRequestProperty (java.lang.String@w{ }@var{key}) + +@end deftypemethod +@deftypemethod URLConnection {public static void} setDefaultRequestProperty (java.lang.String@w{ }@var{key}, java.lang.String@w{ }@var{value}) + +@end deftypemethod +@deftypemethod URLConnection {public static String} getDefaultRequestProperty (java.lang.String@w{ }@var{key}) + +@end deftypemethod +@deftypemethod URLConnection {public static void} setContentHandlerFactory (java.net.ContentHandlerFactory@w{ }@var{fac}) + +@end deftypemethod +@deftypemethod URLConnection {protected static String} guessContentTypeFromName (java.lang.String@w{ }@var{fname}) + +@end deftypemethod +@deftypemethod URLConnection {public static FileNameMap} getFileNameMap () + +@end deftypemethod +@deftypemethod URLConnection {public static void} setFileNameMap (java.net.FileNameMap@w{ }@var{map}) + +@end deftypemethod +@deftypemethod URLDecoder {public static String} decode (java.lang.String@w{ }@var{s}) @*throws Exception + +@end deftypemethod +@deftypemethod URLEncoder {public static String} encode (java.lang.String@w{ }@var{s}) + +@end deftypemethod +@deftypemethod URL {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod URL {public final Object} getContent () @*throws IOException + +@end deftypemethod +@deftypemethod URL {public String} getFile () + +@end deftypemethod +@deftypemethod URL {public String} getHost () + +@end deftypemethod +@deftypemethod URL {public int} getPort () + +@end deftypemethod +@deftypemethod URL {public String} getProtocol () + +@end deftypemethod +@deftypemethod URL {public String} getRef () + +@end deftypemethod +@deftypemethod URL {public int} hashCode () + +@end deftypemethod +@deftypemethod URL {public URLConnection} openConnection () @*throws IOException + +@end deftypemethod +@deftypemethod URL {public final InputStream} openStream () @*throws IOException + +@end deftypemethod +@deftypemethod URL {public boolean} sameFile (java.net.URL@w{ }@var{other}) + +@end deftypemethod +@deftypemethod URL {protected void} set (java.lang.String@w{ }@var{protocol}, java.lang.String@w{ }@var{host}, int@w{ }@var{port}, java.lang.String@w{ }@var{file}, java.lang.String@w{ }@var{ref}) + +@end deftypemethod +@deftypemethod URL {public static synchronized void} setURLStreamHandlerFactory (java.net.URLStreamHandlerFactory@w{ }@var{fac}) + +@end deftypemethod +@deftypemethod URL {public String} toExternalForm () + +@end deftypemethod +@deftypemethod URL {public String} toString () + +@end deftypemethod +@deftypemethod URLStreamHandlerFactory {public URLStreamHandler} createURLStreamHandler (java.lang.String@w{ }@var{protocol}) + +@end deftypemethod +@deftypemethod URLStreamHandler {protected abstract URLConnection} openConnection (java.net.URL@w{ }@var{u}) @*throws IOException + +@end deftypemethod +@deftypemethod URLStreamHandler {protected void} parseURL (java.net.URL@w{ }@var{u}, java.lang.String@w{ }@var{spec}, int@w{ }@var{start}, int@w{ }@var{limit}) + +@end deftypemethod +@deftypemethod URLStreamHandler {protected void} setURL (java.net.URL@w{ }@var{u}, java.lang.String@w{ }@var{protocol}, java.lang.String@w{ }@var{host}, int@w{ }@var{port}, java.lang.String@w{ }@var{file}, java.lang.String@w{ }@var{ref}) + +@end deftypemethod +@deftypemethod URLStreamHandler {protected String} toExternalForm (java.net.URL@w{ }@var{u}) + +@end deftypemethod diff --git a/libjava/doc/java-security-spec.texi b/libjava/doc/java-security-spec.texi new file mode 100644 index 00000000000..e69de29bb2d --- /dev/null +++ b/libjava/doc/java-security-spec.texi diff --git a/libjava/doc/java-security.texi b/libjava/doc/java-security.texi new file mode 100644 index 00000000000..c1a5da87fe1 --- /dev/null +++ b/libjava/doc/java-security.texi @@ -0,0 +1,354 @@ +@deftypemethod BasicPermission {public boolean} implies (java.security.Permission@w{ }@var{perm}) +This method tests to see if the specified permission is implied by + this permission. This will be true if the following conditions are met: + + + + +@itemize @bullet + + +@item +The specified object is an instance of @code{BasicPermission}, + or a subclass. + +@item +The name of the specified permission is identical to this permission's + name or the name of the specified permission satisfies a wildcard match + on this permission. + +@end itemize + +@end deftypemethod +@deftypemethod BasicPermission {public boolean} equals (java.lang.Object@w{ }@var{obj}) +This method tests to see if this object is equal to the specified + @code{Object}. This will be true if and only if the specified + object meets the following conditions: + + + + +@itemize @bullet + + +@item +It is an instance of @code{BasicPermission}, or a subclass. + +@item +It has the same name as this permission. + +@end itemize + +@end deftypemethod +@deftypemethod BasicPermission {public int} hashCode () +This method returns a hash code for this permission object. The hash + code returned is the value returned by calling the @code{hashCode} + method on the @code{String} that is the name of this permission. +@end deftypemethod +@deftypemethod BasicPermission {public String} getActions () +This method returns a list of the actions associated with this + permission. This method always returns the empty string ("") since + this class ignores actions. +@end deftypemethod +@deftypemethod BasicPermission {public PermissionCollection} newPermissionCollection () +This method returns an instance of @code{PermissionCollection} + suitable for storing @code{BasicPermission} objects. This returns + be a sub class of @code{PermissionCollection} + that allows for an efficient and consistent implementation of + the @code{implies} method. The collection doesn't handle subclasses + of BasicPermission correctly; they must override this method. +@end deftypemethod +@deftypemethod DigestOutputStream {public MessageDigest} getMessageDigest () +Returns the MessageDigest associated with this DigestOutputStream +@end deftypemethod +@deftypemethod DigestOutputStream {public void} setMessageDigest (java.security.MessageDigest@w{ }@var{digest}) +Sets the current MessageDigest to current parameter +@end deftypemethod +@deftypemethod DigestOutputStream {public void} write (int@w{ }@var{b}) @*throws IOException +Updates the hash if the on flag is true and then writes a byte to +the underlying output stream. +@end deftypemethod +@deftypemethod DigestOutputStream {public void} write (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException +Updates the hash if the on flag is true and then writes the bytes +to the underlying output stream. +@end deftypemethod +@deftypemethod DigestOutputStream {public void} on (boolean@w{ }@var{on}) +Sets the flag specifying if this DigestOutputStream updates the +digest in the write() methods. The default is on; +@end deftypemethod +@deftypemethod DigestOutputStream {public String} toString () +Converts the output stream and underlying message digest to a string. +@end deftypemethod +@deftypemethod Guard {public void} checkGuard (java.lang.Object@w{ }@var{obj}) @*throws SecurityException +This method tests whether or not access is allowed to the specified + guarded object. Access is allowed if this method returns silently. If + access is denied, an exception is generated. +@end deftypemethod +@deftypemethod Key {public String} getAlgorithm () + +@end deftypemethod +@deftypemethod Key {public String} getFormat () + +@end deftypemethod +@deftypemethod Key {public byte} getEncoded () + +@end deftypemethod +@deftypemethod KeyPairGenerator {public static KeyPairGenerator} getInstance (java.lang.String@w{ }@var{algorithm}) @*throws NoSuchAlgorithmException + +@end deftypemethod +@deftypemethod KeyPairGenerator {public static KeyPairGenerator} getInstance (java.lang.String@w{ }@var{algorithm}, java.lang.String@w{ }@var{provider}) @*throws NoSuchAlgorithmException, NoSuchProviderException + +@end deftypemethod +@deftypemethod KeyPairGenerator {public String} getAlgorithm () + +@end deftypemethod +@deftypemethod KeyPairGenerator {public abstract void} initialize (int@w{ }@var{strength}, java.security.SecureRandom@w{ }@var{random}) + +@end deftypemethod +@deftypemethod KeyPairGenerator {public abstract KeyPair} generateKeyPair () + +@end deftypemethod +@deftypemethod KeyPairGeneratorSpi {public abstract void} initialize (int@w{ }@var{keysize}, java.security.SecureRandom@w{ }@var{random}) + +@end deftypemethod +@deftypemethod KeyPairGeneratorSpi {public abstract KeyPair} generateKeyPair () + +@end deftypemethod +@deftypemethod KeyPair {public PublicKey} getPublic () + +@end deftypemethod +@deftypemethod KeyPair {public PrivateKey} getPrivate () + +@end deftypemethod +@deftypemethod MessageDigest {public static MessageDigest} getInstance (java.lang.String@w{ }@var{algorithm}) @*throws NoSuchAlgorithmException + +@end deftypemethod +@deftypemethod MessageDigest {public static MessageDigest} getInstance (java.lang.String@w{ }@var{algorithm}, java.lang.String@w{ }@var{provider}) @*throws NoSuchAlgorithmException, NoSuchProviderException + +@end deftypemethod +@deftypemethod MessageDigest {public void} update (byte@w{ }@var{input}) + +@end deftypemethod +@deftypemethod MessageDigest {public void} update (byte[]@w{ }@var{input}, int@w{ }@var{offset}, int@w{ }@var{len}) + +@end deftypemethod +@deftypemethod MessageDigest {public void} update (byte[]@w{ }@var{input}) + +@end deftypemethod +@deftypemethod MessageDigest {public byte} digest () + +@end deftypemethod +@deftypemethod MessageDigest {public byte} digest (byte[]@w{ }@var{input}) + +@end deftypemethod +@deftypemethod MessageDigest {public String} toString () + +@end deftypemethod +@deftypemethod MessageDigest {public static boolean} isEqual (byte[]@w{ }@var{digesta}, byte[]@w{ }@var{digestb}) + +@end deftypemethod +@deftypemethod MessageDigest {public void} reset () + +@end deftypemethod +@deftypemethod MessageDigest {public final String} getAlgorithm () + +@end deftypemethod +@deftypemethod MessageDigest {protected abstract void} engineUpdate (byte@w{ }@var{input}) + +@end deftypemethod +@deftypemethod MessageDigest {protected abstract void} engineUpdate (byte[]@w{ }@var{input}, int@w{ }@var{offset}, int@w{ }@var{len}) + +@end deftypemethod +@deftypemethod MessageDigest {protected abstract byte} engineDigest () + +@end deftypemethod +@deftypemethod MessageDigest {protected abstract void} engineReset () + +@end deftypemethod +@deftypemethod MessageDigest {public Object} clone () @*throws CloneNotSupportedException + +@end deftypemethod +@deftypemethod PermissionCollection {public boolean} isReadOnly () +This method tests whether or not this @code{PermissionCollection} + object is read only. +@end deftypemethod +@deftypemethod PermissionCollection {public void} setReadOnly () +This method sets this @code{PermissionCollection} object to be + read only. No further permissions can be added to it after calling this + method. +@end deftypemethod +@deftypemethod PermissionCollection {public abstract void} add (java.security.Permission@w{ }@var{perm}) @*throws SecurityException, IllegalArgumentException +This method adds a new @code{Permission} object to the collection. +@end deftypemethod +@deftypemethod PermissionCollection {public abstract Enumeration} elements () +This method returns an @code{Enumeration} of all the objects in + this collection. +@end deftypemethod +@deftypemethod PermissionCollection {public abstract boolean} implies (java.security.Permission@w{ }@var{perm}) +This method tests whether the specified @code{Permission} object is + implied by this collection of @code{Permission} objects. +@end deftypemethod +@deftypemethod PermissionCollection {public String} toString () +This method returns a @code{String} representation of this + collection. It will print the class name and has code in the same + manner as @code{Object.toString()} then print a listing of all + the @code{Permission} objects contained. +@end deftypemethod +@deftypemethod Permission {public String} getName () +This method returns the name of this @code{Permission} +@end deftypemethod +@deftypemethod Permission {public abstract String} getActions () +This method returns the list of actions for this @code{Permission} + as a @code{String}. +@end deftypemethod +@deftypemethod Permission {public void} checkGuard (java.lang.Object@w{ }@var{obj}) @*throws SecurityException +This method implements the @code{Guard} interface for this class. + It calls the @code{checkPermission} method in + @code{SecurityManager} with this @code{Permission} as its + argument. This method returns silently if the security check succeeds + or throws an exception if it fails. +@end deftypemethod +@deftypemethod Permission {public abstract boolean} implies (java.security.Permission@w{ }@var{perm}) +This method tests whether this @code{Permission} implies that the + specified @code{Permission} is also granted. +@end deftypemethod +@deftypemethod Permission {public abstract int} hashCode () +This method returns a hash code for this @code{Permission}. +@end deftypemethod +@deftypemethod Permission {public String} toString () +This method returns a @code{String} representation of this + @code{Permission} object. +@end deftypemethod +@deftypemethod Permission {public PermissionCollection} newPermissionCollection () +This method returns an empty @code{PermissionCollection} object + that can store permissions of this type, or @code{null} if no + such collection is defined. +@end deftypemethod +@deftypemethod Principal {public String} getName () +This method returns a @code{String} that names this + @code{Principal}. +@end deftypemethod +@deftypemethod Principal {public boolean} equals (java.lang.Object@w{ }@var{obj}) +This method tests another @code{Principal} object for equality + with this one. +@end deftypemethod +@deftypemethod Principal {public int} hashCode () +This method returns a hash code value for this @code{Principal}. +@end deftypemethod +@deftypemethod Principal {public String} toString () +This method returns a @code{String} representation of this + @code{Principal}. +@end deftypemethod +@deftypemethod Provider {public String} getName () +This method returns the name assigned to this @code{Provider}. +@end deftypemethod +@deftypemethod Provider {public double} getVersion () +This method retunrs the version number of this @code{Provider}. +@end deftypemethod +@deftypemethod Provider {public String} getInfo () +This method returns a textual description of the @code{Provider}. +@end deftypemethod +@deftypemethod Provider {public Object} put (java.lang.Object@w{ }@var{key}, java.lang.Object@w{ }@var{value}) +This method sets the specified key to have the specified value. +@end deftypemethod +@deftypemethod Provider {public Object} remove (java.lang.Object@w{ }@var{key}) +This method removes the specified key entry (and its associated value) + from the property mapping list. +@end deftypemethod +@deftypemethod Provider {public void} clear () +This method clears the entire property list such that it no longer + contains the properties used to look up the services provided by + the @code{Provider}. +@end deftypemethod +@deftypemethod Provider {public String} toString () +This method returns a @code{String} representation of this + object. This will include the @code{Provider} name and + version number. +@end deftypemethod +@deftypemethod Security {public static int} insertProviderAt (java.security.Provider@w{ }@var{provider}, int@w{ }@var{position}) + +@end deftypemethod +@deftypemethod Security {public static int} addProvider (java.security.Provider@w{ }@var{provider}) + +@end deftypemethod +@deftypemethod Security {public static void} removeProvider (java.lang.String@w{ }@var{name}) + +@end deftypemethod +@deftypemethod Security {public static Provider} getProviders () + +@end deftypemethod +@deftypemethod Security {public static Provider} getProvider (java.lang.String@w{ }@var{name}) + +@end deftypemethod +@deftypemethod Security {public static String} getProperty (java.lang.String@w{ }@var{key}) + +@end deftypemethod +@deftypemethod Security {public static void} setProperty (java.lang.String@w{ }@var{key}, java.lang.String@w{ }@var{value}) + +@end deftypemethod +@deftypemethod Signature {public static Signature} getInstance (java.lang.String@w{ }@var{algorithm}) @*throws NoSuchAlgorithmException + +@end deftypemethod +@deftypemethod Signature {public static Signature} getInstance (java.lang.String@w{ }@var{algorithm}, java.lang.String@w{ }@var{provider}) @*throws NoSuchAlgorithmException, NoSuchProviderException + +@end deftypemethod +@deftypemethod Signature {public final void} initVerify (java.security.PublicKey@w{ }@var{publicKey}) @*throws InvalidKeyException + +@end deftypemethod +@deftypemethod Signature {public final void} initSign (java.security.PrivateKey@w{ }@var{privateKey}) @*throws InvalidKeyException + +@end deftypemethod +@deftypemethod Signature {public final byte} sign () @*throws SignatureException + +@end deftypemethod +@deftypemethod Signature {public final boolean} verify (byte[]@w{ }@var{signature}) @*throws SignatureException + +@end deftypemethod +@deftypemethod Signature {public final void} update (byte@w{ }@var{b}) @*throws SignatureException + +@end deftypemethod +@deftypemethod Signature {public final void} update (byte[]@w{ }@var{data}) @*throws SignatureException + +@end deftypemethod +@deftypemethod Signature {public final void} update (byte[]@w{ }@var{data}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws SignatureException + +@end deftypemethod +@deftypemethod Signature {public final String} getAlgorithm () + +@end deftypemethod +@deftypemethod Signature {public String} toString () + +@end deftypemethod +@deftypemethod Signature {public final void} setParameter (java.lang.String@w{ }@var{param}, java.lang.Object@w{ }@var{value}) @*throws InvalidParameterException + +@end deftypemethod +@deftypemethod Signature {public final Object} getParameter (java.lang.String@w{ }@var{param}) @*throws InvalidParameterException + +@end deftypemethod +@deftypemethod Signature {protected abstract void} engineInitVerify (java.security.PublicKey@w{ }@var{publicKey}) @*throws InvalidKeyException + +@end deftypemethod +@deftypemethod Signature {protected abstract void} engineInitSign (java.security.PrivateKey@w{ }@var{privateKey}) @*throws InvalidKeyException + +@end deftypemethod +@deftypemethod Signature {protected abstract void} engineUpdate (byte@w{ }@var{b}) @*throws SignatureException + +@end deftypemethod +@deftypemethod Signature {protected abstract void} engineUpdate (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws SignatureException + +@end deftypemethod +@deftypemethod Signature {protected abstract byte} engineSign () @*throws SignatureException + +@end deftypemethod +@deftypemethod Signature {protected abstract boolean} engineVerify (byte[]@w{ }@var{sigBytes}) @*throws SignatureException + +@end deftypemethod +@deftypemethod Signature {protected abstract void} engineSetParameter (java.lang.String@w{ }@var{param}, java.lang.Object@w{ }@var{value}) @*throws InvalidParameterException + +@end deftypemethod +@deftypemethod Signature {protected abstract Object} engineGetParameter (java.lang.String@w{ }@var{param}) @*throws InvalidParameterException + +@end deftypemethod +@deftypemethod Signature {public Object} clone () @*throws CloneNotSupportedException + +@end deftypemethod diff --git a/libjava/doc/java-sql.texi b/libjava/doc/java-sql.texi new file mode 100644 index 00000000000..b522ff7127c --- /dev/null +++ b/libjava/doc/java-sql.texi @@ -0,0 +1,2892 @@ +@deftypemethod Array {public String} getBaseTypeName () @*throws SQLException +This method returns the name of the SQL type of the elements in this + array. This name is database specific. +@end deftypemethod +@deftypemethod Array {public int} getBaseType () @*throws SQLException +This method returns the JDBC type identifier of the elements in this + array. This will be one of the values defined in the @code{Types} + class. +@end deftypemethod +@deftypemethod Array {public Object} getArray () @*throws SQLException +This method returns the contents of this array. This object returned + will be an array of Java objects of the appropriate types. +@end deftypemethod +@deftypemethod Array {public Object} getArray (java.util.Map@w{ }@var{map}) @*throws SQLException +This method returns the contents of this array. The specified + @code{Map} will be used to override selected mappings between + SQL types and Java classes. +@end deftypemethod +@deftypemethod Array {public Object} getArray (long@w{ }@var{offset}, int@w{ }@var{count}) @*throws SQLException +This method returns a portion of this array starting at index + @code{offset} into the array and continuing for @code{length} + elements. Fewer than the requested number of elements will be + returned if the array does not contain the requested number of elements. + The object returned will be an array of Java objects of + the appropriate types. +@end deftypemethod +@deftypemethod Array {public Object} getArray (long@w{ }@var{index}, int@w{ }@var{count}, java.util.Map@w{ }@var{map}) @*throws SQLException +This method returns a portion of this array starting at index + @code{offset} into the array and continuing for @code{length} + elements. Fewer than the requested number of elements will be + returned if the array does not contain the requested number of elements. + The object returned will be an array of Java objects. The specified + @code{Map} will be used for overriding selected SQL type to + Java class mappings. +@end deftypemethod +@deftypemethod Array {public ResultSet} getResultSet () @*throws SQLException +This method returns the elements in the array as a @code{ResultSet}. + Each row of the result set will have two columns. The first will be + the index into the array of that row's contents. The second will be + the actual value of that array element. +@end deftypemethod +@deftypemethod Array {public ResultSet} getResultSet (java.util.Map@w{ }@var{map}) @*throws SQLException +This method returns the elements in the array as a @code{ResultSet}. + Each row of the result set will have two columns. The first will be + the index into the array of that row's contents. The second will be + the actual value of that array element. The specified @code{Map} + will be used to override selected default mappings of SQL types to + Java classes. +@end deftypemethod +@deftypemethod Array {public ResultSet} getResultSet (long@w{ }@var{index}, int@w{ }@var{count}) @*throws SQLException +This method returns a portion of the array as a @code{ResultSet}. + The returned portion will start at index @code{offset} into the + array and up to @code{length} elements will be returned. + + + + Each row of the result set will have two columns. The first will be + the index into the array of that row's contents. The second will be + the actual value of that array element. +@end deftypemethod +@deftypemethod Array {public ResultSet} getResultSet (long@w{ }@var{index}, int@w{ }@var{count}, java.util.Map@w{ }@var{map}) @*throws SQLException +This method returns a portion of the array as a @code{ResultSet}. + The returned portion will start at index @code{offset} into the + array and up to @code{length} elements will be returned. + + + + Each row of the result set will have two columns. The first will be + the index into the array of that row's contents. The second will be + the actual value of that array element. The specified @code{Map} + will be used to override selected default mappings of SQL types to + Java classes. +@end deftypemethod +@deftypemethod BatchUpdateException {public int} getUpdateCounts () +This method returns the update count information for this error. If + not @code{null} this is an array of @code{int}'s that are + the update accounts for each command that was successfully executed. + The array elements are in the order that the commands were executed. +@end deftypemethod +@deftypemethod Blob {public long} length () @*throws SQLException +This method returns the number of bytes in the BLOB. +@end deftypemethod +@deftypemethod Blob {public byte} getBytes (long@w{ }@var{offset}, int@w{ }@var{length}) @*throws SQLException +This method returns up to the requested bytes of this BLOB as a + @code{byte} array. +@end deftypemethod +@deftypemethod Blob {public InputStream} getBinaryStream () @*throws SQLException +This method returns a stream that will read the bytes of the BLOB. +@end deftypemethod +@deftypemethod Blob {public long} position (byte[]@w{ }@var{pattern}, long@w{ }@var{offset}) @*throws SQLException +This method returns the index into the BLOB at which the first instance + of the specified bytes occur. The searching starts at the specified + index into the BLOB. +@end deftypemethod +@deftypemethod Blob {public long} position (java.sql.Blob@w{ }@var{pattern}, long@w{ }@var{offset}) @*throws SQLException +This method returns the index into the BLOB at which the first instance + of the specified pattern occurs. The searching starts at the specified + index into this BLOB. The bytes in the specified @code{Blob} are + used as the search pattern. +@end deftypemethod +@deftypemethod CallableStatement {public boolean} wasNull () @*throws SQLException +This method tests whether the value of the last parameter that was fetched + was actually a SQL NULL value. +@end deftypemethod +@deftypemethod CallableStatement {public String} getString (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified parameter as a Java + @code{String}. +@end deftypemethod +@deftypemethod CallableStatement {public Object} getObject (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified parameter as a Java + @code{Object}. +@end deftypemethod +@deftypemethod CallableStatement {public Object} getObject (int@w{ }@var{index}, java.util.Map@w{ }@var{map}) @*throws SQLException +This method returns the value of the specified parameter as a Java + @code{Object}. +@end deftypemethod +@deftypemethod CallableStatement {public boolean} getBoolean (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified parameter as a Java + @code{boolean}. +@end deftypemethod +@deftypemethod CallableStatement {public byte} getByte (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified parameter as a Java + @code{byte}. +@end deftypemethod +@deftypemethod CallableStatement {public short} getShort (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified parameter as a Java + @code{short}. +@end deftypemethod +@deftypemethod CallableStatement {public int} getInt (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified parameter as a Java + @code{int}. +@end deftypemethod +@deftypemethod CallableStatement {public long} getLong (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified parameter as a Java + @code{long}. +@end deftypemethod +@deftypemethod CallableStatement {public float} getFloat (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified parameter as a Java + @code{float}. +@end deftypemethod +@deftypemethod CallableStatement {public double} getDouble (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified parameter as a Java + @code{double}. +@end deftypemethod +@deftypemethod CallableStatement {public BigDecimal} getBigDecimal (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified parameter as a Java + @code{BigDecimal}. +@end deftypemethod +@deftypemethod CallableStatement {public BigDecimal} getBigDecimal (int@w{ }@var{index}, int@w{ }@var{scale}) @*throws SQLException +This method returns the value of the specified parameter as a Java + @code{BigDecimal}. +@end deftypemethod +@deftypemethod CallableStatement {public byte} getBytes (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified parameter as a Java + byte array. +@end deftypemethod +@deftypemethod CallableStatement {public Date} getDate (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified parameter as a Java + @code{java.sql.Date}. +@end deftypemethod +@deftypemethod CallableStatement {public Date} getDate (int@w{ }@var{index}, java.util.Calendar@w{ }@var{calendar}) @*throws SQLException +This method returns the value of the specified parameter as a Java + @code{java.sql.Date}. +@end deftypemethod +@deftypemethod CallableStatement {public Time} getTime (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified parameter as a Java + @code{java.sql.Time}. +@end deftypemethod +@deftypemethod CallableStatement {public Time} getTime (int@w{ }@var{index}, java.util.Calendar@w{ }@var{calendar}) @*throws SQLException +This method returns the value of the specified parameter as a Java + @code{java.sql.Time}. +@end deftypemethod +@deftypemethod CallableStatement {public Timestamp} getTimestamp (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified parameter as a Java + @code{java.sql.Timestamp}. +@end deftypemethod +@deftypemethod CallableStatement {public Timestamp} getTimestamp (int@w{ }@var{index}, java.util.Calendar@w{ }@var{calendar}) @*throws SQLException +This method returns the value of the specified parameter as a Java + @code{java.sql.Timestamp}. +@end deftypemethod +@deftypemethod CallableStatement {public Ref} getRef (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified parameter as a Java + @code{Ref}. +@end deftypemethod +@deftypemethod CallableStatement {public Blob} getBlob (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified parameter as a Java + @code{Blob}. +@end deftypemethod +@deftypemethod CallableStatement {public Clob} getClob (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified parameter as a Java + @code{Clob}. +@end deftypemethod +@deftypemethod CallableStatement {public Array} getArray (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified parameter as a Java + @code{Array}. +@end deftypemethod +@deftypemethod CallableStatement {public void} registerOutParameter (int@w{ }@var{index}, int@w{ }@var{type}) @*throws SQLException +This method registers the specified parameter as an output parameter + of the specified SQL type. +@end deftypemethod +@deftypemethod CallableStatement {public void} registerOutParameter (int@w{ }@var{index}, int@w{ }@var{type}, java.lang.String@w{ }@var{name}) @*throws SQLException +This method registers the specified parameter as an output parameter + of the specified SQL type. +@end deftypemethod +@deftypemethod CallableStatement {public void} registerOutParameter (int@w{ }@var{index}, int@w{ }@var{type}, int@w{ }@var{scale}) @*throws SQLException +This method registers the specified parameter as an output parameter + of the specified SQL type and scale. +@end deftypemethod +@deftypemethod Clob {public long} length () @*throws SQLException +This method returns the number of characters in the CLOB. +@end deftypemethod +@deftypemethod Clob {public String} getSubString (long@w{ }@var{offset}, int@w{ }@var{length}) @*throws SQLException +This method returns the specified portion of the CLOB as a + @code{String}. +@end deftypemethod +@deftypemethod Clob {public InputStream} getAsciiStream () @*throws SQLException +This method returns a byte stream that reads the contents of the + CLOB as a series of ASCII bytes. +@end deftypemethod +@deftypemethod Clob {public Reader} getCharacterStream () @*throws SQLException +This method returns a character stream that reads the contents of the + CLOB. +@end deftypemethod +@deftypemethod Clob {public long} position (java.lang.String@w{ }@var{pattern}, long@w{ }@var{offset}) @*throws SQLException +This method returns the index into the CLOB of the first occurrence of + the specified character pattern (supplied by the caller as a + @code{String}). The search begins at the specified index. +@end deftypemethod +@deftypemethod Clob {public long} position (java.sql.Clob@w{ }@var{pattern}, long@w{ }@var{offset}) @*throws SQLException +This method returns the index into the CLOB of the first occurrence of + the specified character pattern (supplied by the caller as a + @code{Clob}). The search begins at the specified index. +@end deftypemethod +@deftypemethod Connection {public Statement} createStatement () @*throws SQLException +This method creates a new SQL statement. The default result set type + and concurrency will be used. +@end deftypemethod +@deftypemethod Connection {public Statement} createStatement (int@w{ }@var{resultSetType}, int@w{ }@var{resultSetConcurrency}) @*throws SQLException +This method creates a new SQL statement with the specified type and + concurrency. Valid values for these parameters are specified in the + @code{ResultSet} class. +@end deftypemethod +@deftypemethod Connection {public PreparedStatement} prepareStatement (java.lang.String@w{ }@var{sql}) @*throws SQLException +This method creates a new @code{PreparedStatement} for the specified + SQL string. This method is designed for use with parameterized + statements. The default result set type and concurrency will be used. +@end deftypemethod +@deftypemethod Connection {public PreparedStatement} prepareStatement (java.lang.String@w{ }@var{sql}, int@w{ }@var{resultSetType}, int@w{ }@var{resultSetConcurrency}) @*throws SQLException +This method creates a new @code{PreparedStatement} for the specified + SQL string. This method is designed for use with parameterized + statements. The specified result set type and concurrency will be used. + Valid values for these parameters are specified in the + @code{ResultSet} class. +@end deftypemethod +@deftypemethod Connection {public CallableStatement} prepareCall (java.lang.String@w{ }@var{sql}) @*throws SQLException +This method creates a new @code{CallableStatement} for the + specified SQL string. Thie method is designed to be used with + stored procedures. The default result set type and concurrency + will be used. +@end deftypemethod +@deftypemethod Connection {public CallableStatement} prepareCall (java.lang.String@w{ }@var{sql}, int@w{ }@var{resultSetType}, int@w{ }@var{resultSetConcurrency}) @*throws SQLException +This method creates a new @code{CallableStatement} for the + specified SQL string. Thie method is designed to be used with + stored procedures. The specified result set type and concurrency + will be used. Valid values for these parameters are specified in the + @code{ResultSet} class. +@end deftypemethod +@deftypemethod Connection {public String} nativeSQL (java.lang.String@w{ }@var{sql}) @*throws SQLException +This method converts the specified generic SQL statement into the + native grammer of the database this object is connected to. +@end deftypemethod +@deftypemethod Connection {public boolean} getAutoCommit () @*throws SQLException +This method tests whether or not auto commit mode is currently enabled. + In auto commit mode, every SQL statement is committed its own transaction. + Otherwise a transaction must be explicitly committed or rolled back. +@end deftypemethod +@deftypemethod Connection {public void} setAutoCommit (boolean@w{ }@var{autoCommit}) @*throws SQLException +This method turns auto commit mode on or off. In auto commit mode, + every SQL statement is committed its own transaction. Otherwise a + transaction must be explicitly committed or rolled back. +@end deftypemethod +@deftypemethod Connection {public void} commit () @*throws SQLException +This method commits any SQL statements executed on this connection since + the last commit or rollback. +@end deftypemethod +@deftypemethod Connection {public void} rollback () @*throws SQLException +This method rolls back any SQL statements executed on this connection + since the last commit or rollback. +@end deftypemethod +@deftypemethod Connection {public void} close () @*throws SQLException +This method immediately closes this database connection. +@end deftypemethod +@deftypemethod Connection {public boolean} isClosed () @*throws SQLException +This method tests whether or not this connection has been closed. +@end deftypemethod +@deftypemethod Connection {public DatabaseMetaData} getMetaData () @*throws SQLException +This method returns the meta data for this database connection. +@end deftypemethod +@deftypemethod Connection {public boolean} isReadOnly () @*throws SQLException +This method tests whether or not this connection is in read only mode. +@end deftypemethod +@deftypemethod Connection {public void} setReadOnly (boolean@w{ }@var{readOnly}) @*throws SQLException +This method turns read only mode on or off. It may not be called while + a transaction is in progress. +@end deftypemethod +@deftypemethod Connection {public String} getCatalog () @*throws SQLException +This method returns the name of the catalog in use by this connection, + if any. +@end deftypemethod +@deftypemethod Connection {public void} setCatalog (java.lang.String@w{ }@var{catalog}) @*throws SQLException +This method sets the name of the catalog in use by this connection. + Note that this method does nothing if catalogs are not supported by + this database. +@end deftypemethod +@deftypemethod Connection {public int} getTransactionIsolation () @*throws SQLException +This method returns the current transaction isolation mode. This will + be one of the constants defined in this interface. +@end deftypemethod +@deftypemethod Connection {public void} setTransactionIsolation (int@w{ }@var{level}) @*throws SQLException +This method sets the current transaction isolation mode. This must + be one of the constants defined in this interface. +@end deftypemethod +@deftypemethod Connection {public SQLWarning} getWarnings () @*throws SQLException +This method returns the first warning that occurred on this connection, + if any. If there were any subsequence warnings, they will be chained + to the first one. +@end deftypemethod +@deftypemethod Connection {public void} clearWarnings () @*throws SQLException +This method clears all warnings that have occurred on this connection. +@end deftypemethod +@deftypemethod Connection {public Map} getTypeMap () @*throws SQLException +This method returns the mapping of SQL types to Java classes + currently in use by this connection. This mapping will have no + entries unless they have been manually added. +@end deftypemethod +@deftypemethod Connection {public void} setTypeMap (java.util.Map@w{ }@var{map}) @*throws SQLException +This method sets the mapping table for SQL types to Java classes. + Any entries in this map override the defaults. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} allProceduresAreCallable () @*throws SQLException +This method tests whether or not all the procedures returned by + the @code{getProcedures} method can be called by this user. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} allTablesAreSelectable () @*throws SQLException +This method tests whether or not all the table returned by the + @code{getTables} method can be selected by this user. +@end deftypemethod +@deftypemethod DatabaseMetaData {public String} getURL () @*throws SQLException +This method returns the URL for this database. +@end deftypemethod +@deftypemethod DatabaseMetaData {public String} getUserName () @*throws SQLException +This method returns the database username for this connection. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} isReadOnly () @*throws SQLException +This method tests whether or not the database is in read only mode. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} nullsAreSortedHigh () @*throws SQLException +This method tests whether or not NULL's sort as high values. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} nullsAreSortedLow () @*throws SQLException +This method tests whether or not NULL's sort as low values. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} nullsAreSortedAtStart () @*throws SQLException +This method test whether or not NULL's are sorted to the beginning + of the list regardless of ascending or descending sort order. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} nullsAreSortedAtEnd () @*throws SQLException +This method test whether or not NULL's are sorted to the end + of the list regardless of ascending or descending sort order. +@end deftypemethod +@deftypemethod DatabaseMetaData {public String} getDatabaseProductName () @*throws SQLException +This method returns the name of the database product. +@end deftypemethod +@deftypemethod DatabaseMetaData {public String} getDatabaseProductVersion () @*throws SQLException +This method returns the version of the database product. +@end deftypemethod +@deftypemethod DatabaseMetaData {public String} getDriverName () @*throws SQLException +This method returns the name of the JDBC driver. +@end deftypemethod +@deftypemethod DatabaseMetaData {public String} getDriverVersion () @*throws SQLException +This method returns the version of the JDBC driver. +@end deftypemethod +@deftypemethod DatabaseMetaData {public int} getDriverMajorVersion () +This method returns the major version number of the JDBC driver. +@end deftypemethod +@deftypemethod DatabaseMetaData {public int} getDriverMinorVersion () +This method returns the minor version number of the JDBC driver. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} usesLocalFiles () @*throws SQLException +This method tests whether or not the database uses local files to + store tables. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} usesLocalFilePerTable () @*throws SQLException +This method tests whether or not the database uses a separate file for + each table. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsMixedCaseIdentifiers () @*throws SQLException +This method tests whether or not the database supports identifiers + with mixed case. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} storesUpperCaseIdentifiers () @*throws SQLException +This method tests whether or not the database treats mixed case + identifiers as all upper case. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} storesLowerCaseIdentifiers () @*throws SQLException +This method tests whether or not the database treats mixed case + identifiers as all lower case. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} storesMixedCaseIdentifiers () @*throws SQLException +This method tests whether or not the database stores mixed case + identifers even if it treats them as case insensitive. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsMixedCaseQuotedIdentifiers () @*throws SQLException +This method tests whether or not the database supports quoted identifiers + with mixed case. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} storesUpperCaseQuotedIdentifiers () @*throws SQLException +This method tests whether or not the database treats mixed case + quoted identifiers as all upper case. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} storesLowerCaseQuotedIdentifiers () @*throws SQLException +This method tests whether or not the database treats mixed case + quoted identifiers as all lower case. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} storesMixedCaseQuotedIdentifiers () @*throws SQLException +This method tests whether or not the database stores mixed case + quoted identifers even if it treats them as case insensitive. +@end deftypemethod +@deftypemethod DatabaseMetaData {public String} getIdentifierQuoteString () @*throws SQLException +This metohd returns the quote string for SQL identifiers. +@end deftypemethod +@deftypemethod DatabaseMetaData {public String} getSQLKeywords () @*throws SQLException +This method returns a comma separated list of all the SQL keywords in + the database that are not in SQL92. +@end deftypemethod +@deftypemethod DatabaseMetaData {public String} getNumericFunctions () @*throws SQLException +This method returns a comma separated list of math functions. +@end deftypemethod +@deftypemethod DatabaseMetaData {public String} getStringFunctions () @*throws SQLException +This method returns a comma separated list of string functions. +@end deftypemethod +@deftypemethod DatabaseMetaData {public String} getSystemFunctions () @*throws SQLException +This method returns a comma separated list of of system functions. +@end deftypemethod +@deftypemethod DatabaseMetaData {public String} getTimeDateFunctions () @*throws SQLException +This method returns comma separated list of time/date functions. +@end deftypemethod +@deftypemethod DatabaseMetaData {public String} getSearchStringEscape () @*throws SQLException +This method returns the string used to escape wildcards in search strings. +@end deftypemethod +@deftypemethod DatabaseMetaData {public String} getExtraNameCharacters () @*throws SQLException +This methods returns non-standard characters that can appear in + unquoted identifiers. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsAlterTableWithAddColumn () @*throws SQLException +This method tests whether or not the database supports + "ALTER TABLE ADD COLUMN" +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsAlterTableWithDropColumn () @*throws SQLException +This method tests whether or not the database supports + "ALTER TABLE DROP COLUMN" +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsColumnAliasing () @*throws SQLException +This method tests whether or not column aliasing is supported. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} nullPlusNonNullIsNull () @*throws SQLException +This method tests whether the concatenation of a NULL and non-NULL + value results in a NULL. This will always be true in fully JDBC compliant + drivers. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsConvert () @*throws SQLException +Tests whether or not CONVERT is supported. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsConvert (int@w{ }@var{fromType}, int@w{ }@var{toType}) @*throws SQLException +This method tests whether or not CONVERT can be performed between the + specified types. The types are contants from @code{Types}. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsTableCorrelationNames () @*throws SQLException +This method tests whether or not table correlation names are + supported. This will be always be @code{true} in a fully JDBC + compliant driver. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsDifferentTableCorrelationNames () @*throws SQLException +This method tests whether correlation names must be different from the + name of the table. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsExpressionsInOrderBy () @*throws SQLException +This method tests whether or not expressions are allowed in an + ORDER BY lists. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsOrderByUnrelated () @*throws SQLException +This method tests whether or ORDER BY on a non-selected column is + allowed. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsGroupBy () @*throws SQLException +This method tests whether or not GROUP BY is supported. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsGroupByUnrelated () @*throws SQLException +This method tests whether GROUP BY on a non-selected column is + allowed. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsGroupByBeyondSelect () @*throws SQLException +This method tests whether or not a GROUP BY can add columns not in the + select if it includes all the columns in the select. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsLikeEscapeClause () @*throws SQLException +This method tests whether or not the escape character is supported in + LIKE expressions. A fully JDBC compliant driver will always return + @code{true}. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsMultipleResultSets () @*throws SQLException +This method tests whether multiple result sets for a single statement are + supported. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsMultipleTransactions () @*throws SQLException +This method test whether or not multiple transactions may be open + at once, as long as they are on different connections. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsNonNullableColumns () @*throws SQLException +This method tests whether or not columns can be defined as NOT NULL. A + fully JDBC compliant driver always returns @code{true}. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsMinimumSQLGrammar () @*throws SQLException +This method tests whether or not the minimum grammer for ODBC is supported. + A fully JDBC compliant driver will always return @code{true}. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsCoreSQLGrammar () @*throws SQLException +This method tests whether or not the core grammer for ODBC is supported. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsExtendedSQLGrammar () @*throws SQLException +This method tests whether or not the extended grammer for ODBC is supported. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsANSI92EntryLevelSQL () @*throws SQLException +This method tests whether or not the ANSI92 entry level SQL + grammar is supported. A fully JDBC compliant drivers must return + @code{true}. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsANSI92IntermediateSQL () @*throws SQLException +This method tests whether or not the ANSI92 intermediate SQL + grammar is supported. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsANSI92FullSQL () @*throws SQLException +This method tests whether or not the ANSI92 full SQL + grammar is supported. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsIntegrityEnhancementFacility () @*throws SQLException +This method tests whether or not the SQL integrity enhancement + facility is supported. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsOuterJoins () @*throws SQLException +This method tests whether or not the database supports outer joins. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsFullOuterJoins () @*throws SQLException +This method tests whether or not the database supports full outer joins. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsLimitedOuterJoins () @*throws SQLException +This method tests whether or not the database supports limited outer joins. +@end deftypemethod +@deftypemethod DatabaseMetaData {public String} getSchemaTerm () @*throws SQLException +This method returns the vendor's term for "schema". +@end deftypemethod +@deftypemethod DatabaseMetaData {public String} getProcedureTerm () @*throws SQLException +This method returns the vendor's term for "procedure". +@end deftypemethod +@deftypemethod DatabaseMetaData {public String} getCatalogTerm () @*throws SQLException +This method returns the vendor's term for "catalog". +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} isCatalogAtStart () @*throws SQLException +This method tests whether a catalog name appears at the beginning of + a fully qualified table name. +@end deftypemethod +@deftypemethod DatabaseMetaData {public String} getCatalogSeparator () @*throws SQLException +This method returns the separator between the catalog name and the + table name. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsSchemasInDataManipulation () @*throws SQLException +This method tests whether a catalog name can appear in a data + manipulation statement. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsSchemasInProcedureCalls () @*throws SQLException +This method tests whether a catalog name can appear in a procedure + call +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsSchemasInTableDefinitions () @*throws SQLException +This method tests whether a catalog name can appear in a table definition. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsSchemasInIndexDefinitions () @*throws SQLException +This method tests whether a catalog name can appear in an index definition. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsSchemasInPrivilegeDefinitions () @*throws SQLException +This method tests whether a catalog name can appear in privilege definitions. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsCatalogsInDataManipulation () @*throws SQLException +This method tests whether a catalog name can appear in a data + manipulation statement. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsCatalogsInProcedureCalls () @*throws SQLException +This method tests whether a catalog name can appear in a procedure + call +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsCatalogsInTableDefinitions () @*throws SQLException +This method tests whether a catalog name can appear in a table definition. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsCatalogsInIndexDefinitions () @*throws SQLException +This method tests whether a catalog name can appear in an index definition. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsCatalogsInPrivilegeDefinitions () @*throws SQLException +This method tests whether a catalog name can appear in privilege definitions. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsPositionedDelete () @*throws SQLException +This method tests whether or not that database supports positioned + deletes. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsPositionedUpdate () @*throws SQLException +This method tests whether or not that database supports positioned + updates. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsSelectForUpdate () @*throws SQLException +This method tests whether or not SELECT FOR UPDATE is supported by the + database. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsStoredProcedures () @*throws SQLException +This method tests whether or not stored procedures are supported on + this database. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsSubqueriesInComparisons () @*throws SQLException +This method tests whether or not subqueries are allowed in comparisons. + A fully JDBC compliant driver will always return @code{true}. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsSubqueriesInExists () @*throws SQLException +This method tests whether or not subqueries are allowed in exists + expressions. A fully JDBC compliant driver will always return + @code{true}. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsSubqueriesInIns () @*throws SQLException +This method tests whether subqueries are allowed in IN statements. + A fully JDBC compliant driver will always return @code{true}. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsSubqueriesInQuantifieds () @*throws SQLException +This method tests whether or not subqueries are allowed in quantified + expressions. A fully JDBC compliant driver will always return + @code{true}. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsCorrelatedSubqueries () @*throws SQLException +This method test whether or not correlated subqueries are allowed. A + fully JDBC compliant driver will always return @code{true}. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsUnion () @*throws SQLException +This method tests whether or not the UNION statement is supported. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsUnionAll () @*throws SQLException +This method tests whether or not the UNION ALL statement is supported. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsOpenCursorsAcrossCommit () @*throws SQLException +This method tests whether or not the database supports cursors + remaining open across commits. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsOpenCursorsAcrossRollback () @*throws SQLException +This method tests whether or not the database supports cursors + remaining open across rollbacks. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsOpenStatementsAcrossCommit () @*throws SQLException +This method tests whether or not the database supports statements + remaining open across commits. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsOpenStatementsAcrossRollback () @*throws SQLException +This method tests whether or not the database supports statements + remaining open across rollbacks. +@end deftypemethod +@deftypemethod DatabaseMetaData {public int} getMaxBinaryLiteralLength () @*throws SQLException +This method returns the number of hex characters allowed in an inline + binary literal. +@end deftypemethod +@deftypemethod DatabaseMetaData {public int} getMaxCharLiteralLength () @*throws SQLException +This method returns the maximum length of a character literal. +@end deftypemethod +@deftypemethod DatabaseMetaData {public int} getMaxColumnNameLength () @*throws SQLException +This method returns the maximum length of a column name. +@end deftypemethod +@deftypemethod DatabaseMetaData {public int} getMaxColumnsInGroupBy () @*throws SQLException +This method returns the maximum number of columns in a GROUP BY statement. +@end deftypemethod +@deftypemethod DatabaseMetaData {public int} getMaxColumnsInIndex () @*throws SQLException +This method returns the maximum number of columns in an index. +@end deftypemethod +@deftypemethod DatabaseMetaData {public int} getMaxColumnsInOrderBy () @*throws SQLException +This method returns the maximum number of columns in an ORDER BY statement. +@end deftypemethod +@deftypemethod DatabaseMetaData {public int} getMaxColumnsInSelect () @*throws SQLException +This method returns the maximum number of columns in a SELECT statement. +@end deftypemethod +@deftypemethod DatabaseMetaData {public int} getMaxColumnsInTable () @*throws SQLException +This method returns the maximum number of columns in a table. +@end deftypemethod +@deftypemethod DatabaseMetaData {public int} getMaxConnections () @*throws SQLException +This method returns the maximum number of connections this client + can have to the database. +@end deftypemethod +@deftypemethod DatabaseMetaData {public int} getMaxCursorNameLength () @*throws SQLException +This method returns the maximum length of a cursor name. +@end deftypemethod +@deftypemethod DatabaseMetaData {public int} getMaxIndexLength () @*throws SQLException +This method returns the maximum length of an index. +@end deftypemethod +@deftypemethod DatabaseMetaData {public int} getMaxSchemaNameLength () @*throws SQLException +This method returns the maximum length of a schema name. +@end deftypemethod +@deftypemethod DatabaseMetaData {public int} getMaxProcedureNameLength () @*throws SQLException +This method returns the maximum length of a procedure name. +@end deftypemethod +@deftypemethod DatabaseMetaData {public int} getMaxCatalogNameLength () @*throws SQLException +This method returns the maximum length of a catalog name. +@end deftypemethod +@deftypemethod DatabaseMetaData {public int} getMaxRowSize () @*throws SQLException +This method returns the maximum size of a row in bytes. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} doesMaxRowSizeIncludeBlobs () @*throws SQLException +This method tests whether or not the maximum row size includes BLOB's +@end deftypemethod +@deftypemethod DatabaseMetaData {public int} getMaxStatementLength () @*throws SQLException +This method includes the maximum length of a SQL statement. +@end deftypemethod +@deftypemethod DatabaseMetaData {public int} getMaxStatements () @*throws SQLException +This method returns the maximum number of statements that can be + active at any time. +@end deftypemethod +@deftypemethod DatabaseMetaData {public int} getMaxTableNameLength () @*throws SQLException +This method returns the maximum length of a table name. +@end deftypemethod +@deftypemethod DatabaseMetaData {public int} getMaxTablesInSelect () @*throws SQLException +This method returns the maximum number of tables that may be referenced + in a SELECT statement. +@end deftypemethod +@deftypemethod DatabaseMetaData {public int} getMaxUserNameLength () @*throws SQLException +This method returns the maximum length of a user name. +@end deftypemethod +@deftypemethod DatabaseMetaData {public int} getDefaultTransactionIsolation () @*throws SQLException +This method returns the default transaction isolation level of the + database. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsTransactions () @*throws SQLException +This method tests whether or not the database supports transactions. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsTransactionIsolationLevel (int@w{ }@var{level}) @*throws SQLException +This method tests whether or not the database supports the specified + transaction isolation level. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsDataDefinitionAndDataManipulationTransactions () @*throws SQLException +This method tests whether or not DDL and DML statements allowed within + the same transaction. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsDataManipulationTransactionsOnly () @*throws SQLException +This method tests whether or not only DML statement are allowed + inside a transaction. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} dataDefinitionCausesTransactionCommit () @*throws SQLException +This method tests whether or not a DDL statement will cause the + current transaction to be automatically committed. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} dataDefinitionIgnoredInTransactions () @*throws SQLException +This method tests whether or not DDL statements are ignored in + transactions. +@end deftypemethod +@deftypemethod DatabaseMetaData {public ResultSet} getProcedures (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schemaPattern}, java.lang.String@w{ }@var{namePattern}) @*throws SQLException +This method returns a list of all the stored procedures matching the + specified pattern in the given schema and catalog. This is returned + a @code{ResultSet} with the following columns: + + + + +@itemize @bullet + + +@item +PROCEDURE_CAT - The catalog the procedure is in, which may be + @code{null}. + +@item +PROCEDURE_SCHEM - The schema the procedures is in, which may be + @code{null}. + +@item +PROCEDURE_NAME - The name of the procedure. + +@item +Unused + +@item +Unused + +@item +Unused + +@item +REMARKS - A description of the procedure + +@item +PROCEDURE_TYPE - Indicates the return type of the procedure, which + is one of the contstants defined in this class + (@code{procedureResultUnknown}, @code{procedureNoResult}, or + @code{procedureReturnsResult}). + +@end itemize + +@end deftypemethod +@deftypemethod DatabaseMetaData {public ResultSet} getProcedureColumns (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schemaPattern}, java.lang.String@w{ }@var{namePattern}, java.lang.String@w{ }@var{columnPattern}) @*throws SQLException +This method returns a list of the parameter and result columns for + the requested stored procedures. This is returned in the form of a + @code{ResultSet} with the following columns: + + + + +@itemize @bullet + + +@item +PROCEDURE_CAT - The catalog the procedure is in, which may be + @code{null}. + +@item +PROCEDURE_SCHEM - The schema the procedures is in, which may be + @code{null}. + +@item +PROCEDURE_NAME - The name of the procedure. + +@item +COLUMN_NAME - The name of the column + +@item +COLUMN_TYPE - The type of the column, which will be one of the + contants defined in this class (@code{procedureColumnUnknown}, + @code{procedureColumnIn}, @code{procedureColumnInOut}, + @code{procedureColumnOut}, @code{procedureColumnReturn}, + or @code{procedureColumnResult}). + +@item +DATA_TYPE - The SQL type of the column. This is one of the constants + defined in @code{Types}. + +@item +TYPE_NAME - The string name of the data type for this column. + +@item +PRECISION - The precision of the column. + +@item +LENGTH - The length of the column in bytes + +@item +SCALE - The scale of the column. + +@item +RADIX - The radix of the column. + +@item +NULLABLE - Whether or not the column is NULLABLE. This is one of + the constants defined in this class (@code{procedureNoNulls}, + @code{procedureNullable}, or @code{procedureNullableUnknown}) + +@item +REMARKS - A description of the column. + +@end itemize + +@end deftypemethod +@deftypemethod DatabaseMetaData {public ResultSet} getTables (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schemaPattern}, java.lang.String@w{ }@var{namePattern}, java.lang.String[]@w{ }@var{types}) @*throws SQLException +This method returns a list of the requested table as a + @code{ResultSet} with the following columns: + + + + +@itemize @bullet + + +@item +TABLE_CAT - The catalog the table is in, which may be @code{null}. + +@item +TABLE_SCHEM - The schema the table is in, which may be @code{null}. + +@item +TABLE_NAME - The name of the table. + +@item +TABLE_TYPE - A string describing the table type. This will be one + of the values returned by the @code{getTableTypes()} method. + +@item +REMARKS - Comments about the table. + +@end itemize + +@end deftypemethod +@deftypemethod DatabaseMetaData {public ResultSet} getSchemas () @*throws SQLException +This method returns the list of database schemas as a + @code{ResultSet}, with one column - TABLE_SCHEM - that is the + name of the schema. +@end deftypemethod +@deftypemethod DatabaseMetaData {public ResultSet} getCatalogs () @*throws SQLException +This method returns the list of database catalogs as a + @code{ResultSet} with one column - TABLE_CAT - that is the + name of the catalog. +@end deftypemethod +@deftypemethod DatabaseMetaData {public ResultSet} getTableTypes () @*throws SQLException +This method returns the list of database table types as a + @code{ResultSet} with one column - TABLE_TYPE - that is the + name of the table type. +@end deftypemethod +@deftypemethod DatabaseMetaData {public ResultSet} getColumns (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schemaPattern}, java.lang.String@w{ }@var{namePattern}, java.lang.String@w{ }@var{columnPattern}) @*throws SQLException +This method returns a list of the tables columns for + the requested tables. This is returned in the form of a + @code{ResultSet} with the following columns: + + + + +@itemize @bullet + + +@item +TABLE_CAT - The catalog the table is in, which may be + @code{null}. + +@item +TABLE_SCHEM - The schema the tables is in, which may be + @code{null}. + +@item +TABLE_NAME - The name of the table. + +@item +COLUMN_NAME - The name of the column + +@item +DATA_TYPE - The SQL type of the column. This is one of the constants + defined in @code{Types}. + +@item +TYPE_NAME - The string name of the data type for this column. + +@item +COLUMN_SIZE - The size of the column. + +@item +Unused + +@item +NUM_PREC_RADIX - The radix of the column. + +@item +NULLABLE - Whether or not the column is NULLABLE. This is one of + the constants defined in this class (@code{tableNoNulls}, + @code{tableNullable}, or @code{tableNullableUnknown}) + +@item +REMARKS - A description of the column. + +@item +COLUMN_DEF - The default value for the column, may be @code{null}. + +@item +SQL_DATA_TYPE - Unused + +@item +SQL_DATETIME_SUB - Unused + +@item +CHAR_OCTET_LENGTH - For character columns, the maximum number of bytes + in the column. + +@item +ORDINAL_POSITION - The index of the column in the table. + +@item +IS_NULLABLE - "NO" means no, "YES" means maybe, and an empty string + means unknown. + +@end itemize + +@end deftypemethod +@deftypemethod DatabaseMetaData {public ResultSet} getColumnPrivileges (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schema}, java.lang.String@w{ }@var{table}, java.lang.String@w{ }@var{columnPattern}) @*throws SQLException +This method returns the access rights that have been granted to the + requested columns. This information is returned as a @code{ResultSet} + with the following columns: + + + + +@itemize @bullet + + +@item +TABLE_CAT - The catalog the table is in, which may be + @code{null}. + +@item +TABLE_SCHEM - The schema the tables is in, which may be + @code{null}. + +@item +TABLE_NAME - The name of the table. + +@item +COLUMN_NAME - The name of the column. + +@item +GRANTOR - The entity that granted the access. + +@item +GRANTEE - The entity granted the access. + +@item +PRIVILEGE - The name of the privilege granted. + +@item +IS_GRANTABLE - "YES" if the grantee can grant the privilege to + others, "NO" if not, and @code{null} if unknown. + +@end itemize + +@end deftypemethod +@deftypemethod DatabaseMetaData {public ResultSet} getTablePrivileges (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schema}, java.lang.String@w{ }@var{table}) @*throws SQLException +This method returns the access rights that have been granted to the + requested tables. This information is returned as a @code{ResultSet} + with the following columns: + + + + +@itemize @bullet + + +@item +TABLE_CAT - The catalog the table is in, which may be + @code{null}. + +@item +TABLE_SCHEM - The schema the tables is in, which may be + @code{null}. + +@item +TABLE_NAME - The name of the table. + +@item +GRANTOR - The entity that granted the access. + +@item +GRANTEE - The entity granted the access. + +@item +PRIVILEGE - The name of the privilege granted. + +@item +IS_GRANTABLE - "YES" if the grantee can grant the privilege to + others, "NO" if not, and @code{null} if unknown. + +@end itemize + +@end deftypemethod +@deftypemethod DatabaseMetaData {public ResultSet} getBestRowIdentifier (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schema}, java.lang.String@w{ }@var{table}, int@w{ }@var{scope}, boolean@w{ }@var{nullable}) @*throws SQLException +This method returns the best set of columns for uniquely identifying + a row. It returns this information as a @code{ResultSet} with + the following columns: + + + + +@itemize @bullet + + +@item +SCOPE - The scope of the results returned. This is one of the + constants defined in this class (@code{bestRowTemporary}, + @code{bestRowTransaction}, or @code{bestRowSession}). + +@item +COLUMN_NAME - The name of the column. + +@item +DATA_TYPE - The SQL type of the column. This is one of the constants + defined in @code{Types}. + +@item +TYPE_NAME - The string name of the data type for this column. + +@item +COLUMN_SIZE - The precision of the columns + +@item +BUFFER_LENGTH - Unused + +@item +DECIMAL_DIGITS - The scale of the column. + +@item +PSEUDO_COLUMN - Whether or not the best row identifier is a + pseudo_column. This is one of the constants defined in this class + (@code{bestRowUnknown}, @code{bestRowNotPseudo}, or + @code{bestRowPseudo}). + +@end itemize + +@end deftypemethod +@deftypemethod DatabaseMetaData {public ResultSet} getVersionColumns (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schema}, java.lang.String@w{ }@var{table}) @*throws SQLException +This method returns the set of columns that are automatically updated + when the row is update. It returns this information as a + @code{ResultSet} with the following columns: + + + + +@itemize @bullet + + +@item +SCOPE - Unused + +@item +COLUMN_NAME - The name of the column. + +@item +DATA_TYPE - The SQL type of the column. This is one of the constants + defined in @code{Types}. + +@item +TYPE_NAME - The string name of the data type for this column. + +@item +COLUMN_SIZE - The precision of the columns + +@item +BUFFER_LENGTH - Unused + +@item +DECIMAL_DIGITS - The scale of the column. + +@item +PSEUDO_COLUMN - Whether or not the best row identifier is a + pseudo_column. This is one of the constants defined in this class + (@code{versionRowUnknown}, @code{versionRowNotPseudo}, or + @code{versionRowPseudo}). + +@end itemize + +@end deftypemethod +@deftypemethod DatabaseMetaData {public ResultSet} getPrimaryKeys (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schema}, java.lang.String@w{ }@var{table}) @*throws SQLException +This method returns a list of a table's primary key columns. These + are returned as a @code{ResultSet} with the following columns. + + + + +@itemize @bullet + + +@item +TABLE_CAT - The catalog of the table, which may be @code{null}. + +@item +TABLE_SCHEM - The schema of the table, which may be @code{null}. + +@item +TABLE_NAME - The name of the table. + +@item +COLUMN_NAME - The name of the column. + +@item +KEY_SEQ - The sequence number of the column within the primary key. + +@item +PK_NAME - The name of the primary key, which may be @code{null}. + +@end itemize + +@end deftypemethod +@deftypemethod DatabaseMetaData {public ResultSet} getImportedKeys (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schema}, java.lang.String@w{ }@var{table}) @*throws SQLException +This method returns a list of the table's foreign keys. These are + returned as a @code{ResultSet} with the following columns: + + + + +@itemize @bullet + + +@item +PKTABLE_CAT - The catalog of the table the key was imported from. + +@item +PKTABLE_SCHEM - The schema of the table the key was imported from. + +@item +PKTABLE_NAME - The name of the table the key was imported from. + +@item +PKCOLUMN_NAME - The name of the column that was imported. + +@item +FKTABLE_CAT - The foreign key catalog name. + +@item +FKTABLE_SCHEM - The foreign key schema name. + +@item +FKTABLE_NAME - The foreign key table name. + +@item +FKCOLUMN_NAME - The foreign key column name. + +@item +KEY_SEQ - The sequence number of the column within the foreign key. + +@item +UPDATE_RULE - How the foreign key behaves when the primary key is + updated. This is one of the constants defined in this class + (@code{importedNoAction}, @code{importedKeyCascade}, + @code{importedKeySetNull}, @code{importedKeySetDefault}, or + @code{importedKeyRestrict}). + +@item +DELETE_RULE - How the foreign key behaves when the primary key is + deleted. This is one of the constants defined in this class + (@code{importedNoAction}, @code{importedKeyCascade}, + @code{importedKeySetNull}, or @code{importedKeySetDefault}) + +@item +FK_NAME - The name of the foreign key. + +@item +PK_NAME - The name of the primary key. + +@item +DEFERRABILITY - The deferrability value. This is one of the + constants defined in this table (@code{importedKeyInitiallyDeferred}, + @code{importedKeyInitiallyImmediate}, or + @code{importedKeyNotDeferrable}). + +@end itemize + +@end deftypemethod +@deftypemethod DatabaseMetaData {public ResultSet} getExportedKeys (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schema}, java.lang.String@w{ }@var{table}) @*throws SQLException +This method returns a list of the table's which use this table's + primary key as a foreign key. The information is + returned as a @code{ResultSet} with the following columns: + + + + +@itemize @bullet + + +@item +PKTABLE_CAT - The catalog of the table the key was imported from. + +@item +PKTABLE_SCHEM - The schema of the table the key was imported from. + +@item +PKTABLE_NAME - The name of the table the key was imported from. + +@item +PKCOLUMN_NAME - The name of the column that was imported. + +@item +FKTABLE_CAT - The foreign key catalog name. + +@item +FKTABLE_SCHEM - The foreign key schema name. + +@item +FKTABLE_NAME - The foreign key table name. + +@item +FKCOLUMN_NAME - The foreign key column name. + +@item +KEY_SEQ - The sequence number of the column within the foreign key. + +@item +UPDATE_RULE - How the foreign key behaves when the primary key is + updated. This is one of the constants defined in this class + (@code{importedNoAction}, @code{importedKeyCascade}, + @code{importedKeySetNull}, @code{importedKeySetDefault}, or + @code{importedKeyRestrict}). + +@item +DELETE_RULE - How the foreign key behaves when the primary key is + deleted. This is one of the constants defined in this class + (@code{importedNoAction}, @code{importedKeyCascade}, + @code{importedKeySetNull}, or @code{importedKeySetDefault}) + +@item +FK_NAME - The name of the foreign key. + +@item +PK_NAME - The name of the primary key. + +@item +DEFERRABILITY - The deferrability value. This is one of the + constants defined in this table (@code{importedKeyInitiallyDeferred}, + @code{importedKeyInitiallyImmediate}, or + @code{importedKeyNotDeferrable}). + +@end itemize + +@end deftypemethod +@deftypemethod DatabaseMetaData {public ResultSet} getCrossReference (java.lang.String@w{ }@var{primCatalog}, java.lang.String@w{ }@var{primSchema}, java.lang.String@w{ }@var{primTable}, java.lang.String@w{ }@var{forCatalog}, java.lang.String@w{ }@var{forSchema}, java.lang.String@w{ }@var{forTable}) @*throws SQLException +This method returns a description of how one table imports another + table's primary key as a foreign key. The information is + returned as a @code{ResultSet} with the following columns: + + + + +@itemize @bullet + + +@item +PKTABLE_CAT - The catalog of the table the key was imported from. + +@item +PKTABLE_SCHEM - The schema of the table the key was imported from. + +@item +PKTABLE_NAME - The name of the table the key was imported from. + +@item +PKCOLUMN_NAME - The name of the column that was imported. + +@item +FKTABLE_CAT - The foreign key catalog name. + +@item +FKTABLE_SCHEM - The foreign key schema name. + +@item +FKTABLE_NAME - The foreign key table name. + +@item +FKCOLUMN_NAME - The foreign key column name. + +@item +KEY_SEQ - The sequence number of the column within the foreign key. + +@item +UPDATE_RULE - How the foreign key behaves when the primary key is + updated. This is one of the constants defined in this class + (@code{importedNoAction}, @code{importedKeyCascade}, + @code{importedKeySetNull}, @code{importedKeySetDefault}, or + @code{importedKeyRestrict}). + +@item +DELETE_RULE - How the foreign key behaves when the primary key is + deleted. This is one of the constants defined in this class + (@code{importedNoAction}, @code{importedKeyCascade}, + @code{importedKeySetNull}, or @code{importedKeySetDefault}) + +@item +FK_NAME - The name of the foreign key. + +@item +PK_NAME - The name of the primary key. + +@item +DEFERRABILITY - The deferrability value. This is one of the + constants defined in this table (@code{importedKeyInitiallyDeferred}, + @code{importedKeyInitiallyImmediate}, or + @code{importedKeyNotDeferrable}). + +@end itemize + +@end deftypemethod +@deftypemethod DatabaseMetaData {public ResultSet} getTypeInfo () @*throws SQLException +This method returns a list of the SQL types supported by this + database. The information is returned as a @code{ResultSet} + with the following columns: + + + + +@itemize @bullet + + +@item +TYPE_NAME - The name of the data type. + +@item +DATA_TYPE - A data type constant from @code{Types} for this + type. + +@item +PRECISION - The maximum precision of this type. + +@item +LITERAL_PREFIX - Prefix value used to quote a literal, which may be + @code{null}. + +@item +LITERAL_SUFFIX - Suffix value used to quote a literal, which may be + @code{null}. + +@item +CREATE_PARAMS - The parameters used to create the type, which may be + @code{null}. + +@item +NULLABLE - Whether or not this type supports NULL values. This will + be one of the constants defined in this interface + (@code{typeNoNulls}, @code{typeNullable}, or + @code{typeNullableUnknown}). + +@item +CASE_SENSITIVE - Whether or not the value is case sensitive. + +@item +SEARCHABLE - Whether or not "LIKE" expressions are supported in + WHERE clauses for this type. This will be one of the constants defined + in this interface (@code{typePredNone}, @code{typePredChar}, + @code{typePredBasic}, or @code{typeSearchable}). + +@item +UNSIGNED_ATTRIBUTE - Is the value of this type unsigned. + +@item +FIXED_PREC_SCALE - Whether or not this type can be used for money. + +@item +AUTO_INCREMENT - Whether or not this type supports auto-incrementing. + +@item +LOCAL_TYPE_NAME - A localized name for this data type. + +@item +MINIMUM_SCALE - The minimum scale supported by this type. + +@item +MAXIMUM_SCALE - The maximum scale supported by this type. + +@item +SQL_DATA_TYPE - Unused. + +@item +SQL_DATETIME_SUB - Unused. + +@item +NUM_PREC_RADIX - The radix of this data type. + +@end itemize + +@end deftypemethod +@deftypemethod DatabaseMetaData {public ResultSet} getIndexInfo (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schema}, java.lang.String@w{ }@var{table}, boolean@w{ }@var{unique}, boolean@w{ }@var{approx}) @*throws SQLException +This method returns information about a tables indices and statistics. + It is returned as a @code{ResultSet} with the following columns: + + + + +@itemize @bullet + + +@item +TABLE_CAT - The catalog of the table, which may be @code{null}. + +@item +TABLE_SCHEM - The schema of the table, which may be @code{null}. + +@item +TABLE_NAME - The name of the table. + +@item +NON_UNIQUE - Are index values non-unique? + +@item +INDEX_QUALIFIER The index catalog, which may be @code{null} + +@item +INDEX_NAME - The name of the index. + +@item +TYPE - The type of index, which will be one of the constants defined + in this interface (@code{tableIndexStatistic}, + @code{tableIndexClustered}, @code{tableIndexHashed}, or + @code{tableIndexOther}). + +@item +ORDINAL_POSITION - The sequence number of this column in the index. + This will be 0 when the index type is @code{tableIndexStatistic}. + +@item +COLUMN_NAME - The name of this column in the index. + +@item +ASC_OR_DESC - "A" for an ascending sort sequence, "D" for a + descending sort sequence or @code{null} if a sort sequence is not + supported. + +@item +CARDINALITY - The number of unique rows in the index, or the number + of rows in the table if the index type is @code{tableIndexStatistic}. + +@item +PAGES - The number of pages used for the index, or the number of pages + in the table if the index type is @code{tableIndexStatistic}. + +@item +FILTER_CONDITION - The filter condition for this index, which may be + @code{null}. + +@end itemize + +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsResultSetType (int@w{ }@var{type}) @*throws SQLException +This method tests whether or not the datbase supports the specified + result type. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsResultSetConcurrency (int@w{ }@var{type}, int@w{ }@var{concur}) @*throws SQLException +This method tests whether the specified result set type and result set + concurrency type are supported by the database. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} ownUpdatesAreVisible (int@w{ }@var{type}) @*throws SQLException +This method tests whether or not the specified result set type sees its + own updates. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} ownDeletesAreVisible (int@w{ }@var{type}) @*throws SQLException +This method tests whether or not the specified result set type sees its + own deletes. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} ownInsertsAreVisible (int@w{ }@var{type}) @*throws SQLException +This method tests whether or not the specified result set type sees its + own inserts. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} othersUpdatesAreVisible (int@w{ }@var{type}) @*throws SQLException +This method tests whether or not the specified result set type sees + updates committed by others. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} othersDeletesAreVisible (int@w{ }@var{type}) @*throws SQLException +This method tests whether or not the specified result set type sees + deletes committed by others. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} othersInsertsAreVisible (int@w{ }@var{type}) @*throws SQLException +This method tests whether or not the specified result set type sees + inserts committed by others. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} updatesAreDetected (int@w{ }@var{type}) @*throws SQLException +This method tests whether or not the specified result set type can detect + a visible update by calling the @code{rowUpdated} method. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} deletesAreDetected (int@w{ }@var{type}) @*throws SQLException +This method tests whether or not the specified result set type can detect + a visible delete by calling the @code{rowUpdated} method. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} insertsAreDetected (int@w{ }@var{type}) @*throws SQLException +This method tests whether or not the specified result set type can detect + a visible insert by calling the @code{rowUpdated} method. +@end deftypemethod +@deftypemethod DatabaseMetaData {public boolean} supportsBatchUpdates () @*throws SQLException +This method tests whether or not the database supports batch updates. +@end deftypemethod +@deftypemethod DatabaseMetaData {public ResultSet} getUDTs (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schema}, java.lang.String@w{ }@var{typePattern}, int[]@w{ }@var{types}) @*throws SQLException +This method returns the list of user defined data types in use. These + are returned as a @code{ResultSet} with the following columns: + + + + +@itemize @bullet + + +@item +TYPE_CAT - The catalog name, which may be @code{null}. + +@item +TYPE_SCEHM - The schema name, which may be @code{null}. + +@item +TYPE_NAME - The user defined data type name. + +@item +CLASS_NAME - The Java class name this type maps to. + +@item +DATA_TYPE - A type identifer from @code{Types} for this type. + This will be one of @code{JAVA_OBJECT}, @code{STRUCT}, or + @code{DISTINCT}. + +@item +REMARKS - Comments about this data type. + +@end itemize + +@end deftypemethod +@deftypemethod DatabaseMetaData {public Connection} getConnection () @*throws SQLException +This method returns the @code{Connection} object that was used + to generate the metadata in this object. +@end deftypemethod +@deftypemethod DataTruncation {public int} getIndex () +This method returns the index of the column or parameter that was + truncated. +@end deftypemethod +@deftypemethod DataTruncation {public boolean} getParameter () +This method determines whether or not it was a parameter that was + truncated. +@end deftypemethod +@deftypemethod DataTruncation {public boolean} getRead () +This method determines whether or not it was a column that was + truncated. +@end deftypemethod +@deftypemethod DataTruncation {public int} getDataSize () +This method returns the original size of the parameter or column that + was truncated. +@end deftypemethod +@deftypemethod DataTruncation {public int} getTransferSize () +This method returns the size of the parameter or column after it was + truncated. +@end deftypemethod +@deftypemethod Date {public static Date} valueOf (java.lang.String@w{ }@var{str}) +This method returns a new instance of this class by parsing a + date in JDBC format into a Java date. +@end deftypemethod +@deftypemethod Date {public String} toString () +This method returns this date in JDBC format. +@end deftypemethod +@deftypemethod Driver {public int} getMajorVersion () +This method returns the major version number of the driver. +@end deftypemethod +@deftypemethod Driver {public int} getMinorVersion () +This method returns the minor version number of the driver. +@end deftypemethod +@deftypemethod Driver {public boolean} jdbcCompliant () +This method tests whether or not the driver is JDBC compliant. This + method should only return @code{true} if the driver has been + certified as JDBC compliant. +@end deftypemethod +@deftypemethod Driver {public DriverPropertyInfo} getPropertyInfo (java.lang.String@w{ }@var{url}, java.util.Properties@w{ }@var{properties}) @*throws SQLException +This method returns an array of possible properties that could be + used to connect to the specified database. +@end deftypemethod +@deftypemethod Driver {public boolean} acceptsURL (java.lang.String@w{ }@var{url}) @*throws SQLException +This method tests whether or not the driver believes it can connect to + the specified database. The driver should only test whether it + understands and accepts the URL. It should not necessarily attempt to + probe the database for a connection. +@end deftypemethod +@deftypemethod Driver {public Connection} connect (java.lang.String@w{ }@var{url}, java.util.Properties@w{ }@var{properties}) @*throws SQLException +This method connects to the specified database using the connection + properties supplied. If the driver does not understand the database + URL, it should return @code{null} instead of throwing an + exception since the @code{DriverManager} will probe a driver + in this manner. +@end deftypemethod +@deftypemethod DriverManager {public static int} getLoginTimeout () +This method returns the login timeout in use by JDBC drivers systemwide. +@end deftypemethod +@deftypemethod DriverManager {public static void} setLoginTimeout (int@w{ }@var{login_timeout}) +This method set the login timeout used by JDBC drivers. This is a + system-wide parameter that applies to all drivers. +@end deftypemethod +@deftypemethod DriverManager {public static PrintWriter} getLogWriter () +This method returns the log writer being used by all JDBC drivers. + This method should be used in place of the deprecated + @code{getLogStream} method. +@end deftypemethod +@deftypemethod DriverManager {public static void} setLogWriter (java.io.PrintWriter@w{ }@var{log_writer}) +This method sets the log writer being used by JDBC drivers. This is a + system-wide parameter that affects all drivers. Note that since there + is no way to retrieve a @code{PrintStream} from a + @code{PrintWriter}, this method cannot set the log stream in + use by JDBC. Thus any older drivers may not see this setting. +@end deftypemethod +@deftypemethod DriverManager {public static PrintStream} getLogStream () +This method returns the log stream in use by JDBC. +@end deftypemethod +@deftypemethod DriverManager {public static void} setLogStream (java.io.PrintStream@w{ }@var{log_stream}) +This method sets the log stream in use by JDBC. +@end deftypemethod +@deftypemethod DriverManager {public static void} println (java.lang.String@w{ }@var{str}) +This method prints the specified line to the log stream. +@end deftypemethod +@deftypemethod DriverManager {public static void} registerDriver (java.sql.Driver@w{ }@var{driver}) @*throws SQLException +This method registers a new driver with the manager. This is normally + called by the driver itself in a static initializer. +@end deftypemethod +@deftypemethod DriverManager {public static void} deregisterDriver (java.sql.Driver@w{ }@var{driver}) @*throws SQLException +This method de-registers a driver from the manager. +@end deftypemethod +@deftypemethod DriverManager {public static Enumeration} getDrivers () +This method returns a list of all the currently registered JDBC drivers + that were loaded by the current @code{ClassLoader}. +@end deftypemethod +@deftypemethod DriverManager {public static Driver} getDriver (java.lang.String@w{ }@var{url}) @*throws SQLException +This method returns a driver that can connect to the specified + JDBC URL string. This will be selected from among drivers loaded + at initialization time and those drivers manually loaded by the + same class loader as the caller. +@end deftypemethod +@deftypemethod DriverManager {public static Connection} getConnection (java.lang.String@w{ }@var{url}) @*throws SQLException +This method attempts to return a connection to the specified + JDBC URL string. +@end deftypemethod +@deftypemethod DriverManager {public static Connection} getConnection (java.lang.String@w{ }@var{url}, java.lang.String@w{ }@var{user}, java.lang.String@w{ }@var{password}) @*throws SQLException +This method attempts to return a connection to the specified + JDBC URL string using the specified username and password. +@end deftypemethod +@deftypemethod DriverManager {public static Connection} getConnection (java.lang.String@w{ }@var{url}, java.util.Properties@w{ }@var{properties}) @*throws SQLException +This method attempts to return a connection to the specified + JDBC URL string using the specified connection properties. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setNull (int@w{ }@var{index}, int@w{ }@var{type}) @*throws SQLException +This method populates the specified parameter with a SQL NULL value + for the specified type. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setNull (int@w{ }@var{index}, int@w{ }@var{type}, java.lang.String@w{ }@var{name}) @*throws SQLException +This method populates the specified parameter with a SQL NULL value + for the specified type. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setBoolean (int@w{ }@var{index}, boolean@w{ }@var{value}) @*throws SQLException +This method sets the specified parameter from the given Java + @code{boolean} value. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setByte (int@w{ }@var{index}, byte@w{ }@var{value}) @*throws SQLException +This method sets the specified parameter from the given Java + @code{byte} value. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setShort (int@w{ }@var{index}, short@w{ }@var{value}) @*throws SQLException +This method sets the specified parameter from the given Java + @code{short} value. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setInt (int@w{ }@var{index}, int@w{ }@var{value}) @*throws SQLException +This method sets the specified parameter from the given Java + @code{int} value. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setLong (int@w{ }@var{index}, long@w{ }@var{value}) @*throws SQLException +This method sets the specified parameter from the given Java + @code{long} value. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setFloat (int@w{ }@var{index}, float@w{ }@var{value}) @*throws SQLException +This method sets the specified parameter from the given Java + @code{float} value. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setDouble (int@w{ }@var{index}, double@w{ }@var{value}) @*throws SQLException +This method sets the specified parameter from the given Java + @code{double} value. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setString (int@w{ }@var{index}, java.lang.String@w{ }@var{value}) @*throws SQLException +This method sets the specified parameter from the given Java + @code{String} value. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setBytes (int@w{ }@var{index}, byte[]@w{ }@var{value}) @*throws SQLException +This method sets the specified parameter from the given Java + @code{byte} array value. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setBigDecimal (int@w{ }@var{index}, java.math.BigDecimal@w{ }@var{value}) @*throws SQLException +This method sets the specified parameter from the given Java + @code{java.math.BigDecimal} value. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setDate (int@w{ }@var{index}, java.sql.Date@w{ }@var{value}) @*throws SQLException +This method sets the specified parameter from the given Java + @code{java.sql.Date} value. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setDate (int@w{ }@var{index}, java.sql.Date@w{ }@var{value}, java.util.Calendar@w{ }@var{calendar}) @*throws SQLException +This method sets the specified parameter from the given Java + @code{java.sql.Date} value. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setTime (int@w{ }@var{index}, java.sql.Time@w{ }@var{value}) @*throws SQLException +This method sets the specified parameter from the given Java + @code{java.sql.Time} value. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setTime (int@w{ }@var{index}, java.sql.Time@w{ }@var{value}, java.util.Calendar@w{ }@var{calendar}) @*throws SQLException +This method sets the specified parameter from the given Java + @code{java.sql.Time} value. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setTimestamp (int@w{ }@var{index}, java.sql.Timestamp@w{ }@var{value}) @*throws SQLException +This method sets the specified parameter from the given Java + @code{java.sql.Timestamp} value. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setTimestamp (int@w{ }@var{index}, java.sql.Timestamp@w{ }@var{value}, java.util.Calendar@w{ }@var{calendar}) @*throws SQLException +This method sets the specified parameter from the given Java + @code{java.sql.Timestamp} value. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setAsciiStream (int@w{ }@var{index}, java.io.InputStream@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException +This method sets the specified parameter from the given Java + ASCII @code{InputStream} value. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setUnicodeStream (int@w{ }@var{index}, java.io.InputStream@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException +This method sets the specified parameter from the given Java + Unicode UTF-8 @code{InputStream} value. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setBinaryStream (int@w{ }@var{index}, java.io.InputStream@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException +This method sets the specified parameter from the given Java + binary @code{InputStream} value. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setCharacterStream (int@w{ }@var{index}, java.io.Reader@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException +This method sets the specified parameter from the given Java + character @code{Reader} value. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setRef (int@w{ }@var{index}, java.sql.Ref@w{ }@var{value}) @*throws SQLException +This method sets the specified parameter from the given Java + @code{Ref} value. The default object type to SQL type mapping + will be used. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setBlob (int@w{ }@var{index}, java.sql.Blob@w{ }@var{value}) @*throws SQLException +This method sets the specified parameter from the given Java + @code{Blob} value. The default object type to SQL type mapping + will be used. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setClob (int@w{ }@var{index}, java.sql.Clob@w{ }@var{value}) @*throws SQLException +This method sets the specified parameter from the given Java + @code{Clob} value. The default object type to SQL type mapping + will be used. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setArray (int@w{ }@var{index}, java.sql.Array@w{ }@var{value}) @*throws SQLException +This method sets the specified parameter from the given Java + @code{Array} value. The default object type to SQL type mapping + will be used. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setObject (int@w{ }@var{index}, java.lang.Object@w{ }@var{value}) @*throws SQLException +This method sets the specified parameter from the given Java + @code{Object} value. The default object type to SQL type mapping + will be used. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setObject (int@w{ }@var{index}, java.lang.Object@w{ }@var{value}, int@w{ }@var{type}) @*throws SQLException +This method sets the specified parameter from the given Java + @code{Object} value. The specified SQL object type will be used. +@end deftypemethod +@deftypemethod PreparedStatement {public void} setObject (int@w{ }@var{index}, java.lang.Object@w{ }@var{value}, int@w{ }@var{type}, int@w{ }@var{scale}) @*throws SQLException +This method sets the specified parameter from the given Java + @code{Object} value. The specified SQL object type will be used. +@end deftypemethod +@deftypemethod PreparedStatement {public void} addBatch () @*throws SQLException +This method adds a set of parameters to the batch for JDBC 2.0. +@end deftypemethod +@deftypemethod PreparedStatement {public void} clearParameters () @*throws SQLException +This method clears all of the input parameter that have been + set on this statement. +@end deftypemethod +@deftypemethod PreparedStatement {public ResultSetMetaData} getMetaData () @*throws SQLException +This method returns meta data for the result set from this statement. +@end deftypemethod +@deftypemethod PreparedStatement {public boolean} execute () @*throws SQLException +This method executes a prepared SQL query. + Some prepared statements return multiple results; the execute method + handles these complex statements as well as the simpler form of + statements handled by executeQuery and executeUpdate. +@end deftypemethod +@deftypemethod PreparedStatement {public ResultSet} executeQuery () @*throws SQLException +This method executes a prepared SQL query and returns its ResultSet. +@end deftypemethod +@deftypemethod PreparedStatement {public int} executeUpdate () @*throws SQLException +This method executes an SQL INSERT, UPDATE or DELETE statement. SQL + statements that return nothing such as SQL DDL statements can be executed. +@end deftypemethod +@deftypemethod Ref {public String} getBaseTypeName () @*throws SQLException +This method returns the fully qualified name of the SQL structured + type of the referenced item. +@end deftypemethod +@deftypemethod ResultSet {public boolean} next () @*throws SQLException +This method advances to the next row in the result set. Any streams + open on the current row are closed automatically. +@end deftypemethod +@deftypemethod ResultSet {public boolean} previous () @*throws SQLException +This method moves the current position to the previous row in the + result set. +@end deftypemethod +@deftypemethod ResultSet {public void} close () @*throws SQLException +This method closes the result set and frees any associated resources. +@end deftypemethod +@deftypemethod ResultSet {public boolean} wasNull () @*throws SQLException +This method tests whether the value of the last column that was fetched + was actually a SQL NULL value. +@end deftypemethod +@deftypemethod ResultSet {public String} getString (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{String}. +@end deftypemethod +@deftypemethod ResultSet {public Object} getObject (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{Object}. +@end deftypemethod +@deftypemethod ResultSet {public boolean} getBoolean (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{boolean}. +@end deftypemethod +@deftypemethod ResultSet {public byte} getByte (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{byte}. +@end deftypemethod +@deftypemethod ResultSet {public short} getShort (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{short}. +@end deftypemethod +@deftypemethod ResultSet {public int} getInt (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{int}. +@end deftypemethod +@deftypemethod ResultSet {public long} getLong (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{long}. +@end deftypemethod +@deftypemethod ResultSet {public float} getFloat (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{float}. +@end deftypemethod +@deftypemethod ResultSet {public double} getDouble (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{double}. +@end deftypemethod +@deftypemethod ResultSet {public BigDecimal} getBigDecimal (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{BigDecimal}. +@end deftypemethod +@deftypemethod ResultSet {public BigDecimal} getBigDecimal (int@w{ }@var{index}, int@w{ }@var{scale}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{BigDecimal}. +@end deftypemethod +@deftypemethod ResultSet {public byte} getBytes (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified column as a Java + byte array. +@end deftypemethod +@deftypemethod ResultSet {public Date} getDate (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{java.sql.Date}. +@end deftypemethod +@deftypemethod ResultSet {public Time} getTime (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{java.sql.Time}. +@end deftypemethod +@deftypemethod ResultSet {public Timestamp} getTimestamp (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{java.sql.Timestamp}. +@end deftypemethod +@deftypemethod ResultSet {public InputStream} getAsciiStream (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified column as an ASCII + stream. Note that all the data from this stream must be read before + fetching the value of any other column. Please also be aware that + calling @code{next()} or @code{close()} on this result set + will close this stream as well. +@end deftypemethod +@deftypemethod ResultSet {public InputStream} getUnicodeStream (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified column as a Unicode UTF-8 + stream. Note that all the data from this stream must be read before + fetching the value of any other column. Please also be aware that + calling @code{next()} or @code{close()} on this result set + will close this stream as well. +@end deftypemethod +@deftypemethod ResultSet {public InputStream} getBinaryStream (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified column as a raw byte + stream. Note that all the data from this stream must be read before + fetching the value of any other column. Please also be aware that + calling @code{next()} or @code{close()} on this result set + will close this stream as well. +@end deftypemethod +@deftypemethod ResultSet {public Reader} getCharacterStream (int@w{ }@var{index}) @*throws SQLException +This method returns the value of the specified column as a character + stream. Note that all the data from this stream must be read before + fetching the value of any other column. Please also be aware that + calling @code{next()} or @code{close()} on this result set + will close this stream as well. +@end deftypemethod +@deftypemethod ResultSet {public String} getString (java.lang.String@w{ }@var{column}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{String}. +@end deftypemethod +@deftypemethod ResultSet {public Object} getObject (java.lang.String@w{ }@var{column}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{Object}. +@end deftypemethod +@deftypemethod ResultSet {public boolean} getBoolean (java.lang.String@w{ }@var{column}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{boolean}. +@end deftypemethod +@deftypemethod ResultSet {public byte} getByte (java.lang.String@w{ }@var{column}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{byte}. +@end deftypemethod +@deftypemethod ResultSet {public short} getShort (java.lang.String@w{ }@var{column}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{short}. +@end deftypemethod +@deftypemethod ResultSet {public int} getInt (java.lang.String@w{ }@var{column}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{int}. +@end deftypemethod +@deftypemethod ResultSet {public long} getLong (java.lang.String@w{ }@var{column}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{long}. +@end deftypemethod +@deftypemethod ResultSet {public float} getFloat (java.lang.String@w{ }@var{column}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{float}. +@end deftypemethod +@deftypemethod ResultSet {public double} getDouble (java.lang.String@w{ }@var{column}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{double}. +@end deftypemethod +@deftypemethod ResultSet {public BigDecimal} getBigDecimal (java.lang.String@w{ }@var{column}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{BigDecimal}. +@end deftypemethod +@deftypemethod ResultSet {public BigDecimal} getBigDecimal (java.lang.String@w{ }@var{column}, int@w{ }@var{scale}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{BigDecimal}. +@end deftypemethod +@deftypemethod ResultSet {public byte} getBytes (java.lang.String@w{ }@var{column}) @*throws SQLException +This method returns the value of the specified column as a Java + byte array. +@end deftypemethod +@deftypemethod ResultSet {public Date} getDate (java.lang.String@w{ }@var{column}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{java.sql.Date}. +@end deftypemethod +@deftypemethod ResultSet {public Time} getTime (java.lang.String@w{ }@var{column}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{java.sql.Time}. +@end deftypemethod +@deftypemethod ResultSet {public Timestamp} getTimestamp (java.lang.String@w{ }@var{column}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{java.sql.Timestamp}. +@end deftypemethod +@deftypemethod ResultSet {public InputStream} getAsciiStream (java.lang.String@w{ }@var{column}) @*throws SQLException +This method returns the value of the specified column as an ASCII + stream. Note that all the data from this stream must be read before + fetching the value of any other column. Please also be aware that + calling @code{next()} or @code{close()} on this result set + will close this stream as well. +@end deftypemethod +@deftypemethod ResultSet {public InputStream} getUnicodeStream (java.lang.String@w{ }@var{column}) @*throws SQLException +This method returns the value of the specified column as a Unicode UTF-8 + stream. Note that all the data from this stream must be read before + fetching the value of any other column. Please also be aware that + calling @code{next()} or @code{close()} on this result set + will close this stream as well. +@end deftypemethod +@deftypemethod ResultSet {public InputStream} getBinaryStream (java.lang.String@w{ }@var{column}) @*throws SQLException +This method returns the value of the specified column as a raw byte + stream. Note that all the data from this stream must be read before + fetching the value of any other column. Please also be aware that + calling @code{next()} or @code{close()} on this result set + will close this stream as well. +@end deftypemethod +@deftypemethod ResultSet {public Reader} getCharacterStream (java.lang.String@w{ }@var{column}) @*throws SQLException +This method returns the value of the specified column as a character + stream. Note that all the data from this stream must be read before + fetching the value of any other column. Please also be aware that + calling @code{next()} or @code{close()} on this result set + will close this stream as well. +@end deftypemethod +@deftypemethod ResultSet {public SQLWarning} getWarnings () @*throws SQLException +This method returns the first SQL warning associated with this result + set. Any additional warnings will be chained to this one. +@end deftypemethod +@deftypemethod ResultSet {public void} clearWarnings () @*throws SQLException +This method clears all warnings associated with this result set. +@end deftypemethod +@deftypemethod ResultSet {public String} getCursorName () @*throws SQLException +This method returns the name of the database cursor used by this + result set. +@end deftypemethod +@deftypemethod ResultSet {public ResultSetMetaData} getMetaData () @*throws SQLException +This method returns data about the columns returned as part of the + result set as a @code{ResultSetMetaData} instance. +@end deftypemethod +@deftypemethod ResultSet {public int} findColumn (java.lang.String@w{ }@var{column}) @*throws SQLException +This method returns the column index of the specified named column. +@end deftypemethod +@deftypemethod ResultSet {public boolean} isBeforeFirst () @*throws SQLException +This method tests whether or not the cursor is before the first row + in the result set. +@end deftypemethod +@deftypemethod ResultSet {public boolean} isAfterLast () @*throws SQLException +This method tests whether or not the cursor is after the last row + in the result set. +@end deftypemethod +@deftypemethod ResultSet {public boolean} isFirst () @*throws SQLException +This method tests whether or not the cursor is positioned on the first + row in the result set. +@end deftypemethod +@deftypemethod ResultSet {public boolean} isLast () @*throws SQLException +This method tests whether or not the cursor is on the last row + in the result set. +@end deftypemethod +@deftypemethod ResultSet {public void} beforeFirst () @*throws SQLException +This method repositions the cursor to before the first row in the + result set. +@end deftypemethod +@deftypemethod ResultSet {public void} afterLast () @*throws SQLException +This method repositions the cursor to after the last row in the result + set. +@end deftypemethod +@deftypemethod ResultSet {public boolean} first () @*throws SQLException +This method repositions the cursor on the first row in the + result set. +@end deftypemethod +@deftypemethod ResultSet {public boolean} last () @*throws SQLException +This method repositions the cursor on the last row in the result + set. +@end deftypemethod +@deftypemethod ResultSet {public int} getRow () @*throws SQLException +This method returns the current row number in the cursor. Numbering + begins at index 1. +@end deftypemethod +@deftypemethod ResultSet {public boolean} absolute (int@w{ }@var{row}) @*throws SQLException +This method positions the result set to the specified absolute row. + Positive numbers are row offsets from the beginning of the result + set (numbering starts from row 1) and negative numbers are row offsets + from the end of the result set (numbering starts from -1). +@end deftypemethod +@deftypemethod ResultSet {public boolean} relative (int@w{ }@var{row}) @*throws SQLException +This method moves the result set position relative to the current row. + The offset can be positive or negative. +@end deftypemethod +@deftypemethod ResultSet {public void} setFetchDirection (int@w{ }@var{direction}) @*throws SQLException +This method provides a hint to the driver about which direction the + result set will be processed in. +@end deftypemethod +@deftypemethod ResultSet {public int} getFetchDirection () @*throws SQLException +This method returns the current fetch direction for this result set. +@end deftypemethod +@deftypemethod ResultSet {public void} setFetchSize (int@w{ }@var{rows}) @*throws SQLException +This method provides a hint to the driver about how many rows at a + time it should fetch from the database. +@end deftypemethod +@deftypemethod ResultSet {public int} getFetchSize () @*throws SQLException +This method returns the current number of rows that will be fetched + from the database at a time. +@end deftypemethod +@deftypemethod ResultSet {public int} getType () @*throws SQLException +This method returns the result set type of this result set. This will + be one of the TYPE_* constants defined in this interface. +@end deftypemethod +@deftypemethod ResultSet {public int} getConcurrency () @*throws SQLException +This method returns the concurrency type of this result set. This will + be one of the CONCUR_* constants defined in this interface. +@end deftypemethod +@deftypemethod ResultSet {public boolean} rowUpdated () @*throws SQLException +This method tests whether or not the current row in the result set + has been updated. Updates must be visible in order of this method to + detect the update. +@end deftypemethod +@deftypemethod ResultSet {public boolean} rowInserted () @*throws SQLException +This method tests whether or not the current row in the result set + has been inserted. Inserts must be visible in order of this method to + detect the insert. +@end deftypemethod +@deftypemethod ResultSet {public boolean} rowDeleted () @*throws SQLException +This method tests whether or not the current row in the result set + has been deleted. Deletes must be visible in order of this method to + detect the deletion. +@end deftypemethod +@deftypemethod ResultSet {public void} updateNull (int@w{ }@var{index}) @*throws SQLException +This method updates the specified column to have a NULL value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateBoolean (int@w{ }@var{index}, boolean@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have a boolean value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateByte (int@w{ }@var{index}, byte@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have a byte value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateShort (int@w{ }@var{index}, short@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have a short value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateInt (int@w{ }@var{index}, int@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have an int value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateLong (int@w{ }@var{index}, long@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have a long value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateFloat (int@w{ }@var{index}, float@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have a float value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateDouble (int@w{ }@var{index}, double@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have a double value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateBigDecimal (int@w{ }@var{index}, java.math.BigDecimal@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have a BigDecimal value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateString (int@w{ }@var{index}, java.lang.String@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have a String value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateBytes (int@w{ }@var{index}, byte[]@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have a byte array value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateDate (int@w{ }@var{index}, java.sql.Date@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have a java.sql.Date value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateTime (int@w{ }@var{index}, java.sql.Time@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have a java.sql.Time value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateTimestamp (int@w{ }@var{index}, java.sql.Timestamp@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have a java.sql.Timestamp value. + This does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateAsciiStream (int@w{ }@var{index}, java.io.InputStream@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException +This method updates the specified column from an ASCII text stream. + This does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateBinaryStream (int@w{ }@var{index}, java.io.InputStream@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException +This method updates the specified column from a binary stream. + This does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateCharacterStream (int@w{ }@var{index}, java.io.Reader@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException +This method updates the specified column from a character stream. + This does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateObject (int@w{ }@var{index}, java.lang.Object@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have an Object value. + This does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateObject (int@w{ }@var{index}, java.lang.Object@w{ }@var{value}, int@w{ }@var{scale}) @*throws SQLException +This method updates the specified column to have an Object value. + This does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateNull (java.lang.String@w{ }@var{name}) @*throws SQLException +This method updates the specified column to have a NULL value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateBoolean (java.lang.String@w{ }@var{name}, boolean@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have a boolean value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateByte (java.lang.String@w{ }@var{name}, byte@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have a byte value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateShort (java.lang.String@w{ }@var{name}, short@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have a short value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateInt (java.lang.String@w{ }@var{name}, int@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have an int value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateLong (java.lang.String@w{ }@var{name}, long@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have a long value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateFloat (java.lang.String@w{ }@var{name}, float@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have a float value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateDouble (java.lang.String@w{ }@var{name}, double@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have a double value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateBigDecimal (java.lang.String@w{ }@var{name}, java.math.BigDecimal@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have a BigDecimal value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateString (java.lang.String@w{ }@var{name}, java.lang.String@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have a String value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateBytes (java.lang.String@w{ }@var{name}, byte[]@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have a byte array value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateDate (java.lang.String@w{ }@var{name}, java.sql.Date@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have a java.sql.Date value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateTime (java.lang.String@w{ }@var{name}, java.sql.Time@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have a java.sql.Time value. This + does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateTimestamp (java.lang.String@w{ }@var{name}, java.sql.Timestamp@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have a java.sql.Timestamp value. + This does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateAsciiStream (java.lang.String@w{ }@var{name}, java.io.InputStream@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException +This method updates the specified column from an ASCII text stream. + This does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateBinaryStream (java.lang.String@w{ }@var{name}, java.io.InputStream@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException +This method updates the specified column from a binary stream. + This does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateCharacterStream (java.lang.String@w{ }@var{name}, java.io.Reader@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException +This method updates the specified column from a character stream. + This does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateObject (java.lang.String@w{ }@var{name}, java.lang.Object@w{ }@var{value}) @*throws SQLException +This method updates the specified column to have an Object value. + This does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} updateObject (java.lang.String@w{ }@var{name}, java.lang.Object@w{ }@var{value}, int@w{ }@var{scale}) @*throws SQLException +This method updates the specified column to have an Object value. + This does not update the actual database. @code{updateRow} must be + called in order to do that. +@end deftypemethod +@deftypemethod ResultSet {public void} insertRow () @*throws SQLException +This method inserts the current row into the database. The result set + must be positioned on the insert row in order to call this method + successfully. +@end deftypemethod +@deftypemethod ResultSet {public void} updateRow () @*throws SQLException +This method updates the current row in the database. +@end deftypemethod +@deftypemethod ResultSet {public void} deleteRow () @*throws SQLException +This method deletes the current row in the database. +@end deftypemethod +@deftypemethod ResultSet {public void} refreshRow () @*throws SQLException +This method refreshes the contents of the current row from the database. +@end deftypemethod +@deftypemethod ResultSet {public void} cancelRowUpdates () @*throws SQLException +This method cancels any changes that have been made to a row. If + the @code{rowUpdate} method has been called, then the changes + cannot be undone. +@end deftypemethod +@deftypemethod ResultSet {public void} moveToInsertRow () @*throws SQLException +This method positions the result set to the "insert row", which allows + a new row to be inserted into the database from the result set. +@end deftypemethod +@deftypemethod ResultSet {public void} moveToCurrentRow () @*throws SQLException +This method moves the result set position from the insert row back to + the current row that was selected prior to moving to the insert row. +@end deftypemethod +@deftypemethod ResultSet {public Statement} getStatement () @*throws SQLException +This method returns a the @code{Statement} that was used to + produce this result set. +@end deftypemethod +@deftypemethod ResultSet {public Object} getObject (int@w{ }@var{index}, java.util.Map@w{ }@var{map}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{Object} using the specified SQL type to Java type map. +@end deftypemethod +@deftypemethod ResultSet {public Ref} getRef (int@w{ }@var{index}) @*throws SQLException +This method returns a @code{Ref} for the specified column which + represents the structured type for the column. +@end deftypemethod +@deftypemethod ResultSet {public Blob} getBlob (int@w{ }@var{index}) @*throws SQLException +This method returns the specified column value as a BLOB. +@end deftypemethod +@deftypemethod ResultSet {public Clob} getClob (int@w{ }@var{index}) @*throws SQLException +This method returns the specified column value as a CLOB. +@end deftypemethod +@deftypemethod ResultSet {public Array} getArray (int@w{ }@var{index}) @*throws SQLException +This method returns the specified column value as an @code{Array}. +@end deftypemethod +@deftypemethod ResultSet {public Object} getObject (java.lang.String@w{ }@var{name}, java.util.Map@w{ }@var{map}) @*throws SQLException +This method returns the value of the specified column as a Java + @code{Object} using the specified SQL type to Java type map. +@end deftypemethod +@deftypemethod ResultSet {public Ref} getRef (java.lang.String@w{ }@var{name}) @*throws SQLException +This method returns a @code{Ref} for the specified column which + represents the structured type for the column. +@end deftypemethod +@deftypemethod ResultSet {public Blob} getBlob (java.lang.String@w{ }@var{name}) @*throws SQLException +This method returns the specified column value as a BLOB. +@end deftypemethod +@deftypemethod ResultSet {public Clob} getClob (java.lang.String@w{ }@var{name}) @*throws SQLException +This method returns the specified column value as a CLOB. +@end deftypemethod +@deftypemethod ResultSet {public Array} getArray (java.lang.String@w{ }@var{name}) @*throws SQLException +This method returns the specified column value as an @code{Array}. +@end deftypemethod +@deftypemethod ResultSet {public Date} getDate (int@w{ }@var{index}, java.util.Calendar@w{ }@var{cal}) @*throws SQLException +This method returns the specified column value as a + @code{java.sql.Date}. The specified @code{Calendar} is used + to generate a value for the date if the database does not support + timezones. +@end deftypemethod +@deftypemethod ResultSet {public Time} getTime (int@w{ }@var{index}, java.util.Calendar@w{ }@var{cal}) @*throws SQLException +This method returns the specified column value as a + @code{java.sql.Time}. The specified @code{Calendar} is used + to generate a value for the time if the database does not support + timezones. +@end deftypemethod +@deftypemethod ResultSet {public Timestamp} getTimestamp (int@w{ }@var{index}, java.util.Calendar@w{ }@var{cal}) @*throws SQLException +This method returns the specified column value as a + @code{java.sql.Timestamp}. The specified @code{Calendar} is used + to generate a value for the timestamp if the database does not support + timezones. +@end deftypemethod +@deftypemethod ResultSet {public Date} getDate (java.lang.String@w{ }@var{name}, java.util.Calendar@w{ }@var{cal}) @*throws SQLException +This method returns the specified column value as a + @code{java.sql.Date}. The specified @code{Calendar} is used + to generate a value for the date if the database does not support + timezones. +@end deftypemethod +@deftypemethod ResultSet {public Time} getTime (java.lang.String@w{ }@var{name}, java.util.Calendar@w{ }@var{cal}) @*throws SQLException +This method returns the specified column value as a + @code{java.sql.Time}. The specified @code{Calendar} is used + to generate a value for the time if the database does not support + timezones. +@end deftypemethod +@deftypemethod ResultSet {public Timestamp} getTimestamp (java.lang.String@w{ }@var{name}, java.util.Calendar@w{ }@var{cal}) @*throws SQLException +This method returns the specified column value as a + @code{java.sql.Timestamp}. The specified @code{Calendar} is used + to generate a value for the timestamp if the database does not support + timezones. +@end deftypemethod +@deftypemethod ResultSetMetaData {public int} getColumnCount () @*throws SQLException +This method returns the number of columns in the result set. +@end deftypemethod +@deftypemethod ResultSetMetaData {public boolean} isAutoIncrement (int@w{ }@var{index}) @*throws SQLException +This method test whether or not the column is an auto-increment column. + Auto-increment columns are read-only. +@end deftypemethod +@deftypemethod ResultSetMetaData {public boolean} isCaseSensitive (int@w{ }@var{index}) @*throws SQLException +This method tests whether or not a column is case sensitive in its values. +@end deftypemethod +@deftypemethod ResultSetMetaData {public boolean} isSearchable (int@w{ }@var{index}) @*throws SQLException +This method tests whether not the specified column can be used in + a WHERE clause. +@end deftypemethod +@deftypemethod ResultSetMetaData {public boolean} isCurrency (int@w{ }@var{index}) @*throws SQLException +This method tests whether or not the column stores a monetary value. +@end deftypemethod +@deftypemethod ResultSetMetaData {public int} isNullable (int@w{ }@var{index}) @*throws SQLException +This method returns a value indicating whether or not the specified + column may contain a NULL value. +@end deftypemethod +@deftypemethod ResultSetMetaData {public boolean} isSigned (int@w{ }@var{index}) @*throws SQLException +This method tests whether or not the value of the specified column + is signed or unsigned. +@end deftypemethod +@deftypemethod ResultSetMetaData {public int} getColumnDisplaySize (int@w{ }@var{index}) @*throws SQLException +This method returns the maximum number of characters that can be used + to display a value in this column. +@end deftypemethod +@deftypemethod ResultSetMetaData {public String} getColumnLabel (int@w{ }@var{index}) @*throws SQLException +This method returns a string that should be used as a caption for this + column for user display purposes. +@end deftypemethod +@deftypemethod ResultSetMetaData {public String} getColumnName (int@w{ }@var{index}) @*throws SQLException +This method returns the name of the specified column. +@end deftypemethod +@deftypemethod ResultSetMetaData {public String} getSchemaName (int@w{ }@var{index}) @*throws SQLException +This method returns the name of the schema that contains the specified + column. +@end deftypemethod +@deftypemethod ResultSetMetaData {public int} getPrecision (int@w{ }@var{index}) @*throws SQLException +This method returns the precision of the specified column, which is the + number of decimal digits it contains. +@end deftypemethod +@deftypemethod ResultSetMetaData {public int} getScale (int@w{ }@var{index}) @*throws SQLException +This method returns the scale of the specified column, which is the + number of digits to the right of the decimal point. +@end deftypemethod +@deftypemethod ResultSetMetaData {public String} getTableName (int@w{ }@var{index}) @*throws SQLException +This method returns the name of the table containing the specified + column. +@end deftypemethod +@deftypemethod ResultSetMetaData {public String} getCatalogName (int@w{ }@var{index}) @*throws SQLException +This method returns the name of the catalog containing the specified + column. +@end deftypemethod +@deftypemethod ResultSetMetaData {public int} getColumnType (int@w{ }@var{index}) @*throws SQLException +This method returns the SQL type of the specified column. This will + be one of the constants from @code{Types}. +@end deftypemethod +@deftypemethod ResultSetMetaData {public String} getColumnTypeName (int@w{ }@var{index}) @*throws SQLException +This method returns the name of the SQL type for this column. +@end deftypemethod +@deftypemethod ResultSetMetaData {public boolean} isReadOnly (int@w{ }@var{index}) @*throws SQLException +This method tests whether or not the specified column is read only. +@end deftypemethod +@deftypemethod ResultSetMetaData {public boolean} isWritable (int@w{ }@var{index}) @*throws SQLException +This method tests whether or not the column may be writable. This + does not guarantee that a write will be successful. +@end deftypemethod +@deftypemethod ResultSetMetaData {public boolean} isDefinitelyWritable (int@w{ }@var{index}) @*throws SQLException +This method tests whether or not the column is writable. This + does guarantee that a write will be successful. +@end deftypemethod +@deftypemethod ResultSetMetaData {public String} getColumnClassName (int@w{ }@var{index}) @*throws SQLException +This method returns the name of the Java class which will be used to + create objects representing the data in this column. +@end deftypemethod +@deftypemethod SQLData {public String} getSQLTypeName () @*throws SQLException +This method returns the user defined datatype name for this object. +@end deftypemethod +@deftypemethod SQLData {public void} readSQL (java.sql.SQLInput@w{ }@var{stream}, java.lang.String@w{ }@var{name}) @*throws SQLException +This method populates the data in the object from the specified stream. +@end deftypemethod +@deftypemethod SQLData {public void} writeSQL (java.sql.SQLOutput@w{ }@var{stream}) @*throws SQLException +This method writes the data in this object to the specified stream. +@end deftypemethod +@deftypemethod SQLException {public String} getSQLState () +This method returns the SQLState information associated with this + error. The value returned is a @code{String} which is formatted + using the XOPEN SQL state conventions. +@end deftypemethod +@deftypemethod SQLException {public int} getErrorCode () +This method returns the vendor specific error code associated with + this error. +@end deftypemethod +@deftypemethod SQLException {public SQLException} getNextException () +This method returns the exception that is chained to this object. +@end deftypemethod +@deftypemethod SQLException {public void} setNextException (java.sql.SQLException@w{ }@var{e}) +This method adds a new exception to the end of the chain of exceptions + that are chained to this object. +@end deftypemethod +@deftypemethod SQLInput {public String} readString () @*throws SQLException +This method reads the next item from the stream a Java + @code{String}. +@end deftypemethod +@deftypemethod SQLInput {public boolean} readBoolean () @*throws SQLException +This method reads the next item from the stream a Java + @code{boolean}. +@end deftypemethod +@deftypemethod SQLInput {public byte} readByte () @*throws SQLException +This method reads the next item from the stream a Java + @code{byte}. +@end deftypemethod +@deftypemethod SQLInput {public short} readShort () @*throws SQLException +This method reads the next item from the stream a Java + @code{short}. +@end deftypemethod +@deftypemethod SQLInput {public int} readInt () @*throws SQLException +This method reads the next item from the stream a Java + @code{int}. +@end deftypemethod +@deftypemethod SQLInput {public long} readLong () @*throws SQLException +This method reads the next item from the stream a Java + @code{long}. +@end deftypemethod +@deftypemethod SQLInput {public float} readFloat () @*throws SQLException +This method reads the next item from the stream a Java + @code{float}. +@end deftypemethod +@deftypemethod SQLInput {public double} readDouble () @*throws SQLException +This method reads the next item from the stream a Java + @code{double}. +@end deftypemethod +@deftypemethod SQLInput {public BigDecimal} readBigDecimal () @*throws SQLException +This method reads the next item from the stream a Java + @code{BigDecimal}. +@end deftypemethod +@deftypemethod SQLInput {public byte} readBytes () @*throws SQLException +This method reads the next item from the stream a Java + byte array +@end deftypemethod +@deftypemethod SQLInput {public Date} readDate () @*throws SQLException +This method reads the next item from the stream a Java + @code{java.sql.Date}. +@end deftypemethod +@deftypemethod SQLInput {public Time} readTime () @*throws SQLException +This method reads the next item from the stream a Java + @code{java.sql.Time}. +@end deftypemethod +@deftypemethod SQLInput {public Timestamp} readTimestamp () @*throws SQLException +This method reads the next item from the stream a Java + @code{java.sql.Timestamp}. +@end deftypemethod +@deftypemethod SQLInput {public InputStream} readAsciiStream () @*throws SQLException +This method reads the next item from the stream a ASCII text + @code{InputStream}. +@end deftypemethod +@deftypemethod SQLInput {public InputStream} readBinaryStream () @*throws SQLException +This method reads the next item from the stream a binary + @code{InputStream}. +@end deftypemethod +@deftypemethod SQLInput {public Reader} readCharacterStream () @*throws SQLException +This method reads the next item from the stream a character + @code{Reader}. +@end deftypemethod +@deftypemethod SQLInput {public Object} readObject () @*throws SQLException +This method reads the next item from the stream a Java + @code{Object}. +@end deftypemethod +@deftypemethod SQLInput {public Ref} readRef () @*throws SQLException +This method reads the next item from the stream a Java SQL + @code{Ref}. +@end deftypemethod +@deftypemethod SQLInput {public Blob} readBlob () @*throws SQLException +This method reads the next item from the stream a Java SQL + @code{Blob}. +@end deftypemethod +@deftypemethod SQLInput {public Clob} readClob () @*throws SQLException +This method reads the next item from the stream a Java SQL + @code{Clob}. +@end deftypemethod +@deftypemethod SQLInput {public Array} readArray () @*throws SQLException +This method reads the next item from the stream a Java SQL + @code{Array}. +@end deftypemethod +@deftypemethod SQLInput {public boolean} wasNull () @*throws SQLException +This method tests whether or not the last value read was a SQL + NULL value. +@end deftypemethod +@deftypemethod SQLOutput {public void} writeString (java.lang.String@w{ }@var{value}) @*throws SQLException +This method writes the specified Java @code{String} + to the SQL stream. +@end deftypemethod +@deftypemethod SQLOutput {public void} writeBoolean (boolean@w{ }@var{value}) @*throws SQLException +This method writes the specified Java @code{boolean} + to the SQL stream. +@end deftypemethod +@deftypemethod SQLOutput {public void} writeByte (byte@w{ }@var{value}) @*throws SQLException +This method writes the specified Java @code{byte} + to the SQL stream. +@end deftypemethod +@deftypemethod SQLOutput {public void} writeShort (short@w{ }@var{value}) @*throws SQLException +This method writes the specified Java @code{short} + to the SQL stream. +@end deftypemethod +@deftypemethod SQLOutput {public void} writeInt (int@w{ }@var{value}) @*throws SQLException +This method writes the specified Java @code{int} + to the SQL stream. +@end deftypemethod +@deftypemethod SQLOutput {public void} writeLong (long@w{ }@var{value}) @*throws SQLException +This method writes the specified Java @code{long} + to the SQL stream. +@end deftypemethod +@deftypemethod SQLOutput {public void} writeFloat (float@w{ }@var{value}) @*throws SQLException +This method writes the specified Java @code{float} + to the SQL stream. +@end deftypemethod +@deftypemethod SQLOutput {public void} writeDouble (double@w{ }@var{value}) @*throws SQLException +This method writes the specified Java @code{double} + to the SQL stream. +@end deftypemethod +@deftypemethod SQLOutput {public void} writeBigDecimal (java.math.BigDecimal@w{ }@var{value}) @*throws SQLException +This method writes the specified Java @code{BigDecimal} + to the SQL stream. +@end deftypemethod +@deftypemethod SQLOutput {public void} writeBytes (byte[]@w{ }@var{value}) @*throws SQLException +This method writes the specified Java @code{byte} array + to the SQL stream. +@end deftypemethod +@deftypemethod SQLOutput {public void} writeDate (java.sql.Date@w{ }@var{value}) @*throws SQLException +This method writes the specified Java @code{java.sql.Date} + to the SQL stream. +@end deftypemethod +@deftypemethod SQLOutput {public void} writeTime (java.sql.Time@w{ }@var{value}) @*throws SQLException +This method writes the specified Java @code{java.sql.Time} + to the SQL stream. +@end deftypemethod +@deftypemethod SQLOutput {public void} writeTimestamp (java.sql.Timestamp@w{ }@var{value}) @*throws SQLException +This method writes the specified Java @code{java.sql.Timestamp} + to the SQL stream. +@end deftypemethod +@deftypemethod SQLOutput {public void} writeCharacterStream (java.io.Reader@w{ }@var{value}) @*throws SQLException +This method writes the specified Java character stream + to the SQL stream. +@end deftypemethod +@deftypemethod SQLOutput {public void} writeBinaryStream (java.io.InputStream@w{ }@var{value}) @*throws SQLException +This method writes the specified uninterpreted binary byte stream + to the SQL stream. +@end deftypemethod +@deftypemethod SQLOutput {public void} writeAsciiStream (java.io.InputStream@w{ }@var{value}) @*throws SQLException +This method writes the specified ASCII text stream + to the SQL stream. +@end deftypemethod +@deftypemethod SQLOutput {public void} writeObject (java.sql.SQLData@w{ }@var{value}) @*throws SQLException +This method writes the specified Java @code{SQLData} object + to the SQL stream. +@end deftypemethod +@deftypemethod SQLOutput {public void} writeRef (java.sql.Ref@w{ }@var{value}) @*throws SQLException +This method writes the specified Java SQL @code{Ref} object + to the SQL stream. +@end deftypemethod +@deftypemethod SQLOutput {public void} writeBlob (java.sql.Blob@w{ }@var{value}) @*throws SQLException +This method writes the specified Java SQL @code{Blob} object + to the SQL stream. +@end deftypemethod +@deftypemethod SQLOutput {public void} writeClob (java.sql.Clob@w{ }@var{value}) @*throws SQLException +This method writes the specified Java SQL @code{Clob} object + to the SQL stream. +@end deftypemethod +@deftypemethod SQLOutput {public void} writeStruct (java.sql.Struct@w{ }@var{value}) @*throws SQLException +This method writes the specified Java SQL @code{Struct} object + to the SQL stream. +@end deftypemethod +@deftypemethod SQLOutput {public void} writeArray (java.sql.Array@w{ }@var{value}) @*throws SQLException +This method writes the specified Java SQL @code{Array} object + to the SQL stream. +@end deftypemethod +@deftypemethod SQLWarning {public SQLWarning} getNextWarning () +This method returns the exception that is chained to this object. +@end deftypemethod +@deftypemethod SQLWarning {public void} setNextWarning (java.sql.SQLWarning@w{ }@var{e}) +This method adds a new exception to the end of the chain of exceptions + that are chained to this object. +@end deftypemethod +@deftypemethod Statement {public ResultSet} executeQuery (java.lang.String@w{ }@var{sql}) @*throws SQLException +This method executes the specified SQL SELECT statement and returns a + (possibly empty) @code{ResultSet} with the results of the query. +@end deftypemethod +@deftypemethod Statement {public int} executeUpdate (java.lang.String@w{ }@var{sql}) @*throws SQLException +This method executes the specified SQL INSERT, UPDATE, or DELETE statement + and returns the number of rows affected, which may be 0. +@end deftypemethod +@deftypemethod Statement {public void} close () @*throws SQLException +This method closes the statement and frees any associated resources. +@end deftypemethod +@deftypemethod Statement {public int} getMaxFieldSize () @*throws SQLException +This method returns the maximum length of any column value in bytes. +@end deftypemethod +@deftypemethod Statement {public void} setMaxFieldSize (int@w{ }@var{maxsize}) @*throws SQLException +This method sets the limit for the maximum length of any column in bytes. +@end deftypemethod +@deftypemethod Statement {public int} getMaxRows () @*throws SQLException +This method returns the maximum possible number of rows in a result set. +@end deftypemethod +@deftypemethod Statement {public void} setMaxRows (int@w{ }@var{maxrows}) @*throws SQLException +This method sets the maximum number of rows that can be present in a + result set. +@end deftypemethod +@deftypemethod Statement {public void} setEscapeProcessing (boolean@w{ }@var{esacpe}) @*throws SQLException +This method sets the local escape processing mode on or off. The + default value is on. +@end deftypemethod +@deftypemethod Statement {public int} getQueryTimeout () @*throws SQLException +The method returns the number of seconds a statement may be in process + before timing out. A value of 0 means there is no timeout. +@end deftypemethod +@deftypemethod Statement {public void} setQueryTimeout (int@w{ }@var{timeout}) @*throws SQLException +This method sets the number of seconds a statement may be in process + before timing out. A value of 0 means there is no timeout. +@end deftypemethod +@deftypemethod Statement {public void} cancel () @*throws SQLException +This method cancels an outstanding statement, if the database supports + that operation. +@end deftypemethod +@deftypemethod Statement {public SQLWarning} getWarnings () @*throws SQLException +This method returns the first SQL warning attached to this statement. + Subsequent warnings will be chained to this one. +@end deftypemethod +@deftypemethod Statement {public void} clearWarnings () @*throws SQLException +This method clears any SQL warnings that have been attached to this + statement. +@end deftypemethod +@deftypemethod Statement {public void} setCursorName (java.lang.String@w{ }@var{name}) @*throws SQLException +This method sets the cursor name that will be used by the result set. +@end deftypemethod +@deftypemethod Statement {public boolean} execute (java.lang.String@w{ }@var{sql}) @*throws SQLException +This method executes an arbitrary SQL statement of any time. The + methods @code{getResultSet}, @code{getMoreResults} and + @code{getUpdateCount} retrieve the results. +@end deftypemethod +@deftypemethod Statement {public ResultSet} getResultSet () @*throws SQLException +This method returns the result set of the SQL statement that was + executed. This should be called only once per result set returned. +@end deftypemethod +@deftypemethod Statement {public int} getUpdateCount () @*throws SQLException +This method returns the update count of the SQL statement that was + executed. This should be called only once per executed SQL statement. +@end deftypemethod +@deftypemethod Statement {public boolean} getMoreResults () @*throws SQLException +This method advances the result set pointer to the next result set, + which can then be retrieved using @code{getResultSet} +@end deftypemethod +@deftypemethod Statement {public int} getFetchDirection () @*throws SQLException +This method returns the current direction that the driver thinks the + result set will be accessed int. +@end deftypemethod +@deftypemethod Statement {public void} setFetchDirection (int@w{ }@var{direction}) @*throws SQLException +This method informs the driver which direction the result set will + be accessed in. +@end deftypemethod +@deftypemethod Statement {public int} getFetchSize () @*throws SQLException +This method returns the number of rows the driver believes should be + fetched from the database at a time. +@end deftypemethod +@deftypemethod Statement {public void} setFetchSize (int@w{ }@var{numrows}) @*throws SQLException +This method informs the driver how many rows it should fetch from the + database at a time. +@end deftypemethod +@deftypemethod Statement {public int} getResultSetConcurrency () @*throws SQLException +This method returns the concurrency type of the result set for this + statement. This will be one of the concurrency types defined in + @code{ResultSet}. +@end deftypemethod +@deftypemethod Statement {public int} getResultSetType () @*throws SQLException +This method returns the result set type for this statement. This will + be one of the result set types defined in @code{ResultSet}. +@end deftypemethod +@deftypemethod Statement {public void} addBatch (java.lang.String@w{ }@var{sql}) @*throws SQLException +This method adds a SQL statement to a SQL batch. A driver is not + required to implement this method. +@end deftypemethod +@deftypemethod Statement {public void} clearBatch () @*throws SQLException +This method clears out any SQL statements that have been populated in + the current batch. A driver is not required to implement this method. +@end deftypemethod +@deftypemethod Statement {public int} executeBatch () @*throws SQLException +This method executes the SQL batch and returns an array of update + counts - one for each SQL statement in the batch - ordered in the same + order the statements were added to the batch. A driver is not required + to implement this method. +@end deftypemethod +@deftypemethod Statement {public Connection} getConnection () @*throws SQLException +This method returns the @code{Connection} instance that was + used to create this object. +@end deftypemethod +@deftypemethod Struct {public String} getSQLTypeName () @*throws SQLException +This method returns the name of the SQL structured type for this + object. +@end deftypemethod +@deftypemethod Struct {public Object} getAttributes () @*throws SQLException +This method returns the attributes of this SQL structured type. +@end deftypemethod +@deftypemethod Struct {public Object} getAttributes (java.util.Map@w{ }@var{map}) @*throws SQLException +This method returns the attributes of this SQL structured type. + The specified map of type mappings overrides the default mappings. +@end deftypemethod +@deftypemethod Time {public static Time} valueOf (java.lang.String@w{ }@var{str}) +This method returns a new instance of this class by parsing a + date in JDBC format into a Java date. +@end deftypemethod +@deftypemethod Time {public String} toString () +This method returns this date in JDBC format. +@end deftypemethod +@deftypemethod Timestamp {public static Timestamp} valueOf (java.lang.String@w{ }@var{str}) +This method returns a new instance of this class by parsing a + date in JDBC format into a Java date. +@end deftypemethod +@deftypemethod Timestamp {public String} toString () +This method returns this date in JDBC format. +@end deftypemethod +@deftypemethod Timestamp {public int} getNanos () +This method returns the nanosecond value for this object. +@end deftypemethod +@deftypemethod Timestamp {public void} setNanos (int@w{ }@var{nanos}) +This method sets the nanosecond value for this object. +@end deftypemethod +@deftypemethod Timestamp {public boolean} before (java.sql.Timestamp@w{ }@var{ts}) +This methods tests whether this object is earlier than the specified + object. +@end deftypemethod +@deftypemethod Timestamp {public boolean} after (java.sql.Timestamp@w{ }@var{ts}) +This methods tests whether this object is later than the specified + object. +@end deftypemethod +@deftypemethod Timestamp {public boolean} equals (java.lang.Object@w{ }@var{obj}) +This method these the specified @code{Object} for equality + against this object. This will be true if an only if the specified + object is an instance of @code{Timestamp} and has the same + time value fields. +@end deftypemethod +@deftypemethod Timestamp {public boolean} equals (java.sql.Timestamp@w{ }@var{ts}) +This method tests the specified timestamp for equality against this + object. This will be true if and only if the specified object is + not @code{null} and contains all the same time value fields + as this object. +@end deftypemethod diff --git a/libjava/doc/java-text.texi b/libjava/doc/java-text.texi new file mode 100644 index 00000000000..fd6cecc4638 --- /dev/null +++ b/libjava/doc/java-text.texi @@ -0,0 +1,859 @@ +@deftypemethod BreakIterator {public abstract int} current () + +@end deftypemethod +@deftypemethod BreakIterator {public abstract int} first () + +@end deftypemethod +@deftypemethod BreakIterator {public abstract int} following (int@w{ }@var{pos}) + +@end deftypemethod +@deftypemethod BreakIterator {public static synchronized Locale} getAvailableLocales () + +@end deftypemethod +@deftypemethod BreakIterator {public static BreakIterator} getCharacterInstance () + +@end deftypemethod +@deftypemethod BreakIterator {public static BreakIterator} getCharacterInstance (java.util.Locale@w{ }@var{loc}) + +@end deftypemethod +@deftypemethod BreakIterator {public static BreakIterator} getLineInstance () + +@end deftypemethod +@deftypemethod BreakIterator {public static BreakIterator} getLineInstance (java.util.Locale@w{ }@var{loc}) + +@end deftypemethod +@deftypemethod BreakIterator {public static BreakIterator} getSentenceInstance () + +@end deftypemethod +@deftypemethod BreakIterator {public static BreakIterator} getSentenceInstance (java.util.Locale@w{ }@var{loc}) + +@end deftypemethod +@deftypemethod BreakIterator {public abstract CharacterIterator} getText () + +@end deftypemethod +@deftypemethod BreakIterator {public static BreakIterator} getWordInstance () + +@end deftypemethod +@deftypemethod BreakIterator {public static BreakIterator} getWordInstance (java.util.Locale@w{ }@var{loc}) + +@end deftypemethod +@deftypemethod BreakIterator {public boolean} isBoundary (int@w{ }@var{pos}) + +@end deftypemethod +@deftypemethod BreakIterator {public abstract int} last () + +@end deftypemethod +@deftypemethod BreakIterator {public abstract int} next () + +@end deftypemethod +@deftypemethod BreakIterator {public abstract int} next (int@w{ }@var{n}) + +@end deftypemethod +@deftypemethod BreakIterator {public int} preceding (int@w{ }@var{pos}) + +@end deftypemethod +@deftypemethod BreakIterator {public abstract int} previous () + +@end deftypemethod +@deftypemethod BreakIterator {public void} setText (java.lang.String@w{ }@var{newText}) + +@end deftypemethod +@deftypemethod BreakIterator {public abstract void} setText (java.text.CharacterIterator@w{ }@var{newText}) + +@end deftypemethod +@deftypemethod CharacterIterator {public Object} clone () + +@end deftypemethod +@deftypemethod CharacterIterator {public char} current () + +@end deftypemethod +@deftypemethod CharacterIterator {public char} first () + +@end deftypemethod +@deftypemethod CharacterIterator {public int} getBeginIndex () + +@end deftypemethod +@deftypemethod CharacterIterator {public int} getEndIndex () + +@end deftypemethod +@deftypemethod CharacterIterator {public int} getIndex () + +@end deftypemethod +@deftypemethod CharacterIterator {public char} last () + +@end deftypemethod +@deftypemethod CharacterIterator {public char} next () + +@end deftypemethod +@deftypemethod CharacterIterator {public char} previous () + +@end deftypemethod +@deftypemethod CharacterIterator {public char} setIndex (int@w{ }@var{idx}) + +@end deftypemethod +@deftypemethod ChoiceFormat {public void} applyPattern (java.lang.String@w{ }@var{newPattern}) + +@end deftypemethod +@deftypemethod ChoiceFormat {public Object} clone () + +@end deftypemethod +@deftypemethod ChoiceFormat {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod ChoiceFormat {public StringBuffer} format (long@w{ }@var{num}, java.lang.StringBuffer@w{ }@var{appendBuf}, java.text.FieldPosition@w{ }@var{pos}) + +@end deftypemethod +@deftypemethod ChoiceFormat {public StringBuffer} format (double@w{ }@var{num}, java.lang.StringBuffer@w{ }@var{appendBuf}, java.text.FieldPosition@w{ }@var{pos}) + +@end deftypemethod +@deftypemethod ChoiceFormat {public Object} getFormats () + +@end deftypemethod +@deftypemethod ChoiceFormat {public double} getLimits () + +@end deftypemethod +@deftypemethod ChoiceFormat {public int} hashCode () + +@end deftypemethod +@deftypemethod ChoiceFormat {public static final double} nextDouble (double@w{ }@var{d}) + +@end deftypemethod +@deftypemethod ChoiceFormat {public static double} nextDouble (double@w{ }@var{d}, boolean@w{ }@var{next}) + +@end deftypemethod +@deftypemethod ChoiceFormat {public Number} parse (java.lang.String@w{ }@var{sourceStr}, java.text.ParsePosition@w{ }@var{pos}) + +@end deftypemethod +@deftypemethod ChoiceFormat {public static final double} previousDouble (double@w{ }@var{d}) + +@end deftypemethod +@deftypemethod ChoiceFormat {public void} setChoices (double[]@w{ }@var{choiceLimits}, java.lang.String[]@w{ }@var{choiceFormats}) + +@end deftypemethod +@deftypemethod ChoiceFormat {public String} toPattern () + +@end deftypemethod +@deftypemethod CollationElementIterator {public int} next () + +@end deftypemethod +@deftypemethod CollationElementIterator {public static final int} primaryOrder (int@w{ }@var{order}) + +@end deftypemethod +@deftypemethod CollationElementIterator {public void} reset () + +@end deftypemethod +@deftypemethod CollationElementIterator {public static final short} secondaryOrder (int@w{ }@var{order}) + +@end deftypemethod +@deftypemethod CollationElementIterator {public static final short} tertiaryOrder (int@w{ }@var{order}) + +@end deftypemethod +@deftypemethod CollationKey {public int} compareTo (java.text.CollationKey@w{ }@var{target}) + +@end deftypemethod +@deftypemethod CollationKey {public int} compareTo (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod CollationKey {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod CollationKey {public String} getSourceString () + +@end deftypemethod +@deftypemethod CollationKey {public int} hashCode () + +@end deftypemethod +@deftypemethod CollationKey {public byte} toByteArray () + +@end deftypemethod +@deftypemethod Collator {public abstract int} compare (java.lang.String@w{ }@var{source}, java.lang.String@w{ }@var{target}) + +@end deftypemethod +@deftypemethod Collator {public int} compare (java.lang.Object@w{ }@var{o1}, java.lang.Object@w{ }@var{o2}) + +@end deftypemethod +@deftypemethod Collator {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod Collator {public boolean} equals (java.lang.String@w{ }@var{source}, java.lang.String@w{ }@var{target}) + +@end deftypemethod +@deftypemethod Collator {public Object} clone () + +@end deftypemethod +@deftypemethod Collator {public static synchronized Locale} getAvailableLocales () + +@end deftypemethod +@deftypemethod Collator {public abstract CollationKey} getCollationKey (java.lang.String@w{ }@var{source}) + +@end deftypemethod +@deftypemethod Collator {public synchronized int} getDecomposition () + +@end deftypemethod +@deftypemethod Collator {public static Collator} getInstance () + +@end deftypemethod +@deftypemethod Collator {public static Collator} getInstance (java.util.Locale@w{ }@var{loc}) + +@end deftypemethod +@deftypemethod Collator {public synchronized int} getStrength () + +@end deftypemethod +@deftypemethod Collator {public abstract int} hashCode () + +@end deftypemethod +@deftypemethod Collator {public synchronized void} setDecomposition (int@w{ }@var{mode}) + +@end deftypemethod +@deftypemethod Collator {public synchronized void} setStrength (int@w{ }@var{strength}) + +@end deftypemethod +@deftypemethod DateFormat {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod DateFormat {public Object} clone () + +@end deftypemethod +@deftypemethod DateFormat {public final StringBuffer} format (java.lang.Object@w{ }@var{obj}, java.lang.StringBuffer@w{ }@var{buf}, java.text.FieldPosition@w{ }@var{pos}) + +@end deftypemethod +@deftypemethod DateFormat {public final String} format (java.util.Date@w{ }@var{date}) + +@end deftypemethod +@deftypemethod DateFormat {public abstract StringBuffer} format (java.util.Date@w{ }@var{date}, java.lang.StringBuffer@w{ }@var{buf}, java.text.FieldPosition@w{ }@var{pos}) + +@end deftypemethod +@deftypemethod DateFormat {public static Locale} getAvailableLocales () + +@end deftypemethod +@deftypemethod DateFormat {public Calendar} getCalendar () + +@end deftypemethod +@deftypemethod DateFormat {public static final DateFormat} getDateInstance () + +@end deftypemethod +@deftypemethod DateFormat {public static final DateFormat} getDateInstance (int@w{ }@var{style}) + +@end deftypemethod +@deftypemethod DateFormat {public static final DateFormat} getDateInstance (int@w{ }@var{style}, java.util.Locale@w{ }@var{loc}) + +@end deftypemethod +@deftypemethod DateFormat {public static final DateFormat} getDateTimeInstance () + +@end deftypemethod +@deftypemethod DateFormat {public static final DateFormat} getDateTimeInstance (int@w{ }@var{dateStyle}, int@w{ }@var{timeStyle}) + +@end deftypemethod +@deftypemethod DateFormat {public static final DateFormat} getDateTimeInstance (int@w{ }@var{dateStyle}, int@w{ }@var{timeStyle}, java.util.Locale@w{ }@var{loc}) + +@end deftypemethod +@deftypemethod DateFormat {public static final DateFormat} getInstance () + +@end deftypemethod +@deftypemethod DateFormat {public NumberFormat} getNumberFormat () + +@end deftypemethod +@deftypemethod DateFormat {public static final DateFormat} getTimeInstance () + +@end deftypemethod +@deftypemethod DateFormat {public static final DateFormat} getTimeInstance (int@w{ }@var{style}) + +@end deftypemethod +@deftypemethod DateFormat {public static final DateFormat} getTimeInstance (int@w{ }@var{style}, java.util.Locale@w{ }@var{loc}) + +@end deftypemethod +@deftypemethod DateFormat {public TimeZone} getTimeZone () + +@end deftypemethod +@deftypemethod DateFormat {public int} hashCode () + +@end deftypemethod +@deftypemethod DateFormat {public boolean} isLenient () + +@end deftypemethod +@deftypemethod DateFormat {public Date} parse (java.lang.String@w{ }@var{source}) @*throws ParseException + +@end deftypemethod +@deftypemethod DateFormat {public abstract Date} parse (java.lang.String@w{ }@var{source}, java.text.ParsePosition@w{ }@var{pos}) + +@end deftypemethod +@deftypemethod DateFormat {public Object} parseObject (java.lang.String@w{ }@var{source}, java.text.ParsePosition@w{ }@var{pos}) + +@end deftypemethod +@deftypemethod DateFormat {public void} setCalendar (java.util.Calendar@w{ }@var{calendar}) + +@end deftypemethod +@deftypemethod DateFormat {public void} setLenient (boolean@w{ }@var{lenient}) + +@end deftypemethod +@deftypemethod DateFormat {public void} setNumberFormat (java.text.NumberFormat@w{ }@var{numberFormat}) + +@end deftypemethod +@deftypemethod DateFormat {public void} setTimeZone (java.util.TimeZone@w{ }@var{timeZone}) + +@end deftypemethod +@deftypemethod DateFormatSymbols {public String} getAmPmStrings () + +@end deftypemethod +@deftypemethod DateFormatSymbols {public String} getEras () + +@end deftypemethod +@deftypemethod DateFormatSymbols {public String} getLocalPatternChars () + +@end deftypemethod +@deftypemethod DateFormatSymbols {public String} getMonths () + +@end deftypemethod +@deftypemethod DateFormatSymbols {public String} getShortMonths () + +@end deftypemethod +@deftypemethod DateFormatSymbols {public String} getShortWeekdays () + +@end deftypemethod +@deftypemethod DateFormatSymbols {public String} getWeekdays () + +@end deftypemethod +@deftypemethod DateFormatSymbols {public String} getZoneStrings () + +@end deftypemethod +@deftypemethod DateFormatSymbols {public void} setAmPmStrings (java.lang.String[]@w{ }@var{value}) + +@end deftypemethod +@deftypemethod DateFormatSymbols {public void} setEras (java.lang.String[]@w{ }@var{value}) + +@end deftypemethod +@deftypemethod DateFormatSymbols {public void} setLocalPatternChars (java.lang.String@w{ }@var{value}) + +@end deftypemethod +@deftypemethod DateFormatSymbols {public void} setMonths (java.lang.String[]@w{ }@var{value}) + +@end deftypemethod +@deftypemethod DateFormatSymbols {public void} setShortMonths (java.lang.String[]@w{ }@var{value}) + +@end deftypemethod +@deftypemethod DateFormatSymbols {public void} setShortWeekdays (java.lang.String[]@w{ }@var{value}) + +@end deftypemethod +@deftypemethod DateFormatSymbols {public void} setWeekdays (java.lang.String[]@w{ }@var{value}) + +@end deftypemethod +@deftypemethod DateFormatSymbols {public void} setZoneStrings (java.lang.String[][]@w{ }@var{value}) + +@end deftypemethod +@deftypemethod DateFormatSymbols {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod DateFormatSymbols {public Object} clone () + +@end deftypemethod +@deftypemethod DateFormatSymbols {public int} hashCode () + +@end deftypemethod +@deftypemethod DecimalFormat {public void} applyLocalizedPattern (java.lang.String@w{ }@var{pattern}) + +@end deftypemethod +@deftypemethod DecimalFormat {public void} applyPattern (java.lang.String@w{ }@var{pattern}) + +@end deftypemethod +@deftypemethod DecimalFormat {public Object} clone () + +@end deftypemethod +@deftypemethod DecimalFormat {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod DecimalFormat {public StringBuffer} format (double@w{ }@var{number}, java.lang.StringBuffer@w{ }@var{dest}, java.text.FieldPosition@w{ }@var{fieldPos}) + +@end deftypemethod +@deftypemethod DecimalFormat {public StringBuffer} format (long@w{ }@var{number}, java.lang.StringBuffer@w{ }@var{dest}, java.text.FieldPosition@w{ }@var{fieldPos}) + +@end deftypemethod +@deftypemethod DecimalFormat {public DecimalFormatSymbols} getDecimalFormatSymbols () + +@end deftypemethod +@deftypemethod DecimalFormat {public int} getGroupingSize () + +@end deftypemethod +@deftypemethod DecimalFormat {public int} getMultiplier () + +@end deftypemethod +@deftypemethod DecimalFormat {public String} getNegativePrefix () + +@end deftypemethod +@deftypemethod DecimalFormat {public String} getNegativeSuffix () + +@end deftypemethod +@deftypemethod DecimalFormat {public String} getPositivePrefix () + +@end deftypemethod +@deftypemethod DecimalFormat {public String} getPositiveSuffix () + +@end deftypemethod +@deftypemethod DecimalFormat {public int} hashCode () + +@end deftypemethod +@deftypemethod DecimalFormat {public boolean} isDecimalSeparatorAlwaysShown () + +@end deftypemethod +@deftypemethod DecimalFormat {public Number} parse (java.lang.String@w{ }@var{str}, java.text.ParsePosition@w{ }@var{pos}) + +@end deftypemethod +@deftypemethod DecimalFormat {public void} setDecimalFormatSymbols (java.text.DecimalFormatSymbols@w{ }@var{newSymbols}) + +@end deftypemethod +@deftypemethod DecimalFormat {public void} setDecimalSeparatorAlwaysShown (boolean@w{ }@var{newValue}) + +@end deftypemethod +@deftypemethod DecimalFormat {public void} setGroupingSize (int@w{ }@var{groupSize}) + +@end deftypemethod +@deftypemethod DecimalFormat {public void} setMaximumFractionDigits (int@w{ }@var{newValue}) + +@end deftypemethod +@deftypemethod DecimalFormat {public void} setMaximumIntegerDigits (int@w{ }@var{newValue}) + +@end deftypemethod +@deftypemethod DecimalFormat {public void} setMinimumFractionDigits (int@w{ }@var{newValue}) + +@end deftypemethod +@deftypemethod DecimalFormat {public void} setMinimumIntegerDigits (int@w{ }@var{newValue}) + +@end deftypemethod +@deftypemethod DecimalFormat {public void} setMultiplier (int@w{ }@var{newValue}) + +@end deftypemethod +@deftypemethod DecimalFormat {public void} setNegativePrefix (java.lang.String@w{ }@var{newValue}) + +@end deftypemethod +@deftypemethod DecimalFormat {public void} setNegativeSuffix (java.lang.String@w{ }@var{newValue}) + +@end deftypemethod +@deftypemethod DecimalFormat {public void} setPositivePrefix (java.lang.String@w{ }@var{newValue}) + +@end deftypemethod +@deftypemethod DecimalFormat {public void} setPositiveSuffix (java.lang.String@w{ }@var{newValue}) + +@end deftypemethod +@deftypemethod DecimalFormat {public String} toLocalizedPattern () + +@end deftypemethod +@deftypemethod DecimalFormat {public String} toPattern () + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public Object} clone () + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public String} getCurrencySymbol () + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public char} getDecimalSeparator () + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public char} getDigit () + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public char} getGroupingSeparator () + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public String} getInfinity () + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public String} getInternationalCurrencySymbol () + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public char} getMinusSign () + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public char} getMonetaryDecimalSeparator () + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public String} getNaN () + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public char} getPatternSeparator () + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public char} getPercent () + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public char} getPerMill () + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public char} getZeroDigit () + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public int} hashCode () + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public void} setCurrencySymbol (java.lang.String@w{ }@var{currency}) + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public void} setDecimalSeparator (char@w{ }@var{decimalSep}) + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public void} setDigit (char@w{ }@var{digit}) + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public void} setGroupingSeparator (char@w{ }@var{groupSep}) + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public void} setInfinity (java.lang.String@w{ }@var{infinity}) + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public void} setInternationalCurrencySymbol (java.lang.String@w{ }@var{currency}) + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public void} setMinusSign (char@w{ }@var{minusSign}) + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public void} setMonetaryDecimalSeparator (char@w{ }@var{decimalSep}) + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public void} setNaN (java.lang.String@w{ }@var{nan}) + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public void} setPatternSeparator (char@w{ }@var{patternSep}) + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public void} setPercent (char@w{ }@var{percent}) + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public void} setPerMill (char@w{ }@var{perMill}) + +@end deftypemethod +@deftypemethod DecimalFormatSymbols {public void} setZeroDigit (char@w{ }@var{zeroDigit}) + +@end deftypemethod +@deftypemethod FieldPosition {public int} getField () + +@end deftypemethod +@deftypemethod FieldPosition {public int} getBeginIndex () + +@end deftypemethod +@deftypemethod FieldPosition {public int} getEndIndex () + +@end deftypemethod +@deftypemethod FieldPosition {public void} setBeginIndex (int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod FieldPosition {public void} setEndIndex (int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod FieldPosition {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod Format {public abstract StringBuffer} format (java.lang.Object@w{ }@var{obj}, java.lang.StringBuffer@w{ }@var{sbuf}, java.text.FieldPosition@w{ }@var{pos}) + +@end deftypemethod +@deftypemethod Format {public final String} format (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod Format {public abstract Object} parseObject (java.lang.String@w{ }@var{source}, java.text.ParsePosition@w{ }@var{pos}) + +@end deftypemethod +@deftypemethod Format {public Object} parseObject (java.lang.String@w{ }@var{source}) @*throws ParseException + +@end deftypemethod +@deftypemethod Format {public Object} clone () + +@end deftypemethod +@deftypemethod MessageFormat {public void} applyPattern (java.lang.String@w{ }@var{newPattern}) + +@end deftypemethod +@deftypemethod MessageFormat {public Object} clone () + +@end deftypemethod +@deftypemethod MessageFormat {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod MessageFormat {public static String} format (java.lang.String@w{ }@var{pattern}, java.lang.Object[]@w{ }@var{arguments}) + +@end deftypemethod +@deftypemethod MessageFormat {public final StringBuffer} format (java.lang.Object[]@w{ }@var{arguments}, java.lang.StringBuffer@w{ }@var{appendBuf}, java.text.FieldPosition@w{ }@var{ignore}) + +@end deftypemethod +@deftypemethod MessageFormat {public final StringBuffer} format (java.lang.Object@w{ }@var{singleArg}, java.lang.StringBuffer@w{ }@var{appendBuf}, java.text.FieldPosition@w{ }@var{ignore}) + +@end deftypemethod +@deftypemethod MessageFormat {public Format} getFormats () + +@end deftypemethod +@deftypemethod MessageFormat {public Locale} getLocale () + +@end deftypemethod +@deftypemethod MessageFormat {public int} hashCode () + +@end deftypemethod +@deftypemethod MessageFormat {public Object} parse (java.lang.String@w{ }@var{sourceStr}, java.text.ParsePosition@w{ }@var{pos}) + +@end deftypemethod +@deftypemethod MessageFormat {public Object} parse (java.lang.String@w{ }@var{sourceStr}) @*throws ParseException + +@end deftypemethod +@deftypemethod MessageFormat {public Object} parseObject (java.lang.String@w{ }@var{sourceStr}, java.text.ParsePosition@w{ }@var{pos}) + +@end deftypemethod +@deftypemethod MessageFormat {public void} setFormat (int@w{ }@var{variableNum}, java.text.Format@w{ }@var{newFormat}) + +@end deftypemethod +@deftypemethod MessageFormat {public void} setFormats (java.text.Format[]@w{ }@var{newFormats}) + +@end deftypemethod +@deftypemethod MessageFormat {public void} setLocale (java.util.Locale@w{ }@var{loc}) + +@end deftypemethod +@deftypemethod MessageFormat {public String} toPattern () + +@end deftypemethod +@deftypemethod NumberFormat {public final String} format (long@w{ }@var{number}) + +@end deftypemethod +@deftypemethod NumberFormat {public final StringBuffer} format (java.lang.Object@w{ }@var{obj}, java.lang.StringBuffer@w{ }@var{sbuf}, java.text.FieldPosition@w{ }@var{pos}) + +@end deftypemethod +@deftypemethod NumberFormat {public abstract StringBuffer} format (double@w{ }@var{number}, java.lang.StringBuffer@w{ }@var{sbuf}, java.text.FieldPosition@w{ }@var{pos}) + +@end deftypemethod +@deftypemethod NumberFormat {public abstract StringBuffer} format (long@w{ }@var{number}, java.lang.StringBuffer@w{ }@var{sbuf}, java.text.FieldPosition@w{ }@var{pos}) + +@end deftypemethod +@deftypemethod NumberFormat {public Object} clone () + +@end deftypemethod +@deftypemethod NumberFormat {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod NumberFormat {public static Locale} getAvailableLocales () + +@end deftypemethod +@deftypemethod NumberFormat {public static final NumberFormat} getCurrencyInstance () + +@end deftypemethod +@deftypemethod NumberFormat {public static NumberFormat} getCurrencyInstance (java.util.Locale@w{ }@var{loc}) + +@end deftypemethod +@deftypemethod NumberFormat {public static final NumberFormat} getInstance () + +@end deftypemethod +@deftypemethod NumberFormat {public static NumberFormat} getInstance (java.util.Locale@w{ }@var{loc}) + +@end deftypemethod +@deftypemethod NumberFormat {public int} getMaximumFractionDigits () + +@end deftypemethod +@deftypemethod NumberFormat {public int} getMaximumIntegerDigits () + +@end deftypemethod +@deftypemethod NumberFormat {public int} getMinimumFractionDigits () + +@end deftypemethod +@deftypemethod NumberFormat {public int} getMinimumIntegerDigits () + +@end deftypemethod +@deftypemethod NumberFormat {public static final NumberFormat} getNumberInstance () + +@end deftypemethod +@deftypemethod NumberFormat {public static NumberFormat} getNumberInstance (java.util.Locale@w{ }@var{loc}) + +@end deftypemethod +@deftypemethod NumberFormat {public static final NumberFormat} getPercentInstance () + +@end deftypemethod +@deftypemethod NumberFormat {public static NumberFormat} getPercentInstance (java.util.Locale@w{ }@var{loc}) + +@end deftypemethod +@deftypemethod NumberFormat {public int} hashCode () + +@end deftypemethod +@deftypemethod NumberFormat {public boolean} isGroupingUsed () + +@end deftypemethod +@deftypemethod NumberFormat {public boolean} isParseIntegerOnly () + +@end deftypemethod +@deftypemethod NumberFormat {public abstract Number} parse (java.lang.String@w{ }@var{sourceStr}, java.text.ParsePosition@w{ }@var{pos}) + +@end deftypemethod +@deftypemethod NumberFormat {public Number} parse (java.lang.String@w{ }@var{sourceStr}) @*throws ParseException + +@end deftypemethod +@deftypemethod NumberFormat {public final Object} parseObject (java.lang.String@w{ }@var{sourceStr}, java.text.ParsePosition@w{ }@var{pos}) + +@end deftypemethod +@deftypemethod NumberFormat {public void} setGroupingUsed (boolean@w{ }@var{newValue}) + +@end deftypemethod +@deftypemethod NumberFormat {public void} setMaximumFractionDigits (int@w{ }@var{newValue}) + +@end deftypemethod +@deftypemethod NumberFormat {public void} setMaximumIntegerDigits (int@w{ }@var{newValue}) + +@end deftypemethod +@deftypemethod NumberFormat {public void} setMinimumFractionDigits (int@w{ }@var{newValue}) + +@end deftypemethod +@deftypemethod NumberFormat {public void} setMinimumIntegerDigits (int@w{ }@var{newValue}) + +@end deftypemethod +@deftypemethod NumberFormat {public void} setParseIntegerOnly (boolean@w{ }@var{value}) + +@end deftypemethod +@deftypemethod NumberFormat {public final String} format (double@w{ }@var{number}) + +@end deftypemethod +@deftypemethod ParseException {public int} getErrorOffset () + +@end deftypemethod +@deftypemethod ParsePosition {public int} getIndex () + +@end deftypemethod +@deftypemethod ParsePosition {public void} setIndex (int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod ParsePosition {public int} getErrorIndex () + +@end deftypemethod +@deftypemethod ParsePosition {public void} setErrorIndex (int@w{ }@var{ei}) + +@end deftypemethod +@deftypemethod ParsePosition {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod RuleBasedCollator {public Object} clone () + +@end deftypemethod +@deftypemethod RuleBasedCollator {public int} compare (java.lang.String@w{ }@var{source}, java.lang.String@w{ }@var{target}) + +@end deftypemethod +@deftypemethod RuleBasedCollator {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod RuleBasedCollator {public CollationElementIterator} getCollationElementIterator (java.lang.String@w{ }@var{source}) + +@end deftypemethod +@deftypemethod RuleBasedCollator {public CollationElementIterator} getCollationElementIterator (java.text.CharacterIterator@w{ }@var{source}) + +@end deftypemethod +@deftypemethod RuleBasedCollator {public CollationKey} getCollationKey (java.lang.String@w{ }@var{source}) + +@end deftypemethod +@deftypemethod RuleBasedCollator {public String} getRules () + +@end deftypemethod +@deftypemethod RuleBasedCollator {public int} hashCode () + +@end deftypemethod +@deftypemethod SimpleDateFormat {public String} toString () + +@end deftypemethod +@deftypemethod SimpleDateFormat {public String} toPattern () +This method returns a string with the formatting pattern being used + by this object. This string is unlocalized. +@end deftypemethod +@deftypemethod SimpleDateFormat {public String} toLocalizedPattern () +This method returns a string with the formatting pattern being used + by this object. This string is localized. +@end deftypemethod +@deftypemethod SimpleDateFormat {public void} applyPattern (java.lang.String@w{ }@var{pattern}) +This method sets the formatting pattern that should be used by this + object. This string is not localized. +@end deftypemethod +@deftypemethod SimpleDateFormat {public void} applyLocalizedPattern (java.lang.String@w{ }@var{pattern}) +This method sets the formatting pattern that should be used by this + object. This string is localized. +@end deftypemethod +@deftypemethod SimpleDateFormat {public Date} get2DigitYearStart () +Returns the start of the century used for two digit years. +@end deftypemethod +@deftypemethod SimpleDateFormat {public void} set2DigitYearStart (java.util.Date@w{ }@var{date}) +Sets the start of the century used for two digit years. +@end deftypemethod +@deftypemethod SimpleDateFormat {public DateFormatSymbols} getDateFormatSymbols () +This method returns the format symbol information used for parsing + and formatting dates. +@end deftypemethod +@deftypemethod SimpleDateFormat {public void} setDateFormatSymbols (java.text.DateFormatSymbols@w{ }@var{formatData}) +This method sets the format symbols information used for parsing + and formatting dates. +@end deftypemethod +@deftypemethod SimpleDateFormat {public boolean} equals (java.lang.Object@w{ }@var{o}) +This methods tests whether the specified object is equal to this + object. This will be true if and only if the specified object: + + + + +@itemize @bullet + + +@item +Is not @code{null}. + +@item +Is an instance of @code{SimpleDateFormat}. + +@item +Is equal to this object at the superclass (i.e., @code{DateFormat}) + level. + +@item +Has the same formatting pattern. + +@item +Is using the same formatting symbols. + +@item +Is using the same century for two digit years. + +@end itemize + +@end deftypemethod +@deftypemethod SimpleDateFormat {public StringBuffer} format (java.util.Date@w{ }@var{date}, java.lang.StringBuffer@w{ }@var{buffer}, java.text.FieldPosition@w{ }@var{pos}) +Formats the date input according to the format string in use, + appending to the specified StringBuffer. The input StringBuffer + is returned as output for convenience. +@end deftypemethod +@deftypemethod SimpleDateFormat {public Date} parse (java.lang.String@w{ }@var{dateStr}, java.text.ParsePosition@w{ }@var{pos}) +This method parses the specified string into a date. +@end deftypemethod +@deftypemethod StringCharacterIterator {public Object} clone () + +@end deftypemethod +@deftypemethod StringCharacterIterator {public char} current () + +@end deftypemethod +@deftypemethod StringCharacterIterator {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod StringCharacterIterator {public char} first () + +@end deftypemethod +@deftypemethod StringCharacterIterator {public int} getBeginIndex () + +@end deftypemethod +@deftypemethod StringCharacterIterator {public int} getEndIndex () + +@end deftypemethod +@deftypemethod StringCharacterIterator {public int} getIndex () + +@end deftypemethod +@deftypemethod StringCharacterIterator {public int} hashCode () + +@end deftypemethod +@deftypemethod StringCharacterIterator {public char} last () + +@end deftypemethod +@deftypemethod StringCharacterIterator {public char} next () + +@end deftypemethod +@deftypemethod StringCharacterIterator {public char} previous () + +@end deftypemethod +@deftypemethod StringCharacterIterator {public char} setIndex (int@w{ }@var{idx}) + +@end deftypemethod +@deftypemethod StringCharacterIterator {public void} setText (java.lang.String@w{ }@var{text}) + +@end deftypemethod diff --git a/libjava/doc/java-util-jar.texi b/libjava/doc/java-util-jar.texi new file mode 100644 index 00000000000..7a36859f45c --- /dev/null +++ b/libjava/doc/java-util-jar.texi @@ -0,0 +1,188 @@ +@deftypemethod Attributes {public String} getValue (java.lang.String@w{ }@var{name}) +Gets the value of an attribute name given as a String. +@end deftypemethod +@deftypemethod Attributes {public String} getValue (java.util.jar.Attributes.Name@w{ }@var{name}) +Gets the value of the given attribute name. +@end deftypemethod +@deftypemethod Attributes {public String} putValue (java.lang.String@w{ }@var{name}, java.lang.String@w{ }@var{value}) +Stores an attribute name (represented by a String) and value in this + Attributes map. + When the (case insensitive string) name already exists the value is + replaced and the old value is returned. +@end deftypemethod +@deftypemethod Attributes {public Object} clone () +Return a clone of this attribute map. +@end deftypemethod +@deftypemethod Attributes {public void} clear () +Removes all attributes. +@end deftypemethod +@deftypemethod Attributes {public boolean} containsKey (java.lang.Object@w{ }@var{attrName}) +Checks to see if there is an attribute with the specified name. + XXX - what if the object is a String? +@end deftypemethod +@deftypemethod Attributes {public boolean} containsValue (java.lang.Object@w{ }@var{attrValue}) +Checks to see if there is an attribute name with the specified value. +@end deftypemethod +@deftypemethod Attributes {public Set} entrySet () +Gives a Set of attribute name and values pairs as MapEntries. +@end deftypemethod +@deftypemethod Attributes {public boolean} equals (java.lang.Object@w{ }@var{o}) +Checks to see if two Attributes are equal. The supplied object must be + a real instance of Attributes and contain the same attribute name/value + pairs. +@end deftypemethod +@deftypemethod Attributes {public Object} get (java.lang.Object@w{ }@var{attrName}) +Gets the value of a specified attribute name. + XXX - what if the object is a String? +@end deftypemethod +@deftypemethod Attributes {public int} hashCode () +Returns the hashcode of the attribute name/value map. +@end deftypemethod +@deftypemethod Attributes {public boolean} isEmpty () +Returns true if there are no attributes set, false otherwise. +@end deftypemethod +@deftypemethod Attributes {public Set} keySet () +Gives a Set of all the values of defined attribute names. +@end deftypemethod +@deftypemethod Attributes {public Object} put (java.lang.Object@w{ }@var{name}, java.lang.Object@w{ }@var{value}) +Adds or replaces a attribute name/value pair. + XXX - What if the name is a string? What if the name is neither a Name + nor a String? What if the value is not a string? +@end deftypemethod +@deftypemethod Attributes {public void} putAll (java.util.Map@w{ }@var{attr}) +Adds or replaces all attribute name/value pairs from another + Attributes object to this one. The supplied Map must be an instance of + Attributes. +@end deftypemethod +@deftypemethod Attributes {public Object} remove (java.lang.Object@w{ }@var{name}) +Remove a attribute name/value pair. + XXX - What if the name is a String? +@end deftypemethod +@deftypemethod Attributes {public int} size () +Returns the number of defined attribute name/value pairs. +@end deftypemethod +@deftypemethod Attributes {public Collection} values () +Returns all the values of the defined attribute name/value pairs as a + Collection. +@end deftypemethod +@deftypemethod Attributes.Name {public int} hashCode () +Returns the hash code of the (lowercase) String representation of + this Name. +@end deftypemethod +@deftypemethod Attributes.Name {public boolean} equals (java.lang.Object@w{ }@var{o}) +Checks if another object is equal to this Name object. + Another object is equal to this Name object if it is an instance of + Name and the (lowercase) string representation of the name is equal. +@end deftypemethod +@deftypemethod Attributes.Name {public String} toString () +Returns the string representation of this Name as given to the + constructor (not neccesarily the lower case representation). +@end deftypemethod +@deftypemethod JarEntry {public Attributes} getAttributes () @*throws IOException +Returns a copy of the Attributes set for this entry. + When no Attributes are set in the manifest null is returned. +@end deftypemethod +@deftypemethod JarEntry {public Certificate} getCertificates () +Returns a copy of the certificates set for this entry. + When no certificates are set or when not all data of this entry has + been read null is returned. + + + + To make sure that this call returns a valid value you must read all + data from the JarInputStream for this entry. + When you don't need the data for an entry but want to know the + certificates that are set for the entry then you can skip all data by + calling @code{skip(entry.getSize())} on the JarInputStream for + the entry. +@end deftypemethod +@deftypemethod JarFile {public Enumeration} entries () @*throws IllegalStateException +Returns a enumeration of all the entries in the JarFile. + Note that also the Jar META-INF entries are returned. +@end deftypemethod +@deftypemethod JarFile {public ZipEntry} getEntry (java.lang.String@w{ }@var{name}) +XXX + It actually returns a JarEntry not a zipEntry +@end deftypemethod +@deftypemethod JarFile {public synchronized InputStream} getInputStream (java.util.zip.ZipEntry@w{ }@var{entry}) @*throws ZipException, IOException +XXX should verify the inputstream +@end deftypemethod +@deftypemethod JarFile {public JarEntry} getJarEntry (java.lang.String@w{ }@var{name}) +Returns the JarEntry that belongs to the name if such an entry + exists in the JarFile. Returns null otherwise + Convenience method that just casts the result from @code{getEntry} + to a JarEntry. +@end deftypemethod +@deftypemethod JarFile {public Manifest} getManifest () +Returns the manifest for this JarFile or null when the JarFile does not + contain a manifest file. +@end deftypemethod +@deftypemethod JarInputStream {protected ZipEntry} createZipEntry (java.lang.String@w{ }@var{name}) +Creates a JarEntry for a particular name and consults the manifest + for the Attributes of the entry. + Used by @code{ZipEntry.getNextEntry()} +@end deftypemethod +@deftypemethod JarInputStream {public Manifest} getManifest () +Returns the Manifest for the jar file or null if there was no Manifest. +@end deftypemethod +@deftypemethod JarInputStream {public ZipEntry} getNextEntry () @*throws IOException +Returns the next entry or null when there are no more entries. + Does actually return a JarEntry, if you don't want to cast it yourself + use @code{getNextJarEntry()}. Does not return any entries found + at the beginning of the ZipFile that are special + (those that start with "META-INF/"). +@end deftypemethod +@deftypemethod JarInputStream {public JarEntry} getNextJarEntry () @*throws IOException +Returns the next jar entry or null when there are no more entries. +@end deftypemethod +@deftypemethod JarInputStream {public int} read (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException +XXX +@end deftypemethod +@deftypemethod JarOutputStream {public void} putNextEntry (java.util.zip.ZipEntry@w{ }@var{entry}) @*throws IOException +Prepares the JarOutputStream for writing the next entry. + This implementation just calls @code{super.putNextEntre()}. +@end deftypemethod +@deftypemethod Manifest {public Attributes} getMainAttributes () +Gets the main attributes of this Manifest. +@end deftypemethod +@deftypemethod Manifest {public Map} getEntries () +Gets a map of entry Strings to Attributes for all the entries described + in this manifest. Adding, changing or removing from this entries map + changes the entries of this manifest. +@end deftypemethod +@deftypemethod Manifest {public Attributes} getAttributes (java.lang.String@w{ }@var{entryName}) +Returns the Attributes associated with the Entry. + + + + Implemented as: + @code{return (Attributes)getEntries().get(entryName)} +@end deftypemethod +@deftypemethod Manifest {public void} clear () +Clears the main attributes and removes all the entries from the + manifest. +@end deftypemethod +@deftypemethod Manifest {public void} read (java.io.InputStream@w{ }@var{in}) @*throws IOException +XXX +@end deftypemethod +@deftypemethod Manifest {public void} write (java.io.OutputStream@w{ }@var{out}) @*throws IOException +XXX +@end deftypemethod +@deftypemethod Manifest {public Object} clone () +Makes a deep copy of the main attributes, but a shallow copy of + the other entries. This means that you can freely add, change or remove + the main attributes or the entries of the new manifest without effecting + the original manifest, but adding, changing or removing attributes from + a particular entry also changes the attributes of that entry in the + original manifest. Calls @code{new Manifest(this)}. +@end deftypemethod +@deftypemethod Manifest {public boolean} equals (java.lang.Object@w{ }@var{o}) +Checks if another object is equal to this Manifest object. + Another Object is equal to this Manifest object if it is an instance of + Manifest and the main attributes and the entries of the other manifest + are equal to this one. +@end deftypemethod +@deftypemethod Manifest {public int} hashCode () +Calculates the hash code of the manifest. Implemented by a xor of the + hash code of the main attributes with the hash code of the entries map. +@end deftypemethod diff --git a/libjava/doc/java-util-zip.texi b/libjava/doc/java-util-zip.texi new file mode 100644 index 00000000000..d084b69a00b --- /dev/null +++ b/libjava/doc/java-util-zip.texi @@ -0,0 +1,352 @@ +@deftypemethod Adler32 {public void} reset () +Resets the Adler32 data checksum as if no update was ever called. +@end deftypemethod +@deftypemethod Adler32 {public void} update (int@w{ }@var{bval}) +Adds one byte to the data checksum. +@end deftypemethod +@deftypemethod Adler32 {public void} update (byte[]@w{ }@var{buffer}) +Adds the complete byte array to the data checksum. +@end deftypemethod +@deftypemethod Adler32 {public void} update (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) +Adds the byte array to the data checksum. +@end deftypemethod +@deftypemethod Adler32 {public long} getValue () +Returns the Adler32 data checksum computed so far. +@end deftypemethod +@deftypemethod CheckedInputStream {public Checksum} getChecksum () +Returns the Checksum object used. To get the data checksum computed so + far call @code{getChecksum.getValue()}. +@end deftypemethod +@deftypemethod CheckedInputStream {public int} read () @*throws IOException +Reads one byte, updates the checksum and returns the read byte + (or -1 when the end of file was reached). +@end deftypemethod +@deftypemethod CheckedInputStream {public int} read (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException +Reads at most len bytes in the supplied buffer and updates the checksum + with it. Returns the number of bytes actually read or -1 when the end + of file was reached. +@end deftypemethod +@deftypemethod CheckedInputStream {public long} skip (long@w{ }@var{n}) @*throws IOException +Skips n bytes by reading them in a temporary buffer and updating the + the checksum with that buffer. Returns the actual number of bytes skiped + which can be less then requested when the end of file is reached. +@end deftypemethod +@deftypemethod CheckedOutputStream {public Checksum} getChecksum () +Returns the Checksum object used. To get the data checksum computed so + far call @code{getChecksum.getValue()}. +@end deftypemethod +@deftypemethod CheckedOutputStream {public void} write (int@w{ }@var{bval}) @*throws IOException +Writes one byte to the OutputStream and updates the Checksum. +@end deftypemethod +@deftypemethod CheckedOutputStream {public void} write (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException +Writes the byte array to the OutputStream and updates the Checksum. +@end deftypemethod +@deftypemethod Checksum {public long} getValue () +Returns the data checksum computed so far. +@end deftypemethod +@deftypemethod Checksum {public void} reset () +Resets the data checksum as if no update was ever called. +@end deftypemethod +@deftypemethod Checksum {public void} update (int@w{ }@var{bval}) +Adds one byte to the data checksum. +@end deftypemethod +@deftypemethod Checksum {public void} update (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) +Adds the byte array to the data checksum. +@end deftypemethod +@deftypemethod CRC32 {public long} getValue () +Returns the CRC32 data checksum computed so far. +@end deftypemethod +@deftypemethod CRC32 {public void} reset () +Resets the CRC32 data checksum as if no update was ever called. +@end deftypemethod +@deftypemethod CRC32 {public void} update (int@w{ }@var{bval}) + +@end deftypemethod +@deftypemethod CRC32 {public void} update (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) +Adds the byte array to the data checksum. +@end deftypemethod +@deftypemethod CRC32 {public void} update (byte[]@w{ }@var{buf}) +Adds the complete byte array to the data checksum. +@end deftypemethod +@deftypemethod Deflater {public int} deflate (byte[]@w{ }@var{buf}) + +@end deftypemethod +@deftypemethod Deflater {public native int} deflate (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) + +@end deftypemethod +@deftypemethod Deflater {public native void} end () + +@end deftypemethod +@deftypemethod Deflater {protected void} finalize () + +@end deftypemethod +@deftypemethod Deflater {public native void} finish () + +@end deftypemethod +@deftypemethod Deflater {public synchronized boolean} finished () + +@end deftypemethod +@deftypemethod Deflater {public native int} getAdler () + +@end deftypemethod +@deftypemethod Deflater {public native int} getTotalIn () + +@end deftypemethod +@deftypemethod Deflater {public native int} getTotalOut () + +@end deftypemethod +@deftypemethod Deflater {public native boolean} needsInput () + +@end deftypemethod +@deftypemethod Deflater {public native void} reset () + +@end deftypemethod +@deftypemethod Deflater {public void} setDictionary (byte[]@w{ }@var{buf}) + +@end deftypemethod +@deftypemethod Deflater {public native void} setDictionary (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) + +@end deftypemethod +@deftypemethod Deflater {public void} setInput (byte[]@w{ }@var{buf}) + +@end deftypemethod +@deftypemethod Deflater {public native void} setInput (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) + +@end deftypemethod +@deftypemethod Deflater {public synchronized void} setLevel (int@w{ }@var{lvl}) + +@end deftypemethod +@deftypemethod Deflater {public synchronized void} setStrategy (int@w{ }@var{stgy}) + +@end deftypemethod +@deftypemethod DeflaterOutputStream {public void} close () @*throws IOException + +@end deftypemethod +@deftypemethod DeflaterOutputStream {protected void} deflate () @*throws IOException + +@end deftypemethod +@deftypemethod DeflaterOutputStream {public void} finish () @*throws IOException + +@end deftypemethod +@deftypemethod DeflaterOutputStream {public void} write (int@w{ }@var{bval}) @*throws IOException + +@end deftypemethod +@deftypemethod DeflaterOutputStream {public void} write (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException + +@end deftypemethod +@deftypemethod GZIPInputStream {public void} close () @*throws IOException + +@end deftypemethod +@deftypemethod GZIPInputStream {public int} read (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException + +@end deftypemethod +@deftypemethod GZIPOutputStream {public void} close () @*throws IOException + +@end deftypemethod +@deftypemethod GZIPOutputStream {public void} finish () @*throws IOException + +@end deftypemethod +@deftypemethod GZIPOutputStream {public synchronized void} write (byte[]@w{ }@var{buf}) @*throws IOException + +@end deftypemethod +@deftypemethod GZIPOutputStream {public synchronized void} write (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException + +@end deftypemethod +@deftypemethod InflaterInputStream {protected void} fill () @*throws IOException + +@end deftypemethod +@deftypemethod InflaterInputStream {public int} read () @*throws IOException + +@end deftypemethod +@deftypemethod InflaterInputStream {public int} read (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException + +@end deftypemethod +@deftypemethod InflaterInputStream {public void} close () @*throws IOException + +@end deftypemethod +@deftypemethod InflaterInputStream {public int} available () @*throws IOException + +@end deftypemethod +@deftypemethod InflaterInputStream {public long} skip (long@w{ }@var{n}) @*throws IOException + +@end deftypemethod +@deftypemethod Inflater {public native void} end () + +@end deftypemethod +@deftypemethod Inflater {protected void} finalize () + +@end deftypemethod +@deftypemethod Inflater {public synchronized boolean} finished () + +@end deftypemethod +@deftypemethod Inflater {public native int} getAdler () + +@end deftypemethod +@deftypemethod Inflater {public native int} getRemaining () + +@end deftypemethod +@deftypemethod Inflater {public native int} getTotalIn () + +@end deftypemethod +@deftypemethod Inflater {public native int} getTotalOut () + +@end deftypemethod +@deftypemethod Inflater {public int} inflate (byte[]@w{ }@var{buf}) @*throws DataFormatException + +@end deftypemethod +@deftypemethod Inflater {public native int} inflate (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws DataFormatException + +@end deftypemethod +@deftypemethod Inflater {public synchronized boolean} needsDictionary () + +@end deftypemethod +@deftypemethod Inflater {public synchronized boolean} needsInput () + +@end deftypemethod +@deftypemethod Inflater {public native void} reset () + +@end deftypemethod +@deftypemethod Inflater {public void} setDictionary (byte[]@w{ }@var{buf}) + +@end deftypemethod +@deftypemethod Inflater {public native void} setDictionary (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) + +@end deftypemethod +@deftypemethod Inflater {public void} setInput (byte[]@w{ }@var{buf}) + +@end deftypemethod +@deftypemethod Inflater {public native void} setInput (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) + +@end deftypemethod +@deftypemethod ZipEntry {public Object} clone () +Creates a clone of this ZipEntry. Calls @code{new ZipEntry (this)} + and creates a clone of the contents of the extra byte array field. +@end deftypemethod +@deftypemethod ZipEntry {public String} getComment () + +@end deftypemethod +@deftypemethod ZipEntry {public long} getCompressedSize () + +@end deftypemethod +@deftypemethod ZipEntry {public long} getCrc () + +@end deftypemethod +@deftypemethod ZipEntry {public byte} getExtra () + +@end deftypemethod +@deftypemethod ZipEntry {public int} getMethod () + +@end deftypemethod +@deftypemethod ZipEntry {public String} getName () + +@end deftypemethod +@deftypemethod ZipEntry {public long} getSize () + +@end deftypemethod +@deftypemethod ZipEntry {public long} getTime () + +@end deftypemethod +@deftypemethod ZipEntry {public boolean} isDirectory () + +@end deftypemethod +@deftypemethod ZipEntry {public void} setComment (java.lang.String@w{ }@var{comment}) + +@end deftypemethod +@deftypemethod ZipEntry {public void} setCompressedSize (long@w{ }@var{compressedSize}) +Sets the compressedSize of this ZipEntry. + The new size must be between 0 and 0xffffffffL. +@end deftypemethod +@deftypemethod ZipEntry {public void} setCrc (long@w{ }@var{crc}) + +@end deftypemethod +@deftypemethod ZipEntry {public void} setExtra (byte[]@w{ }@var{extra}) + +@end deftypemethod +@deftypemethod ZipEntry {public void} setMethod (int@w{ }@var{method}) + +@end deftypemethod +@deftypemethod ZipEntry {public void} setSize (long@w{ }@var{size}) + +@end deftypemethod +@deftypemethod ZipEntry {public void} setTime (long@w{ }@var{time}) + +@end deftypemethod +@deftypemethod ZipEntry {public String} toString () + +@end deftypemethod +@deftypemethod ZipEntry {public int} hashCode () +Returns the hashcode of the name of this ZipEntry. +@end deftypemethod +@deftypemethod ZipFile {public Enumeration} entries () + +@end deftypemethod +@deftypemethod ZipFile {public void} close () @*throws IOException + +@end deftypemethod +@deftypemethod ZipFile {public ZipEntry} getEntry (java.lang.String@w{ }@var{name}) + +@end deftypemethod +@deftypemethod ZipFile {public InputStream} getInputStream (java.util.zip.ZipEntry@w{ }@var{ze}) @*throws IOException + +@end deftypemethod +@deftypemethod ZipFile {public String} getName () + +@end deftypemethod +@deftypemethod ZipFile {public int} size () +Returns the number of entries in this ZipFile. +@end deftypemethod +@deftypemethod ZipFile {protected void} finalize () @*throws IOException + +@end deftypemethod +@deftypemethod ZipInputStream {public ZipEntry} getNextEntry () @*throws IOException + +@end deftypemethod +@deftypemethod ZipInputStream {protected void} fill () @*throws IOException + +@end deftypemethod +@deftypemethod ZipInputStream {protected ZipEntry} createZipEntry (java.lang.String@w{ }@var{name}) +Creates a new ZipEntry with the given name. + Used by ZipInputStream when normally @code{new ZipEntry (name)} + would be called. This gives subclasses such as JarInputStream a change + to override this method and add aditional information to the ZipEntry + (subclass). +@end deftypemethod +@deftypemethod ZipInputStream {public int} read (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException + +@end deftypemethod +@deftypemethod ZipInputStream {public long} skip (long@w{ }@var{n}) @*throws IOException + +@end deftypemethod +@deftypemethod ZipInputStream {public int} available () +Returns 0 if the ZipInputStream is closed and 1 otherwise. +@end deftypemethod +@deftypemethod ZipInputStream {public void} closeEntry () @*throws IOException + +@end deftypemethod +@deftypemethod ZipInputStream {public void} close () @*throws IOException +Closes this InflaterInputStream. +@end deftypemethod +@deftypemethod ZipOutputStream {public void} close () @*throws IOException + +@end deftypemethod +@deftypemethod ZipOutputStream {public void} closeEntry () @*throws IOException + +@end deftypemethod +@deftypemethod ZipOutputStream {public void} finish () @*throws IOException + +@end deftypemethod +@deftypemethod ZipOutputStream {public void} putNextEntry (java.util.zip.ZipEntry@w{ }@var{entry}) @*throws IOException + +@end deftypemethod +@deftypemethod ZipOutputStream {public void} setLevel (int@w{ }@var{level}) + +@end deftypemethod +@deftypemethod ZipOutputStream {public void} setMethod (int@w{ }@var{method}) + +@end deftypemethod +@deftypemethod ZipOutputStream {public void} setComment (java.lang.String@w{ }@var{comment}) + +@end deftypemethod +@deftypemethod ZipOutputStream {public synchronized void} write (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException + +@end deftypemethod diff --git a/libjava/doc/java-util.texi b/libjava/doc/java-util.texi new file mode 100644 index 00000000000..c2c18a4eefa --- /dev/null +++ b/libjava/doc/java-util.texi @@ -0,0 +1,2425 @@ +@deftypemethod AbstractCollection {public abstract Iterator} iterator () +Return an Iterator over this collection. The iterator must provide the + hasNext and next methods and should in addition provide remove if the + collection is modifiable. +@end deftypemethod +@deftypemethod AbstractCollection {public abstract int} size () +Return the number of elements in this collection. +@end deftypemethod +@deftypemethod AbstractCollection {public boolean} add (java.lang.Object@w{ }@var{o}) +Add an object to the collection. This implementation always throws an + UnsupportedOperationException - it should be overridden if the collection + is to be modifiable. +@end deftypemethod +@deftypemethod AbstractCollection {public boolean} addAll (java.util.Collection@w{ }@var{c}) +Add all the elements of a given collection to this collection. This + implementation obtains an Iterator over the given collection and iterates + over it, adding each element with the add(Object) method (thus this method + will fail with an UnsupportedOperationException if the add method does). +@end deftypemethod +@deftypemethod AbstractCollection {public void} clear () +Remove all elements from the collection. This implementation obtains an + iterator over the collection and calls next and remove on it repeatedly + (thus this method will fail with an UnsupportedOperationException if the + Iterator's remove method does) until there are no more elements to remove. + Many implementations will have a faster way of doing this. +@end deftypemethod +@deftypemethod AbstractCollection {public boolean} contains (java.lang.Object@w{ }@var{o}) +Test whether this collection contains a given object. That is, if the + collection has an element e such that (o == null ? e == null : + o.equals(e)). This implementation obtains an iterator over the collection + and iterates over it, testing each element for equality with the given + object. If it is equal, true is returned. Otherwise false is returned when + the end of the collection is reached. +@end deftypemethod +@deftypemethod AbstractCollection {public boolean} containsAll (java.util.Collection@w{ }@var{c}) +Tests whether this collection contains all the elements in a given + collection. This implementation iterates over the given collection, + testing whether each element is contained in this collection. If any one + is not, false is returned. Otherwise true is returned. +@end deftypemethod +@deftypemethod AbstractCollection {public boolean} isEmpty () +Test whether this collection is empty. This implementation returns + size() == 0. +@end deftypemethod +@deftypemethod AbstractCollection {public boolean} remove (java.lang.Object@w{ }@var{o}) +Remove a single instance of an object from this collection. That is, + remove one element e such that (o == null ? e == null : o.equals(e)), if + such an element exists. This implementation obtains an iterator over the + collection and iterates over it, testing each element for equality with + the given object. If it is equal, it is removed by the iterator's remove + method (thus this method will fail with an UnsupportedOperationException + if the Iterator's remove method does). After the first element has been + removed, true is returned; if the end of the collection is reached, false + is returned. +@end deftypemethod +@deftypemethod AbstractCollection {public boolean} removeAll (java.util.Collection@w{ }@var{c}) +Remove from this collection all its elements that are contained in a given + collection. This implementation iterates over this collection, and for + each element tests if it is contained in the given collection. If so, it + is removed by the Iterator's remove method (thus this method will fail + with an UnsupportedOperationException if the Iterator's remove method + does). +@end deftypemethod +@deftypemethod AbstractCollection {public boolean} retainAll (java.util.Collection@w{ }@var{c}) +Remove from this collection all its elements that are not contained in a + given collection. This implementation iterates over this collection, and + for each element tests if it is contained in the given collection. If not, + it is removed by the Iterator's remove method (thus this method will fail + with an UnsupportedOperationException if the Iterator's remove method + does). +@end deftypemethod +@deftypemethod AbstractCollection {public Object} toArray () +Return an array containing the elements of this collection. This + implementation creates an Object array of size size() and then iterates + over the collection, setting each element of the array from the value + returned by the iterator. +@end deftypemethod +@deftypemethod AbstractCollection {public Object} toArray (java.lang.Object[]@w{ }@var{a}) +Copy the collection into a given array if it will fit, or into a + dynamically created array of the same run-time type as the given array if + not. If there is space remaining in the array, the first element after the + end of the collection is set to null (this is only useful if the + collection is known to contain no null elements, however). This + implementation first tests whether the given array is large enough to hold + all the elements of the collection. If not, the reflection API is used to + allocate a new array of the same run-time type. Next an iterator is + obtained over the collection and the elements are placed in the array as + they are returned by the iterator. Finally the first spare element, if + any, of the array is set to null, and the created array is returned. +@end deftypemethod +@deftypemethod AbstractCollection {public String} toString () +Creates a String representation of the Collection. The string returned is + of the form "[a, b, ...]" where a and b etc are the results of calling + toString on the elements of the collection. This implementation obtains an + Iterator over the Collection and adds each element to a StringBuffer as it + is returned by the iterator. +@end deftypemethod +@deftypemethod AbstractList {public abstract Object} get (int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod AbstractList {public void} add (int@w{ }@var{index}, java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod AbstractList {public boolean} add (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod AbstractList {public boolean} addAll (int@w{ }@var{index}, java.util.Collection@w{ }@var{c}) + +@end deftypemethod +@deftypemethod AbstractList {public void} clear () + +@end deftypemethod +@deftypemethod AbstractList {public boolean} equals (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod AbstractList {public int} hashCode () + +@end deftypemethod +@deftypemethod AbstractList {public int} indexOf (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod AbstractList {public Iterator} iterator () + +@end deftypemethod +@deftypemethod AbstractList {public int} lastIndexOf (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod AbstractList {public ListIterator} listIterator () +Return an Iterator over this List. This implementation calls + listIterator(0). +@end deftypemethod +@deftypemethod AbstractList {public ListIterator} listIterator (int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod AbstractList {public Object} remove (int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod AbstractList {protected void} removeRange (int@w{ }@var{fromIndex}, int@w{ }@var{toIndex}) +Remove a subsection of the list. This is called by the clear and + removeRange methods of the class which implements subList, which are + difficult for subclasses to override directly. Therefore, this method + should be overridden instead by the more efficient implementation, if one + exists. + + + + This implementation first checks for illegal or out of range arguments. It + then obtains a ListIterator over the list using listIterator(fromIndex). + It then calls next() and remove() on this iterator repeatedly, toIndex - + fromIndex times. +@end deftypemethod +@deftypemethod AbstractList {public Object} set (int@w{ }@var{index}, java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod AbstractList {public List} subList (int@w{ }@var{fromIndex}, int@w{ }@var{toIndex}) + +@end deftypemethod +@deftypemethod AbstractMap {public void} clear () +Remove all entries from this Map. This default implementation calls + entrySet().clear(). +@end deftypemethod +@deftypemethod AbstractMap {public boolean} containsKey (java.lang.Object@w{ }@var{key}) + +@end deftypemethod +@deftypemethod AbstractMap {public boolean} containsValue (java.lang.Object@w{ }@var{value}) + +@end deftypemethod +@deftypemethod AbstractMap {public abstract Set} entrySet () + +@end deftypemethod +@deftypemethod AbstractMap {public boolean} equals (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod AbstractMap {public Object} get (java.lang.Object@w{ }@var{key}) + +@end deftypemethod +@deftypemethod AbstractMap {public int} hashCode () + +@end deftypemethod +@deftypemethod AbstractMap {public boolean} isEmpty () + +@end deftypemethod +@deftypemethod AbstractMap {public Set} keySet () + +@end deftypemethod +@deftypemethod AbstractMap {public Object} put (java.lang.Object@w{ }@var{key}, java.lang.Object@w{ }@var{value}) + +@end deftypemethod +@deftypemethod AbstractMap {public void} putAll (java.util.Map@w{ }@var{m}) + +@end deftypemethod +@deftypemethod AbstractMap {public Object} remove (java.lang.Object@w{ }@var{key}) + +@end deftypemethod +@deftypemethod AbstractMap {public int} size () + +@end deftypemethod +@deftypemethod AbstractMap {public String} toString () + +@end deftypemethod +@deftypemethod AbstractMap {public Collection} values () + +@end deftypemethod +@deftypemethod AbstractSequentialList {public abstract ListIterator} listIterator (int@w{ }@var{index}) +Returns a ListIterator over the list, starting from position index. + Subclasses must provide an implementation of this method. +@end deftypemethod +@deftypemethod AbstractSequentialList {public void} add (int@w{ }@var{index}, java.lang.Object@w{ }@var{o}) +Add an element to the list at a given index. This implementation obtains a + ListIterator positioned at the specified index, and then adds the element + using the ListIterator's add method. +@end deftypemethod +@deftypemethod AbstractSequentialList {public boolean} addAll (int@w{ }@var{index}, java.util.Collection@w{ }@var{c}) + +@end deftypemethod +@deftypemethod AbstractSequentialList {public Object} get (int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod AbstractSequentialList {public Iterator} iterator () +Return an Iterator over this List. This implementation returns + listIterator(). +@end deftypemethod +@deftypemethod AbstractSequentialList {public Object} remove (int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod AbstractSequentialList {public Object} set (int@w{ }@var{index}, java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod AbstractSet {public boolean} equals (java.lang.Object@w{ }@var{o}) +Tests whether the given object is equal to this Set. This implementation + first checks whether this set <em>is</em> the given object, and returns + true if so. Otherwise, if o is a Set and is the same size as this one, it + returns the result of calling containsAll on the given Set. Otherwise, it + returns false. +@end deftypemethod +@deftypemethod AbstractSet {public int} hashCode () +Returns a hash code for this Set. The hash code of a Set is the sum of the + hash codes of all its elements, except that the hash code of null is + defined to be zero. This implementation obtains an Iterator over the Set, + and sums the results. +@end deftypemethod +@deftypemethod ArrayList {public void} ensureCapacity (int@w{ }@var{minCapacity}) +Guarantees that this list will have at least enough capacity to + hold minCapacity elements. +@end deftypemethod +@deftypemethod ArrayList {public boolean} add (java.lang.Object@w{ }@var{e}) +Appends the supplied element to the end of this list. +@end deftypemethod +@deftypemethod ArrayList {public Object} get (int@w{ }@var{index}) +Retrieves the element at the user-supplied index. +@end deftypemethod +@deftypemethod ArrayList {public int} size () +Returns the number of elements in this list +@end deftypemethod +@deftypemethod ArrayList {public Object} remove (int@w{ }@var{index}) +Removes the element at the user-supplied index +@end deftypemethod +@deftypemethod ArrayList {protected void} removeRange (int@w{ }@var{fromIndex}, int@w{ }@var{toIndex}) +Removes all elements in the half-open interval [iFromIndex, iToIndex). +@end deftypemethod +@deftypemethod ArrayList {public void} add (int@w{ }@var{index}, java.lang.Object@w{ }@var{e}) +Adds the supplied element at the specified index, shifting all + elements currently at that index or higher one to the right. +@end deftypemethod +@deftypemethod ArrayList {public boolean} addAll (java.util.Collection@w{ }@var{c}) +Add each element in the supplied Collection to this List. +@end deftypemethod +@deftypemethod ArrayList {public boolean} addAll (int@w{ }@var{index}, java.util.Collection@w{ }@var{c}) +Add all elements in the supplied collection, inserting them beginning + at the specified index. +@end deftypemethod +@deftypemethod ArrayList {public Object} clone () +Creates a shallow copy of this ArrayList +@end deftypemethod +@deftypemethod ArrayList {public boolean} contains (java.lang.Object@w{ }@var{e}) +Returns true iff oElement is in this ArrayList. +@end deftypemethod +@deftypemethod ArrayList {public int} indexOf (java.lang.Object@w{ }@var{e}) +Returns the lowest index at which oElement appears in this List, or + -1 if it does not appear. +@end deftypemethod +@deftypemethod ArrayList {public int} lastIndexOf (java.lang.Object@w{ }@var{e}) +Returns the highest index at which oElement appears in this List, or + -1 if it does not appear. +@end deftypemethod +@deftypemethod ArrayList {public void} clear () +Removes all elements from this List +@end deftypemethod +@deftypemethod ArrayList {public Object} set (int@w{ }@var{index}, java.lang.Object@w{ }@var{e}) +Sets the element at the specified index. +@end deftypemethod +@deftypemethod ArrayList {public Object} toArray () +Returns an Object Array containing all of the elements in this ArrayList +@end deftypemethod +@deftypemethod ArrayList {public Object} toArray (java.lang.Object[]@w{ }@var{array}) +Returns an Array whose component type is the runtime component type of + the passed-in Array. The returned Array is populated with all of the + elements in this ArrayList. If the passed-in Array is not large enough + to store all of the elements in this List, a new Array will be created + and returned; if the passed-in Array is <i>larger</i> than the size + of this List, then size() index will be set to null. +@end deftypemethod +@deftypemethod ArrayList {public void} trimToSize () +Trims the capacity of this List to be equal to its size; + a memory saver. +@end deftypemethod +@deftypemethod Arrays {public static int} binarySearch (byte[]@w{ }@var{a}, byte@w{ }@var{key}) +Perform a binary search of a byte array for a key. The array must be + sorted (as by the sort() method) - if it is not, the behaviour of this + method is undefined, and may be an infinite loop. If the array contains + the key more than once, any one of them may be found. Note: although the + specification allows for an infinite loop if the array is unsorted, it + will not happen in this implementation. +@end deftypemethod +@deftypemethod Arrays {public static int} binarySearch (char[]@w{ }@var{a}, char@w{ }@var{key}) +Perform a binary search of a char array for a key. The array must be + sorted (as by the sort() method) - if it is not, the behaviour of this + method is undefined, and may be an infinite loop. If the array contains + the key more than once, any one of them may be found. Note: although the + specification allows for an infinite loop if the array is unsorted, it + will not happen in this implementation. +@end deftypemethod +@deftypemethod Arrays {public static int} binarySearch (double[]@w{ }@var{a}, double@w{ }@var{key}) +Perform a binary search of a double array for a key. The array must be + sorted (as by the sort() method) - if it is not, the behaviour of this + method is undefined, and may be an infinite loop. If the array contains + the key more than once, any one of them may be found. Note: although the + specification allows for an infinite loop if the array is unsorted, it + will not happen in this implementation. +@end deftypemethod +@deftypemethod Arrays {public static int} binarySearch (float[]@w{ }@var{a}, float@w{ }@var{key}) +Perform a binary search of a float array for a key. The array must be + sorted (as by the sort() method) - if it is not, the behaviour of this + method is undefined, and may be an infinite loop. If the array contains + the key more than once, any one of them may be found. Note: although the + specification allows for an infinite loop if the array is unsorted, it + will not happen in this implementation. +@end deftypemethod +@deftypemethod Arrays {public static int} binarySearch (int[]@w{ }@var{a}, int@w{ }@var{key}) +Perform a binary search of an int array for a key. The array must be + sorted (as by the sort() method) - if it is not, the behaviour of this + method is undefined, and may be an infinite loop. If the array contains + the key more than once, any one of them may be found. Note: although the + specification allows for an infinite loop if the array is unsorted, it + will not happen in this implementation. +@end deftypemethod +@deftypemethod Arrays {public static int} binarySearch (long[]@w{ }@var{a}, long@w{ }@var{key}) +Perform a binary search of a long array for a key. The array must be + sorted (as by the sort() method) - if it is not, the behaviour of this + method is undefined, and may be an infinite loop. If the array contains + the key more than once, any one of them may be found. Note: although the + specification allows for an infinite loop if the array is unsorted, it + will not happen in this implementation. +@end deftypemethod +@deftypemethod Arrays {public static int} binarySearch (short[]@w{ }@var{a}, short@w{ }@var{key}) +Perform a binary search of a short array for a key. The array must be + sorted (as by the sort() method) - if it is not, the behaviour of this + method is undefined, and may be an infinite loop. If the array contains + the key more than once, any one of them may be found. Note: although the + specification allows for an infinite loop if the array is unsorted, it + will not happen in this implementation. +@end deftypemethod +@deftypemethod Arrays {public static int} binarySearch (java.lang.Object[]@w{ }@var{a}, java.lang.Object@w{ }@var{key}) +Perform a binary search of an Object array for a key, using the natural + ordering of the elements. The array must be sorted (as by the sort() + method) - if it is not, the behaviour of this method is undefined, and may + be an infinite loop. Further, the key must be comparable with every item + in the array. If the array contains the key more than once, any one of + them may be found. Note: although the specification allows for an infinite + loop if the array is unsorted, it will not happen in this (JCL) + implementation. +@end deftypemethod +@deftypemethod Arrays {public static int} binarySearch (java.lang.Object[]@w{ }@var{a}, java.lang.Object@w{ }@var{key}, java.util.Comparator@w{ }@var{c}) +Perform a binary search of an Object array for a key, using a supplied + Comparator. The array must be sorted (as by the sort() method with the + same Comparator) - if it is not, the behaviour of this method is + undefined, and may be an infinite loop. Further, the key must be + comparable with every item in the array. If the array contains the key + more than once, any one of them may be found. Note: although the + specification allows for an infinite loop if the array is unsorted, it + will not happen in this (JCL) implementation. +@end deftypemethod +@deftypemethod Arrays {public static boolean} equals (byte[]@w{ }@var{a1}, byte[]@w{ }@var{a2}) +Compare two byte arrays for equality. +@end deftypemethod +@deftypemethod Arrays {public static boolean} equals (char[]@w{ }@var{a1}, char[]@w{ }@var{a2}) +Compare two char arrays for equality. +@end deftypemethod +@deftypemethod Arrays {public static boolean} equals (double[]@w{ }@var{a1}, double[]@w{ }@var{a2}) +Compare two double arrays for equality. +@end deftypemethod +@deftypemethod Arrays {public static boolean} equals (float[]@w{ }@var{a1}, float[]@w{ }@var{a2}) +Compare two float arrays for equality. +@end deftypemethod +@deftypemethod Arrays {public static boolean} equals (long[]@w{ }@var{a1}, long[]@w{ }@var{a2}) +Compare two long arrays for equality. +@end deftypemethod +@deftypemethod Arrays {public static boolean} equals (short[]@w{ }@var{a1}, short[]@w{ }@var{a2}) +Compare two short arrays for equality. +@end deftypemethod +@deftypemethod Arrays {public static boolean} equals (boolean[]@w{ }@var{a1}, boolean[]@w{ }@var{a2}) +Compare two boolean arrays for equality. +@end deftypemethod +@deftypemethod Arrays {public static boolean} equals (int[]@w{ }@var{a1}, int[]@w{ }@var{a2}) +Compare two int arrays for equality. +@end deftypemethod +@deftypemethod Arrays {public static boolean} equals (java.lang.Object[]@w{ }@var{a1}, java.lang.Object[]@w{ }@var{a2}) +Compare two Object arrays for equality. +@end deftypemethod +@deftypemethod Arrays {public static void} fill (boolean[]@w{ }@var{a}, boolean@w{ }@var{val}) +Fill an array with a boolean value. +@end deftypemethod +@deftypemethod Arrays {public static void} fill (boolean[]@w{ }@var{a}, int@w{ }@var{fromIndex}, int@w{ }@var{toIndex}, boolean@w{ }@var{val}) +Fill a range of an array with a boolean value. +@end deftypemethod +@deftypemethod Arrays {public static void} fill (byte[]@w{ }@var{a}, byte@w{ }@var{val}) +Fill an array with a byte value. +@end deftypemethod +@deftypemethod Arrays {public static void} fill (byte[]@w{ }@var{a}, int@w{ }@var{fromIndex}, int@w{ }@var{toIndex}, byte@w{ }@var{val}) +Fill a range of an array with a byte value. +@end deftypemethod +@deftypemethod Arrays {public static void} fill (char[]@w{ }@var{a}, char@w{ }@var{val}) +Fill an array with a char value. +@end deftypemethod +@deftypemethod Arrays {public static void} fill (char[]@w{ }@var{a}, int@w{ }@var{fromIndex}, int@w{ }@var{toIndex}, char@w{ }@var{val}) +Fill a range of an array with a char value. +@end deftypemethod +@deftypemethod Arrays {public static void} fill (double[]@w{ }@var{a}, double@w{ }@var{val}) +Fill an array with a double value. +@end deftypemethod +@deftypemethod Arrays {public static void} fill (double[]@w{ }@var{a}, int@w{ }@var{fromIndex}, int@w{ }@var{toIndex}, double@w{ }@var{val}) +Fill a range of an array with a double value. +@end deftypemethod +@deftypemethod Arrays {public static void} fill (float[]@w{ }@var{a}, float@w{ }@var{val}) +Fill an array with a float value. +@end deftypemethod +@deftypemethod Arrays {public static void} fill (float[]@w{ }@var{a}, int@w{ }@var{fromIndex}, int@w{ }@var{toIndex}, float@w{ }@var{val}) +Fill a range of an array with a float value. +@end deftypemethod +@deftypemethod Arrays {public static void} fill (int[]@w{ }@var{a}, int@w{ }@var{val}) +Fill an array with an int value. +@end deftypemethod +@deftypemethod Arrays {public static void} fill (int[]@w{ }@var{a}, int@w{ }@var{fromIndex}, int@w{ }@var{toIndex}, int@w{ }@var{val}) +Fill a range of an array with an int value. +@end deftypemethod +@deftypemethod Arrays {public static void} fill (long[]@w{ }@var{a}, long@w{ }@var{val}) +Fill an array with a long value. +@end deftypemethod +@deftypemethod Arrays {public static void} fill (long[]@w{ }@var{a}, int@w{ }@var{fromIndex}, int@w{ }@var{toIndex}, long@w{ }@var{val}) +Fill a range of an array with a long value. +@end deftypemethod +@deftypemethod Arrays {public static void} fill (short[]@w{ }@var{a}, short@w{ }@var{val}) +Fill an array with a short value. +@end deftypemethod +@deftypemethod Arrays {public static void} fill (short[]@w{ }@var{a}, int@w{ }@var{fromIndex}, int@w{ }@var{toIndex}, short@w{ }@var{val}) +Fill a range of an array with a short value. +@end deftypemethod +@deftypemethod Arrays {public static void} fill (java.lang.Object[]@w{ }@var{a}, java.lang.Object@w{ }@var{val}) +Fill an array with an Object value. +@end deftypemethod +@deftypemethod Arrays {public static void} fill (java.lang.Object[]@w{ }@var{a}, int@w{ }@var{fromIndex}, int@w{ }@var{toIndex}, java.lang.Object@w{ }@var{val}) +Fill a range of an array with an Object value. +@end deftypemethod +@deftypemethod Arrays {public static void} sort (byte[]@w{ }@var{a}) +Sort a byte array into ascending order. The sort algorithm is an optimised + quicksort, as described in Jon L. Bentley and M. Douglas McIlroy's + "Engineering a Sort Function", Software-Practice and Experience, Vol. + 23(11) P. 1249-1265 (November 1993). This algorithm gives nlog(n) + performance on many arrays that would take quadratic time with a standard + quicksort. +@end deftypemethod +@deftypemethod Arrays {public static void} sort (byte[]@w{ }@var{a}, int@w{ }@var{fromIndex}, int@w{ }@var{toIndex}) + +@end deftypemethod +@deftypemethod Arrays {public static void} sort (char[]@w{ }@var{a}) +Sort a char array into ascending order. The sort algorithm is an optimised + quicksort, as described in Jon L. Bentley and M. Douglas McIlroy's + "Engineering a Sort Function", Software-Practice and Experience, Vol. + 23(11) P. 1249-1265 (November 1993). This algorithm gives nlog(n) + performance on many arrays that would take quadratic time with a standard + quicksort. +@end deftypemethod +@deftypemethod Arrays {public static void} sort (char[]@w{ }@var{a}, int@w{ }@var{fromIndex}, int@w{ }@var{toIndex}) + +@end deftypemethod +@deftypemethod Arrays {public static void} sort (double[]@w{ }@var{a}) +Sort a double array into ascending order. The sort algorithm is an + optimised quicksort, as described in Jon L. Bentley and M. Douglas + McIlroy's "Engineering a Sort Function", Software-Practice and Experience, + Vol. 23(11) P. 1249-1265 (November 1993). This algorithm gives nlog(n) + performance on many arrays that would take quadratic time with a standard + quicksort. Note that this implementation, like Sun's, has undefined + behaviour if the array contains any NaN values. +@end deftypemethod +@deftypemethod Arrays {public static void} sort (double[]@w{ }@var{a}, int@w{ }@var{fromIndex}, int@w{ }@var{toIndex}) + +@end deftypemethod +@deftypemethod Arrays {public static void} sort (float[]@w{ }@var{a}) +Sort a float array into ascending order. The sort algorithm is an + optimised quicksort, as described in Jon L. Bentley and M. Douglas + McIlroy's "Engineering a Sort Function", Software-Practice and Experience, + Vol. 23(11) P. 1249-1265 (November 1993). This algorithm gives nlog(n) + performance on many arrays that would take quadratic time with a standard + quicksort. Note that this implementation, like Sun's, has undefined + behaviour if the array contains any NaN values. +@end deftypemethod +@deftypemethod Arrays {public static void} sort (float[]@w{ }@var{a}, int@w{ }@var{fromIndex}, int@w{ }@var{toIndex}) + +@end deftypemethod +@deftypemethod Arrays {public static void} sort (int[]@w{ }@var{a}) +Sort an int array into ascending order. The sort algorithm is an optimised + quicksort, as described in Jon L. Bentley and M. Douglas McIlroy's + "Engineering a Sort Function", Software-Practice and Experience, Vol. + 23(11) P. 1249-1265 (November 1993). This algorithm gives nlog(n) + performance on many arrays that would take quadratic time with a standard + quicksort. +@end deftypemethod +@deftypemethod Arrays {public static void} sort (int[]@w{ }@var{a}, int@w{ }@var{fromIndex}, int@w{ }@var{toIndex}) + +@end deftypemethod +@deftypemethod Arrays {public static void} sort (long[]@w{ }@var{a}) +Sort a long array into ascending order. The sort algorithm is an optimised + quicksort, as described in Jon L. Bentley and M. Douglas McIlroy's + "Engineering a Sort Function", Software-Practice and Experience, Vol. + 23(11) P. 1249-1265 (November 1993). This algorithm gives nlog(n) + performance on many arrays that would take quadratic time with a standard + quicksort. +@end deftypemethod +@deftypemethod Arrays {public static void} sort (long[]@w{ }@var{a}, int@w{ }@var{fromIndex}, int@w{ }@var{toIndex}) + +@end deftypemethod +@deftypemethod Arrays {public static void} sort (short[]@w{ }@var{a}) +Sort a short array into ascending order. The sort algorithm is an + optimised quicksort, as described in Jon L. Bentley and M. Douglas + McIlroy's "Engineering a Sort Function", Software-Practice and Experience, + Vol. 23(11) P. 1249-1265 (November 1993). This algorithm gives nlog(n) + performance on many arrays that would take quadratic time with a standard + quicksort. +@end deftypemethod +@deftypemethod Arrays {public static void} sort (short[]@w{ }@var{a}, int@w{ }@var{fromIndex}, int@w{ }@var{toIndex}) + +@end deftypemethod +@deftypemethod Arrays {public static void} sort (java.lang.Object[]@w{ }@var{a}) +Sort an array of Objects according to their natural ordering. The sort is + guaranteed to be stable, that is, equal elements will not be reordered. + The sort algorithm is a mergesort with the merge omitted if the last + element of one half comes before the first element of the other half. This + algorithm gives guaranteed O(nlog(n)) time, at the expense of making a + copy of the array. +@end deftypemethod +@deftypemethod Arrays {public static void} sort (java.lang.Object[]@w{ }@var{a}, java.util.Comparator@w{ }@var{c}) +Sort an array of Objects according to a Comparator. The sort is + guaranteed to be stable, that is, equal elements will not be reordered. + The sort algorithm is a mergesort with the merge omitted if the last + element of one half comes before the first element of the other half. This + algorithm gives guaranteed O(nlog(n)) time, at the expense of making a + copy of the array. +@end deftypemethod +@deftypemethod Arrays {public static void} sort (java.lang.Object[]@w{ }@var{a}, int@w{ }@var{fromIndex}, int@w{ }@var{toIndex}) +Sort an array of Objects according to their natural ordering. The sort is + guaranteed to be stable, that is, equal elements will not be reordered. + The sort algorithm is a mergesort with the merge omitted if the last + element of one half comes before the first element of the other half. This + algorithm gives guaranteed O(nlog(n)) time, at the expense of making a + copy of the array. +@end deftypemethod +@deftypemethod Arrays {public static void} sort (java.lang.Object[]@w{ }@var{a}, int@w{ }@var{fromIndex}, int@w{ }@var{toIndex}, java.util.Comparator@w{ }@var{c}) +Sort an array of Objects according to a Comparator. The sort is + guaranteed to be stable, that is, equal elements will not be reordered. + The sort algorithm is a mergesort with the merge omitted if the last + element of one half comes before the first element of the other half. This + algorithm gives guaranteed O(nlog(n)) time, at the expense of making a + copy of the array. +@end deftypemethod +@deftypemethod Arrays {public static List} asList (java.lang.Object[]@w{ }@var{a}) +Returns a list "view" of the specified array. This method is intended to + make it easy to use the Collections API with existing array-based APIs and + programs. +@end deftypemethod +@deftypemethod BitSet {public void} and (java.util.BitSet@w{ }@var{bs}) +Performs the logical AND operation on this bit set and the + given @code{set}. This means it builds the intersection + of the two sets. The result is stored into this bit set. +@end deftypemethod +@deftypemethod BitSet {public void} andNot (java.util.BitSet@w{ }@var{bs}) +Performs the logical AND operation on this bit set and the + complement of the given @code{set}. This means it + selects every element in the first set, that isn't in the + second set. The result is stored into this bit set. +@end deftypemethod +@deftypemethod BitSet {public void} clear (int@w{ }@var{pos}) +Removes the integer @code{bitIndex} from this set. That is + the corresponding bit is cleared. If the index is not in the set, + this method does nothing. +@end deftypemethod +@deftypemethod BitSet {public Object} clone () +Create a clone of this bit set, that is an instance of the same + class and contains the same elements. But it doesn't change when + this bit set changes. +@end deftypemethod +@deftypemethod BitSet {public boolean} equals (java.lang.Object@w{ }@var{obj}) +Returns true if the @code{obj} is a bit set that contains + exactly the same elements as this bit set, otherwise false. +@end deftypemethod +@deftypemethod BitSet {public boolean} get (int@w{ }@var{pos}) +Returns true if the integer @code{bitIndex} is in this bit + set, otherwise false. +@end deftypemethod +@deftypemethod BitSet {public int} hashCode () +Returns a hash code value for this bit set. The hash code of + two bit sets containing the same integers is identical. The algorithm + used to compute it is as follows: + + Suppose the bits in the BitSet were to be stored in an array of + long integers called @code{bits}, in such a manner that + bit @code{k} is set in the BitSet (for non-negative values + of @code{k}) if and only if + + <pre> + ((k/64) < bits.length) && ((bits[k/64] & (1L << (bit % 64))) != 0) + </pre> + + Then the following definition of the hashCode method + would be a correct implementation of the actual algorithm: + + <pre> + public int hashCode() { + long h = 1234; + for (int i = bits.length-1; i>=0; i--) { + h ^= bits[i] * (i + 1); + } + return (int)((h >> 32) ^ h); + } + </pre> + + Note that the hash code values changes, if the set is changed. +@end deftypemethod +@deftypemethod BitSet {public int} length () +Returns the logical number of bits actually used by this bit + set. It returns the index of the highest set bit plus one. + Note that this method doesn't return the number of set bits. +@end deftypemethod +@deftypemethod BitSet {public void} or (java.util.BitSet@w{ }@var{bs}) +Performs the logical OR operation on this bit set and the + given @code{set}. This means it builds the union + of the two sets. The result is stored into this bit set, which + grows as necessary. +@end deftypemethod +@deftypemethod BitSet {public void} set (int@w{ }@var{pos}) +Add the integer @code{bitIndex} to this set. That is + the corresponding bit is set to true. If the index was already in + the set, this method does nothing. The size of this structure + is automatically increased as necessary. +@end deftypemethod +@deftypemethod BitSet {public int} size () +Returns the number of bits actually used by this bit set. Note + that this method doesn't return the number of set bits. +@end deftypemethod +@deftypemethod BitSet {public String} toString () +Returns the string representation of this bit set. This + consists of a comma separated list of the integers in this set + surrounded by curly braces. There is a space after each comma. +@end deftypemethod +@deftypemethod BitSet {public void} xor (java.util.BitSet@w{ }@var{bs}) +Performs the logical XOR operation on this bit set and the + given @code{set}. This means it builds the symmetric + remainder of the two sets (the elements that are in one set, + but not in the other). The result is stored into this bit set, + which grows as necessary. +@end deftypemethod +@deftypemethod Calendar {public static synchronized Calendar} getInstance () +Creates a calendar representing the actual time, using the default + time zone and locale. +@end deftypemethod +@deftypemethod Calendar {public static synchronized Calendar} getInstance (java.util.TimeZone@w{ }@var{zone}) +Creates a calendar representing the actual time, using the given + time zone and the default locale. +@end deftypemethod +@deftypemethod Calendar {public static synchronized Calendar} getInstance (java.util.Locale@w{ }@var{locale}) +Creates a calendar representing the actual time, using the default + time zone and the given locale. +@end deftypemethod +@deftypemethod Calendar {public static synchronized Calendar} getInstance (java.util.TimeZone@w{ }@var{zone}, java.util.Locale@w{ }@var{locale}) +Creates a calendar representing the actual time, using the given + time zone and locale. +@end deftypemethod +@deftypemethod Calendar {public static synchronized Locale} getAvailableLocales () +Gets the set of locales for which a Calendar is availiable. +@end deftypemethod +@deftypemethod Calendar {protected abstract void} computeTime () +Converts the time field values (@code{fields}) to + milliseconds since the epoch UTC (@code{time}). Override + this method if you write your own Calendar. +@end deftypemethod +@deftypemethod Calendar {protected abstract void} computeFields () +Converts the milliseconds since the epoch UTC + (@code{time}) to time fields + (@code{fields}). Override this method if you write your + own Calendar. +@end deftypemethod +@deftypemethod Calendar {public final Date} getTime () +Converts the time represented by this object to a + @code{Date}-Object. +@end deftypemethod +@deftypemethod Calendar {public final void} setTime (java.util.Date@w{ }@var{date}) +Sets this Calender's time to the given Date. All time fields + are invalidated by this method. +@end deftypemethod +@deftypemethod Calendar {protected long} getTimeInMillis () +Returns the time represented by this Calendar. +@end deftypemethod +@deftypemethod Calendar {protected void} setTimeInMillis (long@w{ }@var{time}) +Sets this Calender's time to the given Time. All time fields + are invalidated by this method. +@end deftypemethod +@deftypemethod Calendar {public final int} get (int@w{ }@var{field}) +Gets the value of the specified field. They are recomputed + if they are invalid. +@end deftypemethod +@deftypemethod Calendar {protected final int} internalGet (int@w{ }@var{field}) +Gets the value of the specified field. This method doesn't + recompute the fields, if they are invalid. +@end deftypemethod +@deftypemethod Calendar {public final void} set (int@w{ }@var{field}, int@w{ }@var{value}) +Sets the time field with the given value. This does invalidate + the time in milliseconds. +@end deftypemethod +@deftypemethod Calendar {public final void} set (int@w{ }@var{year}, int@w{ }@var{month}, int@w{ }@var{date}) +Sets the fields for year, month, and date +@end deftypemethod +@deftypemethod Calendar {public final void} set (int@w{ }@var{year}, int@w{ }@var{month}, int@w{ }@var{date}, int@w{ }@var{hour}, int@w{ }@var{minute}) +Sets the fields for year, month, date, hour, and minute +@end deftypemethod +@deftypemethod Calendar {public final void} set (int@w{ }@var{year}, int@w{ }@var{month}, int@w{ }@var{date}, int@w{ }@var{hour}, int@w{ }@var{minute}, int@w{ }@var{second}) +Sets the fields for year, month, date, hour, and minute +@end deftypemethod +@deftypemethod Calendar {public final void} clear () +Clears the values of all the time fields. +@end deftypemethod +@deftypemethod Calendar {public final void} clear (int@w{ }@var{field}) +Clears the values of the specified time field. +@end deftypemethod +@deftypemethod Calendar {public final boolean} isSet (int@w{ }@var{field}) +Determines if the specified field has a valid value. +@end deftypemethod +@deftypemethod Calendar {protected void} complete () +Fills any unset fields in the time field list +@end deftypemethod +@deftypemethod Calendar {public boolean} equals (java.lang.Object@w{ }@var{o}) +Compares the given calender with this. +@end deftypemethod +@deftypemethod Calendar {public int} hashCode () +Returns a hash code for this calendar. +@end deftypemethod +@deftypemethod Calendar {public boolean} before (java.lang.Object@w{ }@var{o}) +Compares the given calender with this. +@end deftypemethod +@deftypemethod Calendar {public boolean} after (java.lang.Object@w{ }@var{o}) +Compares the given calender with this. +@end deftypemethod +@deftypemethod Calendar {public abstract void} add (int@w{ }@var{field}, int@w{ }@var{amount}) +Adds the specified amount of time to the given time field. The + amount may be negative to subtract the time. If the field overflows + it does what you expect: Jan, 25 + 10 Days is Feb, 4. +@end deftypemethod +@deftypemethod Calendar {public abstract void} roll (int@w{ }@var{field}, boolean@w{ }@var{up}) +Rolls the specified time field up or down. This means add one + to the specified field, but don't change the other fields. If + the maximum for this field is reached, start over with the + minimum value. <br> + + <strong>Note:</strong> There may be situation, where the other + fields must be changed, e.g rolling the month on May, 31. + The date June, 31 is automatically converted to July, 1. +@end deftypemethod +@deftypemethod Calendar {public void} roll (int@w{ }@var{field}, int@w{ }@var{amount}) +Rolls up or down the specified time field by the given amount. + A negative amount rolls down. The default implementation is + call @code{roll(int, boolean)} for the specified amount. + + Subclasses should override this method to do more intuitiv things. +@end deftypemethod +@deftypemethod Calendar {public void} setTimeZone (java.util.TimeZone@w{ }@var{zone}) +Sets the time zone to the specified value. +@end deftypemethod +@deftypemethod Calendar {public TimeZone} getTimeZone () +Gets the time zone of this calendar +@end deftypemethod +@deftypemethod Calendar {public void} setLenient (boolean@w{ }@var{lenient}) +Specifies if the date/time interpretation should be lenient. + If the flag is set, a date such as "February 30, 1996" will be + treated as the 29th day after the February 1. If this flag + is false, such dates will cause an exception. +@end deftypemethod +@deftypemethod Calendar {public boolean} isLenient () +Tells if the date/time interpretation is lenient. +@end deftypemethod +@deftypemethod Calendar {public void} setFirstDayOfWeek (int@w{ }@var{value}) +Sets what the first day of week is. This is used for + WEEK_OF_MONTH and WEEK_OF_YEAR fields. +@end deftypemethod +@deftypemethod Calendar {public int} getFirstDayOfWeek () +Gets what the first day of week is. This is used for + WEEK_OF_MONTH and WEEK_OF_YEAR fields. +@end deftypemethod +@deftypemethod Calendar {public void} setMinimalDaysInFirstWeek (int@w{ }@var{value}) +Sets how many days are required in the first week of the year. + If the first day of the year should be the first week you should + set this value to 1. If the first week must be a full week, set + it to 7. +@end deftypemethod +@deftypemethod Calendar {public int} getMinimalDaysInFirstWeek () +Gets how many days are required in the first week of the year. +@end deftypemethod +@deftypemethod Calendar {public abstract int} getMinimum (int@w{ }@var{field}) +Gets the smallest value that is allowed for the specified field. +@end deftypemethod +@deftypemethod Calendar {public abstract int} getMaximum (int@w{ }@var{field}) +Gets the biggest value that is allowed for the specified field. +@end deftypemethod +@deftypemethod Calendar {public abstract int} getGreatestMinimum (int@w{ }@var{field}) +Gets the greatest minimum value that is allowed for the specified field. +@end deftypemethod +@deftypemethod Calendar {public abstract int} getLeastMaximum (int@w{ }@var{field}) +Gets the smallest maximum value that is allowed for the + specified field. For example this is 28 for DAY_OF_MONTH. +@end deftypemethod +@deftypemethod Calendar {public Object} clone () +Return a clone of this object. +@end deftypemethod +@deftypemethod Calendar {public String} toString () +Returns a string representation of this object. It is mainly + for debugging purposes and its content is implementation + specific. +@end deftypemethod +@deftypemethod Collection {public int} size () + +@end deftypemethod +@deftypemethod Collection {public boolean} isEmpty () + +@end deftypemethod +@deftypemethod Collection {public boolean} contains (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod Collection {public Iterator} iterator () + +@end deftypemethod +@deftypemethod Collection {public Object} toArray () + +@end deftypemethod +@deftypemethod Collection {public Object} toArray (java.lang.Object[]@w{ }@var{a}) + +@end deftypemethod +@deftypemethod Collection {public boolean} add (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod Collection {public boolean} remove (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod Collection {public boolean} containsAll (java.util.Collection@w{ }@var{c}) + +@end deftypemethod +@deftypemethod Collection {public boolean} addAll (java.util.Collection@w{ }@var{c}) + +@end deftypemethod +@deftypemethod Collection {public boolean} removeAll (java.util.Collection@w{ }@var{c}) + +@end deftypemethod +@deftypemethod Collection {public boolean} retainAll (java.util.Collection@w{ }@var{c}) + +@end deftypemethod +@deftypemethod Collection {public void} clear () + +@end deftypemethod +@deftypemethod Collection {public boolean} equals (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod Collection {public int} hashCode () + +@end deftypemethod +@deftypemethod Collections {public static int} binarySearch (java.util.List@w{ }@var{l}, java.lang.Object@w{ }@var{key}) +Perform a binary search of a List for a key, using the natural ordering of + the elements. The list must be sorted (as by the sort() method) - if it is + not, the behaviour of this method is undefined, and may be an infinite + loop. Further, the key must be comparable with every item in the list. If + the list contains the key more than once, any one of them may be found. To + avoid pathological behaviour on sequential-access lists, a linear search + is used if (l instanceof AbstractSequentialList). Note: although the + specification allows for an infinite loop if the list is unsorted, it will + not happen in this (Classpath) implementation. +@end deftypemethod +@deftypemethod Collections {public static int} binarySearch (java.util.List@w{ }@var{l}, java.lang.Object@w{ }@var{key}, java.util.Comparator@w{ }@var{c}) +Perform a binary search of a List for a key, using a supplied Comparator. + The list must be sorted (as by the sort() method with the same Comparator) + - if it is not, the behaviour of this method is undefined, and may be an + infinite loop. Further, the key must be comparable with every item in the + list. If the list contains the key more than once, any one of them may be + found. To avoid pathological behaviour on sequential-access lists, a + linear search is used if (l instanceof AbstractSequentialList). Note: + although the specification allows for an infinite loop if the list is + unsorted, it will not happen in this (Classpath) implementation. +@end deftypemethod +@deftypemethod Collections {public static void} copy (java.util.List@w{ }@var{dest}, java.util.List@w{ }@var{source}) +Copy one list to another. If the destination list is longer than the + source list, the remaining elements are unaffected. This method runs in + linear time. +@end deftypemethod +@deftypemethod Collections {public static Enumeration} enumeration (java.util.Collection@w{ }@var{c}) +Returns an Enumeration over a collection. This allows interoperability + with legacy APIs that require an Enumeration as input. +@end deftypemethod +@deftypemethod Collections {public static void} fill (java.util.List@w{ }@var{l}, java.lang.Object@w{ }@var{val}) +Replace every element of a list with a given value. This method runs in + linear time. +@end deftypemethod +@deftypemethod Collections {public static Object} max (java.util.Collection@w{ }@var{c}) +Find the maximum element in a Collection, according to the natural + ordering of the elements. This implementation iterates over the + Collection, so it works in linear time. +@end deftypemethod +@deftypemethod Collections {public static Object} max (java.util.Collection@w{ }@var{c}, java.util.Comparator@w{ }@var{order}) +Find the maximum element in a Collection, according to a specified + Comparator. This implementation iterates over the Collection, so it + works in linear time. +@end deftypemethod +@deftypemethod Collections {public static Object} min (java.util.Collection@w{ }@var{c}) +Find the minimum element in a Collection, according to the natural + ordering of the elements. This implementation iterates over the + Collection, so it works in linear time. +@end deftypemethod +@deftypemethod Collections {public static Object} min (java.util.Collection@w{ }@var{c}, java.util.Comparator@w{ }@var{order}) +Find the minimum element in a Collection, according to a specified + Comparator. This implementation iterates over the Collection, so it + works in linear time. +@end deftypemethod +@deftypemethod Collections {public static List} nCopies (int@w{ }@var{n}, java.lang.Object@w{ }@var{o}) +Creates an immutable list consisting of the same object repeated n times. + The returned object is tiny, consisting of only a single reference to the + object and a count of the number of elements. It is Serializable. +@end deftypemethod +@deftypemethod Collections {public static void} reverse (java.util.List@w{ }@var{l}) +Reverse a given list. This method works in linear time. +@end deftypemethod +@deftypemethod Collections {public static Comparator} reverseOrder () +Get a comparator that implements the reverse of natural ordering. This is + intended to make it easy to sort into reverse order, by simply passing + Collections.reverseOrder() to the sort method. The return value of this + method is Serializable. +@end deftypemethod +@deftypemethod Collections {public static void} shuffle (java.util.List@w{ }@var{l}) +Shuffle a list according to a default source of randomness. The algorithm + used would result in a perfectly fair shuffle (that is, each element would + have an equal chance of ending up in any position) with a perfect source + of randomness; in practice the results are merely very close to perfect. + + + + This method operates in linear time on a random-access list, but may take + quadratic time on a sequential-access list. + Note: this (classpath) implementation will never take quadratic time, but + it does make a copy of the list. This is in line with the behaviour of the + sort methods and seems preferable. +@end deftypemethod +@deftypemethod Collections {public static void} shuffle (java.util.List@w{ }@var{l}, java.util.Random@w{ }@var{r}) +Shuffle a list according to a given source of randomness. The algorithm + used iterates backwards over the list, swapping each element with an + element randomly selected from the elements in positions less than or + equal to it (using r.nextInt(int)). + + + + This algorithm would result in a perfectly fair shuffle (that is, each + element would have an equal chance of ending up in any position) if r were + a perfect source of randomness. In practise (eg if r = new Random()) the + results are merely very close to perfect. + + + + This method operates in linear time on a random-access list, but may take + quadratic time on a sequential-access list. + Note: this (classpath) implementation will never take quadratic time, but + it does make a copy of the list. This is in line with the behaviour of the + sort methods and seems preferable. +@end deftypemethod +@deftypemethod Collections {public static Set} singleton (java.lang.Object@w{ }@var{o}) +Obtain an immutable Set consisting of a single element. The return value + of this method is Serializable. +@end deftypemethod +@deftypemethod Collections {public static List} singletonList (java.lang.Object@w{ }@var{o}) +Obtain an immutable List consisting of a single element. The return value + of this method is Serializable. +@end deftypemethod +@deftypemethod Collections {public static Map} singletonMap (java.lang.Object@w{ }@var{key}, java.lang.Object@w{ }@var{value}) +Obtain an immutable Map consisting of a single key value pair. + The return value of this method is Serializable. +@end deftypemethod +@deftypemethod Collections {public static void} sort (java.util.List@w{ }@var{l}) +Sort a list according to the natural ordering of its elements. The list + must be modifiable, but can be of fixed size. The sort algorithm is + precisely that used by Arrays.sort(Object[]), which offers guaranteed + nlog(n) performance. This implementation dumps the list into an array, + sorts the array, and then iterates over the list setting each element from + the array. +@end deftypemethod +@deftypemethod Collections {public static void} sort (java.util.List@w{ }@var{l}, java.util.Comparator@w{ }@var{c}) +Sort a list according to a specified Comparator. The list must be + modifiable, but can be of fixed size. The sort algorithm is precisely that + used by Arrays.sort(Object[], Comparator), which offers guaranteed + nlog(n) performance. This implementation dumps the list into an array, + sorts the array, and then iterates over the list setting each element from + the array. +@end deftypemethod +@deftypemethod Collections {public static Collection} synchronizedCollection (java.util.Collection@w{ }@var{c}) + +@end deftypemethod +@deftypemethod Collections {public static List} synchronizedList (java.util.List@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Collections {public static Map} synchronizedMap (java.util.Map@w{ }@var{m}) + +@end deftypemethod +@deftypemethod Collections {public static Set} synchronizedSet (java.util.Set@w{ }@var{s}) + +@end deftypemethod +@deftypemethod Collections {public static SortedMap} synchronizedSortedMap (java.util.SortedMap@w{ }@var{m}) + +@end deftypemethod +@deftypemethod Collections {public static SortedSet} synchronizedSortedSet (java.util.SortedSet@w{ }@var{s}) + +@end deftypemethod +@deftypemethod Collections {public static Collection} unmodifiableCollection (java.util.Collection@w{ }@var{c}) + +@end deftypemethod +@deftypemethod Collections {public static List} unmodifiableList (java.util.List@w{ }@var{l}) + +@end deftypemethod +@deftypemethod Collections {public static Map} unmodifiableMap (java.util.Map@w{ }@var{m}) + +@end deftypemethod +@deftypemethod Collections {public static Set} unmodifiableSet (java.util.Set@w{ }@var{s}) + +@end deftypemethod +@deftypemethod Collections {public static SortedMap} unmodifiableSortedMap (java.util.SortedMap@w{ }@var{m}) + +@end deftypemethod +@deftypemethod Collections {public static SortedSet} unmodifiableSortedSet (java.util.SortedSet@w{ }@var{s}) + +@end deftypemethod +@deftypemethod Comparator {public int} compare (java.lang.Object@w{ }@var{o1}, java.lang.Object@w{ }@var{o2}) + +@end deftypemethod +@deftypemethod Comparator {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod Date {public static long} parse (java.lang.String@w{ }@var{string}) + +@end deftypemethod +@deftypemethod Date {public boolean} after (java.util.Date@w{ }@var{when}) + +@end deftypemethod +@deftypemethod Date {public boolean} before (java.util.Date@w{ }@var{when}) + +@end deftypemethod +@deftypemethod Date {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod Date {public long} getTime () + +@end deftypemethod +@deftypemethod Date {public int} hashCode () + +@end deftypemethod +@deftypemethod Date {public void} setTime (long@w{ }@var{millis}) + +@end deftypemethod +@deftypemethod Date {public int} getYear () + +@end deftypemethod +@deftypemethod Date {public int} getMonth () + +@end deftypemethod +@deftypemethod Date {public int} getDate () + +@end deftypemethod +@deftypemethod Date {public int} getDay () + +@end deftypemethod +@deftypemethod Date {public int} getHours () + +@end deftypemethod +@deftypemethod Date {public int} getMinutes () + +@end deftypemethod +@deftypemethod Date {public int} getSeconds () + +@end deftypemethod +@deftypemethod Date {public void} setYear (int@w{ }@var{year}) + +@end deftypemethod +@deftypemethod Date {public void} setMonth (int@w{ }@var{month}) + +@end deftypemethod +@deftypemethod Date {public void} setDate (int@w{ }@var{date}) + +@end deftypemethod +@deftypemethod Date {public void} setHours (int@w{ }@var{hours}) + +@end deftypemethod +@deftypemethod Date {public void} setMinutes (int@w{ }@var{minutes}) + +@end deftypemethod +@deftypemethod Date {public void} setSeconds (int@w{ }@var{seconds}) + +@end deftypemethod +@deftypemethod Date {public int} getTimezoneOffset () + +@end deftypemethod +@deftypemethod Date {public String} toString () + +@end deftypemethod +@deftypemethod Date {public String} toGMTString () + +@end deftypemethod +@deftypemethod Date {public String} toLocaleString () + +@end deftypemethod +@deftypemethod Date {public static long} UTC (int@w{ }@var{year}, int@w{ }@var{month}, int@w{ }@var{date}, int@w{ }@var{hours}, int@w{ }@var{minutes}, int@w{ }@var{seconds}) + +@end deftypemethod +@deftypemethod Dictionary {public abstract Enumeration} elements () + +@end deftypemethod +@deftypemethod Dictionary {public abstract Object} get (java.lang.Object@w{ }@var{key}) @*throws NullPointerException + +@end deftypemethod +@deftypemethod Dictionary {public abstract boolean} isEmpty () + +@end deftypemethod +@deftypemethod Dictionary {public abstract Enumeration} keys () + +@end deftypemethod +@deftypemethod Dictionary {public abstract Object} put (java.lang.Object@w{ }@var{key}, java.lang.Object@w{ }@var{elem}) @*throws NullPointerException + +@end deftypemethod +@deftypemethod Dictionary {public abstract Object} remove (java.lang.Object@w{ }@var{key}) @*throws NullPointerException + +@end deftypemethod +@deftypemethod Dictionary {public abstract int} size () + +@end deftypemethod +@deftypemethod Enumeration {public boolean} hasMoreElements () + +@end deftypemethod +@deftypemethod Enumeration {public Object} nextElement () @*throws NoSuchElementException + +@end deftypemethod +@deftypemethod EventObject {public Object} getSource () + +@end deftypemethod +@deftypemethod EventObject {public String} toString () + +@end deftypemethod +@deftypemethod GregorianCalendar {public int} getMinimum (int@w{ }@var{calfield}) + +@end deftypemethod +@deftypemethod GregorianCalendar {public int} getGreatestMinimum (int@w{ }@var{calfield}) + +@end deftypemethod +@deftypemethod GregorianCalendar {public int} getMaximum (int@w{ }@var{calfield}) + +@end deftypemethod +@deftypemethod GregorianCalendar {public int} getLeastMaximum (int@w{ }@var{calfield}) + +@end deftypemethod +@deftypemethod GregorianCalendar {protected native void} computeFields () + +@end deftypemethod +@deftypemethod GregorianCalendar {protected native void} computeTime () + +@end deftypemethod +@deftypemethod GregorianCalendar {public void} add (int@w{ }@var{fld}, int@w{ }@var{amount}) + +@end deftypemethod +@deftypemethod GregorianCalendar {public void} roll (int@w{ }@var{fld}, boolean@w{ }@var{up}) + +@end deftypemethod +@deftypemethod GregorianCalendar {public final Date} getGregorianChange () + +@end deftypemethod +@deftypemethod GregorianCalendar {public void} setGregorianChange (java.util.Date@w{ }@var{date}) + +@end deftypemethod +@deftypemethod GregorianCalendar {public boolean} isLeapYear (int@w{ }@var{year}) + +@end deftypemethod +@deftypemethod GregorianCalendar {public boolean} after (java.lang.Object@w{ }@var{cal}) + +@end deftypemethod +@deftypemethod GregorianCalendar {public boolean} before (java.lang.Object@w{ }@var{cal}) + +@end deftypemethod +@deftypemethod GregorianCalendar {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod GregorianCalendar {public int} hashCode () + +@end deftypemethod +@deftypemethod HashMap {public int} size () +returns the number of kay-value mappings currently in this Map +@end deftypemethod +@deftypemethod HashMap {public boolean} isEmpty () +returns true if there are no key-value mappings currently in this Map +@end deftypemethod +@deftypemethod HashMap {public boolean} containsValue (java.lang.Object@w{ }@var{value}) +returns true if this HashMap contains a value <pre>o</pre>, such that + <pre>o.equals(value)</pre>. +@end deftypemethod +@deftypemethod HashMap {public boolean} containsKey (java.lang.Object@w{ }@var{key}) +returns true if the supplied object equals (<pre>equals()</pre>) a key + in this HashMap +@end deftypemethod +@deftypemethod HashMap {public Object} get (java.lang.Object@w{ }@var{key}) +return the value in this Hashtable associated with the supplied key, or <pre>null</pre> + if the key maps to nothing +@end deftypemethod +@deftypemethod HashMap {public Object} put (java.lang.Object@w{ }@var{key}, java.lang.Object@w{ }@var{value}) +puts the supplied value into the Map, mapped by the supplied key +@end deftypemethod +@deftypemethod HashMap {public Object} remove (java.lang.Object@w{ }@var{key}) +removes from the HashMap and returns the value which is mapped by the + supplied key; if the key maps to nothing, then the HashMap remains unchanged, + and <pre>null</pre> is returned +@end deftypemethod +@deftypemethod HashMap {public void} putAll (java.util.Map@w{ }@var{m}) + +@end deftypemethod +@deftypemethod HashMap {public void} clear () + +@end deftypemethod +@deftypemethod HashMap {public Object} clone () +returns a shallow clone of this HashMap (i.e. the Map itself is cloned, but + its contents are not) +@end deftypemethod +@deftypemethod HashMap {public Set} keySet () +returns a "set view" of this HashMap's keys +@end deftypemethod +@deftypemethod HashMap {public Collection} values () +Returns a "collection view" (or "bag view") of this HashMap's values. +@end deftypemethod +@deftypemethod HashMap {public Set} entrySet () +Returns a "set view" of this HashMap's entries. +@end deftypemethod +@deftypemethod HashSet {public boolean} add (java.lang.Object@w{ }@var{o}) +adds the given Object to the set if it is not already in the Set, + returns true if teh element was added, false otherwise +@end deftypemethod +@deftypemethod HashSet {public void} clear () +empties this Set of all elements; this is a fast operation [O(1)] +@end deftypemethod +@deftypemethod HashSet {public Object} clone () +returns a shallow copy of this Set (the Set itself is cloned; its + elements are not) +@end deftypemethod +@deftypemethod HashSet {public boolean} contains (java.lang.Object@w{ }@var{o}) +returns true if the supplied element is in this Set, false otherwise +@end deftypemethod +@deftypemethod HashSet {public boolean} isEmpty () +returns true if this set has no elements in it (size() == 0) +@end deftypemethod +@deftypemethod HashSet {public Iterator} iterator () +returns an Iterator over the elements of this Set; the Iterator allows + removal of elements +@end deftypemethod +@deftypemethod HashSet {public boolean} remove (java.lang.Object@w{ }@var{o}) +removes the supplied Object from this Set if it is in the Set; returns + true if an element was removed, false otherwise +@end deftypemethod +@deftypemethod HashSet {public int} size () +returns the number of elements in this Set +@end deftypemethod +@deftypemethod Hashtable {public int} size () +Returns the number of key-value mappings currently in this Map +@end deftypemethod +@deftypemethod Hashtable {public boolean} isEmpty () +returns true if there are no key-value mappings currently in this Map +@end deftypemethod +@deftypemethod Hashtable {public synchronized Enumeration} keys () + +@end deftypemethod +@deftypemethod Hashtable {public synchronized Enumeration} elements () + +@end deftypemethod +@deftypemethod Hashtable {public synchronized boolean} contains (java.lang.Object@w{ }@var{value}) +returns true if this Hashtable contains a value <pre>o</pre>, + such that <pre>o.equals(value)</pre>. + + Note: this is one of the <i>old</i> Hashtable methods which does + not like null values; it throws NullPointerException if the + supplied parameter is null. +@end deftypemethod +@deftypemethod Hashtable {public boolean} containsValue (java.lang.Object@w{ }@var{value}) +returns true if this Hashtable contains a value <pre>o</pre>, such that + <pre>o.equals(value)</pre>. +@end deftypemethod +@deftypemethod Hashtable {public synchronized boolean} containsKey (java.lang.Object@w{ }@var{key}) +returns true if the supplied object equals (<pre>equals()</pre>) a key + in this Hashtable +@end deftypemethod +@deftypemethod Hashtable {public synchronized Object} get (java.lang.Object@w{ }@var{key}) +return the value in this Hashtable associated with the supplied key, or <pre>null</pre> + if the key maps to nothing +@end deftypemethod +@deftypemethod Hashtable {public synchronized Object} put (java.lang.Object@w{ }@var{key}, java.lang.Object@w{ }@var{value}) +puts the supplied value into the Map, mapped by the supplied key +@end deftypemethod +@deftypemethod Hashtable {public synchronized Object} remove (java.lang.Object@w{ }@var{key}) +removes from the table and returns the value which is mapped by the + supplied key; if the key maps to nothing, then the table remains + unchanged, and <pre>null</pre> is returned +@end deftypemethod +@deftypemethod Hashtable {public synchronized void} putAll (java.util.Map@w{ }@var{m}) + +@end deftypemethod +@deftypemethod Hashtable {public synchronized void} clear () + +@end deftypemethod +@deftypemethod Hashtable {public synchronized Object} clone () +returns a shallow clone of this Hashtable (i.e. the Map itself is cloned, + but its contents are not) +@end deftypemethod +@deftypemethod Hashtable {public synchronized String} toString () + +@end deftypemethod +@deftypemethod Hashtable {public Set} keySet () +returns a "set view" of this Hashtable's keys +@end deftypemethod +@deftypemethod Hashtable {public Collection} values () +Returns a "collection view" (or "bag view") of this Hashtable's values. +@end deftypemethod +@deftypemethod Hashtable {public Set} entrySet () +Returns a "set view" of this Hashtable's entries. +@end deftypemethod +@deftypemethod Hashtable {public boolean} equals (java.lang.Object@w{ }@var{o}) +returns true if this Hashtable equals the supplied Object <pre>o</pre>; + that is: + <pre> + if (o instanceof Map) + and + o.keySet().equals(keySet()) + and + for each key in o.keySet(), o.get(key).equals(get(key)) +</pre> +@end deftypemethod +@deftypemethod Hashtable {public int} hashCode () +a Map's hashCode is the sum of the hashCodes of all of its +Map.Entry objects +@end deftypemethod +@deftypemethod Hashtable {protected void} rehash () +increases the size of the Hashtable and rehashes all keys to new array + indices; this is called when the addition of a new value would cause + size() > threshold. Note that the existing Entry objects are reused in + the new hash table. +@end deftypemethod +@deftypemethod Iterator {public boolean} hasNext () + +@end deftypemethod +@deftypemethod Iterator {public Object} next () + +@end deftypemethod +@deftypemethod Iterator {public void} remove () + +@end deftypemethod +@deftypemethod LinkedList {public Object} getFirst () + +@end deftypemethod +@deftypemethod LinkedList {public Object} getLast () + +@end deftypemethod +@deftypemethod LinkedList {public Object} removeFirst () + +@end deftypemethod +@deftypemethod LinkedList {public Object} removeLast () + +@end deftypemethod +@deftypemethod LinkedList {public void} addFirst (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod LinkedList {public void} addLast (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod LinkedList {public boolean} contains (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod LinkedList {public int} size () + +@end deftypemethod +@deftypemethod LinkedList {public boolean} add (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod LinkedList {public boolean} remove (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod LinkedList {public boolean} addAll (java.util.Collection@w{ }@var{c}) + +@end deftypemethod +@deftypemethod LinkedList {public boolean} addAll (int@w{ }@var{index}, java.util.Collection@w{ }@var{c}) + +@end deftypemethod +@deftypemethod LinkedList {public void} clear () + +@end deftypemethod +@deftypemethod LinkedList {public Object} get (int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod LinkedList {public Object} set (int@w{ }@var{index}, java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod LinkedList {public void} add (int@w{ }@var{index}, java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod LinkedList {public Object} remove (int@w{ }@var{index}) + +@end deftypemethod +@deftypemethod LinkedList {public int} indexOf (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod LinkedList {public int} lastIndexOf (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod LinkedList {public ListIterator} listIterator (int@w{ }@var{index}) +Obtain a ListIterator over this list, starting at a given index. The + ListIterator returned by this method supports the add, remove and set + methods. +@end deftypemethod +@deftypemethod LinkedList {public Object} clone () +Create a shallow copy of this LinkedList. +@end deftypemethod +@deftypemethod LinkedList {public Object} toArray () + +@end deftypemethod +@deftypemethod LinkedList {public Object} toArray (java.lang.Object[]@w{ }@var{array}) + +@end deftypemethod +@deftypemethod ListIterator {public boolean} hasNext () + +@end deftypemethod +@deftypemethod ListIterator {public Object} next () + +@end deftypemethod +@deftypemethod ListIterator {public boolean} hasPrevious () + +@end deftypemethod +@deftypemethod ListIterator {public Object} previous () + +@end deftypemethod +@deftypemethod ListIterator {public int} nextIndex () + +@end deftypemethod +@deftypemethod ListIterator {public int} previousIndex () + +@end deftypemethod +@deftypemethod ListIterator {public void} remove () + +@end deftypemethod +@deftypemethod ListIterator {public void} set (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod ListIterator {public void} add (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod List {public void} add (int@w{ }@var{index}, java.lang.Object@w{ }@var{o}) +Insert an element into the list at a given position. +@end deftypemethod +@deftypemethod List {public boolean} add (java.lang.Object@w{ }@var{o}) +Add an element to the end of the list. +@end deftypemethod +@deftypemethod List {public boolean} addAll (int@w{ }@var{index}, java.util.Collection@w{ }@var{c}) +Insert the contents of a collection into the list at a given position. +@end deftypemethod +@deftypemethod List {public boolean} addAll (java.util.Collection@w{ }@var{c}) +Add the contents of a collection to the end of the list. +@end deftypemethod +@deftypemethod List {public void} clear () +Clear the list, such that a subsequent call to isEmpty() would return + true. +@end deftypemethod +@deftypemethod List {public boolean} contains (java.lang.Object@w{ }@var{o}) +Test whether this list contains a given object as one of its elements. +@end deftypemethod +@deftypemethod List {public boolean} containsAll (java.util.Collection@w{ }@var{c}) +Test whether this list contains every element in a given collection. +@end deftypemethod +@deftypemethod List {public boolean} equals (java.lang.Object@w{ }@var{o}) +Test whether this list is equal to another object. A List is defined to be + equal to an object if and only if that object is also a List, and the two + lists are equal. Two lists l1 and l2 are defined to be equal if and only + if @code{l1.size() == l2.size()}, and for every integer n between 0 + and @code{l1.size() - 1} inclusive, @code{l1.get(n) == null ? + l2.get(n) == null : l1.get(n).equals(l2.get(n))}. +@end deftypemethod +@deftypemethod List {public Object} get (int@w{ }@var{index}) +Get the element at a given index in this list. +@end deftypemethod +@deftypemethod List {public int} hashCode () +Obtain a hash code for this list. In order to obey the general contract of + the hashCode method of class Object, this value is calculated as follows: + <pre> + hashCode = 1; + Iterator i = list.iterator(); + while (i.hasNext()) { + Object obj = i.next(); + hashCode = 31*hashCode + (obj==null ? 0 : obj.hashCode()); + } + </pre> + This ensures that the general contract of Object.hashCode() is adhered to. +@end deftypemethod +@deftypemethod List {public int} indexOf (java.lang.Object@w{ }@var{o}) +Obtain the first index at which a given object is to be found in this + list. +@end deftypemethod +@deftypemethod List {public boolean} isEmpty () +Test whether this list is empty, that is, if size() == 0. +@end deftypemethod +@deftypemethod List {public Iterator} iterator () +Obtain an Iterator over this list. +@end deftypemethod +@deftypemethod List {public int} lastIndexOf (java.lang.Object@w{ }@var{o}) +Obtain the last index at which a given object is to be found in this + list. +@end deftypemethod +@deftypemethod List {public ListIterator} listIterator () +Obtain a ListIterator over this list, starting at the beginning. +@end deftypemethod +@deftypemethod List {public ListIterator} listIterator (int@w{ }@var{index}) +Obtain a ListIterator over this list, starting at a given position. +@end deftypemethod +@deftypemethod List {public Object} remove (int@w{ }@var{index}) +Remove the element at a given position in this list. +@end deftypemethod +@deftypemethod List {public boolean} remove (java.lang.Object@w{ }@var{o}) +Remove the first occurence of an object from this list. That is, remove + the first element e such that @code{o == null ? e == null : + o.equals(e)}. +@end deftypemethod +@deftypemethod List {public boolean} removeAll (java.util.Collection@w{ }@var{c}) +Remove all elements of a given collection from this list. That is, remove + every element e such that c.contains(e). +@end deftypemethod +@deftypemethod List {public boolean} retainAll (java.util.Collection@w{ }@var{c}) +Remove all elements of this list that are not contained in a given + collection. That is, remove every element e such that !c.contains(e). +@end deftypemethod +@deftypemethod List {public Object} set (int@w{ }@var{index}, java.lang.Object@w{ }@var{o}) +Replace an element of this list with another object. +@end deftypemethod +@deftypemethod List {public int} size () +Get the number of elements in this list. +@end deftypemethod +@deftypemethod List {public List} subList (int@w{ }@var{fromIndex}, int@w{ }@var{toIndex}) +Obtain a List view of a subsection of this list, from fromIndex + (inclusive) to toIndex (exclusive). The returned list should be modifiable + if and only if this list is modifiable. Changes to the returned list + should be reflected in this list. If this list is structurally modified in + any way other than through the returned list, the result of any subsequent + operations on the returned list is undefined. +@end deftypemethod +@deftypemethod List {public Object} toArray () +Copy the current contents of this list into an array. +@end deftypemethod +@deftypemethod List {public Object} toArray (java.lang.Object[]@w{ }@var{a}) +Copy the current contents of this list into an array. If the array passed + as an argument has length less than that of this list, an array of the + same run-time type as a, and length equal to the length of this list, is + allocated using Reflection. Otherwise, a itself is used. The elements of + this list are copied into it, and if there is space in the array, the + following element is set to null. The resultant array is returned. + Note: The fact that the following element is set to null is only useful + if it is known that this list does not contain any null elements. +@end deftypemethod +@deftypemethod ListResourceBundle {public final Object} handleGetObject (java.lang.String@w{ }@var{key}) + +@end deftypemethod +@deftypemethod ListResourceBundle {public Enumeration} getKeys () + +@end deftypemethod +@deftypemethod ListResourceBundle {protected abstract Object} getContents () + +@end deftypemethod +@deftypemethod Locale {public Object} clone () + +@end deftypemethod +@deftypemethod Locale {public boolean} equals (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod Locale {public String} getCountry () + +@end deftypemethod +@deftypemethod Locale {public String} getLanguage () + +@end deftypemethod +@deftypemethod Locale {public String} getVariant () + +@end deftypemethod +@deftypemethod Locale {public int} hashCode () + +@end deftypemethod +@deftypemethod Locale {public static Locale} getDefault () + +@end deftypemethod +@deftypemethod Locale {public static void} setDefault (java.util.Locale@w{ }@var{newLocale}) + +@end deftypemethod +@deftypemethod Locale {public String} toString () + +@end deftypemethod +@deftypemethod Map {public void} clear () + +@end deftypemethod +@deftypemethod Map {public boolean} containsKey (java.lang.Object@w{ }@var{key}) + +@end deftypemethod +@deftypemethod Map {public boolean} containsValue (java.lang.Object@w{ }@var{value}) + +@end deftypemethod +@deftypemethod Map {public Set} entrySet () + +@end deftypemethod +@deftypemethod Map {public boolean} equals (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod Map {public Object} get (java.lang.Object@w{ }@var{key}) + +@end deftypemethod +@deftypemethod Map {public Object} put (java.lang.Object@w{ }@var{key}, java.lang.Object@w{ }@var{value}) + +@end deftypemethod +@deftypemethod Map {public int} hashCode () + +@end deftypemethod +@deftypemethod Map {public boolean} isEmpty () + +@end deftypemethod +@deftypemethod Map {public Set} keySet () + +@end deftypemethod +@deftypemethod Map {public void} putAll (java.util.Map@w{ }@var{m}) + +@end deftypemethod +@deftypemethod Map {public Object} remove (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod Map {public int} size () + +@end deftypemethod +@deftypemethod Map {public Collection} values () + +@end deftypemethod +@deftypemethod Map.Entry {public Object} getKey () + +@end deftypemethod +@deftypemethod Map.Entry {public Object} getValue () + +@end deftypemethod +@deftypemethod Map.Entry {public Object} setValue (java.lang.Object@w{ }@var{value}) + +@end deftypemethod +@deftypemethod Map.Entry {public int} hashCode () + +@end deftypemethod +@deftypemethod Map.Entry {public boolean} equals (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod MissingResourceException {public String} getClassName () + +@end deftypemethod +@deftypemethod MissingResourceException {public String} getKey () + +@end deftypemethod +@deftypemethod Observable {public synchronized void} addObserver (java.util.Observer@w{ }@var{obs}) + +@end deftypemethod +@deftypemethod Observable {protected synchronized void} clearChanged () + +@end deftypemethod +@deftypemethod Observable {public synchronized int} countObservers () + +@end deftypemethod +@deftypemethod Observable {public synchronized void} deleteObserver (java.util.Observer@w{ }@var{obs}) + +@end deftypemethod +@deftypemethod Observable {public synchronized void} deleteObservers () + +@end deftypemethod +@deftypemethod Observable {public synchronized boolean} hasChanged () + +@end deftypemethod +@deftypemethod Observable {public void} notifyObservers () + +@end deftypemethod +@deftypemethod Observable {public void} notifyObservers (java.lang.Object@w{ }@var{arg}) + +@end deftypemethod +@deftypemethod Observable {protected synchronized void} setChanged () + +@end deftypemethod +@deftypemethod Observer {public void} update (java.util.Observable@w{ }@var{observed}, java.lang.Object@w{ }@var{arg}) + +@end deftypemethod +@deftypemethod Properties {public void} load (java.io.InputStream@w{ }@var{inStream}) @*throws IOException +Reads a property list from an input stream. The stream should + have the following format: <br> + + An empty line or a line starting with @code{#} or + @code{!} is ignored. An backslash (@code{\}) at the + end of the line makes the line continueing on the next line + (but make sure there is no whitespace after the backslash). + Otherwise, each line describes a key/value pair. <br> + + The chars up to the first whitespace, = or : are the key. You + can include this caracters in the key, if you precede them with + a backslash (@code{\}). The key is followed by optional + whitespaces, optionally one @code{=} or @code{:}, + and optionally some more whitespaces. The rest of the line is + the resource belonging to the key. <br> + + Escape sequences @code{\t, \n, \r, \\, \", \', \!, \#, \ }(a + space), and unicode characters with the + @code{\}@code{u}xxxx notation are detected, and + converted to the corresponding single character. <br> + + <pre> + # This is a comment + key = value + k\:5 \ a string starting with space and ending with newline\n + # This is a multiline specification; note that the value contains + # no white space. + weekdays: Sunday,Monday,Tuesday,Wednesday,\ + Thursday,Friday,Saturday + # The safest way to include a space at the end of a value: + label = Name:\@code{}u0020 + </pre> +@end deftypemethod +@deftypemethod Properties {public void} save (java.io.OutputStream@w{ }@var{out}, java.lang.String@w{ }@var{header}) +Calls @code{store(OutputStream out, String header)} and + ignores the IOException that may be thrown. +@end deftypemethod +@deftypemethod Properties {public void} store (java.io.OutputStream@w{ }@var{out}, java.lang.String@w{ }@var{header}) @*throws IOException +Writes the key/value pairs to the given output stream. <br> + + If header is not null, this method writes a comment containing + the header as first line to the stream. The next line (or first + line if header is null) contains a comment with the current date. + Afterwards the key/value pairs are written to the stream in the + following format. <br> + + Each line has the form @code{key = value}. Newlines, + Returns and tabs are written as @code{\n,\t,\r} resp. + The characters @code{\, !, #, =} and @code{:} are + preceeded by a backslash. Spaces are preceded with a backslash, + if and only if they are at the beginning of the key. Characters + that are not in the ascii range 33 to 127 are written in the + @code{\}@code{u}xxxx Form. +@end deftypemethod +@deftypemethod Properties {public Object} setProperty (java.lang.String@w{ }@var{key}, java.lang.String@w{ }@var{value}) +Adds the given key/value pair to this properties. This calls + the hashtable method put. +@end deftypemethod +@deftypemethod Properties {public String} getProperty (java.lang.String@w{ }@var{key}) +Gets the property with the specified key in this property list. + If the key is not found, the default property list is searched. + If the property is not found in default or the default of + default, null is returned. +@end deftypemethod +@deftypemethod Properties {public String} getProperty (java.lang.String@w{ }@var{key}, java.lang.String@w{ }@var{defaultValue}) +Gets the property with the specified key in this property list. If + the key is not found, the default property list is searched. If the + property is not found in default or the default of default, the + specified defaultValue is returned. +@end deftypemethod +@deftypemethod Properties {public Enumeration} propertyNames () +Returns an enumeration of all keys in this property list, including + the keys in the default property list. +@end deftypemethod +@deftypemethod Properties {public void} list (java.io.PrintStream@w{ }@var{out}) +Writes the key/value pairs to the given print stream. They are + written in the way, described in the method store. +@end deftypemethod +@deftypemethod Properties {public void} list (java.io.PrintWriter@w{ }@var{out}) +Writes the key/value pairs to the given print writer. They are + written in the way, described in the method store. +@end deftypemethod +@deftypemethod PropertyPermission {public boolean} implies (java.security.Permission@w{ }@var{p}) +Check if this permission implies p. This returns true iff all of + the following conditions are true: + +@itemize @bullet + + +@item + p is a PropertyPermission + + +@item + this.getName() implies p.getName(), + e.g. @code{java.*} implies @code{java.home} + + +@item + this.getActions is a subset of p.getActions + + +@end itemize + +@end deftypemethod +@deftypemethod PropertyPermission {public String} getActions () +Returns the action string. Note that this may differ from the string + given at the constructor: The actions are converted to lowercase and + may be reordered. +@end deftypemethod +@deftypemethod PropertyPermission {public boolean} equals (java.lang.Object@w{ }@var{obj}) +Check to see whether this object is the same as another + PropertyPermission object. +@end deftypemethod +@deftypemethod PropertyPermission {public PermissionCollection} newPermissionCollection () +Returns a permission collection suitable to take + PropertyPermission objects. +@end deftypemethod +@deftypemethod PropertyResourceBundle {public Enumeration} getKeys () + +@end deftypemethod +@deftypemethod PropertyResourceBundle {public Object} handleGetObject (java.lang.String@w{ }@var{key}) + +@end deftypemethod +@deftypemethod Random {protected synchronized int} next (int@w{ }@var{bits}) + +@end deftypemethod +@deftypemethod Random {public boolean} nextBoolean () + +@end deftypemethod +@deftypemethod Random {public void} nextBytes (byte[]@w{ }@var{buf}) + +@end deftypemethod +@deftypemethod Random {public double} nextDouble () + +@end deftypemethod +@deftypemethod Random {public float} nextFloat () + +@end deftypemethod +@deftypemethod Random {public synchronized double} nextGaussian () + +@end deftypemethod +@deftypemethod Random {public int} nextInt () + +@end deftypemethod +@deftypemethod Random {public int} nextInt (int@w{ }@var{n}) + +@end deftypemethod +@deftypemethod Random {public long} nextLong () + +@end deftypemethod +@deftypemethod Random {public synchronized void} setSeed (long@w{ }@var{seed}) + +@end deftypemethod +@deftypemethod ResourceBundle {public Locale} getLocale () + +@end deftypemethod +@deftypemethod ResourceBundle {public final String} getString (java.lang.String@w{ }@var{key}) @*throws MissingResourceException + +@end deftypemethod +@deftypemethod ResourceBundle {public final String} getStringArray (java.lang.String@w{ }@var{key}) @*throws MissingResourceException + +@end deftypemethod +@deftypemethod ResourceBundle {public final Object} getObject (java.lang.String@w{ }@var{key}) @*throws MissingResourceException + +@end deftypemethod +@deftypemethod ResourceBundle {public static final ResourceBundle} getBundle (java.lang.String@w{ }@var{baseName}) @*throws MissingResourceException + +@end deftypemethod +@deftypemethod ResourceBundle {public static final ResourceBundle} getBundle (java.lang.String@w{ }@var{baseName}, java.util.Locale@w{ }@var{locale}) + +@end deftypemethod +@deftypemethod ResourceBundle {public static final ResourceBundle} getBundle (java.lang.String@w{ }@var{baseName}, java.util.Locale@w{ }@var{locale}, java.lang.ClassLoader@w{ }@var{loader}) @*throws MissingResourceException + +@end deftypemethod +@deftypemethod ResourceBundle {protected void} setParent (java.util.ResourceBundle@w{ }@var{parent}) + +@end deftypemethod +@deftypemethod ResourceBundle {protected abstract Object} handleGetObject (java.lang.String@w{ }@var{key}) @*throws MissingResourceException + +@end deftypemethod +@deftypemethod ResourceBundle {public abstract Enumeration} getKeys () + +@end deftypemethod +@deftypemethod Set {public boolean} add (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod Set {public boolean} addAll (java.util.Collection@w{ }@var{c}) + +@end deftypemethod +@deftypemethod Set {public void} clear () + +@end deftypemethod +@deftypemethod Set {public boolean} contains (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod Set {public boolean} containsAll (java.util.Collection@w{ }@var{c}) + +@end deftypemethod +@deftypemethod Set {public boolean} equals (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod Set {public int} hashCode () + +@end deftypemethod +@deftypemethod Set {public boolean} isEmpty () + +@end deftypemethod +@deftypemethod Set {public Iterator} iterator () + +@end deftypemethod +@deftypemethod Set {public boolean} remove (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod Set {public boolean} removeAll (java.util.Collection@w{ }@var{c}) + +@end deftypemethod +@deftypemethod Set {public boolean} retainAll (java.util.Collection@w{ }@var{c}) + +@end deftypemethod +@deftypemethod Set {public int} size () + +@end deftypemethod +@deftypemethod Set {public Object} toArray () + +@end deftypemethod +@deftypemethod SimpleTimeZone {public void} setStartYear (int@w{ }@var{year}) +Sets the first year, where daylight savings applies. The daylight + savings rule never apply for years in the BC era. Note that this + is gregorian calendar specific. +@end deftypemethod +@deftypemethod SimpleTimeZone {public void} setStartRule (int@w{ }@var{month}, int@w{ }@var{day}, int@w{ }@var{dayOfWeek}, int@w{ }@var{time}) +Sets the daylight savings start rule. You must also set the + end rule with @code{setEndRule} or the result of + getOffset is undefined. For the parameters see the ten-argument + constructor above. +@end deftypemethod +@deftypemethod SimpleTimeZone {public void} setEndRule (int@w{ }@var{month}, int@w{ }@var{day}, int@w{ }@var{dayOfWeek}, int@w{ }@var{time}) +Sets the daylight savings end rule. You must also set the + start rule with @code{setStartRule} or the result of + getOffset is undefined. For the parameters see the ten-argument + constructor above. +@end deftypemethod +@deftypemethod SimpleTimeZone {public int} getOffset (int@w{ }@var{era}, int@w{ }@var{year}, int@w{ }@var{month}, int@w{ }@var{day}, int@w{ }@var{dayOfWeek}, int@w{ }@var{millis}) +Gets the time zone offset, for current date, modified in case of + daylight savings. This is the offset to add to UTC to get the local + time. + + In the standard JDK the results given by this method may result in + inaccurate results at the end of February or the beginning of March. + To avoid this, you should use Calendar instead: + <pre> + offset = cal.get(Calendar.ZONE_OFFSET) + cal.get(Calendar.DST_OFFSET); + </pre> + You could also use in + + This version doesn't suffer this inaccuracy. +@end deftypemethod +@deftypemethod SimpleTimeZone {public int} getRawOffset () +Returns the time zone offset to GMT in milliseconds, ignoring + day light savings. +@end deftypemethod +@deftypemethod SimpleTimeZone {public void} setRawOffset (int@w{ }@var{rawOffset}) +Sets the standard time zone offset to GMT. +@end deftypemethod +@deftypemethod SimpleTimeZone {public int} getDSTSavings () +Gets the daylight savings offset. This is a positive offset in + milliseconds with respect to standard time. Typically this + is one hour, but for some time zones this may be half an our. +@end deftypemethod +@deftypemethod SimpleTimeZone {public boolean} useDaylightTime () +Returns if this time zone uses daylight savings time. +@end deftypemethod +@deftypemethod SimpleTimeZone {public boolean} inDaylightTime (java.util.Date@w{ }@var{date}) +Determines if the given date is in daylight savings time. +@end deftypemethod +@deftypemethod SimpleTimeZone {public synchronized int} hashCode () +Generates the hashCode for the SimpleDateFormat object. It is + the rawOffset, possibly, if useDaylightSavings is true, xored + with startYear, startMonth, startDayOfWeekInMonth, ..., endTime. +@end deftypemethod +@deftypemethod SimpleTimeZone {public synchronized boolean} equals (java.lang.Object@w{ }@var{o}) + +@end deftypemethod +@deftypemethod SimpleTimeZone {public boolean} hasSameRules (java.util.TimeZone@w{ }@var{other}) +Test if the other time zone uses the same rule and only + possibly differs in ID. This implementation for this particular + class will return true if the other object is a SimpleTimeZone, + the raw offsets and useDaylight are identical and if useDaylight + is true, also the start and end datas are identical. +@end deftypemethod +@deftypemethod SimpleTimeZone {public String} toString () +Returns a string representation of this SimpleTimeZone object. +@end deftypemethod +@deftypemethod SortedMap {public Comparator} comparator () + +@end deftypemethod +@deftypemethod SortedMap {public Object} firstKey () + +@end deftypemethod +@deftypemethod SortedMap {public SortedMap} headMap (java.lang.Object@w{ }@var{toKey}) + +@end deftypemethod +@deftypemethod SortedMap {public Object} lastKey () + +@end deftypemethod +@deftypemethod SortedMap {public SortedMap} subMap (java.lang.Object@w{ }@var{fromKey}, java.lang.Object@w{ }@var{toKey}) + +@end deftypemethod +@deftypemethod SortedMap {public SortedMap} tailMap (java.lang.Object@w{ }@var{fromKey}) + +@end deftypemethod +@deftypemethod SortedSet {public Comparator} comparator () + +@end deftypemethod +@deftypemethod SortedSet {public Object} first () + +@end deftypemethod +@deftypemethod SortedSet {public SortedSet} headSet (java.lang.Object@w{ }@var{toElement}) + +@end deftypemethod +@deftypemethod SortedSet {public Object} last () + +@end deftypemethod +@deftypemethod SortedSet {public SortedSet} subSet (java.lang.Object@w{ }@var{fromElement}, java.lang.Object@w{ }@var{toElement}) + +@end deftypemethod +@deftypemethod SortedSet {public SortedSet} tailSet (java.lang.Object@w{ }@var{fromElement}) + +@end deftypemethod +@deftypemethod Stack {public boolean} empty () + +@end deftypemethod +@deftypemethod Stack {public synchronized Object} peek () + +@end deftypemethod +@deftypemethod Stack {public synchronized Object} pop () + +@end deftypemethod +@deftypemethod Stack {public Object} push (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod Stack {public synchronized int} search (java.lang.Object@w{ }@var{obj}) + +@end deftypemethod +@deftypemethod StringTokenizer {public int} countTokens () + +@end deftypemethod +@deftypemethod StringTokenizer {public boolean} hasMoreElements () + +@end deftypemethod +@deftypemethod StringTokenizer {public boolean} hasMoreTokens () + +@end deftypemethod +@deftypemethod StringTokenizer {public Object} nextElement () + +@end deftypemethod +@deftypemethod StringTokenizer {public String} nextToken () + +@end deftypemethod +@deftypemethod StringTokenizer {public String} nextToken (java.lang.String@w{ }@var{delims}) + +@end deftypemethod +@deftypemethod Timer {public void} cancel () +Cancels the execution of the scheduler. If a task is executing it will + normally finish execution, but no other tasks will be executed and no + more tasks can be scheduled. +@end deftypemethod +@deftypemethod Timer {public void} schedule (java.util.TimerTask@w{ }@var{task}, java.util.Date@w{ }@var{date}) +Schedules the task at the specified data for one time execution. +@end deftypemethod +@deftypemethod Timer {public void} schedule (java.util.TimerTask@w{ }@var{task}, java.util.Date@w{ }@var{date}, long@w{ }@var{period}) +Schedules the task at the specified date and reschedules the task every + period milliseconds after the last execution of the task finishes until + this timer or the task is canceled. +@end deftypemethod +@deftypemethod Timer {public void} schedule (java.util.TimerTask@w{ }@var{task}, long@w{ }@var{delay}) +Schedules the task after the specified delay milliseconds for one time + execution. +@end deftypemethod +@deftypemethod Timer {public void} schedule (java.util.TimerTask@w{ }@var{task}, long@w{ }@var{delay}, long@w{ }@var{period}) +Schedules the task after the delay milliseconds and reschedules the + task every period milliseconds after the last execution of the task + finishes until this timer or the task is canceled. +@end deftypemethod +@deftypemethod Timer {public void} scheduleAtFixedRate (java.util.TimerTask@w{ }@var{task}, java.util.Date@w{ }@var{date}, long@w{ }@var{period}) +Schedules the task at the specified date and reschedules the task at a + fixed rate every period milliseconds until this timer or the task is + canceled. +@end deftypemethod +@deftypemethod Timer {public void} scheduleAtFixedRate (java.util.TimerTask@w{ }@var{task}, long@w{ }@var{delay}, long@w{ }@var{period}) +Schedules the task after the delay milliseconds and reschedules the task + at a fixed rate every period milliseconds until this timer or the task + is canceled. +@end deftypemethod +@deftypemethod Timer {protected void} finalize () +Tells the scheduler that the Timer task died + so there will be no more new tasks scheduled. +@end deftypemethod +@deftypemethod TimerTask {public boolean} cancel () +Marks the task as canceled and prevents any further execution. + Returns true if the task was scheduled for any execution in the future + and this cancel operation prevents that execution from happening. + + + + A task that has been canceled can never be scheduled again. + + + + In this implementation the TimerTask it is possible that the Timer does + keep a reference to the TimerTask until the first time the TimerTask + is actually scheduled. But the reference will disappear immediatly when + cancel is called from within the TimerTask run method. +@end deftypemethod +@deftypemethod TimerTask {public abstract void} run () +Method that is called when this task is scheduled for execution. +@end deftypemethod +@deftypemethod TimerTask {public long} scheduledExecutionTime () +Returns the last time this task was scheduled or (when called by the + task from the run method) the time the current execution of the task + was scheduled. When the task has not yet run the return value is + undefined. + + + + Can be used (when the task is scheduled at fixed rate) to see the + difference between the requested schedule time and the actual time + that can be found with @code{System.currentTimeMillis()}. +@end deftypemethod +@deftypemethod TimeZone {public abstract int} getOffset (int@w{ }@var{era}, int@w{ }@var{year}, int@w{ }@var{month}, int@w{ }@var{day}, int@w{ }@var{dayOfWeek}, int@w{ }@var{milliseconds}) +Gets the time zone offset, for current date, modified in case of + daylight savings. This is the offset to add to UTC to get the local + time. +@end deftypemethod +@deftypemethod TimeZone {public abstract int} getRawOffset () +Gets the time zone offset, ignoring daylight savings. This is + the offset to add to UTC to get the local time. +@end deftypemethod +@deftypemethod TimeZone {public abstract void} setRawOffset (int@w{ }@var{offsetMillis}) +Sets the time zone offset, ignoring daylight savings. This is + the offset to add to UTC to get the local time. +@end deftypemethod +@deftypemethod TimeZone {public String} getID () +Gets the identifier of this time zone. For instance, PST for + Pacific Standard Time. +@end deftypemethod +@deftypemethod TimeZone {public void} setID (java.lang.String@w{ }@var{id}) +Sets the identifier of this time zone. For instance, PST for + Pacific Standard Time. +@end deftypemethod +@deftypemethod TimeZone {public final String} getDisplayName () +This method returns a string name of the time zone suitable + for displaying to the user. The string returned will be the long + description of the timezone in the current locale. The name + displayed will assume daylight savings time is not in effect. +@end deftypemethod +@deftypemethod TimeZone {public final String} getDisplayName (java.util.Locale@w{ }@var{locale}) +This method returns a string name of the time zone suitable + for displaying to the user. The string returned will be the long + description of the timezone in the specified locale. The name + displayed will assume daylight savings time is not in effect. +@end deftypemethod +@deftypemethod TimeZone {public final String} getDisplayName (boolean@w{ }@var{dst}, int@w{ }@var{style}) +This method returns a string name of the time zone suitable + for displaying to the user. The string returned will be of the + specified type in the current locale. +@end deftypemethod +@deftypemethod TimeZone {public String} getDisplayName (boolean@w{ }@var{dst}, int@w{ }@var{style}, java.util.Locale@w{ }@var{locale}) +This method returns a string name of the time zone suitable + for displaying to the user. The string returned will be of the + specified type in the specified locale. +@end deftypemethod +@deftypemethod TimeZone {public abstract boolean} useDaylightTime () +Returns true, if this time zone uses Daylight Savings Time. +@end deftypemethod +@deftypemethod TimeZone {public abstract boolean} inDaylightTime (java.util.Date@w{ }@var{date}) +Returns true, if the given date is in Daylight Savings Time in this + time zone. +@end deftypemethod +@deftypemethod TimeZone {public static TimeZone} getTimeZone (java.lang.String@w{ }@var{ID}) +Gets the TimeZone for the given ID. +@end deftypemethod +@deftypemethod TimeZone {public static String} getAvailableIDs (int@w{ }@var{rawOffset}) +Gets the available IDs according to the given time zone + offset. +@end deftypemethod +@deftypemethod TimeZone {public static String} getAvailableIDs () +Gets all available IDs. +@end deftypemethod +@deftypemethod TimeZone {public static TimeZone} getDefault () +Returns the time zone under which the host is running. This + can be changed with setDefault. +@end deftypemethod +@deftypemethod TimeZone {public static void} setDefault (java.util.TimeZone@w{ }@var{zone}) + +@end deftypemethod +@deftypemethod TimeZone {public boolean} hasSameRules (java.util.TimeZone@w{ }@var{other}) +Test if the other time zone uses the same rule and only + possibly differs in ID. This implementation for this particular + class will return true if the raw offsets are identical. Subclasses + should override this method if they use daylight savings. +@end deftypemethod +@deftypemethod TimeZone {public Object} clone () +Returns a clone of this object. I can't imagine, why this is + useful for a time zone. +@end deftypemethod +@deftypemethod Vector {public synchronized void} copyInto (java.lang.Object[]@w{ }@var{anArray}) +Copies the contents of a provided array into the Vector. If the + array is too large to fit in the Vector, an ArrayIndexOutOfBoundsException + is thrown. Old elements in the Vector are overwritten by the new + elements +@end deftypemethod +@deftypemethod Vector {public synchronized void} trimToSize () +Trims the Vector down to size. If the internal data array is larger + than the number of Objects its holding, a new array is constructed + that precisely holds the elements. +@end deftypemethod +@deftypemethod Vector {public synchronized void} ensureCapacity (int@w{ }@var{minCapacity}) +Ensures that <b>minCapacity</b> elements can fit within this Vector. + If it cannot hold this many elements, the internal data array is expanded + in the following manner. If the current size plus the capacityIncrement + is sufficient, the internal array is expanded by capacityIncrement. + If capacityIncrement is non-positive, the size is doubled. If + neither is sufficient, the internal array is expanded to size minCapacity +@end deftypemethod +@deftypemethod Vector {public synchronized void} setSize (int@w{ }@var{newSize}) +Explicitly sets the size of the internal data array, copying the + old values to the new internal array. If the new array is smaller + than the old one, old values that don't fit are lost. If the new size + is larger than the old one, the vector is padded with null entries. +@end deftypemethod +@deftypemethod Vector {public int} capacity () +Returns the size of the internal data array (not the amount of elements + contained in the Vector) +@end deftypemethod +@deftypemethod Vector {public int} size () +Returns the number of elements stored in this Vector +@end deftypemethod +@deftypemethod Vector {public boolean} isEmpty () +Returns true if this Vector is empty, false otherwise +@end deftypemethod +@deftypemethod Vector {public synchronized int} indexOf (java.lang.Object@w{ }@var{e}, int@w{ }@var{index}) +Searches the vector starting at <b>index</b> for object <b>elem</b> + and returns the index of the first occurence of this Object. If + the object is not found, -1 is returned +@end deftypemethod +@deftypemethod Vector {public int} indexOf (java.lang.Object@w{ }@var{elem}) +Returns the first occurence of <b>elem</b> in the Vector, or -1 if + <b>elem</b> is not found. +@end deftypemethod +@deftypemethod Vector {public boolean} contains (java.lang.Object@w{ }@var{elem}) +Returns true if <b>elem</b> is contained in this Vector, false otherwise. +@end deftypemethod +@deftypemethod Vector {public synchronized int} lastIndexOf (java.lang.Object@w{ }@var{e}, int@w{ }@var{index}) +Returns the index of the first occurence of <b>elem</b>, when searching + backwards from <b>index</b>. If the object does not occur in this Vector, + -1 is returned. +@end deftypemethod +@deftypemethod Vector {public int} lastIndexOf (java.lang.Object@w{ }@var{elem}) +Returns the last index of <b>elem</b> within this Vector, or -1 + if the object is not within the Vector +@end deftypemethod +@deftypemethod Vector {public synchronized Object} elementAt (int@w{ }@var{index}) +Returns the Object stored at <b>index</b>. If index is out of range + an ArrayIndexOutOfBoundsException is thrown. +@end deftypemethod +@deftypemethod Vector {public synchronized Object} firstElement () +Returns the first element in the Vector. If there is no first Object + (The vector is empty), a NoSuchElementException is thrown. +@end deftypemethod +@deftypemethod Vector {public synchronized Object} lastElement () +Returns the last element in the Vector. If the Vector has no last element + (The vector is empty), a NoSuchElementException is thrown. +@end deftypemethod +@deftypemethod Vector {public synchronized void} setElementAt (java.lang.Object@w{ }@var{obj}, int@w{ }@var{index}) +Places <b>obj</b> at <b>index</b> within the Vector. If <b>index</b> + refers to an index outside the Vector, an ArrayIndexOutOfBoundsException + is thrown. +@end deftypemethod +@deftypemethod Vector {public synchronized Object} set (int@w{ }@var{index}, java.lang.Object@w{ }@var{element}) +Puts <b>element</b> into the Vector at position <b>index</b> and returns + the Object that previously occupied that position. +@end deftypemethod +@deftypemethod Vector {public synchronized void} removeElementAt (int@w{ }@var{index}) +Removes the element at <b>index</b>, and shifts all elements at + positions greater than index to their index - 1. +@end deftypemethod +@deftypemethod Vector {public void} insertElementAt (java.lang.Object@w{ }@var{obj}, int@w{ }@var{index}) +Inserts a new element into the Vector at <b>index</b>. Any elements + at or greater than index are shifted up one position. +@end deftypemethod +@deftypemethod Vector {public synchronized void} addElement (java.lang.Object@w{ }@var{obj}) +Adds an element to the Vector at the end of the Vector. If the vector + cannot hold the element with its present capacity, its size is increased + based on the same rules followed if ensureCapacity was called with the + argument currentSize+1. +@end deftypemethod +@deftypemethod Vector {public synchronized boolean} removeElement (java.lang.Object@w{ }@var{obj}) +Removes the first occurence of the given object from the Vector. + If such a remove was performed (the object was found), true is returned. + If there was no such object, false is returned. +@end deftypemethod +@deftypemethod Vector {public synchronized void} removeAllElements () +Removes all elements from the Vector. Note that this does not + resize the internal data array. +@end deftypemethod +@deftypemethod Vector {public synchronized Object} clone () +Creates a new Vector with the same contents as this one. +@end deftypemethod +@deftypemethod Vector {public synchronized Object} toArray () +Returns an Object array with the contents of this Vector, in the order + they are stored within this Vector. Note that the Object array returned + is not the internal data array, and that it holds only the elements + within the Vector. This is similar to creating a new Object[] with the + size of this Vector, then calling Vector.copyInto(yourArray). +@end deftypemethod +@deftypemethod Vector {public synchronized Object} toArray (java.lang.Object[]@w{ }@var{array}) +Returns an array containing the contents of this Vector. + If the provided array is large enough, the contents are copied + into that array, and a null is placed in the position size(). + In this manner, you can obtain the size of a Vector by the position + of the null element. If the type of the provided array cannot + hold the elements, an ArrayStoreException is thrown. + + If the provided array is not large enough, + a new one is created with the contents of the Vector, and no null + element. The new array is of the same runtime type as the provided + array. +@end deftypemethod +@deftypemethod Vector {public synchronized Object} get (int@w{ }@var{index}) +Returns the element at position <b>index</b> +@end deftypemethod +@deftypemethod Vector {public boolean} remove (java.lang.Object@w{ }@var{o}) +Removes the given Object from the Vector. If it exists, true + is returned, if not, false is returned. +@end deftypemethod +@deftypemethod Vector {public synchronized boolean} add (java.lang.Object@w{ }@var{o}) +Adds an object to the Vector. +@end deftypemethod +@deftypemethod Vector {public void} add (int@w{ }@var{index}, java.lang.Object@w{ }@var{element}) +Adds an object at the specified index. Elements at or above + index are shifted up one position. +@end deftypemethod +@deftypemethod Vector {public synchronized Object} remove (int@w{ }@var{index}) +Removes the element at the specified index, and returns it. +@end deftypemethod +@deftypemethod Vector {public void} clear () +Clears all elements in the Vector and sets its size to 0 +@end deftypemethod +@deftypemethod Vector {public synchronized boolean} containsAll (java.util.Collection@w{ }@var{c}) + +@end deftypemethod +@deftypemethod Vector {public synchronized boolean} addAll (java.util.Collection@w{ }@var{c}) + +@end deftypemethod +@deftypemethod Vector {public synchronized boolean} removeAll (java.util.Collection@w{ }@var{c}) + +@end deftypemethod +@deftypemethod Vector {public synchronized boolean} retainAll (java.util.Collection@w{ }@var{c}) + +@end deftypemethod +@deftypemethod Vector {public synchronized boolean} addAll (int@w{ }@var{index}, java.util.Collection@w{ }@var{c}) + +@end deftypemethod +@deftypemethod Vector {public synchronized boolean} equals (java.lang.Object@w{ }@var{c}) + +@end deftypemethod +@deftypemethod Vector {public synchronized int} hashCode () + +@end deftypemethod +@deftypemethod Vector {public synchronized String} toString () +Returns a string representation of this Vector in the form + [element0, element1, ... elementN] +@end deftypemethod +@deftypemethod Vector {public synchronized Enumeration} elements () +Returns an Enumeration of the elements of this List. + The Enumeration returned is compatible behavior-wise with + the 1.1 elements() method, in that it does not check for + concurrent modification. +@end deftypemethod +@deftypemethod Vector {public List} subList (int@w{ }@var{fromIndex}, int@w{ }@var{toIndex}) + +@end deftypemethod +@deftypemethod Vector {protected synchronized void} removeRange (int@w{ }@var{fromIndex}, int@w{ }@var{toIndex}) + +@end deftypemethod +@deftypemethod WeakHashMap {public int} size () +Returns the size of this hash map. Note that the size() may shrink + spontanously, if the some of the keys were only weakly reachable. +@end deftypemethod +@deftypemethod WeakHashMap {public boolean} isEmpty () +Tells if the map is empty. Note that the result may change + spontanously, if all of the keys were only weakly reachable. +@end deftypemethod +@deftypemethod WeakHashMap {public boolean} containsKey (java.lang.Object@w{ }@var{key}) +Tells if the map contains the given key. Note that the result + may change spontanously, if all the key was only weakly + reachable. +@end deftypemethod +@deftypemethod WeakHashMap {public Object} get (java.lang.Object@w{ }@var{key}) +Gets the value the key will be mapped to. +@end deftypemethod +@deftypemethod WeakHashMap {public Object} put (java.lang.Object@w{ }@var{key}, java.lang.Object@w{ }@var{value}) +Adds a new key/value mapping to this map. +@end deftypemethod +@deftypemethod WeakHashMap {public Object} remove (java.lang.Object@w{ }@var{key}) +Removes the key and the corresponding value from this map. +@end deftypemethod +@deftypemethod WeakHashMap {public Set} entrySet () +Returns a set representation of the entries in this map. This + set will not have strong references to the keys, so they can be + silently removed. The returned set has therefore the same + strange behaviour (shrinking size(), disappearing entries) as + this weak hash map. +@end deftypemethod diff --git a/libjava/scripts/TexinfoDoclet.java b/libjava/scripts/TexinfoDoclet.java new file mode 100644 index 00000000000..aadc21786f3 --- /dev/null +++ b/libjava/scripts/TexinfoDoclet.java @@ -0,0 +1,140 @@ +/* Copyright (C) 2001 Free Software Foundation + + This file is part of libgcj. + +This software is copyrighted work licensed under the terms of the +Libgcj License. Please consult the file "LIBGCJ_LICENSE" for +details. */ + +import java.io.*; +import com.sun.javadoc.*; + +public class TexinfoDoclet +{ + static PrintStream outfile; + + public static int optionLength(String option) + { + if (option.equals("-outfile")) + return 2; + return 0; + } + + private static String replace (String s, String text, String replacement) + { + int i = s.indexOf (text); + while (i != -1) + { + s = s.substring(0, i) + replacement + s.substring(i+text.length()); + i = s.indexOf (text); + } + + return s; + } + + private static String texify (String s) + { + if (s.indexOf('<') == -1) + return s; + + s = replace (s, "<code>", "@code{"); + s = replace (s, "</code>", "}"); + s = replace (s, "<ol>", "\n@itemize @bullet\n"); + s = replace (s, "</ol>", "\n@end itemize\n"); + s = replace (s, "<ul>", "\n@itemize @bullet\n"); + s = replace (s, "</ul>", "\n@end itemize\n"); + s = replace (s, "<li>", "\n@item\n"); + s = replace (s, "</li>", "\n"); + s = replace (s, "<p>", "\n\n"); + + s = replace (s, "<CODE>", "@code{"); + s = replace (s, "</CODE>", "}"); + s = replace (s, "<OL>", "\n@itemize @bullet\n"); + s = replace (s, "</OL>", "\n@end itemize\n"); + s = replace (s, "<UL>", "\n@itemize @bullet\n"); + s = replace (s, "</UL>", "\n@end itemize\n"); + s = replace (s, "<LI>", "\n@item\n"); + s = replace (s, "</LI>", "\n"); + s = replace (s, "<P>", "\n\n"); + + return s; + } + + private static void emitMethod (ClassDoc c, MethodDoc m) + { + outfile.print ("@deftypemethod " + c.typeName() + + " {" + m.modifiers() + + " " + m.returnType().typeName() + + "} " + m.name()); + + outfile.print (" ("); + Parameter p[] = m.parameters(); + boolean first = true; + + for (int i = 0; i < p.length; i++) + { + if (!first) + outfile.print (", "); + outfile.print (p[i].typeName() + + "@w{ }@var{" + + p[i].name() + + "}"); + first = false; + } + outfile.print (") "); + + ClassDoc exceptions[] = m.thrownExceptions(); + if (exceptions.length > 0) + { + outfile.print ("@*throws "); + first = true; + for (int i = 0; i < exceptions.length; i++) + { + if (!first) + outfile.print (", "); + outfile.print (exceptions[i].typeName()); + first = false; + } + } + outfile.println (""); + + outfile.println (texify (m.commentText())); + + outfile.println ("@end deftypemethod"); + } + + private static void emitClass (ClassDoc c) + { + MethodDoc[] methods = c.methods(); + for (int i = 0; i < methods.length; i++) + { + emitMethod (c, methods[i]); + } + } + + public static boolean start (RootDoc root) + { + String options[][] = root.options (); + + for (int i = 0; i < options.length; i++) + { + try + { + if (options[i][0].equals ("-outfile")) + { + outfile = new PrintStream (new FileOutputStream (options[i][1])); + } + } catch (java.io.IOException e) { + System.err.println ("Can't write to file " + options[i][1]); + return false; + } + } + + ClassDoc[] classes = root.classes(); + for (int i = 0; i < classes.length; i++) + { + emitClass (classes[i]); + } + return true; + } +} |