Package com.helger.base.state

Enum Class EInterrupt

java.lang.Object

java.lang.Enum<EInterrupt>

com.helger.base.state.EInterrupt

All Implemented Interfaces:

IInterruptIndicator, Serializable, Comparable<EInterrupt>, Constable

public enum EInterrupt
extends Enum<EInterrupt>
implements IInterruptIndicator

Small enum for setter method to identify whether a value has changed or not.

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
INTERRUPTED
NOT_INTERRUPTED

Method Summary

Modifier and Type	Method	Description
boolean	isInterrupted()
static @NonNull EInterrupt	valueOf(boolean bInterrupted)	Convert a boolean value to the corresponding EInterrupt enum value.
static @NonNull EInterrupt	valueOf(@NonNull IInterruptIndicator aInterruptIndicator)	Convert an IInterruptIndicator to the corresponding EInterrupt enum value.
static EInterrupt	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EInterrupt[]	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

Methods inherited from interface com.helger.base.state.IInterruptIndicator

and, isNotInterrupted, or

Enum Constant Details

INTERRUPTED

public static final EInterrupt INTERRUPTED

NOT_INTERRUPTED

public static final EInterrupt NOT_INTERRUPTED

Method Details

values

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

isInterrupted

public boolean isInterrupted()

Specified by:

isInterrupted in interface IInterruptIndicator

Returns:

true if interrupted and false if not.

valueOf

public static @NonNull EInterrupt valueOf(boolean bInterrupted)

Convert a boolean value to the corresponding EInterrupt enum value.

Parameters:

bInterrupted - true for INTERRUPTED, false for NOT_INTERRUPTED.

Returns:

Never null.

valueOf

public static @NonNull EInterrupt valueOf(@NonNull IInterruptIndicator aInterruptIndicator)

Convert an IInterruptIndicator to the corresponding EInterrupt enum value.

Parameters:

aInterruptIndicator - The interrupt indicator to convert. May not be null.

Returns:

Never null.