Znalostná bázaCentrum skúšok
SKSlovenčina
Vybrať jazyk13

CKTIS / Java

Typy anotácií — @interface

Deklarácia @interface definuje typ anotácie, teda metadáta pripojené ku kódu. Jej prvky opisujú údaje anotácie, zatiaľ čo meta-anotácie určujú povolené miesta použitia, uchovávanie, opakovateľnosť a dedenie.

Verzia: 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 definuje typ anotácie. Prvok, napríklad String value();, je bezparametrová metóda bez tela. Povolené typy sú primitívne typy, String, Class, enumy, typy anotácií a ich jednorozmerné polia; hodnota nesmie byť null. Prvok bez default je povinný. @Label("demo") je skrátený zápis @Label(value = "demo"), ak majú ostatné prvky predvolené hodnoty.

@Retention určuje, ako dlho sa metadáta uchovávajú: RetentionPolicy.SOURCE znamená, že ich kompilátor zahodí; RetentionPolicy.CLASS znamená, že sa zapíšu do súboru triedy, ale ich dostupnosť prostredníctvom reflexie nie je zaručená; RetentionPolicy.RUNTIME znamená, že sa uchovajú aj počas behu. Prístup pomocou reflexie však závisí od miesta použitia anotácie. Napríklad anotácia s RetentionPolicy.RUNTIME, ktorá označuje použitie typu pri pretypovaní, sa môže zapísať do súboru triedy, ale štandardné rozhranie API na reflexiu v Java SE 21 ju nesprístupňuje. Anotácie deklarácií lokálnych premenných alebo parametrov lambda výrazov sa do súboru triedy nezapisujú ani pri RetentionPolicy.RUNTIME. Bez @Retention platí RetentionPolicy.CLASS. Anotácia sama nespúšťa logiku: musí ju interpretovať nástroj alebo kód.

@Target obmedzuje povolené miesta použitia. ElementType.TYPE zahŕňa deklarácie tried, rozhraní, enumov a záznamov; ElementType.FIELD zahŕňa polia vrátane konštánt enumov; ElementType.METHOD zahŕňa metódy; ElementType.CONSTRUCTOR zahŕňa konštruktory. ElementType.TYPE neznamená ľubovoľné použitie typu: na to slúži ElementType.TYPE_USE.

@Repeatable určuje kontajner, ktorý umožňuje opakovať anotácie rovnakého typu. Kontajner deklaruje value(), ktoré vracia pole opakovaného typu, a jeho ostatné prvky musia mať predvolené hodnoty. Musí tiež spĺňať pravidlá kompatibility JLS pre uchovávanie, ciele a meta-anotácie.

@Inherited umožňuje, aby príslušné reflexné dotazy na anotácie tried prehľadávali nadtriedy. Neprenáša anotácie z implementovaných rozhraní a nespôsobuje dedenie anotácií metód, polí ani konštruktorov. Príklad ukazuje štyri povolené ciele a číta výslovne zadanú aj predvolenú hodnotu.

Prí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ýsledok

demo:0
read:2

Zobrazený kód a uvedený výsledok boli overené v izolovanom prostredí metódou zaznamenanou v dôkaze o overení tejto presnej verzie.

Zdroje