A B C D E F G H I J K L M N O P R S T U V W X

A

anyMisbehave(Formatter, List<File>) - Static method in class com.diffplug.spotless.PaddedCellBulk

Returns true if the formatter is misbehaving for any of the given files.

anyMisbehave(Formatter, List<File>, long) - Static method in class com.diffplug.spotless.PaddedCellBulk

Same as PaddedCellBulk.anyMisbehave(Formatter, List) but with a customizable timeout.

apply(String, File) - Method in interface com.diffplug.spotless.FormatterFunc

apply(Formatter, File) - Static method in class com.diffplug.spotless.PaddedCellBulk

Performs the typical spotlessApply, but with PaddedCell handling of misbehaving FormatterSteps.

apply(T1, T2) - Method in interface com.diffplug.spotless.ThrowingEx.BiFunction

apply(T) - Method in interface com.diffplug.spotless.ThrowingEx.Function

applyAnyChanged(Formatter, File) - Static method in class com.diffplug.spotless.PaddedCellBulk

Performs the typical spotlessApply, but with PaddedCell handling of misbehaving FormatterSteps.

applyTo(File) - Method in class com.diffplug.spotless.Formatter

Applies formatting to the given file.

applyToAndReturnResultIfDirty(File) - Method in class com.diffplug.spotless.Formatter

Applies formatting to the given file.

asRuntime(Exception) - Static method in class com.diffplug.spotless.ThrowingEx

Casts or wraps the given exception to be a RuntimeException.

B

build() - Method in class com.diffplug.spotless.Formatter.Builder

builder() - Static method in class com.diffplug.spotless.Formatter

C

calculateState() - Method in class com.diffplug.spotless.LazyForwardingEquality

This function is guaranteed to be called at most once.

canonical() - Method in class com.diffplug.spotless.PaddedCell

Returns the “canonical” form for this particular result (only possible if isResolvable).

check(Formatter, File) - Static method in class com.diffplug.spotless.PaddedCell

Applies the given formatter to the given file, checking that F(F(input)) == F(input).

check(Formatter, File, String) - Static method in class com.diffplug.spotless.PaddedCell

check(File, File, Formatter, List<File>) - Static method in class com.diffplug.spotless.PaddedCellBulk

Performs a full check using PaddedCell logic on the given files with the given formatter.

clear() - Static method in class com.diffplug.spotless.SpotlessCache

Deprecated.

because it is dangerous, replacement is SpotlessCache.clearOnce(Object).

clearOnce(Object) - Static method in class com.diffplug.spotless.SpotlessCache

Closes all cached classloaders iff key is not .equals() to the last call to clearOnce().

close() - Method in class com.diffplug.spotless.Formatter

close() - Method in interface com.diffplug.spotless.FormatterFunc.Closeable

com.diffplug.spotless - package com.diffplug.spotless

com.diffplug.spotless.annotations - package com.diffplug.spotless.annotations

com.diffplug.spotless.cpp - package com.diffplug.spotless.cpp

com.diffplug.spotless.css - package com.diffplug.spotless.css

com.diffplug.spotless.generic - package com.diffplug.spotless.generic

com.diffplug.spotless.java - package com.diffplug.spotless.java

com.diffplug.spotless.kotlin - package com.diffplug.spotless.kotlin

com.diffplug.spotless.markdown - package com.diffplug.spotless.markdown

com.diffplug.spotless.npm - package com.diffplug.spotless.npm

com.diffplug.spotless.scala - package com.diffplug.spotless.scala

com.diffplug.spotless.sql - package com.diffplug.spotless.sql

com.diffplug.spotless.sql.dbeaver - package com.diffplug.spotless.sql.dbeaver

com.diffplug.spotless.xml - package com.diffplug.spotless.xml

compute(String, File) - Method in class com.diffplug.spotless.Formatter

Returns the result of calling all of the FormatterSteps.

computeLineEndings(String, File) - Method in class com.diffplug.spotless.Formatter

Applies the appropriate line endings to the given unix content.

CppDefaults - Class in com.diffplug.spotless.cpp

Common utilities for C/C++

create(String, State, ThrowingEx.Function<State, FormatterFunc>) - Static method in interface com.diffplug.spotless.FormatterStep

create() - Static method in class com.diffplug.spotless.generic.EndWithNewlineStep

Creates a FormatterStep which forces lines to end with a newline.

create(IndentStep.Type, int) - Static method in class com.diffplug.spotless.generic.IndentStep

Creates a step which will indent with the given type of whitespace, converting between tabs and spaces at the given ratio.

create() - Method in enum com.diffplug.spotless.generic.IndentStep.Type

Creates a step which will indent with the given type of whitespace, converting between tabs and spaces at the default ratio.

create(int) - Method in enum com.diffplug.spotless.generic.IndentStep.Type

Synonym for IndentStep.create(Type, int).

create(String, String, String) - Static method in class com.diffplug.spotless.generic.ReplaceRegexStep

create(String, CharSequence, CharSequence) - Static method in class com.diffplug.spotless.generic.ReplaceStep

create() - Static method in class com.diffplug.spotless.generic.TrimTrailingWhitespaceStep

create(Provisioner) - Static method in class com.diffplug.spotless.java.GoogleJavaFormatStep

Creates a step which formats everything - code, import order, and unused imports.

create(String, Provisioner) - Static method in class com.diffplug.spotless.java.GoogleJavaFormatStep

Creates a step which formats everything - code, import order, and unused imports.

create(String, String, Provisioner) - Static method in class com.diffplug.spotless.java.GoogleJavaFormatStep

Creates a step which formats everything - code, import order, and unused imports.

create(Provisioner) - Static method in class com.diffplug.spotless.java.RemoveUnusedImportsStep

create(Provisioner) - Static method in class com.diffplug.spotless.kotlin.KtLintStep

create(String, Provisioner) - Static method in class com.diffplug.spotless.kotlin.KtLintStep

create(String, Provisioner, Map<String, String>) - Static method in class com.diffplug.spotless.kotlin.KtLintStep

create(ThrowingEx.Supplier<Map<String, ?>>, Provisioner) - Static method in class com.diffplug.spotless.markdown.FreshMarkStep

Creates a formatter step for the given version and settings file.

create(String, ThrowingEx.Supplier<Map<String, ?>>, Provisioner) - Static method in class com.diffplug.spotless.markdown.FreshMarkStep

Creates a formatter step for the given version and settings file.

create(Provisioner, File, File, PrettierConfig) - Static method in class com.diffplug.spotless.npm.PrettierFormatterStep

Deprecated.

create(Map<String, String>, Provisioner, File, File, PrettierConfig) - Static method in class com.diffplug.spotless.npm.PrettierFormatterStep

create(Provisioner, File, File, File, TypedTsFmtConfigFile, Map<String, Object>) - Static method in class com.diffplug.spotless.npm.TsFmtFormatterStep

Deprecated.

create(Map<String, String>, Provisioner, File, File, TypedTsFmtConfigFile, Map<String, Object>) - Static method in class com.diffplug.spotless.npm.TsFmtFormatterStep

create(Provisioner) - Static method in class com.diffplug.spotless.scala.ScalaFmtStep

create(String, Provisioner, File) - Static method in class com.diffplug.spotless.scala.ScalaFmtStep

create(Iterable<File>) - Static method in class com.diffplug.spotless.sql.DBeaverSQLFormatterStep

createFormatterFunc() - Method in class com.diffplug.spotless.npm.PrettierFormatterStep.State

createFormatterFunc() - Method in class com.diffplug.spotless.npm.TsFmtFormatterStep.State

createForScript(String, Provisioner) - Static method in class com.diffplug.spotless.kotlin.KtLintStep

createForScript(String, Provisioner, Map<String, String>) - Static method in class com.diffplug.spotless.kotlin.KtLintStep

createFrom(String...) - Method in class com.diffplug.spotless.java.ImportOrderStep

createFrom(File) - Method in class com.diffplug.spotless.java.ImportOrderStep

createFromFile(File, Charset, String) - Static method in class com.diffplug.spotless.generic.LicenseHeaderStep

Creates a FormatterStep which forces the start of each file to match the license header contained in the given file.

createFromFile(File, Charset, String, String) - Static method in class com.diffplug.spotless.generic.LicenseHeaderStep

Creates a FormatterStep which forces the start of each file to match the license header contained in the given file.

createFromFile(File) - Static method in class com.diffplug.spotless.java.ImportOrderStep

Deprecated.

createFromHeader(String, String) - Static method in class com.diffplug.spotless.generic.LicenseHeaderStep

Creates a FormatterStep which forces the start of each file to match a license header.

createFromHeader(String, String, String) - Static method in class com.diffplug.spotless.generic.LicenseHeaderStep

createFromOrder(List<String>) - Static method in class com.diffplug.spotless.java.ImportOrderStep

Deprecated.

createFromOrder(String...) - Static method in class com.diffplug.spotless.java.ImportOrderStep

Deprecated.

createLazy(String, ThrowingEx.Supplier<State>, ThrowingEx.Function<State, FormatterFunc>) - Static method in interface com.diffplug.spotless.FormatterStep

createNeverUpToDate(String, FormatterFunc) - Static method in interface com.diffplug.spotless.FormatterStep

createNeverUpToDateLazy(String, ThrowingEx.Supplier<FormatterFunc>) - Static method in interface com.diffplug.spotless.FormatterStep

createPolicy(File, Supplier<Iterable<File>>) - Method in enum com.diffplug.spotless.LineEnding

Returns a LineEnding.Policy appropriate for files which are contained within the given rootFolder.

createPolicy() - Method in enum com.diffplug.spotless.LineEnding

Should use LineEnding.createPolicy(File, Supplier) instead, but this will work iff its a path-independent LineEnding policy.

CssDefaults - Class in com.diffplug.spotless.css

Deprecated.

D

DBeaverSQLFormatter - Class in com.diffplug.spotless.sql

DBeaverSQLFormatterConfiguration - Class in com.diffplug.spotless.sql.dbeaver

Warning: Use this class at your own risk.

DBeaverSQLFormatterConfiguration(Properties) - Constructor for class com.diffplug.spotless.sql.dbeaver.DBeaverSQLFormatterConfiguration

DBeaverSQLFormatterStep - Class in com.diffplug.spotless.sql

SQL formatter step which wraps up DBeaver’s SqlTokenizedFormatter implementation.

defaultDevDependencies() - Static method in class com.diffplug.spotless.npm.PrettierFormatterStep

defaultDevDependencies() - Static method in class com.diffplug.spotless.npm.TsFmtFormatterStep

defaultDevDependenciesWithPrettier(String) - Static method in class com.diffplug.spotless.npm.PrettierFormatterStep

defaultDevDependenciesWithTsFmt(String) - Static method in class com.diffplug.spotless.npm.TsFmtFormatterStep

defaultNumSpacesPerTab() - Static method in class com.diffplug.spotless.generic.IndentStep

defaultStyle() - Static method in class com.diffplug.spotless.java.GoogleJavaFormatStep

defaultVersion() - Static method in class com.diffplug.spotless.java.GoogleJavaFormatStep

defaultVersion() - Static method in class com.diffplug.spotless.kotlin.KtLintStep

defaultVersion() - Static method in class com.diffplug.spotless.markdown.FreshMarkStep

defaultVersion() - Static method in class com.diffplug.spotless.scala.ScalaFmtStep

defaultYearDelimiter() - Static method in class com.diffplug.spotless.generic.LicenseHeaderStep

DELIMITER_EXPR - Static variable in class com.diffplug.spotless.cpp.CppDefaults

Default delimiter expression shall cover most valid and common starts of C/C++ declarations and definitions.

DELIMITER_EXPR - Static variable in class com.diffplug.spotless.css.CssDefaults

Deprecated.

Match line that starts with a selector.

DELIMITER_EXPR - Static variable in class com.diffplug.spotless.xml.XmlDefaults

Deprecated.

Delimiter covers beginning of elements and processing instructions.

E

encoding(Charset) - Method in class com.diffplug.spotless.Formatter.Builder

EndWithNewlineStep - Class in com.diffplug.spotless.generic

EqualityBasedOnSerialization() - Constructor for class com.diffplug.spotless.NoLambda.EqualityBasedOnSerialization

equals(Object) - Method in class com.diffplug.spotless.Formatter

equals(Object) - Method in class com.diffplug.spotless.LazyForwardingEquality

equals(Object) - Method in class com.diffplug.spotless.NoLambda.EqualityBasedOnSerialization

exceptionPolicy(FormatExceptionPolicy) - Method in class com.diffplug.spotless.Formatter.Builder

excludePath(String) - Method in class com.diffplug.spotless.FormatExceptionPolicyStrict

Adds a relative path to exclude.

excludeStep(String) - Method in class com.diffplug.spotless.FormatExceptionPolicyStrict

Adds a step name to exclude.

F

failOnlyOnError() - Static method in interface com.diffplug.spotless.FormatExceptionPolicy

A policy which rethrows subclasses of Error and logs other kinds of Exception.

file() - Method in class com.diffplug.spotless.PaddedCell

Returns the file which was tested.

FILE_FILTER - Static variable in class com.diffplug.spotless.cpp.CppDefaults

Filter based on Eclipse-CDT org.eclipse.core.contenttype.contentTypes extension cSource, cHeader, cxxSource and cxxHeader.

FILE_FILTER - Static variable in class com.diffplug.spotless.css.CssDefaults

Deprecated.

Filter based on Eclipse-WTP org.eclipse.core.contenttype.contentTypes extension org.eclipse.wst.css.core.csssource.

FILE_FILTER - Static variable in class com.diffplug.spotless.xml.XmlDefaults

Deprecated.

Filter based on Eclipse-WTP org.eclipse.core.contenttype.contentTypes extension org.eclipse.wst.xml.core.xmlsource.

files() - Method in class com.diffplug.spotless.FileSignature

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

FileSignature - Class in com.diffplug.spotless

Computes a signature for any needed files.

filterByFile(SerializableFileFilter) - Method in interface com.diffplug.spotless.FormatterStep

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

forGroovy() - Static method in class com.diffplug.spotless.java.ImportOrderStep

forJava() - Static method in class com.diffplug.spotless.java.ImportOrderStep

format(String, File) - Method in interface com.diffplug.spotless.FormatterStep

Returns a formatted version of the given content.

format(State, String, File) - Method in class com.diffplug.spotless.FormatterStep.Strict

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

format(String, File) - Method in class com.diffplug.spotless.FormatterStep.Strict

format(String) - Method in class com.diffplug.spotless.generic.LicenseHeaderStep

Formats the given string.

format(String) - Method in class com.diffplug.spotless.sql.dbeaver.SQLTokenizedFormatter

format(String) - Method in class com.diffplug.spotless.sql.DBeaverSQLFormatter

FormatExceptionPolicy - Interface in com.diffplug.spotless

A policy for handling exceptions in the format.

FormatExceptionPolicyStrict - Class in com.diffplug.spotless

A policy for handling exceptions in the format.

FormatExceptionPolicyStrict() - Constructor for class com.diffplug.spotless.FormatExceptionPolicyStrict

Formatter - Class in com.diffplug.spotless

Formatter which performs the full formatting.

Formatter.Builder - Class in com.diffplug.spotless

FormatterFunc - Interface in com.diffplug.spotless

A Function<String, String> which can throw an exception.

FormatterFunc.Closeable - Interface in com.diffplug.spotless

Function<String, String> and BiFunction<String, File, String> whose implementation requires a resource which should be released when the function is no longer needed.

FormatterProperties - Class in com.diffplug.spotless

Utility manages settings of formatter configured by properties.

FormatterStep - Interface in com.diffplug.spotless

An implementation of this class specifies a single step in a formatting process.

FormatterStep.Strict<State extends Serializable> - Class in com.diffplug.spotless

Implements a FormatterStep in a strict way which guarantees correct and lazy implementation of up-to-date checks.

forNameIgnoreCase(String) - Static method in enum com.diffplug.spotless.npm.TsConfigFileType

FreshMarkStep - Class in com.diffplug.spotless.markdown

A step for FreshMark.

from(File...) - Static method in class com.diffplug.spotless.FileSignature

Deprecated.

from(Iterable<File>) - Static method in class com.diffplug.spotless.FileSignature

Deprecated.

from(File...) - Static method in class com.diffplug.spotless.FormatterProperties

Import settings from a sequence of files (file import is the given order)

from(Iterable<File>) - Static method in class com.diffplug.spotless.FormatterProperties

Import settings from a sequence of files (file import is the given order)

from(String, Provisioner) - Static method in class com.diffplug.spotless.JarState

Provisions the given maven coordinate and its transitive dependencies.

from(Collection<String>, Provisioner) - Static method in class com.diffplug.spotless.JarState

Provisions the given maven coordinates and their transitive dependencies.

G

get(ThrowingEx.Supplier<T>) - Static method in class com.diffplug.spotless.ThrowingEx

Gets the given value, rethrowing any exceptions as runtime exceptions.

get() - Method in interface com.diffplug.spotless.ThrowingEx.Supplier

getClassLoader() - Method in class com.diffplug.spotless.JarState

Returns a classloader containing the only jars in this JarState.

getClassLoader(Serializable) - Method in class com.diffplug.spotless.JarState

Returns a classloader containing the only jars in this JarState.

getEncoding() - Method in class com.diffplug.spotless.Formatter

getEndingFor(File) - Method in interface com.diffplug.spotless.LineEnding.Policy

Returns the line ending appropriate for the given file.

getExceptionPolicy() - Method in class com.diffplug.spotless.Formatter

getLineEndingsPolicy() - Method in class com.diffplug.spotless.Formatter

getMavenCoordinates() - Method in class com.diffplug.spotless.JarState

Returns unmodifiable view on sorted Maven coordinates

getName() - Method in interface com.diffplug.spotless.FormatterStep

The name of the step, for debugging purposes.

getObject(Integer) - Method in class com.diffplug.spotless.npm.V8ArrayWrapper

getOnlyFile() - Method in class com.diffplug.spotless.FileSignature

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

getOptions() - Method in class com.diffplug.spotless.npm.PrettierConfig

getPrettierConfigPath() - Method in class com.diffplug.spotless.npm.PrettierConfig

getProperties() - Method in class com.diffplug.spotless.FormatterProperties

Returns the accumulated Properties

getRootDir() - Method in class com.diffplug.spotless.Formatter

getSteps() - Method in class com.diffplug.spotless.Formatter

GoogleJavaFormatStep - Class in com.diffplug.spotless.java

Wraps up google-java-format as a FormatterStep.

H

handleError(Throwable, FormatterStep, String) - Method in interface com.diffplug.spotless.FormatExceptionPolicy

Called for every error in the formatter.

handleError(Throwable, FormatterStep, String) - Method in class com.diffplug.spotless.FormatExceptionPolicyStrict

hashCode() - Method in class com.diffplug.spotless.Formatter

hashCode() - Method in class com.diffplug.spotless.LazyForwardingEquality

hashCode() - Method in class com.diffplug.spotless.NoLambda.EqualityBasedOnSerialization

I

ImportOrderStep - Class in com.diffplug.spotless.java

IndentStep - Class in com.diffplug.spotless.generic

Simple step which checks for consistent indentation characters.

IndentStep.Type - Enum in com.diffplug.spotless.generic

Internal - Annotation Type in com.diffplug.spotless.annotations

Signifies that a public API is actually an implementation detail, and should be treated as if it were private.

isClean(File) - Method in class com.diffplug.spotless.Formatter

Returns true iff the given file’s formatting is up-to-date.

isResolvable() - Method in class com.diffplug.spotless.PaddedCell

Any result which doesn’t diverge can be resolved.

isUnix(File) - Method in interface com.diffplug.spotless.LineEnding.Policy

Returns true iff this file has unix line endings.

J

JarState - Class in com.diffplug.spotless

Grabs a jar and its dependencies from maven, and makes it easy to access the collection in a classloader.

JarState(String, FileSignature, Set<File>) - Constructor for class com.diffplug.spotless.JarState

Deprecated.

JarState(Collection<String>, FileSignature, Set<File>) - Constructor for class com.diffplug.spotless.JarState

Deprecated.

K

KotlinConstants - Class in com.diffplug.spotless.kotlin

KtLintStep - Class in com.diffplug.spotless.kotlin

Wraps up ktlint as a FormatterStep.

L

LazyForwardingEquality<T extends Serializable> - Class in com.diffplug.spotless

Implements equality, hashcode, and serialization entirely in terms of lazily-computed state.

LazyForwardingEquality() - Constructor for class com.diffplug.spotless.LazyForwardingEquality

LICENSE_HEADER_DELIMITER - Static variable in class com.diffplug.spotless.kotlin.KotlinConstants

LicenseHeaderStep - Class in com.diffplug.spotless.generic

Prefixes a license header before the package statement.

LineEnding - Enum in com.diffplug.spotless

Represents the line endings which should be written by the tool.

LineEnding.Policy - Interface in com.diffplug.spotless

A policy for line endings which can vary based on the specific file being requested.

lineEndingsPolicy(LineEnding.Policy) - Method in class com.diffplug.spotless.Formatter.Builder

M

misbehaved() - Method in class com.diffplug.spotless.PaddedCell

Returns true iff the formatter misbehaved in any way (did not converge after a single iteration).

N

name() - Static method in class com.diffplug.spotless.generic.LicenseHeaderStep

NAME - Static variable in class com.diffplug.spotless.npm.PrettierFormatterStep

NAME - Static variable in class com.diffplug.spotless.npm.TsFmtFormatterStep

NoLambda - Interface in com.diffplug.spotless

Marker interface to prevent lambda implementations of single-method interfaces that require serializability.

NoLambda.EqualityBasedOnSerialization - Class in com.diffplug.spotless

An implementation of NoLambda in which equality is based on the serialized representation of itself.

O

of(AutoCloseable, FormatterFunc) - Static method in interface com.diffplug.spotless.FormatterFunc.Closeable

Creates a FormatterFunc.Closeable from an AutoCloseable and a function.

of(Map<String, ?>) - Static method in class com.diffplug.spotless.npm.SimpleJsonWriter

P

PaddedCell - Class in com.diffplug.spotless

Models the result of applying a Formatter on a given File while characterizing various failure modes (slow convergence, cycles, and divergence).

PaddedCell.Type - Enum in com.diffplug.spotless

The kind of result.

PaddedCellBulk - Class in com.diffplug.spotless

Incorporates the PaddedCell machinery into broader apply / check usage.

PaddedCellBulk() - Constructor for class com.diffplug.spotless.PaddedCellBulk

PrettierConfig - Class in com.diffplug.spotless.npm

PrettierConfig(File, Map<String, Object>) - Constructor for class com.diffplug.spotless.npm.PrettierConfig

PrettierFormatterStep - Class in com.diffplug.spotless.npm

PrettierFormatterStep() - Constructor for class com.diffplug.spotless.npm.PrettierFormatterStep

PrettierFormatterStep.State - Class in com.diffplug.spotless.npm

Provisioner - Interface in com.diffplug.spotless

Many spotless steps require third-party libraries, but we want to keep Spotless’ dependencies minimal.

provisionWithDependencies(Collection<String>) - Method in interface com.diffplug.spotless.Provisioner

Deprecated.

provisionWithDependencies(String...) - Method in interface com.diffplug.spotless.Provisioner

Deprecated.

provisionWithTransitives(boolean, String...) - Method in interface com.diffplug.spotless.Provisioner

Given a set of Maven coordinates, returns a set of jars which include all of the specified coordinates and optionally their transitive dependencies.

provisionWithTransitives(boolean, Collection<String>) - Method in interface com.diffplug.spotless.Provisioner

Given a set of Maven coordinates, returns a set of jars which include all of the specified coordinates and optionally their transitive dependencies.

push(Object) - Method in class com.diffplug.spotless.npm.V8ArrayWrapper

pushNull() - Method in class com.diffplug.spotless.npm.V8ArrayWrapper

R

RemoveUnusedImportsStep - Class in com.diffplug.spotless.java

Uses google-java-format, but only to remove unused imports.

ReplaceRegexStep - Class in com.diffplug.spotless.generic

ReplaceStep - Class in com.diffplug.spotless.generic

ReturnValuesAreNonnullByDefault - Annotation Type in com.diffplug.spotless.annotations

rootDir(Path) - Method in class com.diffplug.spotless.Formatter.Builder

run(ThrowingEx.Runnable) - Static method in class com.diffplug.spotless.ThrowingEx

Runs the given runnable, rethrowing any exceptions as runtime exceptions.

run() - Method in interface com.diffplug.spotless.ThrowingEx.Runnable

S

ScalaFmtStep - Class in com.diffplug.spotless.scala

Wraps up scalafmt as a FormatterStep.

SerializableFileFilter - Interface in com.diffplug.spotless

A file filter with full support for serialization.

signAsList(File...) - Static method in class com.diffplug.spotless.FileSignature

Creates file signature whereas order of the files remains unchanged.

signAsList(Iterable<File>) - Static method in class com.diffplug.spotless.FileSignature

Creates file signature whereas order of the files remains unchanged.

signAsSet(File...) - Static method in class com.diffplug.spotless.FileSignature

Creates file signature whereas order of the files remains unchanged.

signAsSet(Iterable<File>) - Static method in class com.diffplug.spotless.FileSignature

Creates file signature insensitive to the order of the files.

SimpleJsonWriter - Class in com.diffplug.spotless.npm

SimpleJsonWriter() - Constructor for class com.diffplug.spotless.npm.SimpleJsonWriter

skipFilesNamed(String...) - Static method in interface com.diffplug.spotless.SerializableFileFilter

Creates a FileFilter which will accept all files except files with the given name(s).

SpotlessCache - Class in com.diffplug.spotless

Spotless’ global cache.

SpotlessCache() - Constructor for class com.diffplug.spotless.SpotlessCache

SQLTokenizedFormatter - Class in com.diffplug.spotless.sql.dbeaver

Warning: Use this class at your own risk.

SQLTokenizedFormatter(DBeaverSQLFormatterConfiguration) - Constructor for class com.diffplug.spotless.sql.dbeaver.SQLTokenizedFormatter

state() - Method in class com.diffplug.spotless.LazyForwardingEquality

Returns the underlying state, possibly triggering a call to {LazyForwardingEquality.calculateState().

State(String, Provisioner, File, File, TypedTsFmtConfigFile, Map<String, Object>) - Constructor for class com.diffplug.spotless.npm.TsFmtFormatterStep.State

Deprecated.

State(String, Map<String, String>, Provisioner, File, File, TypedTsFmtConfigFile, Map<String, Object>) - Constructor for class com.diffplug.spotless.npm.TsFmtFormatterStep.State

steps(List<FormatterStep>) - Method in class com.diffplug.spotless.Formatter.Builder

steps() - Method in class com.diffplug.spotless.PaddedCell

Returns the steps it takes to get to the result.

str() - Method in enum com.diffplug.spotless.LineEnding

Returns the standard line ending for this policy.

Strict() - Constructor for class com.diffplug.spotless.FormatterStep.Strict

T

ThrowingEx - Class in com.diffplug.spotless

Basic functional interfaces which throw exception, along with static helper methods for calling them.

ThrowingEx.BiFunction<T1,T2,R> - Interface in com.diffplug.spotless

A bi-function that can throw any exception.

ThrowingEx.Function<T,R> - Interface in com.diffplug.spotless

A function that can throw any exception.

ThrowingEx.Runnable - Interface in com.diffplug.spotless

A runnable that can throw any exception.

ThrowingEx.Supplier<T> - Interface in com.diffplug.spotless

A supplier that can throw any exception.

ThrowingEx.WrappedAsRuntimeException - Exception in com.diffplug.spotless

A RuntimeException specifically for the purpose of wrapping non-runtime Exceptions as RuntimeExceptions.

toBytes() - Method in interface com.diffplug.spotless.FormatExceptionPolicy

Returns a byte array representation of everything inside this FormatExceptionPolicy.

toBytes() - Method in class com.diffplug.spotless.LazyForwardingEquality

toBytes() - Method in class com.diffplug.spotless.NoLambda.EqualityBasedOnSerialization

toBytes() - Method in interface com.diffplug.spotless.NoLambda

Returns a byte array representation of everything inside this SerializableFileFilter.

toString() - Method in class com.diffplug.spotless.npm.SimpleJsonWriter

toUnix(String) - Static method in enum com.diffplug.spotless.LineEnding

Returns a string with exclusively unix line endings.

TrimTrailingWhitespaceStep - Class in com.diffplug.spotless.generic

TsConfigFileType - Enum in com.diffplug.spotless.npm

TsFmtFormatterStep - Class in com.diffplug.spotless.npm

TsFmtFormatterStep() - Constructor for class com.diffplug.spotless.npm.TsFmtFormatterStep

TsFmtFormatterStep.State - Class in com.diffplug.spotless.npm

type() - Method in class com.diffplug.spotless.PaddedCell

Returns the type of the result (either PaddedCell.Type.CONVERGE, PaddedCell.Type.CYCLE, or PaddedCell.Type.DIVERGE).

TypedTsFmtConfigFile - Class in com.diffplug.spotless.npm

TypedTsFmtConfigFile(TsConfigFileType, File) - Constructor for class com.diffplug.spotless.npm.TypedTsFmtConfigFile

U

unsupportedJvmFilesFilter() - Static method in class com.diffplug.spotless.generic.LicenseHeaderStep

unwrapCause(Throwable) - Static method in class com.diffplug.spotless.ThrowingEx

Utility method for rethrowing an exception’s cause with as few wrappers as possible.

userMessage() - Method in class com.diffplug.spotless.PaddedCell

Returns a string which describes this result.

V

V8ArrayWrapper - Class in com.diffplug.spotless.npm

V8ArrayWrapper(Reflective, Object) - Constructor for class com.diffplug.spotless.npm.V8ArrayWrapper

valueOf(String) - Static method in enum com.diffplug.spotless.generic.IndentStep.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.diffplug.spotless.LineEnding

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.diffplug.spotless.npm.TsConfigFileType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.diffplug.spotless.PaddedCell.Type

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.diffplug.spotless.generic.IndentStep.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.diffplug.spotless.LineEnding

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.diffplug.spotless.npm.TsConfigFileType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.diffplug.spotless.PaddedCell.Type

Returns an array containing the constants of this enum type, in the order they are declared.

W

withoutTransitives(Collection<String>, Provisioner) - Static method in class com.diffplug.spotless.JarState

Provisions the given maven coordinates without their transitive dependencies.

wrap(ThrowingEx.Function<T, R>) - Static method in class com.diffplug.spotless.ThrowingEx

Wraps the given ThrowingEx.Function as a standard Function, rethrowing any exceptions as runtime exceptions.

WRAPPED_CLASS - Static variable in class com.diffplug.spotless.npm.V8ArrayWrapper

WrappedAsRuntimeException(Throwable) - Constructor for exception com.diffplug.spotless.ThrowingEx.WrappedAsRuntimeException

X

XmlDefaults - Class in com.diffplug.spotless.xml

Deprecated.

A B C D E F G H I J K L M N O P R S T U V W X