Package com.diffplug.spotless.generic

Class LicenseHeaderStep

java.lang.Object

com.diffplug.spotless.generic.LicenseHeaderStep

public final class LicenseHeaderStep
extends java.lang.Object

Prefixes a license header before the package statement.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LicenseHeaderStep.YearMode

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_JAVA_HEADER_DELIMITER
static java.lang.String	spotlessSetLicenseHeaderYearsFromGitHistory

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_JAVA_HEADER_DELIMITER

public static final java.lang.String DEFAULT_JAVA_HEADER_DELIMITER

See Also:

Constant Field Values

spotlessSetLicenseHeaderYearsFromGitHistory

public static final java.lang.String spotlessSetLicenseHeaderYearsFromGitHistory

See Also:

Constant Field Values

Method Detail

headerDelimiter

public static LicenseHeaderStep headerDelimiter(java.lang.String header,
                                                java.lang.String delimiter)

headerDelimiter

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

getName

public java.lang.String getName()

withName

public LicenseHeaderStep withName(java.lang.String name)

withContentPattern

public LicenseHeaderStep withContentPattern(java.lang.String contentPattern)

withHeaderString

public LicenseHeaderStep withHeaderString(java.lang.String header)

withHeaderLazy

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

withDelimiter

public LicenseHeaderStep withDelimiter(java.lang.String delimiter)

withYearSeparator

public LicenseHeaderStep withYearSeparator(java.lang.String yearSeparator)

withYearMode

public LicenseHeaderStep withYearMode(LicenseHeaderStep.YearMode yearMode)

withYearModeLazy

public LicenseHeaderStep withYearModeLazy(java.util.function.Supplier<LicenseHeaderStep.YearMode> yearMode)

withSkipLinesMatching

public LicenseHeaderStep withSkipLinesMatching(@Nullable
                                               java.lang.String skipLinesMatching)

build

public FormatterStep build()

defaultYearDelimiter

public static java.lang.String defaultYearDelimiter()

unsupportedJvmFilesFilter

public static SerializableFileFilter unsupportedJvmFilesFilter()

FLAG_SET_LICENSE_HEADER_YEARS_FROM_GIT_HISTORY

public static final java.lang.String FLAG_SET_LICENSE_HEADER_YEARS_FROM_GIT_HISTORY()