java.lang.reflect.AccessibleObject.getAnnotations() Method Example

Description

The java.lang.reflect.AccessibleObject.getAnnotations() method returns all annotations present on this element. (Returns an array of length zero if this element has no annotations.) The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.

Declaration

Following is the declaration for java.lang.reflect.AccessibleObject.getAnnotations() method.

public Annotation[] getAnnotations()

Return Value

all annotations present on this element.

Example

The following example shows the usage of java.lang.reflect.AccessibleObject.getAnnotations() method.

package com.tutorialspoint;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Annotation;
import java.lang.reflect.AccessibleObject;

public class AccessibleObjectDemo {
   public static void main(String[] args) throws NoSuchMethodException, 
      SecurityException, NoSuchFieldException {
      AccessibleObject sampleMethod = SampleClass.class.getMethod("sampleMethod");

      Annotation[] annotations = sampleMethod.getAnnotations();

      for(Annotation annotation : annotations){
         if(annotation instanceof CustomAnnotation){
            CustomAnnotation customAnnotation = (CustomAnnotation) annotation;
            System.out.println("name: " + customAnnotation.name());
            System.out.println("value: " + customAnnotation.value());
         }
      }
   }
}

@CustomAnnotation(name = "SampleClass",  value = "Sample Class Annotation")
class SampleClass {
   private String sampleField;

   @CustomAnnotation(name = "sampleMethod",  value = "Sample Method Annotation")
   public String sampleMethod(){
      return "sample";
   }

   public String getSampleField() {
      return sampleField;
   }

   public void setSampleField(String sampleField) {
      this.sampleField = sampleField;
   } 
}

@Retention(RetentionPolicy.RUNTIME)
@interface CustomAnnotation {
   public String name();
   public String value();
}

Let us compile and run the above program, this will produce the following result −

name: sampleMethod
value: Sample Method Annotation