org.spongepowered.api.item.inventory

Interface ItemStackSnapshot

All Superinterfaces:

DataSerializable, ImmutableDataHolder<ItemStackSnapshot>, ImmutableValueStore<ItemStackSnapshot,ImmutableDataManipulator<?,?>>, PropertyHolder, Translatable, ValueContainer<ItemStackSnapshot>

public interface ItemStackSnapshot
extends ImmutableDataHolder<ItemStackSnapshot>, Translatable

Represents a snapshot of an ItemStack as an ImmutableDataHolder 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.

Field Summary

Fields

Modifier and Type	Field and Description
static ItemStackSnapshot	NONE

Method Summary

Modifier and Type	Method and Description
GameDictionary.Entry	createGameDictionaryEntry() Creates a GameDictionary.Entry that compares stacks to this ItemStackSnapshot.
ItemStack	createStack() Creates a new ItemStack with all the data currently available on this ItemStackSnapshot.
default int	getCount() Deprecated. Use getQuantity()
int	getQuantity() Gets the quantity of items in this the ItemStack this ItemStackSnapshot is representing.
ItemType	getType() Gets the ItemType of this ItemStackSnapshot.
boolean	isEmpty() Returns true if getQuantity() is zero and therefore this ItemStackSnapshot is empty.

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

getManipulators

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.immutable.ImmutableValueStore

get, getContainers, getOrCreate, merge, merge, supports, transform, with, with, with, with, without

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

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

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

getTranslation

Field Detail

NONE

static final ItemStackSnapshot NONE

Method Detail

getType

ItemType getType()

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

Returns:

The item type

getCount

@Deprecated
default int getCount()

Deprecated. Use getQuantity()

Gets the current stack size count of the ItemStack this ItemStackSnapshot is representing.

Returns:

The current stack size

getQuantity

int getQuantity()

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

Returns:

The current stack size

isEmpty

boolean isEmpty()

Returns true if getQuantity() 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

createGameDictionaryEntry

GameDictionary.Entry createGameDictionaryEntry()

Creates a GameDictionary.Entry that compares stacks to this ItemStackSnapshot. Note that not all data stored in this ItemStackSnapshot may be stored in the returned entry.

Returns:

A GameDictionary.Entry based on this ItemStackSnapshot