Package io.micronaut.projectgen.core.openrewrite

Interface OpenRewriteFeature

All Superinterfaces:

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

public interface OpenRewriteFeature
extends Feature

A feature backed by an OpenRewrite recipe.

Field Summary

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method	Description
default 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).
default String	getFrameworkDocumentation(GeneratorContext gc)
List<String>	getRecipes(GeneratorContext generatorContext)
default String	getThirdPartyDocumentation(GeneratorContext gc)
default void	processRecipes(GeneratorContext generatorContext)

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

getDescription

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

getCategory, getDescription, getName, getOrder, getTitle, isCommunity, isPreview, isVisible, processSelectedFeatures, supports

Method Details

getRecipes

List<String> getRecipes(GeneratorContext generatorContext)

apply

default 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 Feature

Parameters:

generatorContext - THe generator context

processRecipes

default void processRecipes(GeneratorContext generatorContext)

getFrameworkDocumentation

default String getFrameworkDocumentation(GeneratorContext gc)

Specified by:

getFrameworkDocumentation in interface Feature

Parameters:

gc - Generator Context

Returns:

Returns a link to Framework documentation about the feature. eg. https://micronaut-projects.github.io/micronaut-cache/latest/guide/index.html#hazelcast

getThirdPartyDocumentation

default String getThirdPartyDocumentation(GeneratorContext gc)

Specified by:

getThirdPartyDocumentation in interface Feature

Parameters:

gc - Generator Context

Returns:

Returns a link to third party. E.g. https://hazelcast.org