To zadanie rozstrzyga skanowania użycia interfejsu API w profilu względnym w odniesieniu do wersji bazowej. Raportuje ono odwołania do typów, metod i pól, których brakuje obecnie w profilu.
Nazwa zadania Ant to apitooling.apiusescanproblems. Aby możliwe było jego użycie, plik JAR apitooling-ant.jar musi znajdować się w ścieżce klas narzędzia Ant.
<apitooling.apiusescanproblems profile="..." report="..." apiusescans="..." excludelist="..." includelist="..." preferences="..." debug="..." />
| Atrybut | Opis | Wymagany |
| profile | Ten atrybut określa położenie bieżącego produktu lub profilu, którego skanowanie użycia interfejsu API ma zostać rozstrzygnięte.
Może to być plik .zip, .jar, .tgz lub .tar.gz albo katalog odpowiadający folderowi instalacyjnemu platformy Eclipse. Jest to katalog, w którym znajduje się plik wykonywalny platformy Eclipse. Położenie jest określane przy użyciu pełnej ścieżki. |
Tak |
| report | Ustawia położenie wyjściowe, w którym będą generowane raporty.
Po zakończeniu zadania raporty będą dostępne w danym katalogu. Dla każdego komponentu z problemami, które wymagają raportowania, tworzony jest podfolder. Każdy podfolder zawiera plik o nazwie report.xml. Położenie jest określane przy użyciu pełnej ścieżki. |
Tak |
| apiusescans | Ten atrybut określa listę rozdzielonych przecinkami położeń skanowań użycia interfejsu API, które mają zostać sprawdzone w odniesieniu do profilu.
Może to być plik .zip lub katalog odpowiadający raportowi skanowania użycia interfejsu API. Jest to katalog, w którym znajduje się folder XML zawarty w skanowaniu użycia. |
Tak |
| excludelist | Ustawia położenie listy wykluczeń.
Położenie listy wykluczeń określa plik tekstowy zawierający pakunki do wykluczenia z analizy. Domyślnie analizowane są wszystkie pakunki w profilu. Atrybutów listy włączeń i wykluczeń można używać do selektywnego włączania i wykluczania pakunków. Lista włączeń określa zbiór pakunków, które mają być analizowane (jej pominięcie oznacza włączenie wszystkich pakunków). Po niej jest stosowana lista wykluczeń. Każdy wiersz pliku określa jeden z następujących elementów:
Położenie jest określane przy użyciu pełnej ścieżki. Przykładowa lista wykluczeń: # PAKUNKI DOC 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 # PAKUNKI SPOZA ŚRODOWISKA ECLIPSE com.ibm.icu com.jcraft.jsch R:javax\..* ... |
Nie |
| includelist | Ustawia położenie listy włączeń.
Położenie listy włączeń określa plik tekstowy zawierający pakunki do uwzględnienia w analizie. Domyślnie analizowane są wszystkie pakunki w profilu. Atrybutów listy włączeń i wykluczeń można używać do selektywnego włączania i wykluczania pakunków. Lista włączeń określa zbiór pakunków, które mają być analizowane (jej pominięcie oznacza włączenie wszystkich pakunków). Po niej jest stosowana lista wykluczeń. Każdy wiersz pliku określa jeden z następujących elementów:
Położenie jest określane przy użyciu pełnej ścieżki. Przykładowa lista włączeń: # PAKUNKI DOC org.eclipse.jdt.doc.isv org.eclipse.jdt.doc.user org.eclipse.pde.doc.user R:org.eclipse.platform.doc.* # PAKUNKI SPOZA ŚRODOWISKA ECLIPSE com.ibm.icu com.jcraft.jsch R:javax\..* ... |
Nie |
| preferences | Ustawianie preferencji zadania.
Preferencje służą do konfigurowania istotności problemów. Istotność problemu może mieć jedną z trzech wartości: Ignorowanie, Ostrzeżenie lub Błąd. Zestaw wykrywanych problemów jest definiowany przez powiązane klucze preferencji problemów w narzędziach interfejsu API. Położenie jest określane przy użyciu pełnej ścieżki. Jeśli dane położenie nie istnieje, preferencje nie zostaną ustawione. Wiersze zaczynające się od znaku # są ignorowane. Format pliku preferencji jest następujący: #czw 20 lis 2008 17:35:06 EST API_USE_SCAN_TYPE_SEVERITY=Error API_USE_SCAN_METHOD_SEVERITY=Error API_USE_SCAN_FIELD_SEVERITY=ErrorKlucze można znaleźć w pliku org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes. |
Nie |
| debug | Ustawia wartość debugowania.
Możliwe wartości to: true, false.
Wartość domyślna to false.
|
Nie |
<apitooling.apiusescanproblems profile="D:\eclipse\3.7\eclipse" report="D:\reports\xml" apiusescans="D:\APIUseScan\ProduktJeden,D:\APIUseScan\ProduktDwa" excludelist="D:\lista_wykluczeń_zewnętrznych.txt" preferences="D:\tests_api\org.eclipse.pde.api.tools.prefs" debug="true" />
Spowoduje to uruchomienie zadania tworzącego pliki report.xml w folderze D:\raporty\xml. Typy, metody i pola ze skanowań użycia zostaną rozstrzygnięte w profilu znajdującym się w katalogu D:\eclipse\3.7\eclipse, a brakujące elementy zostaną zgłoszone.
Aby zmniejszyć liczbę pakunków zawierających problemy do zgłoszenia, używana jest lista wykluczeń z pliku D:\lista_wykluczeń_zewnętrznych.txt.
Poziomy istotności problemów będą generowane zgodnie z opisem w pliku D:\tests_api\org.eclipse.pde.api.tools.prefs.
Ponieważ włączone jest debugowanie, część danych śledzenia debugowania będzie wyświetlana w konsoli narzędzia Ant.

Zadanie Ant analizy interfejsu API
Zadanie Ant blokowania interfejsu API
Zadanie Ant generowania pliku
Zadanie Ant użycia interfejsu API
Zadanie Ant konwersji raportu analizy
Zadanie Ant konwersji raportu blokowania interfejsu API
Zadanie Ant konwersji raportu użycia interfejsu API
Zadanie Ant deaktualizowania interfejsu API
Zadanie Ant konwersji raportu deaktualizowania interfejsu API