public interface ConfigurationNodeList extends OsidList
Like all OsidLists,
ConfigurationNodeList
provides a means for accessing ConfigurationNode
elements
sequentially either one at a time or many at a time. Examples:
while (cnl.hasNext()) { ConfigurationNode node = cnl.getNextConfigurationNode(); }or
while (cnl.hasNext()) { ConfigurationNode[] nodes = cl.getNextConfigurationNodes(cnl.available()); }
Modifier and Type | Method and Description |
---|---|
ConfigurationNode |
getNextConfigurationNode()
Gets the next
ConfigurationNode in this list. |
ConfigurationNode[] |
getNextConfigurationNodes(long n)
Gets the next set of
ConfigurationNode objects in this
lis which must be less than or equal to whst is returned from
available(). |
ConfigurationNode getNextConfigurationNode() throws OperationFailedException
ConfigurationNode
in this list. ConfigurationNode
in this list. The
hasNext()
method should be used to test that a
next ConfigurationNode
is available before
calling this method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. ConfigurationNode[] getNextConfigurationNodes(long n) throws OperationFailedException
ConfigurationNode
objects in this
lis which must be less than or equal to whst is returned from
available().
n
- the number of ConfigurationNode
elements
requested which should be less than or equal to
available()
ConfigurationNode
elements.
The length of the array is less than or equal to the
number specified.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented.