Package com.puppycrawl.tools.checkstyle.checks.whitespace

Enum Class SeparatorOption

java.lang.Object

java.lang.Enum<SeparatorOption>

com.puppycrawl.tools.checkstyle.checks.whitespace.SeparatorOption

All Implemented Interfaces:

Serializable, Comparable<SeparatorOption>, Constable

public enum SeparatorOption
extends Enum<SeparatorOption>

Represents the policy for empty lines at the top or bottom of a block.

See Also:

• EmptyLineWrappingInBlockCheck

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
EMPTY_LINE	Exactly one empty line is required.
EMPTY_LINE_ALLOWED	No validation; any number of empty lines is allowed.
NO_EMPTY_LINE	No empty line is allowed.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SeparatorOption()

Method Summary

Modifier and Type	Method	Description
static SeparatorOption	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SeparatorOption[]	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

EMPTY_LINE

public static final SeparatorOption EMPTY_LINE

Exactly one empty line is required.

EMPTY_LINE_ALLOWED

public static final SeparatorOption EMPTY_LINE_ALLOWED

No validation; any number of empty lines is allowed.

NO_EMPTY_LINE

public static final SeparatorOption NO_EMPTY_LINE

No empty line is allowed.

Constructor Details

SeparatorOption

private SeparatorOption()

Method Details

values

public static SeparatorOption[] 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 SeparatorOption 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