Package org.jboss.jandex

Interface AnnotationTransformation.TransformationContext

All Known Implementing Classes:

AnnotationOverlayImpl.TransformationContextImpl

Enclosing interface:

AnnotationTransformation

public static interface AnnotationTransformation.TransformationContext

A transformation context. Passed as a singular parameter to AnnotationTransformation.apply(TransformationContext).

See Also:

declaration(), annotations(), hasAnnotation(Class), hasAnnotation(DotName), hasAnnotation(Predicate), add(Class), add(AnnotationInstance), addAll(AnnotationInstance...), addAll(Collection), remove(Predicate), removeAll()

Method Summary

Modifier and Type	Method	Description
void	add(java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)	Adds an annotation of given annotationClass to the current set of annotations.
void	add(AnnotationInstance annotation)	Adds the annotation to the current set of annotations.
void	addAll(java.util.Collection<AnnotationInstance> annotations)	Adds all annotations to the current set of annotations.
void	addAll(AnnotationInstance... annotations)	Adds all annotations to the current set of annotations.
java.util.Collection<AnnotationInstance>	annotations()	Returns the collection of annotations present on the declaration that is being transformed.
Declaration	declaration()	Returns the declaration that is being transformed.
boolean	hasAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)	Returns whether the current set of annotations contains an annotation of given annotationClass.
boolean	hasAnnotation(java.util.function.Predicate<AnnotationInstance> predicate)	Returns whether the current set of annotations contains an annotation that matches given predicate.
boolean	hasAnnotation(DotName annotationName)	Returns whether the current set of annotations contains an annotation whose class has given annotationName.
void	remove(java.util.function.Predicate<AnnotationInstance> predicate)	Removes annotations that match given predicate from the current set of annotations.
void	removeAll()	Removes all annotations from current set of annotations.

Method Detail

declaration

Declaration declaration()

Returns the declaration that is being transformed.

Returns:

the declaration that is being transformed

annotations

java.util.Collection<AnnotationInstance> annotations()

Returns the collection of annotations present on the declaration that is being transformed. Reflects all changes done by this annotation transformation and all annotation transformations executed prior to this one.

Changes made directly to this collection and changes made through the other TransformationContext methods are interchangeable.

Returns:

the collection of annotations present on the declaration that is being transformed

hasAnnotation

boolean hasAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)

Returns whether the current set of annotations contains an annotation of given annotationClass.

Parameters:

annotationClass - the annotation class, must not be null

Returns:

whether the current set of annotations contains an annotation of given class

hasAnnotation

boolean hasAnnotation(DotName annotationName)

Returns whether the current set of annotations contains an annotation whose class has given annotationName.

Parameters:

annotationName - name of the annotation class, must not be null

Returns:

whether the current set of annotations contains an annotation of given class

hasAnnotation

boolean hasAnnotation(java.util.function.Predicate<AnnotationInstance> predicate)

Returns whether the current set of annotations contains an annotation that matches given predicate.

Parameters:

predicate - the predicate, must not be null

Returns:

whether the current set of annotations contains an annotation of given class

add

void add(java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)

Adds an annotation of given annotationClass to the current set of annotations.

The annotation type must have no members.

Parameters:

annotationClass - the class of annotation to add, must not be null

add

void add(AnnotationInstance annotation)

Adds the annotation to the current set of annotations.

Parameters:

annotation - the annotation to add, must not be null

addAll

void addAll(AnnotationInstance... annotations)

Adds all annotations to the current set of annotations.

Parameters:

annotations - the annotations to add, must not be null

addAll

void addAll(java.util.Collection<AnnotationInstance> annotations)

Adds all annotations to the current set of annotations.

Parameters:

annotations - the annotations to add, must not be null

remove

void remove(java.util.function.Predicate<AnnotationInstance> predicate)

Removes annotations that match given predicate from the current set of annotations.

Parameters:

predicate - the annotation predicate, must not be null

removeAll

void removeAll()

Removes all annotations from current set of annotations.