hu.elte.eserial.util

Class AnnotationUtils

java.lang.Object

hu.elte.eserial.util.AnnotationUtils

public class AnnotationUtils
extends java.lang.Object

Utility class for EserialAnnotations.

Method Summary

Modifier and Type	Method and Description
static int	compare(java.lang.annotation.Annotation lhs, java.lang.annotation.Annotation rhs) Compares to EserialAnnotations according to their priorities.
static <T extends java.lang.annotation.Annotation> T	getAnnotation(EserialElement element, java.lang.Class<T> annotationClass)
static java.util.List<java.lang.annotation.Annotation>	getEserialAnnotations(Accessor accessor, EserialAnnotationType type)
static java.util.List<java.lang.annotation.Annotation>	getEserialAnnotations(java.lang.Class clazz, EserialAnnotationType type)
static java.util.List<java.lang.annotation.Annotation>	getEserialAnnotations(java.lang.reflect.Field field, EserialAnnotationType type)
static java.util.List<java.lang.annotation.Annotation>	getEserialAnnotations(java.util.List<java.lang.annotation.Annotation> annotations, EserialAnnotationType type)
static <T extends java.lang.annotation.Annotation> boolean	hasAnnotation(EserialElement element, java.lang.Class<T> annotationClass)
static boolean	isEserialAnnotation(java.lang.annotation.Annotation annotation)
static boolean	isMatchingEserialAnnotation(java.lang.annotation.Annotation annotation, EserialAnnotationType type)
static boolean	shouldIncludeElement(EserialElement element) Decides whether an element should be included depending on the EserialAnnotations on its field (if exists), accessor and containing class. The annotations are ordered by their priorities.

Methods inherited from class java.lang.Object

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

Method Detail

getEserialAnnotations

public static java.util.List<java.lang.annotation.Annotation> getEserialAnnotations(java.lang.reflect.Field field,
                                                                                    EserialAnnotationType type)

Parameters:

field - an arbitrary field

type - the type of EserialAnnotation

Returns:

a list of EserialAnnotations on the field

See Also:

getEserialAnnotations(List, EserialAnnotationType)

getEserialAnnotations

public static java.util.List<java.lang.annotation.Annotation> getEserialAnnotations(Accessor accessor,
                                                                                    EserialAnnotationType type)

Parameters:

accessor - a Getter or Setter

type - the type of EserialAnnotation

Returns:

a list of EserialAnnotations on the accessor method

getEserialAnnotations

public static java.util.List<java.lang.annotation.Annotation> getEserialAnnotations(java.lang.Class clazz,
                                                                                    EserialAnnotationType type)

Parameters:

clazz - a class

type - the type of EserialAnnotation

Returns:

a list of EserialAnnotations on the clazz

See Also:

getEserialAnnotations(List,EserialAnnotationType)

getEserialAnnotations

public static java.util.List<java.lang.annotation.Annotation> getEserialAnnotations(java.util.List<java.lang.annotation.Annotation> annotations,
                                                                                    EserialAnnotationType type)

Parameters:

annotations - a list of annotations

type - the type of EserialAnnotation

Returns:

the annotations list's annotations which have an EserialAnnotation on them

See Also:

isMatchingEserialAnnotation(java.lang.annotation.Annotation, hu.elte.eserial.annotation.enumeration.EserialAnnotationType)

isEserialAnnotation

public static boolean isEserialAnnotation(java.lang.annotation.Annotation annotation)

Parameters:

annotation - an annotation

Returns:

true if the has an EserialAnnotation on it

isMatchingEserialAnnotation

public static boolean isMatchingEserialAnnotation(java.lang.annotation.Annotation annotation,
                                                  EserialAnnotationType type)

Parameters:

annotation - an annotation

type - the type of EserialAnnotation

Returns:

true if the has an EserialAnnotation with the given type on it

compare

public static int compare(java.lang.annotation.Annotation lhs,
                          java.lang.annotation.Annotation rhs)

Compares to EserialAnnotations according to their priorities.

Parameters:

lhs - an EserialAnnotation

rhs - an EserialAnnotation

Returns:

the value 0 if lhs.priority() == rhs.priority(),
a value less than 0 if lhs.priority() > rhs.priority() and
a value greater than 0 if lhs.priority() < rhs.priority()

Throws:

EserialNotEserialAnnotationException - if lhs or rhs is not an EserialAnnotation

See Also:

Integer.compare(int, int)

hasAnnotation

public static <T extends java.lang.annotation.Annotation> boolean hasAnnotation(EserialElement element,
                                                                                java.lang.Class<T> annotationClass)

Type Parameters:

T - the type of the annotation

Parameters:

element - an element on which annotations are searched

annotationClass - the class of annotation to find

Returns:

true if there is an annotation with the given type for the element

getAnnotation

public static <T extends java.lang.annotation.Annotation> T getAnnotation(EserialElement element,
                                                                          java.lang.Class<T> annotationClass)

Type Parameters:

T - the type of the annotation for convenient casting of return value

Parameters:

element - an element on which annotations are searched

annotationClass - the class of annotation to find

Returns:

the annotation on the element with the given type or null if none was found

shouldIncludeElement

public static boolean shouldIncludeElement(EserialElement element)

Decides whether an element should be included depending on the EserialAnnotations on its field (if exists), accessor and containing class.
The annotations are ordered by their priorities.

Parameters:

element - an element containing an accessor and a field

Returns:

true if the element should be included

See Also:

EserialAnnotation.priority()