Package org.spongepowered.api.item.inventory

Interface ItemStack.Builder

All Superinterfaces:

AbstractBuilder<ItemStack>, Buildable.Builder<ItemStack>, Builder<ItemStack,ItemStack.Builder>, CopyableBuilder<ItemStack,ItemStack.Builder>, DataHolderBuilder<ItemStack,ItemStack.Builder>, DataHolderBuilder.Mutable<ItemStack,ItemStack.Builder>, ResettableBuilder<ItemStack,ItemStack.Builder>

Enclosing interface:

ItemStack

public static interface ItemStack.Builder
extends DataHolderBuilder.Mutable<ItemStack,ItemStack.Builder>

Nested Class Summary

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

DataHolderBuilder.Immutable<H extends DataHolder.Immutable<H>,B extends DataHolderBuilder.Immutable<H,B>>, DataHolderBuilder.Mutable<H extends DataHolder.Mutable,B extends DataHolderBuilder.Mutable<H,B>>

Method Summary

Modifier and Type	Method	Description
default ItemStack.Builder	apply(java.util.function.Predicate<ItemStack.Builder> predicate, java.util.function.Consumer<ItemStack.Builder> consumer)
default ItemStack.Builder	attributeModifier(java.util.function.Supplier<? extends AttributeType> attributeType, AttributeModifier modifier, DefaultedRegistryReference<? extends EquipmentType> equipmentType)	Adds an AttributeModifier to this item stack.
ItemStack.Builder	attributeModifier(AttributeType attributeType, AttributeModifier modifier, EquipmentType equipmentType)	Adds an AttributeModifier to this item stack.
ItemStack	build()	Builds an instance of an ItemStack.
ItemType	currentItem()
ItemStack.Builder	fromBlockSnapshot(BlockSnapshot blockSnapshot)	Attempts to reconstruct a BlockSnapshot including all data and BlockEntity related data if necessary for creating an ItemStack representation.
default ItemStack.Builder	fromBlockState(java.util.function.Supplier<? extends BlockState> blockState)	Sets the data to recreate a BlockState in a held ItemStack state.
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.
default ItemStack.Builder	itemType(java.util.function.Supplier<? extends ItemType> itemType)	Sets the ItemType of the item stack.
ItemStack.Builder	itemType(ItemType itemType)	Sets the ItemType of the item stack.
ItemStack.Builder	quantity(int quantity)	Sets the quantity of the item stack.

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

add, add, add, add, add, addFrom, from, reset

Method Detail

itemType

ItemStack.Builder itemType(ItemType itemType)

Sets the ItemType of the item stack.

Parameters:

itemType - The type of item

Returns:

This builder, for chaining

itemType

default ItemStack.Builder itemType(java.util.function.Supplier<? extends ItemType> itemType)

Sets the ItemType of the item stack.

Parameters:

itemType - The type of item

Returns:

This builder, for chaining

currentItem

ItemType currentItem()

quantity

ItemStack.Builder quantity(int quantity)
                    throws java.lang.IllegalArgumentException

Sets the quantity of the item stack.

Parameters:

quantity - The quantity of the item stack

Returns:

This builder, for chaining

Throws:

java.lang.IllegalArgumentException - If the quantity is outside the allowed bounds

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

attributeModifier

default ItemStack.Builder attributeModifier(java.util.function.Supplier<? extends AttributeType> attributeType,
                                            AttributeModifier modifier,
                                            DefaultedRegistryReference<? extends EquipmentType> equipmentType)

Adds an AttributeModifier to this item stack.

Parameters:

attributeType - The Attribute type.

modifier - The Attribute modifier.

equipmentType - The equipment type this AttributeModifier will apply to.

Returns:

This builder, for chaining

attributeModifier

ItemStack.Builder attributeModifier(AttributeType attributeType,
                                    AttributeModifier modifier,
                                    EquipmentType equipmentType)

Adds an AttributeModifier to this item stack.

Parameters:

attributeType - The Attribute type.

modifier - The Attribute modifier.

equipmentType - The equipment type this AttributeModifier will apply to.

Returns:

This builder, for chaining

fromBlockState

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

fromBlockState

default ItemStack.Builder fromBlockState(java.util.function.Supplier<? extends 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 BlockEntity related data if necessary for creating an ItemStack representation.

Parameters:

blockSnapshot - The snapshot to use

Returns:

This builder, for chaining

apply

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

build

ItemStack build()
         throws java.lang.IllegalStateException

Builds an instance of an ItemStack.

Specified by:

build in interface AbstractBuilder<ItemStack>

Specified by:

build in interface Buildable.Builder<ItemStack>

Returns:

A new instance of an ItemStack

Throws:

java.lang.IllegalStateException - If the item stack is not completed