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()); }
Modifier and Type | Method and Description |
---|---|
Foundry[] |
getNextFoundries(long n)
Gets the next set of
Foundry elements in this list. |
Foundry |
getNextFoundry()
Gets the next
Foundry in this list. |
Foundry getNextFoundry() throws OperationFailedException
Foundry
in this list. Foundry
in this list. The
hasNext()
method should be used to test that a next
Foundry
is available before calling this
method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Foundry[] getNextFoundries(long n) throws OperationFailedException
Foundry
elements in this list. The
specified amount must be less than or equal to the return from
available().
n
- the number of Foundry
elements requested
which must be less than or equal to available()
Foundry
elements.
The length of the array is less than or equal to the number
specified.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented.