Package io.micronaut.starter.feature.config

Interface ConfigurationFeature

All Superinterfaces:

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

All Known Subinterfaces:

DefaultConfigurationFeature

All Known Implementing Classes:

Config4k, Properties, Toml, Yaml

public interface ConfigurationFeature
extends OneOfFeature

Field Summary

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method	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).
Function<Configuration,Template>	createTemplate()
default String	getCategory()
default Class<?>	getFeatureClass()

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

getDescription

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

getDescription, getMicronautDocumentation, getName, getOrder, getThirdPartyDocumentation, getTitle, isCommunity, isPreview, isVisible, processSelectedFeatures, supports

Method Details

getFeatureClass

default Class<?> getFeatureClass()

Specified by:

getFeatureClass in interface OneOfFeature

getCategory

default String getCategory()

Specified by:

getCategory in interface Feature

Returns:

The Category to which the feature belongs to.

createTemplate

Function<Configuration,Template> createTemplate()

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