概览 页面是此 API 文档的首页, 提供了所有程序包的列表及其概要。此页面也可能包含这些程序包的总体说明。
每个程序包都有一个页面, 其中包含它的类和接口的列表及其概要。此页面可以包含六个类别:
每个类, 接口, 嵌套类和嵌套接口都有各自的页面。其中每个页面都由三部分 (类/接口说明, 概要表, 以及详细的成员说明) 组成:
每个概要条目都包含该项目的详细说明的第一句。概要条目按字母顺序排列, 而详细说明则按其在源代码中出现的顺序排列。这样保持了程序员所建立的逻辑分组。
每个注释类型都有各自的页面, 其中包含以下部分:
每个枚举都有各自的页面, 其中包含以下部分:
每个已文档化的程序包, 类和接口都有各自的“使用”页面。此页面介绍了使用给定类或程序包的任何部分的程序包, 类, 方法, 构造器和字段。对于给定的类或接口 A, 其“使用”页面包含 A 的子类, 声明为 A 的字段, 返回 A 的方法, 以及带有类型为 A 的参数的方法和构造器。访问此页面的方法是: 首先转至程序包, 类或接口, 然后单击导航栏中的 "使用" 链接。
对于所有程序包, 有一个 类分层结构 页面, 以及每个程序包的分层结构。每个分层结构页面都包含类的列表和接口的列表。从 java.lang.Object
开始, 按继承结构对类进行排列。接口不从 java.lang.Object
继承。
已过时的 API 页面列出了所有已过时的 API。一般由于进行了改进并且通常提供了替代的 API, 所以建议不要使用已过时的 API。在将来的实现过程中, 可能会删除已过时的 API。
索引 包含按字母顺序排列的所有类, 接口, 构造器, 方法和字段的列表。
这些链接使您可以转至下一个或上一个类, 接口, 程序包或相关页面。
这些链接用于显示和隐藏 HTML 框架。所有页面均具有有框架和无框架两种显示方式。
所有类链接显示所有类和接口 (除了非静态嵌套类型)。
每个可序列化或可外部化的类都有其序列化字段和方法的说明。此信息对重新实现者有用, 而对使用 API 的开发者则没有什么用处。尽管导航栏中没有链接, 但您可以通过下列方式获取此信息: 转至任何序列化类, 然后单击类说明的 "另请参阅" 部分中的 "序列化表格"。
常量字段值页面列出了静态最终字段及其值。