com.sun.jdmk
Class Enumerated

java.lang.Object
  |
  +--com.sun.jdmk.Enumerated

All Implemented Interfaces:

Serializable

public abstract class Enumerated

extends Object

implements Serializable

This class is used for implementing enumerated values. An enumeration is represented by a class derived from Enumerated. The derived class defines what are the permitted values in the enumeration. An enumerated value is represented by an instance of the derived class. It can be represented : - as an integer - as a string

Version:

3.1 09/29/98

Author:

Sun Microsystems, Inc

See Also:

Serialized Form

Field Summary

protected int

value This variable keeps the integer form of the enumerated.

Constructor Summary

Enumerated()
Construct an enumerated with a default value.

Enumerated(int valueIndex)
Construct an enumerated from its integer form.

Enumerated(Integer valueIndex)
Construct an enumerated from its Integer form.

Enumerated(String valueString)
Construct an enumerated from its string form.

Method Summary

boolean	equals(Object obj) Compares this enumerated to the specified enumerated.
protected abstract Hashtable	getIntTable() Returns the hashtable of the integer forms.
protected abstract Hashtable	getStringTable() Returns the hashtable of the string forms.
int	hashCode() Returns the hash code for this enumerated.
int	intValue() Return the integer form of the enumerated.
String	toString() Returns the string form of this enumerated.
Enumeration	valueIndexes() Returns an Java enumeration of the permitted integers.
Enumeration	valueStrings() Returns an Java enumeration of the permitted strings.

Methods inherited from class java.lang.Object

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

Field Detail

value

protected int value

This variable keeps the integer form of the enumerated. The string form is retreived using getIntTable().

Constructor Detail

Enumerated

public Enumerated()
           throws IllegalArgumentException

Construct an enumerated with a default value. The default value is the first available in getIntTable().

Throws:

IllegalArgumentException - One of the arguments passed to the method is illegal or inappropriate.

Enumerated

public Enumerated(int valueIndex)
           throws IllegalArgumentException

Construct an enumerated from its integer form.

Throws:

IllegalArgumentException - One of the arguments passed to the method is illegal or inappropriate.

Enumerated

public Enumerated(Integer valueIndex)
           throws IllegalArgumentException

Construct an enumerated from its Integer form.

Throws:

IllegalArgumentException - One of the arguments passed to the method is illegal or inappropriate.

Enumerated

public Enumerated(String valueString)
           throws IllegalArgumentException

Construct an enumerated from its string form.

Throws:

IllegalArgumentException - One of the arguments passed to the method is illegal or inappropriate.

Method Detail

intValue

public int intValue()

Return the integer form of the enumerated.

Returns:

The integer form

valueIndexes

public Enumeration valueIndexes()

Returns an Java enumeration of the permitted integers.

Returns:

An enumeration of Integer instances

valueStrings

public Enumeration valueStrings()

Returns an Java enumeration of the permitted strings.

Returns:

An enumeration of String instances

equals

public boolean equals(Object obj)

Compares this enumerated to the specified enumerated. The result is true if and only if the argument is not null and is of the same class.

Overrides:

equals in class Object

Returns:

True if this and obj are the same; false otherwise

hashCode

public int hashCode()

Returns the hash code for this enumerated.

Overrides:

hashCode in class Object

Returns:

A hash code value for this object.

toString

public String toString()

Returns the string form of this enumerated.

Overrides:

toString in class Object

Returns:

The string for for this object.

getIntTable

protected abstract Hashtable getIntTable()

Returns the hashtable of the integer forms. getIntTable().get(x) returns the string form associated to the integer x. This method must be implemented by the derived class.

Returns:

An hashtable for read-only purpose

getStringTable

protected abstract Hashtable getStringTable()

Returns the hashtable of the string forms. getStringTable().get(s) returns the integer form associated to the string s. This method must be implemented by the derived class.

Returns:

An hashtable for read-only purpose