Package net.kyori.indra.licenser.spotless.internal

Class HeaderFormatApplierImpl

java.lang.Object

net.kyori.indra.licenser.spotless.internal.HeaderFormatApplierImpl

All Implemented Interfaces:

HeaderFormatApplier

public class HeaderFormatApplierImpl
extends Object
implements HeaderFormatApplier

Constructor Summary

Constructors

Constructor	Description
HeaderFormatApplierImpl(org.gradle.api.provider.Property<HeaderFormat> format)

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(@NotNull 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.

Methods inherited from class java.lang.Object

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

Constructor Details

HeaderFormatApplierImpl

public HeaderFormatApplierImpl(org.gradle.api.provider.Property<HeaderFormat> format)

Method Details

starSlash

public void starSlash()

Description copied from interface: HeaderFormatApplier

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

Specified by:

starSlash in interface HeaderFormatApplier

doubleSlash

public void doubleSlash()

Description copied from interface: HeaderFormatApplier

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

Specified by:

doubleSlash in interface HeaderFormatApplier

prefix

public void prefix(@NotNull
 @NotNull String prefix)

Description copied from interface: HeaderFormatApplier

A header format containing only a prefix for body lines.

Specified by:

prefix in interface HeaderFormatApplier

Parameters:

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

custom

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

Description copied from interface: HeaderFormatApplier

Set a custom header format.

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

Specified by:

custom in interface HeaderFormatApplier

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