Gitiles
Code Review Sign In
git.eclipse.org / webtools / webtools.releng / 4982c8a2654013d7d27abec659e8d77c033c0a89 / . / org.eclipse.wtp.releng.versionchecker / doc / help-doc.html
blob: 7c3f3dc89cce6e1eccfb636918b77499c8ef5d64 [file] [log] [blame]
david_williamsedbc97e2008-07-23 04:11:42 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
david_williamsb23435a2008-07-23 05:02:46 +0000[diff] [blame]5<!-- Generated by javadoc (build 1.4.2_11) on Wed Jul 23 00:59:09 EDT 2008 -->
david_williamsedbc97e2008-07-23 04:11:42 +0000[diff] [blame]6<TITLE>
7API Help
8</TITLE>
9
10
11<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
12
13<SCRIPT type="text/javascript">
14function windowTitle()
15{
16 parent.document.title="API Help";
17}
18</SCRIPT>
19
20</HEAD>
21
22<BODY BGCOLOR="white" onload="windowTitle();">
23
david_williamsb23435a2008-07-23 05:02:46 +0000[diff] [blame]24
25<!-- ========= START OF TOP NAVBAR ======= -->
26<A NAME="navbar_top"><!-- --></A>
27<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
28<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
29<TR>
30<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
31<A NAME="navbar_top_firstrow"><!-- --></A>
32<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
33 <TR ALIGN="center" VALIGN="top">
34 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Package</FONT>&nbsp;</TD>
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Use</FONT>&nbsp;</TD>
37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="org/eclipse/wtp/releng/tools/versionchecker/package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Help</B></FONT>&nbsp;</TD>
41 </TR>
42</TABLE>
43</TD>
44<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
45</EM>
46</TD>
47</TR>
48
49<TR>
50<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
51&nbsp;PREV&nbsp;
52&nbsp;NEXT</FONT></TD>
53<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
54 <A HREF="index.html" target="_top"><B>FRAMES</B></A> &nbsp;
55&nbsp;<A HREF="help-doc.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
56&nbsp;<SCRIPT type="text/javascript">
57 <!--
58 if(window==top) {
59 document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>');
60 }
61 //-->
62</SCRIPT>
63<NOSCRIPT>
64 <A HREF="allclasses-noframe.html"><B>All Classes</B></A>
65</NOSCRIPT>
66
67</FONT></TD>
68</TR>
69</TABLE>
70<A NAME="skip-navbar_top"></A>
71<!-- ========= END OF TOP NAVBAR ========= -->
72
david_williamsedbc97e2008-07-23 04:11:42 +0000[diff] [blame]73<HR>
74<CENTER>
75<H1>
76How This API Document Is Organized</H1>
77</CENTER>
78This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.<H3>
79Package</H3>
80<BLOCKQUOTE>
81
82<P>
83Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:<UL>
84<LI>Interfaces (italic)<LI>Classes<LI>Exceptions<LI>Errors</UL>
85</BLOCKQUOTE>
86<H3>
87Class/Interface</H3>
88<BLOCKQUOTE>
89
90<P>
91Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:<UL>
92<LI>Class inheritance diagram<LI>Direct Subclasses<LI>All Known Subinterfaces<LI>All Known Implementing Classes<LI>Class/interface declaration<LI>Class/interface description
93<P>
94<LI>Nested Class Summary<LI>Field Summary<LI>Constructor Summary<LI>Method Summary
95<P>
96<LI>Field Detail<LI>Constructor Detail<LI>Method Detail</UL>
97Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.</BLOCKQUOTE>
98<H3>
david_williamsb23435a2008-07-23 05:02:46 +0000[diff] [blame]99Use</H3>
100<BLOCKQUOTE>
101Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.</BLOCKQUOTE>
102<H3>
103Tree (Class Hierarchy)</H3>
104<BLOCKQUOTE>
105There is a <A HREF="overview-tree.html">Class Hierarchy</A> page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with <code>java.lang.Object</code>. The interfaces do not inherit from <code>java.lang.Object</code>.<UL>
106<LI>When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.<LI>When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.</UL>
107</BLOCKQUOTE>
108<H3>
109Deprecated API</H3>
110<BLOCKQUOTE>
111The <A HREF="deprecated-list.html">Deprecated API</A> page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.</BLOCKQUOTE>
112<H3>
113Index</H3>
114<BLOCKQUOTE>
115The <A HREF="index-files/index-1.html">Index</A> contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.</BLOCKQUOTE>
116<H3>
david_williamsedbc97e2008-07-23 04:11:42 +0000[diff] [blame]117Prev/Next</H3>
118These links take you to the next or previous class, interface, package, or related page.<H3>
119Frames/No Frames</H3>
120These links show and hide the HTML frames. All pages are available with or without frames.
121<P>
122<H3>
123Serialized Form</H3>
124Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
125<P>
126<FONT SIZE="-1">
127<EM>
128This help file applies to API documentation generated using the standard doclet.</EM>
129</FONT>
130<BR>
131<HR>
132
david_williamsb23435a2008-07-23 05:02:46 +0000[diff] [blame]133
134<!-- ======= START OF BOTTOM NAVBAR ====== -->
135<A NAME="navbar_bottom"><!-- --></A>
136<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
137<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
138<TR>
139<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
140<A NAME="navbar_bottom_firstrow"><!-- --></A>
141<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
142 <TR ALIGN="center" VALIGN="top">
143 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Package</FONT>&nbsp;</TD>
144 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
145 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Use</FONT>&nbsp;</TD>
146 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="org/eclipse/wtp/releng/tools/versionchecker/package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
147 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
148 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
149 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Help</B></FONT>&nbsp;</TD>
150 </TR>
151</TABLE>
152</TD>
153<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
154</EM>
155</TD>
156</TR>
157
158<TR>
159<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
160&nbsp;PREV&nbsp;
161&nbsp;NEXT</FONT></TD>
162<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
163 <A HREF="index.html" target="_top"><B>FRAMES</B></A> &nbsp;
164&nbsp;<A HREF="help-doc.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
165&nbsp;<SCRIPT type="text/javascript">
166 <!--
167 if(window==top) {
168 document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>');
169 }
170 //-->
171</SCRIPT>
172<NOSCRIPT>
173 <A HREF="allclasses-noframe.html"><B>All Classes</B></A>
174</NOSCRIPT>
175
176</FONT></TD>
177</TR>
178</TABLE>
179<A NAME="skip-navbar_bottom"></A>
180<!-- ======== END OF BOTTOM NAVBAR ======= -->
181
david_williamsedbc97e2008-07-23 04:11:42 +0000[diff] [blame]182<HR>
183
184</BODY>
185</HTML>