Package io.micronaut.annotation.processing

Class AggregatingPackageElementVisitorProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

io.micronaut.annotation.processing.PackageElementVisitorProcessor

io.micronaut.annotation.processing.AggregatingPackageElementVisitorProcessor

All Implemented Interfaces:

Processor

@SupportedOptions({"micronaut.processing.incremental","micronaut.processing.annotations"})
public non-sealed class AggregatingPackageElementVisitorProcessor
extends PackageElementVisitorProcessor

The aggregating PackageElementVisitorProcessor.

Since:

4.10

Author:

Denis Stepanov

Field Summary

Fields

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

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
AggregatingPackageElementVisitorProcessor()

Method Summary

Modifier and Type	Method	Description
protected final void	error(String msg, Object... args)	Produce a compile error for the given message.
protected final void	error(Element e, String msg, Object... args)	Produce a compile error for the given element and message.
protected String	getIncrementalProcessorType()
Set<String>	getSupportedAnnotationTypes()
Set<String>	getSupportedOptions()
SourceVersion	getSupportedSourceVersion()
protected TypeElementVisitor.VisitorKind	getVisitorKind()	obtains the visitor kind.
protected boolean	isIncremental(@NonNull ProcessingEnvironment processingEnv)	Whether incremental compilation is enabled.
protected boolean	isProcessedAnnotation(String annotationName)	Return whether the given annotation is processed.
protected @NonNull JavaVisitorContext	newVisitorContext(@NonNull ProcessingEnvironment processingEnv)	Creates the visitor context.
protected final void	note(String msg, Object... args)	Produce a compile note for the given element and message.
protected final void	note(Element e, String msg, Object... args)	Produce a compile note for the given element and message.
protected final boolean	processingGeneratedAnnotation(Set<? extends TypeElement> annotations)
protected final void	warning(String msg, Object... args)	Produce a compile warning for the given message.
protected final void	warning(Element e, String msg, Object... args)	Produce a compile warning for the given element and message.

Methods inherited from class io.micronaut.annotation.processing.PackageElementVisitorProcessor

getIncrementalProcessorKind, getPackageVisitors, hasVisitors, init, process

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 Details

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

modelUtils

protected ModelUtils modelUtils

visitorAttributes

protected MutableConvertibleValues<Object> visitorAttributes

classWriterOutputVisitor

protected AnnotationProcessingOutputVisitor classWriterOutputVisitor

javaVisitorContext

protected JavaVisitorContext javaVisitorContext

postponedTypes

protected Map<String,Object> postponedTypes

Constructor Details

AggregatingPackageElementVisitorProcessor

public AggregatingPackageElementVisitorProcessor()

Method Details

getIncrementalProcessorType

protected String getIncrementalProcessorType()

Returns:

The incremental processor type.

See Also:

• GRADLE_PROCESSING_AGGREGATING
• GRADLE_PROCESSING_ISOLATING

getSupportedAnnotationTypes

public Set<String> getSupportedAnnotationTypes()

Specified by:

getSupportedAnnotationTypes in interface Processor

Overrides:

getSupportedAnnotationTypes in class PackageElementVisitorProcessor

processingGeneratedAnnotation

protected final boolean processingGeneratedAnnotation(Set<? extends TypeElement> annotations)

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface Processor

Overrides:

getSupportedSourceVersion in class AbstractProcessor

getSupportedOptions

public Set<String> getSupportedOptions()

Specified by:

getSupportedOptions in interface Processor

Overrides:

getSupportedOptions in class AbstractProcessor

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 @NonNull JavaVisitorContext newVisitorContext(@NonNull
 @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
 @NonNull ProcessingEnvironment processingEnv)

Whether incremental compilation is enabled.

Parameters:

processingEnv - The processing environment.

Returns:

True if it is