Package io.micronaut.starter.feature.other

Class OpenRewrite

java.lang.Object

io.micronaut.starter.feature.other.OpenRewrite

All Implemented Interfaces:

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

@Requires(property="micronaut.starter.feature.openrewrite.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class OpenRewrite
extends Object
implements LanguageSpecificFeature

Adds OpenRewrite support to the project, including the OpenRewrite plugin and the Micronaut 3 to 4 migration recipe. Supports both Gradle and Maven build tools, adding appropriate build plugins and dependencies.

Field Summary

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
OpenRewrite(CoordinateResolver coordinateResolver)

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()
@NonNull String	getDescription()
@NonNull String	getName()	The name of the feature.
Language	getRequiredLanguage()
String	getThirdPartyDocumentation(GeneratorContext generatorContext)
String	getTitle()

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

getFrameworkDocumentation, getOrder, isCommunity, isPreview, isVisible, processSelectedFeatures, supports

Constructor Details

OpenRewrite

public OpenRewrite(CoordinateResolver coordinateResolver)

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

getTitle

public String getTitle()

Specified by:

getTitle in interface Feature

Returns:

The title of the feature

getDescription

@NonNull
public @NonNull String getDescription()

Specified by:

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

Specified by:

getDescription in interface 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 Feature

Parameters:

generatorContext - THe generator context

getCategory

public String getCategory()

Specified by:

getCategory in interface Feature

Returns:

The Category to which the feature belongs to.

getThirdPartyDocumentation

public String getThirdPartyDocumentation(GeneratorContext generatorContext)

Specified by:

getThirdPartyDocumentation in interface Feature

Parameters:

generatorContext - Generator Context

Returns:

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

getRequiredLanguage

public Language getRequiredLanguage()

Specified by:

getRequiredLanguage in interface LanguageSpecificFeature

Returns:

The language this feature requires, or empty if the feature can be used with any language.