com.reqdesign.reqif

Class Children

java.lang.Object

com.reqdesign.reqif.Children

All Implemented Interfaces:

java.lang.Iterable<SpecHierarchy>

public final class Children
extends java.lang.Object

The collection class representing the child SpecHierarchy objects in either a Specification object or a parent SpecHierarchy object.

Method Summary

Modifier and Type	Method and Description
boolean	contains(SpecHierarchy specHierarchy) Checks whether the specified SpecHierarchy 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
SpecHierarchy	createSpecHierarchy(SpecObject specObject, java.lang.String desc, java.util.Date lastChange, java.lang.String longName, java.lang.String identifier, java.lang.String alternativeID, java.util.List<AttributeDefinition<?>> editableAtts, boolean isEditable, boolean isTableInternal) Creates an instance of this class and adds it to the parent which is either a Specification or another SpecHierarchy object.
SpecHierarchy	find(java.lang.String longName) Returns the first occurrence of a SpecHierarchy object with the specified longName that is contained in this collection.
SpecHierarchy	get(int index) Returns the SpecHierarchy object at the specified index that is contained in this collection.
SpecHierarchy	get(java.lang.String identifier) Returns the SpecHierarchy object with the specified identifier that is contained in this collection.
int	getCount() Returns the count of items in this collection.
java.util.Iterator<SpecHierarchy>	iterator()
void	remove(SpecHierarchy specHierarchy) Removes a SpecHierarchy object from this collection.
void	removeAll() Removes all child (@code SpecHierarchy} objects in this collection.
java.util.stream.Stream<SpecHierarchy>	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

find

public SpecHierarchy find(java.lang.String longName)

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

Parameters:

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

Returns:

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

createSpecHierarchy

public SpecHierarchy createSpecHierarchy(SpecObject specObject,
                                         java.lang.String desc,
                                         java.util.Date lastChange,
                                         java.lang.String longName,
                                         java.lang.String identifier,
                                         java.lang.String alternativeID,
                                         java.util.List<AttributeDefinition<?>> editableAtts,
                                         boolean isEditable,
                                         boolean isTableInternal)
                                  throws InvalidValueException,
                                         InvalidIdentifierException,
                                         DuplicateIdentifierException

Creates an instance of this class and adds it to the parent which is either a Specification or another SpecHierarchy object.

An instance of a SpecObject class is associated with each SpecHierarchy. The same SpecObject object can be associated with multiple SpecHierarchy objects.

Parameters:

specObject - the SpecObject object to associate with this SpecHierarchy object, not null

desc - the value to assign as the @DESC attribute of this object, can be null

lastChange - the value to assign as the @LAST-CHANGE attribute of this object, not null

longName - the value to assign as the @LONG-NAME attribute of this object, can be null

identifier - the value to assign as the @IDENTIFIER attribute of this object, can be null to auto assign

alternativeID - the value to assign as the ALTERNATIVE-ID::@IDENTIFIER attribute, can be null but not empty

editableAtts - the List of AttributeDefinition objects to specify which attribute values can be modified, can be null

isEditable - the boolean value to set for the @IS-EDITABLE attribute of this object

isTableInternal - the boolean value to set for the @IS-TABLE-INTERNAL attribute of this object

Returns:

the created SpecHierarchy instance, not null

Throws:

InvalidValueException - if SpecObject or any element in the editableAtts list is null or any member in the editableAtts list is not an AttributeDefinition associated with this SpecObject SpecType

InvalidIdentifierException - if the identifier parameter is not a valid xsd:ID

DuplicateIdentifierException - if the identifier parameter has already been used by another object

stream

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

iterator

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

Specified by:

iterator in interface java.lang.Iterable<SpecHierarchy>

get

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

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

Parameters:

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

Returns:

the SpecHierarchy object at the specified index

Throws:

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

get

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

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

Parameters:

identifier - the identifier of the collection member to return

Returns:

the SpecHierarchy subclass with the specified identifier

Throws:

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

contains

public boolean contains(SpecHierarchy specHierarchy)

Checks whether the specified SpecHierarchy exists in this collection.

Parameters:

specHierarchy - the SpecHierarchy to check, not null

Returns:

returns true if the specified specHierarchy exists, false otherwise

remove

public void remove(SpecHierarchy specHierarchy)
            throws NotFoundException

Removes a SpecHierarchy object from this collection. Removing a SpecHierarchy from a collection is deep.

Parameters:

specHierarchy - the SpecHierarchy object to remove, not null

Throws:

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

removeAll

public void removeAll()

Removes all child (@code SpecHierarchy} objects in this collection.

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