Package org.spongepowered.api.item.inventory

Interface ItemStackSnapshot

All Superinterfaces:

CopyableDataHolder, DataHolder, DataHolder.Immutable<ItemStackSnapshot>, DataSerializable, HoverEventSource<HoverEvent.ShowItem>, SerializableDataHolder, SerializableDataHolder.Immutable<ItemStackSnapshot>, ValueContainer

public interface ItemStackSnapshot
extends HoverEventSource<HoverEvent.ShowItem>, SerializableDataHolder.Immutable<ItemStackSnapshot>

Represents a snapshot of an ItemStack as an DataHolder.Immutable to represent all of the data associated with the ItemStack of which the snapshot was created from. Being that it is a snapshot, a snapshot cannot be modified, but modifications will result in a new instance of the ItemStackSnapshot.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ItemStackSnapshot.Factory

Nested classes/interfaces inherited from interface org.spongepowered.api.data.DataHolder

DataHolder.Immutable<I extends DataHolder.Immutable<I>>, DataHolder.Mutable

Nested classes/interfaces inherited from interface org.spongepowered.api.data.SerializableDataHolder

SerializableDataHolder.Immutable<I extends SerializableDataHolder.Immutable<I>>, SerializableDataHolder.Mutable

Method Summary

Modifier and Type	Method	Description
ItemStack	createStack()	Creates a new ItemStack with all the data currently available on this ItemStackSnapshot.
static ItemStackSnapshot	empty()	Gets a empty ItemStackSnapshot.
boolean	isEmpty()	Returns true if quantity() is zero and therefore this ItemStackSnapshot is empty.
int	quantity()	Gets the quantity of items in this the ItemStack this ItemStackSnapshot is representing.
ItemType	type()	Gets the ItemType of this ItemStackSnapshot.

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

mergeWith, mergeWith, transform, transform, with, with, with, without, without, without

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

contentVersion, toContainer

Methods inherited from interface net.kyori.adventure.text.event.HoverEventSource

asHoverEvent, asHoverEvent

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

validateRawData

Methods inherited from interface org.spongepowered.api.data.SerializableDataHolder.Immutable

copy, withRawData

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

get, getDouble, getInt, getKeys, getLong, getOrElse, getOrNull, getValue, getValues, require, requireValue, supports, supports

Method Details

empty

static ItemStackSnapshot empty()

Gets a empty ItemStackSnapshot.

Returns:

The empty item stack snapshot

type

ItemType type()

Gets the ItemType of this ItemStackSnapshot. The ItemType is always available.

Returns:

The item type

quantity

int quantity()

Gets the quantity of items in this the ItemStack this ItemStackSnapshot is representing.

Returns:

The current stack size

isEmpty

boolean isEmpty()

Returns true if quantity() is zero and therefore this ItemStackSnapshot is empty.

Returns:

True if this ItemStackSnapshot is empty

createStack

ItemStack createStack()

Creates a new ItemStack with all the data currently available on this ItemStackSnapshot.

Returns:

The newly generated item stack