Definování omezení API

Modul API Tools poskytuje značky dokumentace Javadoc pro explicitní dokumentaci a omezení použití rozhraní API. Následující tabulky shrnují značky dokumentace Javadoc, které jsou jednotlivými členy podporovány, a jejich sémantiku.

Klientem se rozumí modul plug-in nebo balík, který vyžaduje balík, kde je přidružené rozhraní API definováno. Omezení se nepoužijí na stejný balík, v němž je rozhraní API definováno. Například balík, který definuje rozhraní jako @noimplement, má rovněž povoleno poskytnout implementaci tohoto rozhraní.

Podporované značky omezení

  Třída Rozhraní Metoda Konstruktor

Finální pole

Nefinální pole
@noimplement
-
Podporováno
-
-
-
-
@noextend
Podporováno
Podporováno
-
-
-
-
@noinstantiate
Podporováno
-
-
-
-
-
@nooverride
-
-
Podporováno
-
-
-
@noreference
-
-
Podporováno
Podporováno
-
Podporováno

Sémantika omezení

@noimplement

Označuje, že klienti nesmějí implementovat toto rozhraní. Jakékoli třídy, které používají klíčové slovo implements s přidruženým rozhraním nebo s nadřízeným rozhraním přidruženého rozhraní, přičemž neexistuje implementující supertřída, budou opatřeny příznakem problému.

@noextend
Označuje, že klienti nesmějí rozšiřovat tuto třídu nebo rozhraní. Jakékoli třídy nebo rozhraní, které používají klíčové slovo extends s přidruženým typem, budou opatřeny příznakem problému.
@noinstantiate
Označuje, že klienti nesmějí vytvořit instanci této třídy. Veškerý kód, který vytváří instanci přidružené třídy libovolným konstruktorem, bude opatřen příznakem problému.
@nooverride
Označuje, že klienti nesmějí redeklarovat tuto metodu. Jakákoli podtřída definující metodu, která potlačuje přidruženou metodu, bude opatřena příznakem problému.
@noreference
Označuje, že klienti nesmějí odkazovat na tuto metodu, konstruktor nebo nefinální pole. Jakýkoli kód, který přímo vyvolává přidruženou metodu nebo konstruktor, nebo který odkazuje na přidružené nefinální pole, bude opatřen příznakem problému.

Související úlohy

Nastavení úrovně baseline

Související odkazy

Správa značek Javadoc @since
Předvolby úrovní baseline rozhraní API
Předvolby chyb a varování API