io.micronaut.inject.visitor

Interface TypeElementVisitor<C,E>

Type Parameters:

C - The annotation required on the class. Use Object for all classes.

E - The annotation required on the element. Use Object for all elements.

All Superinterfaces:

Ordered, Toggleable

All Known Implementing Classes:

AsyncTypeElementVisitor, BeanImportVisitor, ContextConfigurerVisitor, ExecutableVisitor, GraalTypeElementVisitor, InternalApiTypeElementVisitor, IntrospectedTypeElementVisitor, RouteValidationVisitor, WebSocketVisitor

public interface TypeElementVisitor<C,E>
extends Ordered, Toggleable

Provides a hook into the compilation process to allow user defined functionality to be created at compile time.

Since:

1.0

Author:

James Kleeh

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TypeElementVisitor.VisitorKind Implementors of the TypeElementVisitor interface should specify what kind of visitor it is.

Field Summary

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method and Description
default void	finish(VisitorContext visitorContext) Called once when visitor processing finishes.
default String	getClassType()
default String	getElementType()
default Set<String>	getSupportedAnnotationNames()
default Set<String>	getSupportedOptions() Called once when processor loads.
default TypeElementVisitor.VisitorKind	getVisitorKind()
default void	start(VisitorContext visitorContext) Called once when visitor processing starts.
default void	visitClass(ClassElement element, VisitorContext context) Executed when a class is encountered that matches the <C> generic.
default void	visitConstructor(ConstructorElement element, VisitorContext context) Executed when a constructor is encountered that matches the <C> generic.
default void	visitEnumConstant(EnumConstantElement element, VisitorContext context) Executed when a enum constant is encountered that matches the <E> generic.
default void	visitField(FieldElement element, VisitorContext context) Executed when a field is encountered that matches the <E> generic.
default void	visitMethod(MethodElement element, VisitorContext context) Executed when a method is encountered that matches the <E> generic.

Methods inherited from interface io.micronaut.core.order.Ordered

getOrder

Methods inherited from interface io.micronaut.core.util.Toggleable

isEnabled

Method Detail

visitClass

default void visitClass(ClassElement element,
                        VisitorContext context)

Executed when a class is encountered that matches the <C> generic.

Parameters:

element - The element

context - The visitor context

visitMethod

default void visitMethod(MethodElement element,
                         VisitorContext context)

Executed when a method is encountered that matches the <E> generic.

Parameters:

element - The element

context - The visitor context

visitConstructor

default void visitConstructor(ConstructorElement element,
                              VisitorContext context)

Executed when a constructor is encountered that matches the <C> generic.

Parameters:

element - The element

context - The visitor context

visitField

default void visitField(FieldElement element,
                        VisitorContext context)

Executed when a field is encountered that matches the <E> generic.

Parameters:

element - The element

context - The visitor context

visitEnumConstant

default void visitEnumConstant(EnumConstantElement element,
                               VisitorContext context)

Executed when a enum constant is encountered that matches the <E> generic.

Parameters:

element - The element

context - The visitor context

Since:

3.6.0

start

default void start(VisitorContext visitorContext)

Called once when visitor processing starts.

Parameters:

visitorContext - The visitor context

finish

default void finish(VisitorContext visitorContext)

Called once when visitor processing finishes.

Parameters:

visitorContext - The visitor context

getSupportedAnnotationNames

default Set<String> getSupportedAnnotationNames()

Returns:

The supported default annotation names.

getClassType

default String getClassType()

getElementType

default String getElementType()

getSupportedOptions

default Set<String> getSupportedOptions()

Called once when processor loads. Used to expose visitors custom processor options.

Returns:

Set with custom options

getVisitorKind

@NonNull
default TypeElementVisitor.VisitorKind getVisitorKind()

Returns:

The visitor kind.