org.osid.topology

Interface EdgeList

All Superinterfaces:

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

public interface EdgeList
extends OsidList

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

       
       
       while (el.hasNext()) {
            Edge edge = el.getNextEdge();
       }
       
                   
       
  

or

       
       
       while (el.hasNext()) {
            Edge[] edges = el.getNextEdges(el.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextEdge

Edge getNextEdge()
                 throws OperationFailedException

Gets the next Edge in this list.

Returns:

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

getNextEdges

Edge[] getNextEdges(long n)
                    throws OperationFailedException

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

Parameters:

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

Returns:

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