Tipos de anotaciones Java

En este tutorial, aprenderemos sobre diferentes tipos de anotaciones de Java con la ayuda de ejemplos.

Las anotaciones de Java son metadatos (datos sobre datos) para el código fuente de nuestro programa. Hay varias anotaciones predefinidas proporcionadas por Java SE. Además, también podemos crear anotaciones personalizadas según nuestras necesidades.

Si no sabe qué son las anotaciones, visite el tutorial de anotaciones de Java.

Estas anotaciones se pueden clasificar como:

1. Anotaciones predefinidas

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

2. Anotaciones personalizadas

3. Meta-anotaciones

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

Tipos de anotaciones predefinidos

1. @Deprecated

La @Deprecatedanotación es una anotación de marcador que indica que el elemento (clase, método, campo, etc.) está obsoleto y ha sido reemplazado por un elemento más nuevo.

Su sintaxis es:

 @Deprecated accessModifier returnType deprecatedMethodName() (… )

Cuando un programa usa el elemento que ha sido declarado obsoleto, el compilador genera una advertencia.

Usamos la @deprecatedetiqueta Javadoc para documentar el elemento obsoleto.

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

Ejemplo 1: ejemplo de anotación @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(); ) )

Salida

 Método obsoleto

2. @Anular

La @Overrideanotación especifica que un método de una subclase anula el método de la superclase con el mismo nombre de método, tipo de retorno y lista de parámetros.

No es obligatorio utilizarlo @Overrideal anular un método. Sin embargo, si lo usamos, el compilador da un error si algo está mal (como un tipo de parámetro incorrecto) al anular el método.

Ejemplo 2: ejemplo de anotación @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(); ) )

Salida 

 yo soy un perro

En este ejemplo, al hacer un objeto dog1 de la clase Dog, podemos llamar a su método printMessage () que luego ejecuta la display()declaración.

Dado que display()se define en ambas clases, el método de la subclase Perro anula el método de la superclase Animal. Por tanto, el display()de la subclase se llama.

3. @SuppressWarnings

Como sugiere el nombre, la @SuppressWarningsanotación indica al compilador que suprima las advertencias que se generan mientras se ejecuta el programa.

Podemos especificar el tipo de advertencias a suprimir. Las advertencias que se pueden suprimir son específicas del compilador, pero hay dos categorías de advertencias: obsoleta y sin marcar .

Para suprimir una categoría particular de advertencia, usamos:

 @SuppressWarnings("warningCategory")

Por ejemplo,

 @SuppressWarnings("deprecated")

Para suprimir múltiples categorías de advertencias, usamos:

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

Por ejemplo,

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

Categoría deprecatedindica al compilador que suprima las advertencias cuando usamos un elemento obsoleto.

Categoría uncheckedindica al compilador que suprima las advertencias cuando usamos tipos sin formato.

Y se ignoran las advertencias indefinidas. Por ejemplo,

 @SuppressWarnings("someundefinedwarning")

Ejemplo 3: ejemplo de anotación @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(); ) )

Salida 

 Método obsoleto

Aquí, deprecatedMethod()se ha marcado como obsoleto y dará advertencias al compilador cuando se use. Al usar la @SuppressWarnings("deprecated")anotación, podemos evitar las advertencias del 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(); )

El valor definido en la @Repeatableanotación es la anotación del contenedor. La anotación de contenedor tiene un valor variable de tipo de matriz de la anotación repetible anterior. Aquí Universitiesestán el tipo de anotación que lo contiene.

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

Ahora, la @Universityanotación se puede usar varias veces en la misma declaración.

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

Si necesitamos recuperar los datos de la anotación, podemos usar la API de Reflection.

Para recuperar los valores de anotación, utilizamos getAnnotationsByType()o getAnnotations()método definido en la API de reflexión.

Articulos interesantes...