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

Class StockOverflowEvent

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.StockIncreaseEvent

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

public class StockOverflowEvent
extends StockIncreaseEvent

A StockEvent called when the amount of stock exceeds Integer.MAX_VALUE.

Nested Class Summary

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

StockEvent.Cause

Constructor Summary

Constructors

Constructor	Description
StockOverflowEvent(@NotNull StockHolder stockHolder, @NotNull BoxItem item, int increments, int excess, @NotNull StockEvent.Cause cause)	The constructor of StockOverflowEvent.

Method Summary

Modifier and Type	Method	Description
int	getExcess()	Gets the amount exceeding Integer.MAX_VALUE.
@NotNull String	toDebugLog()	Creates the debug log from this event.
String	toString()

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

getIncrements

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

StockOverflowEvent

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

The constructor of StockOverflowEvent.

Parameters:

stockHolder - the StockHolder of this event

item - the item that has overflowed the amount of stock

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

excess - the amount exceeding Integer.MAX_VALUE

cause - the cause that indicates why this event was called

Method Details

getExcess

public int getExcess()

Gets the amount exceeding Integer.MAX_VALUE.

Returns:

the amount exceeding Integer.MAX_VALUE

toDebugLog

@NotNull
public @NotNull String toDebugLog()

Description copied from class: BoxEvent

Creates the debug log from this event.

Overrides:

toDebugLog in class StockIncreaseEvent

Returns:

the debug log

toString

public String toString()

Overrides:

toString in class StockIncreaseEvent