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