Package getDeclaredAnnotationsByType() method in Java with Examples

The getDeclaredAnnotationsByType() method of java.lang.Package class is used to get the declared annotations of the specified declared annotation type present in this class. The method returns an array of declared annotations for the specified declared annotation type.

Syntax:

public A[] getDeclaredAnnotationsByType(Class<T> declared annotationClass)

Parameter: This method accepts a parameter declared annotationClass which is the type of the declared annotation to get.

Return Value: This method returns an array of declared annotations for the specified declared annotation type.

Exception: This method throws:



  • NullPointerException: if the given declared annotation class is null.

Below programs demonstrate the getDeclaredAnnotationsByType() method.

Example 1:

filter_none

edit
close

play_arrow

link
brightness_4
code

// Java program to demonstrate
// getDeclaredAnnotationsByType() method
  
import java.util.*;
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 class
        Class myClass = Test.class;
  
        System.out.println(
            "Class represented by myClass: "
            + myClass.toString());
  
        // Get the declared annotation
        // using getDeclaredAnnotationsByType() method
        System.out.println(
            "DeclaredAnnotation of myClass"
            + " of type DeclaredAnnotation: "
            + Arrays.toString(
                  myClass
                      .getDeclaredAnnotationsByType(
                          DeclaredAnnotation.class)));
    }
}

chevron_right


Output:

Class represented by myClass: class Test
DeclaredAnnotation of myClass of type DeclaredAnnotation: [@DeclaredAnnotation(key=GFG, value=GeeksForGeeks)]

Example 2:

filter_none

edit
close

play_arrow

link
brightness_4
code

// Java program to demonstrate
// getDeclaredAnnotationsByType() method
  
import java.util.*;
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 class
            Class myClass = Test.class;
  
            System.out.println(
                "Class represented by myClass: "
                + myClass.toString());
  
            // Get the declared annotation
            // using getDeclaredAnnotationsByType() method
            System.out.println(
                "DeclaredAnnotation of myClass"
                + " of type Deprecated: "
                + Arrays.toString(
                      myClass
                          .getDeclaredAnnotationsByType(
                              Deprecated.class)));
        }
        catch (Exception e) {
            System.out.println(e);
        }
    }
}

chevron_right


Output:

Class represented by myClass: class Test
DeclaredAnnotation of myClass of type Deprecated: [@java.lang.Deprecated()]

Reference: https://docs.oracle.com/javase/9/docs/api/java/lang/Package.html#getDeclaredAnnotationsByType-java.lang.Class-

Attention reader! Don’t stop learning now. Get hold of all the important DSA concepts with the DSA Self Paced Course at a student-friendly price and become industry ready.




My Personal Notes arrow_drop_up

Check out this Author's contributed articles.

If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.

Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.