本 API 文档的组织方式
-
概览
该 Overview 页面是此 API 文档的首页，提供所有包的列表以及每个包的摘要。此页面也可以包含对这些包集合的总体描述。
-
包
每个包都有一个页面，包含其类和接口的列表，并为每一项提供摘要。这些页面可能包含六类：
- 接口
- 类
- 枚举
- 异常
- 错误
- 注释类型
-
类或接口
每个类、接口、嵌套类和嵌套接口都有各自独立的页面。每个这样的页面包含三部分：类/接口描述、摘要表和详细的成员描述：
- 类继承图
- 直接子类
- 所有已知子接口
- 所有已知的实现类
- Class or Interface Declaration
- Class or Interface Description
- 嵌套类摘要
- 字段摘要
- 属性摘要
- 构造函数摘要
- 方法摘要
- 字段详情
- 属性详情
- 构造函数详细信息
- 方法详情
每个摘要条目包含该项目详细描述的第一句。摘要条目按字母顺序排列，而详细描述按它们在源代码中出现的顺序排列。这保留了程序员建立的逻辑分组。
-
注释类型
每种注释类型都有其独立的页面，包含以下部分：
- 注解类型声明
- 注释类型描述
- 必需元素摘要
- 可选元素摘要
- 元素详情
-
枚举
每个枚举都有自己的独立页面，包含以下部分：
- 枚举声明
- 枚举描述
- 枚举常量摘要
- 枚举常量详细信息
-
使用
每个有文档的包、类和接口都有其各自的“使用”页面。该页面描述了哪些包、类、方法、构造函数和字段使用了给定类或包的任何部分。对于给定的类或接口 A，其“使用”页面包括 A 的子类、声明为 A 的字段、返回 A 的方法，以及参数类型为 A 的方法和构造函数。你可以先进入该包、类或接口，然后在导航栏中点击“使用”链接来访问此页面。
-
树（类层次结构）
有一个用于所有包的 Class Hierarchy 页面，并且每个包都有一个层次结构页面。每个层次结构页面包含类列表和接口列表。类按继承结构组织，从
java.lang.Object开始。接口不继承自java.lang.Object。- 在查看 Overview 页面时，单击 "Tree" 会显示所有包的层次结构。
- 当查看某个特定的包、类或接口页面时，单击“Tree”仅显示该包的层次结构。
-
已弃用 API
该 Deprecated API 页面列出了所有已被弃用的 API。已弃用的 API 不建议使用，通常是因为已有改进，且通常会给出替代的 API。已弃用的 API 可能在未来的实现中被移除。
-
索引
该 Index 包含所有类、接口、构造函数、方法和字段的按字母顺序索引，以及所有包和所有类的列表。
-
所有类
All Classes 链接显示所有类和接口，除了非静态嵌套类型。
-
序列化形式
每个可序列化或可外部化的类都有其序列化字段和方法的描述。此信息对于重新实现者来说是有价值的，而对于使用 API 的开发者则不是。尽管导航栏中没有链接，但你可以通过转到任意已序列化的类，并在该类描述的“另请参阅”部分点击 "Serialized Form" 来查看这些信息。
-
常量字段值
该Constant Field Values页面列出了 static final 字段及其值。
-
搜索
您可以搜索 API 中定义的模块、包、类型、字段、方法和其他术语的定义，使用完整或部分名称。 "Camel-case" 缩写受支持：例如，"InpStr" 将找到 "InputStream" 和 "InputStreamReader"。
此帮助文件适用于由标准 doclet 生成的 API 文档。