com.reqdesign.reqif

Class SpecTypes

java.lang.Object

com.reqdesign.reqif.SpecTypes

All Implemented Interfaces:

java.lang.Iterable<SpecType>

public final class SpecTypes
extends java.lang.Object

This class models the SPEC-TYPES element in ReqIF XML.

This is the collection of SPEC-TYPE subclasses:-

  <SPEC-TYPES>
          <RELATION-GROUP-TYPE IDENTIFIER="..." LAST-CHANGE="..." />
          <SPEC-OBJECT-TYPE IDENTIFIER="..." LAST-CHANGE="..." />
          <SPEC-RELATION IDENTIFIER="..." LAST-CHANGE="..." />
          <SPECIFICATION-TYPE IDENTIFIER="..." LAST-CHANGE="..." />
  </SPEC-TYPES>
 

Method Summary

Modifier and Type	Method and Description
boolean	contains(SpecType specType) Checks whether the specified SpecType 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
RelationGroupType	createRelationGroupType(java.lang.String desc, java.util.Date lastChange, java.lang.String longName, java.lang.String identifier, java.lang.String alternativeID) Constructs a new RelationGroupType and adds it to this ReqIF.
SpecificationType	createSpecificationType(java.lang.String desc, java.util.Date lastChange, java.lang.String longName, java.lang.String identifier, java.lang.String alternativeID) Constructs a new SpecificationType and adds it to this ReqIF.
SpecObjectType	createSpecObjectType(java.lang.String desc, java.util.Date lastChange, java.lang.String longName, java.lang.String identifier, java.lang.String alternativeID) Constructs a new SpecObjectType and adds it to this ReqIF.
SpecRelationType	createSpecRelationType(java.lang.String desc, java.util.Date lastChange, java.lang.String longName, java.lang.String identifier, java.lang.String alternativeID) Constructs a new SpecRelationType and adds it to this ReqIF.
SpecType	find(java.lang.String longName) Returns the first occurrence of a SpecType object with the specified longName that is contained in this collection.
SpecType	get(int index) Returns the SpecType object at the specified index that is contained in this collection.
SpecType	get(java.lang.String identifier) Returns the SpecType object with the specified identifier that is contained in this collection.
int	getCount() Returns the count of items in this collection.
java.util.Iterator<SpecType>	iterator()
void	remove(SpecType specType) Removes a SpecType object from this collection.
java.util.stream.Stream<SpecType>	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<SpecType> stream()

iterator

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

Specified by:

iterator in interface java.lang.Iterable<SpecType>

get

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

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

Parameters:

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

Returns:

the SpecType object at the specified index

Throws:

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

get

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

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

Parameters:

identifier - the identifier of the collection member to return

Returns:

the SpecType subclass with the specified identifier

Throws:

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

find

public SpecType find(java.lang.String longName)

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

Parameters:

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

Returns:

the first occurrence of a SpecType subclass with the specified longName, can be null

contains

public boolean contains(SpecType specType)

Checks whether the specified SpecType exists in this collection.

Parameters:

specType - the SpecType to check, not null

Returns:

returns true if the specified specType exists, false otherwise

remove

public void remove(SpecType specType)
            throws NotFoundException,
                   ReferencedException

Removes a SpecType object from this collection.

Parameters:

specType - the SpecType object to remove, not null

Throws:

NotFoundException - if the specified specType object is not in the collection

ReferencedException - if the specified specType object is referenced in other SpecElementWithAttributes objects

createRelationGroupType

public RelationGroupType createRelationGroupType(java.lang.String desc,
                                                 java.util.Date lastChange,
                                                 java.lang.String longName,
                                                 java.lang.String identifier,
                                                 java.lang.String alternativeID)
                                          throws DuplicateIdentifierException,
                                                 InvalidIdentifierException

Constructs a new RelationGroupType and adds it to this ReqIF.

Since LONG-NAME is optional it is permitted to create multiple SpecType objects with the same LONG-NAME.

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

Returns:

the created RelationGroupType, not null

Throws:

DuplicateIdentifierException - if the specified identifier is not unique

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

createSpecificationType

public SpecificationType createSpecificationType(java.lang.String desc,
                                                 java.util.Date lastChange,
                                                 java.lang.String longName,
                                                 java.lang.String identifier,
                                                 java.lang.String alternativeID)
                                          throws DuplicateIdentifierException,
                                                 InvalidIdentifierException

Constructs a new SpecificationType and adds it to this ReqIF.

Since LONG-NAME is optional it is permitted to create multiple SpecType objects with the same LONG-NAME.

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

Returns:

the created SpecificationType, not null

Throws:

DuplicateIdentifierException - if the specified identifier is not unique

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

createSpecObjectType

public SpecObjectType createSpecObjectType(java.lang.String desc,
                                           java.util.Date lastChange,
                                           java.lang.String longName,
                                           java.lang.String identifier,
                                           java.lang.String alternativeID)
                                    throws DuplicateIdentifierException,
                                           InvalidIdentifierException

Constructs a new SpecObjectType and adds it to this ReqIF.

Since LONG-NAME is optional it is permitted to create multiple SpecType objects with the same LONG-NAME.

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

Returns:

the created SpecObjectType, not null

Throws:

DuplicateIdentifierException - if the specified identifier is not unique

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

createSpecRelationType

public SpecRelationType createSpecRelationType(java.lang.String desc,
                                               java.util.Date lastChange,
                                               java.lang.String longName,
                                               java.lang.String identifier,
                                               java.lang.String alternativeID)
                                        throws DuplicateIdentifierException,
                                               InvalidIdentifierException

Constructs a new SpecRelationType and adds it to this ReqIF.

Since LONG-NAME is optional it is permitted to create multiple SpecType objects with the same LONG-NAME.

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

Returns:

the created SpecRelationType, not null

Throws:

DuplicateIdentifierException - if the specified identifier is not unique

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

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