com.diffplug.gradle.spotless.java

Class JavaExtension

java.lang.Object

com.diffplug.gradle.spotless.FormatExtension

com.diffplug.gradle.spotless.java.JavaExtension

public class JavaExtension
extends FormatExtension

Field Summary

Fields

Modifier and Type	Field and Description
static String	LICENSE_HEADER_DELIMITER
static String	NAME

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

name, root, steps, target

Constructor Summary

Constructors

Constructor and Description
JavaExtension(SpotlessExtension rootExtension)

Method Summary

Modifier and Type	Method and Description
void	eclipseFormatFile(Object eclipseFormatFile)
void	googleJavaFormat() Uses the [google-java-format](https://github.com/google/google-java-format) jar to format source code.
void	googleJavaFormat(String version) Uses the given version of [google-java-format](https://github.com/google/google-java-format) to format source code.
void	importOrder(List<String> importOrder)
void	importOrderFile(Object importOrderFile)
void	licenseHeader(String licenseHeader)
void	licenseHeaderFile(Object licenseHeaderFile)
protected void	setupTask(FormatTask 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

custom, custom, customLazy, customLazyGroovy, customReplace, customReplaceRegex, encoding, endWithNewline, getEncoding, getLineEndings, getProject, indentWithSpaces, indentWithSpaces, indentWithTabs, indentWithTabs, licenseHeader, licenseHeaderFile, paddedCell, paddedCell, parseTarget, setEncoding, setEncoding, setLineEndings, target, trimTrailingWhitespace

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

LICENSE_HEADER_DELIMITER

public static final String LICENSE_HEADER_DELIMITER

See Also:

Constant Field Values

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)

googleJavaFormat

public void googleJavaFormat()

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

googleJavaFormat

public void googleJavaFormat(String version)

Uses the given version of [google-java-format](https://github.com/google/google-java-format) to format source code. Limited to published versions. See [issue #33](https://github.com/diffplug/spotless/issues/33#issuecomment-252315095) for an workaround for using snapshot versions.

setupTask

protected void setupTask(FormatTask task)
                  throws Exception

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

Throws:

Exception