Package io.micronaut.projectgen.core.feature.config

Class Yaml

java.lang.Object

io.micronaut.projectgen.core.feature.config.Yaml

All Implemented Interfaces:

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

@Requires(property="micronaut.starter.feature.yaml.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class Yaml
extends Object
implements ConfigurationFeature

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
Yaml()

Method Summary

Modifier and Type	Method	Description
Function<Configuration,Template>	createTemplate()
String	getDescription()
@NonNull String	getName()	The name of the feature.
int	getOrder()	The order of a feature controls the order in which it applies.
String	getTitle()
void	processSelectedFeatures(FeatureContext featureContext)	If this method is called for a given feature then that feature was explicitly selected or was included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set).

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.projectgen.core.feature.ConfigurationFeature

apply, getFeatureClass

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

getDescription

Methods inherited from interface io.micronaut.projectgen.core.feature.Feature

getCategory, getFrameworkDocumentation, getThirdPartyDocumentation, isCommunity, isPreview, isVisible, supports

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

Yaml

public Yaml()

Method Details

getName

@NonNull
public @NonNull String getName()

Description copied from interface: Feature

The name of the feature. It must be unique.

Specified by:

getName in interface Feature

Specified by:

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

Returns:

the name of the feature

getTitle

public String getTitle()

Specified by:

getTitle in interface Feature

Returns:

The title of the feature

getDescription

public String getDescription()

Specified by:

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

Specified by:

getDescription in interface Feature

processSelectedFeatures

public void processSelectedFeatures(FeatureContext featureContext)

Description copied from interface: Feature

If this method is called for a given feature then that feature was explicitly selected or was included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set). This method can be implemented to allow features to modify the list of features that will apply to the project. The methods FeatureContext.addFeature(Feature) and FeatureContext.exclude(FeaturePredicate) are the primary ways to add and remove features from the context. FeatureContext.isPresent(Class) can be used to determine the existence of other features in order to make decisions.

Specified by:

processSelectedFeatures in interface Feature

Parameters:

featureContext - The feature context

getOrder

public int getOrder()

Description copied from interface: Feature

The order of a feature controls the order in which it applies. The order of a feature is important to ensure that any previous work done by other features that may be required is done. See FeaturePhase for a list of phases to choose from.

Specified by:

getOrder in interface Feature

Specified by:

getOrder in interface io.micronaut.core.order.Ordered

Returns:

The order of the feature

createTemplate

public Function<Configuration,Template> createTemplate()

Specified by:

createTemplate in interface ConfigurationFeature