Interface PathList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface PathList
extends OsidList

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

while (pl.hasNext()) {
     Path path = pl.getNextPath();
}            
  

or

while (pl.hasNext()) {
     Path[] paths = pl.getNextPaths(pl.available());
}            
  

Method Summary

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

getNextPath

Path getNextPath()
          throws OperationFailedException

Gets the next Path in this list.

Returns:

the next Path in this list. The hasNext() method should be used to test that a next Path 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.

getNextPaths

Path[] getNextPaths(long n)
             throws OperationFailedException

Gets the next set of Path elements in this list. The specified amount must be less than or equal to the return from available() .

Parameters:

n - the number of Path elements requested which must be less than or equal to available()

Returns:

an array of Path 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.