Interface DirectoryList

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

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

while (dl.hasNext()) {
     Directory directory = dl.getNextDirectory();
}
or 
while (dl.hasNext()) {
     Directory[] directories = dl.getNextDirectories(dl.available());
}

  • Method Summary

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

    • getNextDirectory

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

    • getNextDirectories

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