com.reqdesign.reqif

Class SpecRelationGroups

java.lang.Object

com.reqdesign.reqif.SpecRelationGroups

All Implemented Interfaces:

java.lang.Iterable<RelationGroup>

public final class SpecRelationGroups
extends java.lang.Object

Method Summary

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

iterator

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

Specified by:

iterator in interface java.lang.Iterable<RelationGroup>

get

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

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

Parameters:

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

Returns:

the RelationGroup object at the specified index

Throws:

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

get

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

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

Parameters:

identifier - the identifier of the collection member to return

Returns:

the RelationGroup subclass with the specified identifier

Throws:

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

find

public RelationGroup find(java.lang.String longName)

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

Parameters:

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

Returns:

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

contains

public boolean contains(RelationGroup relationGroup)

Checks whether the specified RelationGroup exists in this collection.

Parameters:

relationGroup - the RelationGroup to check, not null

Returns:

returns true if the specified relationGroup exists, false otherwise

remove

public void remove(RelationGroup relationGroup)
            throws NotFoundException

Removes a RelationGroup object from this collection.

Parameters:

relationGroup - the RelationGroup object to remove, not null

Throws:

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

removeAll

public void removeAll()

Removes all RelationGroup objects from this collection

createRelationGroup

public RelationGroup createRelationGroup(RelationGroupType relationGroupType,
                                         Specification sourceSpecification,
                                         Specification targetSpecification,
                                         java.lang.String desc,
                                         java.util.Date lastChange,
                                         java.lang.String longName,
                                         java.lang.String identifier,
                                         java.lang.String alternativeId)
                                  throws DuplicateIdentifierException,
                                         InvalidIdentifierException

Throws:

DuplicateIdentifierException

InvalidIdentifierException

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