io.ebean.util

Class AnnotationUtil

java.lang.Object

io.ebean.util.AnnotationUtil

public class AnnotationUtil
extends Object

Annotation utility methods to find annotations recursively - taken from the spring framework.

Constructor Summary

Constructors

Constructor and Description
AnnotationUtil()

Method Summary

Modifier and Type	Method and Description
static <A extends Annotation> A	findAnnotation(AnnotatedElement annotatedElement, Class<A> annotationType) Find a single Annotation of annotationType on the supplied AnnotatedElement.
static <A extends Annotation> A	findAnnotation(AnnotatedElement annotatedElement, Class<A> annotationType, io.ebean.annotation.Platform platform) Finds the first annotation of a type for this platform.
static <A extends Annotation> A	findAnnotationRecursive(Class<?> clazz, Class<A> annotationType) Find a single Annotation of annotationType on the supplied class.
static <A extends Annotation> Set<A>	findAnnotations(AnnotatedElement annotatedElement, Class<A> annotationType) Find all Annotations of annotationType on the supplied AnnotatedElement.
static <A extends Annotation> Set<A>	findAnnotationsRecursive(Class<?> clazz, Class<A> annotationType) Finds all annotations recusively for a class and its superclasses or interfaces.
static <T extends Annotation> T	getPlatformMatchingAnnotation(Set<T> anns, io.ebean.annotation.Platform matchPlatform) Finds a suitable annotation from Set anns for this platform.
static boolean	isInJavaLangAnnotationPackage(Annotation annotation) Determine if the supplied Annotation is defined in the core JDK java.lang.annotation package.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationUtil

public AnnotationUtil()

Method Detail

isInJavaLangAnnotationPackage

public static boolean isInJavaLangAnnotationPackage(Annotation annotation)

Determine if the supplied Annotation is defined in the core JDK java.lang.annotation package.

findAnnotation

public static <A extends Annotation> A findAnnotation(AnnotatedElement annotatedElement,
                                                      Class<A> annotationType)

Find a single Annotation of annotationType on the supplied AnnotatedElement.

Meta-annotations will be searched if the annotation is not directly present on the supplied element.

Warning: this method operates generically on annotated elements. In other words, this method does not execute specialized search algorithms for classes or methods. It only traverses through Annotations! It also does not filter out platform dependent annotations!

findAnnotationRecursive

public static <A extends Annotation> A findAnnotationRecursive(Class<?> clazz,
                                                               Class<A> annotationType)

Find a single Annotation of annotationType on the supplied class.

Meta-annotations will be searched if the annotation is not directly present on the supplied element.

Note: this method searches for annotations at class & superClass(es)!

findAnnotation

public static <A extends Annotation> A findAnnotation(AnnotatedElement annotatedElement,
                                                      Class<A> annotationType,
                                                      io.ebean.annotation.Platform platform)

Finds the first annotation of a type for this platform. (if annotation is platform specific, otherwise first found annotation is returned)

findAnnotationsRecursive

public static <A extends Annotation> Set<A> findAnnotationsRecursive(Class<?> clazz,
                                                                     Class<A> annotationType)

Finds all annotations recusively for a class and its superclasses or interfaces.

findAnnotations

public static <A extends Annotation> Set<A> findAnnotations(AnnotatedElement annotatedElement,
                                                            Class<A> annotationType)

Find all Annotations of annotationType on the supplied AnnotatedElement.

Meta-annotations will be searched if the annotation is not directly present on the supplied element.

Warning: this method operates generically on annotated elements. In other words, this method does not execute specialized search algorithms for classes or methods. It only traverses through Annotations!

getPlatformMatchingAnnotation

public static <T extends Annotation> T getPlatformMatchingAnnotation(Set<T> anns,
                                                                     io.ebean.annotation.Platform matchPlatform)

Finds a suitable annotation from Set anns for this platform. To distinguish between platforms, annotation type T must define a method withthis signature:

Class[] platforms() default {};

The finding rules are:

1. Check if T has method "platforms" if not, return ann[0]
2. find the annotation that is defined for databasePlatform
3. otherwise return the annotation for default platform (platforms = {})
4. return null

(This mechanism is currently used by Where and Formula)