Package org.openrewrite.maven

Class ConfigurableRewriteMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.openrewrite.maven.ConfigurableRewriteMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

AbstractRewriteMojo

public abstract class ConfigurableRewriteMojo
extends org.apache.maven.plugin.AbstractMojo

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable String	checkstyleConfigFile
protected boolean	failOnInvalidActiveRecipes	Whether to throw an exception if an activeRecipe fails configuration validation.
protected @Nullable String	metricsPassword
protected @Nullable String	metricsUri
protected @Nullable String	metricsUsername
protected @Nullable String	pomCacheDirectory
protected boolean	pomCacheEnabled
protected boolean	runPerSubmodule
protected @org.openrewrite.internal.lang.Nullable int	sizeThresholdMb
protected boolean	skipMavenParsing	When enabled, skip parsing Maven `pom.xml`s, and any transitive poms, as source files.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
ConfigurableRewriteMojo()

Method Summary

Modifier and Type	Method	Description
protected Set<String>	getActiveRecipes()
protected Set<String>	getActiveStyles()
protected Set<String>	getExclusions()
protected Set<String>	getRecipeArtifactCoordinates()

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.maven.plugin.Mojo

execute

Field Details

metricsUri

@Nullable
@Parameter(property="rewrite.metricsUri",
           alias="metricsUri")
protected @Nullable String metricsUri

metricsUsername

@Nullable
@Parameter(property="rewrite.metricsUsername",
           alias="metricsUsername")
protected @Nullable String metricsUsername

metricsPassword

@Nullable
@Parameter(property="rewrite.metricsPassword",
           alias="metricsPassword")
protected @Nullable String metricsPassword

pomCacheEnabled

@Parameter(property="rewrite.pomCacheEnabled",
           alias="pomCacheEnabled",
           defaultValue="true")
protected boolean pomCacheEnabled

pomCacheDirectory

@Nullable
@Parameter(property="rewrite.pomCacheDirectory",
           alias="pomCacheDirectory")
protected @Nullable String pomCacheDirectory

skipMavenParsing

@Parameter(property="skipMavenParsing",
           defaultValue="false")
protected boolean skipMavenParsing

When enabled, skip parsing Maven `pom.xml`s, and any transitive poms, as source files. This can be an efficiency improvement in certain situations.

checkstyleConfigFile

@Nullable
@Parameter(property="rewrite.checkstyleConfigFile",
           alias="checkstyleConfigFile")
protected @Nullable String checkstyleConfigFile

sizeThresholdMb

@Nullable
@Parameter(property="sizeThresholdMb",
           defaultValue="10")
protected @org.openrewrite.internal.lang.Nullable int sizeThresholdMb

failOnInvalidActiveRecipes

@Parameter(property="rewrite.failOnInvalidActiveRecipes",
           alias="failOnInvalidActiveRecipes",
           defaultValue="false")
protected boolean failOnInvalidActiveRecipes

Whether to throw an exception if an activeRecipe fails configuration validation. This may happen if the activeRecipe is improperly configured, or any downstream recipes are improperly configured.

For the time, this default is "false" to prevent one improperly recipe from failing the build. In the future, this default may be changed to "true" to be more restrictive.

runPerSubmodule

@Parameter(property="rewrite.runPerSubmodule",
           alias="runPerSubmodule",
           defaultValue="false")
protected boolean runPerSubmodule

Constructor Details

ConfigurableRewriteMojo

public ConfigurableRewriteMojo()

Method Details

getExclusions

protected Set<String> getExclusions()

getActiveRecipes

protected Set<String> getActiveRecipes()

getActiveStyles

protected Set<String> getActiveStyles()

getRecipeArtifactCoordinates

protected Set<String> getRecipeArtifactCoordinates()