com.reqdesign.reqif

Class ToolExtensions

java.lang.Object

com.reqdesign.reqif.ToolExtensions

All Implemented Interfaces:

java.lang.Iterable<ReqIFToolExtension>

public final class ToolExtensions
extends java.lang.Object

This class models the TOOL-EXTENSIONS section in a ReqIF File.

This is an optional element that can only contain 0 or more REQ-IF-TOOL-EXTENSION elements.

Any XML content is permissible inside REQ-IF-TOOL-EXTENSION. There are some constructions that are recognized as conforming to standards documented in the ReqIF Implementation Guide.

External Links

The External Links framework uses the <reqif-common:SPEC_OBJECT-EXTENSION/> element in order to define EXTERNAL-LINK elements in a collection that is associated with a particular SPEC-OBJECT.

See Also:

ExternalLinks

Method Summary

Modifier and Type	Method and Description
boolean	contains(ReqIFToolExtension reqIFToolExtension) Checks whether the specified ReqIFToolExtension exists in this collection.
ReqIFToolExtension	createReqIFToolExtension() Creates a new empty ReqIFToolExtension object and add it to the ToolExtensions collection.
ReqIFToolExtension	get(int index) Returns the ReqIFToolExtension object at the specified index that is contained in this collection.
int	getCount() Returns the count of items in this collection.
java.lang.String	getExchangeConversationIdentifier()
SpecObjectReferences	getSpecObjectReferencesWithExternalLinks() Gets all SpecObjectReference objects which have ExternalLinks in a SpecObjectReferences collection.
java.util.Iterator<ReqIFToolExtension>	iterator()
void	setExchangeConversationIdentifier(java.lang.String exchangeConversationIdentifier)
java.util.stream.Stream<ReqIFToolExtension>	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

getExchangeConversationIdentifier

public java.lang.String getExchangeConversationIdentifier()

setExchangeConversationIdentifier

public void setExchangeConversationIdentifier(java.lang.String exchangeConversationIdentifier)

stream

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

iterator

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

Specified by:

iterator in interface java.lang.Iterable<ReqIFToolExtension>

get

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

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

Parameters:

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

Returns:

the ReqIFToolExtension object at the specified index

Throws:

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

contains

public boolean contains(ReqIFToolExtension reqIFToolExtension)

Checks whether the specified ReqIFToolExtension exists in this collection.

Parameters:

reqIFToolExtension - the ReqIFToolExtension to check, not null

Returns:

returns true if the specified reqIFToolExtension exists, false otherwise

createReqIFToolExtension

public ReqIFToolExtension createReqIFToolExtension()

Creates a new empty ReqIFToolExtension object and add it to the ToolExtensions collection.

Returns:

the created ReqIFToolExtension object, not null

getSpecObjectReferencesWithExternalLinks

public SpecObjectReferences getSpecObjectReferencesWithExternalLinks()

Gets all SpecObjectReference objects which have ExternalLinks in a SpecObjectReferences collection.

Returns:

the SpecObjectReferences collection of SpecObject objects having at least one ExternalLink, not null

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