Interface ValueList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface ValueList
extends OsidList

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

while (vl.hasNext()) {
     Value value = vl.getNextValue();
}            
  

or

while (vl.hasNext()) {
     Value[] values = vl.getNextValues(vl.available());
}            
  

Method Summary

Modifier and Type	Method	Description
Value	getNextValue()	Gets the next Value in this list.
Value[]	getNextValues(long n)	Gets the next set of Values in this list which must be less than or equal to the return from available() .

Methods inherited from interface Closeable

close

Methods inherited from interface OsidList

close

Modifier and Type	Method	Description
void	close()	Close this list.

Methods inherited from interface OsidList

available, hasNext, skip

Modifier and Type	Method	Description
long	available()	Gets the number of elements available for retrieval.
boolean	hasNext()	Tests if there are more elements in this list.
void	skip(long n)	Skip the specified number of elements in the list.

Method Details

getNextValue

Value getNextValue()
            throws OperationFailedException

Gets the next Value in this list.

Returns:

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

getNextValues

Value[] getNextValues(long n)
               throws OperationFailedException

Gets the next set of Values in this list which must be less than or equal to the return from available() .

Parameters:

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

Returns:

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