Package com.helger.commons.state

Enum EChange

java.lang.Object

java.lang.Enum<EChange>

com.helger.commons.state.EChange

All Implemented Interfaces:

IChangeIndicator, Serializable, Comparable<EChange>, java.lang.constant.Constable

public enum EChange
extends Enum<EChange>
implements IChangeIndicator

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
CHANGED
UNCHANGED

Method Summary

Modifier and Type	Method	Description
boolean	isChanged()
static EChange	valueOf(boolean bChanged)	Returns the enum constant of this type with the specified name.
static EChange	valueOf(IChangeIndicator aChangeIndicator)	Returns the enum constant of this type with the specified name.
static EChange	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EChange[]	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, 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.commons.state.IChangeIndicator

and, and, isUnchanged, or, or

Enum Constant Details

CHANGED

public static final EChange CHANGED

UNCHANGED

public static final EChange UNCHANGED

Method Details

values

public static EChange[] values()

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

Returns:

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

valueOf

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

isChanged

public boolean isChanged()

Specified by:

isChanged in interface IChangeIndicator

Returns:

true if changed and false if unchanged.

valueOf

@Nonnull
public static EChange valueOf(boolean bChanged)

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:

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

valueOf

@Nonnull
public static EChange valueOf(@Nonnull
 IChangeIndicator aChangeIndicator)

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:

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