API-Einschränkungen definieren

API-Tools stellen Javadoc-Tags zur Verfügung, um die Verwendung von API explizit zu dokumentieren und zu beschränken. In den folgenden Tabellen werden die Javadoc-Tags, die von jedem Member unterstützt werden, und die Semantik eines jeden Tags zusammengefasst.

Ein Client bezieht sich auf ein Plug-in oder Paket, das das Paket erfordert, in dem die zugehörige API definiert ist. Einschränkung werden nicht in demselben Paket angewendet, in dem die API definiert ist. Beispielsweise kann ein Paket, das eine Schnittstelle als '@noimplement' definiert, auch eine Implementierung dieser Schnittstelle zur Verfügung stellen.

Unterstützte Einschränkungs-Tags

  Klasse Schnittstelle Methode Konstruktor

Finales Feld

Nicht finales Feld
@noimplement
-
Unterstützte Breite
-
-
-
-
@noextend
Unterstützte Breite
Unterstützte Breite
-
-
-
-
@noinstantiate
Unterstützte Breite
-
-
-
-
-
@nooverride
-
-
Unterstützte Breite
-
-
-
@noreference
-
-
Unterstützte Breite
Unterstützte Breite
-
Unterstützte Breite

Einschränkungssemantik

@noimplement

Gibt an, dass Clients diese Schnittstelle nicht implementieren dürfen. Jede Klasse, die das Schlüsselwort implements (implementiert) für die zugehörige Schnittstelle oder das übergeordnete Element der zugehörigen Schnittstelle ohne implementierende Superklasse verwendet, wird mit einem Fehler markiert.

@noextend
Gibt an, dass Clients diese Klasse oder Schnittstelle nicht erweitern dürfen. Jede Klasse oder Schnittstelle, die das Schlüsselwort extends (erweitert) für den zugehörigen Typ verwendet, wird mit einem Fehler markiert.
@noinstantiate
Gibt an, dass Clients diese Klasse nicht instanziieren dürfen. Jeder Code, der die zugehörige Klasse mit einem Konstruktor instanziiert, wird mit einem Fehler markiert.
@nooverride
Gibt an, dass Clients diese Klasse nicht erneut deklarieren dürfen. Jede Unterklasse, die eine Methode definiert, die die zugeordnete Methode überschreibt, wird mit einem Fehler markiert.
@noreference
Gibt an, dass Clients nicht auf diese Methode, diesen Konstruktor oder dieses nicht finale Feld verweisen dürfen. Jeder Code, der direkt die zugehörige Methode oder den zugehörigen Konstruktor aufruft oder auf das zugehörige nicht finale Feld verweist, wird mit einem Fehler markiert.

Zugehörige Tasks

Referenzkonfiguration einrichten

Zugehörige Referenzinformationen

Verwaltung von Javadoc-Tags '@since'
Benutzervorgaben API-Referenzkonfiguration
Benutzervorgaben API-Fehler und Warnungen