com.diffplug.gradle.spotless

Class SpotlessExtension

java.lang.Object

com.diffplug.gradle.spotless.SpotlessExtension

public class SpotlessExtension
extends Object

Constructor Summary

Constructors

Constructor and Description
SpotlessExtension(Project project)

Method Summary

Modifier and Type	Method and Description
void	encoding(String charset) Sets encoding to use (defaults to UTF_8).
void	format(String name, Action<FormatExtension> closure) Configures a custom extension.
void	freshmark(Action<FreshMarkExtension> closure) Configures the special freshmark-specific extension.
Charset	getEncoding() Returns the encoding to use.
LineEnding	getLineEndings()
void	groovy(Action<GroovyExtension> closure) Configures the special groovy-specific extension.
boolean	isEnforceCheck() Returns true if Gradle’s check task should run spotlessCheck; false otherwise.
void	java(Action<JavaExtension> closure) Configures the special java-specific extension.
void	kotlin(Action<KotlinExtension> closure) Configures the special kotlin-specific extension.
void	removeFormat(String name) Makes it possible to remove a format which was created earlier.
void	scala(Action<ScalaExtension> closure) Configures the special scala-specific extension.
void	setEncoding(Charset charset) Sets encoding to use (defaults to UTF_8).
void	setEncoding(String name) Sets encoding to use (defaults to UTF_8).
void	setEnforceCheck(boolean enforceCheck) Configures Gradle’s check task to run spotlessCheck if true, but to not do so if false.
void	setLineEndings(LineEnding lineEndings)

Methods inherited from class java.lang.Object

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

Constructor Detail

SpotlessExtension

public SpotlessExtension(Project project)

Method Detail

getLineEndings

public LineEnding getLineEndings()

setLineEndings

public void setLineEndings(LineEnding lineEndings)

getEncoding

public Charset getEncoding()

Returns the encoding to use.

setEncoding

public void setEncoding(String name)

Sets encoding to use (defaults to UTF_8).

setEncoding

public void setEncoding(Charset charset)

Sets encoding to use (defaults to UTF_8).

encoding

public void encoding(String charset)

Sets encoding to use (defaults to UTF_8).

java

public void java(Action<JavaExtension> closure)

Configures the special java-specific extension.

scala

public void scala(Action<ScalaExtension> closure)

Configures the special scala-specific extension.

kotlin

public void kotlin(Action<KotlinExtension> closure)

Configures the special kotlin-specific extension.

freshmark

public void freshmark(Action<FreshMarkExtension> closure)

Configures the special freshmark-specific extension.

groovy

public void groovy(Action<GroovyExtension> closure)

Configures the special groovy-specific extension.

format

public void format(String name,
                   Action<FormatExtension> closure)

Configures a custom extension.

removeFormat

public void removeFormat(String name)

Makes it possible to remove a format which was created earlier.

isEnforceCheck

public boolean isEnforceCheck()

Returns true if Gradle’s check task should run spotlessCheck; false otherwise.

setEnforceCheck

public void setEnforceCheck(boolean enforceCheck)

Configures Gradle’s check task to run spotlessCheck if true, but to not do so if false.

true by default.