Interface BrokerProcessorList

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

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

while (bpl.hasNext()) {
     BrokerProcessor processor = bpl.getNextBrokerProcessor();
}

or

while (bpl.hasNext()) {
     BrokerProcessor[] processors = bpl.getNextBrokerProcessors(bpl.available());
}

  • Method Details

    • getNextBrokerProcessor

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

    • getNextBrokerProcessors

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