Ant-oppgave for API-frys

Formål

Denne oppgaven identifiserer APIer som er lagt til, endret eller fjernet i forhold til en API-basis. Denne oppgaven skal validere at det ikke oppstår endringer i APIen etter en API-frys.

Bruk

Beskrivelse

Navnet på Ant-oppgaven er: apitooling.apifreeze. Når den skal brukes, må jar-filen apitooling-ant.jar være i Ant-klassebanen.

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

Parametere

Attributt Beskrivelse Obligatorisk
baseline Dette attributtet oppgir plasseringen av referansebasisen.

Det kan være en *.zip-, *.jar-, *.tgz- eller *.tar.gz-fil eller en katalog som tilsvarer installeringsmappen til Eclipse. Dette er katalogen hvor du finner den utførbare filen til Eclipse.

Plasseringen oppgis med en absolutt bane.
Ja
profile Dette attributtet oppgir plasseringen av det gjeldende produktet eller profilen som du vil sammenligne med referansebasisen.

Det kan være en *.zip-, *.jar-, *.tgz- eller *.tar.gz-fil eller en katalog som tilsvarer installeringsmappen til Eclipse. Dette er katalogen hvor du finner den utførbare filen til Eclipse.

Plasseringen oppgis med en absolutt bane.
Ja
report Oppgi navnet på rapportfilen som skal genereres.

Den bør oppgis med en absolutt bane.
Dette må være en filplassering, ikke en katalog.
Ja
excludelist Angi plasseringen til ekskluderingslisten.

Ekskluderingslisteplasseringen oppgir en tekstfil med en liste over bunter som skal ekskluderes fra analysen. Som standard blir alle bunter i profilen analysert. Attributtene for inkluderings- og ekskluderingsliste kan brukes til å velge bunter som skal inkluderes og ekskluderes. Denne oppgaven støtter dessuten oppføring av medlemmer i inkluderings- og ekskluderingslister. Inkluderingslisten initialiserer settet med bunter og medlemmer som skal analyseres (hvis den er utelatt, blir alle bunter og medlemmer inkludert), og deretter blir ekskluderingslisten brukt. Hver linje i filen oppgir ett av følgende:
  • et bestemt buntnavn
  • et bestemt medlemsnavn
  • et regulært uttrykk som skal sammenliknes med bunt- eller medlemsnavn (linjer som begynner med "R:")
  • en kommentar (linjer som begynner med '#')

Plasseringen oppgis med en absolutt bane.
Nedenfor finner du et eksempel på en ekskluderingsliste:
# 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\..*
...
Nei
includelist Angi plasseringen til ekskluderingslisten.

Inkluderingslisteplasseringen oppgir en tekstfil med en liste over bunter som skal inkluderes i analysen. Som standard blir alle bunter i profilen analysert. Attributtene for inkluderings- og ekskluderingsliste kan brukes til å velge bunter som skal inkluderes og ekskluderes. Denne oppgaven støtter dessuten oppføring av medlemmer i inkluderings- og ekskluderingslister. Inkluderingslisten initialiserer settet med bunter og medlemmer som skal analyseres (hvis den er utelatt, blir alle bunter og medlemmer inkludert), og deretter blir ekskluderingslisten brukt. Hver linje i filen oppgir ett av følgende:
  • et bestemt buntnavn
  • et bestemt medlemsnavn
  • et regulært uttrykk som skal sammenliknes med bunt- eller medlemsnavn (linjer som begynner med "R:")
  • en kommentar (linjer som begynner med '#')

Plasseringen oppgis med en absolutt bane.
Nedenfor finner du et eksempel på en inkluderingsliste:
# 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\..*
...
Nei
debug Angi feilsøkingsverdien.

Mulige verdier er true og false
Standardverdien er false.
Nei
eefile Angi utføringsmiljøfilen som skal brukes.

Som standard brukes en utføringsmiljøfil som tilsvarer et JavaSE-1.6-utføringsmiljø.

Formatet til filen er beskrevet på denne wiki-siden.

Filen oppgis med en absolutt bane.
Nei

Eksempler

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

Dette kjører oppgaven som oppretter report.xml-filen i mappen D:\report. Den bruker ekskluderingslisten D:\exclude_list_external.txt til å redusere antall problemer som rapporteres.

På grunn av at feilsøking er aktivert, vises noe feilsøkingssporing i Ant-konsollen.

Beslektet referanse

Ant-oppgave for analyse
Ant-oppgave for filgenerering
Ant-oppgave for API-bruk
Ant-oppgave for konvertering av analyserapport
Ant-oppgave for konvertering av rapport for API-frys
Ant-oppgave for API-foreldelse
Ant-oppgave for konvertering av rapport for API-foreldelse
Ant-oppgave for konvertering av rapport for API-bruk