CKTIS / Java
Tipos de anotações — @interface
Uma declaração @interface define um tipo de anotação, ou seja, metadados associados ao código. Os elementos descrevem os dados da anotação, enquanto as meta-anotações controlam os locais permitidos, a retenção, a repetição e a herança.
Versão: Java SE 21; repository runtime, production runtime not attested
Sintaxe
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.CONSTRUCTOR})
@interface Label {
String value();
int priority() default 0;
}@interface define um tipo de anotação. Um elemento como String value(); é um método sem parâmetros e sem corpo. Os tipos permitidos são os primitivos, String, Class, enums, tipos de anotação e arrays unidimensionais destes; o valor não pode ser null. Um elemento sem default é obrigatório. @Label("demo") é uma forma abreviada de @Label(value = "demo") quando os outros elementos têm valores predefinidos.
@Retention determina durante quanto tempo os metadados são conservados: RetentionPolicy.SOURCE significa que o compilador os descarta; RetentionPolicy.CLASS significa que são registados no ficheiro de classe, sem garantia de disponibilidade por reflexão; RetentionPolicy.RUNTIME significa que são conservados durante a execução. No entanto, o acesso por reflexão depende do local onde a anotação é usada. Por exemplo, uma anotação com RetentionPolicy.RUNTIME aplicada à utilização de um tipo numa conversão explícita (cast) pode ser registada no ficheiro de classe, mas a API de reflexão padrão do Java SE 21 não permite aceder-lhe. As anotações aplicadas a declarações de variáveis locais ou de parâmetros de expressões lambda não são registadas no ficheiro de classe, mesmo com RetentionPolicy.RUNTIME. Se @Retention não estiver presente, aplica-se RetentionPolicy.CLASS. Uma anotação não executa lógica por si só: uma ferramenta ou o código tem de a interpretar.
@Target restringe os locais onde a anotação pode ser usada. ElementType.TYPE abrange declarações de classes, interfaces, enums e records; ElementType.FIELD abrange campos, incluindo constantes de enum; ElementType.METHOD abrange métodos; ElementType.CONSTRUCTOR abrange construtores. ElementType.TYPE não significa qualquer utilização de um tipo: esse é o papel de ElementType.TYPE_USE.
@Repeatable identifica um contentor que permite repetir anotações do mesmo tipo. O contentor declara value(), que devolve um array do tipo repetido, e os seus outros elementos têm de ter valores predefinidos. Tem também de cumprir as regras de compatibilidade do JLS relativas à retenção, aos alvos e às meta-anotações.
@Inherited permite que consultas de reflexão adequadas às anotações de classe pesquisem as superclasses. Não transfere anotações das interfaces implementadas nem faz com que sejam herdadas anotações de métodos, campos ou construtores. O exemplo mostra quatro alvos permitidos e lê um valor explícito e um valor predefinido.
Exemplos
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());
}
}Resultado
demo:0 read:2
O código apresentado e o resultado declarado foram verificados num ambiente isolado pelo método registado na prova de verificação desta versão exata.