此 API 文檔的組織方式

此 API（應用程序程式介面）文檔包含對應於導航欄中的項目的頁面，如下所述。

概觀

概觀 頁面是此 API 文檔的首頁，提供了所有軟體套件的列表及其摘要。此頁面也可能包含這些軟體套件的總體描述。

軟體套件

每個軟體套件都有一個頁面，其中包含它的類別和介面的列表及其摘要。此頁面可以包含四個類別別：

• 介面（斜體）
• 類別
• 列舉
• 異常
• 錯誤
• 註釋型別

類別/介面

每個類別、介面、巢狀類別和巢狀介面都有各自的頁面。其中每個頁面都由三部分（類別/介面描述、摘要表，以及詳細的成員描述）組成：

• 類別繼承圖
• 直接子類別
• 所有已知子介面
• 所有已知實作類別
• 類別/介面宣告
• 類別/介面描述

• 巢狀類別摘要
• 欄位摘要
• 建構子摘要
• 方法摘要

• 欄位詳細資訊
• 建構子詳細資訊
• 方法詳細資訊

每個摘要條目都包含該項目的詳細描述的第一句。摘要條目按字母順序排列，而詳細描述則按其在源程式碼中出現的順序排列。這樣保持了開發人員所建立的邏輯分組。

註釋型別

每個註釋型別都有各自的頁面，其中包含以下部分：

• 註釋型別宣告
• 註釋型別描述
• 必需元素摘要
• 可選元素摘要
• 元素詳細資訊

列舉

每個列舉都有各自的頁面，其中包含以下部分：

• 列舉宣告
• 列舉描述
• 列舉常數摘要
• 列舉常數詳細資訊

使用

每個已文檔化的軟體套件、類別和介面都有各自的「使用」頁面。此頁面介紹了使用給定類別或軟體套件的任何部分的軟體套件、類別、方法、建構子和欄位。對於給定的類別或介面 A，其「使用」頁面包含 A 的子類別、宣告為 A 的欄位、返回 A 的方法，以及帶有型別為 A 的參數的方法和建構子。存取此頁面的方法是：首先轉至軟體套件、類別或介面，然後單擊導航欄中的「使用」連接。

階層樹（類別分層結構）

對於所有軟體套件，有一個 類別分層結構 頁面，以及每個軟體套件的分層結構。每個分層結構頁面都包含類別的列表和介面的列表。從 java.lang.Object 開始，按繼承結構對類別進行排列。介面不從 java.lang.Object 繼承。

• 查看「概觀」頁面時，單擊「階層樹」將顯示所有軟體套件的分層結構。
• 查看特定軟體套件、類別或介面頁面時，單擊「階層樹」將僅顯示該軟體套件的分層結構。

已過時的 API

已過時的 API 頁面列出了所有已過時的 API。一般由於進行了改進並且通常提供了替代的 API，所以建議不要使用已過時的 API。在將來的實施過程中，可能會刪除已過時的 API。

索引

索引 套件含按字母順序排列的全部類別、介面、建構子、方法和欄位的列表。

上一個/下一個

這些連接使您可以轉至下一個或上一個類別、介面、軟體套件或相關頁面。

框架/無框架

這些連接用於顯示和隱藏 HTML 框架。所有頁面均具有有框架和無框架兩種顯示方式。

序列化表格

每個可序列化或可外部化的類別都有其序列化欄位和方法的描述。此資訊對重新實作者有用，而對使用 API 的開發者則沒有什麼用處。儘管導航欄中沒有連接，但您可以通過下列方式獲取此資訊：轉至任何序列化類別，然後單擊類別描述的「另請參見」部分中的「序列化表格」。

常數欄位值

常數欄位值頁面列出了靜態最終欄位及其值。

此說明檔案適用於使用標準 doclet 產生的 API 文檔。