Package org.openrewrite.java

Class CoordinatesPrinter

java.lang.Object

org.openrewrite.java.CoordinatesPrinter

public class CoordinatesPrinter
extends Object

Utility to print a compilation unit with tree coordinates embedded in the output. This can be useful to discover the location within the source code that the coordinate represents.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANSI_BACKGROUND_GREEN
static final String	ANSI_FOREGROUND_GREY
static final String	ANSI_FOREGROUND_WHITE
static final String	ANSI_RESET

Constructor Summary

Constructors

Constructor	Description
CoordinatesPrinter()

Method Summary

Modifier and Type	Method	Description
static String	printCoordinates(J.CompilationUnit cu, @Nullable Class<? extends J> cursorFilter)	This will print out the compilation unit and embed the tree coordinates (at each Space position).
static String	printCoordinatesWithColor(J.CompilationUnit cu, Class<? extends J> cursorFilter)	This will print out the compilation unit and embed the tree coordinates (at each Space position).

Methods inherited from class java.lang.Object

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

Field Details

ANSI_RESET

public static final String ANSI_RESET

See Also:

• Constant Field Values

ANSI_FOREGROUND_WHITE

public static final String ANSI_FOREGROUND_WHITE

See Also:

• Constant Field Values

ANSI_FOREGROUND_GREY

public static final String ANSI_FOREGROUND_GREY

See Also:

• Constant Field Values

ANSI_BACKGROUND_GREEN

public static final String ANSI_BACKGROUND_GREEN

See Also:

• Constant Field Values

Constructor Details

CoordinatesPrinter

public CoordinatesPrinter()

Method Details

printCoordinates

public static String printCoordinates(J.CompilationUnit cu,
 @Nullable
 @Nullable Class<? extends J> cursorFilter)

This will print out the compilation unit and embed the tree coordinates (at each Space position). If a filter is supplied, the printer will only print coordinates for the tree elements of that given type.

See printCoordinatesWithColor(J.CompilationUnit, Class) for a variant of this method that will output the string with ASCII color codes.

Parameters:

cu - The compilation unit to print

cursorFilter - An optional cursor filter.

Returns:

The printed tree.

printCoordinatesWithColor

public static String printCoordinatesWithColor(J.CompilationUnit cu,
 Class<? extends J> cursorFilter)

This will print out the compilation unit and embed the tree coordinates (at each Space position). If a filter is supplied, the printer will only print coordinates for the tree elements of that given type. This variant also uses ANSI Color codes to better highlight the differences between the coordinates and the actual source code.

Parameters:

cu - The compilation unit to print

cursorFilter - An optional cursor filter.

Returns:

The printed tree.