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