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