io.micronaut.starter.feature.build

Class MicronautAot

java.lang.Object

io.micronaut.starter.feature.build.MicronautAot

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, Feature

@Singleton
public class MicronautAot
extends java.lang.Object
implements Feature

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FEATURE_NAME_AOT

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
MicronautAot()

Method Summary

Modifier and Type	Method and Description
void	apply(GeneratorContext generatorContext) If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of DefaultFeature.shouldApply(ApplicationType, io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature).
java.lang.String	getCategory()
java.lang.String	getDescription()
java.lang.String	getMicronautDocumentation()
java.lang.String	getName() The name of the feature.
java.lang.String	getTitle()
boolean	supports(ApplicationType applicationType) This method must be implemented to ensure it is only selectable for the desired application types.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.starter.feature.Feature

getOrder, getThirdPartyDocumentation, isCommunity, isPreview, isVisible, processSelectedFeatures

Methods inherited from interface io.micronaut.core.naming.Described

getDescription

Field Detail

FEATURE_NAME_AOT

public static final java.lang.String FEATURE_NAME_AOT

See Also:

Constant Field Values

Constructor Detail

MicronautAot

public MicronautAot()

Method Detail

getCategory

public java.lang.String getCategory()

Specified by:

getCategory in interface Feature

Returns:

The Category to which the feature belongs to.

getName

@NonNull
public java.lang.String getName()

Description copied from interface: Feature

The name of the feature. It must be unique.

Specified by:

getName in interface io.micronaut.core.naming.Named

Specified by:

getName in interface Feature

Returns:

the name of the feature

getDescription

@NonNull
public java.lang.String getDescription()

Specified by:

getDescription in interface io.micronaut.core.naming.Described

Specified by:

getDescription in interface Feature

getMicronautDocumentation

@Nullable
public java.lang.String getMicronautDocumentation()

Specified by:

getMicronautDocumentation in interface Feature

Returns:

Returns a link to Micronaut documentation about the feature. eg. https://micronaut-projects.github.io/micronaut-cache/latest/guide/index.html#hazelcast

getTitle

public java.lang.String getTitle()

Specified by:

getTitle in interface Feature

Returns:

The title of the feature

supports

public boolean supports(ApplicationType applicationType)

Description copied from interface: Feature

This method must be implemented to ensure it is only selectable for the desired application types. This method is not used for determining if a default feature should be applied.

Specified by:

supports in interface Feature

Parameters:

applicationType - The application type

Returns:

True if the feature can be selected by the user

apply

public void apply(GeneratorContext generatorContext)

Description copied from interface: Feature

If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of DefaultFeature.shouldApply(ApplicationType, io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature). At this point the feature list is set and cannot change. This method can be implemented to modify the generated project. The feature can add templates by executing GeneratorContext.addTemplate(String, io.micronaut.starter.template.Template), modify configuration by modifying GeneratorContext.getConfiguration() or GeneratorContext.getBootstrapConfiguration(), or modify build properties through GeneratorContext.getBuildProperties().

Specified by:

apply in interface Feature

Parameters:

generatorContext - THe generator context