Class GroceryMatch

java.lang.Object

GroceryMatch

public class GroceryMatch
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
GroceryMatch() DO NOT EDIT CONSTRUCTOR

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	calcMaxNumServing(Recipe recipe) Calculate what is the maximum number of servings of this recipe using current GroceryList.
void	handleShow() DO NOT EDIT THIS METHOD Handle the command when you try to show how many servings are possible.
void	handleUse(java.util.Scanner stdin) Handle the command when you try to use a recipe.
java.lang.Boolean	initialize(java.lang.String groceryFile, java.lang.String recipeFile) DO NOT EDIT THIS METHOD This method will initialize groceries and recipes.
static void	main(java.lang.String[] args) DO NOT EDIT THIS METHOD The main method initializes the GroceryMatch object and call the initialize method before starting the main menu loop.
void	mainLoop(java.util.Scanner stdin) DO NOT EDIT THIS METHOD Main loop of GroceryMatch.
static void	print(GroceryList groceries) Print all the ingredient names and quantities in a GroceryList.
static void	print(RecipeList recipes) Print all the recipes in a RecipeList.
void	reportShortage(Recipe recipe, java.lang.Integer numOfServing) This method is call when the desired number of servings is greater than maximum possible number of servings.
void	updateGroceries(Recipe recipe, java.lang.Integer numOfServing) Reduce the quantities in GroceryList since you have used them for serving.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GroceryMatch

public GroceryMatch()

DO NOT EDIT CONSTRUCTOR

Method Detail

calcMaxNumServing

public java.lang.Integer calcMaxNumServing(Recipe recipe)

Calculate what is the maximum number of servings of this recipe using current GroceryList. All ingredients must have enough for the maximum number of servings. The maximum number of servings is 0 if any ingredient is not available in sufficient quantity.

Parameters:

recipe - The recipe that you want to serve.

Returns:

The maximum number of servings, return 0 if unable to serve.

reportShortage

public void reportShortage(Recipe recipe,
                           java.lang.Integer numOfServing)

This method is call when the desired number of servings is greater than maximum possible number of servings. This method will print how many more ingredients need to be bought for the insufficient ingredients. For sufficient ingredients, do not print. One ingredient per line, format is "name: quantity", no leading or trailing spaces.

Parameters:

recipe - The recipe that you can not serve.

numOfServing - The number of servings of the recipe.

updateGroceries

public void updateGroceries(Recipe recipe,
                            java.lang.Integer numOfServing)

Reduce the quantities in GroceryList since you have used them for serving.

Parameters:

recipe - The recipe you are serving.

numOfServing - The number of servings of the recipe.

handleUse

public void handleUse(java.util.Scanner stdin)

Handle the command when you try to use a recipe. Input the recipe name and the number of servings, see if it is able to serve using the current GroceryList. (1) If able to server, this function should update the quantities in GroceryList, and print a serving success message. (2) If unable to serve, this function should not update the quantities in GroceryList, and print the ingredients need to be bought.

Parameters:

stdin - The scanner for input.

print

public static void print(GroceryList groceries)

Print all the ingredient names and quantities in a GroceryList. One ingredient each line. Do not sort the ingredients. Display in the order added in the list. name1: quantity1 name2: quantity2 name3: quantity3 name4: quantity4

Parameters:

groceries - The GroceryList you want to print.

print

public static void print(RecipeList recipes)

Print all the recipes in a RecipeList. One recipe each line. Do not sort the recipes. Display in the order they were added to the list. recipeName1 -> ingredient1: quantity1, ingredient2: quantity2, ... recipeName2 -> ingredient1: quantity1, ingredient2: quantity2, ... recipeName3 -> ingredient1: quantity1, ingredient2: quantity2, ...

Parameters:

recipes - The RecipeList you want to print.

handleShow

public void handleShow()

DO NOT EDIT THIS METHOD Handle the command when you try to show how many servings are possible. For each recipe in RecipeList, print the maximum number of servings using the current GroceryList. One recipe per line, format is "recipe-name: max-num-of-serving", no leading or trailing spaces. DO NOT EDIT THIS METHOD

mainLoop

public void mainLoop(java.util.Scanner stdin)

DO NOT EDIT THIS METHOD Main loop of GroceryMatch. The main loop accept input commands, execute them, and print results. The main loop accepts three types of commands: (1) q : Save current groceries to file and quit the program. (2) s : For all recipes, show how many servings are possible using the current GroceryList. (3) u : Use a recipe. For other commands, print UNRECOGNIZED_COMMAND_ERROR and ignore. DO NOT EDIT THIS METHOD

Parameters:

stdin - The Scanner for input.

initialize

public java.lang.Boolean initialize(java.lang.String groceryFile,
                                    java.lang.String recipeFile)

DO NOT EDIT THIS METHOD This method will initialize groceries and recipes. Return false when there is IOException.

Parameters:

groceryFile - filename of groceries

recipeFile - filename of recipes

Returns:

Return true if GroceryList and RecipeList are successfully loaded. Return false if there are Exceptions.

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

DO NOT EDIT THIS METHOD The main method initializes the GroceryMatch object and call the initialize method before starting the main menu loop.

Throws:

java.io.IOException