com.semartinez.projects.choppit.model.entity

Class Ingredient

java.lang.Object

com.semartinez.projects.choppit.model.entity.Ingredient

public class Ingredient
extends Object

Ingredients are child entities of Recipes. Each Ingredient consists of a quantity String, a unit Ingredient.Unit, and a name String. Unit is primarily an Enum of abbreviated cooking terms, but also allows the value Ingredient.Unit.OTHER with unitAlt as a String stand-in for less-common terms (i.e. sprig) and items measured whole (i.e. eggs)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Ingredient.Unit This Enum holds values for units of measurement with an "OTHER" option to handle additional values.

Constructor Summary

Constructors

Constructor and Description
Ingredient()
Ingredient(long recipeId, String quantity, Ingredient.Unit unit, String unitAlt, String name)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
long	getId()
String	getName()
String	getQuantity()
long	getRecipeId()
Ingredient.Unit	getUnit()
String	getUnitAlt()
String	getUnitText()
int	hashCode()
void	setId(long id)
void	setName(String name)
void	setQuantity(String quantity)
void	setRecipeId(long recipeId)
void	setUnit(Ingredient.Unit unit)
void	setUnitAlt(String unitAlt)
void	setUnitText(String unit)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Ingredient

public Ingredient()

Ingredient

public Ingredient(long recipeId,
                  String quantity,
                  Ingredient.Unit unit,
                  String unitAlt,
                  String name)

Parameters:

recipeId - received from the parent Recipe

quantity - is the amount of Ingredient.Unit. Takes a String to avoid dealing with fraction/decimal conversions and unicode characters like '⅔'.

unit - is the unit of measurement.

unitAlt - is optional; used if the unit parameter is Ingredient.Unit.OTHER.

name - is the name of the ingredient.

Method Detail

getId

public long getId()

Returns:

the id of the Ingredient.

setId

public void setId(long id)

Parameters:

id - is generated when an Ingredient is inserted into the database.

getRecipeId

public long getRecipeId()

Returns:

the recipeId of the parent Recipe

setRecipeId

public void setRecipeId(long recipeId)

Parameters:

recipeId - is received from the parent Recipe.

getQuantity

public String getQuantity()

Returns:

the Ingredient's quantity

setQuantity

public void setQuantity(String quantity)

Parameters:

quantity - is set by the user in the EditingFragment.

getUnit

public Ingredient.Unit getUnit()

Returns:

the Ingredient's Unit.

setUnit

public void setUnit(Ingredient.Unit unit)

Parameters:

unit - is set by the user in the EditingFragment.

getUnitText

public String getUnitText()

Returns:

the String value of the Ingredient's Unit.

setUnitText

public void setUnitText(String unit)

Parameters:

unit - is set by the user in the EditingFragment.

getUnitAlt

public String getUnitAlt()

Returns:

a String if the Ingredient's Unit is OTHER.

setUnitAlt

public void setUnitAlt(String unitAlt)

Parameters:

unitAlt - is set by the user in the EditingFragment.

getName

public String getName()

Returns:

the name of the Ingredient.

setName

public void setName(String name)

Parameters:

name - is set by the user in the EditingFragment.

toString

@NonNull
public String toString()

Overrides:

toString in class Object

Returns:

Quantity + Unit + Name.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

a hash based on the contents of the Ingredient.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Parameters:

obj - another Ingredient to compare

Returns:

true if the quantity, unit, unitAlt and name are all equal.