這項作業會執行 API 設定檔相對於基準線的完整 API 分析 - 包括 API 用法、二進位相容性和軟體組版本號碼驗證。此設定檔是開發中產品的現行狀態。此設定檔會與 API 基準線做比較,以瞭解二進位檔相容性(通常是產品的舊版)。
分析不包含 @since 標籤驗證,因為所有驗證都是在二進位類別檔執行(不分析程式碼)。
Ant 作業的名稱為:apitooling.analysis。如果要能夠使用,JAR 檔 apitooling-ant.jar 必須在 Ant 類別路徑上。
<apitooling.analysis baseline="..." profile="..." report="..." filters="..." excludelist="..." includelist="..." preferences="..." debug="..." eefile="..." />
| 屬性 | 說明 | 必要 |
| baseline | 這個屬性指定參照基準線的位置。
它可以是 .zip、.jar、.tgz、.tar.gz 檔案,或是對應於Eclipse 安裝資料夾的目錄。您可以在這個目錄中找到 Eclipse 執行檔。 這個位置是使用絕對路徑指定的。 |
是 |
| profile | 這個屬性指定您要與參照基準線相比較的現行產品或設定檔的位置。
它可以是 .zip、.jar、.tgz、.tar.gz 檔案,或是對應於Eclipse 安裝資料夾的目錄。您可以在這個目錄中找到 Eclipse 執行檔。 這個位置是使用絕對路徑指定的。 |
是 |
| report | 設定將在其中產生報告的輸出位置。
完成這個作業之後,這個目錄會使用類似過濾器根目錄的結構來顯示報告。對於有問題要報告的每一個元件,會建立子資料夾。 每一個子資料夾包含一個叫做 "report.xml" 的檔案。 有一個叫做 "allNonApiBundles" 的特殊資料夾也會建立在這個資料夾中,它亦包含一個叫做 "report.xml" 的檔案。 這個檔案列出不使用「API 工具」本質的所有軟體組。 在 report 目錄中,另外也會建立一個 "counts.xml" 檔,其中有找到之問題的摘要。 這個位置是使用絕對路徑指定的。 |
是 |
| filters | 設定在分析期間要使用的 API 過濾器的根目錄。
這個引數是 .api_filters 檔案的根目錄,這些檔案應該用來過濾「API 工具」分析所產生的潛在問題。 這個根目錄是使用絕對路徑指定的。 根目錄必須包含下列結構:
root
|
+-- component name (i.e. org.eclipse.jface)
|
+--- .api_filters
|
否 |
| excludelist | 設定排除清單位置。
排除清單位置指定一個文字檔,列出要從分析中排除的軟體組。 依預設,會分析設定檔中的所有軟體組。 您可以利用併入及排除清單屬性來選擇性地併入及排除軟體組。 併入清單會植入一組要分析的軟體組(省略的話,就會併入所有軟體組),然後再套用排除清單。 檔案中的每一行指定下列項目之一:
這個位置是使用絕對路徑指定的。 以下是一份範例排除清單: # DOC BUNDLES org.eclipse.jdt.doc.isv org.eclipse.jdt.doc.user org.eclipse.pde.doc.user org.eclipse.platform.doc.isv org.eclipse.platform.doc.user # NON-ECLIPSE BUNDLES com.ibm.icu com.jcraft.jsch R:javax\..* ... |
否 |
| includelist | 設定併入清單位置。
併入清單位置指定一個文字檔,列出要併入分析中的軟體組。 依預設,會分析設定檔中的所有軟體組。 您可以利用併入及排除清單屬性來選擇性地併入及排除軟體組。 併入清單會植入一組要分析的軟體組(省略的話,就會併入所有軟體組),然後再套用排除清單。 檔案中的每一行指定下列項目之一:
這個位置是使用絕對路徑指定的。 以下是一份範例併入清單: # DOC BUNDLES org.eclipse.jdt.doc.isv org.eclipse.jdt.doc.user org.eclipse.pde.doc.user R:org.eclipse.platform.doc.* # NON-ECLIPSE BUNDLES com.ibm.icu com.jcraft.jsch R:javax\..* ... |
否 |
| preferences | 設定作業的喜好設定。
這些喜好設定是用來配置問題嚴重性。問題嚴重性有三個可能值:忽略、警告或錯誤。偵測到的問題集是由 API 工具中對應的問題喜好設定索引鍵所定義。 這個位置是使用絕對路徑指定的。 如果給定的位置不存在,就不會設定喜好設定。 會忽略以 '#' 開始的行。喜好設定檔案的格式如下所示: #Thu Nov 20 17:35:06 EST 2008 ANNOTATION_ELEMENT_TYPE_ADDED_METHOD_WITHOUT_DEFAULT_VALUE=Ignore ANNOTATION_ELEMENT_TYPE_CHANGED_TYPE_CONVERSION=Ignore ANNOTATION_ELEMENT_TYPE_REMOVED_FIELD=Ignore ANNOTATION_ELEMENT_TYPE_REMOVED_METHOD=Ignore ANNOTATION_ELEMENT_TYPE_REMOVED_TYPE_MEMBER=Warning API_COMPONENT_ELEMENT_TYPE_REMOVED_API_TYPE=Ignore API_COMPONENT_ELEMENT_TYPE_REMOVED_TYPE=Ignore CLASS_ELEMENT_TYPE_ADDED_METHOD=Error CLASS_ELEMENT_TYPE_ADDED_RESTRICTIONS=Ignore CLASS_ELEMENT_TYPE_ADDED_TYPE_PARAMETER=Ignore CLASS_ELEMENT_TYPE_CHANGED_CONTRACTED_SUPERINTERFACES_SET=Ignore ...可以在 org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes 中找到索引鍵。 |
否 |
| debug | 設定除錯值。
可能的值為: true、false預設值是 false。 |
否 |
| eefile | 設定要使用的環境檔案。
依預設,會使用對應於 JavaSE-1.6 執行環境的執行環境檔案。 檔案的格式說明於這個 Wiki 網頁上。 這個檔案是使用絕對路徑指定的。 |
否 |
<apitooling.analysis baseline="D:\eclipse\3.4.1\eclipse" profile="D:\eclipse-SDK-I20081118-0800-linux-gtk.tar.gz" report="D:\reports\xml" filters="D:\filters" excludelist="D:\exclude_list_external.txt" preferences="D:\tests_api\org.eclipse.pde.api.tools.prefs" debug="true" />
這個範例將在 D:\reports\xml 資料夾內執行建立 report.xml 檔案的作業。
它將使用排除清單和位於 D:\exclude_list_external.txt 與
D:\filters 的 .api_filter 檔案來減少要報告的問題數目。
將依 D:\tests_api\org.eclipse.pde.api.tools.prefs 所指定來產生問題嚴重性。
由於已啟用除錯,部分除錯追蹤將顯示在 Ant 主控台上。

API 凍結 Ant 作業
檔案產生 Ant 作業
API 用法 Ant 作業
分析報告轉換 Ant 作業
API 凍結報告轉換 Ant 作業
API 用法報告轉換 Ant 作業
API 淘汰 Ant 作業
API 淘汰報告轉換 Ant 作業