概述页面是此 API 文档的首页,并提供所有包的列表以及每个包的摘要。此页面还可以包含对包集的总体描述。
每个包都有一个页面,其中包含其类和接口的列表,每个都有一个摘要。此页面可以包含六个类别:
每个类、接口、嵌套类和嵌套接口都有自己独立的页面。这些页面中的每一个都包含三个部分,包括类/接口描述、摘要表和详细的成员描述:
每个摘要条目都包含该项目详细描述中的第一句话。摘要条目按字母顺序排列,而详细描述则按照它们在源代码中出现的顺序排列。这保留了程序员建立的逻辑分组。
每种注释类型都有自己的单独页面,包含以下部分:
每个枚举都有自己的单独页面,包含以下部分:
每个文档化的包、类和接口都有自己的使用页面。本页描述了哪些包、类、方法、构造函数和字段使用给定类或包的任何部分。给定一个类或接口 A,它的 Use 页面包括 A 的子类、声明为 A 的字段、返回 A 的方法以及参数类型为 A 的方法和构造函数。您可以通过首先转到包、类或接口来访问此页面,然后单击导航栏中的“使用”链接。
There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object
. The interfaces do not inherit from java.lang.Object
.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
These links take you to the next or previous class, interface, package, or related page.
These links show and hide the HTML frames. All pages are available with or without frames.
The All Classes link shows all classes and interfaces except non-static nested types.
每个可序列化或可外部化的类都有其序列化字段和方法的描述。此信息对重新实现者感兴趣,而不是对使用 API 的开发人员感兴趣。虽然导航栏中没有链接,但您可以通过转到任何序列化类并单击类描述的“另见”部分中的“序列化表单”来获取此信息。
常量字段值页面列出了静态最终字段及其值。
版权所有 © 2002–2022 Apache 软件基金会。版权所有。