Definere API-begrensninger

API-verktøy har Javadoc-koder som eksplisitt dokumenterer og begrenser API-bruken. Tabellene nedenfor oppsummerer Javadoc-kodene som støttes av hvert medlem, og semantikken for hver kode.

En klient refererer til en plugin-modul eller bunt som krever bunten der den tilknyttede APIen er definert. Begrensninger gjelder ikke for bunten der APIen er definert. For eksempel vil en bunt som definerer et grensesnitt som @noimplement, også ha lov til å levere en implementering av dette grensesnittet.

Støttede begrensningskoder

  Klasse Grensesnitt Metode Konstruktør

Endelig felt

Ikke-endelig felt
@noimplement
-
Støttes
-
-
-
-
@noextend
Støttes
Støttes
-
-
-
-
@noinstantiate
Støttes
-
-
-
-
-
@nooverride
-
-
Støttes
-
-
-
@noreference
-
-
Støttes
Støttes
-
Støttes

Begrensningssemantikk

@noimplement

Angir at klienter ikke må implementere dette grensesnittet. En klasse som bruker nøkkelordet implements for det tilknyttede grensesnittet eller det overordnede til det tilknyttede grensesnittet når det ikke finnes noen implementerende superklasse, blir flagget med et problem.

@noextend
Angir at klienter ikke må utvide denne klassen eller dette grensesnittet. En klasse eller et grensesnitt som bruker nøkkelordet extends for den tilknyttede typen, blir flagget med et problem.
@noinstantiate
Angir at klienter ikke må opprette forekomster av denne klassen. Kode som oppretter forekomster av den tilknyttede klassen med en konstruktør, blir flagget med et problem.
@nooverride
Angir at klienter ikke behøver å deklarere denne metoden igjen. En subklasse som definerer en metode som overstyrer den tilknyttede metoden, blir flagget med et problem.
@noreference
Angir at klienter ikke må referere til denne metoden, denne konstruktøren eller dette ikke-endelige feltet. En kode som direkte aktiverer den tilknyttede metoden eller konstruktøren, eller som refererer til det tilknyttede ikke-endelige feltet, blir flagget med et problem.

Beslektede oppgaver

Konfigurere en basis

Beslektet referanse

Styring av @since-koder i Javadoc
Preferanser for API-basis
Preferanser for API-feil og -advarsler