Package org.openrewrite.maven

Class AbstractRewriteBaseRunMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.openrewrite.maven.ConfigurableRewriteMojo

org.openrewrite.maven.AbstractRewriteMojo

org.openrewrite.maven.AbstractRewriteBaseRunMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractRewriteDryRunMojo, AbstractRewriteRunMojo

public abstract class AbstractRewriteBaseRunMojo
extends AbstractRewriteMojo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractRewriteBaseRunMojo.ResultsContainer

Nested classes/interfaces inherited from class org.openrewrite.maven.ConfigurableRewriteMojo

ConfigurableRewriteMojo.State

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	exportDatatables
protected @Nullable LinkedHashSet<String>	options
protected LogLevel	recipeChangeLogLevel	The level used to log changes performed by recipes.

Fields inherited from class org.openrewrite.maven.AbstractRewriteMojo

project, repositorySystem, resolvePropertiesInYaml, runtime, settingsDecrypter

Fields inherited from class org.openrewrite.maven.ConfigurableRewriteMojo

activeRecipes, activeStyles, checkstyleConfigFile, checkstyleDetectionEnabled, configLocation, failOnInvalidActiveRecipes, mavenSession, metricsPassword, metricsUri, metricsUsername, pluginDescriptor, pomCacheDirectory, pomCacheEnabled, rewriteSkip, runPerSubmodule, sizeThresholdMb, skipMavenParsing

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

ROLE

Constructor Summary

Constructors

Constructor	Description
AbstractRewriteBaseRunMojo()

Method Summary

Modifier and Type	Method	Description
protected Duration	estimateTimeSavedSum(org.openrewrite.Result result, Duration timeSaving)
protected String	formatDuration(Duration duration)
protected AbstractRewriteBaseRunMojo.ResultsContainer	listResults(org.openrewrite.ExecutionContext ctx)
protected org.openrewrite.LargeSourceSet	loadSourceSet(Path repositoryRoot, org.openrewrite.config.Environment env, org.openrewrite.ExecutionContext ctx)
protected void	log(LogLevel logLevel, CharSequence content)
protected void	logRecipesThatMadeChanges(org.openrewrite.Result result)
protected Path	repositoryRoot()	Attempt to determine the root of the git repository for the given project.
protected List<org.openrewrite.Result>	runRecipe(org.openrewrite.Recipe recipe, org.openrewrite.LargeSourceSet sourceSet, org.openrewrite.ExecutionContext ctx)

Methods inherited from class org.openrewrite.maven.AbstractRewriteMojo

environment, environment, executionContext, getBuildRoot, getRecipeArtifactCoordinatesClassloader

Methods inherited from class org.openrewrite.maven.ConfigurableRewriteMojo

allProjectsMarked, getActiveRecipes, getActiveStyles, getExclusions, getPlainTextMasks, getRecipeArtifactCoordinates, loadStyles, putState

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

exportDatatables

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

options

@Parameter(property="rewrite.options")
protected @Nullable LinkedHashSet<String> options

recipeChangeLogLevel

@Parameter(property="rewrite.recipeChangeLogLevel",
           defaultValue="WARN")
protected LogLevel recipeChangeLogLevel

The level used to log changes performed by recipes.

Constructor Details

AbstractRewriteBaseRunMojo

public AbstractRewriteBaseRunMojo()

Method Details

log

protected void log(LogLevel logLevel,
 CharSequence content)

repositoryRoot

protected Path repositoryRoot()

Attempt to determine the root of the git repository for the given project. Many Gradle builds co-locate the build root with the git repository root, but that is not required. If no git repository can be located in any folder containing the build, the build root will be returned.

listResults

protected AbstractRewriteBaseRunMojo.ResultsContainer listResults(org.openrewrite.ExecutionContext ctx)
                                                           throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

loadSourceSet

protected org.openrewrite.LargeSourceSet loadSourceSet(Path repositoryRoot,
 org.openrewrite.config.Environment env,
 org.openrewrite.ExecutionContext ctx)
                                                throws org.apache.maven.artifact.DependencyResolutionRequiredException,
org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.artifact.DependencyResolutionRequiredException

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

runRecipe

protected List<org.openrewrite.Result> runRecipe(org.openrewrite.Recipe recipe,
 org.openrewrite.LargeSourceSet sourceSet,
 org.openrewrite.ExecutionContext ctx)

logRecipesThatMadeChanges

protected void logRecipesThatMadeChanges(org.openrewrite.Result result)

estimateTimeSavedSum

protected Duration estimateTimeSavedSum(org.openrewrite.Result result,
 Duration timeSaving)

formatDuration

protected String formatDuration(Duration duration)