org.dmd.dms.types

Class EnumValue

java.lang.Object

org.dmd.dms.types.EnumValue

public class EnumValue
extends Object

The EnumValue class is used to store the definition of one enumerated value that comprises part of an overall EnumDefinition.

The value of an EnumValue is comprised of at least three tokens and possibly a label: [enum integer value] [enum value name] [enum description] <: label> For example: 0 ABSTRACT Here is the definition of abstract. : Abstract

Within an EnumDefinition, each EnumValue must have a unique integer identifier and a unique value name.

The enum value name is automatically set to uppercase, even if it is specified in lower or mixed case.

Constructor Summary

Constructors

Constructor and Description
EnumValue() Constructs a new EnumValue.
EnumValue(EnumValue original) Constructs a new EnumValue.
EnumValue(String v) Constructs a new EnumValue with the specified value.

Method Summary

Modifier and Type	Method and Description
void	deserializeIt(DmcInputStreamIF dis)
String	getDescription()
Integer	getId()
String	getLabel()
String	getName()
void	serializeIt(DmcOutputStreamIF dos)
void	set(String v) Sets the value of the EnumValue.
String	toString() Returns the EnumValue in its string representation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EnumValue

public EnumValue()

Constructs a new EnumValue.

EnumValue

public EnumValue(EnumValue original)

Constructs a new EnumValue.

EnumValue

public EnumValue(String v)
          throws DmcValueException

Constructs a new EnumValue with the specified value.

Throws:

DmcValueException

Method Detail

set

public void set(String v)
         throws DmcValueException

Sets the value of the EnumValue.

Parameters:

v - The enum value.

Throws:

ResultException - If the specified string doesn't match the appropriate value format.

DmcValueException

toString

public String toString()

Returns the EnumValue in its string representation.

Overrides:

toString in class Object

getId

public Integer getId()

Returns:

the id

getName

public String getName()

Returns:

the name

getDescription

public String getDescription()

Returns:

the description

getLabel

public String getLabel()

Returns:

the label

serializeIt

public void serializeIt(DmcOutputStreamIF dos)
                 throws Exception

Throws:

Exception

deserializeIt

public void deserializeIt(DmcInputStreamIF dis)
                   throws Exception

Throws:

Exception