Package net.okocraft.box.api.model.manager

Interface StockManager

public interface StockManager

An interface to manage StockHolders.

Method Summary

Modifier and Type	Method	Description
@NotNull StockHolder	createStockHolder(@NotNull UUID uuid, @NotNull String name, @NotNull StockEventCaller eventCaller)	Creates an implementation of StockHolder.
@NotNull StockHolder	createStockHolder(@NotNull UUID uuid, @NotNull String name, @NotNull StockEventCaller eventCaller, @NotNull Collection<StockData> stockData)	Creates an implementation of StockHolder with a collection of StockData.
@NotNull PersonalStockHolder	getPersonalStockHolder(@NotNull BoxUser user)	Gets the PersonalStockHolder of the specified BoxUser.

Method Details

getPersonalStockHolder

@NotNull
@NotNull PersonalStockHolder getPersonalStockHolder(@NotNull
 @NotNull BoxUser user)

Gets the PersonalStockHolder of the specified BoxUser.

Parameters:

user - the BoxUser to get PersonalStockHolder

Returns:

the PersonalStockHolder of the specified BoxUser

createStockHolder

@Contract("_, _, _ -> new")
@NotNull
@NotNull StockHolder createStockHolder(@NotNull
 @NotNull UUID uuid,
 @NotNull
 @NotNull String name,
 @NotNull
 @NotNull StockEventCaller eventCaller)

Creates an implementation of StockHolder.

Parameters:

uuid - the UUID of the StockHolder

name - the name of the StockHolder

eventCaller - the StockEventCaller to call StockEvents

Returns:

a new StockHolder instance

createStockHolder

@Contract("_, _, _, _ -> new")
@NotNull
@NotNull StockHolder createStockHolder(@NotNull
 @NotNull UUID uuid,
 @NotNull
 @NotNull String name,
 @NotNull
 @NotNull StockEventCaller eventCaller,
 @NotNull
 @NotNull Collection<StockData> stockData)

Creates an implementation of StockHolder with a collection of StockData.

Parameters:

uuid - the UUID of the StockHolder

name - the name of the StockHolder

eventCaller - the StockEventCaller to call StockEvents

stockData - a collection of StockData

Returns:

a new StockHolder instance