io.github.portlek.smartinventory.page

Class BasicPage

java.lang.Object

io.github.portlek.smartinventory.page.BasicPage

All Implemented Interfaces:

Page

public final class BasicPage
extends Object
implements Page

an implementation for Page.

Constructor Summary

Constructors

Constructor and Description
BasicPage(@NotNull SmartInventory inventory) ctor.
BasicPage(@NotNull SmartInventory inventory, @NotNull InventoryProvider provider) ctor.

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.
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.
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.
<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 Page.provider()'s InventoryProvider.update(InventoryContents) method with the given contents.
@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.
@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.

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

build, build, canClose, checkBounds, handle, notifyUpdateForAll, notifyUpdateForAllById, open, open, open, whenBottomClick, whenBottomClick, whenClose, whenClose, whenEmptyClick, whenEmptyClick, whenInit, whenInit, whenOpen, whenOpen, whenOutsideClick, whenOutsideClick, whenTick, whenTick, whenUpdate, whenUpdate

Constructor Detail

BasicPage

public BasicPage(@NotNull
                 @NotNull SmartInventory inventory,
                 @NotNull
                 @NotNull InventoryProvider provider)

ctor.

Parameters:

inventory - the inventory.

provider - the provider.

BasicPage

public BasicPage(@NotNull
                 @NotNull SmartInventory inventory)

ctor.

Parameters:

inventory - the inventory.

Method Detail

handle

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

Description copied from interface: Page

adds the given handle.

Specified by:

handle in interface Page

Type Parameters:

T - type of the event.

Parameters:

handle - the handle to add.

Returns:

this, for chained calls.

notifyUpdate

public void notifyUpdate(@NotNull
                         @NotNull InventoryContents contents)

Description copied from interface: Page

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

Specified by:

notifyUpdate in interface Page

Parameters:

contents - the contents to update.

accept

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

Description copied from interface: Page

accepts the upcoming event.

Specified by:

accept in interface Page

Type Parameters:

T - type of the event.

Parameters:

event - the event to accept.

provider

@NotNull
public @NotNull InventoryProvider provider()

Description copied from interface: Page

obtains the inventory provider.

Specified by:

provider in interface Page

Returns:

an inventory provider instance.

provider

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

Description copied from interface: Page

sets the provider to the given provider

Specified by:

provider in interface Page

Parameters:

provider - the provider to set.

Returns:

this, for chained calls.

inventory

@NotNull
public @NotNull SmartInventory inventory()

Description copied from interface: Page

obtains the page's inventory manager.

Specified by:

inventory in interface Page

Returns:

an inventory manager instance.

tick

public long tick()

Description copied from interface: Page

obtains the tick amount.

Specified by:

tick in interface Page

Returns:

the tick amount.

tick

@NotNull
public @NotNull Page tick(long tick)

Description copied from interface: Page

sets the tick.

Specified by:

tick in interface Page

Parameters:

tick - the tick to set.

Returns:

this, for chained calls.

startDelay

public long startDelay()

Description copied from interface: Page

obtains the start delay for the task.

Specified by:

startDelay in interface Page

Returns:

the start delay for the task.

startDelay

@NotNull
public @NotNull Page startDelay(long startDelay)

Description copied from interface: Page

sets the start delay of the task.

Specified by:

startDelay in interface Page

Parameters:

startDelay - the start delay to set.

Returns:

this, for chained calls.

async

public boolean async()

Description copied from interface: Page

obtains status of the task in terms of async.

Specified by:

async in interface Page

Returns:

status of the task in terms of async.

async

@NotNull
public @NotNull Page async(boolean async)

Description copied from interface: Page

sets the task's async status.

Specified by:

async in interface Page

Parameters:

async - the async to set.

Returns:

this, for chained calls.

tickEnable

public boolean tickEnable()

Description copied from interface: Page

obtains the task enable.

Specified by:

tickEnable in interface Page

Returns:

true if the task enable.

tickEnable

@NotNull
public @NotNull Page tickEnable(boolean tickEnable)

Description copied from interface: Page

sets the task's activity.

Specified by:

tickEnable in interface Page

Parameters:

tickEnable - the tick enable to set.

Returns:

this, for chained calls.

row

public int row()

Description copied from interface: Page

obtains row of the page.

Specified by:

row in interface Page

Returns:

row of the page.

row

@NotNull
public @NotNull Page row(int row)

Description copied from interface: Page

set the row of the page.

Specified by:

row in interface Page

Parameters:

row - the row to set.

Returns:

this, for chained calls.

column

public int column()

Description copied from interface: Page

obtains column of the page.

Specified by:

column in interface Page

Returns:

column of the page.

column

@NotNull
public @NotNull Page column(int column)

Description copied from interface: Page

set the column of the page.

Specified by:

column in interface Page

Parameters:

column - the row to set.

Returns:

this, for chained calls.

title

@NotNull
public @NotNull String title()

Description copied from interface: Page

obtains title of the page.

Specified by:

title in interface Page

Returns:

title of the page.

title

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

Description copied from interface: Page

sets the title of the page.

Specified by:

title in interface Page

Parameters:

title - the title to set.

Returns:

this, for chained calls.

parent

@NotNull
public @NotNull Optional<Page> parent()

Description copied from interface: Page

obtains tha parent page of this.

Specified by:

parent in interface Page

Returns:

the parent page of this.

parent

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

Description copied from interface: Page

sets the parent of the page.

Specified by:

parent in interface Page

Parameters:

parent - the parent to set.

Returns:

this, for chained calls.

id

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

Description copied from interface: Page

sets the id of the page.

Specified by:

id in interface Page

Parameters:

id - the id to set.

Returns:

this, for chained calls.

id

@NotNull
public @NotNull String id()

Description copied from interface: Page

obtains id of the page.

Specified by:

id in interface Page

Returns:

id of the page.

canClose

public boolean canClose(@NotNull
                        @NotNull CloseEvent event)

Description copied from interface: Page

checks the can close with the given event.

Specified by:

canClose in interface Page

Parameters:

event - the event to check.

Returns:

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

canClose

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

Description copied from interface: Page

sets the can close predicate of the page.

Specified by:

canClose in interface Page

Parameters:

predicate - the predicate to set.

Returns:

this, for chained calls.

open

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

Description copied from interface: Page

opens the page for the player.

Specified by:

open in interface Page

Parameters:

player - the player to open.

page - the page to open.

properties - the properties to open with.

Returns:

a new Inventory instance.

close

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

Description copied from interface: Page

closes the player's page.

Specified by:

close in interface Page

Parameters:

player - the player to close.