此 API 文檔的(de)組織方式

概覽

概覽 頁面是(shì)此 API 文檔的(de)首頁, 提供了(le／liǎo)所有程序包的(de)列表及其概要(yào / yāo)。此頁面也(yě)可能包含這(zhè)些程序包的(de)總體說(shuō)明。

程序包

每個(gè)程序包都有一(yī / yì ／yí)個(gè)頁面, 其中包含它的(de)類和(hé / huò)接口的(de)列表及其概要(yào / yāo)。此頁面可以(yǐ)包含六個(gè)類别:

• 接口 (斜體)
• 類
• 枚舉
• 異常錯誤
• 錯誤
• 注釋類型

類/接口

每個(gè)類, 接口, 嵌套類和(hé / huò)嵌套接口都有各自的(de)頁面。其中每個(gè)頁面都由三部分 (類/接口說(shuō)明, 概要(yào / yāo)表, 以(yǐ)及詳細的(de)成員說(shuō)明) 組成:

• 類繼承圖
• 直接子(zǐ)類
• 所有已知子(zǐ)接口
• 所有已知實現類
• 類/接口聲明
• 類/接口說(shuō)明

• 嵌套類概要(yào / yāo)
• 字段概要(yào / yāo)
• 構造器概要(yào / yāo)
• 方法概要(yào / yāo)

• 字段詳細資料
• 構造器詳細資料
• 方法詳細資料

每個(gè)概要(yào / yāo)條目都包含該項目的(de)詳細說(shuō)明的(de)第一(yī / yì ／yí)句。概要(yào / yāo)條目按字母順序排列, 而(ér)詳細說(shuō)明則按其在(zài)源代碼中出(chū)現的(de)順序排列。這(zhè)樣保持了(le／liǎo)程序員所建立的(de)邏輯分組。

注釋類型

每個(gè)注釋類型都有各自的(de)頁面, 其中包含以(yǐ)下部分:

• 注釋類型聲明
• 注釋類型說(shuō)明
• 必需元素概要(yào / yāo)
• 可選元素概要(yào / yāo)
• 元素詳細資料

枚舉

每個(gè)枚舉都有各自的(de)頁面, 其中包含以(yǐ)下部分:

• 枚舉聲明
• 枚舉說(shuō)明
• 枚舉常量概要(yào / yāo)
• 枚舉常量詳細資料

樹 (類分層結構)

對于(yú)所有程序包, 有一(yī / yì ／yí)個(gè) 類分層結構 頁面, 以(yǐ)及每個(gè)程序包的(de)分層結構。每個(gè)分層結構頁面都包含類的(de)列表和(hé / huò)接口的(de)列表。從 java.lang.Object 開始, 按繼承結構對類進行排列。接口不(bù)從 java.lang.Object 繼承。

• 查看“概覽”頁面時(shí), 單擊 "樹" 将顯示所有程序包的(de)分層結構。
• 查看特定程序包, 類或接口頁面時(shí), 單擊 "樹" 将僅顯示該程序包的(de)分層結構。

已過時(shí)的(de) API

已過時(shí)的(de) API 頁面列出(chū)了(le／liǎo)所有已過時(shí)的(de) API。一(yī / yì ／yí)般由于(yú)進行了(le／liǎo)改進并且通常提供了(le／liǎo)替代的(de) API, 所以(yǐ)建議不(bù)要(yào / yāo)使用已過時(shí)的(de) API。在(zài)将來(lái)的(de)實現過程中, 可能會删除已過時(shí)的(de) API。

索引

索引 包含按字母順序排列的(de)所有類, 接口, 構造器, 方法和(hé / huò)字段的(de)列表。

上(shàng)一(yī / yì ／yí)個(gè)/下一(yī / yì ／yí)個(gè)

這(zhè)些鏈接使您可以(yǐ)轉至下一(yī / yì ／yí)個(gè)或上(shàng)一(yī / yì ／yí)個(gè)類, 接口, 程序包或相關頁面。

框架/無框架

這(zhè)些鏈接用于(yú)顯示和(hé / huò)隐藏 HTML 框架。所有頁面均具有有框架和(hé / huò)無框架兩種顯示方式。

所有類

所有類鏈接顯示所有類和(hé / huò)接口 (除了(le／liǎo)非靜态嵌套類型)。

序列化表格

每個(gè)可序列化或可外部化的(de)類都有其序列化字段和(hé / huò)方法的(de)說(shuō)明。此信息對重新實現者有用, 而(ér)對使用 API 的(de)開發者則沒有什麽用處。盡管導航欄中沒有鏈接, 但您可以(yǐ)通過下列方式獲取此信息: 轉至任何序列化類, 然後單擊類說(shuō)明的(de) "另請參閱" 部分中的(de) "序列化表格"。

常量字段值

常量字段值頁面列出(chū)了(le／liǎo)靜态最終字段及其值。