com.diffplug.gradle.spotless

Interface FormatterStep

All Known Implementing Classes:

FormatterStep.FileIndependent

public interface FormatterStep

An implementation of this class specifies a single step in a formatting process. The input is guaranteed to have unix-style newlines, and the output is required to not introduce any windows-style newlines as well.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FormatterStep.FileIndependent A FormatterStep which doesn't depend on the input file.

Method Summary

Modifier and Type	Method and Description
static FormatterStep	create(String name, Throwing.Function<String,String> formatter) Creates a FormatterStep from the given function.
static FormatterStep	createLazy(String name, Throwing.Supplier<Throwing.Function<String,String>> formatterSupplier) Creates a FormatterStep lazily from the given formatterSupplier function.
default FormatterStep	filterByFile(Predicate<File> filter) Returns a new FormatterStep which will only apply its changes to files which pass the given filter.
String	format(String raw, File file) Returns a formatted version of the given content.
String	getName() The name of the step, for debugging purposes.

Method Detail

getName

String getName()

The name of the step, for debugging purposes.

format

String format(String raw,
              File file)
       throws Throwable

Returns a formatted version of the given content.

Parameters:

raw - File's content, guaranteed to have unix-style newlines ('\n')

file - the File which is being formatted

Returns:

The formatted content, guaranteed to only have unix-style newlines

Throws:

Throwable

filterByFile

default FormatterStep filterByFile(Predicate<File> filter)

Returns a new FormatterStep which will only apply its changes to files which pass the given filter.

create

static FormatterStep create(String name,
                            Throwing.Function<String,String> formatter)

Creates a FormatterStep from the given function.

createLazy

static FormatterStep createLazy(String name,
                                Throwing.Supplier<Throwing.Function<String,String>> formatterSupplier)

Creates a FormatterStep lazily from the given formatterSupplier function.