io.micronaut.aot.core

Interface AOTContext

All Known Implementing Classes:

DefaultSourceGenerationContext, DelegatingSourceGenerationContext

public interface AOTContext

The source generation context is used by source generators to get configuration details. It is also used as the communication medium between source generators when one depends on the other.

Method Summary

Modifier and Type	Method and Description
void	addDiagnostics(java.lang.String category, java.lang.String message) Adds a diagnostic message, which is going to be written in a log file.
<T> java.util.Optional<T>	get(java.lang.Class<T> type) Reads an entry from the context.
ApplicationContextAnalyzer	getAnalyzer() Returns the application context analyzer.
Configuration	getConfiguration() Returns the source generators configuration.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getDiagnostics() Returns the diagnostics map.
java.lang.String	getPackageName() The package which should be used for generated classes.
Runtime	getRuntime() Returns the target runtime environment.
com.squareup.javapoet.JavaFile	javaFile(com.squareup.javapoet.TypeSpec typeSpec) Generates a java file spec.
<T> void	put(java.lang.Class<T> type, T value) Stores an entry in the context.
void	registerClassNeededAtCompileTime(java.lang.Class<?> clazz) Registers a class as needed at compile time (where compile time is the compile time of generated classes).
void	registerExcludedResource(java.lang.String path) Registers a resource path as excluded.
void	registerGeneratedResource(java.lang.String path, java.util.function.Consumer<? super java.io.File> consumer) Registers a new generated resource.
void	registerGeneratedSourceFile(com.squareup.javapoet.JavaFile javaFile) Registers a generated source file.
void	registerStaticInitializer(com.squareup.javapoet.MethodSpec staticInitializer) Registers a code block to be executed statically when the optimized binary is loaded.

Method Detail

getPackageName

@NonNull
java.lang.String getPackageName()

The package which should be used for generated classes.

Returns:

the package name

getConfiguration

@NonNull
Configuration getConfiguration()

Returns the source generators configuration.

Returns:

the configuration

getAnalyzer

@NonNull
ApplicationContextAnalyzer getAnalyzer()

Returns the application context analyzer.

Returns:

the application context analyzer

registerGeneratedSourceFile

void registerGeneratedSourceFile(@NonNull
                                 com.squareup.javapoet.JavaFile javaFile)

Registers a generated source file.

Parameters:

javaFile - the file to be added.

registerStaticInitializer

void registerStaticInitializer(com.squareup.javapoet.MethodSpec staticInitializer)

Registers a code block to be executed statically when the optimized binary is loaded.

Parameters:

staticInitializer - the static initializer method

registerGeneratedResource

void registerGeneratedResource(@NonNull
                               java.lang.String path,
                               java.util.function.Consumer<? super java.io.File> consumer)

Registers a new generated resource.

Parameters:

path - the relative path to the resource (including file name)

consumer - the consumer to be called when the resource is generated.

registerExcludedResource

void registerExcludedResource(@NonNull
                              java.lang.String path)

Registers a resource path as excluded. Excluded resources should be removed, as much as possible, from the final binary/deliverable since they are either not used or substituted with code.

Parameters:

path - the path of the resource to exclude

registerClassNeededAtCompileTime

void registerClassNeededAtCompileTime(@NonNull
                                      java.lang.Class<?> clazz)

Registers a class as needed at compile time (where compile time is the compile time of generated classes). This will typically be used when source generators need classes which are not on the application classpath.

Parameters:

clazz - a class

javaFile

@NonNull
com.squareup.javapoet.JavaFile javaFile(com.squareup.javapoet.TypeSpec typeSpec)

Generates a java file spec.

Parameters:

typeSpec - the type spec of the main class

Returns:

a java file

addDiagnostics

@NonNull
void addDiagnostics(java.lang.String category,
                             java.lang.String message)

Adds a diagnostic message, which is going to be written in a log file.

Parameters:

category - a category for the message, typically corresponding to the source generator type

message - a message to log

put

<T> void put(@NonNull
             java.lang.Class<T> type,
             @NonNull
             T value)

Stores an entry in the context. The entry may be read by other processors, as long as they are executed in the proper order.

Type Parameters:

T - the type of the value

Parameters:

type - the class of the value to store

value - the value to store

get

@NonNull
<T> java.util.Optional<T> get(@NonNull
                                       java.lang.Class<T> type)

Reads an entry from the context.

Type Parameters:

T - the type of the entry

Parameters:

type - the class of the entry

Returns:

an empty value if absent

getDiagnostics

@NonNull
java.util.Map<java.lang.String,java.util.List<java.lang.String>> getDiagnostics()

Returns the diagnostics map.

Returns:

the diagnostics

getRuntime

@NonNull
Runtime getRuntime()

Returns the target runtime environment.

Returns:

target runtime