Package com.diffplug.gradle.spotless

Class JavaExtension

java.lang.Object

com.diffplug.gradle.spotless.FormatExtension

com.diffplug.gradle.spotless.JavaExtension

All Implemented Interfaces:

HasBuiltinDelimiterForLicense

public class JavaExtension
extends FormatExtension
implements HasBuiltinDelimiterForLicense

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	JavaExtension.CleanthatJavaConfig
class	JavaExtension.EclipseConfig
class	JavaExtension.FormatAnnotationsConfig
class	JavaExtension.GoogleJavaFormatConfig
class	JavaExtension.ImportOrderConfig
class	JavaExtension.PalantirJavaFormatConfig

Nested classes/interfaces inherited from class com.diffplug.gradle.spotless.FormatExtension

FormatExtension.BiomeGeneric, FormatExtension.ClangFormatConfig, FormatExtension.EclipseWtpConfig, FormatExtension.IdeaConfig, FormatExtension.LicenseHeaderConfig, FormatExtension.NpmStepConfig<T extends FormatExtension.NpmStepConfig<?>>, FormatExtension.PrettierConfig

Field Summary

Fields inherited from class com.diffplug.gradle.spotless.FormatExtension

steps, target, targetExclude, targetExcludeContentPattern

Constructor Summary

Constructors

Constructor	Description
JavaExtension(SpotlessExtension spotless)

Method Summary

Modifier and Type	Method	Description
JavaExtension.CleanthatJavaConfig	cleanthat()	Apply CleanThat refactoring rules.
JavaExtension.EclipseConfig	eclipse()
JavaExtension.EclipseConfig	eclipse(String version)
void	forbidWildcardImports()
JavaExtension.FormatAnnotationsConfig	formatAnnotations()	Removes newlines between type annotations and types.
default FileCollection	getSources(Project project, String message, Function<SourceSet,SourceDirectorySet> sourceSetSourceDirectory, Spec<? super File> filterSpec)
JavaExtension.GoogleJavaFormatConfig	googleJavaFormat()	Uses the google-java-format jar to format source code.
JavaExtension.GoogleJavaFormatConfig	googleJavaFormat(String version)	Uses the given version of google-java-format to format source code.
JavaExtension.ImportOrderConfig	importOrder(String... importOrder)
JavaExtension.ImportOrderConfig	importOrderFile(Object importOrderFile)
FormatExtension.LicenseHeaderConfig	licenseHeader(String licenseHeader)
FormatExtension.LicenseHeaderConfig	licenseHeaderFile(Object licenseHeaderFile)
JavaExtension.PalantirJavaFormatConfig	palantirJavaFormat()	Uses the palantir-java-format jar to format source code.
JavaExtension.PalantirJavaFormatConfig	palantirJavaFormat(String version)	Uses the given version of palantir-java-format to format source code.
void	removeUnusedImports()	Removes any unused imports.
void	removeUnusedImports(String formatter)
void	removeWildcardImports()	Deprecated.
protected void	setupTask(SpotlessTask task)	If the user hasn't specified the files yet, we'll assume he/she means all of the java files.

Methods inherited from class com.diffplug.gradle.spotless.FormatExtension

addStep, addStep, biome, biome, bumpThisNumberIfACustomStepChanges, clangFormat, clangFormat, clearSteps, createIndependentApplyTask, createIndependentApplyTaskLazy, custom, custom, eclipseWtp, eclipseWtp, encoding, endWithNewline, forbidRegex, getEncoding, getExistingStepIdx, getLineEndings, getProject, getRatchetFrom, idea, ignoreErrorForPath, ignoreErrorForStep, indentWithSpaces, indentWithSpaces, indentWithTabs, indentWithTabs, isLicenseHeaderStep, leadingSpacesToTabs, leadingSpacesToTabs, leadingTabsToSpaces, leadingTabsToSpaces, licenseHeader, licenseHeaderFile, nativeCmd, noDefaultTargetException, parseTarget, prettier, prettier, prettier, provisioner, ratchetFrom, replace, replaceRegex, replaceStep, setEncoding, setEncoding, setLineEndings, setRatchetFrom, suppressLintsFor, target, targetExclude, targetExcludeIfContentContains, targetExcludeIfContentContainsRegex, toggleOffOn, toggleOffOn, toggleOffOnDisable, toggleOffOnRegex, trimTrailingWhitespace, withinBlocks, withinBlocks, withinBlocksRegex, withinBlocksRegex

Methods inherited from class java.lang.Object

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

Constructor Details

JavaExtension

@Inject
public JavaExtension(SpotlessExtension spotless)

Method Details

licenseHeader

public FormatExtension.LicenseHeaderConfig licenseHeader(String licenseHeader)

Specified by:

licenseHeader in interface HasBuiltinDelimiterForLicense

Parameters:

licenseHeader - Content that should be at the top of every file.

licenseHeaderFile

public FormatExtension.LicenseHeaderConfig licenseHeaderFile(Object licenseHeaderFile)

Specified by:

licenseHeaderFile in interface HasBuiltinDelimiterForLicense

Parameters:

licenseHeaderFile - Content that should be at the top of every file.

importOrder

public JavaExtension.ImportOrderConfig importOrder(String... importOrder)

importOrderFile

public JavaExtension.ImportOrderConfig importOrderFile(Object importOrderFile)

removeUnusedImports

public void removeUnusedImports()

Removes any unused imports.

removeUnusedImports

public void removeUnusedImports(String formatter)

removeWildcardImports

@Deprecated
public void removeWildcardImports()

Deprecated.

forbidWildcardImports

public void forbidWildcardImports()

googleJavaFormat

public JavaExtension.GoogleJavaFormatConfig googleJavaFormat()

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

googleJavaFormat

public JavaExtension.GoogleJavaFormatConfig googleJavaFormat(String version)

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

Limited to published versions. See issue #33 for a workaround for using snapshot versions.

palantirJavaFormat

public JavaExtension.PalantirJavaFormatConfig palantirJavaFormat()

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

palantirJavaFormat

public JavaExtension.PalantirJavaFormatConfig palantirJavaFormat(String version)

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

Limited to published versions. See issue #33 for a workaround for using snapshot versions.

eclipse

public JavaExtension.EclipseConfig eclipse()

eclipse

public JavaExtension.EclipseConfig eclipse(String version)

formatAnnotations

public JavaExtension.FormatAnnotationsConfig formatAnnotations()

Removes newlines between type annotations and types.

cleanthat

public JavaExtension.CleanthatJavaConfig cleanthat()

Apply CleanThat refactoring rules.

setupTask

protected void setupTask(SpotlessTask task)

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

Overrides:

setupTask in class FormatExtension

getSources

default FileCollection getSources(Project project,
 String message,
 Function<SourceSet,SourceDirectorySet> sourceSetSourceDirectory,
 Spec<? super File> filterSpec)