Package io.quarkus.arc.processor

Interface AnnotationsTransformer

All Superinterfaces:

org.jboss.jandex.AnnotationTransformation, BuildExtension

public interface AnnotationsTransformer
extends org.jboss.jandex.AnnotationTransformation, BuildExtension

Allows a build-time extension to override the annotations that exist on bean classes.

The container should use AnnotationStore to obtain annotations of any ClassInfo, FieldInfo and MethodInfo.

See Also:

• AnnotationsTransformer.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AnnotationsTransformer.AbstractBuilder<THIS extends AnnotationsTransformer.AbstractBuilder<THIS>>
static final class	AnnotationsTransformer.Builder	A common AnnotationsTransformer builder.
static final class	AnnotationsTransformer.ClassTransformerBuilder
static final class	AnnotationsTransformer.FieldTransformerBuilder
static final class	AnnotationsTransformer.MethodTransformerBuilder
static interface	AnnotationsTransformer.TransformationContext	A transformation context.

Nested classes/interfaces inherited from interface org.jboss.jandex.AnnotationTransformation

org.jboss.jandex.AnnotationTransformation.ClassBuilder, org.jboss.jandex.AnnotationTransformation.DeclarationBuilder, org.jboss.jandex.AnnotationTransformation.FieldBuilder, org.jboss.jandex.AnnotationTransformation.MethodBuilder, org.jboss.jandex.AnnotationTransformation.MethodParameterBuilder, org.jboss.jandex.AnnotationTransformation.RecordComponentBuilder

Nested classes/interfaces inherited from interface io.quarkus.arc.processor.BuildExtension

BuildExtension.BuildContext, BuildExtension.Key<T>, BuildExtension.SimpleKey<V>

Field Summary

Fields inherited from interface org.jboss.jandex.AnnotationTransformation

DEFAULT_PRIORITY_VALUE

Fields inherited from interface io.quarkus.arc.processor.BuildExtension

DEFAULT_PRIORITY

Method Summary

Modifier and Type	Method	Description
static AnnotationsTransformer.ClassTransformerBuilder	appliedToClass()
static AnnotationsTransformer.FieldTransformerBuilder	appliedToField()
static AnnotationsTransformer.MethodTransformerBuilder	appliedToMethod()
default boolean	appliesTo(org.jboss.jandex.AnnotationTarget.Kind kind)	By default, the transformation is applied to all kinds of targets.
default void	apply(org.jboss.jandex.AnnotationTransformation.TransformationContext context)
static AnnotationsTransformer.Builder	builder()
default int	priority()
default boolean	requiresCompatibleMode()
default boolean	supports(org.jboss.jandex.AnnotationTarget.Kind kind)
void	transform(AnnotationsTransformer.TransformationContext transformationContext)	The transformation context is used to perform the transformation.

Methods inherited from interface io.quarkus.arc.processor.BuildExtension

getPriority, initialize

Method Details

appliesTo

default boolean appliesTo(org.jboss.jandex.AnnotationTarget.Kind kind)

By default, the transformation is applied to all kinds of targets.

Parameters:

kind -

Returns:

true if the transformation applies to the specified kind, false otherwise

transform

void transform(AnnotationsTransformer.TransformationContext transformationContext)

The transformation context is used to perform the transformation. In particular, AnnotationsTransformer.TransformationContext.transform() returns a new transformation object that can be used to alter annotation metadata. Note that the transformation is not applied until the Transformation.done() method is invoked.

Parameters:

transformationContext -

priority

default int priority()

Specified by:

priority in interface org.jboss.jandex.AnnotationTransformation

supports

default boolean supports(org.jboss.jandex.AnnotationTarget.Kind kind)

Specified by:

supports in interface org.jboss.jandex.AnnotationTransformation

apply

default void apply(org.jboss.jandex.AnnotationTransformation.TransformationContext context)

Specified by:

apply in interface org.jboss.jandex.AnnotationTransformation

requiresCompatibleMode

default boolean requiresCompatibleMode()

Specified by:

requiresCompatibleMode in interface org.jboss.jandex.AnnotationTransformation

builder

static AnnotationsTransformer.Builder builder()

Returns:

a new builder instance

See Also:

• appliedToMethod()
• appliedToField()
• appliedToClass()

appliedToMethod

static AnnotationsTransformer.MethodTransformerBuilder appliedToMethod()

Returns:

a new builder to transform methods

appliedToField

static AnnotationsTransformer.FieldTransformerBuilder appliedToField()

Returns:

a new builder to transform fields

appliedToClass

static AnnotationsTransformer.ClassTransformerBuilder appliedToClass()

Returns:

a new builder to transform class