Interface LogList

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

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

while (ll.hasNext()) {
     Log log = ll.getNextLog();
}
or 
while (ll.hasNext()) {
     Log[] logs = ll.getNextLogs(ll.available());
}

  • Method Summary

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

    • getNextLog

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

    • getNextLogs

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