Package io.micronaut.annotation.processing.visitor

Class JavaVisitorContext

java.lang.Object

io.micronaut.annotation.processing.visitor.JavaVisitorContext

All Implemented Interfaces:

ConversionServiceProvider, ConvertibleValues<Object>, MutableConvertibleValues<Object>, ValueResolver<CharSequence>, BeanElementVisitorContext, VisitorContext, ClassWriterOutputVisitor, Iterable<Map.Entry<String,Object>>

@Internal
public final class JavaVisitorContext
extends Object
implements VisitorContext, BeanElementVisitorContext

The visitor context when visiting Java code.

Since:

1.0

Author:

James Kleeh

Nested Class Summary

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

VisitorContext.Language

Field Summary

Fields inherited from interface io.micronaut.core.convert.value.ConvertibleValues

EMPTY

Fields inherited from interface io.micronaut.inject.visitor.VisitorContext

MICRONAUT_BASE_OPTION_NAME, MICRONAUT_PROCESSING_GROUP, MICRONAUT_PROCESSING_MODULE, MICRONAUT_PROCESSING_PROJECT_DIR

Constructor Summary

Constructors

Constructor	Description
JavaVisitorContext(ProcessingEnvironment processingEnv, Messager messager, Elements elements, AnnotationUtils annotationUtils, Types types, ModelUtils modelUtils, GenericUtils genericUtils, Filer filer, MutableConvertibleValues<Object> visitorAttributes, TypeElementVisitor.VisitorKind visitorKind)	Deprecated, for removal: This API element is subject to removal in a future version. No longer needed
JavaVisitorContext(ProcessingEnvironment processingEnv, Messager messager, Elements elements, Types types, ModelUtils modelUtils, Filer filer, MutableConvertibleValues<Object> visitorAttributes, TypeElementVisitor.VisitorKind visitorKind)	The default constructor.

Method Summary

Modifier and Type	Method	Description
BeanElementBuilder	addAssociatedBean(Element originatingElement, ClassElement type)
void	addGeneratedResource(@NonNull String resource)	Some TypeElementVisitors generate classpath resources that other visitors might be interested in.
MutableConvertibleValues<Object>	clear()	Clear all values.
void	fail(String message, Element element)	Allows failing compilation for a given element with the given message.
void	finish()	Finish writing and flush any service entries to disk.
<T> Optional<T>	get(CharSequence name, ArgumentConversionContext<T> conversionContext)	Resolve the given property for the given name.
JavaAnnotationMetadataBuilder	getAnnotationMetadataBuilder()	Gets the annotation metadata builder.
AnnotationUtils	getAnnotationUtils()	Deprecated, for removal: This API element is subject to removal in a future version. No longer used
List<AbstractBeanDefinitionBuilder>	getBeanElementBuilders()
Optional<ClassElement>	getClassElement(String name)	This method will look up another class element by name.
Optional<ClassElement>	getClassElement(String name, ElementAnnotationMetadataFactory annotationMetadataFactory)	This method will look up another class element by name.
@NonNull ClassElement[]	getClassElements(@NonNull String aPackage, @NonNull String... stereotypes)	Find all the classes within the given package and having the given annotation.
@NonNull Iterable<URL>	getClasspathResources(@NonNull String path)	Obtain a set of resources from the user classpath.
JavaElementAnnotationMetadataFactory	getElementAnnotationMetadataFactory()	Gets the element annotation metadata factory.
@NonNull JavaElementFactory	getElementFactory()	Gets the element factory for this visitor context.
Elements	getElements()	The elements.
ExpressionCompilationContextFactory	getExpressionCompilationContextFactory()
Collection<String>	getGeneratedResources()	Provide a collection of generated classpath resources that other TypeElement visitors might want to consume.
GenericUtils	getGenericUtils()	Deprecated, for removal: This API element is subject to removal in a future version. No longer used
VisitorContext.Language	getLanguage()
Messager	getMessager()	The messager.
ModelUtils	getModelUtils()	The model utils.
JavaNativeElementsHelper	getNativeElementsHelper()
Map<String,String>	getOptions()	Java visitor context options from javac arguments and System.getProperties()
ProcessingEnvironment	getProcessingEnv()
Types	getTypes()	The types.
TypeElementVisitor.VisitorKind	getVisitorKind()
void	info(String message)	Allows printing informational messages.
void	info(String message, Element element)	Allows printing informational messages.
Set<String>	names()
MutableConvertibleValues<Object>	put(CharSequence key, @Nullable Object value)	Insert a value for the given key and value.
MutableConvertibleValues<Object>	remove(CharSequence key)	Remove a value for the given key.
Collection<Object>	values()
OutputStream	visitClass(String classname, Element originatingElement)	Visits a new class and returns the output stream with which should be written the bytes of the class to be generated.
OutputStream	visitClass(String classname, Element... originatingElements)	Visits a new class and returns the output stream with which should be written the bytes of the class to be generated.
Optional<GeneratedFile>	visitGeneratedFile(String path)	Visit a file that will be located within the generated source directory.
Optional<GeneratedFile>	visitGeneratedFile(String path, Element... originatingElements)	Visit a file that will be generated within the generated 'sources' directory.
Optional<GeneratedFile>	visitGeneratedSourceFile(String packageName, String fileNameWithoutExtension, Element... originatingElements)	Visit a source file that will be generated within the generated 'sources' directory.
Optional<GeneratedFile>	visitMetaInfFile(String path, Element... originatingElements)	Visit a file within the META-INF directory.
void	visitServiceDescriptor(String type, String classname)	Allows adding a class that will be written to the META-INF/services file under the given type and class name.
void	visitServiceDescriptor(String type, String classname, Element originatingElement)	Allows adding a class that will be written to the META-INF/services file under the given type and class name.
void	warn(String message, @Nullable Element element)	Print warning message.
void	warn(String message, Element element)	Allows printing a warning for the given message and element.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.inject.writer.ClassWriterOutputVisitor

getServiceEntries, visitClass, visitMetaInfFile, visitServiceDescriptor, visitServiceDescriptor

Methods inherited from interface io.micronaut.core.convert.value.ConvertibleValues

asMap, asMap, asProperties, contains, forEach, getConversionService, getValue, getValueType, isEmpty, iterator, subMap, subMap, subMap

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface io.micronaut.core.convert.value.MutableConvertibleValues

putAll, putAll

Methods inherited from interface io.micronaut.core.value.ValueResolver

get, get, get

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

getClassElement, getClassesOutputPath, getConfiguration, getProjectDir, getRequiredClassElement

Constructor Details

JavaVisitorContext

@Deprecated(forRemoval=true,
            since="4.3.0")
public JavaVisitorContext(ProcessingEnvironment processingEnv,
 Messager messager,
 Elements elements,
 AnnotationUtils annotationUtils,
 Types types,
 ModelUtils modelUtils,
 GenericUtils genericUtils,
 Filer filer,
 MutableConvertibleValues<Object> visitorAttributes,
 TypeElementVisitor.VisitorKind visitorKind)

Deprecated, for removal: This API element is subject to removal in a future version.

No longer needed

The default constructor.

Parameters:

processingEnv - The processing environment

messager - The messager

elements - The elements

annotationUtils - The annotation utils

types - Type types

modelUtils - The model utils

genericUtils - The generic type utils

filer - The filer

visitorAttributes - The attributes

visitorKind - The visitor kind

JavaVisitorContext

public JavaVisitorContext(ProcessingEnvironment processingEnv,
 Messager messager,
 Elements elements,
 Types types,
 ModelUtils modelUtils,
 Filer filer,
 MutableConvertibleValues<Object> visitorAttributes,
 TypeElementVisitor.VisitorKind visitorKind)

The default constructor.

Parameters:

processingEnv - The processing environment

messager - The messager

elements - The elements

types - Type types

modelUtils - The model utils

filer - The filer

visitorAttributes - The attributes

visitorKind - The visitor kind

Method Details

getLanguage

public VisitorContext.Language getLanguage()

Specified by:

getLanguage in interface VisitorContext

Returns:

The visitor context's language.

getVisitorKind

public TypeElementVisitor.VisitorKind getVisitorKind()

Returns:

The visitor kind

getProcessingEnv

public ProcessingEnvironment getProcessingEnv()

Returns:

The processing environment

getClasspathResources

@NonNull
public @NonNull Iterable<URL> getClasspathResources(@NonNull
 @NonNull String path)

Description copied from interface: VisitorContext

Obtain a set of resources from the user classpath.

Specified by:

getClasspathResources in interface VisitorContext

Parameters:

path - The path

Returns:

An iterable of resources

getClassElement

public Optional<ClassElement> getClassElement(String name)

Description copied from interface: VisitorContext

This method will look up another class element by name. If it cannot be found an empty optional will be returned.

Specified by:

getClassElement in interface VisitorContext

Parameters:

name - The name

Returns:

The class element

getClassElement

public Optional<ClassElement> getClassElement(String name,
 ElementAnnotationMetadataFactory annotationMetadataFactory)

Description copied from interface: VisitorContext

This method will look up another class element by name. If it cannot be found an empty optional will be returned.

Specified by:

getClassElement in interface VisitorContext

Parameters:

name - The name

annotationMetadataFactory - The element annotation metadata factory

Returns:

The class element

getClassElements

@NonNull
public @NonNull ClassElement[] getClassElements(@NonNull
 @NonNull String aPackage,
 @NonNull
 @NonNull String... stereotypes)

Description copied from interface: VisitorContext

Find all the classes within the given package and having the given annotation.

Specified by:

getClassElements in interface VisitorContext

Parameters:

aPackage - The package

stereotypes - The stereotypes

Returns:

The class elements

getElementFactory

@NonNull
public @NonNull JavaElementFactory getElementFactory()

Description copied from interface: VisitorContext

Gets the element factory for this visitor context.

Specified by:

getElementFactory in interface VisitorContext

Returns:

The element factory

getElementAnnotationMetadataFactory

public JavaElementAnnotationMetadataFactory getElementAnnotationMetadataFactory()

Description copied from interface: VisitorContext

Gets the element annotation metadata factory.

Specified by:

getElementAnnotationMetadataFactory in interface VisitorContext

Returns:

The element annotation metadata factory

getExpressionCompilationContextFactory

public ExpressionCompilationContextFactory getExpressionCompilationContextFactory()

Specified by:

getExpressionCompilationContextFactory in interface VisitorContext

Returns:

The expression compilation context factory.

getAnnotationMetadataBuilder

public JavaAnnotationMetadataBuilder getAnnotationMetadataBuilder()

Description copied from interface: VisitorContext

Gets the annotation metadata builder.

Specified by:

getAnnotationMetadataBuilder in interface VisitorContext

Returns:

The annotation metadata builder

info

public void info(String message,
 @Nullable
 Element element)

Description copied from interface: VisitorContext

Allows printing informational messages.

Specified by:

info in interface VisitorContext

Parameters:

message - The message

element - The element

info

public void info(String message)

Description copied from interface: VisitorContext

Allows printing informational messages.

Specified by:

info in interface VisitorContext

Parameters:

message - The message

fail

public void fail(String message,
 @Nullable
 Element element)

Description copied from interface: VisitorContext

Allows failing compilation for a given element with the given message.

Specified by:

fail in interface VisitorContext

Parameters:

message - The message

element - The element

warn

public void warn(String message,
 @Nullable
 Element element)

Description copied from interface: VisitorContext

Allows printing a warning for the given message and element.

Specified by:

warn in interface VisitorContext

Parameters:

message - The message

element - The element

warn

public void warn(String message,
 @Nullable
 @Nullable Element element)

Print warning message.

Parameters:

message - The message

element - The element

Since:

4.0.0

visitClass

public OutputStream visitClass(String classname,
 @Nullable
 Element originatingElement)
                        throws IOException

Description copied from interface: ClassWriterOutputVisitor

Visits a new class and returns the output stream with which should be written the bytes of the class to be generated.

Specified by:

visitClass in interface ClassWriterOutputVisitor

Parameters:

classname - the fully qualified classname

originatingElement - The originating element

Returns:

the output stream to write to

Throws:

IOException - if an error occurs creating the output stream

visitClass

public OutputStream visitClass(String classname,
 Element... originatingElements)
                        throws IOException

Description copied from interface: ClassWriterOutputVisitor

Visits a new class and returns the output stream with which should be written the bytes of the class to be generated.

Note that this method should only be called from a TypeElementVisitor.VisitorKind.AGGREGATING visitor from within the TypeElementVisitor.finish(io.micronaut.inject.visitor.VisitorContext) method. If the file

Specified by:

visitClass in interface ClassWriterOutputVisitor

Parameters:

classname - the fully qualified classname

originatingElements - The originating elements

Returns:

the output stream to write to

Throws:

IOException - if an error occurs creating the output stream

visitServiceDescriptor

public void visitServiceDescriptor(String type,
 String classname)

Description copied from interface: ClassWriterOutputVisitor

Allows adding a class that will be written to the META-INF/services file under the given type and class name.

Specified by:

visitServiceDescriptor in interface ClassWriterOutputVisitor

Parameters:

type - the fully qualified service name

classname - the fully qualified classname

visitServiceDescriptor

public void visitServiceDescriptor(String type,
 String classname,
 Element originatingElement)

Description copied from interface: ClassWriterOutputVisitor

Allows adding a class that will be written to the META-INF/services file under the given type and class name.

Specified by:

visitServiceDescriptor in interface ClassWriterOutputVisitor

Parameters:

type - the fully qualified service name

classname - the fully qualified classname

originatingElement - The originating element

visitMetaInfFile

public Optional<GeneratedFile> visitMetaInfFile(String path,
 Element... originatingElements)

Description copied from interface: VisitorContext

Visit a file within the META-INF directory.

Specified by:

visitMetaInfFile in interface ClassWriterOutputVisitor

Specified by:

visitMetaInfFile in interface VisitorContext

Parameters:

path - The path to the file

originatingElements - The originating elements

Returns:

An optional file it was possible to create it

visitGeneratedFile

public Optional<GeneratedFile> visitGeneratedFile(String path)

Description copied from interface: VisitorContext

Visit a file that will be located within the generated source directory.

Specified by:

visitGeneratedFile in interface ClassWriterOutputVisitor

Specified by:

visitGeneratedFile in interface VisitorContext

Parameters:

path - The path to the file

Returns:

An optional file it was possible to create it

visitGeneratedFile

public Optional<GeneratedFile> visitGeneratedFile(String path,
 Element... originatingElements)

Description copied from interface: ClassWriterOutputVisitor

Visit a file that will be generated within the generated 'sources' directory.

Specified by:

visitGeneratedFile in interface ClassWriterOutputVisitor

Parameters:

path - The path

originatingElements - the originating elements

Returns:

The file if it was possible to create it

visitGeneratedSourceFile

public Optional<GeneratedFile> visitGeneratedSourceFile(String packageName,
 String fileNameWithoutExtension,
 Element... originatingElements)

Description copied from interface: ClassWriterOutputVisitor

Visit a source file that will be generated within the generated 'sources' directory.

Specified by:

visitGeneratedSourceFile in interface ClassWriterOutputVisitor

Parameters:

packageName - The package for the source file

fileNameWithoutExtension - the name of the source file, without extension (determined automatically)

originatingElements - the originating elements

Returns:

The file if it was possible to create it

finish

public void finish()

Description copied from interface: ClassWriterOutputVisitor

Finish writing and flush any service entries to disk.

Specified by:

finish in interface ClassWriterOutputVisitor

getMessager

public Messager getMessager()

The messager.

Returns:

The messager

getModelUtils

public ModelUtils getModelUtils()

The model utils.

Returns:

The model utils

getElements

public Elements getElements()

The elements.

Returns:

The elements

getAnnotationUtils

@Deprecated(forRemoval=true,
            since="4.3.0")
public AnnotationUtils getAnnotationUtils()

Deprecated, for removal: This API element is subject to removal in a future version.

No longer used

The annotation utils.

Returns:

The annotation utils

getTypes

public Types getTypes()

The types.

Returns:

The types

getGenericUtils

@Deprecated(forRemoval=true,
            since="4.3.0")
public GenericUtils getGenericUtils()

Deprecated, for removal: This API element is subject to removal in a future version.

No longer used

The generic utils object.

Returns:

The generic utils

getNativeElementsHelper

public JavaNativeElementsHelper getNativeElementsHelper()

Returns:

The elements helper

getOptions

public Map<String,String> getOptions()

Java visitor context options from javac arguments and System.getProperties()

System properties has priority over arguments.

Specified by:

getOptions in interface VisitorContext

Returns:

Java visitor context options for all visitors

See Also:

• TypeElementVisitor
• javac arguments

put

public MutableConvertibleValues<Object> put(CharSequence key,
 @Nullable
 @Nullable Object value)

Description copied from interface: MutableConvertibleValues

Insert a value for the given key and value.

Specified by:

put in interface MutableConvertibleValues<Object>

Parameters:

key - The key

value - The value

Returns:

This values instance

remove

public MutableConvertibleValues<Object> remove(CharSequence key)

Description copied from interface: MutableConvertibleValues

Remove a value for the given key.

Specified by:

remove in interface MutableConvertibleValues<Object>

Parameters:

key - The key

Returns:

This values instance

clear

public MutableConvertibleValues<Object> clear()

Description copied from interface: MutableConvertibleValues

Clear all values.

Specified by:

clear in interface MutableConvertibleValues<Object>

Returns:

This values instance

names

public Set<String> names()

Specified by:

names in interface ConvertibleValues<Object>

Returns:

The names of the values

values

public Collection<Object> values()

Specified by:

values in interface ConvertibleValues<Object>

Returns:

The values

get

public <T> Optional<T> get(CharSequence name,
 ArgumentConversionContext<T> conversionContext)

Description copied from interface: ValueResolver

Resolve the given property for the given name.

Specified by:

get in interface ValueResolver<CharSequence>

Type Parameters:

T - The concrete type

Parameters:

name - The name

conversionContext - The conversion context

Returns:

An optional containing the property value if it exists and is able to be converted

getGeneratedResources

public Collection<String> getGeneratedResources()

Description copied from interface: VisitorContext

Provide a collection of generated classpath resources that other TypeElement visitors might want to consume. The generated resources are intended to be strings paths relative to the classpath root.

Specified by:

getGeneratedResources in interface VisitorContext

Returns:

a possibly empty collection of resource paths

addGeneratedResource

public void addGeneratedResource(@NonNull
 @NonNull String resource)

Description copied from interface: VisitorContext

Some TypeElementVisitors generate classpath resources that other visitors might be interested in. The generated resources are intended to be strings paths relative to the classpath root

Specified by:

addGeneratedResource in interface VisitorContext

Parameters:

resource - the relative path to add

getBeanElementBuilders

@Internal
public List<AbstractBeanDefinitionBuilder> getBeanElementBuilders()

Returns:

Gets the produced bean definition builders.

addAssociatedBean

public BeanElementBuilder addAssociatedBean(Element originatingElement,
 ClassElement type)

Specified by:

addAssociatedBean in interface BeanElementVisitorContext