本 API 文档的组织方式
-
概述
The 概述 页面是本 API 文档的首页，提供了所有包的列表以及每个包的摘要。此页面还可以包含一组包的总体描述。
-
包
每个包都有一个页面，其中包含其类和接口的列表以及每个项目的摘要。这些页面可能包含六个类别：
- 接口
- 类
- 枚举
- 异常
- 错误
- 注解类型
-
类或接口
每个类、接口、嵌套类和嵌套接口都有其独立的页面。每个此类页面都包含三个部分：类/接口描述、摘要表和详细成员描述。
- 类继承图
- 直接子类
- 所有已知子接口
- 所有已知实现类
- 类或接口声明
- 类或接口描述
- 嵌套类摘要
- 字段摘要
- 属性摘要
- 构造方法摘要
- 方法摘要
- 字段详情
- 属性详情
- 构造方法详情
- 方法详情
每个摘要条目包含该项目的详细描述中的第一句话。摘要条目按字母顺序排列，而详细描述按其在源代码中出现的顺序排列。这保留了程序员建立的逻辑分组。
-
注解类型
每种注解类型都有其独立的页面，包含以下部分：
- 注解类型声明
- 注解类型描述
- 必需元素摘要
- 可选元素摘要
- 元素详情
-
枚举
每种枚举都有其独立的页面，包含以下部分：
- 枚举声明
- 枚举描述
- 枚举常量摘要
- 枚举常量详情
-
树状图（类层次结构）
有一个 类层次结构 页面，其中列出了所有包的层次结构，以及每个包的层次结构。每个层次结构页面都包含类列表和接口列表。类按照继承结构组织，从
java.lang.Object开始。接口不继承自java.lang.Object。- 当查看概述页面时，点击“树状图”会显示所有包的层次结构。
- 当查看特定包、类或接口页面时，点击“树状图”会仅显示该包的层次结构。
-
已弃用 API
The 已弃用 API 页面列出了所有已弃用的 API。已弃用的 API 通常由于已有改进而不建议使用，并且通常会提供替代 API。已弃用的 API 可能会在未来的实现中移除。
-
索引
The 索引 包含所有类、接口、构造方法、方法和字段的字母索引，以及所有包和所有类的列表。
-
所有 类
The 所有类 链接显示所有类和接口，但不包括非静态嵌套类型。
-
序列化形式
每个可序列化或可外部化的类都有其序列化字段和方法的描述。此信息对于重新实现者有用，而不是使用此 API 的开发者。虽然导航栏中没有链接，但您可以通过转到任何序列化类，并在其类描述的“另请参阅”部分点击“序列化形式”来获取此信息。
-
常量字段值
The 常量字段值 页面列出了静态 final 字段及其值。
-
搜索
您可以使用部分或全部名称搜索 API 中定义的模块、包、类型、字段、方法及其他术语的定义。支持“驼峰命名法”缩写：例如，“InpStr”将找到“InputStream”和“InputStreamReader”。
本帮助文件适用于标准 doclet 生成的 API 文档。