這項作業採用給定的 API 用法掃描,嘗試在給定的候選產品版本內予以重新解析,且會報告任何尚未解析的參照。
Ant 作業的名稱為:apitooling.apimigration。如果要能夠使用,JAR 檔 apitooling-ant.jar 必須在 Ant 類別路徑上。
<apitooling.apimigration
candidate="..."
usescan="..."
scopepattern="..."
referencepattern="..."
excludelist="..."
includelist="..."
report="..."
debug="..."
/>
| 屬性 | 說明 | 必要 |
| candidate |
這個屬性指定您想用來作為移轉候選項的產品。 它可以是 .zip、.jar、.tgz、.tar.gz 檔案,或是對應於Eclipse 安裝資料夾的目錄。您可以在這個目錄中找到 Eclipse 執行檔。 |
是 |
| usescan |
這個屬性指定要與移轉候選項比較的產品用法掃描。 用法掃描是利用用法掃描起始位置的絕對路徑來指定的。 |
是 |
| scopepattern |
這個屬性指定一個正規表示式型樣,以便在產品位置中,用來建置搜尋參照起源的元素範圍。
這個型樣必須是如這裡所定義,已妥善格式化的正規表示式。 |
否 |
| referencepattern |
設定一個正規表示式型樣,以便在產品位置中,用來建置搜尋參照目標的元素範圍。
這個型樣必須是如這裡所定義,已妥善格式化的正規表示式。 |
否 |
| excludelist |
設定排除清單位置。
排除清單位置指定一個文字檔,列出要從分析中排除的軟體組。 依預設,會分析設定檔中的所有軟體組。 您可以利用併入及排除清單屬性來選擇性地併入及排除軟體組。 併入清單會植入一組要分析的軟體組(省略的話,就會併入所有軟體組),然後再套用排除清單。 檔案中的每一行指定下列項目之一:
這個位置是使用絕對路徑指定的。 以下是一份範例排除清單: # EXCLUDED BUNDLES R:org\.eclipse\..*\.doc\..* ... |
否 |
| includelist |
設定併入清單位置。
併入清單位置指定一個文字檔,列出要併入分析中的軟體組。 依預設,會分析設定檔中的所有軟體組。 您可以利用併入及排除清單屬性來選擇性地併入及排除軟體組。 併入清單會植入一組要分析的軟體組(省略的話,就會併入所有軟體組),然後再套用排除清單。 檔案中的每一行指定下列項目之一:
這個位置是使用絕對路徑指定的。 以下是一份範例併入清單: # INCLUDED BUNDLES R:org\.eclipse\..* ... |
否 |
| report |
設定將在其中產生報告的輸出位置。
完成這個作業之後,這個目錄會使用階層式結構來顯示報告。對於有另一個參照它的軟體組的每一個元件,會建立子資料夾。 每一個子資料夾包含一個叫做 "[bundlename].xml" 的檔案。 在這個資料夾內,每一個參照包含資料夾之軟體組的軟體組,會有另一個子資料夾(叫做 "[referencing bundle name].xml")。 有三個子資料夾(API、PRIVATE 或 OTHER)包含那一種的類型、方法或欄位參照,它們其中之一會在參照的軟體組資料夾內。 另外兩個特殊檔案會寫入報告目錄中,它們是"not_searched.xml" 和 "no_apidescription.xml",它們包含來自基準線的軟體組相關資訊,這些軟體組分別是未搜尋使用情形資訊的軟體組,以及它們當中沒有 .api_description 檔案的軟體組。 這個位置是使用絕對路徑指定的。 例如:
root
|
+-- "not_searched.xml"
+-- "no_apidescription.xml"
+-- bundle name with usage
|
+--referencing bundle name
|
+-- [API or PRIVATE or OTHER]
|
+--[type_ or method_ or field_]references.xml
|
是 |
| 除錯 |
設定除錯值。
可能的值為: true、false預設值是 false。 |
否 |
<apitooling.apimigration
candidate="/eclipse/sdk3.5"
usescan="/eclipse/scans/sdk3.4"
scopepattern=".*"
referencepattern="org\.eclipse.*"
excludelist="D:\exclude_list_external.txt"
report="/eclipse/apimigration/xml"
debug="true"
/>
這個範例將執行在 /eclipse/apimigration/xml 資料夾內建立 *.xml 檔案的作業。
這項作業會比對 ID 開頭為 org.eclipse 的候選產品(正規表示式 org\.eclipse.* 所定義),重新解析 usescan 位置中的所有參照(正規表示式 .* 所定義)。
它將使用 D:\exclude_list_external.txt 中的排除清單檔來減少要報告的問題數目。
如果已啟用除錯,部分除錯追蹤將顯示在 Ant 主控台上。
API 凍結 Ant 作業
檔案產生 Ant 作業
分析報告轉換 Ant 作業
API 凍結報告轉換 Ant 作業
API 淘汰 Ant 作業
API 淘汰報告轉換 Ant 作業
API 用法報告轉換 Ant 作業
API 用法移轉報告轉換 Ant 作業