A C E F G I J L N P R S T V

A

apply(Project) - Method in class com.diffplug.gradle.spotless.SpotlessPlugin

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

Applies formatting to the given file.

C

check - Variable in class com.diffplug.gradle.spotless.FormatTask

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

com.diffplug.gradle.spotless.freshmark - package com.diffplug.gradle.spotless.freshmark

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

create(String, Throwing.Function<String, String>) - Static method in interface com.diffplug.gradle.spotless.FormatterStep

Creates a FormatterStep from the given function.

createLazy(String, Throwing.Supplier<Throwing.Function<String, String>>) - Static method in interface com.diffplug.gradle.spotless.FormatterStep

Creates a FormatterStep lazily from the given formatterSupplier function.

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

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

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

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

custom(String, Closure<String>) - Method in class com.diffplug.gradle.spotless.FormatExtension

Adds a custom step.

custom(String, Throwing.Function<String, String>) - Method in class com.diffplug.gradle.spotless.FormatExtension

Adds a custom step.

customLazy(String, Throwing.Supplier<Throwing.Function<String, String>>) - Method in class com.diffplug.gradle.spotless.FormatExtension

Adds the given custom step, which is constructed lazily for performance reasons.

customLazyGroovy(String, Throwing.Supplier<Closure<String>>) - Method in class com.diffplug.gradle.spotless.FormatExtension

Same as FormatExtension.customLazy(String, com.diffplug.common.base.Throwing.Supplier), but for Groovy closures.

customReplace(String, CharSequence, CharSequence) - Method in class com.diffplug.gradle.spotless.FormatExtension

Highly efficient find-replace char sequence.

customReplaceRegex(String, String, String) - Method in class com.diffplug.gradle.spotless.FormatExtension

Highly efficient find-replace regex.

E

eclipseFormatFile(Object) - Method in class com.diffplug.gradle.spotless.java.JavaExtension

EclipseFormatterStep - Class in com.diffplug.gradle.spotless.java

Formatter step which calls out to the Eclipse formatter.

encoding(String) - Method in class com.diffplug.gradle.spotless.FormatExtension

Sets encoding to use (defaults to UTF_8).

encoding - Variable in class com.diffplug.gradle.spotless.FormatTask

encoding(String) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

Sets encoding to use (defaults to UTF_8).

endWithNewline() - Method in class com.diffplug.gradle.spotless.FormatExtension

Ensures that files end with a single newline.

F

filterByFile(Predicate<File>) - Method in interface com.diffplug.gradle.spotless.FormatterStep

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

format() - Method in class com.diffplug.gradle.spotless.FormatTask

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

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

Returns a formatted version of the given content.

format(String) - Method in class com.diffplug.gradle.spotless.IndentStep

format(String) - Method in class com.diffplug.gradle.spotless.java.EclipseFormatterStep

format(String) - Method in class com.diffplug.gradle.spotless.java.ImportSorterStep

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

Formats the given string.

format(String, Action<FormatExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

Configures a custom extension.

FormatExtension - Class in com.diffplug.gradle.spotless

Adds a `spotless{Name}Check` and `spotless{Name}Apply` task.

FormatExtension(String, SpotlessExtension) - Constructor for class com.diffplug.gradle.spotless.FormatExtension

FormatTask - Class in com.diffplug.gradle.spotless

FormatTask() - Constructor for class com.diffplug.gradle.spotless.FormatTask

Formatter - Class in com.diffplug.gradle.spotless

Formatter which performs the full formatting.

Formatter(LineEnding.Policy, Path, List<FormatterStep>) - Constructor for class com.diffplug.gradle.spotless.Formatter

Deprecated.

Formatter(LineEnding.Policy, Charset, Path, List<FormatterStep>) - Constructor for class com.diffplug.gradle.spotless.Formatter

FormatterStep - Interface in com.diffplug.gradle.spotless

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

FormatterStep.FileIndependent - Class in com.diffplug.gradle.spotless

A FormatterStep which doesn't depend on the input file.

freshmark(Action<FreshMarkExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

Configures the special freshmark-specific extension.

FreshMarkExtension - Class in com.diffplug.gradle.spotless.freshmark

FreshMarkExtension(SpotlessExtension) - Constructor for class com.diffplug.gradle.spotless.freshmark.FreshMarkExtension

G

getEncoding() - Method in class com.diffplug.gradle.spotless.FormatExtension

Returns the encoding to use (defaults to SpotlessExtension.getEncoding().

getEncoding() - Method in class com.diffplug.gradle.spotless.SpotlessExtension

Returns the encoding to use.

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

Returns the line ending appropriate for the given file.

getExtension() - Method in class com.diffplug.gradle.spotless.SpotlessPlugin

The extension for this plugin.

getFormatName() - Method in class com.diffplug.gradle.spotless.FormatTask

Returns the name of this format.

getLineEndings() - Method in class com.diffplug.gradle.spotless.FormatExtension

Returns the line endings to use (defaults to SpotlessExtension.getLineEndings().

getLineEndings() - Method in class com.diffplug.gradle.spotless.SpotlessExtension

getName() - Method in class com.diffplug.gradle.spotless.FormatterStep.FileIndependent

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

The name of the step, for debugging purposes.

getProject() - Method in class com.diffplug.gradle.spotless.FormatExtension

Returns the project that this extension is attached to.

googleJavaFormat() - Method in class com.diffplug.gradle.spotless.java.JavaExtension

Uses the [google-java-format](https://github.com/google/google-java-format) jar to format source code.

googleJavaFormat(String) - Method in class com.diffplug.gradle.spotless.java.JavaExtension

Uses the given version of [google-java-format](https://github.com/google/google-java-format) to format source code.

I

importOrder(List<String>) - Method in class com.diffplug.gradle.spotless.java.JavaExtension

importOrderFile(Object) - Method in class com.diffplug.gradle.spotless.java.JavaExtension

ImportSorterStep - Class in com.diffplug.gradle.spotless.java

From https://github.com/krasa/EclipseCodeFormatter

ImportSorterStep(List<String>) - Constructor for class com.diffplug.gradle.spotless.java.ImportSorterStep

ImportSorterStep(File) - Constructor for class com.diffplug.gradle.spotless.java.ImportSorterStep

IndentStep - Class in com.diffplug.gradle.spotless

Simple step which checks for consistent indentation characters.

IndentStep(IndentStep.Type, int) - Constructor for class com.diffplug.gradle.spotless.IndentStep

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

indentWithSpaces(int) - Method in class com.diffplug.gradle.spotless.FormatExtension

Ensures that the files are indented using spaces.

indentWithSpaces() - Method in class com.diffplug.gradle.spotless.FormatExtension

Ensures that the files are indented using spaces.

indentWithTabs(int) - Method in class com.diffplug.gradle.spotless.FormatExtension

Ensures that the files are indented using tabs.

indentWithTabs() - Method in class com.diffplug.gradle.spotless.FormatExtension

Ensures that the files are indented using tabs.

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

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

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

Returns true iff this file has unix line endings.

J

java(Action<JavaExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

Configures the special java-specific extension.

JavaExtension - Class in com.diffplug.gradle.spotless.java

JavaExtension(SpotlessExtension) - Constructor for class com.diffplug.gradle.spotless.java.JavaExtension

L

LICENSE_HEADER_DELIMITER - Static variable in class com.diffplug.gradle.spotless.java.JavaExtension

licenseHeader(String, String) - Method in class com.diffplug.gradle.spotless.FormatExtension

licenseHeader(String) - Method in class com.diffplug.gradle.spotless.java.JavaExtension

licenseHeaderFile(Object, String) - Method in class com.diffplug.gradle.spotless.FormatExtension

licenseHeaderFile(Object) - Method in class com.diffplug.gradle.spotless.java.JavaExtension

LicenseHeaderStep - Class in com.diffplug.gradle.spotless

Prefixes a license header before the package statement.

LicenseHeaderStep(String, String) - Constructor for class com.diffplug.gradle.spotless.LicenseHeaderStep

The license that we'd like enforced.

LicenseHeaderStep(File, String) - Constructor for class com.diffplug.gradle.spotless.LicenseHeaderStep

Deprecated.

LicenseHeaderStep(File, Charset, String) - Constructor for class com.diffplug.gradle.spotless.LicenseHeaderStep

Reads the license file from the given file.

LineEnding - Enum in com.diffplug.gradle.spotless

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

LineEnding.Policy - Interface in com.diffplug.gradle.spotless

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

lineEndingsPolicy - Variable in class com.diffplug.gradle.spotless.FormatTask

load(File) - Static method in class com.diffplug.gradle.spotless.java.EclipseFormatterStep

Returns an EclipseFormatterStep from the given config file.

N

N - Static variable in class com.diffplug.gradle.spotless.java.ImportSorterStep

name - Variable in class com.diffplug.gradle.spotless.FormatExtension

NAME - Static variable in class com.diffplug.gradle.spotless.freshmark.FreshMarkExtension

NAME - Static variable in class com.diffplug.gradle.spotless.java.EclipseFormatterStep

NAME - Static variable in class com.diffplug.gradle.spotless.java.ImportSorterStep

NAME - Static variable in class com.diffplug.gradle.spotless.java.JavaExtension

NAME - Static variable in class com.diffplug.gradle.spotless.LicenseHeaderStep

P

paddedCell() - Method in class com.diffplug.gradle.spotless.FormatExtension

Enables paddedCell mode.

paddedCell(boolean) - Method in class com.diffplug.gradle.spotless.FormatExtension

Enables paddedCell mode.

paddedCell - Variable in class com.diffplug.gradle.spotless.FormatTask

parseTarget(Object) - Method in class com.diffplug.gradle.spotless.FormatExtension

properties - Variable in class com.diffplug.gradle.spotless.freshmark.FreshMarkExtension

properties(Map<String, ?>) - Method in class com.diffplug.gradle.spotless.freshmark.FreshMarkExtension

R

root - Variable in class com.diffplug.gradle.spotless.FormatExtension

S

setEncoding(String) - Method in class com.diffplug.gradle.spotless.FormatExtension

Sets the encoding to use (defaults to SpotlessExtension.getEncoding().

setEncoding(Charset) - Method in class com.diffplug.gradle.spotless.FormatExtension

Sets the encoding to use (defaults to SpotlessExtension.getEncoding().

setEncoding(String) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

Sets encoding to use (defaults to UTF_8).

setEncoding(Charset) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

Sets encoding to use (defaults to UTF_8).

setLineEndings(LineEnding) - Method in class com.diffplug.gradle.spotless.FormatExtension

Sets the line endings to use (defaults to SpotlessExtension.getLineEndings().

setLineEndings(LineEnding) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

setupTask(FormatTask) - Method in class com.diffplug.gradle.spotless.FormatExtension

Sets up a FormatTask according to the values in this extension.

setupTask(FormatTask) - Method in class com.diffplug.gradle.spotless.freshmark.FreshMarkExtension

setupTask(FormatTask) - Method in class com.diffplug.gradle.spotless.java.JavaExtension

If the user hasn't specified the files yet, we'll assume he/she means all of the java files.

SpotlessExtension - Class in com.diffplug.gradle.spotless

SpotlessExtension(Project) - Constructor for class com.diffplug.gradle.spotless.SpotlessExtension

SpotlessPlugin - Class in com.diffplug.gradle.spotless

SpotlessPlugin() - Constructor for class com.diffplug.gradle.spotless.SpotlessPlugin

START_INDEX_OF_IMPORTS_PACKAGE_DECLARATION - Static variable in class com.diffplug.gradle.spotless.java.ImportSorterStep

steps - Variable in class com.diffplug.gradle.spotless.FormatExtension

The steps that need to be added.

steps - Variable in class com.diffplug.gradle.spotless.FormatTask

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

Returns the standard line ending for this policy.

T

target - Variable in class com.diffplug.gradle.spotless.FormatExtension

The files that need to be formatted.

target(Object...) - Method in class com.diffplug.gradle.spotless.FormatExtension

FileCollections pass through raw.

target - Variable in class com.diffplug.gradle.spotless.FormatTask

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

Returns a string with exclusively unix line endings.

trimTrailingWhitespace() - Method in class com.diffplug.gradle.spotless.FormatExtension

Removes trailing whitespace.

V

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

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

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

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

values() - Static method in enum com.diffplug.gradle.spotless.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.gradle.spotless.LineEnding

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

A C E F G I J L N P R S T V