io.micronaut.starter.feature.build

Class KotlinBuildPlugins

java.lang.Object

io.micronaut.starter.feature.build.KotlinBuildPlugins

All Implemented Interfaces:

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

@Singleton
public class KotlinBuildPlugins
extends java.lang.Object
implements Feature

Field Summary

Fields

Modifier and Type	Field and Description
static int	ORDER

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
KotlinBuildPlugins()

Method Summary

Modifier and Type	Method and Description
void	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 of DefaultFeature.shouldApply(ApplicationType, io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature).
java.lang.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.
boolean	shouldApply(FeatureContext featureContext)
boolean	shouldApply(LanguageFeature languageFeature, TestFeature testFeature)
boolean	shouldApply(Language language, TestFramework testFramework)
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.Feature

getCategory, getDescription, getMicronautDocumentation, getOrder, getThirdPartyDocumentation, getTitle, isCommunity, isPreview, processSelectedFeatures

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

getDescription

Field Detail

ORDER

public static final int ORDER

See Also:

Constant Field Values

Constructor Detail

KotlinBuildPlugins

public KotlinBuildPlugins()

Method Detail

getName

public java.lang.String getName()

Description copied from interface: Feature

The name of the feature. It must be unique.

Specified by:

getName in interface io.micronaut.core.naming.Named

Specified by:

getName in interface Feature

Returns:

the name of the feature

apply

public void apply(GeneratorContext generatorContext)

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 of DefaultFeature.shouldApply(ApplicationType, io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.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 executing GeneratorContext.addTemplate(String, io.micronaut.starter.template.Template), modify configuration by modifying GeneratorContext.getConfiguration() or GeneratorContext.getBootstrapConfiguration(), or modify build properties through GeneratorContext.getBuildProperties().

Specified by:

apply in interface Feature

Parameters:

generatorContext - THe generator context

shouldApply

public boolean shouldApply(FeatureContext featureContext)

shouldApply

public boolean shouldApply(LanguageFeature languageFeature,
                           TestFeature testFeature)

shouldApply

public boolean shouldApply(Language language,
                           TestFramework testFramework)

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

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