io.micronaut.inject.visitor

Interface VisitorContext

All Superinterfaces:

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

All Known Implementing Classes:

GroovyVisitorContext, JavaVisitorContext

public interface VisitorContext
extends MutableConvertibleValues<Object>

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 inherited from interface io.micronaut.core.convert.value.ConvertibleValues

EMPTY

Method Summary

Modifier and Type	Method and Description
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.
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.
Optional<GeneratedFile>	visitMetaInfFile(String path) 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, contains, empty, forEach, 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

Method Detail

info

void info(String message,
          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,
          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,
          Element element)

Allows printing a warning for the given message and element.

Parameters:

message - The message

element - The element

visitMetaInfFile

Optional<GeneratedFile> visitMetaInfFile(String path)

Visit a file within the META-INF directory.

Parameters:

path - The path to the file

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.

Parameters:

path - The path to the file

Returns:

An optional file it was possible to create it

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