此 API 文档的组织方式

• 导航栏:
  • 搜索
• 页面:
  • 概览
  • 程序包
  • 类或接口
  • Other Files
  • 使用
  • 树 (类分层结构)
  • 已过时的 API
  • 常量字段值
  • 序列化表格
  • 所有程序包
  • 所有类和接口
  • 索引

导航栏

Starting from the 概览 page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The 索引 and Search box allow you to navigate to specific declarations and summary pages, including: 所有程序包, 所有类和接口

搜索

可以使用部分或完整名称搜索模块、程序包、类型、字段、方法、系统属性以及 API 中定义的其他术语的定义，（可选）也可以使用“驼峰大小写式”缩写进行搜索。例如：

• j.l.obj 将与 "java.lang.Object" 相匹配
• InpStr 将与 "java.io.InputStream" 相匹配
• HM.cK 将与 "java.util.HashMap.containsKey(Object)" 相匹配

有关搜索功能的完整说明，请参阅 Javadoc 搜索规范。

页面

The following sections describe the different kinds of pages in this collection.

概览

概览 页面是此 API 文档的首页, 提供了所有程序包的列表及其概要。此页面也可能包含这些程序包的总体说明。

程序包

每个程序包都有一页，其中包含它的类和接口的列表及其概要。这些页可以包含六个类别：

• 接口
• 类
• 枚举
• 异常错误
• 错误
• 注释类型

类或接口

每个类, 接口, 嵌套类和嵌套接口都有各自的页面。其中每个页面都由三部分 (类/接口说明, 概要表, 以及详细的成员说明) 组成:

• 类继承图
• 直接子类
• 所有已知子接口
• 所有已知实现类
• 类或接口声明
• 类或接口说明

• 嵌套类概要
• 枚举常量概要
• 字段概要
• 属性概要
• 构造器概要
• 方法概要
• 必需元素概要
• 可选元素概要

• 枚举常量详细资料
• 字段详细资料
• 属性详细资料
• 构造器详细资料
• 方法详细资料
• 元素详细资料

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.

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.

Other Files

Packages and modules may contain pages with additional information related to the declarations nearby.

使用

每个已文档化的程序包、类和接口都有各自的“使用”页。此页介绍了使用给定类或程序包的任何部分的程序包、类、方法、构造器和字段。对于给定的类或接口 A，其“使用”页包含 A 的子类、声明为 A 的字段、返回 A 的方法以及带有类型为 A 的参数的方法和构造器。访问此页的方法是：首先转至程序包、类或接口，然后单击导航栏中的“使用”链接。

树 (类分层结构)

对于所有程序包，都有一个 类分层结构 页，以及每个程序包的分层结构。每个分层结构页都包含类的列表和接口的列表。从 java.lang.Object 开始，按继承结构对类进行排列。接口不从 java.lang.Object 继承。

• 查看“概览”页面时, 单击 "树" 将显示所有程序包的分层结构。
• 查看特定程序包、类或接口页时，单击“树”将仅显示该程序包的分层结构。

已过时的 API

已过时的 API 页面列出了所有已过时的 API。通常，由于已过时的 API 存在缺点并且已提供替代 API，不建议使用已过时的 API。在将来的实施中，可能会删除已过时的 API。

常量字段值

常量字段值页面列出了静态最终字段及其值。

序列化表格

每个可序列化或可外部化的类都有其序列化字段和方法的说明。此信息对实施（而非使用）API 的人员有用。尽管导航栏中没有链接，但您可以通过下列方式获取此信息：转至任何序列化类，然后单击类说明的“另请参阅”部分中的“序列化形式”。

所有程序包

The 所有程序包 page contains an alphabetic index of all packages contained in the documentation.

所有类和接口

The 所有类和接口 page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.

索引

索引 包含所有类、接口、构造器、方法和字段的按字母顺序排列的索引，以及所有程序包和所有类的列表。

此帮助文件适用于由标准 doclet 生成的 API 文档。