Package com.diffplug.spotless.extra.integration

Class DiffMessageFormatter

java.lang.Object

com.diffplug.spotless.extra.integration.DiffMessageFormatter

public final class DiffMessageFormatter
extends Object

Formats the messages of failed spotlessCheck invocations with a nice diff message.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DiffMessageFormatter.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_FILES_TO_LIST

Method Summary

Modifier and Type	Method	Description
static DiffMessageFormatter.Builder	builder()
static Map.Entry<Integer,String>	diff(Path rootDir, Formatter formatter, File file)	Returns a map entry with value being a git-style diff between the contents of the given file and what those contents would look like if formatted using the given formatter.

Methods inherited from class java.lang.Object

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

Field Details

MAX_FILES_TO_LIST

public static final int MAX_FILES_TO_LIST

See Also:

• Constant Field Values

Method Details

builder

public static DiffMessageFormatter.Builder builder()

diff

public static Map.Entry<Integer,String> diff(Path rootDir,
 Formatter formatter,
 File file)
                                      throws IOException

Returns a map entry with value being a git-style diff between the contents of the given file and what those contents would look like if formatted using the given formatter. Does not end with any newline sequence (\n, \r, \r\n). The key of the map entry is the 0-based line where the first difference occurred.

Throws:

IOException