Interface CanonicalUnitList

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

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

while (cul.hasNext()) {
     CanonicalUnit canonical = cul.getNextCanonicalUnit();
}
or 
while (cul.hasNext()) {
     CanonicalUnit[] canonicals = cul.getNextCanonicalUnits(cul.available());
}

  • Method Summary

    Modifier and Type
    Method
    Description
    CanonicalUnit
    getNextCanonicalUnit()
    Gets the next CanonicalUnit in this list.
    CanonicalUnit[]
    getNextCanonicalUnits(long n)
    Gets the next set of CanonicalUnit 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

    • getNextCanonicalUnit

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

    • getNextCanonicalUnits

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