Package net.okocraft.box.api.transaction

Interface StockHolderTransaction.Deposit

Enclosing class:

StockHolderTransaction

public static interface StockHolderTransaction.Deposit

An interface to deposit items to StockHolder.

Method Summary

Modifier and Type	Method	Description
@NotNull @Unmodifiable List<TransactionResult>	fromInventory(@NotNull Inventory inventory, StockEvent.Cause cause)	Deposits items from Inventory.
@NotNull @Unmodifiable List<TransactionResult>	fromTopInventory(@NotNull InventoryView view, StockEvent.Cause cause)	Deposits items from InventoryView.getTopInventory().

Method Details

fromInventory

@NotNull
@NotNull @Unmodifiable List<TransactionResult> fromInventory(@NotNull
 @NotNull Inventory inventory,
 @NotNull
 StockEvent.Cause cause)

Deposits items from Inventory.

If no items are deposited, this method returns Collections.emptyList()

Parameters:

inventory - an Inventory to pull out items

cause - a StockEvent.Cause that is passed to StockHolder.increase(BoxItem, int, StockEvent.Cause)

Returns:

a list that contains TransactionResults per item or Collections.emptyList() if no items are deposited

Throws:

NullPointerException - if inventory or cause is null

fromTopInventory

@NotNull
@NotNull @Unmodifiable List<TransactionResult> fromTopInventory(@NotNull
 @NotNull InventoryView view,
 @NotNull
 StockEvent.Cause cause)

Deposits items from InventoryView.getTopInventory().

If no items are deposited, this method returns Collections.emptyList()

This method calls InventoryClickEvents before pulling out the item.

Parameters:

view - an InventoryView to get top Inventory

cause - a StockEvent.Cause that is passed to StockHolder.increase(BoxItem, int, StockEvent.Cause)

Returns:

a list that contains TransactionResults per item or Collections.emptyList() if no items are deposited

Throws:

NullPointerException - if view or cause is null