com.arjuna.webservices.util

Class Enumerated

java.lang.Object

com.arjuna.webservices.util.Enumerated

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SoapFaultType, State, State

public abstract class Enumerated
extends Object
implements Serializable

Base class for enumerated types.

Author:

kevin

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Enumerated(Object value) Construct the enumerated value.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object rhs) Compare the specified object to this one.
protected static Map	generateMap(Enumerated[] enumerations) Generate the map of enumeration values to enumerations.
Object	getKey() Get the key representation of this enumeration.
int	hashCode() Return a hash code for this enumerated entry.
protected Object	readResolve() Replace any serialised version of this class with the same instance.
protected abstract Enumerated	resolveEnum(Object value) Resolve the value of an enumeration.
String	toString() Get the string representation of this enumeration.

Methods inherited from class java.lang.Object

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

Constructor Detail

Enumerated

protected Enumerated(Object value)

Construct the enumerated value.

Parameters:

value - The string value of the enumeration.

Method Detail

equals

public boolean equals(Object rhs)

Compare the specified object to this one.

Overrides:

equals in class Object

Parameters:

rhs - The other object to compare.

hashCode

public int hashCode()

Return a hash code for this enumerated entry.

Overrides:

hashCode in class Object

Returns:

the enumeration hash code.

getKey

public Object getKey()

Get the key representation of this enumeration.

Returns:

the key representation.

toString

public String toString()

Get the string representation of this enumeration.

Overrides:

toString in class Object

Returns:

the string representation.

resolveEnum

protected abstract Enumerated resolveEnum(Object value)
                                   throws InvalidEnumerationException

Resolve the value of an enumeration.

Parameters:

value - The value of the enumeration.

Returns:

The enumeration.

Throws:

InvalidEnumerationException - if the enumeration value is invalid.

readResolve

protected Object readResolve()
                      throws ObjectStreamException

Replace any serialised version of this class with the same instance.

Returns:

The instance of the enumeration.

Throws:

ObjectStreamException

generateMap

protected static Map generateMap(Enumerated[] enumerations)

Generate the map of enumeration values to enumerations.

Parameters:

enumerations - The enumerations to configure.

Returns:

The enumeration map.