Interface OublietteNodeList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, OsidList
public interface OublietteNodeList extends OsidList

Like all OsidLists, OublietteNodeList provides a means for accessing OublietteNode elements sequentially either one at a time or many at a time. Examples: 

while (onl.hasNext()) {
     OublietteNode node = onl.getNextOublietteNode(Node);
}
or 
while (onl.hasNext()) {
     OublietteNode[] nodes = onl.getNextOublietteNodes(onl.available());
}

Like all OsidLists, OublietteNodeList is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • getNextOublietteNode

      OublietteNode getNextOublietteNode() throws OperationFailedException
      Gets the next OublietteNode in this list.
      Returns:
      the next OublietteNode in this list. The hasNext() method should be used to test that a next OublietteNode 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.

    • getNextOublietteNodes

      OublietteNode[] getNextOublietteNodes(long n) throws OperationFailedException
      Gets the next set of OublietteNode elements in this list. The specified amount must be less than or equal to the return from available().
      Parameters:
      n - the number of OublietteNode elements requested which must be less than or equal to available()
      Returns:
      an array of OublietteNode 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.