org.osid.mapping.path

Interface IntersectionList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface IntersectionList
extends OsidList

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

       
       
       while (il.hasNext()) {
            Intersection intersection = il.getNextIntersection();
       }
       
                   
       
  

or

       
       
       while (il.hasNext()) {
            Intersection[] intersections = il.getNextIntersections(il.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Intersection	getNextIntersection() Gets the next Intersection in this list.
Intersection[]	getNextIntersections(long n) Gets the next set of Intersection elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextIntersection

Intersection getNextIntersection()
                                 throws OperationFailedException

Gets the next Intersection in this list.

Returns:

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

getNextIntersections

Intersection[] getNextIntersections(long n)
                                    throws OperationFailedException

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

Parameters:

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

Returns:

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