Package io.micronaut.context.visitor

Class InternalApiTypeElementVisitor

java.lang.Object

io.micronaut.context.visitor.InternalApiTypeElementVisitor

All Implemented Interfaces:

Ordered, Toggleable, TypeElementVisitor<Object,Object>

@Internal
public class InternalApiTypeElementVisitor
extends Object
implements TypeElementVisitor<Object,Object>

Logs warnings during compilation if any class extends an internal or experimental Micronaut API.

Since:

1.1.0

Author:

James Kleeh

Nested Class Summary

Nested classes/interfaces inherited from interface io.micronaut.inject.visitor.TypeElementVisitor

TypeElementVisitor.VisitorKind

Field Summary

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
InternalApiTypeElementVisitor()

Method Summary

Modifier and Type	Method	Description
void	finish(VisitorContext visitorContext)	Called once when visitor processing finishes.
Set<String>	getSupportedAnnotationNames()
Set<String>	getSupportedOptions()	Called once when processor loads.
@NonNull TypeElementVisitor.VisitorKind	getVisitorKind()
void	visitClass(ClassElement element, VisitorContext context)	Executed when a class is encountered that matches the <C> generic.
void	visitConstructor(ConstructorElement element, VisitorContext context)	Executed when a constructor is encountered that matches the <C> generic.
void	visitMethod(MethodElement element, VisitorContext context)	Executed when a method is encountered that matches the <E> generic.

Methods inherited from class java.lang.Object

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

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

getOrder

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

isEnabled

Methods inherited from interface io.micronaut.inject.visitor.TypeElementVisitor

getClassType, getElementType, start, visitEnumConstant, visitField

Constructor Details

InternalApiTypeElementVisitor

public InternalApiTypeElementVisitor()

Method Details

getSupportedAnnotationNames

public Set<String> getSupportedAnnotationNames()

Specified by:

getSupportedAnnotationNames in interface TypeElementVisitor<Object,Object>

Returns:

The supported default annotation names.

getSupportedOptions

public Set<String> getSupportedOptions()

Description copied from interface: TypeElementVisitor

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

Specified by:

getSupportedOptions in interface TypeElementVisitor<Object,Object>

Returns:

Set with custom options

getVisitorKind

@NonNull
public @NonNull TypeElementVisitor.VisitorKind getVisitorKind()

Specified by:

getVisitorKind in interface TypeElementVisitor<Object,Object>

Returns:

The visitor kind.

visitClass

public void visitClass(ClassElement element,
 VisitorContext context)

Description copied from interface: TypeElementVisitor

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

Specified by:

visitClass in interface TypeElementVisitor<Object,Object>

Parameters:

element - The element

context - The visitor context

visitMethod

public void visitMethod(MethodElement element,
 VisitorContext context)

Description copied from interface: TypeElementVisitor

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

Specified by:

visitMethod in interface TypeElementVisitor<Object,Object>

Parameters:

element - The element

context - The visitor context

visitConstructor

public void visitConstructor(ConstructorElement element,
 VisitorContext context)

Description copied from interface: TypeElementVisitor

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

Specified by:

visitConstructor in interface TypeElementVisitor<Object,Object>

Parameters:

element - The element

context - The visitor context

finish

public void finish(VisitorContext visitorContext)

Description copied from interface: TypeElementVisitor

Called once when visitor processing finishes.

Specified by:

finish in interface TypeElementVisitor<Object,Object>

Parameters:

visitorContext - The visitor context