Εργασία Ant μετάβασης χρήσης API

Σκοπός

Αυτή η εργασία παίρνει μία δεδομένη ανίχνευση χρήσης API και προσπαθεί να την αναλύσει εκ νέου στο πλαίσιο έκδοσης υποψήφιου προϊόντος και αναφέρει όποια παραπομπή δεν αναλύθηκε.

Χρήση

Περιγραφή

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

 <apitooling.apimigration
	candidate="..."
	usescan="..."
	scopepattern="..."
	referencepattern="..."
	excludelist="..."
	includelist="..."
	report="..."
		debug="..."
 />

Παράμετροι

Γνώρισμα Περιγραφή Απαιτείται
υποψήφιος Αυτό το γνώρισμα περιγράφει το προϊόν που επιθυμείτε να χρησιμοποιήσετε ως υποψήφιο μετάβασης.

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

Ναι
usescan Αυτό το γνώρισμα περιγράφει την ανίχνευση χρήσης προϊόντος που επιθυμείτε να συγκρίνετε με τον υποψήφιο μετάβασης.

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

Το μοτίβο πρέπει να είναι μια κανονική έκφραση με έγκυρη μορφή, όπως ορίζεται εδώ.
Όχι
referencepattern Καθορίζει το μοτίβο κανονικής έκφρασης που χρησιμοποιείται για τη δόμηση της εμβέλειας των στοιχείων από τα οποία αναζητούνται παραπομπές στη θέση του προϊόντος.

Το μοτίβο πρέπει να είναι μια κανονική έκφραση με έγκυρη μορφή, όπως ορίζεται εδώ.
Όχι
excludelist Ορίστε τη θέση της λίστας εξαιρέσεων.

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

Η θέση καθορίζεται με τη χρήση μιας απόλυτης διαδρομής.
Ακολουθεί ένα παράδειγμα λίστας εξαιρέσεων:
# EXCLUDED BUNDLES
R:org\.eclipse\..*\.doc\..*
...
Όχι
includelist Ορίζει τη θέση της λίστας συμπεριλήψεων.

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

Η θέση καθορίζεται με τη χρήση μιας απόλυτης διαδρομής.
Ακολουθεί ένα παράδειγμα λίστας συμπεριλήψεων:
# INCLUDED BUNDLES
R:org\.eclipse\..*
...
Όχι
report Ορίστε τη θέση εξόδου όπου θα δημιουργηθούν οι αναφορές.

Μετά την ολοκλήρωση της εργασίας, οι αναφορές είναι διαθέσιμες σε αυτόν τον κατάλογο με τη χρήση μιας ιεραρχικής δομής. Δημιουργείται ένας υποφάκελος για κάθε στοιχείο που διαθέτει άλλη δέσμη και παραπέμπει σε αυτό. Κάθε υποφάκελος περιέχει ένα αρχείο με το όνομα "[bundlename].xml". Σε αυτόν το φάκελο βρίσκεται ένας υποφάκελος (με το όνομα "[referencing bundle name].xml") για κάθε δέσμη η οποία παραπέμπει στη δέσμη του περιλαμβανομένου φακέλου. Στο φάκελο δεσμών παραπομπής, βρίσκεται ένας από τρεις υποφακέλους (API, PRIVATE ή OTHER) ο οποίος περιλαμβάνει παραπομπές ειδών, μεθόδων ή πεδίων.

Γίνεται εγγραφή άλλων δυο ειδικών αρχείων στον κατάλογο αναφορών, τα οποία δεν είναι αρχεία "not_searched.xml" και "no_apidescription.xml" και περιλαμβάνουν πληροφορίες σχετικά με τις δέσμες από τη γραμμή βάσης, στα οποία δεν έγινε αναζήτηση για πληροφορίες χρήσης και όσα δεν περιείχαν αρχείο .api_description αντίστοιχα.

Η θέση καθορίζεται με τη χρήση μιας απόλυτης διαδρομής.

Για παράδειγμα:
  root
   |
   +-- "not_searched.xml"
   +-- "no_apidescription.xml"
   +-- όνομα δέσμης με χρήση
     |
     +--όνομα δέσμης με παραπομπή
      |
      +-- [API ή PRIVATE ή OTHER]
       |
       +--[type_ ή method_ ή field_]references.xml
Ναι
debug Ορίστε την τιμή για τον εντοπισμό και τη διόρθωση σφαλμάτων.

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

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

 <apitooling.apimigration
  candidate="/eclipse/sdk3.5"
  usescan="/eclipse/scans/sdk3.4"

  scopepattern=".*"
  referencepattern="org\.eclipse.*"
  excludelist="D:\exclude_list_external.txt"
  report="/eclipse/apimigration/xml"
  debug="true"

 />

Εκτελεί την εργασία που δημιουργεί τα αρχεία *.xml στο φάκελο /eclipse/apimigration/xml. Η εργασία θα αναλύσει εκ νέου όλες τις παραπομπές στη θέση του usescan - που ορίζεται από την κανονική έκφραση .* - έναντι του υποψήφιου προϊόντος του οποίου η ταυτότητα ξεκινά με org.eclipse (όπως ορίζεται από την κανονική έκφραση org\.eclipse.*). Θα χρησιμοποιήσει το αρχείο λίστας εξαιρέσεων D:\exclude_list_external.txt για τη μείωση του αριθμού των προβλημάτων προς αναφορά.

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

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

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