io.micronaut.aot.core

Annotation Type AOTModule

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface AOTModule

Annotation which must be present on AOT optimizers.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	id A unique identifier for this source generator.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String[]	dependencies Returns the identifiers of source generators which must be executed before this generator is called.
java.lang.String	description Returns a description for this source generator.
Runtime[]	enabledOn Returns the runtimes this module is valid for.
Option[]	options Returns the set of configuration keys which affect the configuration of this source generator.
java.lang.Class<? extends AOTCodeGenerator>[]	subgenerators Returns a list of generators which are directly managed (or instantiated_ by this source generator.

Element Detail

id

public abstract java.lang.String id

A unique identifier for this source generator.

Returns:

the id

description

public abstract java.lang.String description

Returns a description for this source generator. Description is optional because some code generators are purely internal and not exposed to users.

Returns:

a description or an empty options

Default:

""

dependencies

public abstract java.lang.String[] dependencies

Returns the identifiers of source generators which must be executed before this generator is called.

Returns:

the list of ids

Default:

{}

subgenerators

public abstract java.lang.Class<? extends AOTCodeGenerator>[] subgenerators

Returns a list of generators which are directly managed (or instantiated_ by this source generator. Such optimizers are typically not registered as services because they make no sense in isolation. This method should be used for introspection only.

Returns:

the list of sub features

Default:

{}

options

public abstract Option[] options

Returns the set of configuration keys which affect the configuration of this source generator.

Returns:

a set of configuration keys

Default:

{}

enabledOn

public abstract Runtime[] enabledOn

Returns the runtimes this module is valid for.

Returns:

the list of runtimes this module applies to.

Default:

{io.micronaut.aot.core.Runtime.JIT, io.micronaut.aot.core.Runtime.NATIVE}