本 API 文档的组织方式

概述

概述页面是本 API 文档的首页，提供了所有包的列表，并附有每个包的摘要。此页面还可以包含对这组包的整体描述。

包

每个包都有一个页面，其中包含其类和接口的列表，并附有每个的摘要。此页面可以包含六个类别

• 接口（斜体）
• 类
• 枚举
• 异常
• 错误
• 注解类型

类/接口

每个类、接口、嵌套类和嵌套接口都有自己的独立页面。这些页面都包含三个部分：类/接口描述、摘要表和详细成员描述

• 类继承图
• 直接子类
• 所有已知子接口
• 所有已知实现类
• 类/接口声明
• 类/接口描述

• 嵌套类摘要
• 字段摘要
• 构造函数摘要
• 方法摘要

• 字段详情
• 构造函数详情
• 方法详情

每个摘要条目包含该项详细描述的第一句话。摘要条目按字母顺序排列，而详细描述按它们在源代码中出现的顺序排列。这保留了程序员建立的逻辑分组。

注解类型

每个注解类型都有自己的独立页面，包含以下部分

• 注解类型声明
• 注解类型描述
• 必需元素摘要
• 可选元素摘要
• 元素详情

枚举

每个枚举都有自己的独立页面，包含以下部分

• 枚举声明
• 枚举描述
• 枚举常量摘要
• 枚举常量详情

已废弃的 API

已废弃的 API 页面列出了所有已废弃的 API。已废弃的 API 不建议使用，通常是因为有改进，并且通常会提供替代的 API。已废弃的 API 可能会在未来的实现中移除。

索引

索引包含所有类、接口、构造函数、方法和字段的字母顺序列表。

框架/无框架

这些链接显示和隐藏 HTML 框架。所有页面均可带框架或不带框架显示。

所有类

所有类链接显示所有类和接口，但不包括非静态嵌套类型。

序列化形式

每个可序列化或可外部化的类都对其序列化字段和方法进行了描述。此信息对重新实现者感兴趣，而不是对使用 API 的开发人员感兴趣。虽然导航栏中没有链接，但您可以通过转到任何序列化的类并单击类描述的“另请参阅”部分中的“序列化形式”来获取此信息。

常量字段值

常量字段值页面列出了静态 final 字段及其值。