這項作業會相對於基準線來解析設定檔中的「API 用法掃描」。 它會報告指向設定檔目前遺漏的類型、方法和欄位之參照。
Ant 作業的名稱如下:apitooling.apiusescanproblems。
如果要能夠使用,JAR 檔 apitooling-ant.jar 必須在 Ant 類別路徑上。
<apitooling.apiusescanproblems profile="..." report="..." apiusescans="..." excludelist="..." includelist="..." preferences="..." debug="..." />
| 屬性 | 說明 | 必要 |
| profile | 這個屬性指定您解析「API 用法掃描」時所要比對的現行產品或設定檔的位置。
它可以是 .zip、.jar、.tgz、.tar.gz 檔案,或是對應於Eclipse 安裝資料夾的目錄。您可以在這個目錄中找到 Eclipse 執行檔。 這個位置是使用絕對路徑指定的。 |
是 |
| report | 設定將在其中產生報告的輸出位置。
作業完成之後,會在這個目錄中提供報告。 對於有問題要報告的每一個元件,會建立子資料夾。 每一個子資料夾包含一個叫做 "report.xml" 的檔案。 這個位置是使用絕對路徑指定的。 |
是 |
| apiusescans | 這個屬性指定一份逗點區隔的清單,列出您想要比對設定檔來檢查的「API 用法掃描」位置。
它可能是一個 .zip 檔,或是對應於「API 用法掃描」報告的目錄。 這是您可以在「用法掃描」中找到 XML 資料夾的目錄。 |
是 |
| 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 API_USE_SCAN_TYPE_SEVERITY=Error API_USE_SCAN_METHOD_SEVERITY=Error API_USE_SCAN_FIELD_SEVERITY=Error可以在 org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes 中找到索引鍵。 |
否 |
| debug | 設定除錯值。
可能的值為: true、false預設值是 false。 |
否 |
<apitooling.apiusescanproblems profile="D:\eclipse\3.7\eclipse" report="D:\reports\xml" apiusescans="D:\APIUseScan\ProductOne,D:\APIUseScan\ProductTwo" excludelist="D:\exclude_list_external.txt" preferences="D:\tests_api\org.eclipse.pde.api.tools.prefs" debug="true" />
這個範例將在 D:\reports\xml 資料夾內執行建立 report.xml 檔案的作業。
用法掃描中的類型、方法和欄位會在位於 D:\eclipse\3.7\eclipse 的設定檔中進行解析,且會提出遺漏報告。
它利用 D:\exclude_list_external.txt 檔中的排除清單來減少要報告問題的軟體組數目。
將依 D:\tests_api\org.eclipse.pde.api.tools.prefs 所指定來產生問題嚴重性。
由於已啟用除錯,部分除錯追蹤將顯示在 Ant 主控台上。

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