Class Toml
java.lang.Object
io.micronaut.starter.feature.config.Toml
- All Implemented Interfaces:
io.micronaut.core.naming.Described,io.micronaut.core.naming.Named,io.micronaut.core.order.Ordered,ConfigurationFeature,Feature,OneOfFeature
-
Field Summary
FieldsFields inherited from interface io.micronaut.core.order.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetName()The name of the feature.intgetOrder()The order of a feature controls the order in which it applies.getTitle()voidprocessSelectedFeatures(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 ofDefaultFeature.shouldApply(ApplicationType, io.micronaut.starter.options.Options, java.util.Set).booleansupports(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, waitMethods inherited from interface io.micronaut.starter.feature.config.ConfigurationFeature
apply, getCategory, getFeatureClassMethods inherited from interface io.micronaut.core.naming.Described
getDescriptionMethods inherited from interface io.micronaut.starter.feature.Feature
getMicronautDocumentation, getThirdPartyDocumentation, isCommunity, isPreview, isVisible
-
Field Details
-
NAME
- See Also:
-
-
Constructor Details
-
Toml
public Toml()
-
-
Method Details
-
processSelectedFeatures
Description copied from interface:FeatureIf this method is called for a given feature then that feature was explicitly selected or was included by default as a result ofDefaultFeature.shouldApply(ApplicationType, 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 methodsFeatureContext.addFeature(Feature)andFeatureContext.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:
processSelectedFeaturesin interfaceFeature- Parameters:
featureContext- The feature context
-
getName
Description copied from interface:FeatureThe name of the feature. It must be unique. -
getTitle
-
getDescription
- Specified by:
getDescriptionin interfaceio.micronaut.core.naming.Described- Specified by:
getDescriptionin interfaceFeature
-
getOrder
public int getOrder()Description copied from interface:FeatureThe 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. SeeFeaturePhasefor a list of phases to choose from. -
supports
Description copied from interface:FeatureThis 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. -
createTemplate
- Specified by:
createTemplatein interfaceConfigurationFeature
-