org.osgl.inject.util

Class AnnotationUtil

java.lang.Object

org.osgl.inject.util.AnnotationUtil

public class AnnotationUtil
extends java.lang.Object

Provides utility methods to deal with annotations.

Constructor Summary

Constructors

Constructor and Description
AnnotationUtil()

Method Summary

Modifier and Type	Method and Description
static <T extends java.lang.annotation.Annotation> T	createAnnotation(java.lang.Class<T> clazz) Create an annotation instance from annotation class.
static <T extends java.lang.annotation.Annotation> T	declaredAnnotation(java.lang.reflect.AnnotatedElement annotatedElement, java.lang.Class<T> annoClass) Return declared annotation with type annoClass from an AnnotatedElement.
static int	hashCode(java.lang.annotation.Annotation a) Generate a hash code for the given annotation using the algorithm presented in the Annotation.hashCode() API docs.
static int	hashMember(java.lang.String name, java.lang.Object value) Helper method for generating a hash code for a member of an annotation.
static <T extends java.lang.annotation.Annotation> T	tagAnnotation(java.lang.annotation.Annotation annotation, java.lang.Class<T> tagClass) Returns the Annotation tagged on another annotation instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationUtil

public AnnotationUtil()

Method Detail

declaredAnnotation

public static <T extends java.lang.annotation.Annotation> T declaredAnnotation(java.lang.reflect.AnnotatedElement annotatedElement,
                                                                               java.lang.Class<T> annoClass)

Return declared annotation with type annoClass from an AnnotatedElement.

Type Parameters:

T - the generic type of the annotation class

Parameters:

annotatedElement - the annotated element (could be class, method or field)

annoClass - the annotation class

Returns:

the annotation instance or null if not found

tagAnnotation

public static <T extends java.lang.annotation.Annotation> T tagAnnotation(java.lang.annotation.Annotation annotation,
                                                                          java.lang.Class<T> tagClass)

Returns the Annotation tagged on another annotation instance.

Type Parameters:

T - the generic type of the expected annotation

Parameters:

annotation - the annotation instance

tagClass - the expected annotation class

Returns:

the annotation tagged on annotation of type tagClass

createAnnotation

public static <T extends java.lang.annotation.Annotation> T createAnnotation(java.lang.Class<T> clazz)

Create an annotation instance from annotation class.

Type Parameters:

T - the generic type of the annoation

Parameters:

clazz - the annotation class

Returns:

the annotation instance

hashCode

public static int hashCode(java.lang.annotation.Annotation a)

Generate a hash code for the given annotation using the algorithm presented in the Annotation.hashCode() API docs.

Parameters:

a - the Annotation for a hash code calculation is desired, not null

Returns:

the calculated hash code

Throws:

java.lang.RuntimeException - if an Exception is encountered during annotation member access

java.lang.IllegalStateException - if an annotation method invocation returns null

hashMember

public static int hashMember(java.lang.String name,
                             java.lang.Object value)

Helper method for generating a hash code for a member of an annotation.

Parameters:

name - the name of the member

value - the value of the member

Returns:

a hash code for this member