org.spongepowered.api.item.inventory

Interface ItemStack.Builder

All Superinterfaces:

DataBuilder<ItemStack>, ResettableBuilder<ItemStack,DataBuilder<ItemStack>>

Enclosing interface:

ItemStack

public static interface ItemStack.Builder
extends DataBuilder<ItemStack>

Method Summary

Modifier and Type	Method and Description
<V> ItemStack.Builder	add(Key<? extends BaseValue<V>> key, V value) Adds a Key and related Object value to apply to the resulting ItemStack.
default ItemStack.Builder	apply(Predicate<ItemStack.Builder> predicate, Consumer<ItemStack.Builder> consumer)
ItemStack	build() Builds an instance of an ItemStack.
ItemStack.Builder	from(ItemStack value) Resets this builder to the values of the given built object.
ItemStack.Builder	fromBlockSnapshot(BlockSnapshot blockSnapshot) Attempts to reconstruct a BlockSnapshot including all data and TileEntity related data if necessary for creating an ItemStack representation.
default ItemStack.Builder	fromBlockState(BlockState blockState) Sets the data to recreate a BlockState in a held ItemStack state.
ItemStack.Builder	fromContainer(DataView container) Attempts to reconstruct the builder with all of the data from DataSerializable.toContainer() including all custom data.
ItemStack.Builder	fromItemStack(ItemStack itemStack) Sets all the settings in this builder from the item stack blueprint.
default ItemStack.Builder	fromSnapshot(ItemStackSnapshot snapshot) Reconstructs this builder to use the ItemStackSnapshot for all the values and data it may contain.
ItemType	getCurrentItem()
ItemStack.Builder	itemData(DataManipulator<?,?> itemData) Sets the DataManipulator to add to the ItemStack.
ItemStack.Builder	itemData(ImmutableDataManipulator<?,?> itemData) Sets the ImmutableDataManipulator to add to the ItemStack.
ItemStack.Builder	itemType(ItemType itemType) Sets the ItemType of the item stack.
default <E> ItemStack.Builder	keyValue(Key<? extends BaseValue<E>> key, E value) Deprecated. As of API 7 due to being a duplicate method. Accomplishes the same thing as add(Key, Object), so is not needed alongside that, expected for removal in API 8 or 9. Use add(Key, Object) instead
ItemStack.Builder	quantity(int quantity) Sets the quantity of the item stack.
ItemStack.Builder	remove(Class<? extends DataManipulator<?,?>> manipulatorClass)

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

build, reset

Method Detail

from

ItemStack.Builder from(ItemStack value)

Description copied from interface: ResettableBuilder

Resets this builder to the values of the given built object.

Specified by:

from in interface DataBuilder<ItemStack>

Specified by:

from in interface ResettableBuilder<ItemStack,DataBuilder<ItemStack>>

Parameters:

value - The built object

Returns:

This builder, for chaining

itemType

ItemStack.Builder itemType(ItemType itemType)

Sets the ItemType of the item stack.

Parameters:

itemType - The type of item

Returns:

This builder, for chaining

getCurrentItem

ItemType getCurrentItem()

quantity

ItemStack.Builder quantity(int quantity)
                    throws IllegalArgumentException

Sets the quantity of the item stack.

Parameters:

quantity - The quantity of the item stack

Returns:

This builder, for chaining

Throws:

IllegalArgumentException - If the quantity is outside the allowed bounds

keyValue

@Deprecated
default <E> ItemStack.Builder keyValue(Key<? extends BaseValue<E>> key,
                                                   E value)

Deprecated. As of API 7 due to being a duplicate method. Accomplishes the same thing as add(Key, Object), so is not needed alongside that, expected for removal in API 8 or 9. Use add(Key, Object) instead

Adds a Key and related Object value to apply to the resulting ItemStack. Note that the resulting ItemStack may not actually accept the provided Key for various reasons due to support or simply that the value itself is not supported. Offering custom data is not supported through this, use itemData(DataManipulator) instead.

Type Parameters:

E - The type of value

Parameters:

key - The key to identify the value with

value - The value to apply

Returns:

This builder, for chaining

itemData

ItemStack.Builder itemData(DataManipulator<?,?> itemData)
                    throws IllegalArgumentException

Sets the DataManipulator to add to the ItemStack.

Parameters:

itemData - The item data to set

Returns:

This builder, for chaining

Throws:

IllegalArgumentException - If the item data is incompatible with the item

itemData

ItemStack.Builder itemData(ImmutableDataManipulator<?,?> itemData)
                    throws IllegalArgumentException

Sets the ImmutableDataManipulator to add to the ItemStack.

Parameters:

itemData - The item data to set

Returns:

This builder, for chaining

Throws:

IllegalArgumentException - If the item data is incompatible

add

<V> ItemStack.Builder add(Key<? extends BaseValue<V>> key,
                          V value)
                   throws IllegalArgumentException

Adds a Key and related Object value to apply to the resulting ItemStack. Note that the resulting ItemStack may not actually accept the provided Key for various reasons due to support or simply that the value itself is not supported. Offering custom data is not supported through this, use itemData(DataManipulator) instead.

Type Parameters:

V - The type of the value

Parameters:

key - The key to assign the value with

value - The value to assign with the key

Returns:

This builder, for chaining

Throws:

IllegalArgumentException - If the item data is incompatible

fromItemStack

ItemStack.Builder fromItemStack(ItemStack itemStack)

Sets all the settings in this builder from the item stack blueprint.

Parameters:

itemStack - The item stack to copy

Returns:

This builder, for chaining

fromBlockState

default ItemStack.Builder fromBlockState(BlockState blockState)

Sets the data to recreate a BlockState in a held ItemStack state.

Parameters:

blockState - The block state to use

Returns:

This builder, for chaining

fromContainer

ItemStack.Builder fromContainer(DataView container)

Attempts to reconstruct the builder with all of the data from DataSerializable.toContainer() including all custom data.

Parameters:

container - The container to translate

Returns:

This builder, for chaining

fromSnapshot

default ItemStack.Builder fromSnapshot(ItemStackSnapshot snapshot)

Reconstructs this builder to use the ItemStackSnapshot for all the values and data it may contain.

Parameters:

snapshot - The snapshot

Returns:

This builder, for chaining

fromBlockSnapshot

ItemStack.Builder fromBlockSnapshot(BlockSnapshot blockSnapshot)

Attempts to reconstruct a BlockSnapshot including all data and TileEntity related data if necessary for creating an ItemStack representation.

Parameters:

blockSnapshot - The snapshot to use

Returns:

This builder, for chaining

remove

ItemStack.Builder remove(Class<? extends DataManipulator<?,?>> manipulatorClass)

apply

default ItemStack.Builder apply(Predicate<ItemStack.Builder> predicate,
                                Consumer<ItemStack.Builder> consumer)

build

ItemStack build()
         throws IllegalStateException

Builds an instance of an ItemStack.

Returns:

A new instance of an ItemStack

Throws:

IllegalStateException - If the item stack is not completed