io.github.portlek.smartinventory

Interface Page

All Known Implementing Classes:

BasicPage

public interface Page

an interface to determine Inventory.

Method Summary

Modifier and Type	Method and Description
<T extends PageEvent> void	accept(T event) accepts the upcoming event.
boolean	async() obtains status of the task in terms of async.
@NotNull Page	async(boolean async) sets the task's async status.
static Page	build(@NotNull SmartInventory inventory) creates a simple page instance from the given inventory.
static Page	build(@NotNull SmartInventory inventory, @NotNull InventoryProvider provider) creates a simple page instance from the given parameters.
default @NotNull Page	canClose(boolean canClose) sets the can close to the given boolean.
boolean	canClose(@NotNull CloseEvent event) checks the can close with the given event.
@NotNull Page	canClose(@NotNull Predicate<CloseEvent> predicate) sets the can close predicate of the page.
default boolean	checkBounds(int row, int column) checks the bounds.
void	close(@NotNull org.bukkit.entity.Player player) closes the player's page.
int	column() obtains column of the page.
@NotNull Page	column(int column) set the column of the page.
default <T extends PageEvent> @NotNull Page	handle(@NotNull Class<T> clazz, @NotNull Consumer<T> consumer, @NotNull List<Predicate<T>> requirements) adds the given consumer.
<T extends PageEvent> @NotNull Page	handle(@NotNull Handle<T> handle) adds the given handle.
@NotNull String	id() obtains id of the page.
@NotNull Page	id(@NotNull String id) sets the id of the page.
@NotNull SmartInventory	inventory() obtains the page's inventory manager.
void	notifyUpdate(@NotNull InventoryContents contents) runs the provider()'s InventoryProvider.update(InventoryContents) method with the given contents.
default void	notifyUpdateForAll() runs the InventoryProvider.update(InventoryContents) methods for all players who opened this.
default void	notifyUpdateForAllById() runs the InventoryProvider.update(InventoryContents) methods for all players who opened this.
default void	open(@NotNull org.bukkit.entity.Player player) opens the page to the given player.
default void	open(@NotNull org.bukkit.entity.Player player, int page) opens the page to the given player.
@NotNull org.bukkit.inventory.Inventory	open(@NotNull org.bukkit.entity.Player player, int page, @NotNull Map<String,Object> properties) opens the page for the player.
default void	open(@NotNull org.bukkit.entity.Player player, @NotNull Map<String,Object> properties) opens the page to the given player.
@NotNull Optional<Page>	parent() obtains tha parent page of this.
@NotNull Page	parent(@NotNull Page parent) sets the parent of the page.
@NotNull InventoryProvider	provider() obtains the inventory provider.
@NotNull Page	provider(@NotNull InventoryProvider provider) sets the provider to the given provider
int	row() obtains row of the page.
@NotNull Page	row(int row) set the row of the page.
long	startDelay() obtains the start delay for the task.
@NotNull Page	startDelay(long startDelay) sets the start delay of the task.
long	tick() obtains the tick amount.
@NotNull Page	tick(long tick) sets the tick.
boolean	tickEnable() obtains the task enable.
@NotNull Page	tickEnable(boolean tickEnable) sets the task's activity.
@NotNull String	title() obtains title of the page.
@NotNull Page	title(@NotNull String title) sets the title of the page.
default @NotNull Page	whenBottomClick(@NotNull Consumer<BottomClickEvent> consumer) adds the given consumer as a bottom inventory click event.
default @NotNull Page	whenBottomClick(@NotNull Consumer<BottomClickEvent> consumer, @NotNull List<Predicate<BottomClickEvent>> requirements) adds the given consumer as a bottom inventory click event.
default @NotNull Page	whenClose(@NotNull Consumer<CloseEvent> consumer) adds the given consumer as a close event.
default @NotNull Page	whenClose(@NotNull Consumer<CloseEvent> consumer, @NotNull List<Predicate<CloseEvent>> requirements) adds the given consumer as a close event.
default @NotNull Page	whenEmptyClick(@NotNull Consumer<PageClickEvent> consumer) adds the given consumer as a empty slot click event.
default @NotNull Page	whenEmptyClick(@NotNull Consumer<PageClickEvent> consumer, @NotNull List<Predicate<PageClickEvent>> requirements) adds the given consumer as a empty slot click event.
default @NotNull Page	whenInit(@NotNull Consumer<InitEvent> consumer) adds the given consumer as a init event.
default @NotNull Page	whenInit(@NotNull Consumer<InitEvent> consumer, @NotNull List<Predicate<InitEvent>> requirements) adds the given consumer as a init event.
default @NotNull Page	whenOpen(@NotNull Consumer<OpenEvent> consumer) adds the given consumer as a open event.
default @NotNull Page	whenOpen(@NotNull Consumer<OpenEvent> consumer, @NotNull List<Predicate<OpenEvent>> requirements) adds the given consumer as a open event.
default @NotNull Page	whenOutsideClick(@NotNull Consumer<OutsideClickEvent> consumer) adds the given consumer as a outside inventory click event.
default @NotNull Page	whenOutsideClick(@NotNull Consumer<OutsideClickEvent> consumer, @NotNull List<Predicate<OutsideClickEvent>> requirements) adds the given consumer as a outside inventory click event.
default @NotNull Page	whenTick(@NotNull Consumer<TickEvent> consumer) adds the given consumer as a tick event.
default @NotNull Page	whenTick(@NotNull Consumer<TickEvent> consumer, @NotNull List<Predicate<TickEvent>> requirements) adds the given consumer as a tick event.
default @NotNull Page	whenUpdate(@NotNull Consumer<UpdateEvent> consumer) adds the given consumer as a update event.
default @NotNull Page	whenUpdate(@NotNull Consumer<UpdateEvent> consumer, @NotNull List<Predicate<UpdateEvent>> requirements) adds the given consumer as a update event.

Method Detail

build

static Page build(@NotNull
                  @NotNull SmartInventory inventory,
                  @NotNull
                  @NotNull InventoryProvider provider)

creates a simple page instance from the given parameters.

Parameters:

inventory - the inventory to create.

provider - the provider to create.

Returns:

a simple page instance.

build

static Page build(@NotNull
                  @NotNull SmartInventory inventory)

creates a simple page instance from the given inventory.

Parameters:

inventory - the inventory to create.

Returns:

a simple page instance.

whenClose

@NotNull
default @NotNull Page whenClose(@NotNull
                                         @NotNull Consumer<CloseEvent> consumer)

adds the given consumer as a close event.

Parameters:

consumer - the consumer to add.

Returns:

this, for chained calls.

whenClose

@NotNull
default @NotNull Page whenClose(@NotNull
                                         @NotNull Consumer<CloseEvent> consumer,
                                         @NotNull
                                         @NotNull List<Predicate<CloseEvent>> requirements)

adds the given consumer as a close event.

Parameters:

consumer - the consumer to add.

requirements - the requirements to add.

Returns:

this, for chained calls.

whenOpen

@NotNull
default @NotNull Page whenOpen(@NotNull
                                        @NotNull Consumer<OpenEvent> consumer)

adds the given consumer as a open event.

Parameters:

consumer - the consumer to add.

Returns:

this, for chained calls.

whenOpen

@NotNull
default @NotNull Page whenOpen(@NotNull
                                        @NotNull Consumer<OpenEvent> consumer,
                                        @NotNull
                                        @NotNull List<Predicate<OpenEvent>> requirements)

adds the given consumer as a open event.

Parameters:

consumer - the consumer to add.

requirements - the requirements to add.

Returns:

this, for chained calls.

whenInit

@NotNull
default @NotNull Page whenInit(@NotNull
                                        @NotNull Consumer<InitEvent> consumer)

adds the given consumer as a init event.

Parameters:

consumer - the consumer to add.

Returns:

this, for chained calls.

whenInit

@NotNull
default @NotNull Page whenInit(@NotNull
                                        @NotNull Consumer<InitEvent> consumer,
                                        @NotNull
                                        @NotNull List<Predicate<InitEvent>> requirements)

adds the given consumer as a init event.

Parameters:

consumer - the consumer to add.

requirements - the requirements to add.

Returns:

this, for chained calls.

whenUpdate

@NotNull
default @NotNull Page whenUpdate(@NotNull
                                          @NotNull Consumer<UpdateEvent> consumer)

adds the given consumer as a update event.

Parameters:

consumer - the consumer to add.

Returns:

this, for chained calls.

whenUpdate

@NotNull
default @NotNull Page whenUpdate(@NotNull
                                          @NotNull Consumer<UpdateEvent> consumer,
                                          @NotNull
                                          @NotNull List<Predicate<UpdateEvent>> requirements)

adds the given consumer as a update event.

Parameters:

consumer - the consumer to add.

requirements - the requirements to add.

Returns:

this, for chained calls.

whenTick

@NotNull
default @NotNull Page whenTick(@NotNull
                                        @NotNull Consumer<TickEvent> consumer)

adds the given consumer as a tick event.

Parameters:

consumer - the consumer to add.

Returns:

this, for chained calls.

whenTick

@NotNull
default @NotNull Page whenTick(@NotNull
                                        @NotNull Consumer<TickEvent> consumer,
                                        @NotNull
                                        @NotNull List<Predicate<TickEvent>> requirements)

adds the given consumer as a tick event.

Parameters:

consumer - the consumer to add.

requirements - the requirements to add.

Returns:

this, for chained calls.

whenBottomClick

@NotNull
default @NotNull Page whenBottomClick(@NotNull
                                               @NotNull Consumer<BottomClickEvent> consumer)

adds the given consumer as a bottom inventory click event.

Parameters:

consumer - the consumer to add.

Returns:

this, for chained calls.

whenBottomClick

@NotNull
default @NotNull Page whenBottomClick(@NotNull
                                               @NotNull Consumer<BottomClickEvent> consumer,
                                               @NotNull
                                               @NotNull List<Predicate<BottomClickEvent>> requirements)

adds the given consumer as a bottom inventory click event.

Parameters:

consumer - the consumer to add.

requirements - the requirements to add.

Returns:

this, for chained calls.

whenOutsideClick

@NotNull
default @NotNull Page whenOutsideClick(@NotNull
                                                @NotNull Consumer<OutsideClickEvent> consumer)

adds the given consumer as a outside inventory click event.

Parameters:

consumer - the consumer to add.

Returns:

this, for chained calls.

whenOutsideClick

@NotNull
default @NotNull Page whenOutsideClick(@NotNull
                                                @NotNull Consumer<OutsideClickEvent> consumer,
                                                @NotNull
                                                @NotNull List<Predicate<OutsideClickEvent>> requirements)

adds the given consumer as a outside inventory click event.

Parameters:

consumer - the consumer to add.

requirements - the requirements to add.

Returns:

this, for chained calls.

whenEmptyClick

@NotNull
default @NotNull Page whenEmptyClick(@NotNull
                                              @NotNull Consumer<PageClickEvent> consumer)

adds the given consumer as a empty slot click event.

Parameters:

consumer - the consumer to add.

Returns:

this, for chained calls.

whenEmptyClick

@NotNull
default @NotNull Page whenEmptyClick(@NotNull
                                              @NotNull Consumer<PageClickEvent> consumer,
                                              @NotNull
                                              @NotNull List<Predicate<PageClickEvent>> requirements)

adds the given consumer as a empty slot click event.

Parameters:

consumer - the consumer to add.

requirements - the requirements to add.

Returns:

this, for chained calls.

handle

@NotNull
default <T extends PageEvent> @NotNull Page handle(@NotNull
                                                            @NotNull Class<T> clazz,
                                                            @NotNull
                                                            @NotNull Consumer<T> consumer,
                                                            @NotNull
                                                            @NotNull List<Predicate<T>> requirements)

adds the given consumer.

Type Parameters:

T - type of the event.

Parameters:

clazz - the class to determine the type of the event.

consumer - the consumer to add.

requirements - the requirements to add.

Returns:

this, for chained calls.

handle

@NotNull
<T extends PageEvent> @NotNull Page handle(@NotNull
                                                    @NotNull Handle<T> handle)

adds the given handle.

Type Parameters:

T - type of the event.

Parameters:

handle - the handle to add.

Returns:

this, for chained calls.

canClose

@NotNull
default @NotNull Page canClose(boolean canClose)

sets the can close to the given boolean.

Parameters:

canClose - the can close to set.

Returns:

this, for chained calls.

open

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

opens the page to the given player.

Parameters:

player - the player to open.

open

default void open(@NotNull
                  @NotNull org.bukkit.entity.Player player,
                  int page)

opens the page to the given player.

Parameters:

player - the player to open.

page - the page to open.

open

default void open(@NotNull
                  @NotNull org.bukkit.entity.Player player,
                  @NotNull
                  @NotNull Map<String,Object> properties)

opens the page to the given player.

Parameters:

player - the player to open.

properties - the properties to open.

checkBounds

default boolean checkBounds(int row,
                            int column)

checks the bounds.

Parameters:

row - the row to check.

column - the column to check.

Returns:

true if the given row and column are correct for the page size.

notifyUpdateForAll

default void notifyUpdateForAll()

runs the InventoryProvider.update(InventoryContents) methods for all players who opened this.

notifyUpdateForAllById

default void notifyUpdateForAllById()

runs the InventoryProvider.update(InventoryContents) methods for all players who opened this.

notifyUpdate

void notifyUpdate(@NotNull
                  @NotNull InventoryContents contents)

runs the provider()'s InventoryProvider.update(InventoryContents) method with the given contents.

Parameters:

contents - the contents to update.

accept

<T extends PageEvent> void accept(@NotNull
                                  T event)

accepts the upcoming event.

Type Parameters:

T - type of the event.

Parameters:

event - the event to accept.

provider

@NotNull
@NotNull InventoryProvider provider()

obtains the inventory provider.

Returns:

an inventory provider instance.

provider

@NotNull
@NotNull Page provider(@NotNull
                                @NotNull InventoryProvider provider)

sets the provider to the given provider

Parameters:

provider - the provider to set.

Returns:

this, for chained calls.

inventory

@NotNull
@NotNull SmartInventory inventory()

obtains the page's inventory manager.

Returns:

an inventory manager instance.

tick

long tick()

obtains the tick amount.

Returns:

the tick amount.

tick

@NotNull
@NotNull Page tick(long tick)

sets the tick.

Parameters:

tick - the tick to set.

Returns:

this, for chained calls.

startDelay

long startDelay()

obtains the start delay for the task.

Returns:

the start delay for the task.

startDelay

@NotNull
@NotNull Page startDelay(long startDelay)

sets the start delay of the task.

Parameters:

startDelay - the start delay to set.

Returns:

this, for chained calls.

async

boolean async()

obtains status of the task in terms of async.

Returns:

status of the task in terms of async.

async

@NotNull
@NotNull Page async(boolean async)

sets the task's async status.

Parameters:

async - the async to set.

Returns:

this, for chained calls.

tickEnable

boolean tickEnable()

obtains the task enable.

Returns:

true if the task enable.

tickEnable

@NotNull
@NotNull Page tickEnable(boolean tickEnable)

sets the task's activity.

Parameters:

tickEnable - the tick enable to set.

Returns:

this, for chained calls.

row

int row()

obtains row of the page.

Returns:

row of the page.

row

@NotNull
@NotNull Page row(int row)

set the row of the page.

Parameters:

row - the row to set.

Returns:

this, for chained calls.

column

int column()

obtains column of the page.

Returns:

column of the page.

column

@NotNull
@NotNull Page column(int column)

set the column of the page.

Parameters:

column - the row to set.

Returns:

this, for chained calls.

title

@NotNull
@NotNull String title()

obtains title of the page.

Returns:

title of the page.

title

@NotNull
@NotNull Page title(@NotNull
                             @NotNull String title)

sets the title of the page.

Parameters:

title - the title to set.

Returns:

this, for chained calls.

parent

@NotNull
@NotNull Optional<Page> parent()

obtains tha parent page of this.

Returns:

the parent page of this.

parent

@NotNull
@NotNull Page parent(@NotNull
                              @NotNull Page parent)

sets the parent of the page.

Parameters:

parent - the parent to set.

Returns:

this, for chained calls.

id

@NotNull
@NotNull Page id(@NotNull
                          @NotNull String id)

sets the id of the page.

Parameters:

id - the id to set.

Returns:

this, for chained calls.

id

@NotNull
@NotNull String id()

obtains id of the page.

Returns:

id of the page.

canClose

boolean canClose(@NotNull
                 @NotNull CloseEvent event)

checks the can close with the given event.

Parameters:

event - the event to check.

Returns:

true if the can close predicate's test returns true.

canClose

@NotNull
@NotNull Page canClose(@NotNull
                                @NotNull Predicate<CloseEvent> predicate)

sets the can close predicate of the page.

Parameters:

predicate - the predicate to set.

Returns:

this, for chained calls.

open

@NotNull
@NotNull org.bukkit.inventory.Inventory open(@NotNull
                                                      @NotNull org.bukkit.entity.Player player,
                                                      int page,
                                                      @NotNull
                                                      @NotNull Map<String,Object> properties)

opens the page for the player.

Parameters:

player - the player to open.

page - the page to open.

properties - the properties to open with.

Returns:

a new Inventory instance.

close

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

closes the player's page.

Parameters:

player - the player to close.