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