com.reqdesign.reqif

Class EnumValue

java.lang.Object

com.reqdesign.reqif.Identifiable<EnumValue>

com.reqdesign.reqif.EnumValue

public final class EnumValue
extends Identifiable<EnumValue>

Class representing enumeration literals.

The specific form of an EnumValue in a ReqIF file is as follows:

<ENUM-VALUE DESC="desc" IDENTIFIER="identifier" LAST-CHANGE="lastChange" LONG-NAME="longName">

The following is the common list of XML attributes:

• @DESC optional xsd:string description
• @IDENTIFIER required xsd:ID
• @LAST-CHANGE required xsd:dateTime
• @LONG-NAME optional xsd:string

Method Summary

Modifier and Type	Method and Description
int	getEnumIndex() Getter for the index of this EnumValue in the enumeration list.
Properties	getProperties() Gets the Properties object owned by this object.
java.lang.String	toString() toString override.

Methods inherited from class com.reqdesign.reqif.Identifiable

equals, getAlternativeID, getChildren, getDesc, getIdentifier, getLastChange, getLastChangeText, getLongName, getPathToRoot, getReqIFContent, hashCode, isUsed, isValidIdentifier, setAlternativeID, setDesc, setLastChange, setLongName, whereUsed

Methods inherited from class java.lang.Object

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

Method Detail

getProperties

public Properties getProperties()

Gets the Properties object owned by this object.

Returns:

the owned Properties object, not null

toString

public java.lang.String toString()

toString override.

Overrides:

toString in class java.lang.Object

Returns:

the String representation of this enumeration obtained from the @LONG-NAME attribute, not null

getEnumIndex

public int getEnumIndex()

Getter for the index of this EnumValue in the enumeration list.

Returns:

the integer index of this object