Package net.okocraft.box.api.event.stockholder.stock

Class StockDecreaseEvent

java.lang.Object

net.okocraft.box.api.event.BoxEvent

net.okocraft.box.api.event.stockholder.StockHolderEvent

net.okocraft.box.api.event.stockholder.stock.StockEvent

net.okocraft.box.api.event.stockholder.stock.StockDecreaseEvent

public class StockDecreaseEvent
extends StockEvent

A StockEvent called when the stock is decreased.

Nested Class Summary

Nested classes/interfaces inherited from class net.okocraft.box.api.event.stockholder.stock.StockEvent

StockEvent.Cause

Constructor Summary

Constructors

Constructor	Description
StockDecreaseEvent(@NotNull StockHolder stockHolder, @NotNull BoxItem item, int decrements, int currentAmount, @NotNull StockEvent.Cause cause)	The constructor of StockDecreaseEvent.

Method Summary

Modifier and Type	Method	Description
int	getDecrements()	Gets the amount of decreased.
@NotNull String	toDebugLog()	Creates the debug log from this event.
String	toString()

Methods inherited from class net.okocraft.box.api.event.stockholder.stock.StockEvent

getAmount, getCause, getItem

Methods inherited from class net.okocraft.box.api.event.stockholder.StockHolderEvent

getStockHolder

Methods inherited from class java.lang.Object

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

Constructor Details

StockDecreaseEvent

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

The constructor of StockDecreaseEvent.

Parameters:

stockHolder - the stockholder of the event

item - the item of the stock

decrements - the amount of decreased

currentAmount - the current amount of the stock

cause - the cause that indicates why this event was called

Method Details

getDecrements

public int getDecrements()

Gets the amount of decreased.

Returns:

the amount of decreased

toDebugLog

@NotNull
public @NotNull String toDebugLog()

Description copied from class: BoxEvent

Creates the debug log from this event.

Overrides:

toDebugLog in class StockHolderEvent

Returns:

the debug log

toString

public String toString()

Overrides:

toString in class StockHolderEvent