Tipos de anotações Java

Neste tutorial, aprenderemos sobre os diferentes tipos de anotação Java com a ajuda de exemplos.

As anotações Java são metadados (dados sobre dados) para o código-fonte do nosso programa. Existem várias anotações predefinidas fornecidas pelo Java SE. Além disso, também podemos criar anotações personalizadas de acordo com nossas necessidades.

Se você não sabe o que são anotações, visite o tutorial de anotações Java.

Essas anotações podem ser categorizadas como:

1. Anotações predefinidas

  • @Deprecated
  • @Override
  • @SuppressWarnings
  • @SafeVarargs
  • @FunctionalInterface

2. Anotações personalizadas

3. Meta-anotações

  • @Retention
  • @Documented
  • @Target
  • @Inherited
  • @Repeatable

Tipos de anotação predefinidos

1. @Deprecated

A @Deprecatedanotação é uma anotação de marcador que indica que o elemento (classe, método, campo, etc.) está obsoleto e foi substituído por um elemento mais novo.

Sua sintaxe é:

 @Deprecated accessModifier returnType deprecatedMethodName() (… )

Quando um programa usa o elemento que foi declarado obsoleto, o compilador gera um aviso.

Usamos a @deprecatedtag Javadoc para documentar o elemento obsoleto.

 /** * @deprecated * why it was deprecated */ @Deprecated accessModifier returnType deprecatedMethodName() (… )

Exemplo 1: exemplo de anotação @Deprecated

 class Main ( /** * @deprecated * This method is deprecated and has been replaced by newMethod() */ @Deprecated public static void deprecatedMethod() ( System.out.println("Deprecated method"); ) public static void main(String args()) ( deprecatedMethod(); ) )

Resultado

 Método obsoleto

2. @Override

A @Overrideanotação especifica que um método de uma subclasse substitui o método da superclasse com o mesmo nome de método, tipo de retorno e lista de parâmetros.

Não é obrigatório usar @Overrideao substituir um método. No entanto, se o usarmos, o compilador fornecerá um erro se algo estiver errado (como o tipo de parâmetro errado) enquanto sobrescreve o método.

Exemplo 2: exemplo de anotação @Override

 class Animal ( // overridden method public void display()( System.out.println("I am an animal"); ) ) class Dog extends Animal ( // overriding method @Override public void display()( System.out.println("I am a dog"); ) public void printMessage()( display(); ) ) class Main ( public static void main(String() args) ( Dog dog1 = new Dog(); dog1.printMessage(); ) )

Resultado 

 eu sou um cão

Neste exemplo, ao criar um objeto dog1 da classe Dog, podemos chamar seu método printMessage () que então executa a display()instrução.

Como display()é definido em ambas as classes, o método da subclasse Dog substitui o método da superclasse Animal. Conseqüentemente, o display()da subclasse é chamado.

3. @SuppressWarnings

Como o nome sugere, a @SuppressWarningsanotação instrui o compilador a suprimir os avisos gerados durante a execução do programa.

Podemos especificar o tipo de avisos a serem suprimidos. Os avisos que podem ser suprimidos são específicos do compilador, mas existem duas categorias de avisos: reprovação e desmarcado .

Para suprimir uma determinada categoria de aviso, usamos:

 @SuppressWarnings("warningCategory")

Por exemplo,

 @SuppressWarnings("deprecated")

Para suprimir várias categorias de avisos, usamos:

 @SuppressWarnings(("warningCategory1", "warningCategory2"))

Por exemplo,

 @SuppressWarnings(("deprecated", "unchecked"))

Categoria deprecatedinstrui o compilador a suprimir avisos quando usamos um elemento obsoleto.

Categoria uncheckedinstrui o compilador a suprimir avisos quando usamos tipos brutos.

E, avisos indefinidos são ignorados. Por exemplo,

 @SuppressWarnings("someundefinedwarning")

Exemplo 3: exemplo de anotação @SuppressWarnings

 class Main ( @Deprecated public static void deprecatedMethod() ( System.out.println("Deprecated method"); ) @SuppressWarnings("deprecated") public static void main(String args()) ( Main depObj = new Main(); depObj. deprecatedMethod(); ) )

Resultado 

 Método obsoleto

Aqui, deprecatedMethod()foi marcado como obsoleto e fornecerá avisos do compilador quando usado. Usando a @SuppressWarnings("deprecated")anotação, podemos evitar avisos do compilador.

4. @SafeVarargs

The @SafeVarargs annotation asserts that the annotated method or constructor does not perform unsafe operations on its varargs (variable number of arguments).

We can only use this annotation on methods or constructors that cannot be overridden. This is because the methods that override them might perform unsafe operations.

Before Java 9, we could use this annotation only on final or static methods because they cannot be overridden. We can now use this annotation for private methods as well.

Example 4: @SafeVarargs annotation example

 import java.util.*; class Main ( private void displayList(List… lists) ( for (List list : lists) ( System.out.println(list); ) ) public static void main(String args()) ( Main obj = new Main(); List universityList = Arrays.asList("Tribhuvan University", "Kathmandu University"); obj.displayList(universityList); List programmingLanguages = Arrays.asList("Java", "C"); obj.displayList(universityList, programmingLanguages); ) )

Warnings 

 Type safety: Potential heap pollution via varargs parameter lists Type safety: A generic array of List is created for a varargs parameter

Output

 Note: Main.java uses unchecked or unsafe operations. (Tribhuvan University, Kathmandu University) (Tribhuvan University, Kathmandu University) (Java, C)

Here, List … lists specifies a variable-length argument of type List. This means that the method displayList() can have zero or more arguments.

The above program compiles without errors but gives warnings when @SafeVarargs annotation isn't used.

When we use @SafeVarargs annotation in the above example,

 @SafeVarargs private void displayList(List… lists) (… )

We get the same output but without any warnings. Unchecked warnings are also suppressed when we use this annotation.

5. @FunctionalInterface

Java 8 first introduced this @FunctionalInterface annotation. This annotation indicates that the type declaration on which it is used is a functional interface. A functional interface can have only one abstract method.

Example 5: @FunctionalInterface annotation example

 @FunctionalInterface public interface MyFuncInterface( public void firstMethod(); // this is an abstract method )

If we add another abstract method, let's say

 @FunctionalInterface public interface MyFuncInterface( public void firstMethod(); // this is an abstract method public void secondMethod(); // this throws compile error )

Now, when we run the program, we will get the following warning:

 Unexpected @FunctionalInterface annotation @FunctionalInterface MyFuncInterface is not a functional interface multiple non-overriding abstract methods found in interface MyFuncInterface

It is not mandatory to use @FunctionalInterface annotation. The compiler will consider any interface that meets the functional interface definition as a functional interface.

We use this annotation to make sure that the functional interface has only one abstract method.

However, it can have any number of default and static methods because they have an implementation.

 @FunctionalInterface public interface MyFuncInterface( public void firstMethod(); // this is an abstract method default void secondMethod() (… ) default void thirdMethod() (… ) )

Custom Annotations

It is also possible to create our own custom annotations.

Its syntax is:

 (Access Specifier) @interface ( DataType () (default value); )

Here is what you need to know about custom annotation:

  • Annotations can be created by using @interface followed by the annotation name.
  • The annotation can have elements that look like methods but they do not have an implementation.
  • The default value is optional. The parameters cannot have a null value.
  • The return type of the method can be primitive, enum, string, class name or array of these types.

Example 6: Custom annotation example

 @interface MyCustomAnnotation ( String value() default "default value"; ) class Main ( @MyCustomAnnotation(value = "programiz") public void method1() ( System.out.println("Test method 1"); ) public static void main(String() args) throws Exception ( Main obj = new Main(); obj.method1(); ) )

Output 

 Test method 1

Meta Annotations

Meta-annotations are annotations that are applied to other annotations.

1. @Retention

The @Retention annotation specifies the level up to which the annotation will be available.

Its syntax is:

 @Retention(RetentionPolicy)

There are 3 types of retention policies:

  • RetentionPolicy.SOURCE - The annotation is available only at the source level and is ignored by the compiler.
  • RetentionPolicy.CLASS - The annotation is available to the compiler at compile-time, but is ignored by the Java Virtual Machine (JVM).
  • RetentionPolicy.RUNTIME - The annotation is available to the JVM.

For example,

 @Retention(RetentionPolicy.RUNTIME) public @interface MyCustomAnnotation(… )

2. @Documented

By default, custom annotations are not included in the official Java documentation. To include our annotation in the Javadoc documentation, we use the @Documented annotation.

For example,

 @Documented public @interface MyCustomAnnotation(… )

3. @Target

We can restrict an annotation to be applied to specific targets using the @Target annotation.

Its syntax is:

 @Target(ElementType)

The ElementType can have one of the following types:

Element Type Target
ElementType.ANNOTATION_TYPE Annotation type
ElementType.CONSTRUCTOR Constructors
ElementType.FIELD Fields
ElementType.LOCAL_VARIABLE Local variables
ElementType.METHOD Methods
ElementType.PACKAGE Package
ElementType.PARAMETER Parameter
ElementType.TYPE Any element of class

For example,

 @Target(ElementType.METHOD) public @interface MyCustomAnnotation(… )

In this example, we have restricted the use of this annotation to methods only.

Note: If the target type is not defined, the annotation can be used for any element.

4. @Inherited

By default, an annotation type cannot be inherited from a superclass. However, if we need to inherit an annotation from a superclass to a subclass, we use the @Inherited annotation.

Its syntax is:

 @Inherited

For example,

 @Inherited public @interface MyCustomAnnotation (… ) @MyCustomAnnotation public class ParentClass(… ) public class ChildClass extends ParentClass (… )

5. @Repeatable

An annotation that has been marked by @Repeatable can be applied multiple times to the same declaration.

 @Repeatable(Universities.class) public @interface University ( String name(); )

O valor definido na @Repeatableanotação é a anotação do contêiner. A anotação do contêiner tem um valor variável do tipo de matriz da anotação repetível acima. Aqui Universitiesestão os tipos de anotação que o contêm.

 public @interface Universities ( University() value(); )

Agora, a @Universityanotação pode ser usada várias vezes na mesma declaração.

 @University(name = "TU") @University(name = "KU") private String uniName;

Se precisarmos recuperar os dados de anotação, podemos usar a API Reflection.

Para recuperar valores de anotação, usamos um método getAnnotationsByType()ou getAnnotations()definido na API do Reflection.

Artigos interessantes...