Denne opgave udfører en fuldstændig API-analyse af en API-profil i forhold til en grundlinje - og søger kun efter medlemmer (klasser, felter, metoder), der er forældet/ikke længere er forældet. Profilen er den aktuelle tilstand af et produkt under udvikling. Profilen sammenlignes med en API-grundlinje for forældelsesændringer (normalt den tidligere release af et produkt).
Navnet på Ant-opgaven er: apitooling.apideprecation
. For at kunne bruges skal JAR-filen apitooling-ant.jar
findes i Ant-classpath.
<apitooling.apideprecation
baseline="..."
profile="..."
report="..."
excludelist="..."
includelist="..."
debug="..."
eefile="..."
/>
Attribut | Beskrivelse | Påkrævet |
baseline |
Denne attribut angiver placeringen af referencegrundlinjen. Det kan være en .zip-, .jar-, .tgz-, .tar.gz-fil eller et bibliotek, der svarer til Eclipse-installationsfolderen. Det er i dette bibliotek, at du kan finde den eksekvérbare Eclipse-fil. Placeringen angives ved hjælp af en absolut sti. |
Ja |
profile |
Denne attribut angiver placeringen af det aktuelle produkt eller den aktuelle profil, som du vil sammenligne med referencegrundlinjen. Det kan være en .zip-, .jar-, .tgz-, .tar.gz-fil eller et bibliotek, der svarer til Eclipse-installationsfolderen. Det er i dette bibliotek, at du kan finde den eksekvérbare Eclipse-fil. Placeringen angives ved hjælp af en absolut sti. |
Ja |
report |
Angiv den outputplacering, hvor rapporterne bliver genereret. Når opgaven er udført, er rapporterne tilgængelige i dette bibliotek ved hjælp af en struktur, der ligner filterroden. Der oprettes en underfolder for alle komponenter, der har problemer, som skal rapporteres. De enkelte underfoldere indeholder en fil, der hedder "report.xml". Der oprettes også en særlig folder, som hedder "allNonApiBundles", i denne folder. Den indeholder også en fil med navnet "report.xml". Denne fil indeholder en liste over alle de bundter, der ikke bruger API-værktøjsnaturen. Placeringen angives ved hjælp af en absolut sti. |
Ja |
excludelist |
Angiv placeringen af exclude-listen. Placeringen af exclude-listen angiver en tekstfil med de bundter, der skal udelades fra analysen. Som standard analyseres alle bundterne i profilen. Attributter for include- og exclude-lister kan bruges til selektivt at medtage og udelade bundter. Desuden understøtter opgaven angivelse af medlemmer på include- og exclude-listerne. Include-listen tilfører det bundtsæt og de medlemmer, der skal analyseres (når den ikke angives, medtages alle bundter og medlemmer), og exclude-listen anvendes derefter. Linjerne i filen angiver et af følgende:
Placeringen angives ved hjælp af en absolut sti. Her er et eksempel på en exclude-liste: # ECLIPSE-MEDLEMMER org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object; # DOC-BUNDTER 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 # IKKE-ECLIPSE-BUNDTER com.ibm.icu com.jcraft.jsch javax.servlet javax.servlet.jsp ...Exclude-listen kan indeholde regulære udtryk, hvis linjen starter med "R:". |
Nej |
includelist |
Angiv placeringen af include-listen. Placeringen af include-listen angiver en tekstfil med de bundter, der skal medtages i analysen. Som standard analyseres alle bundterne i profilen. Attributter for include- og exclude-lister kan bruges til selektivt at medtage og udelade bundter. Desuden understøtter opgaven angivelse af medlemmer på include- og exclude-listerne. Include-listen tilfører det bundtsæt og de medlemmer, der skal analyseres (når den ikke angives, medtages alle bundter og medlemmer), og exclude-listen anvendes derefter. Linjerne i filen angiver et af følgende:
Placeringen angives ved hjælp af en absolut sti. Her er et eksempel på en include-liste: # ECLIPSE-MEDLEMMER org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object; # DOC-BUNDTER 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 # IKKE-ECLIPSE-BUNDTER com.ibm.icu com.jcraft.jsch javax.servlet javax.servlet.jsp ... |
Nej |
debug |
Angiv fejlfindingsværdien. Mulige værdier er: true ,
false Standardværdien er false .
|
Nej |
eefile |
Angiv den udførelsesmiljøfil, der skal bruges. Som standard bruges en udførelsesmiljøfil, svarende til et JavaSE-1.6-udførelsesmiljø. Formatet af filen er beskrevet på denne wikiside. Filen angives ved hjælp af en absolut sti. |
Nej |
<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"
/>
Herved køres den opgave, som opretter report.xml
-filer, i folderen D:\reports\xml
. Opgaven bruger exclude-listen til at reducere antallet af problemer, der skal rapporteres.
Da fejlfinding er aktiveret, bliver der vist fejlfindingssporing i Ant-konsollen.
API-opgave: API-frys
Ant-opgave: Generering af fil
API-opgave: API-brug
Ant-opgave: Konvertering af analyserapport
Ant-opgave: Konvertering af API-frysrapport
Ant-opgave: Konvertering af API-brugsrapport
Ant-opgave: Konvertering af API-forældelsesrapport