Interface IngredientList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, OsidList
public interface IngredientList extends OsidList

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

while (il.hasNext()) {
     Ingredient ingredient = il.getNextIngredient();
}
or 
while (il.hasNext()) {
     Ingredient[] ingredients = il.getNextIngredients(il.available());
}

  • Method Summary

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

    • getNextIngredient

      Ingredient getNextIngredient() throws OperationFailedException
      Gets the next Ingredient in this list.
      Returns:
      the next Ingredient in this list. The hasNext() method should be used to test that a next Ingredient 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.

    • getNextIngredients

      Ingredient[] getNextIngredients(long n) throws OperationFailedException
      Gets the next set of Ingredient elements in this list. The specified amount must be less than or equal to the return from available() .
      Parameters:
      n - the number of Ingredient elements requested which must be less than or equal to available()
      Returns:
      an array of Ingredient 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.