io.micronaut.inject.visitor

Interface VisitorContext

All Superinterfaces:

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

All Known Subinterfaces:

BeanElementVisitorContext

All Known Implementing Classes:

GroovyVisitorContext, JavaVisitorContext

public interface VisitorContext
extends MutableConvertibleValues<Object>, ClassWriterOutputVisitor

Provides a way for TypeElementVisitor classes to log messages during compilation and fail compilation.

Since:

1.0

Author:

James Kleeh, Graeme Rocher

Field Summary

Fields

Modifier and Type	Field and Description
static String	MICRONAUT_BASE_OPTION_NAME
static String	MICRONAUT_PROCESSING_GROUP
static String	MICRONAUT_PROCESSING_MODULE
static String	MICRONAUT_PROCESSING_PROJECT_DIR

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

EMPTY

Method Summary

Modifier and Type	Method and Description
default void	addGeneratedResource(String resource) Some TypeElementVisitors generate classpath resources that other visitors might be interested in.
void	fail(String message, Element element) Allows failing compilation for a given element with the given message.
default Optional<ClassElement>	getClassElement(Class<?> type) This method will lookup another class element by name.
default Optional<ClassElement>	getClassElement(String name) This method will lookup another class element by name.
default ClassElement[]	getClassElements(String aPackage, String... stereotypes) Find all the classes within the given package and having the given annotation.
default Optional<Path>	getClassesOutputPath() Provide the Path to the annotation processing classes output directory, i.e.
default Iterable<URL>	getClasspathResources(String path) Obtain a set of resources from the user classpath.
default VisitorConfiguration	getConfiguration()
ElementFactory<?,?,?,?>	getElementFactory() Gets the element factory for this visitor context.
default Collection<String>	getGeneratedResources() Provide a collection of generated classpath resources that other TypeElement visitors might want to consume.
default Map<String,String>	getOptions() The annotation processor environment custom options.
default Optional<Path>	getProjectDir() Obtain the project directory.
void	info(String message) Allows printing informational messages.
void	info(String message, Element element) Allows printing informational messages.
Optional<GeneratedFile>	visitGeneratedFile(String path) Visit a file that will be located within the generated source directory.
default Optional<GeneratedFile>	visitMetaInfFile(String path) Deprecated. Visiting a file should supply the originating elements. Use visitMetaInfFile(String, Element...) instead
Optional<GeneratedFile>	visitMetaInfFile(String path, Element... originatingElements) Visit a file within the META-INF directory.
void	warn(String message, Element element) Allows printing a warning for the given message and element.

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

clear, of, put, putAll, putAll, remove

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

asMap, asMap, asProperties, contains, empty, forEach, getValue, getValueType, isEmpty, iterator, names, subMap, subMap, subMap, values

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

get, get, get, get

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

finish, getServiceEntries, visitClass, visitClass, visitClass, visitServiceDescriptor, visitServiceDescriptor

Field Detail

MICRONAUT_BASE_OPTION_NAME

static final String MICRONAUT_BASE_OPTION_NAME

See Also:

Constant Field Values

MICRONAUT_PROCESSING_PROJECT_DIR

static final String MICRONAUT_PROCESSING_PROJECT_DIR

See Also:

Constant Field Values

MICRONAUT_PROCESSING_GROUP

static final String MICRONAUT_PROCESSING_GROUP

See Also:

Constant Field Values

MICRONAUT_PROCESSING_MODULE

static final String MICRONAUT_PROCESSING_MODULE

See Also:

Constant Field Values

Method Detail

getElementFactory

@NonNull
ElementFactory<?,?,?,?> getElementFactory()

Gets the element factory for this visitor context.

Returns:

The element factory

Since:

2.3.0

info

void info(String message,
          @Nullable
          Element element)

Allows printing informational messages.

Parameters:

message - The message

element - The element

info

void info(String message)

Allows printing informational messages.

Parameters:

message - The message

fail

void fail(String message,
          @Nullable
          Element element)

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

Parameters:

message - The message

element - The element

warn

void warn(String message,
          @Nullable
          Element element)

Allows printing a warning for the given message and element.

Parameters:

message - The message

element - The element

getConfiguration

@NonNull
default VisitorConfiguration getConfiguration()

Returns:

The visitor configuration

visitMetaInfFile

@Deprecated
default Optional<GeneratedFile> visitMetaInfFile(String path)

Deprecated. Visiting a file should supply the originating elements. Use visitMetaInfFile(String, Element...) instead

Visit a file within the META-INF directory.

Specified by:

visitMetaInfFile in interface ClassWriterOutputVisitor

Parameters:

path - The path to the file

Returns:

An optional file it was possible to create it

visitMetaInfFile

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

Visit a file within the META-INF directory.

Specified by:

visitMetaInfFile in interface ClassWriterOutputVisitor

Parameters:

path - The path to the file

originatingElements - The originating elements

Returns:

An optional file it was possible to create it

visitGeneratedFile

Optional<GeneratedFile> visitGeneratedFile(String path)

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

Specified by:

visitGeneratedFile in interface ClassWriterOutputVisitor

Parameters:

path - The path to the file

Returns:

An optional file it was possible to create it

getClasspathResources

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

Obtain a set of resources from the user classpath.

Parameters:

path - The path

Returns:

An iterable of resources

getProjectDir

default Optional<Path> getProjectDir()

Obtain the project directory.

Returns:

An optional wrapping the project directory

getClassesOutputPath

default Optional<Path> getClassesOutputPath()

Provide the Path to the annotation processing classes output directory, i.e. the parent of META-INF.

This might, for example, be used as a convenience for TypeElementVisitor classes to provide relative path strings to addGeneratedResource(String)

 Path resource = ... // absolute path to the resource
 visitorContext.getClassesOutputPath().ifPresent(path ->
     visitorContext.addGeneratedResource(path.relativize(resource).toString()));
 

Returns:

Path pointing to the classes output directory

getClassElement

default Optional<ClassElement> getClassElement(String name)

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

Parameters:

name - The name

Returns:

The class element

getClassElement

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

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

Parameters:

type - The name

Returns:

The class element

getClassElements

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

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

Parameters:

aPackage - The package

stereotypes - The stereotypes

Returns:

The class elements

getOptions

default Map<String,String> getOptions()

The annotation processor environment custom options.

All options names MUST start with MICRONAUT_BASE_OPTION_NAME

Returns:

A Map with annotation processor runtime options

See Also:

ProcessingEnvironment.getOptions()

getGeneratedResources

default Collection<String> getGeneratedResources()

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.

Returns:

a possibly empty collection of resource paths

addGeneratedResource

default void addGeneratedResource(String resource)

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

Parameters:

resource - the relative path to add