org.springframework.test.util

Class MetaAnnotationUtils.AnnotationDescriptor<T extends Annotation>

java.lang.Object

org.springframework.test.util.MetaAnnotationUtils.AnnotationDescriptor<T>

Type Parameters:

T - the annotation type

Direct Known Subclasses:

MetaAnnotationUtils.UntypedAnnotationDescriptor

Enclosing class:

MetaAnnotationUtils

public static class MetaAnnotationUtils.AnnotationDescriptor<T extends Annotation>
extends Object

Descriptor for an Annotation, including the class on which the annotation is declared as well as the actual annotation instance.

If the annotation is used as a meta-annotation, the descriptor also includes the composed annotation on which the annotation is present. In such cases, the root declaring class is not directly annotated with the annotation but rather indirectly via the composed annotation.

Given the following example, if we are searching for the @Transactional annotation on the TransactionalTests class, then the properties of the AnnotationDescriptor would be as follows.

• rootDeclaringClass: TransactionalTests class object
• declaringClass: TransactionalTests class object
• composedAnnotation: null
• annotation: instance of the Transactional annotation

 @Transactional
 @ContextConfiguration({"/test-datasource.xml", "/repository-config.xml"})
 public class TransactionalTests { }
 

Given the following example, if we are searching for the @Transactional annotation on the UserRepositoryTests class, then the properties of the AnnotationDescriptor would be as follows.

• rootDeclaringClass: UserRepositoryTests class object
• declaringClass: RepositoryTests class object
• composedAnnotation: instance of the RepositoryTests annotation
• annotation: instance of the Transactional annotation

 @Transactional
 @ContextConfiguration({"/test-datasource.xml", "/repository-config.xml"})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface RepositoryTests { }

 @RepositoryTests
 public class UserRepositoryTests { }
 

Constructor Summary

Constructors

Constructor and Description
AnnotationDescriptor(Class<?> rootDeclaringClass, Class<?> declaringClass, Annotation composedAnnotation, T annotation)
AnnotationDescriptor(Class<?> rootDeclaringClass, T annotation)

Method Summary

Modifier and Type	Method and Description
T	getAnnotation()
AnnotationAttributes	getAnnotationAttributes()
Class<? extends Annotation>	getAnnotationType()
Annotation	getComposedAnnotation()
Class<? extends Annotation>	getComposedAnnotationType()
Class<?>	getDeclaringClass()
Class<?>	getRootDeclaringClass()
T	synthesizeAnnotation() Synthesize the merged AnnotationAttributes in this descriptor back into an annotation of the target annotation type.
String	toString() Provide a textual representation of this AnnotationDescriptor.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationDescriptor

public AnnotationDescriptor(Class<?> rootDeclaringClass,
                            T annotation)

AnnotationDescriptor

public AnnotationDescriptor(Class<?> rootDeclaringClass,
                            Class<?> declaringClass,
                            @Nullable
                            Annotation composedAnnotation,
                            T annotation)

Method Detail

getRootDeclaringClass

public Class<?> getRootDeclaringClass()

getDeclaringClass

public Class<?> getDeclaringClass()

getAnnotation

public T getAnnotation()

synthesizeAnnotation

public T synthesizeAnnotation()

Synthesize the merged AnnotationAttributes in this descriptor back into an annotation of the target annotation type.

Since:

4.2

See Also:

getAnnotationAttributes(), getAnnotationType(), AnnotationUtils.synthesizeAnnotation(java.util.Map, Class, java.lang.reflect.AnnotatedElement)

getAnnotationType

public Class<? extends Annotation> getAnnotationType()

getAnnotationAttributes

public AnnotationAttributes getAnnotationAttributes()

getComposedAnnotation

@Nullable
public Annotation getComposedAnnotation()

getComposedAnnotationType

@Nullable
public Class<? extends Annotation> getComposedAnnotationType()

toString

public String toString()

Provide a textual representation of this AnnotationDescriptor.

Overrides:

toString in class Object