Package com.diffplug.spotless.generic

Class LicenseHeaderStep

java.lang.Object

com.diffplug.spotless.generic.LicenseHeaderStep

public final class LicenseHeaderStep
extends Object

Prefixes a license header before the package statement.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LicenseHeaderStep.YearMode

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_JAVA_HEADER_DELIMITER
static final String	spotlessSetLicenseHeaderYearsFromGitHistory

Method Summary

Modifier and Type	Method	Description
FormatterStep	build()
static String	defaultYearDelimiter()
static final String	FLAG_SET_LICENSE_HEADER_YEARS_FROM_GIT_HISTORY()
String	getName()
static LicenseHeaderStep	headerDelimiter(ThrowingEx.Supplier<String> headerLazy, String delimiter)
static LicenseHeaderStep	headerDelimiter(String header, String delimiter)
static SerializableFileFilter	unsupportedJvmFilesFilter()
LicenseHeaderStep	withContentPattern(String contentPattern)
LicenseHeaderStep	withDelimiter(String delimiter)
LicenseHeaderStep	withHeaderLazy(ThrowingEx.Supplier<String> headerLazy)
LicenseHeaderStep	withHeaderString(String header)
LicenseHeaderStep	withName(String name)
LicenseHeaderStep	withSkipLinesMatching(String skipLinesMatching)
LicenseHeaderStep	withYearMode(LicenseHeaderStep.YearMode yearMode)
LicenseHeaderStep	withYearModeLazy(Supplier<LicenseHeaderStep.YearMode> yearMode)
LicenseHeaderStep	withYearSeparator(String yearSeparator)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_JAVA_HEADER_DELIMITER

public static final String DEFAULT_JAVA_HEADER_DELIMITER

See Also:

• Constant Field Values

spotlessSetLicenseHeaderYearsFromGitHistory

public static final String spotlessSetLicenseHeaderYearsFromGitHistory

See Also:

• Constant Field Values

Method Details

headerDelimiter

public static LicenseHeaderStep headerDelimiter(String header,
 String delimiter)

headerDelimiter

public static LicenseHeaderStep headerDelimiter(ThrowingEx.Supplier<String> headerLazy,
 String delimiter)

getName

public String getName()

withName

public LicenseHeaderStep withName(String name)

withContentPattern

public LicenseHeaderStep withContentPattern(String contentPattern)

withHeaderString

public LicenseHeaderStep withHeaderString(String header)

withHeaderLazy

public LicenseHeaderStep withHeaderLazy(ThrowingEx.Supplier<String> headerLazy)

withDelimiter

public LicenseHeaderStep withDelimiter(String delimiter)

withYearSeparator

public LicenseHeaderStep withYearSeparator(String yearSeparator)

withYearMode

public LicenseHeaderStep withYearMode(LicenseHeaderStep.YearMode yearMode)

withYearModeLazy

public LicenseHeaderStep withYearModeLazy(Supplier<LicenseHeaderStep.YearMode> yearMode)

withSkipLinesMatching

public LicenseHeaderStep withSkipLinesMatching(@Nullable
 String skipLinesMatching)

build

public FormatterStep build()

defaultYearDelimiter

public static String defaultYearDelimiter()

unsupportedJvmFilesFilter

public static SerializableFileFilter unsupportedJvmFilesFilter()

FLAG_SET_LICENSE_HEADER_YEARS_FROM_GIT_HISTORY

public static final String FLAG_SET_LICENSE_HEADER_YEARS_FROM_GIT_HISTORY()