Definiera API-begränsningar

API-verktygen tillhandahåller Javadoc-märkord för explicit dokumentation och begränsning av användningen av APIt. Följande tabeller sammanfattar de Javadoc-märkord som hanteras av varje medlem och semantiken för varje märkord.

En klient refererar till ett insticksprogram eller ett samlingspaket som kräver det samlingspaket där det associerade APIt är definierat. Begränsningar tillämpas inte i samma samlingspaket där APIt är definierat. Ett exempel: ett samlingspaket som definierar ett gränssnitt där @noimplement även tillåts tillhandahålla implementeringen av det gränssnittet.

Begränsningsmärkord som kan användas

  Klass Gränssnitt Metod Konstruktor

Slutlig fält

Icke-slutligt fält
@noimplement
-
Hanteras
-
-
-
-
@noextend
Hanteras
Hanteras
-
-
-
-
@noinstantiate
Hanteras
-
-
-
-
-
@nooverride
-
-
Hanteras
-
-
-
@noreference
-
-
Hanteras
Hanteras
-
Hanteras

Begränsningssemantik

@noimplement

Ange att klienter inte behöver implementera det här gränssnittet. Alla klasser som använder nyckelordet implements för det associerade gränssnittet eller det överordnade objektet för det associerade gränssnittet och där det inte finns någon implementerande superklass flaggas med ett problem.

@noextend
Anger att klienterna inte behöver utöka den här klassen eller gränsnittet. Alla klasser eller gränsnitt som använder nyckelordet extends för den associerade typen flaggas med ett problem.
@noinstantiate
Anger att klienter inte behöver instansiera den här klassen. Alla koder som instansierar den associerade klassen med en konstruktor flaggas med ett problem.
@nooverride
Ange att klienter inte behöver deklarera den här metoden. Alla underklasser som definierar en metod som åsidosätter den associerade metoden flaggas med ett problem.
@noreference
Anger att klienter inte behöver referera till den här metoden, konstruktorn eller icke-slutliga fältet. All kod som direkt anropar den associerade metoden eller konstruktor eller refererar till det associerade icke-slutliga fältet flaggas med ett problem.

Närliggande uppgifter

Konfigurera en basnivå

Närliggande referenser

Hantering av Javadoc-märkordet @since
Inställningar för API-basnivåer
Inställningar för API-fel och -varningar