Package io.micronaut.projectgen.quarkus

Class QuarkusDefaultFeature

java.lang.Object

io.micronaut.projectgen.quarkus.QuarkusDefaultFeature

All Implemented Interfaces:

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

@Singleton
public class QuarkusDefaultFeature
extends Object
implements DefaultFeature

Field Summary

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
QuarkusDefaultFeature(Gradle gradle, GitIgnore gitIgnore, JavaGradlePlugin javaGradlePlugin, QuarkusGradlePlugin quarkusGradlePlugin, QuarkusArc quarkusArc, QuarkusRest quarkusRest, QuarkusJunit5 quarkusJunit5, QuarkusBom quarkusBom)

Method Summary

Modifier and Type	Method	Description
String	getName()	The name of the feature.
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.
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).
boolean	shouldApply(Options options, Set<Feature> selectedFeatures)	Determines if the feature should be applied to the project.

Methods inherited from class java.lang.Object

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

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

getDescription

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

apply, getCategory, getDescription, getFrameworkDocumentation, getOrder, getThirdPartyDocumentation, getTitle, isCommunity, isPreview, supports

Constructor Details

QuarkusDefaultFeature

public QuarkusDefaultFeature(Gradle gradle,
 GitIgnore gitIgnore,
 JavaGradlePlugin javaGradlePlugin,
 QuarkusGradlePlugin quarkusGradlePlugin,
 QuarkusArc quarkusArc,
 QuarkusRest quarkusRest,
 QuarkusJunit5 quarkusJunit5,
 QuarkusBom quarkusBom)

Method Details

shouldApply

public boolean shouldApply(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 interface DefaultFeature

Parameters:

options - The options

selectedFeatures - The features manually selected by the user

Returns:

True if the feature should apply

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

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

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 be able to be selected by the user