io.github.portlek.smartinventory

Interface SmartInventory

All Known Implementing Classes:

BasicSmartInventory

public interface SmartInventory

a class that manages all smart inventories.

Field Summary

Fields

Modifier and Type	Field and Description
static List<InventoryOpener>	DEFAULT_OPENERS default inventory openers.
static Function<SmartInventory,List<org.bukkit.event.Listener>>	LISTENERS all listener to register.

Method Summary

Modifier and Type	Method and Description
void	clearContents() clears all contents.
void	clearContentsByInventory() clears all contents by inventory
void	clearLastPages() clears all the latest opened pages.
default void	clearLastPages(@NotNull Predicate<org.bukkit.entity.Player> predicate) clears all the latest opened pages if the predicate returns true.
void	clearPages() clears all pages.
default void	clearPages(@NotNull Predicate<InventoryContents> predicate) clears Pages if the given predicate returns true.
void	clearTask() clears all tasks.
default @NotNull Optional<InventoryOpener>	findOpener(@NotNull org.bukkit.event.inventory.InventoryType type) finds a InventoryOpener from the given InventoryType.
@NotNull Map<org.bukkit.entity.Player,InventoryContents>	getContents() obtains all InventoryContents.
@NotNull Optional<InventoryContents>	getContents(@NotNull org.bukkit.entity.Player player) obtains InventoryContents of the given player.
@NotNull Map<org.bukkit.inventory.Inventory,InventoryContents>	getContentsByInventory() obtains a map that contains Inventory and InventoryContents as key and value.
@NotNull Optional<InventoryContents>	getContentsByInventory(@NotNull org.bukkit.inventory.Inventory inventory) obtains InventoryContents from the given inventory.
@NotNull Optional<Page>	getLastPage(@NotNull org.bukkit.entity.Player player) obtains the latest opened page of the given player.
@NotNull Map<org.bukkit.entity.Player,Page>	getLastPages() obtains the latest opened pages.
default @NotNull List<org.bukkit.entity.Player>	getOpenedPlayers(@NotNull Page page) obtains the players that see the given page.
@NotNull Collection<InventoryOpener>	getOpeners() obtains inventory openers.
@NotNull Optional<Page>	getPage(@NotNull org.bukkit.entity.Player player) obtains the page that seeing by the given player.
@NotNull Map<org.bukkit.entity.Player,Page>	getPages() obtains all opened Page.
@NotNull org.bukkit.plugin.Plugin	getPlugin() obtains the plugin.
@NotNull Optional<org.bukkit.scheduler.BukkitRunnable>	getTask(@NotNull org.bukkit.entity.Player player) obtains the given player's task.
default void	init() initiates the manager.
default void	notifyUpdate(@NotNull org.bukkit.entity.Player player) runs InventoryProvider.update(InventoryContents) method of the player's page.
default <T extends InventoryProvider> void	notifyUpdateForAll(@NotNull Class<T> provider) runs InventoryProvider.update(InventoryContents) method of the given provider's class.
default void	notifyUpdateForAllById(@NotNull String id) runs InventoryProvider.update(InventoryContents) method of the page called the given id.
void	registerOpeners(InventoryOpener... openers) registers the given inventory openers.
void	removeContent(@NotNull org.bukkit.entity.Player player) removes the given player's InventoryContents.
void	removeContentByInventory(@NotNull org.bukkit.inventory.Inventory inventory) removes the given inventory's InventoryContents.
void	removeLastPage(@NotNull org.bukkit.entity.Player player) removes the given player's latest opened Page.
void	removePage(@NotNull org.bukkit.entity.Player player) removes the given player's Page.
void	removeTask(@NotNull org.bukkit.entity.Player player) removes given player of the ticking task.
void	setContents(@NotNull org.bukkit.entity.Player player, @NotNull InventoryContents contest) sets the given player of the contents to the given contents.
void	setContentsByInventory(@NotNull org.bukkit.inventory.Inventory inventory, @NotNull InventoryContents contest) sets the given inventory of the contents to the given contents.
void	setPage(@NotNull org.bukkit.entity.Player player, @NotNull Page page) sets the given player of the page to the given page.
void	setTask(@NotNull org.bukkit.entity.Player player, @NotNull org.bukkit.scheduler.BukkitRunnable task) sets the given player of the ticking task to the given task.
default void	stopTick(@NotNull org.bukkit.entity.Player player) stops the ticking of the given player.
default void	tick(@NotNull org.bukkit.entity.Player player, @NotNull Page page) starts the ticking of the given player with the given page.

Field Detail

LISTENERS

static final Function<SmartInventory,List<org.bukkit.event.Listener>> LISTENERS

all listener to register.

DEFAULT_OPENERS

static final List<InventoryOpener> DEFAULT_OPENERS

default inventory openers.

Method Detail

init

default void init()

initiates the manager.

getOpenedPlayers

@NotNull
default @NotNull List<org.bukkit.entity.Player> getOpenedPlayers(@NotNull
                                                                          @NotNull Page page)

obtains the players that see the given page.

Parameters:

page - the page to obtain.

Returns:

a player list.

notifyUpdate

default void notifyUpdate(@NotNull
                          @NotNull org.bukkit.entity.Player player)

runs InventoryProvider.update(InventoryContents) method of the player's page.

Parameters:

player - the player to notify.

notifyUpdateForAll

default <T extends InventoryProvider> void notifyUpdateForAll(@NotNull
                                                              @NotNull Class<T> provider)

runs InventoryProvider.update(InventoryContents) method of the given provider's class.

Type Parameters:

T - type of the class.

Parameters:

provider - the provider to notify.

notifyUpdateForAllById

default void notifyUpdateForAllById(@NotNull
                                    @NotNull String id)

runs InventoryProvider.update(InventoryContents) method of the page called the given id.

Parameters:

id - the id to find and run the update method.

stopTick

default void stopTick(@NotNull
                      @NotNull org.bukkit.entity.Player player)

stops the ticking of the given player.

Parameters:

player - the player to stop.

tick

default void tick(@NotNull
                  @NotNull org.bukkit.entity.Player player,
                  @NotNull
                  @NotNull Page page)

starts the ticking of the given player with the given page.

Parameters:

player - the player to start.

page - the page to start.

findOpener

@NotNull
default @NotNull Optional<InventoryOpener> findOpener(@NotNull
                                                               @NotNull org.bukkit.event.inventory.InventoryType type)

finds a InventoryOpener from the given InventoryType.

Parameters:

type - the type to find.

Returns:

the inventory opener from the given type.

clearPages

default void clearPages(@NotNull
                        @NotNull Predicate<InventoryContents> predicate)

clears Pages if the given predicate returns true.

Parameters:

predicate - the predicate to check.

clearLastPages

default void clearLastPages(@NotNull
                            @NotNull Predicate<org.bukkit.entity.Player> predicate)

clears all the latest opened pages if the predicate returns true.

Parameters:

predicate - the predicate to check.

getPlugin

@NotNull
@NotNull org.bukkit.plugin.Plugin getPlugin()

obtains the plugin.

Returns:

the plugin.

getOpeners

@NotNull
@NotNull Collection<InventoryOpener> getOpeners()

obtains inventory openers.

Returns:

inventory openers.

getLastPages

@NotNull
@NotNull Map<org.bukkit.entity.Player,Page> getLastPages()

obtains the latest opened pages.

Returns:

the latest opened pages.

getPages

@NotNull
@NotNull Map<org.bukkit.entity.Player,Page> getPages()

obtains all opened Page.

Returns:

all the pages.

getContents

@NotNull
@NotNull Map<org.bukkit.entity.Player,InventoryContents> getContents()

obtains all InventoryContents.

Returns:

all the inventory contents.

getContentsByInventory

@NotNull
@NotNull Map<org.bukkit.inventory.Inventory,InventoryContents> getContentsByInventory()

obtains a map that contains Inventory and InventoryContents as key and value.

Returns:

a map that contains inventory and contents as key and value.

getPage

@NotNull
@NotNull Optional<Page> getPage(@NotNull
                                         @NotNull org.bukkit.entity.Player player)

obtains the page that seeing by the given player.

Parameters:

player - the player to obtain.

Returns:

a Page instance.

getLastPage

@NotNull
@NotNull Optional<Page> getLastPage(@NotNull
                                             @NotNull org.bukkit.entity.Player player)

obtains the latest opened page of the given player.

Parameters:

player - the player to obtain.

Returns:

a Page instance.

getContents

@NotNull
@NotNull Optional<InventoryContents> getContents(@NotNull
                                                          @NotNull org.bukkit.entity.Player player)

obtains InventoryContents of the given player.

Parameters:

player - the player to obtain.

Returns:

an InventoryContents instance.

getContentsByInventory

@NotNull
@NotNull Optional<InventoryContents> getContentsByInventory(@NotNull
                                                                     @NotNull org.bukkit.inventory.Inventory inventory)

obtains InventoryContents from the given inventory.

Parameters:

inventory - the inventory to obtain.

Returns:

an InventoryContents instance.

getTask

@NotNull
@NotNull Optional<org.bukkit.scheduler.BukkitRunnable> getTask(@NotNull
                                                                        @NotNull org.bukkit.entity.Player player)

obtains the given player's task.

Parameters:

player - the player to obtain.

Returns:

a BukkitRunnable instance.

setPage

void setPage(@NotNull
             @NotNull org.bukkit.entity.Player player,
             @NotNull
             @NotNull Page page)

sets the given player of the page to the given page.

Parameters:

player - the player to set.

page - the page to set.

setContents

void setContents(@NotNull
                 @NotNull org.bukkit.entity.Player player,
                 @NotNull
                 @NotNull InventoryContents contest)

sets the given player of the contents to the given contents.

Parameters:

player - the player to set.

contest - the contest to set.

setContentsByInventory

void setContentsByInventory(@NotNull
                            @NotNull org.bukkit.inventory.Inventory inventory,
                            @NotNull
                            @NotNull InventoryContents contest)

sets the given inventory of the contents to the given contents.

Parameters:

inventory - the inventory to set.

contest - the contest to set.

setTask

void setTask(@NotNull
             @NotNull org.bukkit.entity.Player player,
             @NotNull
             @NotNull org.bukkit.scheduler.BukkitRunnable task)

sets the given player of the ticking task to the given task.

Parameters:

player - the player to set.

task - the task to set.

removePage

void removePage(@NotNull
                @NotNull org.bukkit.entity.Player player)

removes the given player's Page.

Parameters:

player - the player to remove.

removeLastPage

void removeLastPage(@NotNull
                    @NotNull org.bukkit.entity.Player player)

removes the given player's latest opened Page.

Parameters:

player - the player to remove.

removeContent

void removeContent(@NotNull
                   @NotNull org.bukkit.entity.Player player)

removes the given player's InventoryContents.

Parameters:

player - the player to remove.

removeContentByInventory

void removeContentByInventory(@NotNull
                              @NotNull org.bukkit.inventory.Inventory inventory)

removes the given inventory's InventoryContents.

Parameters:

inventory - the inventory to remove.

removeTask

void removeTask(@NotNull
                @NotNull org.bukkit.entity.Player player)

removes given player of the ticking task.

Parameters:

player - the player to set.

clearPages

void clearPages()

clears all pages.

clearLastPages

void clearLastPages()

clears all the latest opened pages.

clearContents

void clearContents()

clears all contents.

clearContentsByInventory

void clearContentsByInventory()

clears all contents by inventory

clearTask

void clearTask()

clears all tasks.

registerOpeners

void registerOpeners(@NotNull
                     InventoryOpener... openers)

registers the given inventory openers.

Parameters:

openers - the openers to register.