com.diffplug.spotless.generic

Class LicenseHeaderStep

java.lang.Object

com.diffplug.spotless.generic.LicenseHeaderStep

All Implemented Interfaces:

Serializable

public final class LicenseHeaderStep
extends Object
implements Serializable

Prefixes a license header before the package statement.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static FormatterStep	createFromFile(File licenseHeaderFile, Charset encoding, String delimiter) Creates a FormatterStep which forces the start of each file to match the license header contained in the given file.
static FormatterStep	createFromFile(File licenseHeaderFile, Charset encoding, String delimiter, String yearSeparator) Creates a FormatterStep which forces the start of each file to match the license header contained in the given file.
static FormatterStep	createFromHeader(String licenseHeader, String delimiter) Creates a FormatterStep which forces the start of each file to match a license header.
static FormatterStep	createFromHeader(String licenseHeader, String delimiter, String yearSeparator)
static String	defaultYearDelimiter()
String	format(String raw) Formats the given string.
static String	name()
static SerializableFileFilter	unsupportedJvmFilesFilter()

Methods inherited from class java.lang.Object

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

Method Detail

createFromHeader

public static FormatterStep createFromHeader(String licenseHeader,
                                             String delimiter)

Creates a FormatterStep which forces the start of each file to match a license header.

createFromHeader

public static FormatterStep createFromHeader(String licenseHeader,
                                             String delimiter,
                                             String yearSeparator)

createFromFile

public static FormatterStep createFromFile(File licenseHeaderFile,
                                           Charset encoding,
                                           String delimiter)

Creates a FormatterStep which forces the start of each file to match the license header contained in the given file.

createFromFile

public static FormatterStep createFromFile(File licenseHeaderFile,
                                           Charset encoding,
                                           String delimiter,
                                           String yearSeparator)

Creates a FormatterStep which forces the start of each file to match the license header contained in the given file.

name

public static String name()

defaultYearDelimiter

public static String defaultYearDelimiter()

unsupportedJvmFilesFilter

public static SerializableFileFilter unsupportedJvmFilesFilter()

format

public String format(String raw)

Formats the given string.