Renamed IPotionRecipe.getInput() to getIngredient()

Author: Clashsoft

src/main/java/clashsoft/brewingapi/potion/recipe/AbstractPotionRecipe.java

@@ -7,11 +7,11 @@
 
 public abstract class AbstractPotionRecipe implements IPotionRecipe
 {
-	protected ItemStack input;
+	protected ItemStack	ingredient;
 
 	public AbstractPotionRecipe(ItemStack input)
 	{
-		this.input = input;
+		this.ingredient = input;
 	}
 
 	@Override
@@ -22,17 +22,25 @@ public IPotionRecipe register()
 	}
 
 	@Override
-	public ItemStack getInput()
+	public ItemStack getIngredient()
 	{
-		return this.input;
+		return this.ingredient;
 	}
 
 	@Override
 	public boolean canApply(ItemStack ingredient, PotionTypeList potionTypes)
 	{
-		return CSStacks.itemEquals(this.getInput(), ingredient) && this.canApply(potionTypes);
+		return CSStacks.itemEquals(this.getIngredient(), ingredient) && this.canApply(potionTypes);
 	}
 
+	/**
+	 * Returns true if this {@link IPotionRecipe} is appliable to the given
+	 * {@link ItemStack} {@code potion}.
+	 * 
+	 * @param potion
+	 *            the potion stack
+	 * @return true, if this potion recipe is appliable
+	 */
 	public abstract boolean canApply(PotionTypeList potionTypes);
 
 	@Override
@@ -41,5 +49,12 @@ public void apply(ItemStack ingredient, PotionTypeList potionTypes)
 		this.apply(potionTypes);
 	}
 
+	/**
+	 * Applies this {@link IPotionRecipe} to the given {@link ItemStack}
+	 * {@code potion}.
+	 * 
+	 * @param potion
+	 *            the potion stack
+	 */
 	public abstract void apply(PotionTypeList potionTypes);
 }

src/main/java/clashsoft/brewingapi/potion/recipe/IPotionRecipe.java

@@ -17,11 +17,11 @@ public interface IPotionRecipe
 	public IPotionRecipe register();
 
 	/**
-	 * Gets the input stack of this {@link IPotionRecipe}.
+	 * Gets the ingredient of this {@link IPotionRecipe}.
 	 * 
-	 * @return the input stack
+	 * @return the ingredient
 	 */
-	public ItemStack getInput();
+	public ItemStack getIngredient();
 
 	/**
 	 * Returns true if this {@link IPotionRecipe} is appliable to the given

src/main/java/clashsoft/brewingapi/potion/recipe/PotionRecipes.java

@@ -41,7 +41,7 @@ public static IPotionRecipe get(ItemStack ingredient)
 	{
 		for (IPotionRecipe recipe : recipes)
 		{
-			if (CSStacks.equals(ingredient, recipe.getInput()))
+			if (CSStacks.equals(ingredient, recipe.getIngredient()))
 			{
 				return recipe;
 			}
@@ -62,7 +62,7 @@ public static List<IPotionRecipe> getAll(ItemStack ingredient)
 		List<IPotionRecipe> list = new ArrayList();
 		for (IPotionRecipe recipe : recipes)
 		{
-			if (CSStacks.equals(ingredient, recipe.getInput()))
+			if (CSStacks.equals(ingredient, recipe.getIngredient()))
 			{
 				list.add(recipe);
 			}

src/main/java/clashsoft/brewingapi/potion/type/AbstractPotionType.java

@@ -168,7 +168,7 @@ public StringBuilder getDisplayName()
 	public ItemStack getIngredient()
 	{
 		PotionRecipe recipe = PotionRecipes.get(this);
-		return recipe == null ? null : recipe.getInput();
+		return recipe == null ? null : recipe.getIngredient();
 	}
 
 	@Override