Úloha Ant zmrazení API

Účel

Tato úloha identifikuje rozhraní API, která byla doplněna, upravena nebo odebrána vzhledem k úrovni baseline rozhraní API. Tato úloha je určena k ověření, že po zmrazení rozhraní API nedošlo ke změnám API.

Použití

Popis

Název úlohy Ant je: apitooling.apifreeze. Chcete-li ji použít, soubor JAR apitooling-ant.jar musí být v cestě ke třídě nástroje Ant.

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

Parametry

Atribut Popis Nezbytné
baseline Tento atribut určuje umístění referenční úrovně baseline.

Může to být soubor .zip, .jar, .tgz, .tar.gz nebo adresář, který odpovídá instalačnímu adresáři Eclipse. To je adresář, v němž se nachází spustitelný soubor Eclipse.

Umístění se zadává pomocí absolutní cesty.
Ano
profile Tento atribut určuje umístění aktuálního produktu nebo profilu, který chcete porovnat vůči referenční úrovni baseline.

Může to být soubor .zip, .jar, .tgz, .tar.gz nebo adresář, který odpovídá instalačnímu adresáři Eclipse. To je adresář, v němž se nachází spustitelný soubor Eclipse.

Umístění se zadává pomocí absolutní cesty.
Ano
report Nastavte název souboru sestavy, který se má vygenerovat.

Měl by být zadán pomocí absolutní cesty.
Musí to být umístění souboru, nikoli adresář.
Ano
excludelist Nastavte umístění vylučovacího seznamu.

Umístění vylučovacího seznamu určuje textový soubor obsahující seznam balíků, které se mají vyloučit z analýzy. Standardně se analyzují všechny balíky v profilu. Atributy zahrnovacího a vylučovacího seznamu lze použít k selektivnímu zahrnutí a vyloučení balíků. Kromě toho tato úloha podporuje vypsání členů v zahrnovacím a vylučovacím seznamu. Seznam zahrnutí naplní sadu balíků a členů, které se mají analyzovat (když je vynechán, zahrnou se všechny balíky a členy), a poté se použije vylučovací seznam. Každý řádek souboru určuje jedno z následujících:
  • Specifický název balíku.
  • Specifický název člen,.
  • Regulární výraz k porovnání s názvy balíků a členů (řádky s "R:").
  • Komentář (řádky s '#').

Umístění se zadává pomocí absolutní cesty.
Následuje příklad vylučovacího seznamu:
# ECLIPSE MEMBERS
org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object;
# ECLIPSE BUNDLES
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
# NON-ECLIPSE BUNDLES
com.ibm.icu
R:javax\..*
...
Ne
includelist Nastavte umístění seznamu zahrnutí.

Umístění seznamu zahrnutí určuje textový soubor obsahující seznam balíků, které se mají zahrnout do analýzy. Standardně se analyzují všechny balíky v profilu. Atributy zahrnovacího a vylučovacího seznamu lze použít k selektivnímu zahrnutí a vyloučení balíků. Kromě toho tato úloha podporuje vypsání členů v zahrnovacím a vylučovacím seznamu. Seznam zahrnutí naplní sadu balíků a členů, které se mají analyzovat (když je vynechán, zahrnou se všechny balíky a členy), a poté se použije vylučovací seznam. Každý řádek souboru určuje jedno z následujících:
  • Specifický název balíku.
  • Specifický název člen,.
  • Regulární výraz k porovnání s názvy balíků a členů (řádky s "R:").
  • Komentář (řádky s '#').

Umístění se zadává pomocí absolutní cesty.
Následuje příklad seznamu zahrnutí:
# ECLIPSE MEMBERS
org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object;
# ECLIPSE BUNDLES
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
# NON-ECLIPSE BUNDLES
com.ibm.icu
R:javax\..*
...
Ne
debug Nastavte hodnotu ladění.

Možné hodnoty jsou: true, false
Výchozí hodnota je false.
Ne
eefile Nastavte soubor prováděcího prostředí, který se má použít.

Standardně se použije soubor prováděcího prostředí odpovídající prováděcímu prostředí JavaSE-1.6.

Formát souboru je popsán na této stránce wiki.

Soubor se určuje pomocí absolutní cesty.
Ne

Příklady

	<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:\exclude_list.txt"
		debug="true"
	/>

Tímto se spustí úloha a vytvoří se soubor report.xml ve složce D:\report. Ke snížení počtu hlášených problémů se použije vylučovací seznam D:\exclude_list_external.txt.

Vzhledem k tomu, že je povoleno ladění, na konzole Ant se zobrazí určitá ladicí trasování.

Související odkazy

Úloha Ant analýzy
Úloha Ant generování souboru
Úloha Ant použití API
Úloha Ant převodu sestavy analýzy
Úloha Ant převodu sestavy zmrazení API
Úloha Ant nepřípustnosti rozhraní API
Úloha Ant převodu sestavy nepřípustnosti rozhraní API
Úloha Ant převodu sestavy využití API