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