io.github.portlek.smartinventory.manager

Class BasicSmartInventory

java.lang.Object

io.github.portlek.smartinventory.manager.BasicSmartInventory

All Implemented Interfaces:

SmartInventory

public final class BasicSmartInventory
extends Object
implements SmartInventory

an implementation for SmartInventory.

Field Summary

Fields inherited from interface io.github.portlek.smartinventory.SmartInventory

DEFAULT_OPENERS, LISTENERS

Constructor Summary

Constructors

Constructor and Description
BasicSmartInventory(@NotNull org.bukkit.plugin.Plugin plugin)

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.
void	clearPages() clears all pages.
void	clearTask() clears all tasks.
@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.
@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.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.portlek.smartinventory.SmartInventory

clearLastPages, clearPages, findOpener, getOpenedPlayers, init, notifyUpdate, notifyUpdateForAll, notifyUpdateForAllById, stopTick, tick

Constructor Detail

BasicSmartInventory

public BasicSmartInventory(@NotNull
                           @NotNull org.bukkit.plugin.Plugin plugin)

Method Detail

getPlugin

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

Description copied from interface: SmartInventory

obtains the plugin.

Specified by:

getPlugin in interface SmartInventory

Returns:

the plugin.

getOpeners

@NotNull
public @NotNull Collection<InventoryOpener> getOpeners()

Description copied from interface: SmartInventory

obtains inventory openers.

Specified by:

getOpeners in interface SmartInventory

Returns:

inventory openers.

getLastPages

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

Description copied from interface: SmartInventory

obtains the latest opened pages.

Specified by:

getLastPages in interface SmartInventory

Returns:

the latest opened pages.

getPages

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

Description copied from interface: SmartInventory

obtains all opened Page.

Specified by:

getPages in interface SmartInventory

Returns:

all the pages.

getContents

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

Description copied from interface: SmartInventory

obtains all InventoryContents.

Specified by:

getContents in interface SmartInventory

Returns:

all the inventory contents.

getContentsByInventory

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

Description copied from interface: SmartInventory

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

Specified by:

getContentsByInventory in interface SmartInventory

Returns:

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

getPage

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

Description copied from interface: SmartInventory

obtains the page that seeing by the given player.

Specified by:

getPage in interface SmartInventory

Parameters:

player - the player to obtain.

Returns:

a Page instance.

getLastPage

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

Description copied from interface: SmartInventory

obtains the latest opened page of the given player.

Specified by:

getLastPage in interface SmartInventory

Parameters:

player - the player to obtain.

Returns:

a Page instance.

getContents

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

Description copied from interface: SmartInventory

obtains InventoryContents of the given player.

Specified by:

getContents in interface SmartInventory

Parameters:

player - the player to obtain.

Returns:

an InventoryContents instance.

getContentsByInventory

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

Description copied from interface: SmartInventory

obtains InventoryContents from the given inventory.

Specified by:

getContentsByInventory in interface SmartInventory

Parameters:

inventory - the inventory to obtain.

Returns:

an InventoryContents instance.

getTask

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

Description copied from interface: SmartInventory

obtains the given player's task.

Specified by:

getTask in interface SmartInventory

Parameters:

player - the player to obtain.

Returns:

a BukkitRunnable instance.

setPage

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

Description copied from interface: SmartInventory

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

Specified by:

setPage in interface SmartInventory

Parameters:

player - the player to set.

page - the page to set.

setContents

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

Description copied from interface: SmartInventory

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

Specified by:

setContents in interface SmartInventory

Parameters:

player - the player to set.

contest - the contest to set.

setContentsByInventory

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

Description copied from interface: SmartInventory

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

Specified by:

setContentsByInventory in interface SmartInventory

Parameters:

inventory - the inventory to set.

contest - the contest to set.

setTask

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

Description copied from interface: SmartInventory

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

Specified by:

setTask in interface SmartInventory

Parameters:

player - the player to set.

task - the task to set.

removePage

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

Description copied from interface: SmartInventory

removes the given player's Page.

Specified by:

removePage in interface SmartInventory

Parameters:

player - the player to remove.

removeLastPage

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

Description copied from interface: SmartInventory

removes the given player's latest opened Page.

Specified by:

removeLastPage in interface SmartInventory

Parameters:

player - the player to remove.

removeContent

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

Description copied from interface: SmartInventory

removes the given player's InventoryContents.

Specified by:

removeContent in interface SmartInventory

Parameters:

player - the player to remove.

removeContentByInventory

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

Description copied from interface: SmartInventory

removes the given inventory's InventoryContents.

Specified by:

removeContentByInventory in interface SmartInventory

Parameters:

inventory - the inventory to remove.

removeTask

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

Description copied from interface: SmartInventory

removes given player of the ticking task.

Specified by:

removeTask in interface SmartInventory

Parameters:

player - the player to set.

clearPages

public void clearPages()

Description copied from interface: SmartInventory

clears all pages.

Specified by:

clearPages in interface SmartInventory

clearLastPages

public void clearLastPages()

Description copied from interface: SmartInventory

clears all the latest opened pages.

Specified by:

clearLastPages in interface SmartInventory

clearContents

public void clearContents()

Description copied from interface: SmartInventory

clears all contents.

Specified by:

clearContents in interface SmartInventory

clearContentsByInventory

public void clearContentsByInventory()

Description copied from interface: SmartInventory

clears all contents by inventory

Specified by:

clearContentsByInventory in interface SmartInventory

clearTask

public void clearTask()

Description copied from interface: SmartInventory

clears all tasks.

Specified by:

clearTask in interface SmartInventory

registerOpeners

public void registerOpeners(@NotNull
                            InventoryOpener... openers)

Description copied from interface: SmartInventory

registers the given inventory openers.

Specified by:

registerOpeners in interface SmartInventory

Parameters:

openers - the openers to register.