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