com.semartinez.projects.choppit.model.entity

Class Step

java.lang.Object

com.semartinez.projects.choppit.model.entity.Step

public class Step
extends Object

Steps are child entities of Recipes. Each Step consists of an instruction String, and recipe order integer.

Constructor Summary

Constructors

Constructor and Description
Step()
Step(long recipeId, @NotNull String instructions, int recipeOrder)

Method Summary

Modifier and Type	Method and Description
@NotNull String	getInstructions()
long	getRecipeId()
int	getRecipeOrder()
long	getStepId()
void	setInstructions(@NotNull String instructions)
void	setRecipeId(long recipeId)
void	setRecipeOrder(int recipeOrder)
void	setStepId(long stepId)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Step

public Step()

Step

public Step(long recipeId,
            @NotNull
            @NotNull String instructions,
            int recipeOrder)

Parameters:

recipeId - is the id of the parent Recipe.

instructions - is the instruction text.

recipeOrder - is the order to display this Step in its Recipe.

Method Detail

getStepId

public long getStepId()

Returns:

the id of the Step

setStepId

public void setStepId(long stepId)

Parameters:

stepId - is generated when a Step is inserted into the database.

getRecipeId

public long getRecipeId()

Returns:

returns the recipeId of the parent Recipe.

setRecipeId

public void setRecipeId(long recipeId)

Parameters:

recipeId - is received from the parent Recipe.

getInstructions

@NotNull
public @NotNull String getInstructions()

Returns:

the instruction String for a step.

setInstructions

public void setInstructions(@NotNull
                            @NotNull String instructions)

Parameters:

instructions - is set by the user in the EditingFragment.

getRecipeOrder

public int getRecipeOrder()

Returns:

the order to display this Step in its Recipe.

setRecipeOrder

public void setRecipeOrder(int recipeOrder)

Parameters:

recipeOrder - determined by the Step's position in the EditingFragment.

toString

@NonNull
public String toString()

Overrides:

toString in class Object

Returns:

the step number and first 20 characters of the Step.