Package org.openrewrite.text

Class ChangeText

java.lang.Object
org.openrewrite.Recipe
org.openrewrite.text.ChangeText
All Implemented Interfaces:
Cloneable
public class ChangeText extends Recipe

  • Constructor Details

    • ChangeText

      public ChangeText()

  • Method Details

    • getTags

      public Set<String> getTags()
      Description copied from class: Recipe
      A set of strings used for categorizing related recipes. For example "testing", "junit", "spring". Any individual tag should consist of a single word, all lowercase.
      Overrides:
      getTags in class Recipe
      Returns:
      The tags.

    • getDisplayName

      public 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.

    • getInstanceNameSuffix

      public String getInstanceNameSuffix()
      Description copied from class: Recipe
      Since most instance names will be constructed with Recipe.getDisplayName() followed by some further descriptive text about the recipe's options, this method provides a convenient way to just specify the option descriptive text. When Recipe.getInstanceName() is overridden, this method has no effect. Generally either override this method or Recipe.getInstanceName() if you want to customize the instance name text.
      Overrides:
      getInstanceNameSuffix in class Recipe
      Returns:
      A suffix to append to the display name of a recipe.

    • getDescription

      public 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`.".

      Specified by:
      getDescription in class Recipe
      Returns:
      The display name.

    • getVisitor

      public TreeVisitor<?,ExecutionContext> getVisitor()
      Description copied from class: Recipe
      A recipe can optionally encapsulate 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.