com.reqdesign.reqif

Class Identifiables

java.lang.Object

com.reqdesign.reqif.Identifiables

All Implemented Interfaces:

java.lang.Iterable<Identifiable<?>>

public final class Identifiables
extends java.lang.Object

This class is a collection of Identifiable objects.

Method Summary

Modifier and Type	Method and Description
boolean	contains(Identifiable<?> identifiable) Checks whether the specified Identifiable 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
Identifiable	find(java.lang.String longName) Returns the first occurrence of an Identifiable object with the specified longName that is contained in this collection.
Identifiable<?>	get(int index) Returns the Identifiable object at the specified index that is contained in this collection.
Identifiable<?>	get(java.lang.String identifier) Returns the Identifiable object with the specified identifier that is contained in this collection.
int	getCount() Returns the count of items in this collection.
java.util.Iterator<Identifiable<?>>	iterator()
java.util.stream.Stream<Identifiable<?>>	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<Identifiable<?>> stream()

iterator

public java.util.Iterator<Identifiable<?>> iterator()

Specified by:

iterator in interface java.lang.Iterable<Identifiable<?>>

get

public Identifiable<?> get(int index)
                    throws java.lang.IndexOutOfBoundsException

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

Parameters:

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

Returns:

the Identifiable object at the specified index

Throws:

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

get

public Identifiable<?> get(java.lang.String identifier)
                    throws UnknownIdentifierException

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

Parameters:

identifier - the identifier of the collection member to return

Returns:

the Identifiable subclass with the specified identifier

Throws:

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

find

public Identifiable find(java.lang.String longName)

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

Parameters:

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

Returns:

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

contains

public boolean contains(Identifiable<?> identifiable)

Checks whether the specified Identifiable exists in this collection.

Parameters:

identifiable - the Identifiable to check, not null

Returns:

returns true if the specified identifiable 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