Package com.helger.commons.state

Enum ETopBottom

java.lang.Object

java.lang.Enum<ETopBottom>

com.helger.commons.state.ETopBottom

All Implemented Interfaces:

ITopBottomIndicator, Serializable, Comparable<ETopBottom>

public enum ETopBottom
extends Enum<ETopBottom>
implements ITopBottomIndicator

Small enum for top and bottom

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTTOM
TOP

Method Summary

Modifier and Type	Method	Description
boolean	isTop()
static ETopBottom	valueOf(ITopBottomIndicator aTopBottomIndicator)	Returns the enum constant of this type with the specified name.
static ETopBottom	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ETopBottom[]	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.ITopBottomIndicator

isBottom

Enum Constant Detail

TOP

public static final ETopBottom TOP

BOTTOM

public static final ETopBottom BOTTOM

Method Detail

values

public static ETopBottom[] 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 (ETopBottom c : ETopBottom.values())
    System.out.println(c);

Returns:

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

valueOf

public static ETopBottom 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

isTop

public boolean isTop()

Specified by:

isTop in interface ITopBottomIndicator

Returns:

true if top and false if bottom.

valueOf

@Nonnull
public static ETopBottom valueOf(@Nonnull
                                 ITopBottomIndicator aTopBottomIndicator)

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:

aTopBottomIndicator - 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