Interface SpeedZoneList

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

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

while (szl.hasNext()) {
     SpeedZone zone = szl.getNextSpeedZone();
}
or 
while (szl.hasNext()) {
     SSpeedZone[] zones = szl.getNextSpeedZones(szl.available());
}

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

  • Method Details

    • getNextSpeedZone

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

    • getNextSpeedZones

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