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
<li><ahref="#all-classes">All Classes and Interfaces</a></li>
77
-
<li><ahref="#index">Index</a></li>
78
-
</ul>
79
-
</li>
80
-
</ul>
81
-
<hr>
82
-
<divclass="sub-title">
83
-
<h2id="help-navigation">Navigation</h2>
84
-
Starting from the <ahref="index.html">Overview</a> page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The <ahref="index-all.html">Index</a> and Search box allow you to navigate to specific declarations and summary pages, including: <ahref="allpackages-index.html">All Packages</a>, <ahref="allclasses-index.html">All Classes and Interfaces</a>
85
-
<sectionclass="help-section" id="help-search">
86
-
<h3>Search</h3>
87
-
<p>You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API, using some or all of the name, optionally using "camelCase" abbreviations. For example:</p>
88
-
<ulclass="help-section-list">
89
-
<li><code>j.l.obj</code> will match "java.lang.Object"</li>
90
-
<li><code>InpStr</code> will match "java.io.InputStream"</li>
91
-
<li><code>HM.cK</code> will match "java.util.HashMap.containsKey(Object)"</li>
92
-
</ul>
93
-
<p>Refer to the <ahref="https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/javadoc-search-spec.html">Javadoc Search Specification</a> for a full description of search features.</p>
94
-
</section>
54
+
<divclass="header">
55
+
<h1class="title">How This API Document Is Organized</h1>
56
+
<divclass="sub-title">This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.</div>
95
57
</div>
96
-
<hr>
97
-
<divclass="sub-title">
98
-
<h2id="help-pages">Kinds of Pages</h2>
99
-
The following sections describe the different kinds of pages in this collection.
100
-
<sectionclass="help-section" id="overview">
101
-
<h3>Overview</h3>
58
+
<sectionclass="help-section">
59
+
<h2>Overview</h2>
102
60
<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>
103
61
</section>
104
-
<sectionclass="help-section"id="package">
105
-
<h3>Package</h3>
106
-
<p>Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:</p>
62
+
<sectionclass="help-section">
63
+
<h2>Package</h2>
64
+
<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>
107
65
<ulclass="help-section-list">
108
66
<li>Interfaces</li>
109
67
<li>Classes</li>
@@ -113,9 +71,9 @@ <h3>Package</h3>
113
71
<li>Annotation Interfaces</li>
114
72
</ul>
115
73
</section>
116
-
<sectionclass="help-section"id="class">
117
-
<h3>Class or Interface</h3>
118
-
<p>Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.</p>
74
+
<sectionclass="help-section">
75
+
<h2>Class or Interface</h2>
76
+
<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>
119
77
<ulclass="help-section-list">
120
78
<li>Class Inheritance Diagram</li>
121
79
<li>Direct Subclasses</li>
@@ -127,63 +85,75 @@ <h3>Class or Interface</h3>
127
85
<br>
128
86
<ulclass="help-section-list">
129
87
<li>Nested Class Summary</li>
130
-
<li>Enum Constant Summary</li>
131
88
<li>Field Summary</li>
132
89
<li>Property Summary</li>
133
90
<li>Constructor Summary</li>
134
91
<li>Method Summary</li>
135
-
<li>Required Element Summary</li>
136
-
<li>Optional Element Summary</li>
137
92
</ul>
138
93
<br>
139
94
<ulclass="help-section-list">
140
-
<li>Enum Constant Details</li>
141
95
<li>Field Details</li>
142
96
<li>Property Details</li>
143
97
<li>Constructor Details</li>
144
98
<li>Method Details</li>
145
-
<li>Element Details</li>
146
99
</ul>
147
-
<p><spanclass="help-note">Note:</span> Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.</p>
148
100
<p>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>
149
101
</section>
150
-
<sectionclass="help-section" id="doc-file">
151
-
<h3>Other Files</h3>
152
-
<p>Packages and modules may contain pages with additional information related to the declarations nearby.</p>
102
+
<sectionclass="help-section">
103
+
<h2>Annotation Interface</h2>
104
+
<p>Each annotation interface has its own separate page with the following sections:</p>
105
+
<ulclass="help-section-list">
106
+
<li>Annotation Interface Declaration</li>
107
+
<li>Annotation Interface Description</li>
108
+
<li>Required Element Summary</li>
109
+
<li>Optional Element Summary</li>
110
+
<li>Element Details</li>
111
+
</ul>
112
+
</section>
113
+
<sectionclass="help-section">
114
+
<h2>Enum Class</h2>
115
+
<p>Each enum class has its own separate page with the following sections:</p>
116
+
<ulclass="help-section-list">
117
+
<li>Enum Declaration</li>
118
+
<li>Enum Description</li>
119
+
<li>Enum Constant Summary</li>
120
+
<li>Enum Constant Details</li>
121
+
</ul>
153
122
</section>
154
-
<sectionclass="help-section"id="use">
155
-
<h3>Use</h3>
156
-
<p>Each 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.</p>
123
+
<sectionclass="help-section">
124
+
<h2>Use</h2>
125
+
<p>Each 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.</p>
157
126
</section>
158
-
<sectionclass="help-section"id="tree">
159
-
<h3>Tree (Class Hierarchy)</h3>
127
+
<sectionclass="help-section">
128
+
<h2>Tree (Class Hierarchy)</h2>
160
129
<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>
161
130
<ulclass="help-section-list">
162
-
<li>When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.</li>
163
-
<li>When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.</li>
131
+
<li>When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.</li>
132
+
<li>When viewing a particular package, class or interface page, clicking on "Tree" displays the hierarchy for only that package.</li>
164
133
</ul>
165
134
</section>
166
-
<sectionclass="help-section"id="constant-values">
167
-
<h3>Constant Field Values</h3>
168
-
<p>The <ahref="constant-values.html">Constant Field Values</a>page lists the static final fieldsand their values.</p>
135
+
<sectionclass="help-section">
136
+
<h2>Index</h2>
137
+
<p>The <ahref="index-all.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>
169
138
</section>
170
-
<sectionclass="help-section"id="serialized-form">
171
-
<h3>Serialized Form</h3>
139
+
<sectionclass="help-section">
140
+
<h2>Serialized Form</h2>
172
141
<p>Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to those who implement rather than use 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>
173
142
</section>
174
-
<sectionclass="help-section" id="all-packages">
175
-
<h3>All Packages</h3>
176
-
<p>The <ahref="allpackages-index.html">All Packages</a> page contains an alphabetic index of all packages contained in the documentation.</p>
177
-
</section>
178
-
<sectionclass="help-section" id="all-classes">
179
-
<h3>All Classes and Interfaces</h3>
180
-
<p>The <ahref="allclasses-index.html">All Classes and Interfaces</a> page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.</p>
143
+
<sectionclass="help-section">
144
+
<h2>Constant Field Values</h2>
145
+
<p>The <ahref="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.</p>
181
146
</section>
182
-
<sectionclass="help-section" id="index">
183
-
<h3>Index</h3>
184
-
<p>The <ahref="index-all.html">Index</a> contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as <ahref="allpackages-index.html">All Packages</a>, <ahref="allclasses-index.html">All Classes and Interfaces</a>.</p>
147
+
<sectionclass="help-section">
148
+
<h2>Search</h2>
149
+
<p>You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API, using some or all of the name, optionally using "camel-case" abbreviations. For example:</p>
150
+
<ulclass="help-section-list">
151
+
<li><code>j.l.obj</code> will match "java.lang.Object"</li>
152
+
<li><code>InpStr</code> will match "java.io.InputStream"</li>
153
+
<li><code>HM.cK</code> will match "java.util.HashMap.containsKey(Object)"</li>
154
+
</ul>
155
+
<p>Refer to <ahref="https://docs.oracle.com/en/java/javase/16/docs/specs/javadoc/javadoc-search-spec.html">the Javadoc Search Specification</a> for a full description of search features.</p>
185
156
</section>
186
-
</div>
187
157
<hr>
188
158
<spanclass="help-footnote">This help file applies to API documentation generated by the standard doclet.</span></main>
0 commit comments