Package org.openrewrite.text

Class CreateTextFile

java.lang.Object
org.openrewrite.Recipe
org.openrewrite.ScanningRecipe<AtomicBoolean>
org.openrewrite.text.CreateTextFile
All Implemented Interfaces:
Cloneable
public class CreateTextFile extends ScanningRecipe<AtomicBoolean>

  • Constructor Details

    • CreateTextFile

      public CreateTextFile()

  • Method Details

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

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

    • getInitialValue

      public AtomicBoolean getInitialValue(ExecutionContext ctx)
      Specified by:
      getInitialValue in class ScanningRecipe<AtomicBoolean>
      Returns:
      The initial value of the accumulator before any source files have been iterated over.

    • getScanner

      public TreeVisitor<?,ExecutionContext> getScanner(AtomicBoolean shouldCreate)
      Description copied from class: ScanningRecipe
      A visitor that is called for each source file in the repository in an initial pass. Scanning data should be accumulated to acc. The first source file to visit will receive an acc value that is supplied by ScanningRecipe.getInitialValue(ExecutionContext).
      Any changes that the scanning visitor makes to the source file will be discarded.
      Specified by:
      getScanner in class ScanningRecipe<AtomicBoolean>
      Parameters:
      shouldCreate - The accumulated scanning data.
      Returns:
      A visitor that is called to collect scanning data on each source file.

    • generate

      public Collection<SourceFile> generate(AtomicBoolean shouldCreate, ExecutionContext ctx)
      Description copied from class: ScanningRecipe
      Generate new source files to add to the repository using information collected from scanning.
      Overrides:
      generate in class ScanningRecipe<AtomicBoolean>
      Parameters:
      shouldCreate - The accumulated scanning data.
      Returns:
      A list of new source files.

    • getVisitor

      public TreeVisitor<?,ExecutionContext> getVisitor(AtomicBoolean created)
      Description copied from class: ScanningRecipe
      A visitor that is called in a second pass to perform transformation on each source file. To delete a source file, return null from the TreeVisitor.visit(Tree, Object) method.
      Overrides:
      getVisitor in class ScanningRecipe<AtomicBoolean>
      Parameters:
      created - The accumulated scanning data.
      Returns:
      A visitor that is called to perform transformation on each source file.