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()); }
Modifier and Type | Method and 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(). |
MailboxNode getNextMailboxNode() throws OperationFailedException
MailboxNode
in this list. MailboxNode
in this list. The
hasNext()
method should be used to test that a next
MailboxNode
is available before calling this
method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. MailboxNode[] getNextMailboxNodes(long n) throws OperationFailedException
MailboxNode
elements in this list
which must be less than or equal to the return from
available().
n
- the number of MailboxNode
elements requested
which must be less than or equal to available()
MailboxNode
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.