CKTIS / Java
Annotationstypen — @interface
Eine @interface-Deklaration definiert einen Annotationstyp, also Metadaten, die an Code angefügt werden. Elemente beschreiben die Daten der Annotation; Meta-Annotationen steuern zulässige Stellen, Aufbewahrung, Wiederholbarkeit und Vererbung.
Version: Java SE 21; repository runtime, production runtime not attested
Syntax
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.CONSTRUCTOR})
@interface Label {
String value();
int priority() default 0;
}@interface definiert einen Annotationstyp. Ein Element wie String value(); ist eine parameterlose Methode ohne Rumpf. Zulässige Typen sind primitive Typen, String, Class, Enums, Annotationstypen und eindimensionale Arrays davon; der Wert darf nicht null sein. Ein Element ohne default ist erforderlich. @Label("demo") ist eine Kurzform für @Label(value = "demo"), wenn die übrigen Elemente Standardwerte haben.
@Retention legt fest, wie lange Metadaten erhalten bleiben: RetentionPolicy.SOURCE bedeutet, dass der Compiler sie verwirft; RetentionPolicy.CLASS bedeutet, dass sie in der Klassendatei gespeichert werden, ohne dass ihre Verfügbarkeit per Reflection garantiert ist; RetentionPolicy.RUNTIME bedeutet, dass sie auch zur Laufzeit erhalten bleiben. Ob sie per Reflection ausgelesen werden können, hängt jedoch davon ab, wo die Annotation verwendet wird. Beispielsweise kann eine Annotation mit RetentionPolicy.RUNTIME, die sich auf die Verwendung eines Typs in einem Cast bezieht, in der Klassendatei gespeichert werden. Die Standard-Reflection-API von Java SE 21 stellt sie aber nicht bereit. Deklarationsannotationen für lokale Variablen oder Parameter von Lambda-Ausdrücken werden selbst mit RetentionPolicy.RUNTIME nicht in der Klassendatei gespeichert. Ohne @Retention gilt RetentionPolicy.CLASS. Eine Annotation führt selbst keine Logik aus: Ein Werkzeug oder Code muss sie interpretieren.
@Target schränkt die zulässigen Stellen ein. ElementType.TYPE umfasst Deklarationen von Klassen, Interfaces, Enums und Records; ElementType.FIELD umfasst Felder, einschließlich Enum-Konstanten; ElementType.METHOD umfasst Methoden; ElementType.CONSTRUCTOR umfasst Konstruktoren. ElementType.TYPE bedeutet nicht beliebige Verwendungen eines Typs: Dafür ist ElementType.TYPE_USE vorgesehen.
@Repeatable gibt einen Container an, der wiederholte Annotationen desselben Typs ermöglicht. Der Container deklariert value(), das ein Array des wiederholten Typs zurückgibt, und seine übrigen Elemente müssen Standardwerte haben. Außerdem muss er die Kompatibilitätsregeln der JLS für Aufbewahrung, Ziele und Meta-Annotationen erfüllen.
@Inherited ermöglicht es geeigneten Reflection-Abfragen nach Klassenannotationen, auch Oberklassen zu durchsuchen. Es überträgt Annotationen weder von implementierten Interfaces noch bewirkt es, dass Annotationen auf Methoden, Feldern oder Konstruktoren vererbt werden. Das Beispiel zeigt vier zulässige Ziele und liest einen ausdrücklich angegebenen sowie einen Standardwert aus.
Beispiele
import java.lang.annotation.*;
public class Main {
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.FIELD,
ElementType.METHOD, ElementType.CONSTRUCTOR})
public @interface Label {
String value();
int priority() default 0;
}
@Label("demo")
static class Item {
@Label("id")
int id;
@Label("create")
Item() {}
@Label(value = "read", priority = 2)
void read() {}
}
public static void main(String[] args) throws ReflectiveOperationException {
Label type = Item.class.getAnnotation(Label.class);
Label method = Item.class.getDeclaredMethod("read").getAnnotation(Label.class);
System.out.println(type.value() + ":" + type.priority());
System.out.println(method.value() + ":" + method.priority());
}
}Ergebnis
demo:0 read:2
Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.