Définition des restrictions des API

Les utilitaires d'API fournissent des balises Javadoc pour documenter explicitement et restreindre l'utilisation des API. Les tableaux qui suivent résument les balises Javadoc prises en charge par chaque membre et la sémantique de chaque balise.

Un client fait référence à un plug-in ou à un regroupement qui exige le regroupement dans lequel l'API associée est définie. Les restrictions ne s'appliquent pas au regroupement dans lequel l'API est définie. Par exemple, un regroupement qui définit une interface comme @noimplement est également autorisé à fournir une implémentation de cette interface.

Balises de restriction prises en charge

  Classe Interface Méthode Constructeur

Zone finale

Zone non finale
@noimplement
-
Pris en charge
-
-
-
-
@noextend
Pris en charge
Pris en charge
-
-
-
-
@noinstantiate
Pris en charge
-
-
-
-
-
@nooverride
-
-
Pris en charge
-
-
-
@noreference
-
-
Pris en charge
Pris en charge
-
Pris en charge

Sémantique des restrictions

@noimplement

Indique que les clients ne doivent pas implémenter cette interface. Une classe utilisant le mot clé implements pour l'interface associée ou le parent de l'interface associée où il n'existe pas une superclasse d'implémentation déclenchera un incident.

@noextend
Indique que les clients ne doivent pas étendre cette classe ou interface. Une classe ou une interface qui utilise le mot clé extends pour le type associé déclenchera un incident.
@noinstantiate
Indique que les clients ne doivent pas instancier cette classe. Tout code qui instancie la classe associée avec un constructeur déclenchera un incident.
@nooverride
Indique que les clients ne doivent pas déclarer cette méthode une nouvelle fois. Toute sous-classe qui définit une méthode remplaçant la méthode associée déclenchera un incident.
@noreference
Indique que les clients ne doivent pas référencer cette méthode, ce constructeur ou cette zone non finale. Tout code qui appelle directement la méthode ou le constructeur associés, ou fait référence à la zone non finale associée, déclenchera un incident.

Tâches connexes

Configuration d'une référence

Référence connexe

Gestion des balises @since Javadoc
Préférences de référence d'API
Préférences Erreurs/Avertissements d'API