8-3 查詢 API 文件

學習 Java 程式設計的重點之一,就是學習使用 Java SE 所提供的各種標準類別,然而對於每一個類別的功能及當中所定義的每一個方法之作用該如何去進行了解呢?當然的!不可能去背誦所有的類別與方法之作用,您要學會的是如何查詢 API 文件( API Specification )

對於 Java SE 7 來說,您可以連結以上的網址來進行 API 文件的查詢:

http://docs.oracle.com/javase/7/docs/api/

圖8-15 Java SE 7 線上 API 文件

在線上API文件中分作三個頁框,左上角的是套件( package) 分類,左下角是類別分類,右邊是對應的內容說明,預設左下角是顯示所有的類別,依字母順序排列。

舉個實際的例子,假設您想查詢 java.lang.Integer 類別的說明,則您先在左上角中找到 java.lang 的鏈結。

圖8-16 選擇 java.lang 套件

按下 java.lang 的鏈結之後,左下頁框就會只顯示 java.lang 套件管理下的所有類別,依字母順序排列,您可以很快的找到 Integer 的鏈結。

圖8-17 選擇 Integer 類別

按下 Integer 類別的鏈結之後,在右邊頁框就會出現 Integer 類別的相關說明。

圖8-18 Integer 類別說明

在圖 8-17 中,可以看到 API 文件中詳細記載了 Integer 類別的繼承架構、實作之介面,以及 Integer 類別的功能介紹,在當中您也可以看到它載明了從哪一個 JDK 版本開始有了 Integer 類別。

重點提示

API 文件主要以英文撰寫而成,不過當中的英文都很淺顯,對於學習 Java 的人來說,學會查詢 API 文件是必備的功夫。

往下捲動右邊的頁框,您可以看到 Integer 類別的各個值域( Field )成員與方法( Method )成員之介紹,以及建構方法( Constructor )的使用。

圖8-19 Integer 類別的 Field、Method 與 Constructor 介紹

關於 Field、Method 與 Constructor,會在之後的單元中再詳細介紹。

以查詢 byteValue()方法來說,您可以在 Method Summary 中看到 byteValue()的作用是將 Integer 的值以 byte 型態返回(Returns the value of this Integer as a byte.),如果想要看到更多有關 byteValue()的說明,可以按下 byteValue()的鏈結。

圖8-20 顯示 byteValue()的詳細說明

查詢 API 文件的大致流程如以上介紹的,如果您不方便連結網路來查詢線上 API 文件的話,也可以直接下載整個 API 文件至電腦中,下載網址是:

http://www.oracle.com/technetwork/java/javase/downloads/index.html

圖8-21 下載整個 API 文件

相關資料

下列參考資料能夠對本章節所討論的話題提供 更詳細的說明: