io.micronaut.aot.core.context

Class DefaultSourceGenerationContext

java.lang.Object

io.micronaut.aot.core.context.DefaultSourceGenerationContext

All Implemented Interfaces:

AOTContext

public final class DefaultSourceGenerationContext
extends java.lang.Object
implements AOTContext

The source generation context. Typically provides access to the application classloader or the name of the package of classes which are going to be generated. In addition, the context can be used to register resources which will need to be excluded from the final binary (e.g if a configuration file is replaced with a class at build time, we need a way to explain that the resource file needs to be excluded from the binary). Last but not least, this context can be used to send diagnostic messages which are written to log files during code generation.

Constructor Summary

Constructors

Constructor and Description
DefaultSourceGenerationContext(java.lang.String packageName, ApplicationContextAnalyzer analyzer, Configuration configuration, java.nio.file.Path generatedResourcesDirectory)

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.util.Set<java.lang.String>	getExcludedResources() Returns the list of resources to be excluded from the binary.
java.util.List<java.io.File>	getExtraClasspath()
java.util.List<com.squareup.javapoet.JavaFile>	getGeneratedJavaFiles()
java.util.List<com.squareup.javapoet.MethodSpec>	getGeneratedStaticInitializers()
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSourceGenerationContext

public DefaultSourceGenerationContext(java.lang.String packageName,
                                      ApplicationContextAnalyzer analyzer,
                                      Configuration configuration,
                                      java.nio.file.Path generatedResourcesDirectory)

Method Detail

getPackageName

@NonNull
public java.lang.String getPackageName()

Description copied from interface: AOTContext

The package which should be used for generated classes.

Specified by:

getPackageName in interface AOTContext

Returns:

the package name

getRuntime

@NonNull
public Runtime getRuntime()

Description copied from interface: AOTContext

Returns the target runtime environment.

Specified by:

getRuntime in interface AOTContext

Returns:

target runtime

getConfiguration

@NonNull
public Configuration getConfiguration()

Description copied from interface: AOTContext

Returns the source generators configuration.

Specified by:

getConfiguration in interface AOTContext

Returns:

the configuration

getAnalyzer

@NonNull
public ApplicationContextAnalyzer getAnalyzer()

Description copied from interface: AOTContext

Returns the application context analyzer.

Specified by:

getAnalyzer in interface AOTContext

Returns:

the application context analyzer

registerExcludedResource

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

Description copied from interface: AOTContext

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.

Specified by:

registerExcludedResource in interface AOTContext

Parameters:

path - the path of the resource to exclude

registerClassNeededAtCompileTime

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

Description copied from interface: AOTContext

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.

Specified by:

registerClassNeededAtCompileTime in interface AOTContext

Parameters:

clazz - a class

registerGeneratedSourceFile

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

Description copied from interface: AOTContext

Registers a generated source file.

Specified by:

registerGeneratedSourceFile in interface AOTContext

Parameters:

javaFile - the file to be added.

getGeneratedJavaFiles

public java.util.List<com.squareup.javapoet.JavaFile> getGeneratedJavaFiles()

registerStaticInitializer

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

Description copied from interface: AOTContext

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

Specified by:

registerStaticInitializer in interface AOTContext

Parameters:

staticInitializer - the static initializer method

getGeneratedStaticInitializers

public java.util.List<com.squareup.javapoet.MethodSpec> getGeneratedStaticInitializers()

registerGeneratedResource

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

Description copied from interface: AOTContext

Registers a new generated resource.

Specified by:

registerGeneratedResource in interface AOTContext

Parameters:

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

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

getExtraClasspath

@NonNull
public java.util.List<java.io.File> getExtraClasspath()

getExcludedResources

@NonNull
public java.util.Set<java.lang.String> getExcludedResources()

Returns the list of resources to be excluded from the binary.

Returns:

the list of resources registered to be excluded.

See Also:

AOTContext.registerExcludedResource(java.lang.String)

javaFile

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

Description copied from interface: AOTContext

Generates a java file spec.

Specified by:

javaFile in interface AOTContext

Parameters:

typeSpec - the type spec of the main class

Returns:

a java file

addDiagnostics

public void addDiagnostics(java.lang.String category,
                           java.lang.String message)

Description copied from interface: AOTContext

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

Specified by:

addDiagnostics in interface AOTContext

Parameters:

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

message - a message to log

put

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

Description copied from interface: AOTContext

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

Specified by:

put in interface AOTContext

Type Parameters:

T - the type of the value

Parameters:

type - the class of the value to store

value - the value to store

get

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

Description copied from interface: AOTContext

Reads an entry from the context.

Specified by:

get in interface AOTContext

Type Parameters:

T - the type of the entry

Parameters:

type - the class of the entry

Returns:

an empty value if absent

getDiagnostics

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

Description copied from interface: AOTContext

Returns the diagnostics map.

Specified by:

getDiagnostics in interface AOTContext

Returns:

the diagnostics