Interface CompositionList

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

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

while (cl.hasNext()) {
     Composition composition = cl.getNextComposition();
}
or 
while (cl.hasNext()) {
     Composition[] compositions = cl.getNextCompositions(cl.available());
}

  • Method Summary

    Modifier and Type
    Method
    Description
    Composition
    getNextComposition()
    Gets the next Composition in this list.
    Composition[]
    getNextCompositions(long n)
    Gets the next set of Composition elements in this list which must be less than or equal to the return from available() .

    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

    • getNextComposition

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

    • getNextCompositions

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