Interface EntryList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface EntryList
extends OsidList

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

while (el.hasNext()) {
     Entry entry = el.getNextEntry();
}            
  

or

while (el.hasNext()) {
     Entry[] entries = el.getNextEntries(el.available());
}            
  

Method Summary

Modifier and Type	Method	Description
Entry[]	getNextEntries(long n)	Gets the next set of Entry elements in this list which must be less than or equal to the number returned from available() .
Entry	getNextEntry()	Gets the next Entry in this list.

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

getNextEntry

Entry getNextEntry()
            throws OperationFailedException

Gets the next Entry in this list.

Returns:

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

getNextEntries

Entry[] getNextEntries(long n)
                throws OperationFailedException

Gets the next set of Entry elements in this list which must be less than or equal to the number returned from available() .

Parameters:

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

Returns:

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