Package net.okocraft.box.api.transaction

Class StockHolderTransaction

java.lang.Object

net.okocraft.box.api.transaction.StockHolderTransaction

public final class StockHolderTransaction
extends Object

A utility class for transacting items between StockHolder and Inventory.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StockHolderTransaction.Deposit	An interface to deposit items to StockHolder.
static interface	StockHolderTransaction.Withdrawal	An interface to withdraw items from StockHolder.

Method Summary

Modifier and Type	Method	Description
static @NotNull StockHolderTransaction	create(@NotNull StockHolder stockHolder)	Creates a StockHolderTransaction.
@NotNull StockHolderTransaction.Deposit	deposit(@NotNull BoxItem item, int limit)	Creates a StockHolderTransaction.Deposit instance that depositing the specified BoxItem.
@NotNull StockHolderTransaction.Deposit	depositAll()	Creates a StockHolderTransaction.Deposit instance that depositing all items that can be deposited.
@NotNull StockHolderTransaction.Deposit	depositAll(@NotNull Predicate<BoxItem> filter)	Creates a StockHolderTransaction.Deposit instance that depositing filtered items that can be deposited.
@NotNull StockHolderTransaction.Withdrawal	withdraw(@NotNull BoxItem item, int limit)	Creates a StockHolderTransaction.Withdrawal instance that withdrawing the specified BoxItem.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Contract("_ -> new")
@NotNull
public static @NotNull StockHolderTransaction create(@NotNull
 @NotNull StockHolder stockHolder)

Creates a StockHolderTransaction.

Parameters:

stockHolder - a StockHolder to transact

Returns:

a new StockHolderTransaction

Throws:

NullPointerException - if stockHolder is null

deposit

@NotNull
public @NotNull StockHolderTransaction.Deposit deposit(@NotNull
 @NotNull BoxItem item,
 int limit)

Creates a StockHolderTransaction.Deposit instance that depositing the specified BoxItem.

Parameters:

item - a BoxItem to deposit to the StockHolder

limit - a maximum amount to deposit

Returns:

a StockHolderTransaction.Deposit instance

Throws:

NullPointerException - if item is null

depositAll

@NotNull
public @NotNull StockHolderTransaction.Deposit depositAll()

Creates a StockHolderTransaction.Deposit instance that depositing all items that can be deposited.

Returns:

a StockHolderTransaction.Deposit instance

depositAll

@NotNull
public @NotNull StockHolderTransaction.Deposit depositAll(@NotNull
 @NotNull Predicate<BoxItem> filter)

Creates a StockHolderTransaction.Deposit instance that depositing filtered items that can be deposited.

Parameters:

filter - a Predicate to filter BoxItems

Returns:

a StockHolderTransaction.Deposit instance

Throws:

NullPointerException - if filter is null

withdraw

@NotNull
public @NotNull StockHolderTransaction.Withdrawal withdraw(@NotNull
 @NotNull BoxItem item,
 int limit)

Creates a StockHolderTransaction.Withdrawal instance that withdrawing the specified BoxItem.

Parameters:

item - a BoxItem to withdraw from the StockHolder

limit - a maximum amount to withdraw

Returns:

a StockHolderTransaction.Withdrawal instance

Throws:

NullPointerException - if item is null