com.actional.soapstation.plugin.inproc

Class Enum

java.lang.Object

com.actional.soapstation.plugin.inproc.Enum

Direct Known Subclasses:

DOMType, EventType, IAlertNotifierPlugin.AlertSeverity, MessageType, ReturnStatusType

public class Enum
extends java.lang.Object

Base class to keep track of all the possible values in an Enum. This class is used to ensure that there is always only one instance in memory of a possible enum value. See DOMType for an example enum that uses this class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	Enum.Entries

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	itsStringValue
private static java.util.HashMap	itsTable
private int	itsValue

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Enum(int value, java.lang.String stringValue) Initialize the enumeration class

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Compare this object to another.
static Enum	fromString(java.lang.Class cls, java.lang.String value) Find the enumeration instance
static Enum	fromValue(java.lang.Class cls, int value) Get the enum instance for a specific class
private static Enum.Entries	GetAndCreateEntries(java.lang.Class cls) Get the class specific Entries, creating it if necessary.
private static Enum.Entries	GetEntries(java.lang.Class cls) Get the class specific hash map
int	getValue() Get the enumeration value.
static java.util.Collection	getValues(java.lang.Class cls) Find all the possible enumeration values for the class.
int	hashCode() Return the hash code for this enumeration value.
java.lang.String	toString() Convert the enumeration into a string

Methods inherited from class java.lang.Object

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

Field Detail

itsTable

private static java.util.HashMap itsTable

itsValue

private int itsValue

itsStringValue

private java.lang.String itsStringValue

Constructor Detail

Enum

protected Enum(int value,
               java.lang.String stringValue)

Initialize the enumeration class

Method Detail

GetAndCreateEntries

private static Enum.Entries GetAndCreateEntries(java.lang.Class cls)

Get the class specific Entries, creating it if necessary.

Parameters:

cls - class to get hash map for

Returns:

hash map

GetEntries

private static Enum.Entries GetEntries(java.lang.Class cls)

Get the class specific hash map

Parameters:

cls - class to get hash map for

Returns:

hash map

getValue

public int getValue()

Get the enumeration value.

Returns:

value

toString

public java.lang.String toString()

Convert the enumeration into a string

Overrides:

toString in class java.lang.Object

Returns:

String value of enumeration

hashCode

public int hashCode()

Return the hash code for this enumeration value.

Overrides:

hashCode in class java.lang.Object

Returns:

Hash code for enum value

equals

public boolean equals(java.lang.Object obj)

Compare this object to another. Because there is only one instance of an enumeration value the objects can be compared by object reference.

Overrides:

equals in class java.lang.Object

Parameters:

obj - object to compare to

fromValue

public static Enum fromValue(java.lang.Class cls,
                             int value)

Get the enum instance for a specific class

Parameters:

cls - Class of enumeration

value - Value of enumeration

Returns:

enumeration instance

fromString

public static Enum fromString(java.lang.Class cls,
                              java.lang.String value)

Find the enumeration instance

Parameters:

cls - Class of enumeration

value - Value of enumeration

Returns:

enumeration instance

getValues

public static java.util.Collection getValues(java.lang.Class cls)

Find all the possible enumeration values for the class.

Parameters:

cls - Class of enumeration

Returns:

Collection containing the values