Package com.diffplug.spotless

Class FormatterStep.Strict<State extends Serializable>

java.lang.Object

com.diffplug.spotless.LazyForwardingEquality<State>

com.diffplug.spotless.FormatterStep.Strict<State>

All Implemented Interfaces:

FormatterStep, NoLambda, Serializable

Enclosing interface:

FormatterStep

public abstract static class FormatterStep.Strict<State extends Serializable>
extends LazyForwardingEquality<State>
implements FormatterStep

Implements a FormatterStep in a strict way which guarantees correct and lazy implementation of up-to-date checks. This maximizes performance for cases where the FormatterStep is not actually needed (e.g. don't load eclipse setting file unless this step is actually running) while also ensuring that gradle can detect changes in a step's settings to determine that it needs to rerun a format.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.diffplug.spotless.FormatterStep

FormatterStep.Strict<State extends Serializable>

Nested classes/interfaces inherited from interface com.diffplug.spotless.NoLambda

NoLambda.EqualityBasedOnSerialization

Constructor Summary

Constructors

Constructor	Description
Strict()

Method Summary

Modifier and Type	Method	Description
String	format(String rawUnix, File file)	Returns a formatted version of the given content.
protected abstract String	format(State state, String rawUnix, File file)	Implements the formatting function strictly in terms of the input data and the result of LazyForwardingEquality.calculateState().

Methods inherited from class com.diffplug.spotless.LazyForwardingEquality

calculateState, equals, hashCode, state, toBytes

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.diffplug.spotless.FormatterStep

filterByContentPattern, filterByFile, getName

Constructor Detail

Strict

public Strict()

Method Detail

format

protected abstract String format(State state,
                                 String rawUnix,
                                 File file)
                          throws Exception

Implements the formatting function strictly in terms of the input data and the result of LazyForwardingEquality.calculateState().

Throws:

Exception

format

public final String format(String rawUnix,
                           File file)
                    throws Exception

Description copied from interface: FormatterStep

Returns a formatted version of the given content.

Specified by:

format in interface FormatterStep

Parameters:

rawUnix - the content to format, guaranteed to have unix-style newlines ('\n'); never null

file - the file which rawUnix was obtained from; never null. Pass an empty file using new File("") if and only if no file is actually associated with rawUnix

Returns:

the formatted content, guaranteed to only have unix-style newlines; may return null if the formatter step doesn't have any changes to make

Throws:

Exception - if the formatter step experiences a problem