You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<h1class="title">How This API Document Is Organized</h1>
73
98
<divclass="subTitle">This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.</div>
74
99
</div>
75
100
<divclass="contentContainer">
76
101
<ulclass="blockList">
77
102
<liclass="blockList">
103
+
<section>
78
104
<h2>Overview</h2>
79
-
<p>The <ahref="overview-summary.html">Overview</a> page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.</p>
105
+
<p>The <ahref="index.html">Overview</a> page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.</p>
106
+
</section>
80
107
</li>
81
108
<liclass="blockList">
109
+
<section>
82
110
<h2>Package</h2>
83
-
<p>Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:</p>
111
+
<p>Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain six categories:</p>
84
112
<ul>
85
-
<li>Interfaces (italic)</li>
113
+
<li>Interfaces</li>
86
114
<li>Classes</li>
87
115
<li>Enums</li>
88
116
<li>Exceptions</li>
89
117
<li>Errors</li>
90
118
<li>Annotation Types</li>
91
119
</ul>
120
+
</section>
92
121
</li>
93
122
<liclass="blockList">
94
-
<h2>Class/Interface</h2>
123
+
<section>
124
+
<h2>Class or Interface</h2>
95
125
<p>Each 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:</p>
96
126
<ul>
97
-
<li>Class inheritance diagram</li>
127
+
<li>Class Inheritance Diagram</li>
98
128
<li>Direct Subclasses</li>
99
129
<li>All Known Subinterfaces</li>
100
130
<li>All Known Implementing Classes</li>
101
-
<li>Class/interface declaration</li>
102
-
<li>Class/interface description</li>
131
+
<li>Class or Interface Declaration</li>
132
+
<li>Class or Interface Description</li>
103
133
</ul>
134
+
<br>
104
135
<ul>
105
136
<li>Nested Class Summary</li>
106
137
<li>Field Summary</li>
138
+
<li>Property Summary</li>
107
139
<li>Constructor Summary</li>
108
140
<li>Method Summary</li>
109
141
</ul>
142
+
<br>
110
143
<ul>
111
144
<li>Field Detail</li>
145
+
<li>Property Detail</li>
112
146
<li>Constructor Detail</li>
113
147
<li>Method Detail</li>
114
148
</ul>
115
149
<p>Each 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.</p>
150
+
</section>
116
151
</li>
117
152
<liclass="blockList">
153
+
<section>
118
154
<h2>Annotation Type</h2>
119
155
<p>Each annotation type has its own separate page with the following sections:</p>
120
156
<ul>
121
-
<li>Annotation Type declaration</li>
122
-
<li>Annotation Type description</li>
157
+
<li>Annotation Type Declaration</li>
158
+
<li>Annotation Type Description</li>
123
159
<li>Required Element Summary</li>
124
160
<li>Optional Element Summary</li>
125
161
<li>Element Detail</li>
126
162
</ul>
163
+
</section>
127
164
</li>
128
165
<liclass="blockList">
166
+
<section>
129
167
<h2>Enum</h2>
130
168
<p>Each enum has its own separate page with the following sections:</p>
131
169
<ul>
132
-
<li>Enum declaration</li>
133
-
<li>Enum description</li>
170
+
<li>Enum Declaration</li>
171
+
<li>Enum Description</li>
134
172
<li>Enum Constant Summary</li>
135
173
<li>Enum Constant Detail</li>
136
174
</ul>
175
+
</section>
137
176
</li>
138
177
<liclass="blockList">
178
+
<section>
139
179
<h2>Tree (Class Hierarchy)</h2>
140
-
<p>There is a <ahref="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>.</p>
180
+
<p>There is a <ahref="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. Classes are organized by inheritance structure starting with <code>java.lang.Object</code>. Interfaces do not inherit from <code>java.lang.Object</code>.</p>
141
181
<ul>
142
182
<li>When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.</li>
143
-
<li>When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.</li>
183
+
<li>When viewing a particular package, class or interface page, clicking on "Tree" displays the hierarchy for only that package.</li>
144
184
</ul>
185
+
</section>
145
186
</li>
146
187
<liclass="blockList">
188
+
<section>
147
189
<h2>Deprecated API</h2>
148
190
<p>The <ahref="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.</p>
191
+
</section>
149
192
</li>
150
193
<liclass="blockList">
194
+
<section>
151
195
<h2>Index</h2>
152
-
<p>The <ahref="index-files/index-1.html">Index</a> contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.</p>
196
+
<p>The <ahref="index-files/index-1.html">Index</a> contains an alphabetic index of all classes, interfaces, constructors, methods, and fields, as well as lists of all packages and all classes.</p>
197
+
</section>
153
198
</li>
154
199
<liclass="blockList">
155
-
<h2>Prev/Next</h2>
156
-
<p>These links take you to the next or previous class, interface, package, or related page.</p>
157
-
</li>
158
-
<liclass="blockList">
159
-
<h2>Frames/No Frames</h2>
160
-
<p>These links show and hide the HTML frames. All pages are available with or without frames.</p>
161
-
</li>
162
-
<liclass="blockList">
163
-
<h2>All Classes</h2>
164
-
<p>The <ahref="allclasses-noframe.html">All Classes</a> link shows all classes and interfaces except non-static nested types.</p>
200
+
<section>
201
+
<h2>All Classes</h2>
202
+
<p>The <ahref="allclasses.html">All Classes</a> link shows all classes and interfaces except non-static nested types.</p>
203
+
</section>
165
204
</li>
166
205
<liclass="blockList">
206
+
<section>
167
207
<h2>Serialized Form</h2>
168
208
<p>Each 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.</p>
209
+
</section>
169
210
</li>
170
211
<liclass="blockList">
212
+
<section>
171
213
<h2>Constant Field Values</h2>
172
214
<p>The <ahref="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.</p>
215
+
</section>
216
+
</li>
217
+
<liclass="blockList">
218
+
<section>
219
+
<h2>Search</h2>
220
+
<p>You can search for definitions of modules, packages, types, fields, methods and other terms defined in the API, using some or all of the name. "Camel-case" abbreviations are supported: for example, "InpStr" will find "InputStream" and "InputStreamReader".</p>
221
+
</section>
173
222
</li>
174
223
</ul>
175
-
<spanclass="emphasizedPhrase">This help file applies to API documentation generated using the standard doclet.</span></div>
224
+
<hr>
225
+
<spanclass="emphasizedPhrase">This help file applies to API documentation generated by the standard doclet.</span></div>
0 commit comments