Definér API-begrænsninger

API-værktøjer indeholder Javadoc-koder, som eksplicit dokumenterer og begrænser brugen af API. I de følgende tabeller vises de Javadoc-koder, der understøttes af de enkelte medlemmer, og semantikken for hver kode.

En klient henviser til en plugin eller et bundt, som kræver bundtet dér, hvor det tilknyttede API er defineret. Begrænsninger anvendes ikke i det samme bundt, som hvor API'et er defineret. F.eks. kan et bundt, der definerer en grænseflade som @noimplement, også levere en implementering af den pågældende grænseflade.

Understøttede begrænsningskoder

  Klasse Grænseflade Metode Konstruktør

'Final' felt

Ikke-'final' felt
@noimplement
-
Understøttes
-
-
-
-
@noextend
Understøttes
Understøttes
-
-
-
-
@noinstantiate
Understøttes
-
-
-
-
-
@nooverride
-
-
Understøttes
-
-
-
@noreference
-
-
Understøttes
Understøttes
-
Understøttes

Begrænsningssemantik

@noimplement

Angiver, at klienter ikke må implementere denne grænseflade. En klasse, der anvender nøgleordet implements til den tilknyttede grænseflade eller overordnede for den tilknyttede grænseflade, når der ikke er nogen implementerende superklasse, markeres med et problem.

@noextend
Angiver, at klienter ikke må udvide denne klasse eller grænseflade. En klasse eller grænseflade, der anvender nøgleordet extends til den tilknyttede type, markeres med et problem.
@noinstantiate
Angiver, at klienter ikke må oprette en forekomst af denne klasse. En kode, der opretter en forekomst af den tilknyttede klasse med en vilkårlig konstruktør, markeres med et problem.
@nooverride
Angiver, at klienter ikke må erklære denne metode igen. En underklasse, der definerer en metode, som tilsidesætter den tilknyttede metode, markeres med et problem.
@noreference
Angiver, at klienter ikke må henvise til denne metode, konstruktør eller ikke-final felt. En kode, der direkte aktiverer den tilknyttede metode eller konstruktør eller henviser til det tilknyttede ikke-'final' felt, markeres med et problem.

Relaterede opgaver

Konfigurér en grundlinje

Relaterede referencer

Administraiton af @since-kode i Javadoc
API-grundlinjeindstillinger
Indstillinger for API-fejl og -advarsler