CODEWITHSUNDEEP
javaannotations
D.Bertini
D.Bertini

Reputation: 29

How to prevent multiple instances of a Java annotation in a class

I have a Java annotation type like this:

import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

@Retention(RUNTIME)
@Target(METHOD)
public @interface Foo {

}

My intention is to avoid multiple instances of this annotation. In other words I want to disallow the next example code and throw an exception:

public class FooTest {
   @Foo
   public void method1(){...}
   @Foo
   public void method2(){...}
}

Any suggestion?

Upvotes: 2

Views: 766

Answers (1)

user11595728
user11595728

Reputation:

The best technique to fulfill your intention (avoid multiple instances of this annotation) would be a static check, simply because it can be done and would detect the problem earlier. This is supported through Java's annotation processing feature.

However, the question also shows a desire to do this at run-time given that it includes @Retention(RUNTIME) and mentions exceptions. This can be done easily with reflection if the list of classes to check is known in advance. Here's a simple piece of code to check one class, since the question mentions checking a single class. 

public static void checkClass(Class<?> clazz) {
    boolean used = false;
    for( Method method : clazz.getDeclaredMethods() ) {
        if( method.getAnnotation(Foo.class) != null ) {
            if( used ) { 
                throw new IllegalFooUseException(); 
            }
            else { used = true; }
        }
    }
}

Checking across a project would be more work, as it would require collecting all the classes in the project, which isn't so simple.

Upvotes: 1

Related Questions