Package com.helger.base.state

Enum Class EEOI

java.lang.Object

java.lang.Enum<EEOI>

com.helger.base.state.EEOI

All Implemented Interfaces:

Serializable, Comparable<EEOI>, Constable

public enum EEOI
extends Enum<EEOI>

Small enum to identify whether we reached end of input or not.

Since:

9.3.8

Author:

Philip Helger

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
EOI
NOT_EOI

Method Summary

Modifier and Type	Method	Description
boolean	isEndOfInput()
boolean	isNotEndOfInput()
static @NonNull EEOI	valueOf(boolean bEOI)	Convert a boolean value to the corresponding EEOI enum value.
static EEOI	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EEOI[]	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

EOI

public static final EEOI EOI

NOT_EOI

public static final EEOI NOT_EOI

Method Details

values

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

isEndOfInput

public boolean isEndOfInput()

Returns:

true if end of input was reached, false otherwise.

isNotEndOfInput

public boolean isNotEndOfInput()

Returns:

true if end of input was not yet reached, false otherwise.

valueOf

public static @NonNull EEOI valueOf(boolean bEOI)

Convert a boolean value to the corresponding EEOI enum value.

Parameters:

bEOI - true for EOI, false for NOT_EOI.

Returns:

Never null.