io.micronaut.starter.feature.config

Class Yaml

java.lang.Object

io.micronaut.starter.feature.config.Yaml

All Implemented Interfaces:

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

@Singleton
public class Yaml
extends java.lang.Object
implements ConfigurationFeature, DefaultFeature

Field Summary

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
Yaml()

Method Summary

Modifier and Type	Method and Description
java.util.function.Function<Configuration,Template>	createTemplate()
java.lang.String	getName() The name of the feature.
int	getOrder() The order of a feature controls the order in which it applies.
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.
boolean	shouldApply(ApplicationType applicationType, Options options, java.util.Set<Feature> selectedFeatures) Determines if the feature should be applied to the project.
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.config.ConfigurationFeature

apply, getCategory, getFeatureClass

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

getDescription, getMicronautDocumentation, getThirdPartyDocumentation, getTitle, isCommunity, isPreview, processSelectedFeatures

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

getDescription

Constructor Detail

Yaml

public Yaml()

Method Detail

getName

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

isVisible

public 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

shouldApply

public boolean shouldApply(ApplicationType applicationType,
                           Options options,
                           java.util.Set<Feature> selectedFeatures)

Description copied from interface: DefaultFeature

Determines if the feature should be applied to the project. Default features do not need to be concerned if the feature was already selected and therefore is already in the list of selected features. The addition to the set is based on the identity of the feature instance and all features are singletons.

Specified by:

shouldApply in interface DefaultFeature

Parameters:

applicationType - The application type

options - The options

selectedFeatures - The features manually selected by the user

Returns:

True if the feature should apply

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 io.micronaut.core.order.Ordered

Specified by:

getOrder in interface Feature

Returns:

The order of the feature

createTemplate

public java.util.function.Function<Configuration,Template> createTemplate()

Specified by:

createTemplate in interface ConfigurationFeature

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