Interface FoundryList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface FoundryList
extends OsidList

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

while (fl.hasNext()) {
     Foundry foundry = fl.getNextFoundry();
}            
  

or

while (fl.hasNext()) {
     Foundry[] foundries = fl.getNextFoundries(fl.available());
}            
  

Method Summary

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

getNextFoundry

Foundry getNextFoundry()
                throws OperationFailedException

Gets the next Foundry in this list.

Returns:

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

getNextFoundries

Foundry[] getNextFoundries(long n)
                    throws OperationFailedException

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

Parameters:

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

Returns:

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