概览页面是 API 文档的首页,并提供所有软件包的列表以及每个软件包的摘要。此页面还可能包含对软件包的一般性描述。
每个软件包都有一页,其中包含其类和接口的列表以及每个摘要。此页面可能包含六类:
每个类、接口、嵌套类和嵌套接口有自己的独立页面。每个此类页面都有三个部分,包括类/接口描述、摘要表和详细成员描述。
每个摘要条目都包含该项详细描述中的第一句话。摘要条目是按字母顺序排列的,而详细描述的顺序则按其在源代码中的出现顺序排列。这保留了程序员建立的逻辑分组。
每个注释类型有自己的独立页面,包含以下部分:
每个枚举有自己的独立页面,包含以下部分:
有适用于所有软件包的类层次页面,另有适用于每个软件包的层次。每个层次页面都包含类列表和接口列表。这些类按继承结构组织,从java.lang.Object
开始。这些接口没有从java.lang.Object
继承。
已弃用的 API页面列出所有已弃用的 API。通常由于做了改进,所以不建议使用已弃用的 API,并且通常会提供替代 API。已弃用的 API 可能在未来实施中删除。
索引包含所有类、接口、构造函数、方法和字段的按字母顺序排列的列表。
这些链接可带您转到下一页或前一页的类、接口、软件包或相关页面。
这些链接显示和隐藏 HTML 框架。所有页面都可使用或不使用框架。
所有类链接显示除非静态嵌套类之外的所有类和接口。
每个可序列化或可外在化的类都要对其序列化字段和方法进行描述。这些信息对于重新实现者非常有用,而 API 使用者则可以不用理会。虽然导航栏中没有这个链接,但是你可以在进入任意序列化的类之后,单击类描述中的“查看”部分的“序列化形式”按钮来获取这些信息。
常量字段值 页面列出了静态 final 字段及其值。