Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / Java

Typy anotací — @interface

Deklarace @interface definuje typ anotace, tedy metadata připojená ke kódu. Její prvky popisují data anotace, zatímco meta-anotace určují povolená místa použití, dobu uchování, opakovatelnost a dědičnost.

Verze: Java SE 21; repository runtime, production runtime not attested

Syntaxe

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.CONSTRUCTOR})
@interface Label {
    String value();
    int priority() default 0;
}

@interface definuje typ anotace. Prvek, jako je String value();, je bezparametrová metoda bez těla. Povolené typy jsou primitivní typy, String, Class, enumy, typy anotací a jejich jednorozměrná pole; hodnota nesmí být null. Prvek bez default je povinný. @Label("demo") je zkrácený zápis @Label(value = "demo"), pokud mají ostatní prvky výchozí hodnoty.

@Retention určuje, jak dlouho se metadata uchovávají: RetentionPolicy.SOURCE znamená, že je kompilátor zahodí; RetentionPolicy.CLASS znamená, že se zapíší do souboru třídy, ale jejich dostupnost prostřednictvím reflexe není zaručena; RetentionPolicy.RUNTIME znamená, že se uchovají i za běhu. Přístup pomocí reflexe však závisí na místě použití anotace. Například anotace použití typu při přetypování s RetentionPolicy.RUNTIME se může zapsat do souboru třídy, ale standardní rozhraní API pro reflexi v Java SE 21 ji nezpřístupňuje. Anotace deklarací lokálních proměnných nebo parametrů lambda výrazů se do souboru třídy nezapisují ani při RetentionPolicy.RUNTIME. Bez @Retention platí RetentionPolicy.CLASS. Anotace sama žádnou logiku nespouští: musí ji interpretovat nástroj nebo kód.

@Target omezuje povolená místa použití. ElementType.TYPE zahrnuje deklarace tříd, rozhraní, enumů a záznamů; ElementType.FIELD zahrnuje pole včetně konstant enumů; ElementType.METHOD zahrnuje metody; ElementType.CONSTRUCTOR zahrnuje konstruktory. ElementType.TYPE neznamená libovolné použití typu: k tomu slouží ElementType.TYPE_USE.

@Repeatable určuje kontejner, který umožňuje opakovat anotace stejného typu. Kontejner deklaruje value(), které vrací pole opakovaného typu, a jeho ostatní prvky musí mít výchozí hodnoty. Musí také splňovat pravidla kompatibility JLS pro uchovávání, cíle a meta-anotace.

@Inherited umožňuje, aby příslušné reflexní dotazy na anotace tříd prohledávaly nadtřídy. Nepřenáší anotace z implementovaných rozhraní a nezpůsobuje dědění anotací metod, polí ani konstruktorů. Příklad ukazuje čtyři povolené cíle a čte výslovně zadanou i výchozí hodnotu.

Příklady

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());
    }
}

Výsledek

demo:0
read:2

Zobrazený kód a uvedený výsledek byly ověřeny v izolovaném prostředí metodou zaznamenanou v dokladu o ověření této přesné verze.

Zdroje