Interface ConfigurationNodeList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, OsidList
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());
}

  • Method Summary

    Modifier and Type
    Method
    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() .

    Methods inherited from interface Closeable

    close

    Methods inherited from interface OsidList

    close
    Modifier and Type
    Method
    Description
    void
    close()
    Close this list.

    Methods inherited from interface OsidList

    available, hasNext, skip
    Modifier and Type
    Method
    Description
    long
    available()
    Gets the number of elements available for retrieval.
    boolean
    hasNext()
    Tests if there are more elements in this list.
    void
    skip(long n)
    Skip the specified number of elements in the list.

  • Method Details

    • getNextConfigurationNode

      ConfigurationNode getNextConfigurationNode() throws OperationFailedException
      Gets the next ConfigurationNode in this list.
      Returns:
      the next ConfigurationNode in this list. The hasNext() method should be used to test that a next ConfigurationNode is available before calling this method.
      Throws:
      IllegalStateException - no more elements available in this list
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getNextConfigurationNodes

      ConfigurationNode[] getNextConfigurationNodes(long n) throws OperationFailedException
      Gets the next set of ConfigurationNode objects in this lis which must be less than or equal to whst is returned from available() .
      Parameters:
      n - the number of ConfigurationNode elements requested which should be less than or equal to available()
      Returns:
      an array of ConfigurationNode elements. The length of the array is less than or equal to the number specified.
      Throws:
      IllegalStateException - no more elements available in this list
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.