View Javadoc
1   /**
2    * This file Copyright (c) 2013-2018 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 java.lang.annotation.Annotation;
37  import java.lang.reflect.AnnotatedElement;
38  import java.lang.reflect.Method;
39  import java.lang.reflect.TypeVariable;
40  import java.util.Set;
41  
42  import org.reflections.ReflectionUtils;
43  
44  import com.google.common.base.Predicate;
45  
46  /**
47   * Utility methods to retrieve annotations.
48   * TODO : Cache ?
49   */
50  public class AnnotationUtils {
51      private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(AnnotationUtils.class);
52  
53      public static boolean hasAnnotationOn(AnnotatedElement annotatedElement, final Class<? extends Annotation> annotationType) {
54          if (annotatedElement instanceof Class) {
55              return getAllAnnotationsOfType((Class) annotatedElement, annotationType).size() > 0;
56          } else if (annotatedElement instanceof Method) {
57              return isMethodAnnotatedWith((Method) annotatedElement, annotationType);
58          } else if (annotatedElement instanceof TypeVariable) {
59              log.debug("Looks like we're running on Java 8. Ignoring annotations on TypeVariable, skipping {}.", annotatedElement);
60              return false;
61          } else {
62              throw new IllegalArgumentException("Only supports Class and Method, can't deal with " + annotatedElement + " (" + annotatedElement.getClass() + ")");
63          }
64      }
65  
66      public static <A extends Annotation> A getAnnotationOn(Class annotatedElement, final Class<A> annotationType) {
67          final Set<A> allAnnotations = getAllAnnotationsOfType(annotatedElement, annotationType);
68          if (allAnnotations.isEmpty()) {
69              throw new IllegalStateException(annotatedElement + " is not annotated with @" + annotationType.getSimpleName());
70          }
71          if (allAnnotations.size() > 1) {
72              // TODO figure out what to do in this case
73              throw new IllegalStateException();
74          }
75  
76          return allAnnotations.iterator().next();
77      }
78  
79      private static <A extends Annotation> Set<A> getAllAnnotationsOfType(Class clazz, Class<A> annotationType) {
80          // ReflectionUtils.getAllAnnotations only really works on classes. If passed a Method, it does not walk up the class hierarchy
81          return (Set<A>) ReflectionUtils.getAllAnnotations(clazz, new AnnotationTypePredicate(annotationType));
82      }
83  
84      /**
85       * Checks if the given method or one of its superclass/interface definition is annotated with the given annotation.
86       */
87      private static boolean isMethodAnnotatedWith(Method method, Class<? extends Annotation> annotation) {
88          final Set<Class<?>> clazzes = ReflectionUtils.getAllSuperTypes(method.getDeclaringClass());
89          for (Class clazz : clazzes) {
90              try {
91                  final Method m = clazz.getDeclaredMethod(method.getName(), method.getParameterTypes());
92                  if (m.isAnnotationPresent(annotation)) {
93                      return true;
94                  }
95              } catch (NoSuchMethodException e) {
96              }
97          }
98  
99          return false;
100     }
101 
102     private static class AnnotationTypePredicate implements Predicate<Annotation> {
103         private final Class<? extends Annotation> annotationType;
104 
105         public AnnotationTypePredicate(Class<? extends Annotation> annotationType) {
106             this.annotationType = annotationType;
107         }
108 
109         @Override
110         public boolean apply(Annotation input) {
111             return annotationType.isInstance(input);
112         }
113     }
114 }