Ohjelmointirajapinnan jäädytyksen Ant-tehtävä

Käyttötarkoitus

Tämä tehtävä yksilöi ohjelmointirajapinnat, jotka on lisätty tai poistettu tai joita on muutettu suhteessa ohjelmointirajapintojen perustasoon. Tehtävän tarkoituksena on varmistaa, että ohjelmointirajapinnan jäädytyksen jälkeen ei tapahdu ohjelmointirajapinnan muutoksia.

Käyttö

Kuvaus

Ant-tehtävän nimi on apitooling.apifreeze. Jar-tiedoston apitooling-ant.jar käyttö edellyttää, että tiedosto on Ant-tehtävän luokkapolussa.

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

Parametrit

Määrite Kuvaus Pakollinen
baseline Tämä määrite ilmaisee viiteperustason sijainnin.

Sijainti voi olla .zip-, .jar-, .tgz- tai .tar.gz-tiedosto tai Eclipse-järjestelmän asennuskansiota vastaava hakemisto. Eclipse-järjestelmän ohjelmatiedosto on tässä hakemistossa.

Sijainti määritetään absoluuttisen polun avulla.
Kyllä
profile Tämä määrite ilmaisee sen nykyisen tuotteen tai profiilin sijainnin, jota on tarkoitus verrata viiteperustasoon.

Sijainti voi olla .zip-, .jar-, .tgz- tai .tar.gz-tiedosto tai Eclipse-järjestelmän asennuskansiota vastaava hakemisto. Eclipse-järjestelmän ohjelmatiedosto on tässä hakemistossa.

Sijainti määritetään absoluuttisen polun avulla.
Kyllä
report Määrittää luotavan raporttitiedoston nimen.

Nimi on määritettävä absoluuttisen polun avulla.
Tämän on oltava tiedostosijainti, ei hakemisto.
Kyllä
excludelist Määrittää pois suljettavien luettelon sijainnin.

Pois suljettavien luettelon sijainti määrittää tekstitiedoston, joka sisältää luettelon analyysistä pois suljettavista resurssijoukoista. Oletusarvon mukaan kaikki profiilin resurssijoukot analysoidaan. Resurssijoukkoja voidaan valikoivasti sisällyttää ja sulkea pois sisällyttävillä ja pois sulkevilla luettelomääritteillä. Lisäksi tämä tehtävä tukee jäsenten luetteloimista sisällyttävissä ja pois sulkevissa luetteloissa. Sisällyttävä luettelo määrittää analysoitavat resurssijoukot ja jäsenet (jos mitään ehtoa ei ole määritetty, kaikki resurssijoukot ja jäsenet otetaan mukaan), ja pois sulkeva luettelo otetaan käyttöön. Tiedoston jokainen rivi määrittää yhden seuraavista:
  • määritetyn resurssijoukon nimen
  • määritetyn jäsenen nimen
  • säännöllisen lausekkeen, jota verrataan resurssijoukkojen tai jäsenten nimiin (rivit alkavat merkkijonolla "R:")
  • kommentin (rivit alkavat merkillä "#")

Sijainti määritetään absoluuttisen polun avulla.
Seuraavassa on esimerkki pois sulkevasta luettelosta:
# 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\..*
...
Ei
includelist Määrittää sisällyttävän luettelon sijainnin.

Sisällyttävän luettelon sijainti määrittää tekstitiedoston, joka sisältää luettelon analyysiin sisällytettävistä resurssijoukoista. Oletusarvon mukaan kaikki profiilin resurssijoukot analysoidaan. Resurssijoukkoja voidaan valikoivasti sisällyttää ja sulkea pois sisällyttävillä ja pois sulkevilla luettelomääritteillä. Lisäksi tämä tehtävä tukee jäsenten luetteloimista sisällyttävissä ja pois sulkevissa luetteloissa. Sisällyttävä luettelo määrittää analysoitavat resurssijoukot ja jäsenet (jos mitään ehtoa ei ole määritetty, kaikki resurssijoukot ja jäsenet otetaan mukaan), ja pois sulkeva luettelo otetaan käyttöön. Tiedoston jokainen rivi määrittää yhden seuraavista:
  • määritetyn resurssijoukon nimen
  • määritetyn jäsenen nimen
  • säännöllisen lausekkeen, jota verrataan resurssijoukkojen tai jäsenten nimiin (rivit alkavat merkkijonolla "R:")
  • kommentin (rivit alkavat merkillä "#")

Sijainti määritetään absoluuttisen polun avulla.
Seuraavassa on esimerkki sisällyttävästä luettelosta:
# 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\..*
...
Ei
debug Määrittää vianmääritysarvon.

Mahdolliset arvot ovat seuraavat: true, false
Oletusarvo on false.
Ei
eefile Määrittää käytettävän toteutusympäristötiedoston.

Oletusarvon mukaan käytössä on JavaSE-1.6-toteutusympäristöä vastaava toteutusympäristötiedosto.

Tiedoston muoto on kuvattu tällä wiki-sivulla.

Tiedosto määritetään absoluuttisen polun avulla.
Ei

Esimerkkejä

	<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"
	/>

Järjestelmä ajaa tehtävän, joka luo report.xml-tiedoston kansioon D:\report. Tehtävä pienentää raportoitavien ongelmien määrää käyttämällä pois suljettavien luetteloa D:\exclude_list_external.txt.

Vianmääritys on käytössä, joten vianmäärityksen jäljitystietoja tulee näkyviin Ant-konsoliin.

Aiheeseen liittyviä ohjeita

Analyysin Ant-tehtävä
Tiedostojen luonnin Ant-tehtävä
Ohjelmointirajapinnan käytön Ant-tehtävä
Analyysiraportin muunnon Ant-tehtävä
Ohjelmointirajapinnan jäädytysraportin muunnon Ant-tehtävä
Ohjelmointirajapinnan vanhentumisen Ant-tehtävä
Ohjelmointirajapinnan vanhentumisraportin muunnon Ant-tehtävä
Ohjelmointirajapinnan käyttöraportin muunnon Ant-tehtävä