io.micronaut.starter.feature

Interface ApplicationFeature

All Superinterfaces:

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

All Known Subinterfaces:

GroovyApplicationFeature, JavaApplicationFeature, KotlinApplicationFeature

All Known Implementing Classes:

AwsLambdaCustomRuntime, GroovyApplication, JavaApplication, KotlinApplication, Ktor, PicocliGroovyApplication, PicocliJavaApplication, PicocliKotlinApplication

public interface ApplicationFeature
extends Feature

Field Summary

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method and Description
default 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).
default boolean	isVisible() Some features should not be visible to the user because they are a common parent of other selectable features, or they should always be applied, or any other reason.
java.lang.String	mainClassName(GeneratorContext generatorContext)

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

getCategory, getDescription, getMicronautDocumentation, getName, getOrder, getThirdPartyDocumentation, getTitle, isPreview, processSelectedFeatures, supports

Method Detail

mainClassName

@Nullable
java.lang.String mainClassName(GeneratorContext generatorContext)

isVisible

default boolean isVisible()

Description copied from interface: Feature

Some features should not be visible to the user because they are a common parent of other selectable features, or they should always be applied, or any other reason.

Specified by:

isVisible in interface Feature

Returns:

True if the feature should able to be selected by the user

apply

default 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