Package net.okocraft.box.api.transaction

Interface StockHolderTransaction.Withdrawal

Enclosing class:

StockHolderTransaction

public static interface StockHolderTransaction.Withdrawal

An interface to withdraw items from StockHolder.

Method Summary

Modifier and Type	Method	Description
@NotNull TransactionResult	toInventory(@NotNull Inventory inventory, StockEvent.Cause cause)	Withdraws items to Inventory.
@NotNull TransactionResult	toTopInventory(@NotNull InventoryView view, StockEvent.Cause cause)	Withdraws items to InventoryView.getTopInventory().

Method Details

toInventory

@NotNull
@NotNull TransactionResult toInventory(@NotNull
 @NotNull Inventory inventory,
 @NotNull
 StockEvent.Cause cause)

Withdraws items to Inventory.

Parameters:

inventory - an Inventory to put items in

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

Returns:

a TransactionResult

Throws:

NullPointerException - if inventory or cause is null

toTopInventory

@NotNull
@NotNull TransactionResult toTopInventory(@NotNull
 @NotNull InventoryView view,
 @NotNull
 StockEvent.Cause cause)

Withdraws items to InventoryView.getTopInventory().

This method calls InventoryClickEvents before putting the item in.

Parameters:

view - an InventoryView to put items in

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

Returns:

a TransactionResult

Throws:

NullPointerException - if view or cause is null