com.edorasware.commons.core.entity

Class State

java.lang.Object

com.edorasware.commons.core.entity.State

All Implemented Interfaces:

Serializable

public final class State
extends Object
implements Serializable

Represents a state.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static State	UNDEFINED A type-safe and null-safe undefined state.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
static State	getInstance(String name) Returns the state instance with the given name.
String	getName() Returns the name of the state.
int	hashCode()
boolean	isUndefined() Returns whether the state represents an undefined state.
static State	nullSafeGetInstance(String name) Returns the state instance with the given name or null if the name is null.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

UNDEFINED

public static final State UNDEFINED

A type-safe and null-safe undefined state.

Method Detail

getName

public String getName()

Returns the name of the state.

Returns:

the name of the state

isUndefined

public boolean isUndefined()

Returns whether the state represents an undefined state.

Returns:

true if the state represents an undefined state

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getInstance

public static State getInstance(String name)

Returns the state instance with the given name. Always the same reference is returned for a given name.

Parameters:

name - the name of the state

Returns:

the singleton instance of the state with the given name

nullSafeGetInstance

public static State nullSafeGetInstance(String name)

Returns the state instance with the given name or null if the name is null. Always the same reference is returned for a given non-null name.

Parameters:

name - the name of the state

Returns:

the singleton instance of the state with the given name, or null