Interface DirectionList

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

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

while (dl.hasNext()) {
     Direction direction = dl.getNextDirection();
}
or 
while (dl.hasNext()) {
     Direction[] directions = dl.getNextDirections(dl.available());
}

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

  • Method Details

    • getNextDirection

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

    • getNextDirections

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