Interface DictionaryNodeList

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

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

while (dnl.hasNext()) {
     DictionaryNode node = dnl.getNextDictionaryNode();
}
or 
while (dnl.hasNext()) {
     DictionaryNode[] nodes = dnl.getNextDictionaryNodes(dnl.available());
}

  • Method Summary

    Modifier and Type
    Method
    Description
    DictionaryNode
    getNextDictionaryNode()
    Gets the next DictionaryNode in this list.
    DictionaryNode[]
    getNextDictionaryNodes(long n)
    Gets the next set of DictionaryNode 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

    • getNextDictionaryNode

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

    • getNextDictionaryNodes

      DictionaryNode[] getNextDictionaryNodes(long n) throws OperationFailedException
      Gets the next set of DictionaryNode objects in this lis which must be less than or equal to whst is returned from available() .
      Parameters:
      n - the number of DictionaryNode elements requested which should be less than or equal to available()
      Returns:
      an array of DictionaryNode 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.