Interface KeyList

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

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

while (kl.hasNext()) {
     Key key = kl.getNextKey();
}
or 
while (kl.hasNext()) {
     Key[] keys = kl.getNextKeys(kl.available());
}

  • Method Summary

    Modifier and Type
    Method
    Description
    Key
    getNextKey()
    Gets the next Key in this list.
    Key[]
    getNextKeys(long n)
    Gets the next set of Key elements in this list which must be less than or equal to the number returned 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

    • getNextKey

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

    • getNextKeys

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