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 and Description |
---|
LicenseHeaderConfig(LicenseHeaderStep builder) |
Modifier and Type | Method and Description |
---|---|
FormatExtension.LicenseHeaderConfig |
delimiter(String delimiter) |
FormatExtension.LicenseHeaderConfig |
updateYearWithLatest(boolean updateYearWithLatest) |
FormatExtension.LicenseHeaderConfig |
yearSeparator(String yearSeparator) |
public LicenseHeaderConfig(LicenseHeaderStep builder)
public FormatExtension.LicenseHeaderConfig delimiter(String delimiter)
delimiter
- Spotless will look for a line that starts with this regular expression pattern to know what the “top” is.public FormatExtension.LicenseHeaderConfig yearSeparator(String yearSeparator)
yearSeparator
- The characters used to separate the first and last years in multi years patterns.public FormatExtension.LicenseHeaderConfig updateYearWithLatest(boolean updateYearWithLatest)
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.