Package com.diffplug.gradle.spotless

Class GroovyExtension

java.lang.Object

com.diffplug.gradle.spotless.FormatExtension

com.diffplug.gradle.spotless.BaseGroovyExtension

com.diffplug.gradle.spotless.GroovyExtension

All Implemented Interfaces:

HasBuiltinDelimiterForLicense

public class GroovyExtension
extends BaseGroovyExtension
implements HasBuiltinDelimiterForLicense

Nested Class Summary

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

BaseGroovyExtension.GrEclipseConfig

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
GroovyExtension(SpotlessExtension spotless)

Method Summary

Modifier and Type	Method	Description
void	excludeJava()	Excludes .java files, to focus on only .groovy files.
void	excludeJava(boolean excludeJava)	Determines whether to exclude .java files, to focus on only .groovy files.
default FileCollection	getSources(Project project, String message, Function<SourceSet,SourceDirectorySet> sourceSetSourceDirectory, Spec<? super File> filterSpec)
FormatExtension.LicenseHeaderConfig	licenseHeader(String licenseHeader)
FormatExtension.LicenseHeaderConfig	licenseHeaderFile(Object licenseHeaderFile)
protected void	setupTask(SpotlessTask task)	If the user hasn't specified the files yet, we'll assume he/she means all of the groovy files.

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

greclipse, greclipse, importOrder, importOrderFile, removeSemicolons

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

GroovyExtension

@Inject
public GroovyExtension(SpotlessExtension spotless)

Method Details

excludeJava

public void excludeJava()

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

excludeJava

public void excludeJava(boolean excludeJava)

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

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.

setupTask

protected void setupTask(SpotlessTask task)

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

Overrides:

setupTask in class FormatExtension

getSources

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