Definiowanie ograniczeń interfejsu API

Narzędzia interfejsu API udostępniają znaczniki dokumentacji Javadoc umożliwiające jawne dokumentowanie i ograniczanie użycia interfejsu API. W następujących tabelach przedstawiono podsumowanie znaczników dokumentacji Javadoc obsługiwanych przez poszczególne elementy oraz semantykę każdego znacznika.

Termin klient oznacza wtyczkę lub pakunek wymagający pakunku z definicją powiązanego interfejsu API. Ograniczenia nie mają zastosowania w tym pakunku, w którym zdefiniowano interfejs API. Na przykład pakunek, który definiuje interfejs jako @noimplement, może też udostępniać implementację tego interfejsu.

Obsługiwane znaczniki ograniczeń

  Klasa Interfejs Metoda Konstruktor

Pole final

Pole inne niż final
@noimplement
-
Obsługiwany
-
-
-
-
@noextend
Obsługiwany
Obsługiwany
-
-
-
-
@noinstantiate
Obsługiwany
-
-
-
-
-
@nooverride
-
-
Obsługiwany
-
-
-
@noreference
-
-
Obsługiwany
Obsługiwany
-
Obsługiwany

Semantyka ograniczeń

@noimplement

Wskazuje, że klientom nie wolno implementować tego interfejsu. Dowolna klasa korzystająca ze słowa kluczowego implements dla powiązanego interfejsu lub elementu nadrzędnego powiązanego interfejsu, w których nie ma implementującej nadklasy, zostanie oznaczona flagą problemu.

@noextend
Wskazuje, że klientom nie wolno rozszerzać tej klasy lub interfejsu. Każda klasa lub interfejs korzystające ze słowa kluczowego extends dla powiązanego typu zostanie oznaczona flagą problemu.
@noinstantiate
Wskazuje, że klientom nie wolno tworzyć instancji tej klasy. Dowolny kod tworzący instancje powiązanej klasy przy użyciu dowolnego konstruktora zostanie oznaczony flagą problemu.
@nooverride
Wskazuje, że klientom nie wolno ponownie deklarować tej metody. Każda podklasa, która definiuje metodę przesłaniającą powiązaną metodę, zostanie oznaczona flagą problemu.
@noreference
Wskazuje, że klientom nie wolno przywoływać tej metody, konstruktora ani pola innego niż final. Dowolny kod, który bezpośrednio wywołuje powiązaną metodę lub konstruktor albo przywołuje powiązane pole inne niż final, zostanie oznaczone flagą problemu.

Czynności pokrewne

Konfigurowanie wersji bazowej

Informacje pokrewne

Zarządzanie znacznikami @since dokumentacji Javadoc
Preferencje wersji bazowych interfejsu API
Preferencje błędów i ostrzeżeń interfejsu API