View Javadoc
1   /**
2    * This file Copyright (c) 2013-2015 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.i18nsystem.util;
35  
36  import com.google.common.base.Predicate;
37  import org.reflections.ReflectionUtils;
38  import javax.annotation.Nullable;
39  import java.lang.annotation.Annotation;
40  import java.lang.reflect.AnnotatedElement;
41  import java.lang.reflect.Method;
42  import java.lang.reflect.TypeVariable;
43  import java.util.Set;
44  
45  /**
46   * Utility methods to retrieve annotations.
47   * TODO : Cache ?
48   */
49  public class AnnotationUtils {
50      private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(AnnotationUtils.class);
51  
52      public static boolean hasAnnotationOn(AnnotatedElement annotatedElement, final Class<? extends Annotation> annotationType) {
53          if (annotatedElement instanceof Class) {
54              return getAllAnnotationsOfType((Class) annotatedElement, annotationType).size() > 0;
55          } else if (annotatedElement instanceof Method) {
56              return isMethodAnnotatedWith((Method) annotatedElement, annotationType);
57          } else if (annotatedElement instanceof TypeVariable) {
58              log.debug("Looks like we're running on Java 8. Ignoring annotations on TypeVariable, skipping {}.", annotatedElement);
59              return false;
60          } else {
61              throw new IllegalArgumentException("Only supports Class and Method, can't deal with " + annotatedElement + " (" + annotatedElement.getClass() + ")");
62          }
63      }
64  
65      public static <A extends Annotation> A getAnnotationOn(Class annotatedElement, final Class<A> annotationType) {
66          final Set<A> allAnnotations = getAllAnnotationsOfType(annotatedElement, annotationType);
67          if (allAnnotations.isEmpty()) {
68              throw new IllegalStateException(annotatedElement + " is not annotated with @" + annotationType.getSimpleName());
69          }
70          if (allAnnotations.size() > 1) {
71              // TODO figure out what to do in this case
72              throw new IllegalStateException();
73          }
74  
75          return allAnnotations.iterator().next();
76      }
77  
78      private static <A extends Annotation> Set<A> getAllAnnotationsOfType(Class clazz, Class<A> annotationType) {
79          // ReflectionUtils.getAllAnnotations only really works on classes. If passed a Method, it does not walk up the class hierarchy
80          return (Set<A>) ReflectionUtils.getAllAnnotations(clazz, new AnnotationTypePredicate(annotationType));
81      }
82  
83      /**
84       * Checks if the given method or one of its superclass/interface definition is annotated with the given annotation.
85       */
86      private static boolean isMethodAnnotatedWith(Method method, Class<? extends Annotation> annotation) {
87          final Set<Class<?>> clazzes = ReflectionUtils.getAllSuperTypes(method.getDeclaringClass());
88          for (Class clazz : clazzes) {
89              try {
90                  final Method m = clazz.getDeclaredMethod(method.getName(), method.getParameterTypes());
91                  if (m.isAnnotationPresent(annotation)) {
92                      return true;
93                  }
94              } catch (NoSuchMethodException e) {
95              }
96          }
97  
98          return false;
99      }
100 
101     private static class AnnotationTypePredicate implements Predicate<Annotation> {
102         private final Class<? extends Annotation> annotationType;
103 
104         public AnnotationTypePredicate(Class<? extends Annotation> annotationType) {
105             this.annotationType = annotationType;
106         }
107 
108         @Override
109         public boolean apply(@Nullable Annotation input) {
110             return annotationType.isInstance(input);
111         }
112     }
113 }