Package io.micronaut.starter.feature.kotlin

Class Ktor

java.lang.Object

io.micronaut.starter.feature.kotlin.Ktor

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, ApplicationFeature, Feature, KotlinApplicationFeature, KotlinSpecificFeature, LanguageSpecificFeature, OneOfFeature, OpenRewriteFeature, ServerFeature, ThirdPartyServerFeature

@Requires(property="micronaut.starter.feature.ktor.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class Ktor
extends Object
implements KotlinApplicationFeature, ThirdPartyServerFeature, KotlinSpecificFeature, OpenRewriteFeature

Feature that enables support for building Micronaut applications using Ktor as the HTTP server. This feature is only applicable for Kotlin language and the default application type.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
Ktor(MicronautValidationFeature micronautValidationFeature)

Method Summary

Modifier and Type	Method	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(io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature).
String	getCategory()
String	getDescription()
@NonNull String	getName()	The name of the feature.
int	getOrder()	The order of a feature controls the order in which it applies.
List<String>	getRecipes(GeneratorContext generatorContext)
String	getTitle()
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.
@Nullable String	mainClassName(GeneratorContext generatorContext)
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	supports(Options options)	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.core.naming.Described

getDescription

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

isCommunity, isPreview

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

getRequiredLanguage

Methods inherited from interface io.micronaut.projectgen.core.openrewrite.OpenRewriteFeature

getFrameworkDocumentation, getThirdPartyDocumentation, processRecipes

Methods inherited from interface io.micronaut.starter.feature.server.ServerFeature

getFeatureClass

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

Ktor

public Ktor(MicronautValidationFeature micronautValidationFeature)

Method Details

supports

public boolean supports(Options options)

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

Specified by:

supports in interface ServerFeature

Parameters:

options - Options

Returns:

True if the feature can be selected by the user

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

@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

getDescription

public String getDescription()

Specified by:

getDescription in interface io.micronaut.core.naming.Described

Specified by:

getDescription in interface Feature

getTitle

public String getTitle()

Specified by:

getTitle in interface Feature

Returns:

The title of the feature

getCategory

public String getCategory()

Specified by:

getCategory in interface Feature

Specified by:

getCategory in interface ServerFeature

Returns:

The Category to which the feature belongs to.

mainClassName

@Nullable
public @Nullable String mainClassName(GeneratorContext generatorContext)

Specified by:

mainClassName in interface ApplicationFeature

getRecipes

public List<String> getRecipes(GeneratorContext generatorContext)

Specified by:

getRecipes in interface OpenRewriteFeature

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 ApplicationFeature

Specified by:

isVisible in interface Feature

Returns:

True if the feature should be able to be selected by the user

getOrder

public 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 KotlinApplicationFeature

Specified by:

getOrder in interface io.micronaut.core.order.Ordered

Returns:

The order 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(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.

Specified by:

apply in interface ApplicationFeature

Specified by:

apply in interface Feature

Specified by:

apply in interface OpenRewriteFeature

Parameters:

generatorContext - THe generator context