Package org.openrewrite

Class FindLstProvenance

java.lang.Object

org.openrewrite.Recipe

org.openrewrite.ScanningRecipe<FindLstProvenance.Accumulator>

org.openrewrite.FindLstProvenance

All Implemented Interfaces:

Cloneable

public class FindLstProvenance
extends ScanningRecipe<FindLstProvenance.Accumulator>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FindLstProvenance.Accumulator

Field Summary

Fields inherited from class org.openrewrite.Recipe

contributors, examples, PANIC

Constructor Summary

Constructors

Constructor	Description
FindLstProvenance()

Method Summary

Modifier and Type	Method	Description
String	getDescription()	A human-readable description for the recipe, consisting of one or more full sentences ending with a period.
String	getDisplayName()	A human-readable display name for the recipe, initial capped with no period.
FindLstProvenance.Accumulator	getInitialValue(ExecutionContext ctx)
TreeVisitor<?,ExecutionContext>	getScanner(FindLstProvenance.Accumulator acc)	A visitor that is called for each source file in the repository in an initial pass.

Methods inherited from class org.openrewrite.ScanningRecipe

generate, generate, getAccumulator, getVisitor, getVisitor

Methods inherited from class org.openrewrite.Recipe

addDataTable, causesAnotherCycle, clone, createRecipeDescriptor, equals, getContributors, getDataTableDescriptors, getDescriptor, getEstimatedEffortPerOccurrence, getExamples, getJacksonPolymorphicTypeTag, getMaintainers, getName, getRecipeList, getTags, hashCode, maxCycles, noop, run, run, run, validate, validate, validateAll, validateAll

Methods inherited from class java.lang.Object

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

Constructor Details

FindLstProvenance

public FindLstProvenance()

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 FindLstProvenance.Accumulator getInitialValue(ExecutionContext ctx)

Specified by:

getInitialValue in class ScanningRecipe<FindLstProvenance.Accumulator>

Returns:

The initial value of the accumulator before any source files have been iterated over.

getScanner

public TreeVisitor<?,ExecutionContext> getScanner(FindLstProvenance.Accumulator acc)

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<FindLstProvenance.Accumulator>

Parameters:

acc - The accumulated scanning data.

Returns:

A visitor that is called to collect scanning data on each source file.