Εργασία Ant αναστολής API

Σκοπός

Η εργασία αυτή προσδιορίζει τα API που έχουν προστεθεί, τροποποιηθεί ή αφαιρεθεί από μια γραμμή βάσης API. Η εργασία αυτή χρησιμοποιείται για να διασφαλιστεί ότι δεν παρουσιάζονται αλλαγές API μετά από μια αναστολή API.

Χρήση

Περιγραφή

Το όνομα της εργασίας Ant είναι: apitooling.apifreeze. Προκειμένου να χρησιμοποιηθεί, το αρχείο jar apitooling-ant.jar πρέπει να βρίσκεται στην ίδια διαδρομή κλάσεων Ant.

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

Παράμετροι

Γνώρισμα Περιγραφή Απαιτείται
baseline Αυτό το γνώρισμα καθορίζει τη θέση της γραμμής βάσης παραπομπής.

Μπορεί να είναι αρχείο .zip, .jar, .tgz, .tar.gz ή ένας κατάλογος που αντιστοιχεί στο φάκελο εγκατάστασης του Eclipse. Αυτός είναι ο κατάλογος στον οποίο υπάρχει το Eclipse ως εκτελέσιμο αρχείο.

Η θέση καθορίζεται με τη χρήση μιας απόλυτης διαδρομής.
Ναι
profile Αυτό το γνώρισμα καθορίζει τη θέση του τρέχοντος προϊόντος ή προφίλ, το οποίο θέλετε να συγκρίνετε με τη γραμμή βάσης παραπομπής.

Μπορεί να είναι αρχείο .zip, .jar, .tgz, .tar.gz ή ένας κατάλογος που αντιστοιχεί στο φάκελο εγκατάστασης του Eclipse. Αυτός είναι ο κατάλογος στον οποίο υπάρχει το Eclipse ως εκτελέσιμο αρχείο.

Η θέση καθορίζεται με τη χρήση μιας απόλυτης διαδρομής.
Ναι
report Ορίστε το όνομα του αρχείου αναφοράς προς δημιουργία.

Πρέπει να οριστεί με τη χρήση μιας απόλυτης διαδρομής.
Πρέπει να είναι θέση αρχείου και όχι κατάλογος.
Ναι
excludelist Ορίστε τη θέση της λίστας εξαιρέσεων.

Η θέση της λίστας εξαιρέσεων καθορίζει ένα αρχείο κειμένου στο οποίο εμφανίζονται οι δέσμες που θα εξαιρεθούν από την ανάλυση. Από προεπιλογή, αναλύονται όλες οι δέσμες του προφίλ. Τα γνωρίσματα λίστας συμπεριλήψεων και εξαιρέσεων μπορούν να χρησιμοποιηθούν για την επιλεκτική συμπερίληψη ή εξαίρεση δεσμών. Επιπλέον, η εργασία υποστηρίζει την καταχώρηση μελών στις λίστες συμπερίληψης και εξαίρεσης. Η λίστα συμπεριλήψεων παρέχει το αρχικό σύνολο με τις δέσμες και τα μέλη που θα αναλυθούν (αν παραλειφθεί, συμπεριλαμβάνονται όλες οι δέσμες και όλα τα μέλη). Στη συνέχεια εφαρμόζεται η λίστα εξαιρέσεων. Κάθε γραμμή του αρχείου καθορίζει ένα από τα εξής:
  • ένα όνομα δέσμης
  • ένα όνομα μέλους
  • μια κανονική έκφραση για την αναζήτηση ονομάτων δεσμών ή μελών (γραμμές που αρχίζουν με "R:")
  • ένα σχόλιο (γραμμές που αρχίζουν με '#')

Η θέση καθορίζεται με τη χρήση μιας απόλυτης διαδρομής.
Ακολουθεί ένα παράδειγμα λίστας εξαιρέσεων:
# 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\..*
...
Όχι
includelist Ορίζει τη θέση της λίστας συμπεριλήψεων.

Η θέση της λίστας συμπεριλήψεων καθορίζει ένα αρχείο κειμένου στο οποίο εμφανίζονται οι δέσμες που θα συμπεριληφθούν στην ανάλυση. Από προεπιλογή, αναλύονται όλες οι δέσμες του προφίλ. Τα γνωρίσματα λίστας συμπεριλήψεων και εξαιρέσεων μπορούν να χρησιμοποιηθούν για την επιλεκτική συμπερίληψη ή εξαίρεση δεσμών. Επιπλέον, η εργασία υποστηρίζει την καταχώρηση μελών στις λίστες συμπερίληψης και εξαίρεσης. Η λίστα συμπεριλήψεων παρέχει το αρχικό σύνολο με τις δέσμες και τα μέλη που θα αναλυθούν (αν παραλειφθεί, συμπεριλαμβάνονται όλες οι δέσμες και όλα τα μέλη). Στη συνέχεια εφαρμόζεται η λίστα εξαιρέσεων. Κάθε γραμμή του αρχείου καθορίζει ένα από τα εξής:
  • ένα όνομα δέσμης
  • ένα όνομα μέλους
  • μια κανονική έκφραση για την αναζήτηση ονομάτων δεσμών ή μελών (γραμμές που αρχίζουν με "R:")
  • ένα σχόλιο (γραμμές που αρχίζουν με '#')

Η θέση καθορίζεται με τη χρήση μιας απόλυτης διαδρομής.
Ακολουθεί ένα παράδειγμα λίστας συμπεριλήψεων:
# 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\..*
...
Όχι
debug Ορίστε την τιμή για τον εντοπισμό και τη διόρθωση σφαλμάτων.

Οι πιθανές τιμές είναι: true, false
Η προεπιλεγμένη τιμή είναι false.
Όχι
eefile Ορίστε το αρχείο περιβάλλοντος εκτέλεσης που θα χρησιμοποιηθεί.

Από προεπιλογή, χρησιμοποιείται ένα αρχείο περιβάλλοντος εκτέλεσης που αντιστοιχεί σε περιβάλλον εκτέλεσης JavaSE-1.6.

Η μορφή του αρχείου περιγράφεται σε αυτή τη σελίδα wiki.

Το αρχείο ορίζεται με τη χρήση μιας απόλυτης διαδρομής.
Όχι

Παραδείγματα

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

Εκτελεί την εργασία που δημιουργεί το αρχείο report.xml στο φάκελο D:\report. Θα χρησιμοποιήσει τη λίστα εξαιρέσεων D:\exclude_list_external.txt για τη μείωση του αριθμού των προβλημάτων στην αναφορά.

Εφόσον έχει ενεργοποιηθεί ο εντοπισμός και η διόρθωση σφαλμάτων, θα εμφανιστεί κάποια ρουτίνα ιχνηλασίας εντοπισμού και διόρθωσης σφαλμάτων στην κονσόλα Ant.

Σχετικές παραπομπές

Εργασία Ant ανάλυσης
Εργασία Ant δημιουργίας αρχείων
Εργασία Ant χρήσης API
Εργασία Ant μετατροπής αναφορών ανάλυσης
Εργασία Ant μετατροπής αναφορών αναστολής API
Εργασία Ant κατάργησης ΑΡΙ
Εργασία Ant μετατροπής αναφορών κατάργησης API
Εργασία Ant μετατροπής αναφορών χρήσης ΑΡΙ