io.micronaut.starter.feature.build

Interface BuildFeature

All Superinterfaces:

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

All Known Implementing Classes:

Gradle, Maven

public interface BuildFeature
extends DefaultFeature

Field Summary

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method and Description
default int	getOrder() The order of a feature controls the order in which it applies.
default 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.
default boolean	supports(ApplicationType applicationType) This method must be implemented to ensure it is only selectable for the desired application types.

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

shouldApply

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

apply, getCategory, getDescription, getMicronautDocumentation, getName, getThirdPartyDocumentation, getTitle, isCommunity, isPreview, processSelectedFeatures

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

getDescription

Method Detail

isVisible

default 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

getOrder

default 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

supports

default 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