Class AnnotationTransformation.Builder<THIS extends AnnotationTransformation.Builder<THIS>>

java.lang.Object

org.jboss.jandex.AnnotationTransformation.Builder<THIS>

Type Parameters:

THIS - type of this builder

Direct Known Subclasses:

AnnotationTransformation.ClassBuilder, AnnotationTransformation.DeclarationBuilder, AnnotationTransformation.FieldBuilder, AnnotationTransformation.MethodBuilder, AnnotationTransformation.MethodParameterBuilder, AnnotationTransformation.RecordComponentBuilder

Enclosing interface:

AnnotationTransformation

public abstract static class AnnotationTransformation.Builder<THIS extends AnnotationTransformation.Builder<THIS>>
extends Object

Abstract class for annotation transformation builders.

Since:

3.2.0

See Also:

• priority(int)
• whenAnyMatch(Class...)
• whenAnyMatch(DotName...)
• whenAnyMatch(List)
• whenAnyMatch(Predicate)
• whenAllMatch(Class...)
• whenAllMatch(DotName...)
• whenAllMatch(List)
• whenAllMatch(Predicate)
• whenNoneMatch(Class...)
• whenNoneMatch(DotName...)
• whenNoneMatch(List)
• whenNoneMatch(Predicate)
• when(Predicate)
• AnnotationTransformation.DeclarationBuilder
• AnnotationTransformation.ClassBuilder
• AnnotationTransformation.FieldBuilder
• AnnotationTransformation.MethodBuilder
• AnnotationTransformation.MethodParameterBuilder
• AnnotationTransformation.RecordComponentBuilder

Field Summary

Fields

Modifier and Type	Field	Description
private final AnnotationTarget.Kind	kind
private Predicate<AnnotationTransformation.TransformationContext>	predicate
private int	priority

Constructor Summary

Constructors

Constructor	Description
Builder(AnnotationTarget.Kind kind)

Method Summary

Modifier and Type	Method	Description
private static Predicate<AnnotationInstance>	annotationPredicate(Class<? extends Annotation>... classes)
private static Predicate<AnnotationInstance>	annotationPredicate(DotName... classes)
final THIS	priority(int priority)	Sets the priority of the built annotation transformation.
(package private) THIS	self()
AnnotationTransformation	transform(Consumer<AnnotationTransformation.TransformationContext> transformation)	Builds an annotation transformation based on the given transformation function.
THIS	when(Predicate<AnnotationTransformation.TransformationContext> predicate)	Adds a predicate to the list of predicates that will be tested before applying the transformation.
final THIS	whenAllMatch(Class<? extends Annotation>... classes)	Adds a predicate that tests whether all of the current set of annotations are of given classes.
final THIS	whenAllMatch(Predicate<AnnotationInstance> predicate)	Adds a predicate that tests whether all of the current set of annotations match the given predicate.
final THIS	whenAllMatch(List<DotName> classes)	Adds a predicate that tests whether all of the current set of annotations are of given classes.
final THIS	whenAllMatch(DotName... classes)	Adds a predicate that tests whether all of the current set of annotations are of given classes.
final THIS	whenAnyMatch(Class<? extends Annotation>... classes)	Adds a predicate that tests whether any of the current set of annotations is of given classes.
final THIS	whenAnyMatch(Predicate<AnnotationInstance> predicate)	Adds a predicate that tests whether any of the current set of annotations matches the given predicate.
final THIS	whenAnyMatch(List<DotName> classes)	Adds a predicate that tests whether any of the current set of annotations is of given classes.
final THIS	whenAnyMatch(DotName... classes)	Adds a predicate that tests whether any of the current set of annotations is of given classes.
final THIS	whenNoneMatch(Class<? extends Annotation>... classes)	Adds a predicate that tests whether none of the current set of annotations is of given classes.
final THIS	whenNoneMatch(Predicate<AnnotationInstance> predicate)	Adds a predicate that tests whether none of the current set of annotations matches the given predicate.
final THIS	whenNoneMatch(List<DotName> classes)	Adds a predicate that tests whether none of the current set of annotations is of given classes.
final THIS	whenNoneMatch(DotName... classes)	Adds a predicate that tests whether none of the current set of annotations is of given classes.

Methods inherited from class Object

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

Field Details

kind

private final AnnotationTarget.Kind kind

priority

private int priority

predicate

private Predicate<AnnotationTransformation.TransformationContext> predicate

Constructor Details

Builder

Builder(AnnotationTarget.Kind kind)

Method Details

priority

public final THIS priority(int priority)

Sets the priority of the built annotation transformation. By default, the priority is AnnotationTransformation.DEFAULT_PRIORITY_VALUE.

Parameters:

priority - the priority

Returns:

this builder

annotationPredicate

@SafeVarargs
private static Predicate<AnnotationInstance> annotationPredicate(Class<? extends Annotation>... classes)

annotationPredicate

private static Predicate<AnnotationInstance> annotationPredicate(DotName... classes)

whenAnyMatch

@SafeVarargs
public final THIS whenAnyMatch(Class<? extends Annotation>... classes)

Adds a predicate that tests whether any of the current set of annotations is of given classes.

Parameters:

classes - the annotation classes, must not be null

Returns:

this builder

See Also:

• when(Predicate)

whenAnyMatch

public final THIS whenAnyMatch(DotName... classes)

Adds a predicate that tests whether any of the current set of annotations is of given classes.

Parameters:

classes - the annotation classes, must not be null

Returns:

this builder

See Also:

• when(Predicate)

whenAnyMatch

public final THIS whenAnyMatch(List<DotName> classes)

Adds a predicate that tests whether any of the current set of annotations is of given classes.

Parameters:

classes - the annotation classes, must not be null

Returns:

this builder

See Also:

• when(Predicate)

whenAnyMatch

public final THIS whenAnyMatch(Predicate<AnnotationInstance> predicate)

Adds a predicate that tests whether any of the current set of annotations matches the given predicate.

Parameters:

predicate - the predicate, must not be null

Returns:

this builder

See Also:

• when(Predicate)

whenAllMatch

@SafeVarargs
public final THIS whenAllMatch(Class<? extends Annotation>... classes)

Adds a predicate that tests whether all of the current set of annotations are of given classes.

Parameters:

classes - the annotation classes, must not be null

Returns:

this builder

See Also:

• when(Predicate)

whenAllMatch

public final THIS whenAllMatch(DotName... classes)

Adds a predicate that tests whether all of the current set of annotations are of given classes.

Parameters:

classes - the annotation classes, must not be null

Returns:

this builder

See Also:

• when(Predicate)

whenAllMatch

public final THIS whenAllMatch(List<DotName> classes)

Adds a predicate that tests whether all of the current set of annotations are of given classes.

Parameters:

classes - the annotation classes, must not be null

Returns:

this builder

See Also:

• when(Predicate)

whenAllMatch

public final THIS whenAllMatch(Predicate<AnnotationInstance> predicate)

Adds a predicate that tests whether all of the current set of annotations match the given predicate.

Parameters:

predicate - the predicate, must not be null

Returns:

this builder

See Also:

• when(Predicate)

whenNoneMatch

@SafeVarargs
public final THIS whenNoneMatch(Class<? extends Annotation>... classes)

Adds a predicate that tests whether none of the current set of annotations is of given classes.

Parameters:

classes - the annotation classes, must not be null

Returns:

this builder

See Also:

• when(Predicate)

whenNoneMatch

public final THIS whenNoneMatch(DotName... classes)

Adds a predicate that tests whether none of the current set of annotations is of given classes.

Parameters:

classes - the annotation classes, must not be null

Returns:

this builder

See Also:

• when(Predicate)

whenNoneMatch

public final THIS whenNoneMatch(List<DotName> classes)

Adds a predicate that tests whether none of the current set of annotations is of given classes.

Parameters:

classes - the annotation classes, must not be null

Returns:

this builder

See Also:

• when(Predicate)

whenNoneMatch

public final THIS whenNoneMatch(Predicate<AnnotationInstance> predicate)

Adds a predicate that tests whether none of the current set of annotations matches the given predicate.

Parameters:

predicate - the predicate, must not be null

Returns:

this builder

See Also:

• when(Predicate)

when

public THIS when(Predicate<AnnotationTransformation.TransformationContext> predicate)

Adds a predicate to the list of predicates that will be tested before applying the transformation. If some of the predicates returns false, the transformation is not applied. In other words, the predicates are combined using logical and (conjunction).

Parameters:

predicate - the predicate, must not be null

Returns:

this builder

transform

public AnnotationTransformation transform(Consumer<AnnotationTransformation.TransformationContext> transformation)

Builds an annotation transformation based on the given transformation function.

Parameters:

transformation - the transformation function, must not be null

Returns:

the built annotation transformation, never null

self

THIS self()