Úloha Ant nepřípustnosti rozhraní API

Účel

Tato úloha spustí úplnou analýzu rozhraní API v profilu API relativně k úrovni baseline - hledání pouze členů (tříd, polí, metod), které byly zamítnuty/bylo zrušeno jejich zamítnutí. Profil je aktuální stav vyvíjeného produktu. Profil se porovná s úrovní baseline API, zda došlo ke změnám odmítnutí (obvykle s předchozí verzí produktu).

Použití

Popis

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

<apitooling.apideprecation
	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 umístění výstupu, kam se vygenerují sestavy.

Jakmile bude úloha dokončena, v tomto adresáři budou k dispozici sestavy ve struktuře, která se podobá kořenovému adresáři filtrů. Pro každou komponentu s problémy, které se mají hlásit, se vytvoří podsložka. Každá podsložka obsahuje soubor s názvem "report.xml".

Také se v této složce vytvoří speciální složka s názvem "allNonApiBundles", která rovněž obsahuje soubor s názvem "report.xml". Tento soubor obsahuje seznam všech balíků, které nepoužívají charakter modulu API Tools.

Umístění se zadává pomocí absolutní cesty.
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;
 # DOC BUNDLES
 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
 # NON-ECLIPSE BUNDLES
 com.ibm.icu
 com.jcraft.jsch
 javax.servlet
 javax.servlet.jsp
 ...
Vylučovací seznam může obsahovat regulární výrazy, pokud řádek začíná znakem "R:".
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;
 # DOC BUNDLES
 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
 # NON-ECLIPSE BUNDLES
 com.ibm.icu
 com.jcraft.jsch
 javax.servlet
 javax.servlet.jsp
 ...
Ne
ladění 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.apideprecation
  baseline="D:\eclipse\3.4.1\eclipse"
  profile="D:\eclipse-SDK-I20081118-0800-linux-gtk.tar.gz"

  report="D:\reports\xml"
  excludelist="D:\exclude_list_external.txt"
  debug="true"
 />

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

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

Související odkazy

Úloha Ant zmrazení API
Ú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 převodu sestavy využití API
Úloha Ant převodu sestavy nepřípustnosti rozhraní API