Zadanie Ant deaktualizowania interfejsu API

Przeznaczenie

To zadanie wykonuje pełną analizę interfejsu API dla profilu interfejsu API względem wersji bazowej, wyszukując tylko składowe (klasy, pola, metody), które zostały zdeaktualizowane lub których deaktualizacja została anulowana. Profil to bieżący stan tworzonego produktu. Profil zostaje porównany z wersją bazową interfejsu API pod kątem zmian związanych z deaktualizowaniem (zwykle z wcześniejszą wersją produktu).

Użycie

Opis

Nazwa zadania Ant to apitooling.apideprecation. Aby możliwe było jego użycie, plik JAR apitooling-ant.jar musi znajdować się w ścieżce klas narzędzia Ant.

<apitooling.apideprecation
	baseline="..."
	profile="..."
	report="..."
	excludelist="..."
	includelist="..."
	debug="..."
	eefile="..."
/>

Parametry

Atrybut Opis Wymagany
baseline Ten atrybut określa położenie wersji bazowej odniesienia.

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
profile Ten atrybut określa położenie bieżącego produktu lub profilu, który ma zostać porównany z wersją bazową odniesienia.

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 tym katalogu o strukturze przypominającej katalog główny filtrów. Dla każdego komponentu z problemami, które wymagają raportowania, tworzony jest podfolder. Każdy podfolder zawiera plik o nazwie report.xml.

W tym folderze tworzony jest także specjalny folder o nazwie allNonApiBundles, który zawiera plik o nazwie report.xml. W tym pliku znajduje się lista wszystkich pakunków, które nie używają rodzaju Narzędzia interfejsu API.

Położenie jest określane przy użyciu pełnej ścieżki.
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. Dodatkowo zadanie to obsługuje umieszczanie w listach włączeń lub wykluczeń także składowych. Lista włączeń określa zbiór pakunków i składowych, które mają być analizowane (jej pominięcie oznacza włączenie wszystkich pakunków i składowych). Po niej jest stosowana lista wykluczeń. Każdy wiersz pliku określa jeden z następujących elementów:
  • konkretna nazwa pakunku,
  • konkretna nazwa składowej,
  • wyrażenie regularne porównywane z nazwami pakunków lub składowych (wiersze zaczynające się od łańcucha „R:”),
  • komentarz (wiersze zaczynające się od znaku „#”).

Położenie jest określane przy użyciu pełnej ścieżki.
Przykładowa lista wykluczeń:
 # SKŁADOWE ŚRODOWISKA ECLIPSEorg.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object;
 # 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
 javax.servlet
 javax.servlet.jsp
 ...
Lista wykluczeń może zawierać wyrażenia regularne w wierszach rozpoczynających się łańcuchem "R:".
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. Dodatkowo zadanie to obsługuje umieszczanie w listach włączeń lub wykluczeń także składowych. Lista włączeń określa zbiór pakunków i składowych, które mają być analizowane (jej pominięcie oznacza włączenie wszystkich pakunków i składowych). Po niej jest stosowana lista wykluczeń. Każdy wiersz pliku określa jeden z następujących elementów:
  • konkretna nazwa pakunku,
  • konkretna nazwa składowej,
  • wyrażenie regularne porównywane z nazwami pakunków lub składowych (wiersze zaczynające się od łańcucha „R:”),
  • komentarz (wiersze zaczynające się od znaku „#”).

Położenie jest określane przy użyciu pełnej ścieżki.
Przykładowa lista włączeń:
 # SKŁADOWE ŚRODOWISKA ECLIPSEorg.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object;
 # 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
 javax.servlet
 javax.servlet.jsp
 ...
Nie
debug Ustawia wartość debugowania.

Możliwe wartości to: true i false.
Wartość domyślna to false.
Nie
eefile Ustawia plik środowiska wykonawczego, który ma być używany.

Domyślnie plik środowiska wykonawczego odpowiada używanemu środowisku wykonawczemu JavaSE-1.6.

Format pliku jest opisany na tej stronie wiki.

Położenie jest określane przy użyciu pełnej ścieżki.
Nie

Przykłady

 <apitooling.apideprecation
  baseline="D:\eclipse\3.4.1\eclipse"
  profile="D:\eclipse-SDK-I20081118-0800-linux-gtk.tar.gz"

  report="D:\reports\xml"
  excludelist="D:\lista_wykluczeń_zewnętrznych.txt"
  debug="true"
 />

Spowoduje to uruchomienie zadania tworzącego pliki report.xml w folderze D:\raporty\xml. Używa ono listy wykluczeń w celu zmniejszenia liczby problemów do zgłoszenia.

Ponieważ włączone jest debugowanie, część danych śledzenia debugowania będzie wyświetlana w konsoli narzędzia Ant.

Informacje pokrewne

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 konwersji raportu deaktualizowania interfejsu API