Zainab Lawal

Annotations in Java

Creating and using custom annotations types

Zainab Lawal's photo
Zainab Lawal
·

4 min read

Table of contents

Introduction

Annotations in Java are a form of metadata that can be added to code to provide additional information about it. They are represented using the @ symbol followed by the name of the annotation and can be added to various program elements such as classes, methods, fields, and parameters. Annotations can be used for a variety of purposes, including documentation, code generation, testing, and more.

Predefined Annotations

There are several built-in annotations in Java, such as @Override, @Deprecated, and @SuppressWarnings. These annotations provide information to the compiler or to other tools used during development and help improve code quality and maintainability.

Here's an example of the @Override annotation in action: 

class Animal {
  public void makeSound() {
    System.out.println("Animal Sound");
  }
}

class Cat extends Animal {
  @Override
  public void makeSound() {
    System.out.println("Meow");
  }
}

In this example, the @Override annotation is used to indicate that the makeSound() method in the Cat class is intended to override the makeSound() method in the Animal class. If the @Override annotation is used incorrectly (i.e., if the method in the child class does not actually override the method in the parent class), the compiler will generate an error.

Custom Annotation Types in Java

In addition to the built-in annotations, Java also allows you to define your own custom annotation types. Custom annotations can be used to provide additional information about your code or to create your own DSL (Domain-Specific Language).

Definining Custom Annotations

To define a custom annotation type, you use the @interface keyword followed by the name of the annotation. Here's an example:

import java.lang.annotation.*;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@interface MyAnnotation {
  String value();
}

In this example, we've defined a custom annotation called @MyAnnotation. The annotation has a single attribute called value, which is a String.

The @Retention annotation is used to specify that the annotation should be retained at runtime. Java allows us to define retention policies in three levels which are:

  • RetentionPolicy.SOURCE— available at the source level and ignored by the compiler

  • RetentionPolicy.CLASS— available to the compiler at compile-time and ignored by the JVM

  • RetentionPolicy.RUNTIME— available to the JVM

The @Target annotation is used to specify that the annotation can be applied to methods. A target annotation specifies one of the following element types as its value:

  • ElementType.ANNOTATION_TYPE can be applied to an annotation type.

  • ElementType.CONSTRUCTOR can be applied to a constructor.

  • ElementType.FIELD can be applied to a field or property.

  • ElementType.LOCAL_VARIABLE can be applied to a local variable.

  • ElementType.METHOD can be applied to a method-level annotation.

  • ElementType.PACKAGE can be applied to a package declaration.

  • ElementType.PARAMETER can be applied to the parameters of a method.

  • ElementType.TYPE can be applied to any element of a class.

Using Defined Custom Annotations

To use this custom annotation, you can add it to a program element, like a class or method, by adding the @MyAnnotation annotation before it. Here's an example:

@MyAnnotation("Hello, World!")
public class MyClass {
    // class code here
}

In this example, we added the @MyAnnotation annotation to the 'MyClass' class, and passed a string value "Hello, World!" to the 'value' element.

To access the annotation information at runtime, you can use the Java Reflection API. Here's an example:

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;

public class Main {
    public static void main(String[] args) throws NoSuchMethodException {
        Class<MyClass> myClass = MyClass.class;
        Method method = myClass.getMethod("myMethod");
        MyAnnotation annotation = method.getAnnotation(MyAnnotation.class);
        System.out.println("Value: " + annotation.value());
    }
}

In this example, we used the Java Reflection API to access the annotation information at runtime. We first obtained a reference to the MyClass class using the Class class. We then obtained a reference to the 'myMethod' method of the class using the getMethod method.

We then used the getAnnotation method of the 'Method' class to get an instance of our custom @MyAnnotation annotation. Finally, we accessed the 'value' element of the annotation and printed it out.

Conclusion

In conclusion, annotations are a powerful tool in Java that allow you to provide additional metadata to your code. You can use the built-in annotations provided by Java or create your own custom annotations to suit your specific needs.

Thanks for reading. If you have any questions or improvements, please let me know in the comments below.

Javaannotationsintroductionprogramming languages