Interface InputPeerList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, OsidList
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());
}

  • Method Summary

    Modifier and Type
    Method
    Description
    InputPeer
    getNextInputPeer()
    Gets the next InputPeer in this list.
    InputPeer[]
    getNextInputPeers(long n)
    Gets the next set of InputPeer elements in this list.

    Methods inherited from interface Closeable

    close

    Methods inherited from interface OsidList

    close
    Modifier and Type
    Method
    Description
    void
    close()
    Close this list.

    Methods inherited from interface OsidList

    available, hasNext, skip
    Modifier and Type
    Method
    Description
    long
    available()
    Gets the number of elements available for retrieval.
    boolean
    hasNext()
    Tests if there are more elements in this list.
    void
    skip(long n)
    Skip the specified number of elements in the list.

  • Method Details

    • getNextInputPeer

      InputPeer getNextInputPeer() throws OperationFailedException
      Gets the next InputPeer in this list.
      Returns:
      the next InputPeer in this list. The hasNext() method should be used to test that a next InputPeer is available before calling this method.
      Throws:
      IllegalStateException - no more elements available in this list
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getNextInputPeers

      InputPeer[] getNextInputPeers(long n) throws OperationFailedException
      Gets the next set of InputPeer elements in this list. The specified amount must be less than or equal to the return from available() .
      Parameters:
      n - the number of InputPeer elements requested which must be less than or equal to available()
      Returns:
      an array of InputPeer elements. The length of the array is less than or equal to the number specified.
      Throws:
      IllegalStateException - no more elements available in this list
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.