com.reqdesign.reqif

Class SpecObjectReferences

java.lang.Object

com.reqdesign.reqif.SpecObjectReferences

All Implemented Interfaces:

java.lang.Iterable<SpecObjectReference>

public final class SpecObjectReferences
extends java.lang.Object

This class is a collection class for SpecObjectReference objects.

It is used to obtain the collection of SpecObjectReference objects which represent SpecObject objects that contain at least one ExternalLink object.

See Also:

ToolExtensions.getSpecObjectReferencesWithExternalLinks()

Method Summary

Modifier and Type	Method and Description
boolean	contains(SpecObjectReference specObjectReference) Checks whether the specified SpecObjectReference exists in this collection.
SpecObjectReference	get(int index) Returns the SpecObjectReference object at the specified index that is contained in this collection.
int	getCount() Returns the count of items in this collection.
java.util.Iterator<SpecObjectReference>	iterator()
java.util.stream.Stream<SpecObjectReference>	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<SpecObjectReference> stream()

iterator

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

Specified by:

iterator in interface java.lang.Iterable<SpecObjectReference>

get

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

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

Parameters:

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

Returns:

the SpecObjectReference object at the specified index

Throws:

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

contains

public boolean contains(SpecObjectReference specObjectReference)

Checks whether the specified SpecObjectReference exists in this collection.

Parameters:

specObjectReference - the SpecObjectReference to check, not null

Returns:

returns true if the specified specObjectReference exists, false otherwise

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