nova.core.recipes.ingredient

Class SpecificItemIngredient

java.lang.Object

nova.core.recipes.ingredient.AbstractIngredient

nova.core.recipes.ingredient.SpecificItemIngredient

All Implemented Interfaces:

ItemIngredient

public class SpecificItemIngredient
extends AbstractIngredient

Specifies an ingredient identifying a single kind of item.

Constructor Summary

Constructors

Constructor and Description
SpecificItemIngredient(java.lang.String itemId)

Method Summary

Modifier and Type	Method and Description
java.util.Optional<Item>	consumeOnCrafting(Item original, CraftingGrid craftingGrid) Performs any necessary actions when this ingredient is consumed due to crafting a single item.
boolean	equals(java.lang.Object other)
java.util.Collection<Item>	getExampleItems() Returns a list of example items.
java.lang.String	getItemId()
java.util.Collection<java.lang.String>	getPossibleItemIds() Returns a list of all items that could possibly match this ingredient.
int	hashCode()
boolean	isSubsetOf(ItemIngredient ingredient) Checks if this ingredient is a subset of another ingredient.
boolean	matches(Item item) Checks if this ingredient matches the given item.
java.lang.String	toString()

Methods inherited from class nova.core.recipes.ingredient.AbstractIngredient

getTag, withTag

Methods inherited from class java.lang.Object

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

Methods inherited from interface nova.core.recipes.ingredient.ItemIngredient

forBlock, forDictionary, forItem, forItem

Constructor Detail

SpecificItemIngredient

public SpecificItemIngredient(java.lang.String itemId)

Method Detail

getItemId

public java.lang.String getItemId()

getPossibleItemIds

public java.util.Collection<java.lang.String> getPossibleItemIds()

Description copied from interface: ItemIngredient

Returns a list of all items that could possibly match this ingredient. Should return Optional.empty() if there is no such list.

Returns:

possible items

getExampleItems

public java.util.Collection<Item> getExampleItems()

Description copied from interface: ItemIngredient

Returns a list of example items. This list could be used to render ingredients when displayed to users.

Returns:

example items

isSubsetOf

public boolean isSubsetOf(ItemIngredient ingredient)

Description copied from interface: ItemIngredient

Checks if this ingredient is a subset of another ingredient. An ingredient is a subset if all items that match this ingredient also match the other ingredient.

Specified by:

isSubsetOf in interface ItemIngredient

Overrides:

isSubsetOf in class AbstractIngredient

Parameters:

ingredient - The another ingredient

Returns:

Result of the check

matches

public boolean matches(Item item)

Description copied from interface: ItemIngredient

Checks if this ingredient matches the given item.

Parameters:

item - Item to check

Returns:

Whether the item matches or not

consumeOnCrafting

public java.util.Optional<Item> consumeOnCrafting(Item original,
                                                  CraftingGrid craftingGrid)

Description copied from interface: ItemIngredient

Performs any necessary actions when this ingredient is consumed due to crafting a single item. May return a stack with zero size, but cannot return null.

Parameters:

original - ingredient

craftingGrid - CraftingGrid used

Returns:

Resulting Item, or an empty optional if the item was empty.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object