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