API-beperkingen definiƫren

API-tools bieden Javadoc-tags waarmee het gebruik van een API expliciet kan worden beperkt en gedocumenteerd. In de onderstaande tabellen vindt u een overzicht van de Javadoc-tags die worden ondersteund door elk lid en de semantiek van alle tags.

Een client verwijst naar een plugin of bundel die de bundel nodig heeft waarin de bijbehorende API is gedefinieerd. Beperkingen worden niet toegepast in dezelfde bundel als waarin de API is gedefinieerd. Bijvoorbeeld, een bundel waarin een interface wordt gedefinieerd met @noimplement, heeft tevens de mogelijkheid om een implementatie van die interface te leveren.

Ondersteunde tags voor beperkingen

  Klasse Interface Methode Constructor

Final-veld

Niet-final-veld
@noimplement
-
Ondersteund
-
-
-
-
@noextend
Ondersteund
Ondersteund
-
-
-
-
@noinstantiate
Ondersteund
-
-
-
-
-
@nooverride
-
-
Ondersteund
-
-
-
@noreference
-
-
Ondersteund
Ondersteund
-
Ondersteund

Semantiek voor beperkingen

@noimplement

Geeft aan dat de clients deze interface niet moeten implementeren. Klassen die het sleutelwoord implements gebruiken voor de betreffende interface of het bovenliggende niveau van de interface waar geen implementerende superklasse aanwezig is, worden gemarkeerd met een probleemaanduiding.

@noextend
Geeft aan dat clients deze klasse of interface niet mogen uitbreiden. Klassen of interfaces die het sleutelwoord extends gebruiken voor het betreffende type worden gemarkeerd met een probleemaanduiding.
@noinstantiate
Geeft aan dat clients deze klasse niet mogen instantiƫren. Eventuele code die de betreffende klasse instantieert met een willekeurige constructor, wordt gemarkeerd met een probleemaanduiding.
@nooverride
Geeft aan dat clients deze methode niet opnieuw mogen declareren. Elke subklasse die een methode definieert die de gekoppelde methode uitschakelt, wordt gemarkeerd met een probleemaanduiding.
@noreference
Geeft aan dat clients niet mogen verwijzen naar deze methode, constructor of dit niet-final-veld. Eventuele code die de betreffende methode of constructor oproepen, of verwijzen naar het betreffende niet-final-veld, worden gemarkeerd met een probleemaanduiding.

Verwante taken

Instellen van een basislijn

Verwant naslagmateriaal

Javadoc @since tag Management
API-basislijnvoorkeuren
Voorkeuren voor API-fouten en -waarschuwingen