annotations not returned by getAnnotations()

[Richard Hayward]

I'm reading Jeanne & Scott's complete OCP 11 study guide, chapter 13 about Annotations.

Following the syntax they give, I define an Annotation:

Exercise.java

package com.mydomain.ocp11.ch13.p0558;                                                                                       
                                                                                                                                   
public @interface Exercise {}  

I then create a class, with that Exercise annotation applied, than can print out it's own annotations:

PrintMyAnnotations.java

package com.mydomain.ocp11.ch13.p0558;                                                                                           
                                                                                                                                      
import java.lang.annotation.Annotation;                                                                                               
import static java.lang.System.out;                                                                                                   
                                                                                                                                      
@Exercise                                                                                                                           
public class PrintMyAnnotations{                                                                                                      
  public static void main(String[] args) {                                                                                            
    Class myClass = PrintMyAnnotations.class;                                                                                         
    Annotation[] annotations = myClass.getAnnotations();                                                                              
    out.printf("annotations.length = %d\n", annotations.length);                                                                      
    for(Annotation annotation:annotations){                                                                                           
      out.println(annotation.toString());                                                                                             
    }                                                                                                                                 
  }                                                                                                                                   
} 

but nothing gets printed
$ java com.mydomain.ocp11.ch13.p0558.PrintMyAnnotations annotations.length = 0 $

If, instead of @Exercise, I use a @Deprecated annotation

package com.mydomain.ocp11.ch13.p0558;                                                                                           
                                                                                                                                      
import java.lang.annotation.Annotation;                                                                                               
import static java.lang.System.out;                                                                                                   
                                                                                                                                      
@Deprecated                                                                                                                           
public class PrintMyAnnotations{                                                                                                      
  public static void main(String[] args) {                                                                                            
    Class myClass = PrintMyAnnotations.class;                                                                                         
    Annotation[] annotations = myClass.getAnnotations();                                                                              
    out.printf("annotations.length = %d\n", annotations.length);                                                                      
    for(Annotation annotation:annotations){                                                                                           
      out.println(annotation.toString());                                                                                             
    }                                                                                                                                 
  }                                                                                                                                   
}

I get, as expected, an annotation reported:
$ java com.mydomain.ocp11.ch13.p0558.PrintMyAnnotations annotations.length = 1 @java.lang.Deprecated(forRemoval=false, since="") $

Could anyone tell me why, in the case of @Exercise, I'm not getting any annotation reported?

[Campbell Ritchie]

Have a look at the differences between your annotation and @Deprecated. Deprecated has both targets and retention (=RUNTIME).  If you look in the JLS (=Java® Language Specification), you will find that annotations are not always present. I suggest you add a retention to your annotation and see what happens. Not certain, but I think the absence of a target isn't a problem at the moment.

Addition: getAnnotations() only returns annotations that are present.

[Richard Hayward]

Campbell Ritchie wrote:I suggest you add a retention to your annotation and see what happens.

Changing the annotation so as to include that:

MyExercise.java

package com.mydomain.ocp11.ch13.p0558;                                                                                                                                                     
                                                                                                                                                                                                
import java.lang.annotation.Retention;                                                                                                                                                          
import java.lang.annotation.RetentionPolicy;                                                                                                                                                    
                                                                                                                                                                                                
@Retention(RetentionPolicy.RUNTIME)                                                                                                                                                             
public @interface MyExercise {} 

PrintMyAnnotations.java

package com.mydomain.ocp11.ch13.p0558;                                                                                                                                                     
                                                                                                                                                                                                
import java.lang.annotation.Annotation;                                                                                                                                                         
import static java.lang.System.out;                                                                                                                                                             
                                                                                                                                                                                                
@MyExercise                                                                                                                                                                                     
public class PrintMyAnnotations{                                                                                                                                                                
  public static void main(String[] args) {                                                                                                                                                      
    Class myClass = PrintMyAnnotations.class;                                                                                                                                                   
    Annotation[] annotations = myClass.getAnnotations();                                                                                                                                        
    out.printf("annotations.length = %d\n", annotations.length);                                                                                                                                
    for(Annotation annotation:annotations){                                                                                                                                                     
      out.println(annotation.toString());                                                                                                                                                       
    }                                                                                                                                                                                           
  }                                                                                                                                                                                             
}  

It works!

$ java com.mydomain.ocp11.ch13.p0558.PrintMyAnnotations annotations.length = 1 @com.mydomain.ocp11.ch13.p0558.MyExercise() $

Seems that without RetentionPolicy.RUNTIME, the annotation doesn't exist at runtime.

Thanks Campbell

[Campbell Ritchie]

Richard Hayward wrote:. . . Seems that without RetentionPolicy.RUNTIME, the annotation doesn't exist at runtime.

Yes, that seems to be what the JLS link I showed you says.

Thanks Campbell

That's a pleasure

[Campbell Ritchie]

By the way: Two (very) minor points: Class is a parametrised type, so it might be preferable to declare it as such. It won't make any difference in sich a simple use case. Many people use clazz as the identifier; you can't use class as an identifier because it is a keyword.Class<PrintMyAnnotations> clazz = PrintMyAnnotations.class;