com.reqdesign.reqif

Class AttributeDefinitionBoolean

java.lang.Object

com.reqdesign.reqif.Identifiable<AttributeDefinition<T>>

com.reqdesign.reqif.AttributeDefinition<AttributeValueBoolean>

com.reqdesign.reqif.AttributeDefinitionBoolean

public final class AttributeDefinitionBoolean
extends AttributeDefinition<AttributeValueBoolean>

This class is the definition of a boolean attribute.

This class extends from the base class AttributeDefinition.

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

<ATTRIBUTE-DEFINITION-BOOLEAN DESC="desc" IS-EDITABLE="isEditable" IDENTIFIER="identifier" LAST-CHANGE="lastChange" LONG-NAME="longName">

The following is the list of XML attributes:

• @DESC optional xsd:string description
• @IS-EDITABLE optional xsd:boolean, if not specified, false is assumed
• @IDENTIFIER required xsd:ID
• @LAST-CHANGE required xsd:dateTime
• @LONG-NAME required xsd:string (Note: currently the reqif.xsd does not enforce this)

Method Summary

Modifier and Type	Method and Description
DatatypeDefinitionBoolean	getDatatypeDefinitionBoolean() Type specific getter for the associated DatatypeDefinition subclass.
AttributeValueBoolean	getDefaultValue() The default value which can be assigned by the exporting tool if one is specified.
void	setDefaultValue(boolean theValue) Sets the default value for this object.

Methods inherited from class com.reqdesign.reqif.AttributeDefinition

getDatatypeDefinition, getSpecType, hasDefaultValue, isEditable, removeDefaultValue, setIsEditable, toString

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

getDatatypeDefinitionBoolean

public DatatypeDefinitionBoolean getDatatypeDefinitionBoolean()

Type specific getter for the associated DatatypeDefinition subclass.

Returns:

the associated DatatypeDefinitionBoolean object, not null

getDefaultValue

public AttributeValueBoolean getDefaultValue()

The default value which can be assigned by the exporting tool if one is specified.

If, during import, an AttributeValueBoolean is not specified for a particular SpecElementWithAttributes, and corresponding AttributeDefinitionBoolean on the associated SpecType, then the default value if one exists will be the substitute for the missing value otherwise the value null is assumed meaning 'unset'.

Specified by:

getDefaultValue in class AttributeDefinition<AttributeValueBoolean>

Returns:

the default value for this AttributeDefinitionBoolean

setDefaultValue

public void setDefaultValue(boolean theValue)
                     throws NotFoundException

Sets the default value for this object.
See AttributeDefinition.removeDefaultValue() to unset the default.

Parameters:

theValue - the boolean value to set as the default

Throws:

NotFoundException - if this AttributeDefinitionBoolean has been removed from its SpecType