Index

A B C D E F G H I J K L M N O P Q R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

add(int, V) - Method in class com.diffplug.spotless.Jvm.Support

Add maximum supported formatter version

addAll(Collection<? extends FormatterStep>) - Method in class com.diffplug.spotless.ConfigurationCacheHackList

addMin(int, V) - Method in class com.diffplug.spotless.Jvm.Support

addWarningMessageTo(StringBuilder, String, boolean) - Method in class com.diffplug.spotless.Lint

alwaysReturns(R) - Static method in interface com.diffplug.spotless.SerializedFunction

Antlr4Defaults - Class in com.diffplug.spotless.antlr4

Antlr4FormatterStep - Class in com.diffplug.spotless.antlr4

appendFeatureToToggle(Map<String, Boolean>) - Method in class com.diffplug.spotless.json.JacksonConfig

appendJsonFeatureToToggle(Map<String, Boolean>) - Method in class com.diffplug.spotless.json.JacksonJsonConfig

Refers to com.fasterxml.jackson.core.JsonGenerator.Feature

appendYamlFeatureToToggle(Map<String, Boolean>) - Method in class com.diffplug.spotless.yaml.JacksonYamlConfig

Refers to com.fasterxml.jackson.dataformat.yaml.YAMLGenerator.Feature

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

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

apply(String) - Method in class com.diffplug.spotless.rdf.RdfFormatterFunc

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

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

apply(String, File) - Method in class com.diffplug.spotless.rdf.RdfFormatterFunc

apply(T) - Method in class com.diffplug.spotless.SerializedFunction.AlwaysReturns

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

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

apply(T, String) - Method in interface com.diffplug.spotless.FormatterFunc.Closeable.ResourceFunc

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

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

applyWithin(List<FormatterStep>) - Method in class com.diffplug.spotless.generic.FenceStep

Returns a step which will apply the given steps only within the blocks selected by the regex / openClose pair.

args() - Method in class com.diffplug.spotless.ProcessRunner.Result

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

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

Casts or wraps the given exception to be a RuntimeException.

assertExitZero(Charset) - Method in class com.diffplug.spotless.ProcessRunner.Result

Asserts that the exit code was zero, and if so, returns the content of stdout encoded with the given charset.

assertFormatterSupported(V) - Method in class com.diffplug.spotless.Jvm.Support

Assert the formatter is supported

asStringDetailed(File, Formatter) - Method in class com.diffplug.spotless.LintState

asStringOneLine(File, Formatter) - Method in class com.diffplug.spotless.LintState

atLine(int, String, String) - Static method in class com.diffplug.spotless.Lint

atLineRange(int, int, String, String) - Static method in class com.diffplug.spotless.Lint

atUndefinedLine(String, String) - Static method in class com.diffplug.spotless.Lint

B

BiomeSettings - Class in com.diffplug.spotless.biome

Settings and constants for Biome to use.

BiomeStep - Class in com.diffplug.spotless.biome

formatter step that formats JavaScript and TypeScript code with Biome: https://github.com/biomejs/biome.

BlackStep - Class in com.diffplug.spotless.python

BufStep - Class in com.diffplug.spotless.protobuf

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

build() - Method in class com.diffplug.spotless.generic.IdeaStep.IdeaStepBuilder

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

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

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

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

Builder() - Constructor for class com.diffplug.spotless.rdf.RdfFormatterConfig.Builder

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(Formatter, File, String, ValuePerStep<Throwable>) - Static method in class com.diffplug.spotless.PaddedCell

ClangFormatStep - Class in com.diffplug.spotless.cpp

clean() - Static method in class com.diffplug.spotless.DirtyState

Returns the DirtyState which corresponds to isClean().

clean() - Static method in class com.diffplug.spotless.LintState

Returns the DirtyState which corresponds to isClean().

CleanthatJavaStep - Class in com.diffplug.spotless.java

Enables CleanThat as a SpotLess step.

clear() - Method in class com.diffplug.spotless.ConfigurationCacheHackList

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

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

close() - Method in class com.diffplug.spotless.ProcessRunner.LongRunningProcess

close() - Method in class com.diffplug.spotless.yaml.SerializeToByteArrayHack

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

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

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

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

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

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

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

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

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

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

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

com.diffplug.spotless.json.gson - package com.diffplug.spotless.json.gson

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.pom - package com.diffplug.spotless.pom

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

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

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

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

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

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

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

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

COMPLETE - Enum constant in enum class com.diffplug.spotless.kotlin.KtfmtStep.TrailingCommaManagementStrategy

Fully manage trailing commas, adding and removing them where necessary.

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.

configName() - Static method in class com.diffplug.spotless.biome.BiomeSettings

ConfigurationCacheHackList - Class in com.diffplug.spotless

Gradle requires three things: - Gradle defines cache equality based on your serialized representation - Combined with remote build cache, you cannot have any absolute paths in your serialized representation - Combined with configuration cache, you must be able to roundtrip yourself through serialization These requirements are at odds with each other, as described in these issues - Gradle issue to define custom equality https://github.com/gradle/gradle/issues/29816 - Spotless plea for developer cache instead of configuration cache https://github.com/diffplug/spotless/issues/987 - Spotless cache miss bug fixed by this class https://github.com/diffplug/spotless/issues/2168 This class is a `List` which can optimize the serialized representation for either - roundtrip integrity - OR - equality Because it is not possible to provide both at the same time.

confirmVersionAndGetAbsolutePath() - Method in class com.diffplug.spotless.ForeignExe

Searches for the executable and confirms that it has the expected version.

CONVERGE - Enum constant in enum class com.diffplug.spotless.PaddedCell.Type

CppDefaults - Class in com.diffplug.spotless.cpp

Common utilities for C/C++

create() - Method in class com.diffplug.spotless.biome.BiomeStep

Creates a formatter step with the current configuration, which formats code by passing it to the Biome executable.

create() - Method in class com.diffplug.spotless.cpp.ClangFormatStep

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

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

create() - Method in enum class 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() - Static method in class com.diffplug.spotless.generic.TrimTrailingWhitespaceStep

create() - Method in class com.diffplug.spotless.go.GofmtFormatStep

create() - Static method in class com.diffplug.spotless.groovy.RemoveSemicolonsStep

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

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

create() - Method in class com.diffplug.spotless.protobuf.BufStep

create() - Method in class com.diffplug.spotless.python.BlackStep

create() - Method in class com.diffplug.spotless.shell.ShfmtStep

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

Synonym for IndentStep.create(Type, int).

create(int, Provisioner) - Static method in class com.diffplug.spotless.json.JsonSimpleStep

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(GherkinUtilsConfig, String, Provisioner) - Static method in class com.diffplug.spotless.gherkin.GherkinUtilsStep

create(GsonConfig, Provisioner) - Static method in class com.diffplug.spotless.json.gson.GsonStep

create(JacksonJsonConfig, String, Provisioner) - Static method in class com.diffplug.spotless.json.JacksonJsonStep

create(SortPomCfg, Provisioner) - Static method in class com.diffplug.spotless.pom.SortPomStep

create(Provisioner) - Static method in class com.diffplug.spotless.antlr4.Antlr4FormatterStep

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

Creates a step that applies default CleanThat mutators.

create(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.PalantirJavaFormatStep

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.json.JacksonJsonStep

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

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

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

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

create(Provisioner) - Static method in class com.diffplug.spotless.markdown.FlexmarkStep

Creates a formatter step for the default version.

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

create(Provisioner) - Static method in class com.diffplug.spotless.yaml.JacksonYamlStep

create(RdfFormatterConfig, Map<String, String>, Provisioner) - Static method in class com.diffplug.spotless.rdf.RdfFormatterStep

create(JacksonYamlConfig, String, Provisioner) - Static method in class com.diffplug.spotless.yaml.JacksonYamlStep

create(File) - Static method in class com.diffplug.spotless.npm.NodeModulesCachingNpmProcessFactory

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

create(String, Provisioner) - Static method in class com.diffplug.spotless.antlr4.Antlr4FormatterStep

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

Creates a step that applies default CleanThat mutators.

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, Provisioner) - Static method in class com.diffplug.spotless.java.PalantirJavaFormatStep

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

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

create(String, Provisioner) - Static method in class com.diffplug.spotless.json.JsonPatchStep

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

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

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

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

create(String, Provisioner) - Static method in class com.diffplug.spotless.markdown.FlexmarkStep

Creates a formatter step for the given version.

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

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

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

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

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

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

create(String, File, List<String>) - Static method in class com.diffplug.spotless.generic.NativeCmdStep

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

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

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

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(String, String, Provisioner) - Static method in class com.diffplug.spotless.java.PalantirJavaFormatStep

Creates a step which formats code, import order, and unused imports, but not Java docs.

create(String, String, Provisioner) - Static method in class com.diffplug.spotless.json.JsonPatchStep

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

Creates a step which formats everything - code, import order, and unused imports - and optionally reflows long strings.

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

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

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

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

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

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

Creates a step which formats everything - groupArtifact, code, import order, and unused imports - and optionally reflows long strings.

create(String, String, String, List<String>, List<String>, boolean, Provisioner) - Static method in class com.diffplug.spotless.java.CleanthatJavaStep

Creates a step that applies selected CleanThat mutators.

create(String, List<Map<String, Object>>, Provisioner) - Static method in class com.diffplug.spotless.json.JsonPatchStep

create(String, 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, RoundtripState, SerializedFunction<RoundtripState, EqualityState>, SerializedFunction<EqualityState, ? extends FormatterFunc>) - Static method in interface com.diffplug.spotless.FormatterStep

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

create(List<String>, List<String>) - Static method in class com.diffplug.spotless.java.FormatAnnotationsStep

create(List<Map<String, Object>>, Provisioner) - Static method in class com.diffplug.spotless.json.JsonPatchStep

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

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

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

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

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

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

createFrom(boolean, boolean, Set<String>, Set<String>, File) - Method in class com.diffplug.spotless.java.ImportOrderStep

createFrom(boolean, boolean, Set<String>, Set<String>, String...) - Method in class com.diffplug.spotless.java.ImportOrderStep

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

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

createLazy(String, ThrowingEx.Supplier<RoundtripState>, SerializedFunction<RoundtripState, EqualityState>, SerializedFunction<EqualityState, ? extends FormatterFunc>) - Static method in interface com.diffplug.spotless.FormatterStep

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

createNpmInstallProcess(NodeServerLayout, NpmFormatterStepLocations, NpmProcessFactory.OnlinePreferrence) - Method in class com.diffplug.spotless.npm.NodeModulesCachingNpmProcessFactory

createNpmInstallProcess(NodeServerLayout, NpmFormatterStepLocations, NpmProcessFactory.OnlinePreferrence) - Method in interface com.diffplug.spotless.npm.NpmProcessFactory

createNpmInstallProcess(NodeServerLayout, NpmFormatterStepLocations, NpmProcessFactory.OnlinePreferrence) - Method in class com.diffplug.spotless.npm.StandardNpmProcessFactory

createNpmServeProcess(NodeServerLayout, NpmFormatterStepLocations, UUID) - Method in class com.diffplug.spotless.npm.NodeModulesCachingNpmProcessFactory

createNpmServeProcess(NodeServerLayout, NpmFormatterStepLocations, UUID) - Method in interface com.diffplug.spotless.npm.NpmProcessFactory

createNpmServeProcess(NodeServerLayout, NpmFormatterStepLocations, UUID) - Method in class com.diffplug.spotless.npm.StandardNpmProcessFactory

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

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

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

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

CYCLE - Enum constant in enum class com.diffplug.spotless.PaddedCell.Type

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.

DEFAULT - Enum constant in enum class com.diffplug.spotless.kotlin.KtfmtStep.Style

DEFAULT_ESLINT_VERSION - Static variable in class com.diffplug.spotless.npm.EslintFormatterStep

DEFAULT_JAVA_HEADER_DELIMITER - Static variable in class com.diffplug.spotless.generic.LicenseHeaderStep

DEFAULT_VERSION - Static variable in class com.diffplug.spotless.json.gson.GsonStep

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

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

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

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

defaultDevDependenciesForTypescript() - Static method in class com.diffplug.spotless.npm.EslintFormatterStep

defaultDevDependenciesTypescriptWithEslint(String) - Static method in class com.diffplug.spotless.npm.EslintFormatterStep

defaultDevDependenciesWithEslint(String) - Static method in class com.diffplug.spotless.npm.EslintFormatterStep

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

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

defaultExcludedMutators() - Static method in class com.diffplug.spotless.java.CleanthatJavaStep

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

defaultFormatJavadoc() - Static method in class com.diffplug.spotless.java.PalantirJavaFormatStep

Get default for whether Java docs should be formatted

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

defaultGroupArtifact() - Static method in class com.diffplug.spotless.java.CleanthatJavaStep

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

defaultIncludeDraft() - Static method in class com.diffplug.spotless.java.CleanthatJavaStep

defaultIndentSpaces() - Static method in class com.diffplug.spotless.gherkin.GherkinUtilsConfig

defaultMutators() - Static method in class com.diffplug.spotless.java.CleanthatJavaStep

By default, we include only safe and consensual mutators

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

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

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

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

defaultSourceJdk() - Static method in class com.diffplug.spotless.java.CleanthatJavaStep

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

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

Get default style

defaultToggleName() - Static method in class com.diffplug.spotless.generic.FenceStep

defaultToggleOff() - Static method in class com.diffplug.spotless.generic.FenceStep

defaultToggleOn() - Static method in class com.diffplug.spotless.generic.FenceStep

defaultVersion() - Static method in class com.diffplug.spotless.antlr4.Antlr4FormatterStep

defaultVersion() - Static method in class com.diffplug.spotless.biome.BiomeSettings

defaultVersion() - Static method in class com.diffplug.spotless.cpp.ClangFormatStep

defaultVersion() - Static method in class com.diffplug.spotless.gherkin.GherkinUtilsStep

defaultVersion() - Static method in class com.diffplug.spotless.go.GofmtFormatStep

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

Get default formatter version

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

Get default formatter version

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

Get default formatter version

defaultVersion() - Static method in class com.diffplug.spotless.json.JacksonJsonStep

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

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

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

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

defaultVersion() - Static method in class com.diffplug.spotless.protobuf.BufStep

defaultVersion() - Static method in class com.diffplug.spotless.python.BlackStep

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

defaultVersion() - Static method in class com.diffplug.spotless.shell.ShfmtStep

defaultVersion() - Static method in class com.diffplug.spotless.yaml.JacksonYamlStep

defaultVersionDiktat() - Static method in class com.diffplug.spotless.kotlin.DiktatStep

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.

describe() - Method in interface com.diffplug.spotless.npm.NpmProcessFactory

destroy() - Method in class com.diffplug.spotless.ProcessRunner.LongRunningProcess

destroyForcibly() - Method in class com.diffplug.spotless.ProcessRunner.LongRunningProcess

didNotConverge() - Method in class com.diffplug.spotless.DirtyState

DiktatStep - Class in com.diffplug.spotless.kotlin

Wraps up diktat as a FormatterStep.

DirtyState - Class in com.diffplug.spotless

The clean/dirty state of a single file.

diverge() - Static method in class com.diffplug.spotless.TestingOnly

DIVERGE - Enum constant in enum class com.diffplug.spotless.PaddedCell.Type

DROPBOX - Enum constant in enum class com.diffplug.spotless.kotlin.KtfmtStep.Style

E

encoding - Variable in class com.diffplug.spotless.pom.SortPomCfg

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

endWithNewline - Variable in class com.diffplug.spotless.pom.SortPomCfg

EndWithNewlineStep - Class in com.diffplug.spotless.generic

ensureDoesNotSuppressAll() - Method in class com.diffplug.spotless.LintSuppression

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

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

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

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

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

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

equals(Object) - Method in class com.diffplug.spotless.rdf.RdfFormatterStep.State

error(String, Object...) - Method in interface com.diffplug.spotless.GitPrePushHookInstaller.GitPreHookLogger

EslintConfig - Class in com.diffplug.spotless.npm

EslintConfig(File, String) - Constructor for class com.diffplug.spotless.npm.EslintConfig

EslintFormatterStep - Class in com.diffplug.spotless.npm

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

EslintRestService - Class in com.diffplug.spotless.npm

EslintTypescriptConfig - Class in com.diffplug.spotless.npm

EslintTypescriptConfig(File, String, File) - Constructor for class com.diffplug.spotless.npm.EslintTypescriptConfig

EXCLUDE - Enum constant in enum class com.diffplug.spotless.OnMatch

exec(byte[], String...) - Method in class com.diffplug.spotless.ProcessRunner

Creates a process with the given arguments, the given byte array is written to stdin immediately.

exec(byte[], List<String>) - Method in class com.diffplug.spotless.ProcessRunner

Creates a process with the given arguments, the given byte array is written to stdin immediately.

exec(File, Map<String, String>, byte[], List<String>) - Method in class com.diffplug.spotless.ProcessRunner

Creates a process with the given arguments, the given byte array is written to stdin immediately.

exec(String...) - Method in class com.diffplug.spotless.ProcessRunner

Creates a process with the given arguments.

exec(List<String>) - Method in class com.diffplug.spotless.ProcessRunner

Creates a process with the given arguments.

exitCode() - Method in class com.diffplug.spotless.ProcessRunner.Result

exitNotZero() - Method in class com.diffplug.spotless.ProcessRunner.Result

Returns true if the exit code was not zero.

exitValue() - Method in class com.diffplug.spotless.ProcessRunner.LongRunningProcess

expandEmptyElements - Variable in class com.diffplug.spotless.pom.SortPomCfg

F

failOnWarning() - Method in class com.diffplug.spotless.rdf.RdfFormatterConfig.Builder

failOnWarning(boolean) - Method in class com.diffplug.spotless.rdf.RdfFormatterConfig.Builder

featureToToggle - Variable in class com.diffplug.spotless.json.JacksonConfig

FenceStep - Class in com.diffplug.spotless.generic

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

Returns the file which was tested.

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.

FileSignature.Promised - Class in com.diffplug.spotless

A view of `FileSignature` which can be safely roundtripped.

filterByContent(OnMatch, String) - Method in interface com.diffplug.spotless.FormatterStep

Returns a new FormatterStep which, observing the value of formatIfMatches, will only apply, or not, its changes to files which pass the given filter.

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.

fixCantFind(String) - Method in class com.diffplug.spotless.ForeignExe

Use {version} anywhere you would like to inject the actual version string.

fixWrongVersion(String) - Method in class com.diffplug.spotless.ForeignExe

Use {version} or {versionFound} anywhere you would like to inject the actual version strings.

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

FlexmarkStep - Class in com.diffplug.spotless.markdown

A step for flexmark-java.

ForbidWildcardImportsStep - Class in com.diffplug.spotless.java

Forbids any wildcard import statements.

ForeignExe - Class in com.diffplug.spotless

Finds a foreign executable and checks its version.

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

forEquality() - Static method in class com.diffplug.spotless.ConfigurationCacheHackList

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

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

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

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

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

Returns a formatted version of the given content.

format(String, File) - Method in class com.diffplug.spotless.yaml.SerializeToByteArrayHack

format(String, String) - Method in class com.diffplug.spotless.npm.PrettierRestService

format(String, Map<EslintRestService.FormatOption, Object>) - Method in class com.diffplug.spotless.npm.EslintRestService

format(String, Map<String, Object>) - Method in class com.diffplug.spotless.npm.TsFmtRestService

FormatAnnotationsStep - Class in com.diffplug.spotless.java

Some formatters put every annotation on its own line -- even type annotations, which should be on the same line as the type they qualify.

Formatter - Class in com.diffplug.spotless

Formatter which performs the full formatting.

Formatter.Builder - Class in com.diffplug.spotless

formatterFunc(RdfFormatterStep.State) - Static method in class com.diffplug.spotless.rdf.RdfFormatterStep

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.

FormatterFunc.Closeable.ResourceFunc<T> - Interface in com.diffplug.spotless

FormatterFunc.Closeable.ResourceFuncNeedsFile<T> - Interface in com.diffplug.spotless

FormatterFunc.NeedsFile - Interface in com.diffplug.spotless

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.

formatterStepLocations - Variable in class com.diffplug.spotless.npm.NodeApp

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

forRoundtrip() - Static method in class com.diffplug.spotless.ConfigurationCacheHackList

FreshMarkStep - Class in com.diffplug.spotless.markdown

A step for FreshMark.

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.

fromPropertiesContent(Iterable<String>) - Static method in class com.diffplug.spotless.FormatterProperties

fromXmlContent(Iterable<String>) - Static method in class com.diffplug.spotless.FormatterProperties

G

get() - Method in class com.diffplug.spotless.FileSignature.Promised

get() - Method in class com.diffplug.spotless.JarState.Promised

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

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

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

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

Returns either a forcedClassloader (JarState.setForcedClassLoader()) or a classloader containing the only jars in this JarState.

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

Returns either a forcedClassloader (JarState.setForcedClassLoader) or a classloader containing the only jars in this JarState.

getConfig() - Method in class com.diffplug.spotless.rdf.RdfFormatterStep.State

getDetail() - Method in class com.diffplug.spotless.Lint

getDirtyState() - Method in class com.diffplug.spotless.LintState

getDownloadFilePattern() - Static method in class com.diffplug.spotless.biome.BiomeSettings

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.

getErrorStream() - Method in class com.diffplug.spotless.ProcessRunner.LongRunningProcess

getEslintConfigJs() - Method in class com.diffplug.spotless.npm.EslintConfig

getEslintConfigPath() - Method in class com.diffplug.spotless.npm.EslintConfig

getFeatureToToggle() - Method in class com.diffplug.spotless.json.JacksonConfig

getIndentSpaces() - Method in class com.diffplug.spotless.gherkin.GherkinUtilsConfig

getIndentSpaces() - Method in class com.diffplug.spotless.json.gson.GsonConfig

getInputStream() - Method in class com.diffplug.spotless.ProcessRunner.LongRunningProcess

getJarState() - Method in class com.diffplug.spotless.rdf.RdfFormatterStep.State

getJsonFeatureToToggle() - Method in class com.diffplug.spotless.json.JacksonJsonConfig

getLineEnd() - Method in class com.diffplug.spotless.Lint

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

getLineStart() - Method in class com.diffplug.spotless.Lint

getLints() - Method in interface com.diffplug.spotless.Lint.Has

getLintsByStep(Formatter) - Method in class com.diffplug.spotless.LintState

getMinimumRequiredFormatterVersion() - Method in class com.diffplug.spotless.Jvm.Support

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

The name of the step, for debugging purposes.

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

getName() - Method in class com.diffplug.spotless.yaml.SerializeToByteArrayHack

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

getOutputStream() - Method in class com.diffplug.spotless.ProcessRunner.LongRunningProcess

getPath() - Method in class com.diffplug.spotless.LintSuppression

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

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

Returns the accumulated Properties

getRecommendedFormatterVersion() - Method in class com.diffplug.spotless.Jvm.Support

getResult() - Method in exception class com.diffplug.spotless.npm.NpmProcessException

getShortCode() - Method in class com.diffplug.spotless.Lint

getShortCode() - Method in class com.diffplug.spotless.LintSuppression

getStep() - Method in class com.diffplug.spotless.LintSuppression

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

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

getTurtleFormatterStyle() - Method in class com.diffplug.spotless.rdf.RdfFormatterStep.State

getTurtleFormatterVersion() - Method in class com.diffplug.spotless.rdf.RdfFormatterConfig

getTypescriptConfigPath() - Method in class com.diffplug.spotless.npm.EslintTypescriptConfig

getUrlPattern(String) - Static method in class com.diffplug.spotless.biome.BiomeSettings

getVersion() - Method in class com.diffplug.spotless.json.gson.GsonConfig

getYamlFeatureToToggle() - Method in class com.diffplug.spotless.yaml.JacksonYamlConfig

GherkinUtilsConfig - Class in com.diffplug.spotless.gherkin

GherkinUtilsConfig(int) - Constructor for class com.diffplug.spotless.gherkin.GherkinUtilsConfig

GherkinUtilsStep - Class in com.diffplug.spotless.gherkin

GIT_ATTRIBUTES - Enum constant in enum class com.diffplug.spotless.LineEnding

Uses the same line endings as Git, using .gitattributes and the core.eol property.

GIT_ATTRIBUTES_FAST_ALLSAME - Enum constant in enum class com.diffplug.spotless.LineEnding

Uses the same line endings as Git, and assumes that every single file being formatted will have the same line ending.

GitPrePushHookInstaller - Class in com.diffplug.spotless

Abstract class responsible for installing a Git pre-push hook in a repository.

GitPrePushHookInstaller(GitPrePushHookInstaller.GitPreHookLogger, File) - Constructor for class com.diffplug.spotless.GitPrePushHookInstaller

Constructor to initialize the GitPrePushHookInstaller with a logger and repository root path.

GitPrePushHookInstaller.Executor - Enum Class in com.diffplug.spotless

GitPrePushHookInstaller.GitPreHookLogger - Interface in com.diffplug.spotless

GitPrePushHookInstallerGradle - Class in com.diffplug.spotless

Implementation of GitPrePushHookInstaller specifically for Gradle-based projects.

GitPrePushHookInstallerGradle(GitPrePushHookInstaller.GitPreHookLogger, File) - Constructor for class com.diffplug.spotless.GitPrePushHookInstallerGradle

GitPrePushHookInstallerMaven - Class in com.diffplug.spotless

Implementation of GitPrePushHookInstaller specifically for Maven-based projects.

GitPrePushHookInstallerMaven(GitPrePushHookInstaller.GitPreHookLogger, File) - Constructor for class com.diffplug.spotless.GitPrePushHookInstallerMaven

global - Variable in enum class com.diffplug.spotless.GitPrePushHookInstaller.Executor

GofmtFormatStep - Class in com.diffplug.spotless.go

Note: gofmt doesn't have a version flag, because it's part of standard Go distribution.

GOOGLE - Enum constant in enum class com.diffplug.spotless.kotlin.KtfmtStep.Style

GoogleJavaFormatStep - Class in com.diffplug.spotless.java

Wraps up google-java-format as a FormatterStep.

GRADLE - Enum constant in enum class com.diffplug.spotless.GitPrePushHookInstaller.Executor

GsonConfig - Class in com.diffplug.spotless.json.gson

GsonConfig(boolean, boolean, int, String) - Constructor for class com.diffplug.spotless.json.gson.GsonConfig

GsonStep - Class in com.diffplug.spotless.json.gson

H

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

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

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

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

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

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

hashCode() - Method in class com.diffplug.spotless.rdf.RdfFormatterConfig

hashCode() - Method in class com.diffplug.spotless.rdf.RdfFormatterStep.State

headerDelimiter(ThrowingEx.Supplier<String>, String) - Static method in class com.diffplug.spotless.generic.LicenseHeaderStep

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

I

IDEA_CONFIG_PATH_PROPERTY - Static variable in class com.diffplug.spotless.generic.IdeaStep

IDEA_EXECUTABLE_DEFAULT - Static variable in class com.diffplug.spotless.generic.IdeaStep

IDEA_SYSTEM_PATH_PROPERTY - Static variable in class com.diffplug.spotless.generic.IdeaStep

IdeaStep - Class in com.diffplug.spotless.generic

IdeaStep.IdeaStepBuilder - Class in com.diffplug.spotless.generic

identity() - Static method in interface com.diffplug.spotless.SerializedFunction

ImportOrderStep - Class in com.diffplug.spotless.java

INCLUDE - Enum constant in enum class com.diffplug.spotless.OnMatch

includes() - Static method in class com.diffplug.spotless.antlr4.Antlr4Defaults

indentAttribute - Variable in class com.diffplug.spotless.pom.SortPomCfg

indentBlankLines - Variable in class com.diffplug.spotless.pom.SortPomCfg

indentSchemaLocation - Variable in class com.diffplug.spotless.pom.SortPomCfg

IndentStep - Class in com.diffplug.spotless.generic

Simple step which checks for consistent indentation characters.

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

info(String, Object...) - Method in interface com.diffplug.spotless.GitPrePushHookInstaller.GitPreHookLogger

install() - Method in class com.diffplug.spotless.GitPrePushHookInstaller

Installs the Git pre-push hook while ensuring thread safety and preventing parallel installations.

INSTANCE - Static variable in class com.diffplug.spotless.npm.StandardNpmProcessFactory

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

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

isAlive() - Method in class com.diffplug.spotless.ProcessRunner.LongRunningProcess

isClean() - Method in class com.diffplug.spotless.DirtyState

isClean() - Method in class com.diffplug.spotless.LintState

isEscapeHtml() - Method in class com.diffplug.spotless.json.gson.GsonConfig

isFailOnWarning() - Method in class com.diffplug.spotless.rdf.RdfFormatterConfig

isHasLints() - Method in class com.diffplug.spotless.LintState

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

Any result which doesn't diverge can be resolved.

isSortByKeys() - Method in class com.diffplug.spotless.json.gson.GsonConfig

isSpaceBeforeSeparator() - Method in class com.diffplug.spotless.json.JacksonJsonConfig

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

Returns true iff this file has unix line endings.

isVerify() - Method in class com.diffplug.spotless.rdf.RdfFormatterConfig

J

JacksonConfig - Class in com.diffplug.spotless.json

A DTO holding the basic for Jackson-based formatters

JacksonConfig() - Constructor for class com.diffplug.spotless.json.JacksonConfig

JacksonJsonConfig - Class in com.diffplug.spotless.json

Specialization of JacksonConfig for JSON documents

JacksonJsonConfig() - Constructor for class com.diffplug.spotless.json.JacksonJsonConfig

JacksonJsonStep - Class in com.diffplug.spotless.json

Simple YAML formatter which reformats the file according to Jackson YAMLFactory.

JacksonYamlConfig - Class in com.diffplug.spotless.yaml

Specialization of JacksonConfig for YAML documents

JacksonYamlConfig() - Constructor for class com.diffplug.spotless.yaml.JacksonYamlConfig

JacksonYamlStep - Class in com.diffplug.spotless.yaml

Simple YAML formatter which reformats the file according to Jackson YAMLFactory.

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.Promised - Class in com.diffplug.spotless

A lazily evaluated JarState, which becomes a set of files when serialized.

jsonFeatureToToggle - Variable in class com.diffplug.spotless.json.JacksonJsonConfig

JsonPatchStep - Class in com.diffplug.spotless.json

JsonSimpleStep - Class in com.diffplug.spotless.json

Simple JSON formatter which reformats the file according to the org.json library's default pretty-printing, but has no ability to customise more than the indentation size.

Jsr223Step - Class in com.diffplug.spotless.generic

Jvm - Class in com.diffplug.spotless

Java virtual machine helper

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

Jvm.Support<V> - Class in com.diffplug.spotless

Utility to map constraints of formatter to this JVM

K

keepBlankLines - Variable in class com.diffplug.spotless.pom.SortPomCfg

KotlinConstants - Class in com.diffplug.spotless.kotlin

KOTLINLANG - Enum constant in enum class com.diffplug.spotless.kotlin.KtfmtStep.Style

KtfmtFormattingOptions() - Constructor for class com.diffplug.spotless.kotlin.KtfmtStep.KtfmtFormattingOptions

KtfmtFormattingOptions(Integer, Integer, Integer, Boolean, KtfmtStep.TrailingCommaManagementStrategy) - Constructor for class com.diffplug.spotless.kotlin.KtfmtStep.KtfmtFormattingOptions

KtfmtStep - Class in com.diffplug.spotless.kotlin

Wraps up ktfmt as a FormatterStep.

KtfmtStep.KtfmtFormattingOptions - Class in com.diffplug.spotless.kotlin

KtfmtStep.Style - Enum Class in com.diffplug.spotless.kotlin

Used to allow multiple style option through formatting options and since when is each of them available.

KtfmtStep.TrailingCommaManagementStrategy - Enum Class in com.diffplug.spotless.kotlin

KtLintStep - Class in com.diffplug.spotless.kotlin

Wraps up ktlint as a FormatterStep.

L

LATEST_TURTLE_FORMATTER_VERSION - Static variable in class com.diffplug.spotless.rdf.RdfFormatterStep

lazy(Supplier<Object>) - Static method in class com.diffplug.spotless.LazyArgLogger

LazyArgLogger - Class in com.diffplug.spotless

This is a utility class to allow for lazy evaluation of arguments to be passed to a logger and thus avoid unnecessary computation of the arguments if the log level is not enabled.

LazyForwardingEquality<T> - 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

LICENSE_HEADER_DELIMITER - Static variable in class com.diffplug.spotless.protobuf.ProtobufConstants

licenseHeaderDelimiter() - Static method in class com.diffplug.spotless.antlr4.Antlr4Defaults

LicenseHeaderStep - Class in com.diffplug.spotless.generic

Prefixes a license header before the package statement.

LicenseHeaderStep.YearMode - Enum Class in com.diffplug.spotless.generic

LINE_UNDEFINED - Static variable in class com.diffplug.spotless.Lint

LineEnding - Enum Class 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

lineSeparator - Variable in class com.diffplug.spotless.pom.SortPomCfg

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

Calculates a list of lints against the given content.

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

Returns a list of lints against the given file content

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

lint(T, String) - Method in interface com.diffplug.spotless.FormatterFunc.Closeable.ResourceFunc

Calculates a list of lints against the given content.

lint(T, String, File) - Method in interface com.diffplug.spotless.FormatterFunc.Closeable.ResourceFuncNeedsFile

Lint - Class in com.diffplug.spotless

Models a linted line or line range.

Lint.Has - Interface in com.diffplug.spotless

Any exception which implements this interface will have its lints extracted and reported cleanly to the user.

LintState - Class in com.diffplug.spotless

LintSuppression - Class in com.diffplug.spotless

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

locations - Variable in class com.diffplug.spotless.npm.TsFmtFormatterStep.State

logger - Variable in class com.diffplug.spotless.GitPrePushHookInstaller

Logger for recording informational and error messages during the installation process.

LongRunningProcess(Process, List<String>, Future<byte[]>, Future<byte[]>) - Constructor for class com.diffplug.spotless.ProcessRunner.LongRunningProcess

lowercase() - Static method in class com.diffplug.spotless.TestingOnly

M

MAC_CLASSIC - Enum constant in enum class com.diffplug.spotless.LineEnding

\r

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

Returns true if this JVM is running on a windows machine.

MAVEN - Enum constant in enum class com.diffplug.spotless.GitPrePushHookInstaller.Executor

MAVEN_COORDINATE - Static variable in class com.diffplug.spotless.java.PalantirJavaFormatStep

merge(Properties...) - Static method in class com.diffplug.spotless.FormatterProperties

META - Enum constant in enum class com.diffplug.spotless.kotlin.KtfmtStep.Style

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() - Method in class com.diffplug.spotless.biome.BiomeStep

name() - Static method in class com.diffplug.spotless.cpp.ClangFormatStep

name() - Static method in class com.diffplug.spotless.go.GofmtFormatStep

name() - Static method in class com.diffplug.spotless.protobuf.BufStep

name() - Static method in class com.diffplug.spotless.python.BlackStep

name() - Static method in class com.diffplug.spotless.shell.ShfmtStep

NAME - Static variable in class com.diffplug.spotless.antlr4.Antlr4FormatterStep

NAME - Static variable in class com.diffplug.spotless.generic.IdeaStep

NAME - Static variable in class com.diffplug.spotless.gherkin.GherkinUtilsStep

NAME - Static variable in class com.diffplug.spotless.json.gson.GsonStep

NAME - Static variable in class com.diffplug.spotless.json.JacksonJsonStep

NAME - Static variable in class com.diffplug.spotless.json.JsonPatchStep

NAME - Static variable in class com.diffplug.spotless.json.JsonSimpleStep

NAME - Static variable in class com.diffplug.spotless.markdown.FlexmarkStep

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

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

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

NAME - Static variable in class com.diffplug.spotless.pom.SortPomStep

NAME - Static variable in class com.diffplug.spotless.yaml.JacksonYamlStep

nameAndVersion(String, String) - Static method in class com.diffplug.spotless.ForeignExe

The name of the executable, used by "where" (win) and "which" (unix).

named(String) - Static method in class com.diffplug.spotless.generic.FenceStep

Declares the name of the step.

NativeCmdStep - Class in com.diffplug.spotless.generic

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

Deprecated.

Using the system-native line endings to detect the windows operating system has turned out to be unreliable. Use FileSignature.machineIsWin() instead.

needsFile(FormatterFunc.NeedsFile) - Static method in interface com.diffplug.spotless.FormatterFunc

Ideally, formatters don't need the underlying file.

newBuilder(File) - Static method in class com.diffplug.spotless.generic.IdeaStep

NO_FILE_SENTINEL - Static variable in class com.diffplug.spotless.Formatter

This Sentinel reference may be used to pass string content to a Formatter or FormatterStep when there is no actual File to format

NodeApp - Class in com.diffplug.spotless.npm

NodeApp(NodeServerLayout, NpmConfig, NpmFormatterStepLocations) - Constructor for class com.diffplug.spotless.npm.NodeApp

NodeModulesCachingNpmProcessFactory - Class in com.diffplug.spotless.npm

NodeServeApp - Class in com.diffplug.spotless.npm

NodeServeApp(NodeServerLayout, NpmConfig, NpmFormatterStepLocations) - Constructor for class com.diffplug.spotless.npm.NodeServeApp

nodeServerLayout - Variable in class com.diffplug.spotless.npm.NodeApp

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.

NONE - Enum constant in enum class com.diffplug.spotless.kotlin.KtfmtStep.TrailingCommaManagementStrategy

Do not manage trailing commas at all, only format what is already present.

npmConfig - Variable in class com.diffplug.spotless.npm.NodeApp

NpmPathResolver - Class in com.diffplug.spotless.npm

NpmPathResolver(File, File, File, List<File>) - Constructor for class com.diffplug.spotless.npm.NpmPathResolver

NpmProcessException - Exception Class in com.diffplug.spotless.npm

NpmProcessException(String, ProcessRunner.Result) - Constructor for exception class com.diffplug.spotless.npm.NpmProcessException

NpmProcessException(String, Throwable) - Constructor for exception class com.diffplug.spotless.npm.NpmProcessException

npmProcessFactory - Variable in class com.diffplug.spotless.npm.NodeApp

NpmProcessFactory - Interface in com.diffplug.spotless.npm

NpmProcessFactory.OnlinePreferrence - Enum Class in com.diffplug.spotless.npm

nrOfIndentSpace - Variable in class com.diffplug.spotless.pom.SortPomCfg

O

of(Formatter, File) - Static method in class com.diffplug.spotless.DirtyState

of(Formatter, File) - Static method in class com.diffplug.spotless.LintState

of(Formatter, File, byte[]) - Static method in class com.diffplug.spotless.DirtyState

of(Formatter, File, byte[]) - Static method in class com.diffplug.spotless.LintState

of(Formatter, File, byte[], String) - Static method in class com.diffplug.spotless.DirtyState

of(T, FormatterFunc.Closeable.ResourceFunc<T>) - Static method in interface com.diffplug.spotless.FormatterFunc.Closeable

Creates a FormatterFunc.Closeable which uses the given resource to execute the format function.

of(T, FormatterFunc.Closeable.ResourceFuncNeedsFile<T>) - Static method in interface com.diffplug.spotless.FormatterFunc.Closeable

Creates a FormatterFunc.Closeable which uses the given resource to execute the file-dependent format function.

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

Dangerous way to create a FormatterFunc.Closeable from an AutoCloseable and a function.

ONLY_ADD - Enum constant in enum class com.diffplug.spotless.kotlin.KtfmtStep.TrailingCommaManagementStrategy

Only add trailing commas when necessary, but do not remove them.

OnMatch - Enum Class in com.diffplug.spotless

Enum to make boolean logic more readable.

openClose(String, String) - Method in class com.diffplug.spotless.generic.FenceStep

Defines the opening and closing markers.

option() - Method in enum class com.diffplug.spotless.npm.NpmProcessFactory.OnlinePreferrence

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 Class in com.diffplug.spotless

The kind of result.

PalantirJavaFormatStep - Class in com.diffplug.spotless.java

Wraps up palantir-java-format fork of google-java-format as a FormatterStep.

pathNativeToUnix(String) - Static method in class com.diffplug.spotless.FileSignature

Transforms a native path to a unix one.

pathToExe(String) - Method in class com.diffplug.spotless.ForeignExe

Path to the executable.

pathUnixToNative(String) - Static method in class com.diffplug.spotless.FileSignature

Transforms a unix path to a native one.

PLATFORM_NATIVE - Enum constant in enum class com.diffplug.spotless.LineEnding

\n on unix systems, \r\n on windows systems.

predefinedSortOrder - Variable in class com.diffplug.spotless.pom.SortPomCfg

PREFER_OFFLINE - Enum constant in enum class com.diffplug.spotless.npm.NpmProcessFactory.OnlinePreferrence

PREFER_ONLINE - Enum constant in enum class com.diffplug.spotless.npm.NpmProcessFactory.OnlinePreferrence

preHookContent() - Method in class com.diffplug.spotless.GitPrePushHookInstaller

Provides the content of the hook that should be inserted into the pre-push script.

preHookContent() - Method in class com.diffplug.spotless.GitPrePushHookInstallerGradle

Provides the content of the hook that should be inserted into the pre-push script.

preHookContent() - Method in class com.diffplug.spotless.GitPrePushHookInstallerMaven

Provides the content of the hook that should be inserted into the pre-push script.

preHookTemplate(GitPrePushHookInstaller.Executor, String, String) - Method in class com.diffplug.spotless.GitPrePushHookInstaller

Generates a pre-push template script that defines the commands to check and apply changes using an executor and Spotless.

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

PRESERVE - Enum constant in enum class com.diffplug.spotless.generic.LicenseHeaderStep.YearMode

PRESERVE - Enum constant in enum class com.diffplug.spotless.LineEnding

preserve the line ending of the first line (no matter which format)

preserveOrder(Collection<File>) - Static method in class com.diffplug.spotless.JarState

Wraps the given collection of a files as a JarState, maintaining the order in the Collection.

preserveWithin(List<FormatterStep>) - Method in class com.diffplug.spotless.generic.FenceStep

Returns a step which will apply the given steps but preserve the content selected by the regex / openClose pair.

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

PrettierRestService - Class in com.diffplug.spotless.npm

ProcessRunner - Class in com.diffplug.spotless

Shelling out to a process is harder than it ought to be in Java.

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

ProcessRunner.LongRunningProcess - Class in com.diffplug.spotless

A long-running process that can be waited for.

ProcessRunner.Result - Class in com.diffplug.spotless

promise(ThrowingEx.Supplier<JarState>) - Static method in class com.diffplug.spotless.JarState

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

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

Promised(ThrowingEx.Supplier<JarState>) - Constructor for class com.diffplug.spotless.JarState.Promised

ProtobufConstants - Class in com.diffplug.spotless.protobuf

ProtobufConstants() - Constructor for class com.diffplug.spotless.protobuf.ProtobufConstants

Provisioner - Interface in com.diffplug.spotless

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

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.

Q

quiet - Variable in class com.diffplug.spotless.pom.SortPomCfg

R

RdfFormatterConfig - Class in com.diffplug.spotless.rdf

RdfFormatterConfig() - Constructor for class com.diffplug.spotless.rdf.RdfFormatterConfig

RdfFormatterConfig.Builder - Class in com.diffplug.spotless.rdf

RdfFormatterFunc - Class in com.diffplug.spotless.rdf

RdfFormatterFunc(RdfFormatterStep.State) - Constructor for class com.diffplug.spotless.rdf.RdfFormatterFunc

RdfFormatterStep - Class in com.diffplug.spotless.rdf

RdfFormatterStep(JarState.Promised, RdfFormatterConfig, Map<String, String>) - Constructor for class com.diffplug.spotless.rdf.RdfFormatterStep

RdfFormatterStep.State - Class in com.diffplug.spotless.rdf

regex(String) - Method in class com.diffplug.spotless.generic.FenceStep

Defines the pipe via regex.

regex(Pattern) - Method in class com.diffplug.spotless.generic.FenceStep

Defines the pipe via regex.

relativizeAsUnix(File, File) - Static method in class com.diffplug.spotless.LintSuppression

Returns the relative path between root and dest, or null if dest is not a child of root.

RemoveSemicolonsStep - Class in com.diffplug.spotless.groovy

Removes all semicolons from the end of lines.

RemoveUnusedImportsStep - Class in com.diffplug.spotless.java

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

replaceDevDependencies(String, Map<String, String>) - Static method in class com.diffplug.spotless.npm.TsFmtFormatterStep.State

ReplaceRegexStep - Class in com.diffplug.spotless.generic

ReplaceStep - Class in com.diffplug.spotless.generic

resolveConfig(File, Map<String, Object>) - Method in class com.diffplug.spotless.npm.PrettierRestService

resolveNodeExecutable() - Method in class com.diffplug.spotless.npm.NpmPathResolver

Finds the node executable to use.

resolveNpmExecutable() - Method in class com.diffplug.spotless.npm.NpmPathResolver

Finds the npm executable to use.

resolveNpmrcContent() - Method in class com.diffplug.spotless.npm.NpmPathResolver

restClient - Variable in class com.diffplug.spotless.npm.EslintRestService

restClient - Variable in class com.diffplug.spotless.npm.PrettierRestService

restClient - Variable in class com.diffplug.spotless.npm.TsFmtRestService

result() - Method in class com.diffplug.spotless.ProcessRunner.LongRunningProcess

Result(List<String>, int, byte[], byte[]) - Constructor for class com.diffplug.spotless.ProcessRunner.Result

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

root - Variable in class com.diffplug.spotless.GitPrePushHookInstaller

The root directory of the Git repository where the hook will be installed.

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

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

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

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.

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

SerializedFunction.AlwaysReturns<T,R> - Class in com.diffplug.spotless

SerializeToByteArrayHack - Class in com.diffplug.spotless.yaml

This step is a flag which marks that `ConfigurationCacheHackList` should serialize each item individually into `byte[]` array, rather than using normal serialization.

SerializeToByteArrayHack() - Constructor for class com.diffplug.spotless.yaml.SerializeToByteArrayHack

SET_FROM_GIT - Enum constant in enum class com.diffplug.spotless.generic.LicenseHeaderStep.YearMode

setBinaryPath(String) - Method in class com.diffplug.spotless.generic.IdeaStep.IdeaStepBuilder

setBlockIndent(int) - Method in class com.diffplug.spotless.kotlin.KtfmtStep.KtfmtFormattingOptions

setCodeStyleSettingsPath(String) - Method in class com.diffplug.spotless.generic.IdeaStep.IdeaStepBuilder

setContinuationIndent(int) - Method in class com.diffplug.spotless.kotlin.KtfmtStep.KtfmtFormattingOptions

setEscapeHtml(boolean) - Method in class com.diffplug.spotless.json.gson.GsonConfig

setFailOnWarning(boolean) - Method in class com.diffplug.spotless.rdf.RdfFormatterConfig

setFeatureToToggle(Map<String, Boolean>) - Method in class com.diffplug.spotless.json.JacksonConfig

setForcedClassLoader(ClassLoader) - Static method in class com.diffplug.spotless.JarState

Overrides the classloader used by all JarStates.

setIdeaProperties(Map<String, String>) - Method in class com.diffplug.spotless.generic.IdeaStep.IdeaStepBuilder

setIndentSpaces(int) - Method in class com.diffplug.spotless.json.gson.GsonConfig

setJsonFeatureToToggle(Map<String, Boolean>) - Method in class com.diffplug.spotless.json.JacksonJsonConfig

Refers to com.fasterxml.jackson.core.JsonGenerator.Feature

setMaxWidth(int) - Method in class com.diffplug.spotless.kotlin.KtfmtStep.KtfmtFormattingOptions

setPath(String) - Method in class com.diffplug.spotless.LintSuppression

setRemoveUnusedImports(boolean) - Method in class com.diffplug.spotless.kotlin.KtfmtStep.KtfmtFormattingOptions

setShortCode(String) - Method in class com.diffplug.spotless.LintSuppression

setSortByKeys(boolean) - Method in class com.diffplug.spotless.json.gson.GsonConfig

setSpaceBeforeSeparator(boolean) - Method in class com.diffplug.spotless.json.JacksonJsonConfig

setStep(String) - Method in class com.diffplug.spotless.LintSuppression

setTrailingCommaManagementStrategy(KtfmtStep.TrailingCommaManagementStrategy) - Method in class com.diffplug.spotless.kotlin.KtfmtStep.KtfmtFormattingOptions

setTurtleFormatterVersion(String) - Method in class com.diffplug.spotless.rdf.RdfFormatterConfig

setUseDefaults(boolean) - Method in class com.diffplug.spotless.generic.IdeaStep.IdeaStepBuilder

setVerify(boolean) - Method in class com.diffplug.spotless.rdf.RdfFormatterConfig

setVersion(String) - Method in class com.diffplug.spotless.json.gson.GsonConfig

setYamlFeatureToToggle(Map<String, Boolean>) - Method in class com.diffplug.spotless.yaml.JacksonYamlConfig

Refers to com.fasterxml.jackson.dataformat.yaml.YAMLGenerator.Feature

shell(String) - Method in class com.diffplug.spotless.ProcessRunner

Executes the given shell command (using cmd on windows and sh on unix).

shellWinUnix(File, Map<String, String>, String, String) - Method in class com.diffplug.spotless.ProcessRunner

Executes the given shell command (using cmd on windows and sh on unix).

shellWinUnix(String, String) - Method in class com.diffplug.spotless.ProcessRunner

Executes the given shell command (using cmd on windows and sh on unix).

ShfmtStep - Class in com.diffplug.spotless.shell

shortcut() - Method in class com.diffplug.spotless.Lint

Returns an exception which will wrap this lint using Lint.Has

shortcut(Collection<Lint>) - Static method in class com.diffplug.spotless.Lint

Returns an exception which will wrap all of the given lints using Lint.Has

shortName() - Static method in class com.diffplug.spotless.biome.BiomeSettings

shutdown() - Method in class com.diffplug.spotless.npm.EslintRestService

shutdown() - Method in class com.diffplug.spotless.npm.PrettierRestService

shutdown() - Method in class com.diffplug.spotless.npm.TsFmtRestService

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.

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

sortDependencies - Variable in class com.diffplug.spotless.pom.SortPomCfg

sortDependencyExclusions - Variable in class com.diffplug.spotless.pom.SortPomCfg

sortDependencyManagement - Variable in class com.diffplug.spotless.pom.SortPomCfg

sortExecutions - Variable in class com.diffplug.spotless.pom.SortPomCfg

sortModules - Variable in class com.diffplug.spotless.pom.SortPomCfg

sortOrderFile - Variable in class com.diffplug.spotless.pom.SortPomCfg

sortPlugins - Variable in class com.diffplug.spotless.pom.SortPomCfg

SortPomCfg - Class in com.diffplug.spotless.pom

SortPomCfg() - Constructor for class com.diffplug.spotless.pom.SortPomCfg

SortPomStep - Class in com.diffplug.spotless.pom

sortProperties - Variable in class com.diffplug.spotless.pom.SortPomCfg

SPACE - Enum constant in enum class com.diffplug.spotless.generic.IndentStep.Type

spaceBeforeCloseEmptyElement - Variable in class com.diffplug.spotless.pom.SortPomCfg

spaceBeforeSeparator - Variable in class com.diffplug.spotless.json.JacksonJsonConfig

SpotlessCache - Class in com.diffplug.spotless

Spotless' global cache.

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

spotlessSetLicenseHeaderYearsFromGitHistory - Static variable in class com.diffplug.spotless.generic.LicenseHeaderStep

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

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

StandardNpmProcessFactory - Class in com.diffplug.spotless.npm

start(File, Map<String, String>, byte[], boolean, List<String>) - Method in class com.diffplug.spotless.ProcessRunner

Creates a process with the given arguments, the given byte array is written to stdin immediately.

start(File, Map<String, String>, byte[], List<String>) - Method in class com.diffplug.spotless.ProcessRunner

Creates a process with the given arguments, the given byte array is written to stdin immediately.

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

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

state(RdfFormatterStep) - Static method in class com.diffplug.spotless.rdf.RdfFormatterStep

State(RdfFormatterConfig, Map<String, String>, JarState) - Constructor for class com.diffplug.spotless.rdf.RdfFormatterStep.State

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

stdErr() - Method in class com.diffplug.spotless.ProcessRunner.Result

stdErrUtf8() - Method in class com.diffplug.spotless.ProcessRunner.Result

stdOut() - Method in class com.diffplug.spotless.ProcessRunner.Result

stdOutUtf8() - Method in class com.diffplug.spotless.ProcessRunner.Result

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

Returns the steps it takes to get to the result.

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

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

Returns the standard line ending for this policy.

subpath(String, String) - Static method in class com.diffplug.spotless.FileSignature

Asserts that child is a subpath of root.

suggestLaterVersionOnError(V, FormatterFunc) - Method in class com.diffplug.spotless.Jvm.Support

Suggest to use a different formatter version if formatting fails

support(String) - Static method in class com.diffplug.spotless.Jvm

Creates a map of JVM requirements for a formatter

suppresses(String, FormatterStep, Lint) - Method in class com.diffplug.spotless.LintSuppression

T

TAB - Enum constant in enum class com.diffplug.spotless.generic.IndentStep.Type

TestingOnly - Class in com.diffplug.spotless

These FormatterStep are meant to be used for testing only.

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

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 Class in com.diffplug.spotless

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

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.

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

toString() - Method in class com.diffplug.spotless.generic.IdeaStep.IdeaStepBuilder

toString() - Method in class com.diffplug.spotless.Jvm.Support

toString() - Method in class com.diffplug.spotless.LazyArgLogger

toString() - Method in class com.diffplug.spotless.Lint

toString() - Method in class com.diffplug.spotless.LintSuppression

toString() - Method in class com.diffplug.spotless.ProcessRunner.Result

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

Returns a string with exclusively unix line endings.

TrimTrailingWhitespaceStep - Class in com.diffplug.spotless.generic

TSCONFIG - Enum constant in enum class com.diffplug.spotless.npm.TsConfigFileType

TsConfigFileType - Enum Class in com.diffplug.spotless.npm

TSFMT - Enum constant in enum class com.diffplug.spotless.npm.TsConfigFileType

TsFmtFormatterStep - Class in com.diffplug.spotless.npm

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

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

TsFmtRestService - Class in com.diffplug.spotless.npm

TSLINT - Enum constant in enum class com.diffplug.spotless.npm.TsConfigFileType

turtleFormatterVersion(String) - Method in class com.diffplug.spotless.rdf.RdfFormatterConfig.Builder

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

UNIX - Enum constant in enum class com.diffplug.spotless.LineEnding

\n

unlazy(Object) - Static method in class com.diffplug.spotless.LazyForwardingEquality

Ensures that the lazy state has been evaluated.

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.

UPDATE_TO_TODAY - Enum constant in enum class com.diffplug.spotless.generic.LicenseHeaderStep.YearMode

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

Returns a string which describes this result.

usingRingBuffersOfCapacity(int) - Static method in class com.diffplug.spotless.ProcessRunner

V

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

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

valueOf(String) - Static method in enum class com.diffplug.spotless.generic.LicenseHeaderStep.YearMode

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

valueOf(String) - Static method in enum class com.diffplug.spotless.GitPrePushHookInstaller.Executor

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

valueOf(String) - Static method in enum class com.diffplug.spotless.kotlin.KtfmtStep.Style

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

valueOf(String) - Static method in enum class com.diffplug.spotless.kotlin.KtfmtStep.TrailingCommaManagementStrategy

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

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

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

valueOf(String) - Static method in enum class com.diffplug.spotless.npm.NpmProcessFactory.OnlinePreferrence

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

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

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

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

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

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

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

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

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

values() - Static method in enum class com.diffplug.spotless.generic.LicenseHeaderStep.YearMode

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

values() - Static method in enum class com.diffplug.spotless.GitPrePushHookInstaller.Executor

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

values() - Static method in enum class com.diffplug.spotless.kotlin.KtfmtStep.Style

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

values() - Static method in enum class com.diffplug.spotless.kotlin.KtfmtStep.TrailingCommaManagementStrategy

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

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

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

values() - Static method in enum class com.diffplug.spotless.npm.NpmProcessFactory.OnlinePreferrence

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

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

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

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

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

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

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

verify() - Method in class com.diffplug.spotless.npm.EslintConfig

verify() - Method in class com.diffplug.spotless.rdf.RdfFormatterConfig.Builder

verify(boolean) - Method in class com.diffplug.spotless.rdf.RdfFormatterConfig.Builder

version - Variable in class com.diffplug.spotless.pom.SortPomCfg

version() - Static method in class com.diffplug.spotless.Jvm

versionFlag(String) - Method in class com.diffplug.spotless.ForeignExe

The flag which causes the exe to print its version (defaults to --version).

versionHigherThanOrEqualTo(String, int, int, int) - Static method in class com.diffplug.spotless.biome.BiomeSettings

Checks if the version of Biome is equal to or higher than the given major, minor, and patch version.

versionRegex(Pattern) - Method in class com.diffplug.spotless.ForeignExe

A regex which can parse the version out of the output of the ForeignExe.versionFlag(String) command (defaults to version (\\S*))

VSCODE - Enum constant in enum class com.diffplug.spotless.npm.TsConfigFileType

W

waitFor() - Method in class com.diffplug.spotless.ProcessRunner.LongRunningProcess

waitFor(long, TimeUnit) - Method in class com.diffplug.spotless.ProcessRunner.LongRunningProcess

warn(String, Object...) - Method in interface com.diffplug.spotless.GitPrePushHookInstaller.GitPreHookLogger

WINDOWS - Enum constant in enum class com.diffplug.spotless.LineEnding

\r\n

withConfigPath(String) - Method in class com.diffplug.spotless.biome.BiomeStep

Sets the path to the Biome configuration.

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

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

withEslintConfigPath(File) - Method in class com.diffplug.spotless.npm.EslintConfig

withEslintConfigPath(File) - Method in class com.diffplug.spotless.npm.EslintTypescriptConfig

withExeDownload(String, String) - Static method in class com.diffplug.spotless.biome.BiomeStep

Creates a Biome step that format code by downloading to the given Biome version.

withExePath(String) - Static method in class com.diffplug.spotless.biome.BiomeStep

Creates a Biome step that formats code by delegating to the Biome executable located at the given path.

withGoExecutable(String) - Method in class com.diffplug.spotless.go.GofmtFormatStep

withHeaderLazy(ThrowingEx.Supplier<String>) - Method in class com.diffplug.spotless.generic.LicenseHeaderStep

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

withLanguage(String) - Method in class com.diffplug.spotless.biome.BiomeStep

Sets the language of the files to format When no language is set, it is determined automatically from the file name.

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

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

Provisions the given maven coordinates without their transitive dependencies.

withPathToExe(String) - Method in class com.diffplug.spotless.cpp.ClangFormatStep

withPathToExe(String) - Method in class com.diffplug.spotless.protobuf.BufStep

withPathToExe(String) - Method in class com.diffplug.spotless.python.BlackStep

withPathToExe(String) - Method in class com.diffplug.spotless.shell.ShfmtStep

withRemovedSuppressions(Formatter, String, List<LintSuppression>) - Method in class com.diffplug.spotless.LintState

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

withStyle(String) - Method in class com.diffplug.spotless.cpp.ClangFormatStep

withVersion(String) - Static method in class com.diffplug.spotless.cpp.ClangFormatStep

withVersion(String) - Static method in class com.diffplug.spotless.go.GofmtFormatStep

withVersion(String) - Static method in class com.diffplug.spotless.protobuf.BufStep

withVersion(String) - Static method in class com.diffplug.spotless.python.BlackStep

withVersion(String) - Static method in class com.diffplug.spotless.shell.ShfmtStep

withYearMode(LicenseHeaderStep.YearMode) - Method in class com.diffplug.spotless.generic.LicenseHeaderStep

withYearModeLazy(Supplier<LicenseHeaderStep.YearMode>) - Method in class com.diffplug.spotless.generic.LicenseHeaderStep

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

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.

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

wrapper - Variable in enum class com.diffplug.spotless.GitPrePushHookInstaller.Executor

writeCanonicalTo(File) - Method in class com.diffplug.spotless.DirtyState

writeCanonicalTo(OutputStream) - Method in class com.diffplug.spotless.DirtyState

Y

yamlFeatureToToggle - Variable in class com.diffplug.spotless.yaml.JacksonYamlConfig

A B C D E F G H I J K L M N O P Q R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form