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