com.reqdesign.reqif

Class AttributeValues

java.lang.Object

com.reqdesign.reqif.AttributeValues

All Implemented Interfaces:

java.lang.Iterable<AttributeValue>

public final class AttributeValues
extends java.lang.Object

The collection class for AttributeValue objects.

An instance of this class is contained in a SpecElementWithAttributes object.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all AttributeValue objects from this AttributeValues collection.
boolean	contains(AttributeValue attributeValue) Checks whether the specified AttributeValue exists in this collection.
AttributeValueBoolean	createAttributeValue(AttributeDefinitionBoolean attributeDefinitionBoolean, boolean theValue) Creates and adds an AttributeValueBoolean based on the specified AttributeDefinitionBoolean parameter and adds it to the collection of host which is either an instance of a Specification, SpecObject or SpecRelation object.
AttributeValueDate	createAttributeValue(AttributeDefinitionDate attributeDefinitionDate, java.util.Date dateValue) Creates and adds an AttributeValueDate based on the specified AttributeDefinitionDate parameter and adds it to the collection of host which is either an instance of a Specification, SpecObject or SpecRelation object.
AttributeValueEnumeration	createAttributeValue(AttributeDefinitionEnumeration attributeDefinitionEnumeration, EnumValue... theValues) Creates and adds an AttributeValueEnumeration based on the specified AttributeDefinitionEnumeration parameter and adds it to the collection of host which is either an instance of a Specification, SpecObject or SpecRelation object.
AttributeValueInteger	createAttributeValue(AttributeDefinitionInteger attributeDefinitionInteger, long theValue) Creates and adds an AttributeValueInteger based on the specified AttributeDefinitionInteger parameter and adds it to the collection of host which is either an instance of a Specification, SpecObject or SpecRelation object.
AttributeValueReal	createAttributeValue(AttributeDefinitionReal attributeDefinitionReal, double theValue) Creates and adds an AttributeValueReal based on the specified AttributeDefinitionReal parameter and adds it to the collection of host which is either an instance of a Specification, SpecObject or SpecRelation object.
AttributeValueString	createAttributeValue(AttributeDefinitionString attributeDefinitionString, java.lang.String theValue) Creates and adds an AttributeValueString based on the specified AttributeDefinitionString parameter and adds it to the collection of host which is either an instance of a Specification, SpecObject or SpecRelation object.
AttributeValueXHTML	createAttributeValue(AttributeDefinitionXHTML attributeDefinitionXHTML, org.w3c.dom.Element theValue) Creates and adds an AttributeValueXHTML based on the specified AttributeDefinitionXHTML parameter and adds it to the collection of host which is either an instance of a Specification, SpecObject or SpecRelation object.
AttributeValueXHTML	createAttributeValue(AttributeDefinitionXHTML attributeDefinitionXHTML, org.w3c.dom.Element theValue, java.util.function.Consumer<ValidationMessage> validationMessageConsumer) Creates and adds an AttributeValueXHTML based on the specified AttributeDefinitionXHTML parameter and adds it to the collection of host which is either an instance of a Specification, SpecObject or SpecRelation object (with validation).
AttributeValueXHTML	createAttributeValue(AttributeDefinitionXHTML attributeDefinitionXHTML, org.w3c.dom.Element theValue, org.w3c.dom.Element theOriginalValue, boolean isSimplified) Creates and adds an AttributeValueXHTML based on the specified AttributeDefinitionXHTML parameter and adds it to the collection of host which is either an instance of a Specification, SpecObject or SpecRelation object.
AttributeValueXHTML	createAttributeValue(AttributeDefinitionXHTML attributeDefinitionXHTML, org.w3c.dom.Element theValue, org.w3c.dom.Element theOriginalValue, boolean isSimplified, java.util.function.Consumer<ValidationMessage> validationMessageConsumer) Creates and adds an AttributeValueXHTML based on the specified AttributeDefinitionXHTML parameter and adds it to the collection of host which is either an instance of a Specification, SpecObject or SpecRelation object (with validation).
AttributeValue	get(AttributeDefinition<?> attributeDefinition) Returns the AttributeValue associated with the specified AttributeDefinition.
AttributeValue	get(int index) Returns the AttributeValue object at the specified index that is contained in this collection.
int	getCount() Returns the count of items in this collection.
java.util.Iterator<AttributeValue>	iterator()
void	remove(AttributeValue attributeValue) Removes the specified AttributeValue from the AttributeValues collection
java.util.stream.Stream<AttributeValue>	stream()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

stream

public java.util.stream.Stream<AttributeValue> stream()

iterator

public java.util.Iterator<AttributeValue> iterator()

Specified by:

iterator in interface java.lang.Iterable<AttributeValue>

get

public AttributeValue get(int index)
                   throws java.lang.IndexOutOfBoundsException

Returns the AttributeValue object at the specified index that is contained in this collection.

Parameters:

index - the index of the AttributeValue to return from the collection, >= 0 and < collection size

Returns:

the AttributeValue object at the specified index

Throws:

java.lang.IndexOutOfBoundsException - if the index is < 0 or >= count

contains

public boolean contains(AttributeValue attributeValue)

Checks whether the specified AttributeValue exists in this collection.

Parameters:

attributeValue - the AttributeValue to check, not null

Returns:

returns true if the specified attributeValue exists, false otherwise

createAttributeValue

public AttributeValueBoolean createAttributeValue(AttributeDefinitionBoolean attributeDefinitionBoolean,
                                                  boolean theValue)
                                           throws AlreadyExistsException,
                                                  NotFoundException

Creates and adds an AttributeValueBoolean based on the specified AttributeDefinitionBoolean parameter and adds it to the collection of host which is either an instance of a Specification, SpecObject or SpecRelation object.

The AttributeDefinitionBoolean parameter must be obtained from the SpecType subclass object that is associated with this host object.

Parameters:

attributeDefinitionBoolean - the AttributeDefinitionBoolean object on which to base the value to create. It must be obtained from the host's SpecType object. (Not null)

theValue - the boolean value to set

Returns:

the created AttributeValueBoolean object, not null

Throws:

NotFoundException - if the specified AttributeDefinitionBoolean object is not a member of the host's SpecType object

AlreadyExistsException - if an attribute with the specified AttributeDefinitionBoolean has already been added to this AttributeValues collection

createAttributeValue

public AttributeValueDate createAttributeValue(AttributeDefinitionDate attributeDefinitionDate,
                                               java.util.Date dateValue)
                                        throws NotFoundException,
                                               AlreadyExistsException

Creates and adds an AttributeValueDate based on the specified AttributeDefinitionDate parameter and adds it to the collection of host which is either an instance of a Specification, SpecObject or SpecRelation object.

The AttributeDefinitionDate parameter must be obtained from the SpecType subclass object that is associated with this host object.

Parameters:

attributeDefinitionDate - the AttributeDefinitionDate object on which to base the value to create. It must be obtained from the host's SpecType object. (Not null)

dateValue - the Date value to set, not null

Returns:

the created AttributeValueDate object, not null

Throws:

NotFoundException - if the specified AttributeDefinitionDate object is not a member of the host's SpecType object.

AlreadyExistsException - if an attribute with the specified AttributeDefinitionDate has already been added to this AttributeValues collection

createAttributeValue

public AttributeValueEnumeration createAttributeValue(AttributeDefinitionEnumeration attributeDefinitionEnumeration,
                                                      EnumValue... theValues)
                                               throws InvalidValueException,
                                                      NotFoundException,
                                                      AlreadyExistsException

Creates and adds an AttributeValueEnumeration based on the specified AttributeDefinitionEnumeration parameter and adds it to the collection of host which is either an instance of a Specification, SpecObject or SpecRelation object.

The AttributeDefinitionEnumeration parameter must be obtained from the SpecType subclass object that is associated with this host object.

Parameters:

attributeDefinitionEnumeration - the AttributeDefinitionEnumeration object on which to base the value to create. It must be obtained from the host's SpecType object. (Not null)

theValues - the EnumValue values to set

Returns:

the created AttributeValueEnumeration object, not null

Throws:

NotFoundException - if the specified AttributeDefinitionEnumeration object is not a member of the host's SpecType object.

AlreadyExistsException - if an attribute with the specified AttributeDefinitionEnumeration has already been added to this AttributeValues collection

InvalidValueException - if more enumValue objects are specified than are allowed by the AttributeDefinitionEnumeration

createAttributeValue

public AttributeValueInteger createAttributeValue(AttributeDefinitionInteger attributeDefinitionInteger,
                                                  long theValue)
                                           throws InvalidValueException,
                                                  AlreadyExistsException,
                                                  NotFoundException

Creates and adds an AttributeValueInteger based on the specified AttributeDefinitionInteger parameter and adds it to the collection of host which is either an instance of a Specification, SpecObject or SpecRelation object.

The AttributeDefinitionInteger parameter must be obtained from the SpecType subclass object that is associated with this host object.

Parameters:

attributeDefinitionInteger - the AttributeDefinitionInteger object on which to base the value to create. It must be obtained from the host's SpecType object. (Not null)

theValue - the int value to set

Returns:

the created AttributeValueInteger object, not null

Throws:

NotFoundException - if the specified AttributeDefinitionInteger object is not a member of the host's SpecType object.

AlreadyExistsException - if an attribute with the specified AttributeDefinitionInteger has already been added to this AttributeValues collection

InvalidValueException - if the theValue value is outside the range permitted by the associated DatatypeDefinitionInteger

createAttributeValue

public AttributeValueReal createAttributeValue(AttributeDefinitionReal attributeDefinitionReal,
                                               double theValue)
                                        throws NotFoundException,
                                               InvalidValueException,
                                               AlreadyExistsException

Creates and adds an AttributeValueReal based on the specified AttributeDefinitionReal parameter and adds it to the collection of host which is either an instance of a Specification, SpecObject or SpecRelation object.

The AttributeDefinitionReal parameter must be obtained from the SpecType subclass object that is associated with this host object.

Parameters:

attributeDefinitionReal - the AttributeDefinitionReal object on which to base the value to create. It must be obtained from the host's SpecType object. (Not null)

theValue - the double value to set

Returns:

the created AttributeValueReal object, not null

Throws:

NotFoundException - if the specified AttributeDefinitionReal object is not a member of the host's SpecType object.

AlreadyExistsException - if an attribute with the specified AttributeDefinitionReal has already been added to this AttributeValues collection

InvalidValueException - if the theValue value is outside the range permitted by the associated DatatypeDefinitionReal

createAttributeValue

public AttributeValueString createAttributeValue(AttributeDefinitionString attributeDefinitionString,
                                                 java.lang.String theValue)
                                          throws NotFoundException,
                                                 InvalidValueException,
                                                 AlreadyExistsException

Creates and adds an AttributeValueString based on the specified AttributeDefinitionString parameter and adds it to the collection of host which is either an instance of a Specification, SpecObject or SpecRelation object.

The AttributeDefinitionString parameter must be obtained from the SpecType subclass object that is associated with this host object.

Parameters:

attributeDefinitionString - the AttributeDefinitionString object on which to base the value to create. It must be obtained from the host's SpecType object. (Not null)

theValue - the String value to set

Returns:

the created AttributeValueString object, not null

Throws:

NotFoundException - if the specified AttributeDefinitionString object is not a member of the host's SpecType object.

AlreadyExistsException - if an attribute with the specified AttributeDefinitionString has already been added to this AttributeValues collection

InvalidValueException - if the theValue string is longer than that permitted by the associated DatatypeDefinitionString

createAttributeValue

public AttributeValueXHTML createAttributeValue(AttributeDefinitionXHTML attributeDefinitionXHTML,
                                                org.w3c.dom.Element theValue,
                                                org.w3c.dom.Element theOriginalValue,
                                                boolean isSimplified,
                                                java.util.function.Consumer<ValidationMessage> validationMessageConsumer)
                                         throws NotFoundException,
                                                ValidationException,
                                                AlreadyExistsException

Creates and adds an AttributeValueXHTML based on the specified AttributeDefinitionXHTML parameter and adds it to the collection of host which is either an instance of a Specification, SpecObject or SpecRelation object (with validation).

The AttributeDefinitionXHTML parameter must be obtained from the SpecType subclass object that is associated with this host object.

Parameters:

attributeDefinitionXHTML - the AttributeDefinitionXHTML object on which to base the value to create. It must be obtained from the host's SpecType object. (Not null)

theValue - the Element value to set as the theValue ReqIF XHTML content, not null

theOriginalValue - the Element value to set as the theOriginalValue ReqIF XHTML content, can be null

isSimplified - true or false to set as the @IS-SIMPLIFIED attribute

validationMessageConsumer - a consumer of validation messages, not null

Returns:

the created AttributeValueXHTML object, not null

Throws:

NotFoundException - if the specified AttributeDefinitionXHTML object is not a member of the host's SpecType object.

AlreadyExistsException - if an attribute with the specified AttributeDefinitionXHTML has already been added to this AttributeValues collection

ValidationException - if either the theValue or theOriginalValue Element values do not conform to ReqIF XHTML standards

createAttributeValue

public AttributeValueXHTML createAttributeValue(AttributeDefinitionXHTML attributeDefinitionXHTML,
                                                org.w3c.dom.Element theValue)
                                         throws NotFoundException,
                                                ValidationException,
                                                AlreadyExistsException

Creates and adds an AttributeValueXHTML based on the specified AttributeDefinitionXHTML parameter and adds it to the collection of host which is either an instance of a Specification, SpecObject or SpecRelation object.

The AttributeDefinitionXHTML parameter must be obtained from the SpecType subclass object that is associated with this host object.

The THE-ORIGINAL-VALUE ReqIF XHTML content is unspecified.

The @IS-SIMPLIFIED attribute is set to false.

Parameters:

attributeDefinitionXHTML - the AttributeDefinitionXHTML object on which to base the value to create. It must be obtained from the host's SpecType object. (Not null)

theValue - the Element value to set as the theValue ReqIF XHTML content, not null

Returns:

the created AttributeValueXHTML object, not null

Throws:

NotFoundException - if the specified AttributeDefinitionXHTML object is not a member of the host's SpecType object.

AlreadyExistsException - if an attribute with the specified AttributeDefinitionXHTML has already been added to this AttributeValues collection

ValidationException - if either the theValue or theOriginalValue Element values do not conform to ReqIF XHTML standards

createAttributeValue

public AttributeValueXHTML createAttributeValue(AttributeDefinitionXHTML attributeDefinitionXHTML,
                                                org.w3c.dom.Element theValue,
                                                java.util.function.Consumer<ValidationMessage> validationMessageConsumer)
                                         throws NotFoundException,
                                                ValidationException,
                                                AlreadyExistsException

Creates and adds an AttributeValueXHTML based on the specified AttributeDefinitionXHTML parameter and adds it to the collection of host which is either an instance of a Specification, SpecObject or SpecRelation object (with validation).

The AttributeDefinitionXHTML parameter must be obtained from the SpecType subclass object that is associated with this host object.

The THE-ORIGINAL-VALUE ReqIF XHTML content is unspecified.

The @IS-SIMPLIFIED attribute is set to false.

Parameters:

attributeDefinitionXHTML - the AttributeDefinitionXHTML object on which to base the value to create. It must be obtained from the host's SpecType object. (Not null)

theValue - the Element value to set as the theValue ReqIF XHTML content, not null

validationMessageConsumer - a consumer of validation message objects ValidationMessage, not null

Returns:

the created AttributeValueXHTML object, not null

Throws:

NotFoundException - if the specified AttributeDefinitionXHTML object is not a member of the host's SpecType object.

AlreadyExistsException - if an attribute with the specified AttributeDefinitionXHTML has already been added to this AttributeValues collection

ValidationException - if either the theValue or theOriginalValue Element values do not conform to ReqIF XHTML standards

createAttributeValue

public AttributeValueXHTML createAttributeValue(AttributeDefinitionXHTML attributeDefinitionXHTML,
                                                org.w3c.dom.Element theValue,
                                                org.w3c.dom.Element theOriginalValue,
                                                boolean isSimplified)
                                         throws NotFoundException,
                                                ValidationException,
                                                AlreadyExistsException

Creates and adds an AttributeValueXHTML based on the specified AttributeDefinitionXHTML parameter and adds it to the collection of host which is either an instance of a Specification, SpecObject or SpecRelation object.

The AttributeDefinitionXHTML parameter must be obtained from the SpecType subclass object that is associated with this host object.

Parameters:

attributeDefinitionXHTML - the AttributeDefinitionXHTML object on which to base the value to create. It must be obtained from the host's SpecType object. (Not null)

theValue - the Element value to set as the theValue ReqIF XHTML content, not null

theOriginalValue - the Element value to set as the theOriginalValue ReqIF XHTML content, can be null

isSimplified - true or false to set as the @IS-SIMPLIFIED attribute

Returns:

the created AttributeValueXHTML object, not null

Throws:

NotFoundException - if the specified AttributeDefinitionXHTML object is not a member of the host's SpecType object.

AlreadyExistsException - if an attribute with the specified AttributeDefinitionXHTML has already been added to this AttributeValues collection

ValidationException - if either the theValue or theOriginalValue Element values do not conform to ReqIF XHTML standards

get

public AttributeValue get(AttributeDefinition<?> attributeDefinition)
                   throws NotFoundException

Returns the AttributeValue associated with the specified AttributeDefinition.

Parameters:

attributeDefinition - the AttributeDefinition of the AttributeValue to return

Returns:

the AttributeValue associated with the specified AttributeDefinition, can be null

Throws:

NotFoundException - if the attributeDefinition is not found in this object's SpecType

clear

public void clear()

Removes all AttributeValue objects from this AttributeValues collection.

remove

public void remove(AttributeValue attributeValue)
            throws NotFoundException

Removes the specified AttributeValue from the AttributeValues collection

Parameters:

attributeValue - the AttributeValue to remove, not null

Throws:

NotFoundException - if the specified AttributeValue was not found

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getCount

public int getCount()

Returns the count of items in this collection.

Returns:

the collection size