Package io.microsphere.util

Class AnnotationUtils

  • All Implemented Interfaces:
    Utils
    public abstract class AnnotationUtils
extends java.lang.Object
implements Utils
    Annotation Utilities class
    Since:
    1.0.0
    Author:
    Mercy

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static boolean exists​(java.lang.annotation.Annotation[] annotations, java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)  
      static boolean exists​(java.lang.Iterable<java.lang.annotation.Annotation> annotations, java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)  
      static boolean exists​(java.util.Collection<java.lang.annotation.Annotation> annotations, java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)  
      static java.util.List<java.lang.annotation.Annotation> filterAnnotations​(java.lang.annotation.Annotation[] annotations, java.util.function.Predicate<? super java.lang.annotation.Annotation>... annotationsToFilter)  
      static java.util.List<java.lang.annotation.Annotation> filterAnnotations​(java.util.List<java.lang.annotation.Annotation> annotations, java.util.function.Predicate<? super java.lang.annotation.Annotation>... annotationsToFilter)  
      static java.util.List<java.lang.annotation.Annotation> findAllDeclaredAnnotations​(java.lang.Class<?> type, java.util.function.Predicate<? super java.lang.annotation.Annotation>... annotationsToFilter)
      Get all directly declared annotations of the specified type and those all hierarchical types, not including meta annotations.
      static java.util.List<java.lang.annotation.Annotation> findAllDeclaredAnnotations​(java.lang.reflect.AnnotatedElement annotatedElement, java.util.function.Predicate<? super java.lang.annotation.Annotation>... annotationsToFilter)
      Find all directly declared annotations of the annotated element with filters, not including meta annotations.
      static <A extends java.lang.annotation.Annotation>
      A      		 findAnnotation​(java.lang.reflect.AnnotatedElement annotatedElement, java.lang.Class<A> annotationType)
      Find the annotation that is annotated on the specified element may be a meta-annotation
      static <A extends java.lang.annotation.Annotation>
      A      		 findAnnotation​(java.lang.reflect.AnnotatedElement annotatedElement, java.util.function.Predicate<? super java.lang.annotation.Annotation>... annotationFilters)
      Find the annotation that is annotated on the specified element may be a meta-annotation
      static java.util.Map<java.lang.String,​java.lang.Object> findAttributesMap​(java.lang.annotation.Annotation annotation, java.lang.String... attributeNamesToFilter)
      Find the attributes map from the specified annotation by the attribute names
      static java.util.Map<java.lang.String,​java.lang.Object> findAttributesMap​(java.lang.annotation.Annotation annotation, java.util.function.Predicate<? super java.lang.reflect.Method>... attributesToFilter)
      Find the attributes map from the specified annotation by the attribute method
      static <T> T findAttributeValue​(java.lang.annotation.Annotation[] annotations, java.lang.String attributeName)
      Find the attribute value from the specified annotations
      static java.util.List<java.lang.annotation.Annotation> findDeclaredAnnotations​(java.lang.reflect.AnnotatedElement annotatedElement, java.util.function.Predicate<? super java.lang.annotation.Annotation>... annotationsToFilter)
      Find the declared annotations that are directly present on this element with filters.
      static java.util.List<java.lang.annotation.Annotation> getAllDeclaredAnnotations​(java.lang.reflect.AnnotatedElement annotatedElement)
      Get all directly declared annotations of the annotated element, not including meta annotations.
      static java.util.Map<java.lang.String,​java.lang.Object> getAttributesMap​(java.lang.annotation.Annotation annotation)
      Get the attributes map from the specified annotation
      static <T> T getAttributeValue​(java.lang.annotation.Annotation annotation, java.lang.String attributeName)
      Get the attribute value of the annotation
      static java.util.List<java.lang.annotation.Annotation> getDeclaredAnnotations​(java.lang.reflect.AnnotatedElement annotatedElement)
      Get the declared annotations that are directly present on this element.
      static boolean isAnnotationInterfaceMethod​(java.lang.reflect.Method attributeMethod)
      Is the specified method declared by the Annotation interface or not
      static boolean isAnnotationPresent​(java.lang.annotation.Annotation annotation, java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)  
      static boolean isAnnotationPresent​(java.lang.annotation.Annotation annotation, java.lang.Iterable<java.lang.Class<? extends java.lang.annotation.Annotation>> annotationTypes)  
      static boolean isAnnotationPresent​(java.lang.reflect.AnnotatedElement[] annotatedElements, java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)  
      static boolean isAnnotationPresent​(java.lang.reflect.AnnotatedElement annotatedElement, java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)  
      static boolean isAnnotationPresent​(java.lang.reflect.AnnotatedElement annotatedElement, java.lang.Iterable<java.lang.Class<? extends java.lang.annotation.Annotation>> annotationTypes)  
      static boolean isCallerSensitivePresent()
      Is jdk.internal.reflect.CallerSensitive class present or not
      static boolean isMetaAnnotation​(java.lang.annotation.Annotation annotation, java.lang.Class<? extends java.lang.annotation.Annotation>... metaAnnotationTypes)  
      static boolean isMetaAnnotation​(java.lang.annotation.Annotation annotation, java.lang.Iterable<java.lang.Class<? extends java.lang.annotation.Annotation>> metaAnnotationTypes)  
      static boolean isMetaAnnotation​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType, java.lang.Class<? extends java.lang.annotation.Annotation>... metaAnnotationTypes)  
      static boolean isMetaAnnotation​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType, java.lang.Iterable<java.lang.Class<? extends java.lang.annotation.Annotation>> metaAnnotationTypes)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • NATIVE_ANNOTATION_TYPES

        public static final java.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>> NATIVE_ANNOTATION_TYPES

      • CALLER_SENSITIVE_ANNOTATION_CLASS_NAME

        public static final java.lang.String CALLER_SENSITIVE_ANNOTATION_CLASS_NAME
        The annotation class name of jdk.internal.reflect.CallerSensitive
        See Also:
        Constant Field Values

      • CALLER_SENSITIVE_ANNOTATION_CLASS

        public static final java.lang.Class<? extends java.lang.annotation.Annotation> CALLER_SENSITIVE_ANNOTATION_CLASS
        The annotation Class of jdk.internal.reflect.CallerSensitive that may be null

      • EMPTY_ANNOTATION_ARRAY

        public static final java.lang.annotation.Annotation[] EMPTY_ANNOTATION_ARRAY
        An empty immutable Annotation array

    • Method Detail

      • findAnnotation

        public static <A extends java.lang.annotation.Annotation> A findAnnotation​(java.lang.reflect.AnnotatedElement annotatedElement,
                                                                           java.lang.Class<A> annotationType)
        Find the annotation that is annotated on the specified element may be a meta-annotation
        Type Parameters:
        A - the required type of annotation
        Parameters:
        annotatedElement - the annotated element
        annotationType - the type of annotation
        Returns:
        If found, return first matched-type annotation, or null

      • findAnnotation

        public static <A extends java.lang.annotation.Annotation> A findAnnotation​(java.lang.reflect.AnnotatedElement annotatedElement,
                                                                           java.util.function.Predicate<? super java.lang.annotation.Annotation>... annotationFilters)
        Find the annotation that is annotated on the specified element may be a meta-annotation
        Type Parameters:
        A - the required type of annotation
        Parameters:
        annotatedElement - the annotated element
        annotationFilters - the filters of annotations
        Returns:
        If found, return first matched-type annotation, or null

      • isMetaAnnotation

        public static boolean isMetaAnnotation​(java.lang.annotation.Annotation annotation,
                                       java.lang.Class<? extends java.lang.annotation.Annotation>... metaAnnotationTypes)

      • isMetaAnnotation

        public static boolean isMetaAnnotation​(java.lang.annotation.Annotation annotation,
                                       java.lang.Iterable<java.lang.Class<? extends java.lang.annotation.Annotation>> metaAnnotationTypes)

      • isMetaAnnotation

        public static boolean isMetaAnnotation​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType,
                                       java.lang.Class<? extends java.lang.annotation.Annotation>... metaAnnotationTypes)

      • isMetaAnnotation

        public static boolean isMetaAnnotation​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType,
                                       java.lang.Iterable<java.lang.Class<? extends java.lang.annotation.Annotation>> metaAnnotationTypes)

      • getAllDeclaredAnnotations

        public static java.util.List<java.lang.annotation.Annotation> getAllDeclaredAnnotations​(java.lang.reflect.AnnotatedElement annotatedElement)
        Get all directly declared annotations of the annotated element, not including meta annotations.
        Parameters:
        annotatedElement - the annotated element
        Returns:
        non-null read-only List

      • getDeclaredAnnotations

        public static java.util.List<java.lang.annotation.Annotation> getDeclaredAnnotations​(java.lang.reflect.AnnotatedElement annotatedElement)
        Get the declared annotations that are directly present on this element. This method ignores inherited annotations.
        Parameters:
        annotatedElement - the annotated element
        Returns:
        non-null read-only List

      • findAllDeclaredAnnotations

        public static java.util.List<java.lang.annotation.Annotation> findAllDeclaredAnnotations​(java.lang.reflect.AnnotatedElement annotatedElement,
                                                                                         java.util.function.Predicate<? super java.lang.annotation.Annotation>... annotationsToFilter)
        Find all directly declared annotations of the annotated element with filters, not including meta annotations.
        Parameters:
        annotatedElement - the annotated element
        annotationsToFilter - the annotations to filter
        Returns:
        non-null read-only List

      • findAllDeclaredAnnotations

        public static java.util.List<java.lang.annotation.Annotation> findAllDeclaredAnnotations​(java.lang.Class<?> type,
                                                                                         java.util.function.Predicate<? super java.lang.annotation.Annotation>... annotationsToFilter)
        Get all directly declared annotations of the specified type and those all hierarchical types, not including meta annotations.
        Parameters:
        type - the specified type
        annotationsToFilter - the annotations to filter
        Returns:
        non-null read-only List

      • findDeclaredAnnotations

        public static java.util.List<java.lang.annotation.Annotation> findDeclaredAnnotations​(java.lang.reflect.AnnotatedElement annotatedElement,
                                                                                      java.util.function.Predicate<? super java.lang.annotation.Annotation>... annotationsToFilter)
        Find the declared annotations that are directly present on this element with filters. This method ignores inherited annotations.
        Parameters:
        annotatedElement - the annotated element
        annotationsToFilter - the annotations to filter
        Returns:
        non-null read-only List

      • filterAnnotations

        public static java.util.List<java.lang.annotation.Annotation> filterAnnotations​(java.lang.annotation.Annotation[] annotations,
                                                                                java.util.function.Predicate<? super java.lang.annotation.Annotation>... annotationsToFilter)

      • filterAnnotations

        public static java.util.List<java.lang.annotation.Annotation> filterAnnotations​(java.util.List<java.lang.annotation.Annotation> annotations,
                                                                                java.util.function.Predicate<? super java.lang.annotation.Annotation>... annotationsToFilter)

      • findAttributeValue

        public static <T> T findAttributeValue​(java.lang.annotation.Annotation[] annotations,
                                       java.lang.String attributeName)
        Find the attribute value from the specified annotations
        Type Parameters:
        T - attribute value type
        Parameters:
        annotations - the annotations to be found
        attributeName - attribute name
        Returns:
        attribute value if found, otherwise null

      • getAttributeValue

        public static <T> T getAttributeValue​(java.lang.annotation.Annotation annotation,
                                      java.lang.String attributeName)
        Get the attribute value of the annotation
        Type Parameters:
        T - attribute value type
        Parameters:
        annotation - annotation
        attributeName - attribute name
        Returns:
        attribute value if found, otherwise null

      • getAttributesMap

        public static java.util.Map<java.lang.String,​java.lang.Object> getAttributesMap​(java.lang.annotation.Annotation annotation)
        Get the attributes map from the specified annotation
        Parameters:
        annotation - the specified annotation
        Returns:
        non-null read-only Map

      • findAttributesMap

        public static java.util.Map<java.lang.String,​java.lang.Object> findAttributesMap​(java.lang.annotation.Annotation annotation,
                                                                                       java.lang.String... attributeNamesToFilter)
        Find the attributes map from the specified annotation by the attribute names
        Parameters:
        annotation - the specified annotation
        attributeNamesToFilter - the attribute names to filter
        Returns:
        non-null read-only Map

      • findAttributesMap

        public static java.util.Map<java.lang.String,​java.lang.Object> findAttributesMap​(java.lang.annotation.Annotation annotation,
                                                                                       java.util.function.Predicate<? super java.lang.reflect.Method>... attributesToFilter)
        Find the attributes map from the specified annotation by the attribute method
        Parameters:
        annotation - the specified annotation
        attributesToFilter - the attribute methods to filter
        Returns:
        non-null read-only Map

      • exists

        public static boolean exists​(java.lang.annotation.Annotation[] annotations,
                             java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

      • exists

        public static boolean exists​(java.util.Collection<java.lang.annotation.Annotation> annotations,
                             java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

      • exists

        public static boolean exists​(java.lang.Iterable<java.lang.annotation.Annotation> annotations,
                             java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

      • isAnnotationPresent

        public static boolean isAnnotationPresent​(java.lang.reflect.AnnotatedElement[] annotatedElements,
                                          java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

      • isAnnotationPresent

        public static boolean isAnnotationPresent​(java.lang.reflect.AnnotatedElement annotatedElement,
                                          java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

      • isAnnotationPresent

        public static boolean isAnnotationPresent​(java.lang.annotation.Annotation annotation,
                                          java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

      • isAnnotationPresent

        public static boolean isAnnotationPresent​(java.lang.reflect.AnnotatedElement annotatedElement,
                                          java.lang.Iterable<java.lang.Class<? extends java.lang.annotation.Annotation>> annotationTypes)

      • isAnnotationPresent

        public static boolean isAnnotationPresent​(java.lang.annotation.Annotation annotation,
                                          java.lang.Iterable<java.lang.Class<? extends java.lang.annotation.Annotation>> annotationTypes)

      • isAnnotationInterfaceMethod

        public static boolean isAnnotationInterfaceMethod​(java.lang.reflect.Method attributeMethod)
        Is the specified method declared by the Annotation interface or not
        Parameters:
        attributeMethod - the attribute method
        Returns:
        true if the specified method declared by the Annotation interface

      • isCallerSensitivePresent

        public static boolean isCallerSensitivePresent()
        Is jdk.internal.reflect.CallerSensitive class present or not
        Returns:
        true if jdk.internal.reflect.CallerSensitive presents
        See Also:
        CALLER_SENSITIVE_ANNOTATION_CLASS