Package org.openrewrite.text

Class CreateTextFile

java.lang.Object

org.openrewrite.Recipe

org.openrewrite.text.CreateTextFile

@Incubating(since="7.12.0")
public class CreateTextFile
extends Recipe

Field Summary

Fields inherited from class org.openrewrite.Recipe

NOOP, PANIC

Constructor Summary

Constructors

Constructor	Description
CreateTextFile()

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 java.util.List<SourceFile>	visit(java.util.List<SourceFile> before, ExecutionContext ctx)	Override this to generate new source files or delete source files.

Methods inherited from class org.openrewrite.Recipe

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateTextFile

public CreateTextFile()

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.

visit

protected java.util.List<SourceFile> visit(java.util.List<SourceFile> before,
                                           ExecutionContext ctx)

Description copied from class: Recipe

Override this to generate new source files or delete source files.

Overrides:

visit in class Recipe

Parameters:

before - The set of source files to operate on.

ctx - The current execution context.

Returns:

A set of source files, with some files potentially added/deleted/modified.