Interface MailboxNodeList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, OsidList
public interface MailboxNodeList extends OsidList

Like all OsidLists , MailboxNodeList provides a means for accessing MailboxNode elements sequentially either one at a time or many at a time. Examples: 

while (mnl.hasNext()) {
     MailboxNode node = mnl.getNextMailboxNode();
}
or 
while (mnl.hasNext()) {
     MailboxNode[] nodes = mnl.getNextMailboxNodes(mnl.available());
}

  • Method Summary

    Modifier and Type
    Method
    Description
    MailboxNode
    getNextMailboxNode()
    Gets the next MailboxNode in this list.
    MailboxNode[]
    getNextMailboxNodes(long n)
    Gets the next set of MailboxNode elements in this list which must be less than or equal to the return from available() .

    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

    • getNextMailboxNode

      MailboxNode getNextMailboxNode() throws OperationFailedException
      Gets the next MailboxNode in this list.
      Returns:
      the next MailboxNode in this list. The hasNext() method should be used to test that a next MailboxNode 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.

    • getNextMailboxNodes

      MailboxNode[] getNextMailboxNodes(long n) throws OperationFailedException
      Gets the next set of MailboxNode elements in this list which must be less than or equal to the return from available() .
      Parameters:
      n - the number of MailboxNode elements requested which must be less than or equal to available()
      Returns:
      an array of MailboxNode 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.