Package org.bukkit.inventory

Interface RecipeChoice

All Superinterfaces:

Cloneable, Predicate<ItemStack>

All Known Subinterfaces:

RecipeChoice.ItemTypeChoice

All Known Implementing Classes:

RecipeChoice.ExactChoice, RecipeChoice.MaterialChoice

@NullMarked
@NonExtendable
public interface RecipeChoice
extends Predicate<ItemStack>, Cloneable

Represents a potential item match within a recipe. All choices within a recipe must be satisfied for it to be craftable. Choices must never be null or air. This class is not legal for implementation by plugins!

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	RecipeChoice.ExactChoice	Represents a choice that will be valid only if one of the stacks is exactly matched (aside from stack size).
static interface	RecipeChoice.ItemTypeChoice	Represents a choice that will be valid if the ItemStack.getType() matches any of the item types in the set.
static class	RecipeChoice.MaterialChoice	Represents a choice of multiple matching Materials.

Method Summary

Modifier and Type	Method	Description
RecipeChoice	clone()
static RecipeChoice	empty()	An "empty" recipe choice.
ItemStack	getItemStack()	Deprecated. for compatibility only
static RecipeChoice.ItemTypeChoice	itemType(RegistryKeySet<ItemType> itemTypes)	Creates a new recipe choice based on a RegistryKeySet of item types.
static RecipeChoice.ItemTypeChoice	itemType(ItemType itemType, ItemType... itemTypes)	Creates a new recipe choice based on a collection of ItemTypes.
boolean	test(ItemStack itemStack)
default RecipeChoice	validate(boolean allowEmptyRecipes)

Methods inherited from interface java.util.function.Predicate

and, negate, or

Method Details

empty

static RecipeChoice empty()

An "empty" recipe choice. Only valid as a recipe choice in specific places. Check the javadocs of a method before using it to be sure it's valid for that recipe and ingredient type.

Returns:

the empty recipe choice

itemType

@Contract(pure=true,
          value="_, _ -> new")
static RecipeChoice.ItemTypeChoice itemType(ItemType itemType,
 ItemType... itemTypes)

Creates a new recipe choice based on a collection of ItemTypes.

Parameters:

itemType - the first item type to match

itemTypes - other item types to match.

Returns:

a new recipe choice

itemType

@Contract(pure=true,
          value="_ -> new")
static RecipeChoice.ItemTypeChoice itemType(RegistryKeySet<ItemType> itemTypes)

Creates a new recipe choice based on a RegistryKeySet of item types. Can either be created via RegistrySet.keySet(RegistryKey, TypedKey[]) or obtained from Registry.getTag(TagKey).

Parameters:

itemTypes - the item types to match

Returns:

a new recipe choice

getItemStack

@Deprecated(since="1.13.1")
ItemStack getItemStack()

Deprecated.

for compatibility only

Gets a single item stack representative of this stack choice.

Returns:

a single representative item

clone

RecipeChoice clone()

test

boolean test(ItemStack itemStack)

Specified by:

test in interface Predicate<ItemStack>

validate

@Internal
default RecipeChoice validate(boolean allowEmptyRecipes)