Package org.openrewrite.search

Class FindCommitters

java.lang.Object

org.openrewrite.Recipe

org.openrewrite.ScanningRecipe<Map<String,GitProvenance.Committer>>

org.openrewrite.search.FindCommitters

All Implemented Interfaces:

Cloneable

public class FindCommitters
extends ScanningRecipe<Map<String,GitProvenance.Committer>>

Field Summary

Fields inherited from class org.openrewrite.Recipe

contributors, examples, PANIC

Constructor Summary

Constructors

Constructor	Description
FindCommitters()

Method Summary

Modifier and Type	Method	Description
Collection<? extends SourceFile>	generate(Map<String,GitProvenance.Committer> acc, ExecutionContext ctx)	Generate new source files to add to the repository using information collected from scanning.
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.
Map<String,GitProvenance.Committer>	getInitialValue(ExecutionContext ctx)
TreeVisitor<?,ExecutionContext>	getScanner(Map<String,GitProvenance.Committer> acc)	A visitor that is called for each source file in the repository in an initial pass.
TreeVisitor<?,ExecutionContext>	getVisitor(Map<String,GitProvenance.Committer> acc)	A visitor that is called in a second pass to perform transformation on each source file.

Methods inherited from class org.openrewrite.ScanningRecipe

generate, getAccumulator, 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

FindCommitters

public FindCommitters()

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 Map<String,GitProvenance.Committer> getInitialValue(ExecutionContext ctx)

Specified by:

getInitialValue in class ScanningRecipe<Map<String,GitProvenance.Committer>>

Returns:

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

getScanner

public TreeVisitor<?,ExecutionContext> getScanner(Map<String,GitProvenance.Committer> 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<Map<String,GitProvenance.Committer>>

Parameters:

acc - The accumulated scanning data.

Returns:

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

generate

public Collection<? extends SourceFile> generate(Map<String,GitProvenance.Committer> acc,
 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<Map<String,GitProvenance.Committer>>

Parameters:

acc - The accumulated scanning data.

Returns:

A list of new source files.

getVisitor

public TreeVisitor<?,ExecutionContext> getVisitor(Map<String,GitProvenance.Committer> acc)

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<Map<String,GitProvenance.Committer>>

Parameters:

acc - The accumulated scanning data.

Returns:

A visitor that is called to perform transformation on each source file.