Package org.openrewrite

Class RenameFile

java.lang.Object

org.openrewrite.Recipe

org.openrewrite.RenameFile

public class RenameFile
extends Recipe

Field Summary

Fields inherited from class org.openrewrite.Recipe

NOOP, PANIC

Constructor Summary

Constructors

Constructor	Description
RenameFile()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()	A human-readable description for the recipe, consisting of one or more full sentences ending with a period.
java.lang.String	getDisplayName()	A human-readable display name for the recipe, initial capped with no period.
protected TreeVisitor<?,ExecutionContext>	getVisitor()	A recipe can optionally encasulate a visitor that performs operations on a set of source files.

Methods inherited from class org.openrewrite.Recipe

causesAnotherCycle, doNext, equals, getApplicableTest, getDescriptor, getEstimatedEffortPerOccurrence, getJacksonPolymorphicTypeTag, getLanguages, getName, getRecipeList, getSingleSourceApplicableTest, getTags, hashCode, noop, run, run, run, run, validate, validate, validateAll, validateAll, visit

Methods inherited from class java.lang.Object

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

Constructor Detail

RenameFile

public RenameFile()

Method Detail

getDisplayName

public java.lang.String getDisplayName()

Description copied from class: Recipe

A human-readable display name for the recipe, initial capped with no period. For example, "Find text". The display name can be assumed to be rendered in documentation and other places where markdown is understood, so it is possible to use stylistic markers like backticks to indicate types. For example, "Find uses of `java.util.List`".

Specified by:

getDisplayName in class Recipe

Returns:

The display name.

getDescription

public java.lang.String getDescription()

Description copied from class: Recipe

A human-readable description for the recipe, consisting of one or more full sentences ending with a period.

"Find methods by pattern." is an example. The description can be assumed to be rendered in documentation and other places where markdown is understood, so it is possible to use stylistic markers like backticks to indicate types. For example, "Find uses of `java.util.List`.".

Overrides:

getDescription in class Recipe

Returns:

The display name.

getVisitor

protected TreeVisitor<?,ExecutionContext> getVisitor()

Description copied from class: Recipe

A recipe can optionally encasulate a visitor that performs operations on a set of source files. Subclasses of the recipe may override this method to provide an instance of a visitor that will be used when the recipe is executed.

Overrides:

getVisitor in class Recipe

Returns:

A tree visitor that will perform operations associated with the recipe.