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