Uppgiften identifierar APIer som har lagts till, ändrats eller tagits bort relativt till en API-basnivå. Uppgiften är avsedd för att validera att inga API-ändringar sker efter API-frysning.
Ant-uppgiftens namn: apitooling.apifreeze. Om den ska kunna användas måste JAR-filen apitooling-ant.jar finnas i Ant-klassökvägen.
<apitooling.apifreeze baseline="..." profile="..." report="..." excludelist="..." includelist="..." debug="..." eefile="..." />
| Attribut | Beskrivning | Obligatoriskt |
| baseline | Attributet anger platsen för refererad basnivå.
Det kan vara en .zip-, .jar-, .tgz-, .tar.gz-fil eller en katalog som motsvarar installationskatalogen för Eclipse. Det är den katalog där alla körbara Eclipse-filer finns. Platsen anges med en absolut sökväg. |
Ja |
| profile | Attributet anger platsen för aktuell produktprofil som ska jämföras med referensbasnivån.
Det kan vara en .zip-, .jar-, .tgz-, .tar.gz-fil eller en katalog som motsvarar installationskatalogen för Eclipse. Det är den katalog där alla körbara Eclipse-filer finns. Platsen anges med en absolut sökväg. |
Ja |
| report | Ange namnet på rapportfilen som ska skapas.
Det ska anges med en absolut sökväg. Detta måste vara en filplats, inte en katalog |
Ja |
| excludelist | Platsen för exkluderingslistan
I exkluderingslistan anges en textfil där de samlingspaket som ska uteslutas från analysen listas. Som standard analyseras alla paket i profilen. Med inkluderings- och exkluderingslistattributen kan du välja vilka paket som ska tas med repektive uteslutas. Dessutom kan uppgiften lista medlemmar i inkluderings- och exkluderingslistor. Inkluderingslistan anger vilka paket och medlemmar som ska analyseras (om den utelämnas tas alla paket och medlemmar med), och sedan tillämpas exkluderingslistan. Varje rad i filen anger antingen:
Platsen anges med en absolut sökväg. Följande är ett exempel på en exkluderingslista: # 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\..* ... |
Nej |
| includelist | Platsen för inkluderingsslistan.
I inkluderingslistan anges en textfil där de samlingspaket som ska tas med i analysen listas. Som standard analyseras alla paket i profilen. Med inkluderings- och exkluderingslistattributen kan du välja vilka paket som ska tas med repektive uteslutas. Dessutom kan uppgiften lista medlemmar i inkluderings- och exkluderingslistor. Inkluderingslistan anger vilka paket och medlemmar som ska analyseras (om den utelämnas tas alla paket och medlemmar med), och sedan tillämpas exkluderingslistan. Varje rad i filen anger antingen:
Platsen anges med en absolut sökväg. Följande är ett exempel på en inkluderingslista: # 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\..* ... |
Nej |
| debug | Felsökningsvärdet Giltiga värden är true och false.
Standardvärdet är false.
|
Nej |
| eefile | Den körningsmiljöfil som ska användas
Som standard används en körningsmiljöfil som motsvarar körningsmiljön JavaSE-1.6. Formatet på filen beskrivs på den här wiki-sidan. Filen anges med en absolut sökväg. |
Nej |
<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" />
Uppgiften som skapar report.xml i mappen D:\report körs.
Exkluderingslistan D:\exclude_list_external.txt används för att minska antalet problem som ska rapporteras.
Eftersom debug är aktiverat visas vissa felsökningsmeddelanden i Ant-konsolen.

Ant-uppgiften Analysis
Ant-uppgiften File Generation
Ant-uppgiften API Use
Ant-uppgiften Analysis Report Conversion
Ant-uppgiften API Freeze Report Conversion
Ant-uppgiften API Deprecation
Ant-uppgiften API Deprecation Report Conversion
Ant-uppgiften API Use Report Conversion