Package io.micronaut.starter.feature.lang.kotlin

Class Kotlin

java.lang.Object

io.micronaut.starter.feature.lang.kotlin.Kotlin

All Implemented Interfaces:

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

@Requires(property="micronaut.starter.feature.kotlin.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class Kotlin
extends Object
implements LanguageFeature

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<KotlinApplicationFeature>	applicationFeatures
protected static final Dependency	DEPENDENCY_MICRONAUT_KOTLIN_RUNTIME

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
Kotlin(List<KotlinApplicationFeature> applicationFeatures)

Method Summary

Modifier and Type	Method	Description
protected void	addDependencies(GeneratorContext generatorContext)
protected void	addKotlinVersionProperty(GeneratorContext generatorContext)
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).
@NonNull String	getName()	The name of the feature.
boolean	isKotlin()
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(ApplicationType, io.micronaut.starter.options.Options, java.util.Set).
protected void	processSelectedFeatures(FeatureContext featureContext, Predicate<Feature> filter)
boolean	shouldApply(ApplicationType applicationType, 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.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, getThirdPartyDocumentation, getTitle, isCommunity, isPreview

Methods inherited from interface io.micronaut.starter.feature.lang.LanguageFeature

getOrder, isGroovy, isJava, isVisible, supports

Field Details

DEPENDENCY_MICRONAUT_KOTLIN_RUNTIME

protected static final Dependency DEPENDENCY_MICRONAUT_KOTLIN_RUNTIME

applicationFeatures

protected final List<KotlinApplicationFeature> applicationFeatures

Constructor Details

Kotlin

public Kotlin(List<KotlinApplicationFeature> applicationFeatures)

Method Details

getName

@NonNull
public @NonNull 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

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(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 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

processSelectedFeatures

protected void processSelectedFeatures(FeatureContext featureContext,
 Predicate<Feature> filter)

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

addKotlinVersionProperty

protected void addKotlinVersionProperty(GeneratorContext generatorContext)

addDependencies

protected void addDependencies(GeneratorContext generatorContext)

isKotlin

public boolean isKotlin()

Specified by:

isKotlin in interface LanguageFeature

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 interface DefaultFeature

Parameters:

applicationType - The application type

options - The options

selectedFeatures - The features manually selected by the user

Returns:

True if the feature should apply