org.spongepowered.api.item.inventory

Interface Inventory.Builder

All Superinterfaces:

ResettableBuilder<Inventory,Inventory.Builder>

Enclosing interface:

Inventory

public static interface Inventory.Builder
extends ResettableBuilder<Inventory,Inventory.Builder>

A Builder for Inventories based on InventoryArchetypes.

Method Summary

Modifier and Type	Method and Description
Inventory	build(Object plugin) Builds the Inventory.
Inventory.Builder	forCarrier(Carrier carrier) Sets the InventoryArchetype and Properties according to the Carriers Inventory.
Inventory.Builder	forCarrier(Class<? extends Carrier> carrier) Sets the InventoryArchetype and Properties for a default Inventory of given Carrier.
<E extends InteractInventoryEvent> Inventory.Builder	listener(Class<E> type, Consumer<E> listener) Registers a listener for given Event type
Inventory.Builder	of(InventoryArchetype archetype) Sets the base InventoryArchetype for the Inventory.
Inventory.Builder	property(InventoryProperty<?,?> property) Sets an InventoryProperty with its default key.
Inventory.Builder	property(String name, InventoryProperty<?,?> property) Sets an InventoryProperty.
Inventory.Builder	withCarrier(Carrier carrier) Sets the Carrier that carries the Inventory.

Methods inherited from interface org.spongepowered.api.util.ResettableBuilder

from, reset

Method Detail

of

Inventory.Builder of(InventoryArchetype archetype)

Sets the base InventoryArchetype for the Inventory.

Parameters:

archetype - The InventoryArchetype

Returns:

Fluent pattern

property

Inventory.Builder property(String name,
                           InventoryProperty<?,?> property)

Sets an InventoryProperty.

Parameters:

name - The name

property - The property

Returns:

Fluent pattern

property

Inventory.Builder property(InventoryProperty<?,?> property)

Sets an InventoryProperty with its default key.

Parameters:

property - The property

Returns:

Fluent pattern

withCarrier

Inventory.Builder withCarrier(Carrier carrier)

Sets the Carrier that carries the Inventory.

Parameters:

carrier - The Carrier

Returns:

Fluent pattern

listener

<E extends InteractInventoryEvent> Inventory.Builder listener(Class<E> type,
                                                              Consumer<E> listener)

Registers a listener for given Event type

Parameters:

type - The type

listener - The listener

Returns:

Fluent pattern

forCarrier

Inventory.Builder forCarrier(Carrier carrier)

Sets the InventoryArchetype and Properties according to the Carriers Inventory.

Parameters:

carrier - The Carrier

Returns:

Fluent pattern

forCarrier

Inventory.Builder forCarrier(Class<? extends Carrier> carrier)

Sets the InventoryArchetype and Properties for a default Inventory of given Carrier.

Parameters:

carrier - The Carrier class

Returns:

Fluent pattern

build

Inventory build(Object plugin)

Builds the Inventory.

Parameters:

plugin - The plugin building this inventory

Returns:

The new Inventory instance