Baza znanjaIzpitno središče
SLSlovenščina
Izberi jezik13

CKTIS / Java

Vrste anotacij — @interface

Deklaracija @interface določa vrsto anotacije, torej metapodatke, dodane kodi. Elementi opisujejo podatke anotacije, meta-anotacije pa določajo dovoljena mesta uporabe, hrambo, ponovljivost in dedovanje.

Različica: Java SE 21; repository runtime, production runtime not attested

Sintaksa

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

@interface določa vrsto anotacije. Element, kot je String value();, je metoda brez parametrov in brez telesa. Dovoljeni tipi so primitivni tipi, String, Class, enum-i, tipi anotacij in njihova enodimenzionalna polja; vrednost ne sme biti null. Element brez default je obvezen. @Label("demo") je krajši zapis za @Label(value = "demo"), kadar imajo drugi elementi privzete vrednosti.

@Retention določa, kako dolgo se metapodatki hranijo: RetentionPolicy.SOURCE pomeni, da jih prevajalnik zavrže; RetentionPolicy.CLASS pomeni, da se zapišejo v datoteko razreda, ne da bi bila zagotovljena njihova dostopnost prek refleksije; RetentionPolicy.RUNTIME pomeni, da se ohranijo tudi med izvajanjem. Dostop prek refleksije pa je odvisen od mesta uporabe anotacije. Na primer, anotacija z RetentionPolicy.RUNTIME, ki označuje uporabo tipa pri eksplicitni pretvorbi tipa (cast), se lahko zapiše v datoteko razreda, vendar standardni API za refleksijo v Java SE 21 do nje ne omogoča dostopa. Anotacije na deklaracijah lokalnih spremenljivk ali parametrov izrazov lambda se ne zapišejo v datoteko razreda niti pri RetentionPolicy.RUNTIME. Če @Retention ni naveden, velja RetentionPolicy.CLASS. Anotacija sama ne izvaja logike: razložiti jo mora orodje ali koda.

@Target omejuje dovoljena mesta uporabe. ElementType.TYPE zajema deklaracije razredov, vmesnikov, enumov in zapisov; ElementType.FIELD zajema polja, vključno s konstantami enumov; ElementType.METHOD zajema metode; ElementType.CONSTRUCTOR zajema konstruktorje. ElementType.TYPE ne pomeni poljubne uporabe tipa: za to je namenjen ElementType.TYPE_USE.

@Repeatable določa vsebnik, ki omogoča ponavljanje anotacij istega tipa. Vsebnik deklarira value(), ki vrne polje ponavljanega tipa, njegovi drugi elementi pa morajo imeti privzete vrednosti. Izpolnjevati mora tudi pravila združljivosti JLS za hrambo, cilje in meta-anotacije.

@Inherited omogoča, da ustrezne refleksijske poizvedbe za anotacije razredov preiščejo nadrazrede. Anotacij ne prenaša z implementiranih vmesnikov in ne povzroči dedovanja anotacij metod, polj ali konstruktorjev. Primer prikazuje štiri dovoljena mesta uporabe ter prebere izrecno določeno in privzeto vrednost.

Primeri

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

Rezultat

demo:0
read:2

Prikazana koda in navedeni rezultat sta bila preverjena v izoliranem okolju z metodo, zapisano v dokazilu o preverjanju te natančne različice.

Viri