Interface ProcessProcessorList

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

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

while (ppl.hasNext()) {
     ProcessProcessor processor = ppl.getNextProcessProcessor();
}

or

while (ppl.hasNext()) {
     ProcessProcessor[] processors = ppl.getNextProcessProcessors(ppl.available());
}

  • Method Details

    • getNextProcessProcessor

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

    • getNextProcessProcessors

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