org.spongepowered.api.item.inventory

Interface ItemStack

All Superinterfaces:

CompositeValueStore<DataHolder,DataManipulator<?,?>>, DataHolder, DataSerializable, PropertyHolder, Translatable, ValueContainer<DataHolder>

public interface ItemStack
extends DataHolder, Translatable

Represents a stack of a specific ItemType. Supports serialization and can be compared using the comparators listed in ItemStackComparators.

ItemStacks have a variety of properties and data. It is advised to use CompositeValueStore.get(Class) in order to retrieve information regarding this item stack.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ItemStack.Builder

Method Summary

Modifier and Type	Method and Description
static ItemStack.Builder	builder() Creates a new ItemStack.Builder to build an ItemStack.
ItemStack	copy() Creates a clone copy of this ValueContainer as a new ValueContainer such that all the BaseValues are safely duplicated to the new instance.
ItemStackSnapshot	createSnapshot() Gets the ItemStackSnapshot of this ItemStack.
static ItemStack	empty() Returns an empty ItemStack.
boolean	equalTo(ItemStack that) Returns true if the specified ItemStack has the same stack size, ItemType, and data.
default ItemType	getItem() Deprecated. Use getType()
int	getMaxStackQuantity() Gets the maximum quantity per stack.
int	getQuantity() Gets the quantity of items in this stack.
ItemType	getType() Gets the ItemType of this ItemStack.
boolean	isEmpty() Returns true if getQuantity() is zero and therefore this ItemStack is empty.
static ItemStack	of(ItemType itemType) Creates a new ItemStack of the provided ItemType and quantity of 1
static ItemStack	of(ItemType itemType, int quantity) Creates a new ItemStack of the provided ItemType and quantity.
void	setQuantity(int quantity) Sets the quantity in this stack.

Methods inherited from interface org.spongepowered.api.data.DataHolder

setRawData, validateRawData

Methods inherited from interface org.spongepowered.api.data.DataSerializable

getContentVersion, toContainer

Methods inherited from interface org.spongepowered.api.data.property.PropertyHolder

getApplicableProperties, getProperty

Methods inherited from interface org.spongepowered.api.data.value.mutable.CompositeValueStore

copyFrom, copyFrom, get, getContainers, getOrCreate, offer, offer, offer, offer, offer, offer, remove, remove, remove, require, supports, transform, tryOffer, tryOffer, tryOffer, tryOffer, undo

Methods inherited from interface org.spongepowered.api.data.value.ValueContainer

get, getKeys, getOrElse, getOrNull, getValue, getValues, require, supports, supports

Methods inherited from interface org.spongepowered.api.text.translation.Translatable

getTranslation

Method Detail

builder

static ItemStack.Builder builder()

Creates a new ItemStack.Builder to build an ItemStack.

Returns:

The new builder

of

static ItemStack of(ItemType itemType,
                    int quantity)

Creates a new ItemStack of the provided ItemType and quantity.

Parameters:

itemType - The item type

quantity - The quantity

Returns:

The new item stack

of

static ItemStack of(ItemType itemType)

Creates a new ItemStack of the provided ItemType and quantity of 1

Parameters:

itemType - The item type

Returns:

The new item stack

empty

static ItemStack empty()

Returns an empty ItemStack.

Returns:

The empty ItemStack

getItem

@Deprecated
default ItemType getItem()

Deprecated. Use getType()

Gets the ItemType of this ItemStack.

Returns:

The item type

getType

ItemType getType()

Gets the ItemType of this ItemStack.

Returns:

The item type

getQuantity

int getQuantity()

Gets the quantity of items in this stack. This may exceed the max stack size of the item, and if added to an inventory will then be divided by the max stack.

Returns:

Quantity of items

setQuantity

void setQuantity(int quantity)
          throws IllegalArgumentException

Sets the quantity in this stack.

Parameters:

quantity - Quantity

Throws:

IllegalArgumentException - If quantity set exceeds the getMaxStackQuantity()

getMaxStackQuantity

int getMaxStackQuantity()

Gets the maximum quantity per stack. By default, returns ItemType.getMaxStackQuantity(), unless a different value has been set for this specific stack.

Returns:

Max stack quantity

createSnapshot

ItemStackSnapshot createSnapshot()

Gets the ItemStackSnapshot of this ItemStack. All known DataManipulators existing on this ItemStack are added as copies to the ItemStackSnapshot.

Returns:

The newly created item stack snapshot

equalTo

boolean equalTo(ItemStack that)

Returns true if the specified ItemStack has the same stack size, ItemType, and data. Note that this method is not an overrider of Object.equals(Object) in order to maintain compatibility with the base game. Therefore, ItemStacks may not behave as expected when using them in equality based constructs such as Maps or Sets.

Parameters:

that - ItemStack to compare

Returns:

True if this equals the ItemStack

isEmpty

boolean isEmpty()

Returns true if getQuantity() is zero and therefore this ItemStack is empty.

In Vanilla empty ItemStacks are not rendered by the client.

Returns:

True if this ItemStack is empty

copy

ItemStack copy()

Description copied from interface: ValueContainer

Creates a clone copy of this ValueContainer as a new ValueContainer such that all the BaseValues are safely duplicated to the new instance.

Specified by:

copy in interface ValueContainer<DataHolder>

Returns:

The new copy