Package net.kyori.indra.licenser.spotless

Interface HeaderFormatApplier

All Known Implementing Classes:

HeaderFormatApplierImpl

public interface HeaderFormatApplier

A helper interface to allow modifying header formats without needing to search for imports.

Since:

2.2.0

See Also:

• HeaderFormat

Method Summary

Modifier and Type	Method	Description
void	custom(@Nullable String begin, @Nullable String linePrefix, @Nullable String lineSuffix, @Nullable String end)	Set a custom header format.
void	doubleSlash()	Set the header format to use a double-slash prefix.
void	prefix(String prefix)	A header format containing only a prefix for body lines.
void	starSlash()	Set the header format to use star-slash, or C-style format.

Method Details

starSlash

void starSlash()

Set the header format to use star-slash, or C-style format.

Since:

2.2.0

doubleSlash

void doubleSlash()

Set the header format to use a double-slash prefix.

Since:

2.2.0

prefix

void prefix(String prefix)

A header format containing only a prefix for body lines.

Parameters:

prefix - the prefix (no space-padding will be added)

Since:

2.2.0

custom

void custom(@Nullable
 @Nullable String begin,
 @Nullable
 @Nullable String linePrefix,
 @Nullable
 @Nullable String lineSuffix,
 @Nullable
 @Nullable String end)

Set a custom header format.

Any parameters may be null, but a null parameter will be of limited use.

Parameters:

begin - text to put at the beginning of the header block

linePrefix - text to put at the beginning of every line

lineSuffix - text to put at the end of every line

end - text to put at the end of the header block

Since:

2.2.0