org.osid.sequencing

Interface AntimatroidNodeList

All Superinterfaces:

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

public interface AntimatroidNodeList
extends OsidList

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

       
       
       while (anl.hasNext()) {
            AntimatroidNode node = anl.getNextAntimatroidNode();
       }
       
                   
       
  

or

       
       
       while (anl.hasNext()) {
            AntimatroidNode[] nodes = anl.getNextAntimatroidNodes(anl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextAntimatroidNode

AntimatroidNode getNextAntimatroidNode()
                                       throws OperationFailedException

Gets the next AntimatroidNode in this list.

Returns:

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

getNextAntimatroidNodes

AntimatroidNode[] getNextAntimatroidNodes(long n)
                                          throws OperationFailedException

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

Parameters:

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

Returns:

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