A B C D E F G H I J K L P R S T U

A

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

Adds a new step.

addStep(FormatterStep) - Method in class com.diffplug.gradle.spotless.SpotlessTask

aosp() - Method in class com.diffplug.gradle.spotless.JavaExtension.GoogleJavaFormatConfig

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

B

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

An optional performance optimization if you are using any of the custom or customLazy methods.

C

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

Clears all of the existing steps.

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

configFile(Object...) - Method in class com.diffplug.gradle.spotless.GroovyExtension.GrEclipseConfig

configFile(Object...) - Method in class com.diffplug.gradle.spotless.JavaExtension.EclipseConfig

configFile(Object) - Method in class com.diffplug.gradle.spotless.ScalaExtension.ScalaFmtConfig

configFile(Object...) - Method in class com.diffplug.gradle.spotless.SqlExtension.DBeaverSQLFormatterConfig

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

Adds a custom step.

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

Adds a custom step.

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

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

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

Same as FormatExtension.customLazy(String, ThrowingEx.Supplier), but for Groovy closures.

D

dbeaver() - Method in class com.diffplug.gradle.spotless.SqlExtension

E

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

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

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

Deprecated.

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

Deprecated.

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

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

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

Sets encoding to use (defaults to UTF_8).

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

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

Ensures that files end with a single newline.

exceptionPolicy - Variable in class com.diffplug.gradle.spotless.SpotlessTask

excludeJava() - Method in class com.diffplug.gradle.spotless.GroovyExtension

Excludes .java files, to focus on only .groovy files.

excludeJava(boolean) - Method in class com.diffplug.gradle.spotless.GroovyExtension

Determines whether to exclude .java files, to focus on only .groovy files.

F

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(SpotlessExtension) - Constructor for class com.diffplug.gradle.spotless.FormatExtension

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

Configures the special freshmark-specific extension.

FreshMarkExtension - Class in com.diffplug.gradle.spotless

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

fromProject(Project) - Static method in class com.diffplug.gradle.spotless.GradleProvisioner

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.

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

getExceptionPolicy() - Method in class com.diffplug.gradle.spotless.SpotlessTask

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

Returns the existing step with the given name, if any.

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

The extension for this plugin.

getInternalTarget() - Method in class com.diffplug.gradle.spotless.SpotlessTask

Deprecated.

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

getLineEndingsPolicy() - Method in class com.diffplug.gradle.spotless.SpotlessTask

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

Returns the project that this extension is attached to.

getSteps() - Method in class com.diffplug.gradle.spotless.SpotlessTask

getTarget() - Method in class com.diffplug.gradle.spotless.SpotlessTask

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

Uses the google-java-format jar to format source code.

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

Uses the given version of google-java-format to format source code.

GradleProvisioner - Class in com.diffplug.gradle.spotless

Gradle integration for Provisioner.

greclipse() - Method in class com.diffplug.gradle.spotless.GroovyExtension

greclipse(String) - Method in class com.diffplug.gradle.spotless.GroovyExtension

greclipse() - Method in class com.diffplug.gradle.spotless.GroovyGradleExtension

greclipse(String) - Method in class com.diffplug.gradle.spotless.GroovyGradleExtension

groovy(Action<GroovyExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

Configures the special groovy-specific extension.

GroovyExtension - Class in com.diffplug.gradle.spotless

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

GroovyExtension.GrEclipseConfig - Class in com.diffplug.gradle.spotless

groovyGradle(Action<GroovyGradleExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

Configures the special groovy-specific extension for Gradle files.

GroovyGradleExtension - Class in com.diffplug.gradle.spotless

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

H

HasBuiltinDelimiterForLicense - Interface in com.diffplug.gradle.spotless

Every FormatExtension has a method license(licenseContent, licenseDelimiter), where licenseDelimiter is a regex that separates the license part of the code from the content.

I

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

Ignores errors for the given relative path.

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

Ignores errors in the given step.

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

Deprecated.

importOrder(String...) - Method in class com.diffplug.gradle.spotless.GroovyExtension

importOrder(String...) - Method in class com.diffplug.gradle.spotless.GroovyGradleExtension

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

Deprecated.

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

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

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

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

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.

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

Returns true if Gradle’s check task should run spotlessCheck; false otherwise.

isPaddedCell() - Method in class com.diffplug.gradle.spotless.SpotlessTask

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

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

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

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

K

kotlin(Action<KotlinExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

Configures the special kotlin-specific extension.

KotlinExtension - Class in com.diffplug.gradle.spotless

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

KotlinExtension.KotlinFormatExtension - Class in com.diffplug.gradle.spotless

kotlinGradle(Action<KotlinGradleExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

Configures the special Gradle Kotlin DSL specific extension.

KotlinGradleExtension - Class in com.diffplug.gradle.spotless

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

KotlinGradleExtension.KotlinFormatExtension - Class in com.diffplug.gradle.spotless

ktlint(String) - Method in class com.diffplug.gradle.spotless.KotlinExtension

Adds the specified version of ktlint.

ktlint() - Method in class com.diffplug.gradle.spotless.KotlinExtension

ktlint(String) - Method in class com.diffplug.gradle.spotless.KotlinGradleExtension

Adds the specified version of ktlint.

ktlint() - Method in class com.diffplug.gradle.spotless.KotlinGradleExtension

L

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

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

licenseHeader(String) - Method in interface com.diffplug.gradle.spotless.HasBuiltinDelimiterForLicense

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

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

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

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

licenseHeaderFile(Object) - Method in interface com.diffplug.gradle.spotless.HasBuiltinDelimiterForLicense

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

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

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

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.SpotlessTask

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

performAction(IncrementalTaskInputs) - Method in class com.diffplug.gradle.spotless.SpotlessTask

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

propertiesFile(Object...) - Method in class com.diffplug.gradle.spotless.FreshMarkExtension

propertyActions - Variable in class com.diffplug.gradle.spotless.FreshMarkExtension

R

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

Makes it possible to remove a format which was created earlier.

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

Removes any unused imports.

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

Highly efficient find-replace char sequence.

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

Highly efficient find-replace regex.

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

Replaces the given step.

S

scala(Action<ScalaExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

Configures the special scala-specific extension.

ScalaExtension - Class in com.diffplug.gradle.spotless

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

ScalaExtension.ScalaFmtConfig - Class in com.diffplug.gradle.spotless

scalafmt() - Method in class com.diffplug.gradle.spotless.ScalaExtension

scalafmt(String) - Method in class com.diffplug.gradle.spotless.ScalaExtension

setApply() - Method in class com.diffplug.gradle.spotless.SpotlessTask

setCheck() - Method in class com.diffplug.gradle.spotless.SpotlessTask

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).

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

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

Configures Gradle’s check task to run spotlessCheck if true, but to not do so if false.

setExceptionPolicy(FormatExceptionPolicy) - Method in class com.diffplug.gradle.spotless.SpotlessTask

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

setLineEndingsPolicy(LineEnding.Policy) - Method in class com.diffplug.gradle.spotless.SpotlessTask

setPaddedCell(boolean) - Method in class com.diffplug.gradle.spotless.SpotlessTask

setSteps(List<FormatterStep>) - Method in class com.diffplug.gradle.spotless.SpotlessTask

setTarget(Iterable<File>) - Method in class com.diffplug.gradle.spotless.SpotlessTask

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

Sets up a format task according to the values in this extension.

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

setupTask(SpotlessTask) - Method in class com.diffplug.gradle.spotless.GroovyExtension

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

setupTask(SpotlessTask) - Method in class com.diffplug.gradle.spotless.GroovyGradleExtension

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

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

setupTask(SpotlessTask) - Method in class com.diffplug.gradle.spotless.KotlinExtension

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

setupTask(SpotlessTask) - Method in class com.diffplug.gradle.spotless.KotlinGradleExtension

setupTask(SpotlessTask) - Method in class com.diffplug.gradle.spotless.ScalaExtension

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

setupTask(SpotlessTask) - Method in class com.diffplug.gradle.spotless.SqlExtension

If the user hasn’t specified the files yet, we’ll assume he/she means all of the sql 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

SpotlessTask - Class in com.diffplug.gradle.spotless

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

sql(Action<SqlExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

Configures the special sql-specific extension for SQL files.

SqlExtension - Class in com.diffplug.gradle.spotless

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

SqlExtension.DBeaverSQLFormatterConfig - Class in com.diffplug.gradle.spotless

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

The steps that need to be added.

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

style(String) - Method in class com.diffplug.gradle.spotless.JavaExtension.GoogleJavaFormatConfig

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.SpotlessTask

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

Removes trailing whitespace.

U

userData(Map<String, String>) - Method in class com.diffplug.gradle.spotless.KotlinExtension.KotlinFormatExtension

userData(Map<String, String>) - Method in class com.diffplug.gradle.spotless.KotlinGradleExtension.KotlinFormatExtension

A B C D E F G H I J K L P R S T U