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