Package com.puppycrawl.tools.checkstyle.checks

Enum Class LineEndingOption

java.lang.Object

java.lang.Enum<LineEndingOption>

com.puppycrawl.tools.checkstyle.checks.LineEndingOption

All Implemented Interfaces:

Serializable, Comparable<LineEndingOption>, Constable

public enum LineEndingOption
extends Enum<LineEndingOption>

Represents the options for line ending settings.

See Also:

• LineEndingCheck

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
CRLF	Windows-style line ending.
LF	Unix-style line ending.

Field Summary

Fields

Modifier and Type	Field	Description
private static final byte	CARRIAGE_RETURN	Carriage return character ('\r').
private final byte[]	lineEnding	The line ending representation.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	LineEndingOption(String end)	Creates a new LineEndingOption instance.

Method Summary

Modifier and Type	Method	Description
static boolean	isCarriageReturn(byte value)	Checks that value is equal to the byte representation of carriage return.
boolean	matches(byte... bytes)	Checks that bytes is equal to the byte representation of this line ending.
static LineEndingOption	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LineEndingOption[]	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 LineEndingOption CRLF

Windows-style line ending.

LF

public static final LineEndingOption LF

Unix-style line ending.

Field Details

CARRIAGE_RETURN

private static final byte CARRIAGE_RETURN

Carriage return character ('\r').

See Also:

• Constant Field Values

lineEnding

private final byte[] lineEnding

The line ending representation.

Constructor Details

LineEndingOption

private LineEndingOption(String end)

Creates a new LineEndingOption instance.

Parameters:

end - the line separator, e.g. "\n"

Method Details

values

public static LineEndingOption[] 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 LineEndingOption 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 ending.

Parameters:

bytes - a bytes array to check

Returns:

true if bytes is equal to the byte representation of this line ending.

isCarriageReturn

public static boolean isCarriageReturn(byte value)

Checks that value is equal to the byte representation of carriage return.

Parameters:

value - a byte to check

Returns:

true if value is equal to byte representation of carriage return.