Package com.diffplug.gradle.spotless

Class FormatExtension.LicenseHeaderConfig

java.lang.Object

com.diffplug.gradle.spotless.FormatExtension.LicenseHeaderConfig

Enclosing class:

FormatExtension

public 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	Description
LicenseHeaderConfig(LicenseHeaderStep builder)

Method Summary

Modifier and Type	Method	Description
FormatExtension.LicenseHeaderConfig	delimiter(String delimiter)
FormatExtension.LicenseHeaderConfig	named(String name)
FormatExtension.LicenseHeaderConfig	onlyIfContentMatches(String contentPattern)
FormatExtension.LicenseHeaderConfig	skipLinesMatching(String skipLinesMatching)
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 Details

LicenseHeaderConfig

public LicenseHeaderConfig(LicenseHeaderStep builder)

Method Details

named

public FormatExtension.LicenseHeaderConfig named(String name)

onlyIfContentMatches

public FormatExtension.LicenseHeaderConfig onlyIfContentMatches(String contentPattern)

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.

skipLinesMatching

public FormatExtension.LicenseHeaderConfig skipLinesMatching(String skipLinesMatching)

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 SpotlessExtension.ratchetFrom(String) is used, in which case default value is true.