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