Interface QueueProcessorList

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

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

while (qpl.hasNext()) {
     QueueProcessor processor = qpl.getNextQueueProcessor();
}
or 
while (qpl.hasNext()) {
     QueueProcessor[] processors  = qpl.getNextQueueProcessors(qpl.available());
}

  • Method Summary

    Modifier and Type
    Method
    Description
    QueueProcessor
    getNextQueueProcessor()
    Gets the next QueueProcessor in this list.
    QueueProcessor[]
    getNextQueueProcessors(long n)
    Gets the next set of QueueProcessor elements in this list.

    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

    • getNextQueueProcessor

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

    • getNextQueueProcessors

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