public interface RecipeList extends OsidList
Like all OsidLists,
RecipeList
provides a
means for accessing Recipe
elements sequentially either one
at a time or many at a time. Examples:
while (rl.hasNext()) { Recipe recipe = rl.getNextRecipe(); }or
while (rl.hasNext()) { Recipe[] recipes = rl.getNextRecipes(rl.available()); }
Modifier and Type | Method and Description |
---|---|
Recipe |
getNextRecipe()
Gets the next
Recipe in this list. |
Recipe[] |
getNextRecipes(long n)
Gets the next set of
Recipe elements in this list. |
Recipe getNextRecipe() throws OperationFailedException
Recipe
in this list. Recipe
in this list. The
hasNext()
method should be used to test that a next
Recipe
is available before calling this method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Recipe[] getNextRecipes(long n) throws OperationFailedException
Recipe
elements in this list. The
specified amount must be less than or equal to the return from
available().
n
- the number of Recipe
elements requested which
must be less than or equal to available()
Recipe
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.