io.micronaut.annotation.processing.visitor

Class JavaVisitorContext

java.lang.Object

io.micronaut.annotation.processing.visitor.JavaVisitorContext

All Implemented Interfaces:

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

@Internal
public class JavaVisitorContext
extends Object
implements VisitorContext

The visitor context when visiting Java code.

Since:

1.0

Author:

James Kleeh

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
JavaVisitorContext(Messager messager, Elements elements, AnnotationUtils annotationUtils, Types types, ModelUtils modelUtils, Filer filer, MutableConvertibleValues<Object> visitorAttributes) The default constructor.

Method Summary

Modifier and Type	Method and Description
MutableConvertibleValues<Object>	clear() Clear all values.
void	fail(String message, Element element) Allows failing compilation for a given element with the given message.
<T> Optional<T>	get(CharSequence name, ArgumentConversionContext<T> conversionContext) Resolve the given property for the given name.
AnnotationUtils	getAnnotationUtils() The annotation utils.
Optional<ClassElement>	getClassElement(String name) This method will lookup another class element by name.
Elements	getElements() The elements.
Messager	getMessager() The messager.
ModelUtils	getModelUtils() The model utils.
Types	getTypes() The types.
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, 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()
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 class java.lang.Object

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

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

getClassElement

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

of, putAll, putAll

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

asMap, asMap, asProperties, contains, empty, forEach, getValueType, isEmpty, iterator, subMap, subMap, subMap

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

get, get, get

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

JavaVisitorContext

public JavaVisitorContext(Messager messager,
                          Elements elements,
                          AnnotationUtils annotationUtils,
                          Types types,
                          ModelUtils modelUtils,
                          Filer filer,
                          MutableConvertibleValues<Object> visitorAttributes)

The default constructor.

Parameters:

messager - The messager

elements - The elements

annotationUtils - The annotation utils

types - Type types

modelUtils - The model utils

filer - The filer

visitorAttributes - The attributes

Method Detail

getClassElement

public Optional<ClassElement> getClassElement(String name)

Description copied from interface: VisitorContext

This method will lookup 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

info

public void info(String message,
                 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,
                 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,
                 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

visitMetaInfFile

public Optional<GeneratedFile> visitMetaInfFile(String path)

Description copied from interface: VisitorContext

Visit a file within the META-INF directory.

Specified by:

visitMetaInfFile 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)

Description copied from interface: VisitorContext

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

Specified by:

visitGeneratedFile in interface VisitorContext

Parameters:

path - The path to the file

Returns:

An optional file it was possible to create it

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

public AnnotationUtils getAnnotationUtils()

The annotation utils.

Returns:

The annotation utils

getTypes

public Types getTypes()

The types.

Returns:

The types

put

public MutableConvertibleValues<Object> put(CharSequence key,
                                            @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:

The previous value

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:

The previous value

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