public interface MapList extends OsidList
Like all OsidLists,
MapList
provides a
means for accessing Map
elements sequentially either one at
a time or many at a time. Examples:
while (ml.hasNext()) { Map map = ml.getNextMap(); }or
while (ml.hasNext()) { Map[] maps = ml.getNextMaps(ml.available()); }
Modifier and Type | Method and Description |
---|---|
Map |
getNextMap()
Gets the next
Map in this list. |
Map[] |
getNextMaps(long n)
Gets the next set of
Map elements in this list. |
Map getNextMap() throws OperationFailedException
Map
in this list. Map
in this list. The hasNext()
method should be used to test that a next Map
is available before calling this method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Map[] getNextMaps(long n) throws OperationFailedException
Map
elements in this list. The
specified amount must be less than or equal to the return from
available().
n
- the number of Map
elements requested which
must be less than or equal to available()
Map
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.