Package com.helger.commons.state

Enum ELeftRight

java.lang.Object

java.lang.Enum<ELeftRight>

com.helger.commons.state.ELeftRight

All Implemented Interfaces:

ILeftRightIndicator, Serializable, Comparable<ELeftRight>

public enum ELeftRight
extends Enum<ELeftRight>
implements ILeftRightIndicator

Small enum for left and right

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant	Description
LEFT
RIGHT

Method Summary

Modifier and Type	Method	Description
boolean	isLeft()
static ELeftRight	valueOf(ILeftRightIndicator aLeftRightIndicator)	Returns the enum constant of this type with the specified name.
static ELeftRight	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ELeftRight[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.commons.state.ILeftRightIndicator

isRight

Enum Constant Detail

LEFT

public static final ELeftRight LEFT

RIGHT

public static final ELeftRight RIGHT

Method Detail

values

public static ELeftRight[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ELeftRight c : ELeftRight.values())
    System.out.println(c);

Returns:

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

valueOf

public static ELeftRight valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

isLeft

public boolean isLeft()

Specified by:

isLeft in interface ILeftRightIndicator

Returns:

true if left and false if right.

valueOf

@Nonnull
public static ELeftRight valueOf(@Nonnull
                                 ILeftRightIndicator aLeftRightIndicator)

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

Parameters:

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

Returns:

the enum constant with the specified name

Throws:

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

NullPointerException - if the argument is null