Ορισμός περιορισμών API

Τα εργαλεία API παρέχουν προσδιοριστικά Javadoc για τη ρητή τεκμηρίωση και τον περιορισμό της χρήσης του API. Οι ακόλουθοι πίνακες συνοψίζουν τα προσδιοριστικά Javadoc που υποστηρίζονται από κάθε μέλος και τη σημασιολογία κάθε προσδιοριστικού.

Ένας πελάτης παραπέμπει σε μια πρόσθετη λειτουργία ή δέσμη που απαιτεί τη δέσμη όπου ορίζεται το συσχετισμένο API. Οι περιορισμοί δεν εφαρμόζονται στην ίδια δέσμη όπου ορίζεται το API. Για παράδειγμα, μια δέσμη που ορίζει μια διεπαφή ως @noimplement, μπορεί να παράσχει μια υλοποίηση αυτής της διεπαφής.

Υποστηριζόμενα προσδιοριστικά περιορισμού

  Κλάση Διεπαφή Μέθοδος Λειτουργία κατασκευής

Τελικό πεδίο

Μη τελικό πεδίο
@noimplement
-
Υποστηρίζεται
-
-
-
-
@noextend
Υποστηρίζεται
Υποστηρίζεται
-
-
-
-
@noinstantiate
Υποστηρίζεται
-
-
-
-
-
@nooverride
-
-
Υποστηρίζεται
-
-
-
@noreference
-
-
Υποστηρίζεται
Υποστηρίζεται
-
Υποστηρίζεται

Σημασιολογία περιορισμού

@noimplement

Δηλώνει ότι οι πελάτες δεν πρέπει να υλοποιήσουν αυτήν τη διεπαφή. Οποιαδήποτε κλάση που χρησιμοποιεί τη λέξη-κλειδί implements για τη συσχετισμένη διεπαφή ή το γονικό στοιχείο της συσχετισμένης διεπαφής, όπου δεν υπάρχει υπερκλάση υλοποίησης θα επισημαίνεται με πρόβλημα.

@noextend
Δηλώνει ότι οι πελάτες δεν πρέπει να επεκτείνουν αυτήν την κλάση ή τη διεπαφή. Οποιαδήποτε κλάση ή διεπαφή που χρησιμοποιεί τη λέξη-κλειδί extends για το συσχετιζόμενο είδος θα επισημαίνεται με πρόβλημα.
@noinstantiate
Δηλώνει ότι οι πελάτες δεν πρέπει να δημιουργούν χρήση αυτής της κλάσης. Οποιοσδήποτε κώδικας που δημιουργεί χρήση της συσχετισμένης κλάσης με οποιαδήποτε λειτουργία κατασκευής θα επισημαίνεται με ένα πρόβλημα.
@nooverride
Δηλώνει ότι οι πελάτες δεν πρέπει να επαναδηλώνουν αυτήν τη μέθοδο. Οποιαδήποτε υπο-κλάση που ορίζει μια μέθοδο που αντικαθιστά τη συσχετισμένη μέθοδο θα επισημαίνεται με πρόβλημα.
@noreference
Δηλώνει ότι οι πελάτες δεν πρέπει να παραπέμπουν αυτήν τη μέθοδο, τη λειτουργία κατασκευής ή το μη τελικό πεδίο. Οποιοσδήποτε κώδικας που καλεί απευθείας τη συσχετισμένη μέθοδο ή λειτουργία κατασκευής, ή παραπέμπει στο συσχετισμένο μη τελικό πεδίο, θα επισημαίνεται με ένα πρόβλημα.

Σχετικές εργασίες

Ρύθμιση γραμμής βάσης

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

Διαχείριση προσδιοριστικού Javadoc @since
Προτιμήσεις γραμμών βάσης API
Προτιμήσεις σφαλμάτων και προειδοποιήσεων API