public interface RouteList extends OsidList
Like all OsidLists,
RouteList
provides a
means for accessing Route
elements sequentially either one
at a time or many at a time. Examples:
while (rl.hasNext()) { Route route = rl.getNextRoute(); }or
while (rl.hasNext()) { Route[] routes = rl.getNextRoutes(rl.available()); }
Modifier and Type | Method and Description |
---|---|
Route |
getNextRoute()
Gets the next
Route in this list. |
Route[] |
getNextRoutes(long n)
Gets the next set of
Route elements in this list. |
Route getNextRoute() throws OperationFailedException
Route
in this list. Route
in this list. The
hasNext()
method should be used to test that a next
Route
is available before calling this method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Route[] getNextRoutes(long n) throws OperationFailedException
Route
elements in this list. The
specified amount must be less than or equal to the return from
available().
n
- the number of Route
elements requested which
must be less than or equal to available()
Route
elements.
The
length of the array is less than or equal to the number
specified.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented.