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