AnnotatedElement getDeclaredAnnotations() method in Java with Examples

The getDeclaredAnnotations() method of java.lang.AnnotatedElement class is used to get the declared annotations present in the class implementing this interface. The method returns an array of declared annotations present.

Syntax:

public DeclaredAnnotation[] getDeclaredAnnotations()

Parameter: This method does not accepts any parameter.

Return Value: This method returns an array of declared annotations present.

Below programs demonstrate the getDeclaredAnnotations() method.

Example 1:

// Java program to demonstrate
// getDeclaredAnnotations() method

import java.util.*;
import java.lang.reflect.*;
import java.lang.annotation.*;

@Deprecated
public class Test {

    public Object obj;

    public static void main(String[] args)
        throws ClassNotFoundException
    {
        try {

            // returns the Class object
            // for this myAnnotatedElement
            AnnotatedElement myAnnotatedElement
                = Test.class;

            System.out.println(
                "AnnotatedElement represented"
                + " by myAnnotatedElement: "
                + myAnnotatedElement.toString());

            // Get the declared annotation
            // using getDeclaredAnnotations() method
            System.out.println(
                "DeclaredAnnotation of myAnnotatedElement: "
                + Arrays.toString(
                      myAnnotatedElement
                          .getDeclaredAnnotations()));
        }
        catch (Exception e) {
            System.out.println(e);
        }
    }
}

Output:

AnnotatedElement represented by myAnnotatedElement: class Test
DeclaredAnnotation of myAnnotatedElement: [@java.lang.Deprecated()]

Example 2:

// Java program to demonstrate
// getDeclaredAnnotations() method

import java.util.*;
import java.lang.reflect.*;
import java.lang.annotation.*;

// create a custom DeclaredAnnotation
@Retention(RetentionPolicy.RUNTIME)
@interface DeclaredAnnotation {

    // This declared annotation has two attributes.
    public String key();

    public String value();
}

// call DeclaredAnnotation for method
// and pass values for declared annotation
@DeclaredAnnotation(key = "GFG", value = "GeeksForGeeks")
public class Test {

    public Object obj;

    public static void main(String[] args)
        throws ClassNotFoundException
    {

        // returns the Class object
        // for this myAnnotatedElement
        AnnotatedElement myAnnotatedElement
            = Test.class;

        System.out.println(
            "AnnotatedElement represented"
            + " by myAnnotatedElement: "
            + myAnnotatedElement.toString());

        // Get the declared annotation
        // using getDeclaredAnnotations() method
        System.out.println(
            "DeclaredAnnotation of myAnnotatedElement: "
            + Arrays.toString(
                  myAnnotatedElement
                      .getDeclaredAnnotations()));
    }
}

Output:

AnnotatedElement represented by myAnnotatedElement: class Test
DeclaredAnnotation of myAnnotatedElement: [@DeclaredAnnotation(key=GFG, value=GeeksForGeeks)]

Reference: https://docs.oracle.com/javase/9/docs/api/java/lang/reflect/AnnotatedElement.html#getDeclaredAnnotations–