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