Package com.puppycrawl.tools.checkstyle.checks

Enum Class LineSeparatorOption

java.lang.Object

java.lang.Enum<LineSeparatorOption>

com.puppycrawl.tools.checkstyle.checks.LineSeparatorOption

All Implemented Interfaces:

Serializable, Comparable<LineSeparatorOption>, Constable

public enum LineSeparatorOption
extends Enum<LineSeparatorOption>

Represents the options for line separator settings.

See Also:

• NewlineAtEndOfFileCheck

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CR	Mac-style line separators.
CRLF	Windows-style line separators.
LF	Unix-style line separators.
LF_CR_CRLF	Matches CR, LF and CRLF line separators.
SYSTEM	System default line separators.

Field Summary

Fields

Modifier and Type	Field	Description
private final byte[]	lineSeparator	The line separator representation.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	LineSeparatorOption(String sep)	Creates a new LineSeparatorOption instance.

Method Summary

Modifier and Type	Method	Description
int	length()	Returns length of file separator in bytes.
boolean	matches(byte... bytes)	Checks that bytes is equal to the byte representation of this line separator.
static LineSeparatorOption	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LineSeparatorOption[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CRLF

public static final LineSeparatorOption CRLF

Windows-style line separators.

CR

public static final LineSeparatorOption CR

Mac-style line separators.

LF

public static final LineSeparatorOption LF

Unix-style line separators.

LF_CR_CRLF

public static final LineSeparatorOption LF_CR_CRLF

Matches CR, LF and CRLF line separators. Only the length is used - the actual value is ignored.

SYSTEM

public static final LineSeparatorOption SYSTEM

System default line separators.

Field Details

lineSeparator

private final byte[] lineSeparator

The line separator representation.

Constructor Details

LineSeparatorOption

private LineSeparatorOption(String sep)

Creates a new LineSeparatorOption instance.

Parameters:

sep - the line separator, e.g. "\r\n"

Method Details

values

public static LineSeparatorOption[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static LineSeparatorOption valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

matches

public boolean matches(byte... bytes)

Checks that bytes is equal to the byte representation of this line separator.

Parameters:

bytes - a bytes array to check

Returns:

if bytes is equal to the byte representation of this line separator

length

public int length()

Returns length of file separator in bytes.

Returns:

the length of the file separator in bytes, e.g. 1 for CR, 2 for CRLF, ...