org.apache.juneau.reflect

Class AnnotationInfo<T extends Annotation>

java.lang.Object

org.apache.juneau.reflect.AnnotationInfo<T>

Type Parameters:

T - The annotation type.

public class AnnotationInfo<T extends Annotation>
extends Object

Represents an annotation instance on a class and the class it was found on.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnnotationInfo(ClassInfo c, MethodInfo m, Package p, T a) Constructor.

Method Summary

Modifier and Type	Method and Description
T	getAnnotation() Returns the annotation found.
ClassInfo	getClassInfo() Returns the class that this annotation was found on.
ClassInfo	getClassOn() Returns the class where the annotation was found.
ConfigApply<Annotation>	getConfigApply(VarResolverSession vrs) If this annotation has a PropertyStoreApply annotation, returns an instance of the specified ConfigApply class.
MethodInfo	getMethodOn() Returns the method where the annotation was found.
Package	getPackageOn() Returns the package where the annotation was found.
boolean	hasAnnotation(Class<? extends Annotation> a) Returns true if this annotation has the specified annotation defined on it.
boolean	isType(Class<? extends Annotation> a) Returns true if this annotation is the specified type.
static <T extends Annotation> AnnotationInfo<T>	of(ClassInfo c, T a) Convenience constructor when annotation is found on a class.
static <T extends Annotation> AnnotationInfo<T>	of(MethodInfo m, T a) Convenience constructor when annotation is found on a method.
static <T extends Annotation> AnnotationInfo<T>	of(Package p, T a) Convenience constructor when annotation is found on a package.
ObjectMap	toObjectMap() Converts this object to a readable JSON object for debugging purposes.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationInfo

protected AnnotationInfo(ClassInfo c,
                         MethodInfo m,
                         Package p,
                         T a)

Constructor.

Parameters:

c - The class where the annotation was found.

m - The method where the annotation was found.

p - The package where the annotation was found.

a - The annotation found.

Method Detail

of

public static <T extends Annotation> AnnotationInfo<T> of(ClassInfo c,
                                                          T a)

Convenience constructor when annotation is found on a class.

Parameters:

c - The class where the annotation was found.

a - The annotation found.

Returns:

A new AnnotationInfo object.

of

public static <T extends Annotation> AnnotationInfo<T> of(MethodInfo m,
                                                          T a)

Convenience constructor when annotation is found on a method.

Parameters:

m - The method where the annotation was found.

a - The annotation found.

Returns:

A new AnnotationInfo object.

of

public static <T extends Annotation> AnnotationInfo<T> of(Package p,
                                                          T a)

Convenience constructor when annotation is found on a package.

Parameters:

p - The package where the annotation was found.

a - The annotation found.

Returns:

A new AnnotationInfo object.

getClassOn

public ClassInfo getClassOn()

Returns the class where the annotation was found.

Returns:

the class where the annotation was found, or null if it wasn't found on a method.

getMethodOn

public MethodInfo getMethodOn()

Returns the method where the annotation was found.

Returns:

the method where the annotation was found, or null if it wasn't found on a method.

getPackageOn

public Package getPackageOn()

Returns the package where the annotation was found.

Returns:

the package where the annotation was found, or null if it wasn't found on a package.

getAnnotation

public T getAnnotation()

Returns the annotation found.

Returns:

The annotation found.

toObjectMap

public ObjectMap toObjectMap()

Converts this object to a readable JSON object for debugging purposes.

Returns:

A new map showing the attributes of this object as a JSON object.

getConfigApply

public ConfigApply<Annotation> getConfigApply(VarResolverSession vrs)
                                       throws ExecutableException

If this annotation has a PropertyStoreApply annotation, returns an instance of the specified ConfigApply class.

Parameters:

vrs - Variable resolver passed to the ConfigApply object.

Returns:

A new ConfigApply object. Never null.

Throws:

ExecutableException - Exception occurred on invoked constructor/method/field.

getClassInfo

public ClassInfo getClassInfo()

Returns the class that this annotation was found on.

Returns:

The class that this annotation was found on, or null if it was found on a package.

isType

public boolean isType(Class<? extends Annotation> a)

Returns true if this annotation is the specified type.

Parameters:

a - The type to test against.

Returns:

true if this annotation is the specified type.

hasAnnotation

public boolean hasAnnotation(Class<? extends Annotation> a)

Returns true if this annotation has the specified annotation defined on it.

Parameters:

a - The annotation to test for.

Returns:

true if this annotation has the specified annotation defined on it.

toString

public String toString()

Overrides:

toString in class Object