com.reqdesign.reqif

Class Specifications

java.lang.Object

com.reqdesign.reqif.Specifications

All Implemented Interfaces:

java.lang.Iterable<Specification>

public final class Specifications
extends java.lang.Object

Method Summary

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

iterator

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

Specified by:

iterator in interface java.lang.Iterable<Specification>

get

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

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

Parameters:

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

Returns:

the Specification object at the specified index

Throws:

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

get

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

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

Parameters:

identifier - the identifier of the collection member to return

Returns:

the Specification subclass with the specified identifier

Throws:

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

find

public Specification find(java.lang.String longName)

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

Parameters:

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

Returns:

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

contains

public boolean contains(Specification specification)

Checks whether the specified Specification exists in this collection.

Parameters:

specification - the Specification to check, not null

Returns:

returns true if the specified specification exists, false otherwise

remove

public void remove(Specification specification)
            throws NotFoundException,
                   ReferencedException

Removes a Specification object from this collection. This method will also remove child SpecHierarchy objects.

Parameters:

specification - the Specification object to remove, not null

Throws:

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

ReferencedException - if the specified Specification object is referenced in other RelationGroup objects

removeAll

public void removeAll()
               throws ReferencedException

Removes all Specification objects from this collection.

Throws:

ReferencedException - if one or more Specification objects in the collection is referenced in one or more RelationGroup objects

createSpecification

public Specification createSpecification(SpecificationType specificationType,
                                         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 new Specification object

Parameters:

specificationType - the SpecificationType for this specification, 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 Specification, 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

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