Η εργασία αυτή εκτελεί πλήρη ανάλυση API ενός προφίλ API σε σχέση με μια γραμμή βάσης - αναζητά μόνο τα μέλη (κλάσεις, πεδία, μεθόδους) που έχουν καταργηθεί ή των οποίων η κατάργηση έχει αναιρεθεί. Το προφίλ αποτελεί την τρέχουσα κατάσταση ενός προϊόντος που βρίσκεται σε στάδιο ανάπτυξης. Γίνεται σύγκριση του προφίλ με μια γραμμή βάσης API για αλλαγές ως προς τα καταργημένα στοιχεία (συνήθως με την προηγούμενη έκδοση του προϊόντος).
Το όνομα της εργασίας Ant είναι: apitooling.apideprecation.
Προκειμένου να χρησιμοποιηθεί, το αρχείο jar apitooling-ant.jar πρέπει να
βρίσκεται στη διαδρομή κλάσεων Ant.
<apitooling.apideprecation
baseline="..."
profile="..."
report="..."
excludelist="..."
includelist="..."
debug="..."
eefile="..."
/>
| Γνώρισμα | Περιγραφή | Απαιτείται |
| baseline |
Αυτό το γνώρισμα καθορίζει τη θέση της γραμμής βάσης παραπομπής. Μπορεί να είναι αρχείο .zip, .jar, .tgz, .tar.gz ή ένας κατάλογος που αντιστοιχεί στο φάκελο εγκατάστασης του Eclipse. Αυτός είναι ο κατάλογος στον οποίο υπάρχει το Eclipse ως εκτελέσιμο αρχείο. Η θέση καθορίζεται με τη χρήση μιας απόλυτης διαδρομής. |
Ναι |
| profile |
Αυτό το γνώρισμα καθορίζει τη θέση του τρέχοντος προϊόντος ή προφίλ, το οποίο θέλετε να συγκρίνετε με τη γραμμή βάσης παραπομπής. Μπορεί να είναι αρχείο .zip, .jar, .tgz, .tar.gz ή ένας κατάλογος που αντιστοιχεί στο φάκελο εγκατάστασης του Eclipse. Αυτός είναι ο κατάλογος στον οποίο υπάρχει το Eclipse ως εκτελέσιμο αρχείο. Η θέση καθορίζεται με τη χρήση μιας απόλυτης διαδρομής. |
Ναι |
| report |
Ορίστε τη θέση εξόδου όπου θα δημιουργηθούν οι αναφορές. Μετά την ολοκλήρωση της εργασίας, οι αναφορές είναι διαθέσιμες σε αυτόν τον κατάλογο με τη χρήση μιας δομής παρόμοιας με τον κεντρικό κατάλογο φίλτρου. Δημιουργείται ένας υποφάκελος για κάθε στοιχείο που παρουσιάζει προβλήματα προς αναφορά. Κάθε υποφάκελος περιέχει ένα αρχείο με το όνομα "report.xml". Ένας ειδικός φάκελος με το όνομα "allNonApiBundles" δημιουργείται σε αυτόν το φάκελο, ο οποίος επίσης περιέχει ένα αρχείο με το όνομα "report.xml". Στο αρχείο εμφανίζονται όλες οι δέσμες που δεν χρησιμοποιούν εργαλεία API. Η θέση καθορίζεται με τη χρήση μιας απόλυτης διαδρομής. |
Ναι |
| excludelist |
Ορίστε τη θέση της λίστας εξαιρέσεων. Η θέση της λίστας εξαιρέσεων καθορίζει ένα αρχείο κειμένου στο οποίο εμφανίζονται οι δέσμες που θα εξαιρεθούν από την ανάλυση. Από προεπιλογή, αναλύονται όλες οι δέσμες του προφίλ. Τα γνωρίσματα λίστας συμπεριλήψεων και εξαιρέσεων μπορούν να χρησιμοποιηθούν για την επιλεκτική συμπερίληψη ή εξαίρεση δεσμών. Επιπλέον, η εργασία υποστηρίζει την καταχώρηση μελών στις λίστες συμπερίληψης και εξαίρεσης. Η λίστα συμπεριλήψεων παρέχει το αρχικό σύνολο με τις δέσμες και τα μέλη που θα αναλυθούν (αν παραλειφθεί, συμπεριλαμβάνονται όλες οι δέσμες και όλα τα μέλη). Στη συνέχεια εφαρμόζεται η λίστα εξαιρέσεων. Κάθε γραμμή του αρχείου καθορίζει ένα από τα εξής:
Η θέση καθορίζεται με τη χρήση μιας απόλυτης διαδρομής. Ακολουθεί ένα παράδειγμα λίστας εξαιρέσεων: # ΜΕΛΗ ECLIPSE org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object; # ΔΕΣΜΕΣ DOC 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 # ΔΕΣΜΕΣ ΕΚΤΟΣ ECLIPSE com.ibm.icu com.jcraft.jsch javax.servlet javax.servlet.jsp ...Η λίστα εξαιρέσεων μπορεί να περιέχει κανονικές εκφράσεις εφόσον η γραμμή αρχίζει με "R:". |
Όχι |
| includelist |
Ορίζει τη θέση της λίστας συμπεριλήψεων. Η θέση της λίστας συμπεριλήψεων καθορίζει ένα αρχείο κειμένου στο οποίο εμφανίζονται οι δέσμες που θα συμπεριληφθούν στην ανάλυση. Από προεπιλογή, αναλύονται όλες οι δέσμες του προφίλ. Τα γνωρίσματα λίστας συμπεριλήψεων και εξαιρέσεων μπορούν να χρησιμοποιηθούν για την επιλεκτική συμπερίληψη ή εξαίρεση δεσμών. Επιπλέον, η εργασία υποστηρίζει την καταχώρηση μελών στις λίστες συμπερίληψης και εξαίρεσης. Η λίστα συμπεριλήψεων παρέχει το αρχικό σύνολο με τις δέσμες και τα μέλη που θα αναλυθούν (αν παραλειφθεί, συμπεριλαμβάνονται όλες οι δέσμες και όλα τα μέλη). Στη συνέχεια εφαρμόζεται η λίστα εξαιρέσεων. Κάθε γραμμή του αρχείου καθορίζει ένα από τα εξής:
Η θέση καθορίζεται με τη χρήση μιας απόλυτης διαδρομής. Ακολουθεί ένα παράδειγμα λίστας συμπεριλήψεων: # ΜΕΛΗ ECLIPSE org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object; # ΔΕΣΜΕΣ DOC 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 # ΔΕΣΜΕΣ ΕΚΤΟΣ ECLIPSE com.ibm.icu com.jcraft.jsch javax.servlet javax.servlet.jsp ... |
Όχι |
| debug |
Ορίστε την τιμή για τον εντοπισμό και τη διόρθωση σφαλμάτων. Οι πιθανές τιμές είναι: true, falseΗ προεπιλεγμένη τιμή είναι false.
|
Όχι |
| eefile |
Ορίστε το αρχείο περιβάλλοντος εκτέλεσης που θα χρησιμοποιηθεί. Από προεπιλογή, χρησιμοποιείται ένα αρχείο περιβάλλοντος εκτέλεσης που αντιστοιχεί σε περιβάλλον εκτέλεσης JavaSE-1.6. Η μορφή του αρχείου περιγράφεται σε αυτή τη σελίδα wiki. Το αρχείο ορίζεται με τη χρήση μιας απόλυτης διαδρομής. |
Όχι |
<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"
/>
Εκτελεί την εργασία που δημιουργεί τα αρχεία report.xml στο φάκελο
D:\reports\xml. Θα χρησιμοποιήσει τη λίστα εξαιρέσεων για να περιορίσει τον αριθμό
των προβλημάτων που θα αναφερθούν.
Εφόσον έχει ενεργοποιηθεί ο εντοπισμός και η διόρθωση σφαλμάτων, θα εμφανιστεί κάποια ρουτίνα ιχνηλασίας εντοπισμού και διόρθωσης σφαλμάτων στην κονσόλα Ant.
Εργασία Ant αναστολής API
Εργασία Ant δημιουργίας αρχείων
Εργασία Ant χρήσης API
Εργασία Ant μετατροπής αναφορών ανάλυσης
Εργασία Ant μετατροπής αναφορών αναστολής API
Εργασία Ant μετατροπής αναφορών χρήσης ΑΡΙ
Εργασία Ant μετατροπής αναφορών κατάργησης API