org.osid.mapping

Interface CoordinateList

All Superinterfaces:

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

public interface CoordinateList
extends OsidList

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

       
       
       while (cl.hasNext()) {
            Coordinate coordinate = cl.getNextCoordinate();
       }
       
                   
       
  

or

       
       
       while (cl.hasNext()) {
            Coordinate[] coordinates = cl.getNextCoordinates(cl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextCoordinate

Coordinate getNextCoordinate()
                             throws OperationFailedException

Gets the next Coordinate in this list.

Returns:

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

getNextCoordinates

Coordinate[] getNextCoordinates(long n)
                                throws OperationFailedException

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

Parameters:

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

Returns:

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