com.reqdesign.reqif

Class AttributeValueEnumeration

java.lang.Object

com.reqdesign.reqif.AttributeValue

com.reqdesign.reqif.AttributeValueEnumeration

public final class AttributeValueEnumeration
extends AttributeValue

Concrete specialization of the AttributeValue class specifically for Enumeration values

This class extends from the base class AttributeValue.

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

 <ATTRIBUTE-VALUE-ENUMERATION>
     <VALUES>
         <ENUM-VALUE-REF>EnumValue@IDENTIFIER</ENUM-VALUE-REF>
     </VALUES>
     ...
 </ATTRIBUTE-VALUE-ENUMERATION>

Method Summary

Modifier and Type	Method and Description
AttributeDefinitionEnumeration	getAttributeDefinitionEnumeration() The AttributeDefinitionEnumeration associated with this attribute value
DatatypeDefinitionEnumeration	getDatatypeDefinitionEnumeration() The DatatypeDefinitionEnumeration associated with this attribute value
java.lang.String	getDisplayText() Returns the collection of EnumValue objects as a single String composed from individual EnumValue @LONG-NAME attribute values and comma delimited.
SpecifiedValues	getEnumValues() Returns the collection of EnumValue objects contained in this object
java.lang.Object	getValue() Returns the native value as Object
java.lang.String[]	getValues() Returns the collection of EnumValue objects as a String[] array of individual EnumValue @LONG-NAME attribute values.
void	setTheValue(EnumValue... theValues) Sets the EnumValue values

Methods inherited from class com.reqdesign.reqif.AttributeValue

getAttributeDefinition, getAttributeDefinitionLongName, getDatatypeDefinition, getReqIFContent, getReqIFContent, getSpecElementWithAttributes

Methods inherited from class java.lang.Object

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

Method Detail

getEnumValues

public SpecifiedValues getEnumValues()

Returns the collection of EnumValue objects contained in this object

Returns:

the collection of EnumValue objects as a SpecifiedValues collection object, not null

setTheValue

public void setTheValue(EnumValue... theValues)
                 throws InvalidValueException,
                        NotFoundException

Sets the EnumValue values

Parameters:

theValues - the new EnumValue values to set for this object

Throws:

InvalidValueException - if any of the supplied theValue parameters is null

NotFoundException - if the AttributeDefinitionEnumeration for this AttributeValueEnumeration was not found in the SpecType SpecAttributes collection

getAttributeDefinitionEnumeration

public AttributeDefinitionEnumeration getAttributeDefinitionEnumeration()

The AttributeDefinitionEnumeration associated with this attribute value

Returns:

the AttributeDefinitionEnumeration object associated with this object, not null

getDatatypeDefinitionEnumeration

public DatatypeDefinitionEnumeration getDatatypeDefinitionEnumeration()

The DatatypeDefinitionEnumeration associated with this attribute value

Returns:

the DatatypeDefinitionEnumeration object associated with this object, not null

getValues

public java.lang.String[] getValues()

Returns the collection of EnumValue objects as a String[] array of individual EnumValue @LONG-NAME attribute values.

Returns:

a String[] array of contained EnumValue @LONG-NAME attribute values, not null

getDisplayText

public java.lang.String getDisplayText()

Returns the collection of EnumValue objects as a single String composed from individual EnumValue @LONG-NAME attribute values and comma delimited.

Specified by:

getDisplayText in class AttributeValue

Returns:

a single String composed from each EnumValue @LONG-NAME attribute value and comma delimited, not null

getValue

public java.lang.Object getValue()

Returns the native value as Object

Specified by:

getValue in class AttributeValue

Returns:

the EnumValue value collection as Object