com.reqdesign.reqif

Class SpecifiedValues

java.lang.Object

com.reqdesign.reqif.SpecifiedValues

All Implemented Interfaces:

java.lang.Iterable<EnumValue>

public final class SpecifiedValues
extends java.lang.Object

Class representing the ReqIF SPECIFIED-VALUES XML element The DatatypeDefinitionEnumeration class defines a member of this class

Method Summary

Modifier and Type	Method and Description
boolean	contains(EnumValue enumValue) Checks whether the specified EnumValue exists in this collection.
boolean	containsIdentifiableWithLongName(java.lang.String longName) Checks for existence of an Identifiable in this collection with the specified longName.
boolean	containsKey(java.lang.String identifier) Checks whether this collection contains the Identifiable whose identfier matches that specified in the argument
EnumValue	createEnumValue(java.lang.String desc, java.util.Date lastChange, java.lang.String longName, java.lang.String identifier, java.lang.String alternativeID, long key, java.lang.String otherContent) Constructs a EnumValue objects and adds it to this object.
EnumValue	find(java.lang.String longName) Returns the first occurrence of an EnumValue object with the specified longName that is contained in this collection.
EnumValue	get(int index) Returns the EnumValue object at the specified index that is contained in this collection.
EnumValue	get(java.lang.String identifier) Returns the EnumValue object with the specified identifier that is contained in this collection.
int	getCount() Returns the count of items in this collection.
java.util.Iterator<EnumValue>	iterator()
void	remove(EnumValue enumValue) Removes an EnumValue object from this collection.
java.util.stream.Stream<EnumValue>	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

createEnumValue

public EnumValue createEnumValue(java.lang.String desc,
                                 java.util.Date lastChange,
                                 java.lang.String longName,
                                 java.lang.String identifier,
                                 java.lang.String alternativeID,
                                 long key,
                                 java.lang.String otherContent)
                          throws InvalidValueException,
                                 DuplicateIdentifierException,
                                 InvalidIdentifierException,
                                 NotFoundException

Constructs a EnumValue objects and adds it to this object.

Parameters:

desc - the value to be assigned to the DESC attribute, can be null

lastChange - the date value to be assigned to the LAST-CHANGE attribute, can be null in which case 'now' is assigned

longName - the value to be assigned to the LONG-NAME attribute, can be null

identifier - the identifier to assign to this object, can be null to auto-assign

alternativeID - the value to be assigned to the ALTERNATIVE-ID::IDENTIFIER attribute, can be null

key - the value to be assigned to the PROPERTIES::EMBEDDED-VALUE::KEY attribute, not null

otherContent - the value to be assigned to the PROPERTIES::EMBEDDED-VALUE::OTHER-CONTENT attribute, not null

Returns:

the created EnumValue object, not null

Throws:

DuplicateIdentifierException - if the specified identifier is not unique

InvalidValueException - if otherContent is null

InvalidIdentifierException - if the specified identifier is not valid xsd:ID format

NotFoundException - if the owning DatatypeDefinitionEnumeration has been removed from the Datatypes collection

remove

public void remove(EnumValue enumValue)
            throws NotFoundException,
                   ReferencedException

Removes an EnumValue object from this collection.

Parameters:

enumValue - the EnumValue object to remove, not null

Throws:

NotFoundException - if the specified EnumValue object is not in the collection or the owning DatatypeDefinitionEnumeration has been removed from the Datatypes collection

ReferencedException - if the specified EnumValue object is referenced in other AttributeDefinition or AttributeValue objects

stream

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

iterator

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

Specified by:

iterator in interface java.lang.Iterable<EnumValue>

get

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

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

Parameters:

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

Returns:

the EnumValue object at the specified index

Throws:

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

get

public EnumValue get(java.lang.String identifier)
              throws UnknownIdentifierException

Returns the EnumValue object with the specified identifier that is contained in this collection.

Parameters:

identifier - the identifier of the collection member to return

Returns:

the EnumValue subclass with the specified identifier

Throws:

UnknownIdentifierException - if the object identified by the Identifier parameter can't be found

find

public EnumValue find(java.lang.String longName)

Returns the first occurrence of an EnumValue object with the specified longName that is contained in this collection.

Parameters:

longName - the longName of the EnumValue to return, not null

Returns:

the first occurrence of an EnumValue subclass with the specified longName, can be null

contains

public boolean contains(EnumValue enumValue)

Checks whether the specified EnumValue exists in this collection.

Parameters:

enumValue - the EnumValue to check, not null

Returns:

returns true if the specified enumValue exists, false otherwise

containsKey

public boolean containsKey(java.lang.String identifier)

Checks whether this collection contains the Identifiable whose identfier matches that specified in the argument

Parameters:

identifier - the identifier of the member to check for occurrence in the collection, not null

Returns:

true if the member having the specified identifier exists in the collection

containsIdentifiableWithLongName

public boolean containsIdentifiableWithLongName(java.lang.String longName)

Checks for existence of an Identifiable in this collection with the specified longName.

Parameters:

longName - the value of longName to check, nullable since longName can be null

Returns:

True if an Identifiable with the specified longName exists in this collection, otherwise false

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