Zadanie Ant blokowania interfejsu API

Przeznaczenie

To zadanie identyfikuje interfejsy API, które zostały dodane, zmodyfikowane lub usunięte względem wersji bazowej interfejsu API. To zadanie służy do sprawdzania, czy nie wystąpiły zmiany w interfejsie API po jego zablokowaniu.

Opis

Opis

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

<apitooling.apifreeze
	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 nazwę pliku raportu, który będzie generowany.

Powinien być określany przy użyciu pełnej ścieżki.
Musi to być położenie pliku, a nie katalogu.
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 ECLIPSE
org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object;
# PAKUNKI ŚRODOWISKA ECLIPSE
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_DEC_FIELD_ERROR
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_DEC_FIELD_WARNING
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_ELCL_COLLAPSEALL
# PAKUNKI SPOZA ŚRODOWISKA ECLIPSE
com.ibm.icu
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. 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 ECLIPSE
org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object;
# PAKUNKI ŚRODOWISKA ECLIPSE
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_DEC_FIELD_ERROR
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_DEC_FIELD_WARNING
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_ELCL_COLLAPSEALL
# PAKUNKI SPOZA ŚRODOWISKA ECLIPSE
com.ibm.icu
R:javax\..*
...
Nie
debug Ustawia wartość debugowania.

Możliwe wartości to: true, 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.apifreeze
		baseline="D:\eclipse\3.4.1\eclipse"
		profile="D:\eclipse-SDK-I20081118-0800-linux-gtk.tar.gz"
		report="D:\report\report.xml"
		excludelist="D:\lista_wykluczeń.txt"
		debug="true"
	/>

W powyższym przykładzie uruchamiane jest zadanie tworzenia pliku raport.xml wewnątrz folderu D:\raport. Aby zmniejszyć liczbę problemów do zgłoszenia, używana jest lista wykluczeń D:\lista_wykluczeń.txt.

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

Informacje pokrewne

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