com.diffplug.gradle.spotless

Class FormatExtension.LicenseHeaderConfig

java.lang.Object

com.diffplug.gradle.spotless.FormatExtension.LicenseHeaderConfig

Enclosing class:

FormatExtension

public abstract class FormatExtension.LicenseHeaderConfig
extends Object

Created by FormatExtension.licenseHeader(String, String) or FormatExtension.licenseHeaderFile(Object, String). For most language-specific formats (e.g. java, scala, etc.) you can omit the second delimiter argument, because it is supplied automatically (HasBuiltinDelimiterForLicense).

Constructor Summary

Constructors

Constructor and Description
LicenseHeaderConfig(String delimiter)

Method Summary

Modifier and Type	Method and Description
FormatExtension.LicenseHeaderConfig	delimiter(String delimiter)
protected abstract String	licenseHeader()
FormatExtension.LicenseHeaderConfig	updateYearWithLatest(boolean updateYearWithLatest)
FormatExtension.LicenseHeaderConfig	yearSeparator(String yearSeparator)

Methods inherited from class java.lang.Object

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

Constructor Detail

LicenseHeaderConfig

public LicenseHeaderConfig(String delimiter)

Method Detail

delimiter

public FormatExtension.LicenseHeaderConfig delimiter(String delimiter)

Parameters:

delimiter - Spotless will look for a line that starts with this regular expression pattern to know what the “top” is.

yearSeparator

public FormatExtension.LicenseHeaderConfig yearSeparator(String yearSeparator)

Parameters:

yearSeparator - The characters used to separate the first and last years in multi years patterns.

updateYearWithLatest

public FormatExtension.LicenseHeaderConfig updateYearWithLatest(boolean updateYearWithLatest)

Parameters:

updateYearWithLatest - Will turn 2004 into 2004-2020, and 2004-2019 into 2004-2020 Default value is false, unless SpotlessExtensionBase.ratchetFrom(String) is used, in which case default value is true.

licenseHeader

protected abstract String licenseHeader()
                                 throws IOException

Throws:

IOException