com.reqdesign.reqif

Class SpecObjects

java.lang.Object

com.reqdesign.reqif.SpecObjects

All Implemented Interfaces:

java.lang.Iterable<SpecObject>

public final class SpecObjects
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
boolean	contains(SpecObject specObject) Checks whether the specified SpecObject 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
SpecObject	createSpecObject(SpecObjectType specObjectType, java.lang.String desc, java.util.Date lastChange, java.lang.String longName, java.lang.String identifier, java.lang.String alternativeId) Creates a SpecObject
SpecObject	find(java.lang.String longName) Returns the first occurrence of a SpecObject object with the specified longName that is contained in this collection.
SpecObject	get(int index) Returns the SpecObject object at the specified index that is contained in this collection.
SpecObject	get(java.lang.String identifier) Returns the SpecObject object with the specified identifier that is contained in this collection.
int	getCount() Returns the count of items in this collection.
java.util.Iterator<SpecObject>	iterator()
void	remove(SpecObject specObject) Removes a SpecObject object from this collection.
void	removeAll() Removes all SpecObject objects from this collection.
java.util.stream.Stream<SpecObject>	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

createSpecObject

public SpecObject createSpecObject(SpecObjectType specObjectType,
                                   java.lang.String desc,
                                   java.util.Date lastChange,
                                   java.lang.String longName,
                                   java.lang.String identifier,
                                   java.lang.String alternativeId)
                            throws DuplicateIdentifierException,
                                   InvalidIdentifierException

Creates a SpecObject

Parameters:

specObjectType - the SpecObjectType for this SpecObject, not null

desc - the String value to sert for the description property, can be null

lastChange - the Date value to set for the lastChange property, set to null for 'now'

longName - the String value to set for the longName property, can be null

identifier - the String value to set for the identifier property (must confirm to xsd:ID), set to null to autogenerate

alternativeId - the String value to set for the alternativeId property, can be null

Returns:

a reference to the created SpecObject, not null

Throws:

DuplicateIdentifierException - if the specified identifier is already used in this ReqIF file

InvalidIdentifierException - if the specified identifier does not confrom to xsd:ID format

stream

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

iterator

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

Specified by:

iterator in interface java.lang.Iterable<SpecObject>

get

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

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

Parameters:

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

Returns:

the SpecObject object at the specified index

Throws:

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

get

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

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

Parameters:

identifier - the identifier of the collection member to return

Returns:

the SpecObject subclass with the specified identifier

Throws:

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

find

public SpecObject find(java.lang.String longName)

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

Parameters:

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

Returns:

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

contains

public boolean contains(SpecObject specObject)

Checks whether the specified SpecObject exists in this collection.

Parameters:

specObject - the SpecObject to check, not null

Returns:

returns true if the specified specObject exists, false otherwise

remove

public void remove(SpecObject specObject)
            throws NotFoundException,
                   ReferencedException

Removes a SpecObject object from this collection.

Parameters:

specObject - the SpecObject object to remove, not null

Throws:

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

ReferencedException - if the specified SpecObject object is referenced in one or more SpecRelation or SpecHierarchy objects

removeAll

public void removeAll()
               throws ReferencedException

Removes all SpecObject objects from this collection.

Throws:

ReferencedException - if the specified SpecObject object is referenced in one or more SpecRelation or SpecHierarchy objects

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