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