com.reqdesign.reqif

Class DatatypeDefinitionInteger

java.lang.Object

com.reqdesign.reqif.Identifiable<DatatypeDefinition>

com.reqdesign.reqif.DatatypeDefinition

com.reqdesign.reqif.DatatypeDefinitionInteger

public final class DatatypeDefinitionInteger
extends DatatypeDefinition

This class defines the primitive Integer data type.

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

<DATATYPE-DEFINITION-INTEGER DESC="desc" IDENTIFIER="identifier" LAST-CHANGE="lastChange" LONG-NAME="longName" MAX="max" MIN="min">

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
• @MAX required xsd:integer specifies the maximum value allowed to be specified for this datatype
• @MIN required xsd:integer specifies the minimum value allowed to be specified for this datatype

Method Summary

Modifier and Type	Method and Description
long	getMax() Returns the value of the @MAX attribute for this DatatypeDefinitionInteger object.
java.lang.String	getMaxText() Returns the MAX attribute value as it is represented in the ReqIF XML file.
long	getMin() Returns the value of the @MIN attribute for this DatatypeDefinitionInteger object.
java.lang.String	getMinText() Returns the MIN attribute value as it is represented in the ReqIF XML file.
void	setMax(long max) Sets the value of the @MAX attribute to the specified value.
void	setMin(long min) Sets the value of the @MIN attribute to the specified value.

Methods inherited from class com.reqdesign.reqif.DatatypeDefinition

getDatatypeName, 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

getMax

public long getMax()

Returns the value of the @MAX attribute for this DatatypeDefinitionInteger object.

Returns:

the value of the @MAX attribute

getMaxText

public java.lang.String getMaxText()

Returns the MAX attribute value as it is represented in the ReqIF XML file.

Returns:

the String representation in the ReqIF file for the MAX attribute

getMinText

public java.lang.String getMinText()

Returns the MIN attribute value as it is represented in the ReqIF XML file.

Returns:

the String representation in the ReqIF file for the MIN attribute

setMax

public void setMax(long max)
            throws InvalidValueException,
                   NotFoundException

Sets the value of the @MAX attribute to the specified value.

When setting this value, consider any existing AttributeDefinitionInteger objects associated with a SpecType subclasses that may have specified a default long value based on this DatatypeDefinitionInteger object wthat is greater than this value. Similarly there may be existing AttributeValueInteger objects also with long values greater than this value. Any attempt to set this value exceeding any existing instance will cause an InvalidValueException to be raised.

Parameters:

max - the value to set for the @MAX attribute

Throws:

InvalidValueException - if the value is lower than the current @MIN attribute or any existing attribute values or default values that are linked to this DatatypeDefinitionInteger object

NotFoundException - if the DatatypeDefinitionInteger is not in the Datatypes collection

getMin

public long getMin()

Returns the value of the @MIN attribute for this DatatypeDefinitionInteger object.

Returns:

the value of the @MIN attribute

setMin

public void setMin(long min)
            throws InvalidValueException,
                   NotFoundException

Sets the value of the @MIN attribute to the specified value.

When setting this value, consider any existing AttributeDefinitionInteger objects associated with a SpecType subclasses that may have specified a default long value based on this DatatypeDefinitionInteger object that is lower than this value. Similarly there may be existing AttributeValueInteger objects also with long values lower than this value. Any attempt to set this value below any existing instance will cause an InvalidValueException to be raised.

Parameters:

min - the value to set for the @MIN attribute

Throws:

InvalidValueException - if the value is greater than the current @MAX attribute or any existing attribute values or default values that are linked to this DatatypeDefinitionInteger object

NotFoundException - if the DatatypeDefinitionInteger is not in the Datatypes collection