Package io.micronaut.starter.feature.config

Class Properties

java.lang.Object

io.micronaut.starter.feature.config.Properties

All Implemented Interfaces:

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

@Singleton
public class Properties
extends Object
implements DefaultConfigurationFeature

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
Properties()

Method Summary

Modifier and Type	Method	Description
Function<Configuration,Template>	createTemplate()
String	getDescription()
String	getName()	The name of the feature.
int	getOrder()	The order of a feature controls the order in which it applies.
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.config.ConfigurationFeature

apply, getCategory, getFeatureClass

Methods inherited from interface io.micronaut.starter.feature.config.DefaultConfigurationFeature

shouldApply

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

getTargetFramework

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

getDescription

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

getMicronautDocumentation, getThirdPartyDocumentation, isCommunity, isPreview, isVisible, processSelectedFeatures

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

Properties

public Properties()

Method Details

getName

public 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

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

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