io.micronaut.annotation.processing

Class TypeElementVisitorProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

io.micronaut.annotation.processing.TypeElementVisitorProcessor

All Implemented Interfaces:

Processor

Direct Known Subclasses:

AggregatingTypeElementVisitorProcessor

@SupportedOptions(value={"micronaut.processing.incremental","micronaut.processing.annotations","micronaut.processing.project.dir","micronaut.processing.group","micronaut.processing.module"})
public class TypeElementVisitorProcessor
extends AbstractProcessor

The annotation processed used to execute type element visitors.

Since:

1.0

Author:

James Kleeh, graemerocher

Field Summary

Fields

Modifier and Type	Field and Description
protected AnnotationUtils	annotationUtils
protected AnnotationProcessingOutputVisitor	classWriterOutputVisitor
protected Elements	elementUtils
protected Filer	filer
protected GenericUtils	genericUtils
protected static String	GRADLE_PROCESSING_AGGREGATING Constant for aggregating processor.
protected static String	GRADLE_PROCESSING_ISOLATING Constant for isolating processor.
protected JavaVisitorContext	javaVisitorContext
protected Messager	messager
protected static String	MICRONAUT_PROCESSING_ANNOTATIONS Annotation processor option used to add additional annotation patterns to process.
protected static String	MICRONAUT_PROCESSING_INCREMENTAL Annotation processor option used to activate incremental processing.
protected ModelUtils	modelUtils
protected Types	typeUtils
protected MutableConvertibleValues<Object>	visitorAttributes

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
TypeElementVisitorProcessor()

Method Summary

Modifier and Type	Method and Description
protected void	error(Element e, String msg, Object... args) Produce a compile error for the given element and message.
protected void	error(String msg, Object... args) Produce a compile error for the given message.
protected Collection<TypeElementVisitor>	findTypeElementVisitors() Discovers the TypeElementVisitor instances that are available.
protected TypeElementVisitor.VisitorKind	getIncrementalProcessorKind()
protected String	getIncrementalProcessorType()
protected List<LoadedVisitor>	getLoadedVisitors()
Set<String>	getSupportedAnnotationTypes()
Set<String>	getSupportedOptions()
SourceVersion	getSupportedSourceVersion()
protected TypeElementVisitor.VisitorKind	getVisitorKind() obtains the visitor kind.
void	init(ProcessingEnvironment processingEnv)
protected boolean	isIncremental(ProcessingEnvironment processingEnv) Whether incremental compilation is enabled.
protected boolean	isProcessedAnnotation(String annotationName) Return whether the given annotation is processed.
protected JavaVisitorContext	newVisitorContext(ProcessingEnvironment processingEnv) Creates the visitor context.
protected void	note(Element e, String msg, Object... args) Produce a compile note for the given element and message.
protected void	note(String msg, Object... args) Produce a compile note for the given element and message.
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
protected void	warning(Element e, String msg, Object... args) Produce a compile warning for the given element and message.
protected void	warning(String msg, Object... args) Produce a compile warning for the given message.

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, isInitialized

Methods inherited from class java.lang.Object

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

Field Detail

MICRONAUT_PROCESSING_INCREMENTAL

protected static final String MICRONAUT_PROCESSING_INCREMENTAL

Annotation processor option used to activate incremental processing.

See Also:

Constant Field Values

MICRONAUT_PROCESSING_ANNOTATIONS

protected static final String MICRONAUT_PROCESSING_ANNOTATIONS

Annotation processor option used to add additional annotation patterns to process.

See Also:

Constant Field Values

GRADLE_PROCESSING_AGGREGATING

protected static final String GRADLE_PROCESSING_AGGREGATING

Constant for aggregating processor.

See Also:

Constant Field Values

GRADLE_PROCESSING_ISOLATING

protected static final String GRADLE_PROCESSING_ISOLATING

Constant for isolating processor.

See Also:

Constant Field Values

messager

protected Messager messager

filer

protected Filer filer

elementUtils

protected Elements elementUtils

typeUtils

protected Types typeUtils

annotationUtils

protected AnnotationUtils annotationUtils

genericUtils

protected GenericUtils genericUtils

modelUtils

protected ModelUtils modelUtils

visitorAttributes

protected MutableConvertibleValues<Object> visitorAttributes

classWriterOutputVisitor

protected AnnotationProcessingOutputVisitor classWriterOutputVisitor

javaVisitorContext

protected JavaVisitorContext javaVisitorContext

Constructor Detail

TypeElementVisitorProcessor

public TypeElementVisitorProcessor()

Method Detail

init

public void init(ProcessingEnvironment processingEnv)

Specified by:

init in interface Processor

getLoadedVisitors

protected List<LoadedVisitor> getLoadedVisitors()

Returns:

The loaded visitors.

getIncrementalProcessorKind

protected TypeElementVisitor.VisitorKind getIncrementalProcessorKind()

Returns:

The incremental processor type.

See Also:

GRADLE_PROCESSING_AGGREGATING, GRADLE_PROCESSING_ISOLATING

getSupportedAnnotationTypes

public Set<String> getSupportedAnnotationTypes()

Specified by:

getSupportedAnnotationTypes in interface Processor

getSupportedOptions

public Set<String> getSupportedOptions()

Specified by:

getSupportedOptions in interface Processor

process

public boolean process(Set<? extends TypeElement> annotations,
                       RoundEnvironment roundEnv)

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor

findTypeElementVisitors

@NonNull
protected Collection<TypeElementVisitor> findTypeElementVisitors()

Discovers the TypeElementVisitor instances that are available.

Returns:

A collection of type element visitors.

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface Processor

Overrides:

getSupportedSourceVersion in class AbstractProcessor

getIncrementalProcessorType

protected String getIncrementalProcessorType()

Returns:

The incremental processor type.

See Also:

GRADLE_PROCESSING_AGGREGATING, GRADLE_PROCESSING_ISOLATING

isProcessedAnnotation

protected boolean isProcessedAnnotation(String annotationName)

Return whether the given annotation is processed.

Parameters:

annotationName - The annotation name

Returns:

True if it is

newVisitorContext

@NonNull
protected JavaVisitorContext newVisitorContext(@NonNull
                                                        ProcessingEnvironment processingEnv)

Creates the visitor context.

Parameters:

processingEnv - The processing env

Returns:

The context

getVisitorKind

@NonNull
protected TypeElementVisitor.VisitorKind getVisitorKind()

obtains the visitor kind.

Returns:

The visitor kind

error

protected final void error(Element e,
                           String msg,
                           Object... args)

Produce a compile error for the given element and message.

Parameters:

e - The element

msg - The message

args - The string format args

error

protected final void error(String msg,
                           Object... args)

Produce a compile error for the given message.

Parameters:

msg - The message

args - The string format args

warning

protected final void warning(Element e,
                             String msg,
                             Object... args)

Produce a compile warning for the given element and message.

Parameters:

e - The element

msg - The message

args - The string format args

warning

protected final void warning(String msg,
                             Object... args)

Produce a compile warning for the given message.

Parameters:

msg - The message

args - The string format args

note

protected final void note(Element e,
                          String msg,
                          Object... args)

Produce a compile note for the given element and message.

Parameters:

e - The element

msg - The message

args - The string format args

note

protected final void note(String msg,
                          Object... args)

Produce a compile note for the given element and message.

Parameters:

msg - The message

args - The string format args

isIncremental

protected boolean isIncremental(@NonNull
                                ProcessingEnvironment processingEnv)

Whether incremental compilation is enabled.

Parameters:

processingEnv - The processing environment.

Returns:

True if it is