本 API 文件的組織方式
-
概述
The 概述 頁面是本 API 文件的首頁,提供了所有包的列表以及每個包的摘要。此頁面還可以包含一組包的總體描述。
-
包
每個包都有一個頁面,其中包含其類和介面的列表以及每個專案的摘要。這些頁面可能包含六個類別:
- 介面
- 類
- 列舉
- 異常
- 錯誤
- 註解型別
-
類或介面
每個類、介面、巢狀類和巢狀介面都有其獨立的頁面。每個此類頁面都包含三個部分:類/介面描述、摘要表和詳細成員描述。
- 類繼承圖
- 直接子類
- 所有已知子介面
- 所有已知實現類
- 類或介面宣告
- 類或介面描述
- 巢狀類摘要
- 欄位摘要
- 屬性摘要
- 構造方法摘要
- 方法摘要
- 欄位詳情
- 屬性詳情
- 構造方法詳情
- 方法詳情
每個摘要條目包含該專案的詳細描述中的第一句話。摘要條目按字母順序排列,而詳細描述按其在原始碼中出現的順序排列。這保留了程式設計師建立的邏輯分組。
-
註解型別
每種註解型別都有其獨立的頁面,包含以下部分:
- 註解型別宣告
- 註解型別描述
- 必需元素摘要
- 可選元素摘要
- 元素詳情
-
列舉
每種列舉都有其獨立的頁面,包含以下部分:
- 列舉宣告
- 列舉描述
- 列舉常量摘要
- 列舉常量詳情
-
樹狀圖(類層次結構)
有一個 類層次結構 頁面,其中列出了所有包的層次結構,以及每個包的層次結構。每個層次結構頁面都包含類列表和介面列表。類按照繼承結構組織,從
java.lang.Object開始。介面不繼承自java.lang.Object。- 當檢視概述頁面時,點選“樹狀圖”會顯示所有包的層次結構。
- 當檢視特定包、類或介面頁面時,點選“樹狀圖”會僅顯示該包的層次結構。
-
已棄用 API
The 已棄用 API 頁面列出了所有已棄用的 API。已棄用的 API 通常由於已有改進而不建議使用,並且通常會提供替代 API。已棄用的 API 可能會在未來的實現中移除。
-
索引
The 索引 包含所有類、介面、構造方法、方法和欄位的字母索引,以及所有包和所有類的列表。
-
所有 類
The 所有類 連結顯示所有類和介面,但不包括非靜態巢狀型別。
-
序列化形式
每個可序列化或可外部化的類都有其序列化欄位和方法的描述。此資訊對於重新實現者有用,而不是使用此 API 的開發者。雖然導航欄中沒有連結,但您可以透過轉到任何序列化類,並在其類描述的“另請參閱”部分點選“序列化形式”來獲取此資訊。
-
常量欄位值
The 常量欄位值 頁面列出了靜態 final 欄位及其值。
-
搜尋
您可以使用部分或全部名稱搜尋 API 中定義的模組、包、型別、欄位、方法及其他術語的定義。支援“駝峰命名法”縮寫:例如,“InpStr”將找到“InputStream”和“InputStreamReader”。
本幫助檔案適用於標準 doclet 生成的 API 文件。