Package io.micronaut.ast.groovy.visitor

Class GroovyVisitorContext

java.lang.Object

io.micronaut.ast.groovy.visitor.GroovyVisitorContext

All Implemented Interfaces:

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

@Internal
public class GroovyVisitorContext
extends Object
implements VisitorContext

The visitor context when visiting Groovy code.

Since:

1.0

Author:

James Kleeh, Graeme Rocher

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
GroovyVisitorContext(org.codehaus.groovy.control.SourceUnit sourceUnit, @Nullable org.codehaus.groovy.control.CompilationUnit compilationUnit)
GroovyVisitorContext(org.codehaus.groovy.control.SourceUnit sourceUnit, @Nullable org.codehaus.groovy.control.CompilationUnit compilationUnit, ClassWriterOutputVisitor outputVisitor)

Method Summary

Modifier and Type	Method	Description
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, @Nullable Element element)	Allows failing compilation for a given element with the given message.
final void	fail(String message, org.codehaus.groovy.ast.ASTNode expr)
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.
@NonNull GroovyAnnotationMetadataBuilder	getAnnotationMetadataBuilder()	Gets the annotation metadata builder.
List<AbstractBeanDefinitionBuilder>	getBeanElementBuilders()
Optional<ClassElement>	getClassElement(Class<?> type)	This method will look up another class element by name.
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.
org.codehaus.groovy.control.CompilationUnit	getCompilationUnit()
@NonNull GroovyElementAnnotationMetadataFactory	getElementAnnotationMetadataFactory()	Gets the element annotation metadata factory.
@NonNull GroovyElementFactory	getElementFactory()	Gets the element factory for this visitor context.
@NonNull ExpressionCompilationContextFactory	getExpressionCompilationContextFactory()
Collection<String>	getGeneratedResources()	Provide a collection of generated classpath resources that other TypeElement visitors might want to consume.
VisitorContext.Language	getLanguage()
GroovyNativeElementHelper	getNativeElementHelper()
Map<String,String>	getOptions()	Groovy options source are System.getProperties() based.
void	info(String message)	Allows printing informational messages.
void	info(String message, @Nullable 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, @Nullable 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)	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

getClassesOutputPath, getConfiguration, getProjectDir, getRequiredClassElement

Constructor Details

GroovyVisitorContext

public GroovyVisitorContext(org.codehaus.groovy.control.SourceUnit sourceUnit,
 @Nullable
 @Nullable org.codehaus.groovy.control.CompilationUnit compilationUnit)

Parameters:

sourceUnit - The source unit

compilationUnit - The compilation unit

GroovyVisitorContext

public GroovyVisitorContext(org.codehaus.groovy.control.SourceUnit sourceUnit,
 @Nullable
 @Nullable org.codehaus.groovy.control.CompilationUnit compilationUnit,
 ClassWriterOutputVisitor outputVisitor)

Parameters:

sourceUnit - The source unit

compilationUnit - The compilation unit

outputVisitor - The class writer output visitor

Method Details

getLanguage

public VisitorContext.Language getLanguage()

Specified by:

getLanguage in interface VisitorContext

Returns:

The visitor context's language.

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

getClassElement

public Optional<ClassElement> getClassElement(Class<?> type)

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:

type - The name

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 GroovyElementFactory 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

@NonNull
public @NonNull GroovyElementAnnotationMetadataFactory 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

@NonNull
public @NonNull ExpressionCompilationContextFactory getExpressionCompilationContextFactory()

Specified by:

getExpressionCompilationContextFactory in interface VisitorContext

Returns:

The expression compilation context factory.

getAnnotationMetadataBuilder

@NonNull
public @NonNull GroovyAnnotationMetadataBuilder 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
 @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
 @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

fail

public final void fail(String message,
 org.codehaus.groovy.ast.ASTNode expr)

warn

public void warn(String message,
 @Nullable
 @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

visitClass

public OutputStream visitClass(String classname,
 @Nullable
 @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

getCompilationUnit

@Internal
public org.codehaus.groovy.control.CompilationUnit getCompilationUnit()

Returns:

The compilation unit

getNativeElementHelper

@Internal
public GroovyNativeElementHelper getNativeElementHelper()

Returns:

The native element helper

getOptions

public Map<String,String> getOptions()

Groovy options source are System.getProperties() based.

All properties MUST start with VisitorContext.MICRONAUT_BASE_OPTION_NAME

Specified by:

getOptions in interface VisitorContext

Returns:

options Map

See Also:

• ProcessingEnvironment.getOptions()

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.