org.osid.sequencing

Interface AntimatroidList

All Superinterfaces:

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

public interface AntimatroidList
extends OsidList

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

       
       
       while (al.hasNext()) {
            Antimatroid antimatroid = al.getNextAntimatroid();
       }
       
                   
       
  

or

       
       
       while (al.hasNext()) {
            Antimatroid[] antimatroids = al.getNextAntimatroids(al.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextAntimatroid

Antimatroid getNextAntimatroid()
                               throws OperationFailedException

Gets the next Antimatroid in this list.

Returns:

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

getNextAntimatroids

Antimatroid[] getNextAntimatroids(long n)
                                  throws OperationFailedException

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

Parameters:

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

Returns:

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