API korlátozások meghatározása

Az API eszközkészlet Javadoc címkéket biztosít az API használat explicit dokumentálásához és korlátozásához. A következő táblázat összefoglalja az egyes tagok által támogatott Javadoc címkéket és az egyes tagok szemantikáját.

Az ügyfél egy bedolgozóra vagy kötegre vonatkozik, amely megköveteli azt a köteget, amelyben a társított API meg van határozva. A korlátozások nem kerülnek alkalmazásra abban a kötegben, amelyben az API meg van határozva. Például egy köteg számára, amely @noimplement címkével határoz meg egy felületet, engedélyezve van, hogy biztosítson egy megvalósítást az adott felülethez.

Támogatott korlátozási címkék

  Osztály Felület Metódus Konstruktor

Végleges mező

Nem végleges mező
@noimplement
-
Támogatott
-
-
-
-
@noextend
Támogatott
Támogatott
-
-
-
-
@noinstantiate
Támogatott
-
-
-
-
-
@nooverride
-
-
Támogatott
-
-
-
@noreference
-
-
Támogatott
Támogatott
-
Támogatott

Korlátozás szemantikája

@noimplement

Azt jelöli, hogy az ügyfelek nem valósíthatják meg ezt a felületet. Bármely osztály, amely használja az implements kulcsszót a társított felülethez vagy a társított felület szülőjéhez, ahol nincs megvalósító ősosztály, problémaként lesz megjelölve.

@noextend
Azt jelöli, hogy az ügyfelek nem terjeszthetik ki ezt az osztályt vagy felületet. Bármely osztály vagy felület, amely használja az extends kulcsszót a társított típushoz, problémaként lesz megjelölve.
@noinstantiate
Azt jelöli, hogy az ügyfelek nem példányosíthatják ezt az osztályt. Bármely kód, amely példányosítja a kérdéses osztályt bármilyen konstruktorral, problémaként lesz megjelölve.
@nooverride
Azt jelöli, hogy az ügyfelek nem deklarálhatják újra ezt a metódust. Bármely osztály, amely a társított metódust újradefiniáló metódust határoz meg, problémaként lesz megjelölve.
@noreference
Azt jelöli, hogy az ügyfelek nem hivatkozhatnak erre a metódusra, konstruktorra vagy nem végleges mezőre. Bármely kód, amely közvetlenül hívja meg a kérdéses metódust vagy konstruktort, vagy hivatkozik a kérdéses nem végleges mezőre, problémaként lesz megjelölve.

Kapcsolódó feladatok

Alapsor beállítása

Kapcsolódó leírások

Javadoc @since címke kezelése
API alapsor beállítások
API hibák és figyelmeztetések beállításai