com.diffplug.gradle.spotless

Class JavaExtension

java.lang.Object

com.diffplug.gradle.spotless.FormatExtension

com.diffplug.gradle.spotless.JavaExtension

public class JavaExtension
extends FormatExtension

Field Summary

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

steps, target

Constructor Summary

Constructors

Constructor and Description
JavaExtension(SpotlessExtension rootExtension)

Method Summary

Modifier and Type	Method and Description
void	eclipseFormatFile(Object eclipseFormatFile)
void	eclipseFormatFile(String eclipseVersion, Object eclipseFormatFile)
void	googleJavaFormat() Uses the google-java-format jar to format source code.
void	googleJavaFormat(String version) Uses the given version of google-java-format to format source code.
void	importOrder(List<String> importOrder)
void	importOrderFile(Object importOrderFile)
void	licenseHeader(String licenseHeader)
void	licenseHeaderFile(Object licenseHeaderFile)
void	removeUnusedImports() Removes any unused imports.
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, bumpThisNumberIfACustomStepChanges, clearSteps, custom, custom, customLazy, customLazyGroovy, encoding, endWithNewline, getEncoding, getExistingStep, getLineEndings, getProject, ignoreErrorForPath, ignoreErrorForStep, indentWithSpaces, indentWithSpaces, indentWithTabs, indentWithTabs, licenseHeader, licenseHeaderFile, paddedCell, paddedCell, parseTarget, replace, replaceRegex, replaceStep, setEncoding, setEncoding, setLineEndings, target, trimTrailingWhitespace

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaExtension

public JavaExtension(SpotlessExtension rootExtension)

Method Detail

licenseHeader

public void licenseHeader(String licenseHeader)

licenseHeaderFile

public void licenseHeaderFile(Object licenseHeaderFile)

importOrder

public void importOrder(List<String> importOrder)

importOrderFile

public void importOrderFile(Object importOrderFile)

eclipseFormatFile

public void eclipseFormatFile(Object eclipseFormatFile)

eclipseFormatFile

public void eclipseFormatFile(String eclipseVersion,
                              Object eclipseFormatFile)

removeUnusedImports

public void removeUnusedImports()

Removes any unused imports.

googleJavaFormat

public void googleJavaFormat()

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

googleJavaFormat

public void googleJavaFormat(String version)

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

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

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