Package com.diffplug.spotless

Class DirtyState

java.lang.Object

com.diffplug.spotless.DirtyState

public class DirtyState
extends Object

The clean/dirty state of a single file. Intended use: - isClean() means that the file is is clean, and there's nothing else to say - didNotConverge() means that we were unable to determine a clean state - once you've tested the above conditions and you know that it's a dirty file with a converged state, then you can call writeCanonicalTo(OutputStream) to get the canonical form of the given file.

Method Summary

Modifier and Type	Method	Description
static DirtyState	clean()	Returns the DirtyState which corresponds to isClean().
boolean	didNotConverge()
boolean	isClean()
static DirtyState	of(Formatter formatter, File file)
static DirtyState	of(Formatter formatter, File file, byte[] rawBytes)
static DirtyState	of(Formatter formatter, File file, byte[] rawBytes, String raw)
void	writeCanonicalTo(File file)
void	writeCanonicalTo(OutputStream out)

Methods inherited from class java.lang.Object

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

Method Details

isClean

public boolean isClean()

didNotConverge

public boolean didNotConverge()

writeCanonicalTo

public void writeCanonicalTo(File file)
                      throws IOException

Throws:

IOException

writeCanonicalTo

public void writeCanonicalTo(OutputStream out)
                      throws IOException

Throws:

IOException

clean

public static DirtyState clean()

Returns the DirtyState which corresponds to isClean().

of

public static DirtyState of(Formatter formatter,
 File file)
                     throws IOException

Throws:

IOException

of

public static DirtyState of(Formatter formatter,
 File file,
 byte[] rawBytes)

of

public static DirtyState of(Formatter formatter,
 File file,
 byte[] rawBytes,
 String raw)