Class StaticResourceFeature
java.lang.Object
io.micronaut.starter.feature.staticResources.StaticResourceFeature
- All Implemented Interfaces:
io.micronaut.core.naming.Described
,io.micronaut.core.naming.Named
,io.micronaut.core.order.Ordered
,DefaultFeature
,Feature
-
Field Summary
Fields inherited from interface io.micronaut.core.order.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
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 ofDefaultFeature.shouldApply(ApplicationType, io.micronaut.starter.options.Options, java.util.Set)
, or added explicitly by another feature throughFeatureContext.addFeature(Feature)
.getName()
The name of the feature.boolean
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, 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.DefaultFeature
getTargetFramework
Methods inherited from interface io.micronaut.core.naming.Described
getDescription
Methods inherited from interface io.micronaut.starter.feature.Feature
getCategory, getDescription, getMicronautDocumentation, getOrder, getThirdPartyDocumentation, getTitle, isCommunity, isPreview, processSelectedFeatures
-
Constructor Details
-
StaticResourceFeature
public StaticResourceFeature()
-
-
Method Details
-
getName
Description copied from interface:Feature
The name of the feature. It must be unique. -
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. -
apply
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 ofDefaultFeature.shouldApply(ApplicationType, io.micronaut.starter.options.Options, java.util.Set)
, or added explicitly by another feature throughFeatureContext.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 executingGeneratorContext.addTemplate(String, io.micronaut.starter.template.Template)
, modify configuration by modifyingGeneratorContext.getConfiguration()
orGeneratorContext.getBootstrapConfiguration()
, or modify build properties throughGeneratorContext.getBuildProperties()
. -
supports
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. -
shouldApply
public boolean shouldApply(ApplicationType applicationType, Options options, 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 interfaceDefaultFeature
- Parameters:
applicationType
- The application typeoptions
- The optionsselectedFeatures
- The features manually selected by the user- Returns:
- True if the feature should apply
-