Package net.okocraft.box.api.model.stock

Interface StockEventCaller

public interface StockEventCaller

An interface that is used for calling StockEvents from StockHolder.

Method Summary

Modifier and Type	Method	Description
void	callDecreaseEvent(@NotNull StockHolder stockHolder, @NotNull BoxItem item, int decrements, int currentAmount, StockEvent.Cause cause)	Calls StockDecreaseEvent.
void	callIncreaseEvent(@NotNull StockHolder stockHolder, @NotNull BoxItem item, int increments, int currentAmount, StockEvent.Cause cause)	Calls StockIncreaseEvent.
void	callOverflowEvent(@NotNull StockHolder stockHolder, @NotNull BoxItem item, int increments, int excess, StockEvent.Cause cause)	Calls StockOverflowEvent.
void	callResetEvent(@NotNull StockHolder stockHolder, @NotNull Collection<StockData> stockDataBeforeReset)	Calls StockHolderResetEvent.
void	callSetEvent(@NotNull StockHolder stockHolder, @NotNull BoxItem item, int amount, int previousAmount, StockEvent.Cause cause)	Calls StockSetEvent.
static @NotNull StockEventCaller	createDefault(@NotNull EventCaller<BoxEvent> eventCaller)	Creates a default implementation of StockEventCaller.

Method Details

createDefault

@Contract(value="_ -> new",
          pure=true)
@NotNull
static @NotNull StockEventCaller createDefault(@NotNull
 @NotNull EventCaller<BoxEvent> eventCaller)

Creates a default implementation of StockEventCaller.

Parameters:

eventCaller - a EventCaller to call StockEvents

Returns:

a new StockEventCaller

callSetEvent

void callSetEvent(@NotNull
 @NotNull StockHolder stockHolder,
 @NotNull
 @NotNull BoxItem item,
 int amount,
 int previousAmount,
 @NotNull
 StockEvent.Cause cause)

Calls StockSetEvent.

Parameters:

stockHolder - the source StockHolder

item - the item that has set the amount of stock

amount - the amount of stock

previousAmount - the amount of stock before set

cause - the StockEvent.Cause that is passed to StockHolder.setAmount(BoxItem, int, StockEvent.Cause)

callIncreaseEvent

void callIncreaseEvent(@NotNull
 @NotNull StockHolder stockHolder,
 @NotNull
 @NotNull BoxItem item,
 int increments,
 int currentAmount,
 @NotNull
 StockEvent.Cause cause)

Calls StockIncreaseEvent.

Parameters:

stockHolder - the source StockHolder

item - the item that has set the amount of stock

increments - the amount of increase

currentAmount - the amount of stock after increase

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

callOverflowEvent

void callOverflowEvent(@NotNull
 @NotNull StockHolder stockHolder,
 @NotNull
 @NotNull BoxItem item,
 int increments,
 int excess,
 @NotNull
 StockEvent.Cause cause)

Calls StockOverflowEvent.

Parameters:

stockHolder - the source StockHolder

item - the item that has set the amount of stock

increments - the amount of increase (excess is not included)

excess - the amount exceeding Integer.MAX_VALUE

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

callDecreaseEvent

void callDecreaseEvent(@NotNull
 @NotNull StockHolder stockHolder,
 @NotNull
 @NotNull BoxItem item,
 int decrements,
 int currentAmount,
 @NotNull
 StockEvent.Cause cause)

Calls StockDecreaseEvent.

Parameters:

stockHolder - the source StockHolder

item - the item that has set the amount of stock

decrements - the amount of decrease

currentAmount - the amount of stock after decrease

cause - the StockEvent.Cause that is passed to StockHolder.decrease(BoxItem, int, StockEvent.Cause) or such methods

callResetEvent

void callResetEvent(@NotNull
 @NotNull StockHolder stockHolder,
 @NotNull
 @NotNull Collection<StockData> stockDataBeforeReset)

Calls StockHolderResetEvent.

Parameters:

stockHolder - the source StockHolder

stockDataBeforeReset - the collection of StockData before reset