86 |
Navigation
87 | Starting from the
Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The
Index and Search box allow you to navigate to specific declarations and summary pages, including:
All Packages,
All Classes and Interfaces
88 |
89 | Search
90 | 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:
91 |
92 | j.l.obj
will match "java.lang.Object"
93 | InpStr
will match "java.io.InputStream"
94 | HM.cK
will match "java.util.HashMap.containsKey(Object)"
95 |
96 | Refer to the Javadoc Search Specification for a full description of search features.
97 |
98 |
99 |
101 |
Kinds of Pages
102 | The following sections describe the different kinds of pages in this collection.
103 |
104 | Package
105 | 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:
106 |
107 | - Interfaces
108 | - Classes
109 | - Enum Classes
110 | - Exception Classes
111 | - Annotation Interfaces
112 |
113 |
114 |
115 | Class or Interface
116 | 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.
117 |
118 | - Class Inheritance Diagram
119 | - Direct Subclasses
120 | - All Known Subinterfaces
121 | - All Known Implementing Classes
122 | - Class or Interface Declaration
123 | - Class or Interface Description
124 |
125 |
126 |
127 | - Nested Class Summary
128 | - Enum Constant Summary
129 | - Field Summary
130 | - Property Summary
131 | - Constructor Summary
132 | - Method Summary
133 | - Required Element Summary
134 | - Optional Element Summary
135 |
136 |
137 |
138 | - Enum Constant Details
139 | - Field Details
140 | - Property Details
141 | - Constructor Details
142 | - Method Details
143 | - Element Details
144 |
145 | Note: 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.
146 | 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.
147 |
148 |
149 | Other Files
150 | Packages and modules may contain pages with additional information related to the declarations nearby.
151 |
152 |
153 | Tree (Class Hierarchy)
154 | There is a Class Hierarchy 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 java.lang.Object
. Interfaces do not inherit from java.lang.Object
.
155 |
156 | - When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
157 | - When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
158 |
159 |
160 |
161 | All Packages
162 | The All Packages page contains an alphabetic index of all packages contained in the documentation.
163 |
164 |
165 | All Classes and Interfaces
166 | The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.
167 |
168 |
169 | Index
170 | The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as All Packages, All Classes and Interfaces.
171 |
172 |
173 |