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>

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHANGED
UNCHANGED

Method Summary

Methods

Modifier and Type	Method and Description
EChange	and(IChangeIndicator aChange)
boolean	isChanged()
boolean	isUnchanged()
EChange	or(IChangeIndicator aChange)
static EChange	valueOf(boolean bChanged)
static EChange	valueOf(IChangeIndicator aChangeIndicator)
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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CHANGED

public static final EChange CHANGED

UNCHANGED

public static final EChange UNCHANGED

Method Detail

values

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

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.

isUnchanged

public boolean isUnchanged()

Specified by:

isUnchanged in interface IChangeIndicator

Returns:

true if unchanged and false if changed.

or

@Nonnull
public EChange or(@Nonnull
                 IChangeIndicator aChange)

and

@Nonnull
public EChange and(@Nonnull
                  IChangeIndicator aChange)

valueOf

@Nonnull
public static EChange valueOf(boolean bChanged)

valueOf

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