com.reqdesign.reqif

Class DatatypeDefinitionString

java.lang.Object

com.reqdesign.reqif.Identifiable<DatatypeDefinition>

com.reqdesign.reqif.DatatypeDefinition

com.reqdesign.reqif.DatatypeDefinitionString

public final class DatatypeDefinitionString
extends DatatypeDefinition

This class defines the primitive String data type.

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

<DATATYPE-DEFINITION-STRING DESC="desc" IDENTIFIER="identifier" LAST-CHANGE="lastChange" LONG-NAME="longName" MAX-LENGTH="maxLength">

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-LENGTH required xsd:integer specifies the maximum value allowed to be specified for any string based on this datatype

Method Summary

Modifier and Type	Method and Description
long	getMaxLength() Gets the @MAX-LENGTH attribute value for this DatatypeDefinitionString object.
java.lang.String	getMaxLengthText() Returns the String representation for the MAX-LENGTH attribute odf this DatatypeDefinitionString.
void	setMaxLength(long maxLength) Sets the @MAX_LENGTH attribute for this DatatypeDefinitionString object.

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

getMaxLength

public long getMaxLength()

Gets the @MAX-LENGTH attribute value for this DatatypeDefinitionString object.

Returns:

the value assigned to the @MAX-LENGTH attribute

getMaxLengthText

public java.lang.String getMaxLengthText()

Returns the String representation for the MAX-LENGTH attribute odf this DatatypeDefinitionString.

Returns:

the String representation for the MAX-LENGTH attribute.

setMaxLength

public void setMaxLength(long maxLength)
                  throws InvalidValueException,
                         NotFoundException

Sets the @MAX_LENGTH attribute for this DatatypeDefinitionString object.

When setting this value, consider any existing AttributeDefinitionReal objects associated with a SpecType subclasses that may have specified a default String value based on this DatatypeDefinitionString object with lengths greater than this value. Similarly there may be existing AttributeValueString objects also with String values with lengths greater than this value. Any attempt to set this value below and existing string length will cause an InvalidValueException to be raised.

Parameters:

maxLength - the value to set for the @MAX-LENGTH attribute

Throws:

InvalidValueException - if the specified value is negative or lower than any existing AttributeValueString that is linked to this datatype definition.

NotFoundException - if the DatatypeDefinitionString is not in the Datatypes collection