cz.ues.platform.essentials.annotations

Class AnnotationHelper

java.lang.Object

cz.ues.platform.essentials.annotations.AnnotationHelper

public final class AnnotationHelper
extends java.lang.Object

AnnotationHelper provides some utility methods to simplify the usage of annotations in reflection code.

Since:

UES6-00

Constructor Summary

Constructors

Modifier	Constructor and Description
private	AnnotationHelper() AnnotationHelper is utility class and will be never instantiated.

Method Summary

Methods

Modifier and Type	Method and Description
static <A extends java.lang.annotation.Annotation> A	getAnnotation(java.lang.reflect.AnnotatedElement aElement, java.lang.Object aOwner, java.lang.Class<A> aAnnotation, boolean aTraverse) Reads annotation from specified element or optionally from owner elements.
protected static <A extends java.lang.annotation.Annotation> A	getAnnotation0(java.lang.Class<?> aService, java.lang.Class<?> aOwner, java.lang.Class<A> aAnnotation, boolean aTraverse) Reads annotation from given service interface or implementation class.
protected static <A extends java.lang.annotation.Annotation> A	getAnnotation0(java.lang.reflect.Field aField, java.lang.Class<?> aOwner, java.lang.Class<A> aAnnotation, boolean aTraverse) Reads annotation from given field.
protected static <A extends java.lang.annotation.Annotation> A	getAnnotation0(java.lang.reflect.Method aMethod, java.lang.Class<?> aOwner, java.lang.Class<A> aAnnotation, boolean aTraverse) Reads annotation from given method.
protected static <A extends java.lang.annotation.Annotation> A	getAnnotation0(java.lang.Package aPackage, java.lang.Class<?> aOwner, java.lang.Class<A> aAnnotation, boolean aTraverse) Reads annotation from given package.
static <T> T	getAnnotationAttributeValue(java.lang.annotation.Annotation annot, java.lang.String attributeName)
private static java.lang.reflect.Method	getInterfaceMethod(java.lang.Class<?> aClass, java.lang.reflect.Method aMethod) Finds specified method on some interface of given Class.
private static java.lang.Class<?>	getOwnerClass(java.lang.Object aOwner) Returns class of given owner object.
private static java.lang.Class<?>	getServiceInterface(java.lang.Class<?> aServiceClass) Returns interface of class.
private static boolean	hasElementType(java.lang.Class<? extends java.lang.annotation.Annotation> aAnnotation, java.lang.annotation.ElementType aType) Check if annotation has declared given element type.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationHelper

private AnnotationHelper()

AnnotationHelper is utility class and will be never instantiated.

Since:

UES6-00

Method Detail

getAnnotation

public static final <A extends java.lang.annotation.Annotation> A getAnnotation(java.lang.reflect.AnnotatedElement aElement,
java.lang.Object aOwner,
java.lang.Class<A> aAnnotation,
boolean aTraverse)

Reads annotation from specified element or optionally from owner elements. See UES Platform documentation to read annotation hierarchy rules.

Type Parameters:

A - Annotation type.

Parameters:

aElement - Element (Method, Field, Class, Package) where to look for annotation

aOwner - Owner (Service instance or class) of annotated element, used for element type of Method or Field, may be null

aAnnotation - Class of annotation we are looking for

aTraverse - FALSE to read annotation only from given element, TRUE when traverse through next annotated elements.

Returns:

The found annotation or NULL

Since:

UES6-00

getAnnotation0

protected static final <A extends java.lang.annotation.Annotation> A getAnnotation0(java.lang.reflect.Method aMethod,
java.lang.Class<?> aOwner,
java.lang.Class<A> aAnnotation,
boolean aTraverse)

Reads annotation from given method.

Type Parameters:

A - Annotation type.

Parameters:

aMethod - Method where to look for annotation

aOwner - Owner (Service instance or class) of method, may be null

aAnnotation - Class of annotation we are looking for

aTraverse - FALSE to read annotation only from given method, TRUE when traverse through next annotated elements.

Returns:

The found annotation or NULL

Since:

UES6-00

getAnnotation0

protected static final <A extends java.lang.annotation.Annotation> A getAnnotation0(java.lang.reflect.Field aField,
java.lang.Class<?> aOwner,
java.lang.Class<A> aAnnotation,
boolean aTraverse)

Reads annotation from given field.

Type Parameters:

A - Annotation type.

Parameters:

aField - Field where to look for annotation

aOwner - Owner (Service instance or class) of field, may be null

aAnnotation - Class of annotation we are looking for

aTraverse - FALSE to read annotation only from given field, TRUE when traverse through next annotated elements.

Returns:

The found annotation or NULL

Since:

UES6-00

getAnnotation0

protected static final <A extends java.lang.annotation.Annotation> A getAnnotation0(java.lang.Class<?> aService,
java.lang.Class<?> aOwner,
java.lang.Class<A> aAnnotation,
boolean aTraverse)

Reads annotation from given service interface or implementation class.

Type Parameters:

A - Annotation type.

Parameters:

aService - Service class where to look for annotation

aOwner - This attribute is ignored

aAnnotation - Class of annotation we are looking for

aTraverse - FALSE to read annotation only from given service class, TRUE when traverse through next annotated elements.

Returns:

The found annotation or NULL

Since:

UES6-00

getAnnotation0

protected static <A extends java.lang.annotation.Annotation> A getAnnotation0(java.lang.Package aPackage,
java.lang.Class<?> aOwner,
java.lang.Class<A> aAnnotation,
boolean aTraverse)

Reads annotation from given package.

Type Parameters:

A - Annotation type.

Parameters:

aPackage - Package where to look for annotation

aOwner - This attribute is ignored

aAnnotation - Class of annotation we are looking for

aTraverse - FALSE to read annotation only from given package, TRUE when traverse through parent packages.

Returns:

The found annotation or NULL

Since:

UES6-00

getOwnerClass

private static final java.lang.Class<?> getOwnerClass(java.lang.Object aOwner)

Returns class of given owner object.

Parameters:

aOwner - Owner object of annotated element

Returns:

Class of owner object (or directly owner in case it is already instance of class)

Since:

UES6-00

hasElementType

private static final boolean hasElementType(java.lang.Class<? extends java.lang.annotation.Annotation> aAnnotation,
java.lang.annotation.ElementType aType)

Check if annotation has declared given element type.

Parameters:

aAnnotation - Annotation to be checked

aType - Expected element type

Returns:

TRUE if annotation declares element type, else FALSE

Since:

UES6-00

getInterfaceMethod

private static final java.lang.reflect.Method getInterfaceMethod(java.lang.Class<?> aClass,
java.lang.reflect.Method aMethod)

Finds specified method on some interface of given Class.

Parameters:

aClass - Class on which interface to look for method

aMethod - Method to be found

Returns:

Instance of Method object or null if method is not found on any interface

Since:

UES6-00

getServiceInterface

private static final java.lang.Class<?> getServiceInterface(java.lang.Class<?> aServiceClass)

Returns interface of class.

Parameters:

aServiceClass - Class which interface to return

Returns:

Interface of class, null of there is no interface or given Class is interface

Since:

UES6-00

getAnnotationAttributeValue

public static <T> T getAnnotationAttributeValue(java.lang.annotation.Annotation annot,
java.lang.String attributeName)