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