io.micronaut.annotation.processing.visitor

Class LoadedVisitor

java.lang.Object

io.micronaut.annotation.processing.visitor.LoadedVisitor

All Implemented Interfaces:

Ordered

@Internal
public class LoadedVisitor
extends java.lang.Object
implements Ordered

Used to store a reference to an underlying TypeElementVisitor and optionally invoke the visit methods on the visitor if it matches the element being visited by the annotation processor.

Since:

1.0

Author:

James Kleeh

Field Summary

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
LoadedVisitor(TypeElementVisitor visitor, JavaVisitorContext visitorContext, GenericUtils genericUtils, javax.annotation.processing.ProcessingEnvironment processingEnvironment)

Method Summary

Modifier and Type	Method and Description
int	getOrder()
TypeElementVisitor	getVisitor()
boolean	matches(AnnotationMetadata annotationMetadata)
boolean	matches(javax.lang.model.element.TypeElement typeElement)
java.lang.String	toString()
Element	visit(javax.lang.model.element.Element element, AnnotationMetadata annotationMetadata) Invoke the underlying visitor for the given element.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoadedVisitor

public LoadedVisitor(TypeElementVisitor visitor,
                     JavaVisitorContext visitorContext,
                     GenericUtils genericUtils,
                     javax.annotation.processing.ProcessingEnvironment processingEnvironment)

Parameters:

visitor - The TypeElementVisitor

visitorContext - The visitor context

genericUtils - The generic utils

processingEnvironment - The ProcessEnvironment

Method Detail

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

Returns:

The order of the object. Defaults to zero (no order).

getVisitor

public TypeElementVisitor getVisitor()

Returns:

The visitor

matches

public boolean matches(javax.lang.model.element.TypeElement typeElement)

Parameters:

typeElement - The class element

Returns:

True if the class element should be visited

matches

public boolean matches(AnnotationMetadata annotationMetadata)

Parameters:

annotationMetadata - The annotation data

Returns:

True if the element should be visited

visit

@Nullable
public Element visit(javax.lang.model.element.Element element,
                               AnnotationMetadata annotationMetadata)

Invoke the underlying visitor for the given element.

Parameters:

element - The element to visit

annotationMetadata - The annotation data for the node

Returns:

The element if one was created or null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object