Package org.openrewrite.maven

Class AbstractRewriteMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.openrewrite.maven.AbstractRewriteMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

CycloneDxBomMojo, RewriteDiscoverMojo, RewriteDryRunMojo, RewriteRunMojo

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractRewriteMojo.ResultsContainer

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<String>	activeRecipes
protected Set<String>	activeStyles
protected org.apache.maven.project.MavenProject	project
protected org.apache.maven.rtinfo.RuntimeInformation	runtime
protected boolean	suppressWarnings	Maven dependency resolution has a few bugs that lead to the log filling up with (recoverable) errors.

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

ROLE

Constructor Summary

Constructors

Constructor	Description
AbstractRewriteMojo()

Method Summary

Modifier and Type	Method	Description
protected org.openrewrite.config.Environment	environment()
protected org.openrewrite.ExecutionContext	executionContext()
protected Path	getBaseDir()
static org.openrewrite.config.RecipeDescriptor	getRecipeDescriptor(String recipe, Collection<org.openrewrite.config.RecipeDescriptor> recipeDescriptors)
protected static List<Path>	listJavaSources(String sourceDirectory)
protected AbstractRewriteMojo.ResultsContainer	listResults()
protected void	logRecipesThatMadeChanges(org.openrewrite.Result result)
protected org.openrewrite.maven.tree.Maven	parseMaven(Path baseDir, org.openrewrite.ExecutionContext ctx)

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 Detail

project

@Parameter(defaultValue="${project}",
           readonly=true,
           required=true)
protected org.apache.maven.project.MavenProject project

runtime

@Component
protected org.apache.maven.rtinfo.RuntimeInformation runtime

activeRecipes

@Parameter(property="activeRecipes")
protected Set<String> activeRecipes

activeStyles

@Parameter(property="activeStyles")
protected Set<String> activeStyles

suppressWarnings

protected boolean suppressWarnings

Maven dependency resolution has a few bugs that lead to the log filling up with (recoverable) errors. While we work on fixing those issues, set this to 'true' during maven parsing to avoid log spam

Constructor Detail

AbstractRewriteMojo

public AbstractRewriteMojo()

Method Detail

environment

protected org.openrewrite.config.Environment environment()
                                                  throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

executionContext

protected org.openrewrite.ExecutionContext executionContext()

parseMaven

protected org.openrewrite.maven.tree.Maven parseMaven(Path baseDir,
                                                      org.openrewrite.ExecutionContext ctx)

getBaseDir

protected Path getBaseDir()

listResults

protected AbstractRewriteMojo.ResultsContainer listResults()
                                                    throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

listJavaSources

protected static List<Path> listJavaSources(String sourceDirectory)
                                     throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

logRecipesThatMadeChanges

protected void logRecipesThatMadeChanges(org.openrewrite.Result result)

getRecipeDescriptor

public static org.openrewrite.config.RecipeDescriptor getRecipeDescriptor(String recipe,
                                                                          Collection<org.openrewrite.config.RecipeDescriptor> recipeDescriptors)
                                                                   throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException