com.diffplug.spotless

Class FileSignature

java.lang.Object

com.diffplug.spotless.FileSignature

All Implemented Interfaces:

Serializable

public final class FileSignature
extends Object
implements Serializable

Computes a signature for any needed files.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
Collection<File>	files() Returns all of the files in this signature, throwing an exception if there are more or less than 1 file.
static FileSignature	from(File... files) Deprecated.
static FileSignature	from(Iterable<File> files) Deprecated.
File	getOnlyFile() Returns the only file in this signature, throwing an exception if there are more or less than 1 file.
static FileSignature	signAsList(File... files) Creates file signature whereas order of the files remains unchanged.
static FileSignature	signAsList(Iterable<File> files) Creates file signature whereas order of the files remains unchanged.
static FileSignature	signAsSet(File... files) Creates file signature whereas order of the files remains unchanged.
static FileSignature	signAsSet(Iterable<File> files) Creates file signature insensitive to the order of the files.

Methods inherited from class java.lang.Object

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

Method Detail

from

@Deprecated
public static FileSignature from(File... files)
                                      throws IOException

Deprecated.

Method has been renamed to signAsSet(java.io.File...). In case no sorting and removal of duplicates is required, use signAsList(java.io.File...) instead.

Throws:

IOException

from

@Deprecated
public static FileSignature from(Iterable<File> files)
                                      throws IOException

Deprecated.

Method has been renamed to signAsSet(java.io.File...). In case no sorting and removal of duplicates is required, use signAsList(java.io.File...) instead.

Throws:

IOException

signAsList

public static FileSignature signAsList(File... files)
                                throws IOException

Creates file signature whereas order of the files remains unchanged.

Throws:

IOException

signAsList

public static FileSignature signAsList(Iterable<File> files)
                                throws IOException

Creates file signature whereas order of the files remains unchanged.

Throws:

IOException

signAsSet

public static FileSignature signAsSet(File... files)
                               throws IOException

Creates file signature whereas order of the files remains unchanged.

Throws:

IOException

signAsSet

public static FileSignature signAsSet(Iterable<File> files)
                               throws IOException

Creates file signature insensitive to the order of the files.

Throws:

IOException

files

public Collection<File> files()

Returns all of the files in this signature, throwing an exception if there are more or less than 1 file.

getOnlyFile

public File getOnlyFile()

Returns the only file in this signature, throwing an exception if there are more or less than 1 file.