Package org.openrewrite.marker

Class SearchResult

java.lang.Object

org.openrewrite.marker.SearchResult

All Implemented Interfaces:

Marker

public final class SearchResult
extends Object
implements Marker

Constructor Summary

Constructors

Constructor	Description
SearchResult()

Method Summary

Modifier and Type	Method	Description
static <T extends Tree> T	found(T t)
static <T extends Tree> T	found(T t, @Nullable String description)
static <T extends Tree> T	mergingFound(T t, String description)	Merge the description of two search results into a single search result with a unified description.
static <T extends Tree> T	mergingFound(T t, String description, String delimiter)	Merge the description of two search results into a single search result with a unified description.
String	print(Cursor cursor, UnaryOperator<String> commentWrapper, boolean verbose)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openrewrite.marker.Marker

getId, withId

Constructor Details

SearchResult

public SearchResult()

Method Details

found

public static <T extends Tree> T found(@Nullable
 T t)

found

public static <T extends Tree> T found(@Nullable
 T t,
 @Nullable
 @Nullable String description)

mergingFound

@Incubating(since="8.0.0")
public static <T extends Tree> T mergingFound(@Nullable
 T t,
 String description)

Merge the description of two search results into a single search result with a unified description.

If the there already exists a search result with the same description, the existing search result is returned.

mergingFound

@Incubating(since="8.0.0")
public static <T extends Tree> T mergingFound(@Nullable
 T t,
 String description,
 String delimiter)

Merge the description of two search results into a single search result with a unified description.

If the there already exists a search result with the same description, the existing search result is returned.

Parameters:

delimiter - The delimiter to use when merging descriptions.

print

public String print(Cursor cursor,
 UnaryOperator<String> commentWrapper,
 boolean verbose)

Specified by:

print in interface Marker

Parameters:

cursor - The cursor at the point where the marker is being visited.

commentWrapper - A function that wraps arbitrary text in a multi-line comment that is language-specific.

Returns:

The printed representation of the marker.