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