Package org.openrewrite

Class SourceVisitor<R>

java.lang.Object

org.openrewrite.SourceVisitor<R>

Direct Known Subclasses:

CompositeSourceVisitor, FindIndent

public abstract class SourceVisitor<R>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected int	cycle

Constructor Summary

Constructors

Constructor	Description
SourceVisitor()

Method Summary

Modifier and Type	Method	Description
java.util.List<SourceVisitor<R>>	andThen()	Used to build up pipelines of visitors.
void	andThen(SourceVisitor<R> visitor)
abstract R	defaultTo(Tree t)
Cursor	getCursor()
java.lang.String	getName()
java.lang.Iterable<io.micrometer.core.instrument.Tag>	getTags()
boolean	isIdempotent()	Determines whether this visitor can be run multiple times as a top-level rule.
void	nextCycle()
R	reduce(R r1, R r2)	Some sensible defaults for reduce (boolean OR, list concatenation, or else just the value of r1).
protected void	setCursoringOn()
Validated	validate()
R	visit(java.util.List<? extends Tree> trees)
R	visit(Tree tree)
R	visitAfter(R r, java.util.List<? extends Tree> trees)
R	visitAfter(R r, Tree tree)
R	visitTree(Tree tree)

Methods inherited from class java.lang.Object

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

Field Detail

cycle

protected volatile int cycle

Constructor Detail

SourceVisitor

public SourceVisitor()

Method Detail

getTags

public java.lang.Iterable<io.micrometer.core.instrument.Tag> getTags()

setCursoringOn

protected void setCursoringOn()

andThen

public java.util.List<SourceVisitor<R>> andThen()

Used to build up pipelines of visitors.

Returns:

Other visitors that are run after this one.

andThen

public void andThen(SourceVisitor<R> visitor)

isIdempotent

public boolean isIdempotent()

Determines whether this visitor can be run multiple times as a top-level rule. In the case of a visitor which mutates the underlying tree, indicates that running once or N times will yield the same mutation.

Returns:

If true, this visitor can be run multiple times.

validate

public Validated validate()

getName

public java.lang.String getName()

getCursor

public Cursor getCursor()

nextCycle

public void nextCycle()

defaultTo

public abstract R defaultTo(@Nullable
                            Tree t)

reduce

public R reduce(R r1,
                R r2)

Some sensible defaults for reduce (boolean OR, list concatenation, or else just the value of r1). Override if your particular visitor needs to reduce values in a different way.

Parameters:

r1 - The left side to reduce.

r2 - The right side to reduce.

Returns:

The reduced value.

visit

public final R visit(@Nullable
                     Tree tree)

visit

public R visit(@Nullable
               java.util.List<? extends Tree> trees)

visitTree

public R visitTree(Tree tree)

visitAfter

public final R visitAfter(R r,
                          @Nullable
                          Tree tree)

visitAfter

public final R visitAfter(R r,
                          @Nullable
                          java.util.List<? extends Tree> trees)