Package com.mrivanplays.pagedinventory.internal

Class PagedInventoryImpl

java.lang.Object

com.mrivanplays.pagedinventory.internal.PagedInventoryImpl

All Implemented Interfaces:

PagedInventory

public class PagedInventoryImpl
extends Object
implements PagedInventory

Constructor Summary

Constructors

Constructor	Description
PagedInventoryImpl()

Method Summary

Modifier and Type	Method	Description
void	addOnClickFunction(@NotNull Consumer<PageClick> onClick)	Adds a click listener, when a Page got clicked.
void	addOnCloseFunction(@NotNull Consumer<PageClose> onClose)	Adds a close listener, when a Page got closed.
void	addPage(@NotNull Page page)	Adds a Page to this PagedInventory
@NotNull Map<Integer,NavigationItem>	getNavigationItems()	Returns a immutable map of the NavigationItems added.
@NotNull Optional<Page>	getPage(int page)	Retrieves the page specified.
@NotNull Optional<Page>	getPage(@NotNull UUID page)	Retrieves the page by the specified page uuid
@NotNull UUID	getPagedInventoryUUID()	Returns the UniqueId of this PagedInventory, in case you want to store it somewhere
@NotNull OptionalInt	getPageNumber(@NotNull Page page)	Retrieves the page number of the page specified.
@NotNull OptionalInt	getPageNumber(@NotNull UUID page)	Retrieves the page number of the page uuid specified
@NotNull Map<Integer,Page>	getPages()	Returns a immutable map of the Pages this PagedInventory has
@NotNull Optional<Page>	getPageViewed(@NotNull org.bukkit.entity.Player viewer)	Returns the page, currently viewed by the specified Player viewer
@NotNull Map<UUID,UUID>	getViewers()	Returns a immutable map of the known viewers and the viewed pages, key being a Player's UUID, and value being a Page's UUID
void	open(@NotNull org.bukkit.entity.Player viewer, int page)	Opens the specified page and adds the Player to the cache.
void	openNext(@NotNull org.bukkit.entity.Player viewer)	Opens the next page of the page viewed by the player if present
void	openPrevious(@NotNull org.bukkit.entity.Player viewer)	Opens the previous page of the page viewed by the player if present
void	removeNavigationItem(int pos)	Removes the specified NavigationItem on that position.
void	removePage(int page)	Removes the specified page from this PagedInventory
void	setNavigationItem(int pos, @NotNull NavigationItem item)	Sets the specified NavigationItem on the specified Inventory position.
void	setPage(int pageNum, @NotNull Page page)	Sets the specified Page number to the specified Page in this PagedInventory

Methods inherited from class java.lang.Object

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

Constructor Detail

PagedInventoryImpl

public PagedInventoryImpl()

Method Detail

addOnClickFunction

public void addOnClickFunction(@NotNull
                               @NotNull Consumer<PageClick> onClick)

Description copied from interface: PagedInventory

Adds a click listener, when a Page got clicked.

Specified by:

addOnClickFunction in interface PagedInventory

Parameters:

onClick - on click function

addOnCloseFunction

public void addOnCloseFunction(@NotNull
                               @NotNull Consumer<PageClose> onClose)

Description copied from interface: PagedInventory

Adds a close listener, when a Page got closed.

Specified by:

addOnCloseFunction in interface PagedInventory

Parameters:

onClose - on close function

getPage

@NotNull
public @NotNull Optional<Page> getPage(int page)

Description copied from interface: PagedInventory

Retrieves the page specified.

Specified by:

getPage in interface PagedInventory

Parameters:

page - the page you want to retrieve

Returns:

empty optional if page wasn't found, or else optional with value

getPage

@NotNull
public @NotNull Optional<Page> getPage(@NotNull
                                       @NotNull UUID page)

Description copied from interface: PagedInventory

Retrieves the page by the specified page uuid

Specified by:

getPage in interface PagedInventory

Parameters:

page - page uuid

Returns:

empty optional if page wasn't found, or else optional with value

getPageNumber

@NotNull
public @NotNull OptionalInt getPageNumber(@NotNull
                                          @NotNull Page page)

Description copied from interface: PagedInventory

Retrieves the page number of the page specified.

Specified by:

getPageNumber in interface PagedInventory

Parameters:

page - the page object you want to get numbe

Returns:

number of the page if present

getPageNumber

@NotNull
public @NotNull OptionalInt getPageNumber(@NotNull
                                          @NotNull UUID page)

Description copied from interface: PagedInventory

Retrieves the page number of the page uuid specified

Specified by:

getPageNumber in interface PagedInventory

Parameters:

page - page uuid

Returns:

number of the page if present

addPage

public void addPage(@NotNull
                    @NotNull Page page)

Description copied from interface: PagedInventory

Adds a Page to this PagedInventory

Specified by:

addPage in interface PagedInventory

Parameters:

page - the page you want to add

setPage

public void setPage(int pageNum,
                    @NotNull
                    @NotNull Page page)

Description copied from interface: PagedInventory

Sets the specified Page number to the specified Page in this PagedInventory

Specified by:

setPage in interface PagedInventory

Parameters:

pageNum - the page number you want to override/set

page - the page you want to set

removePage

public void removePage(int page)

Description copied from interface: PagedInventory

Removes the specified page from this PagedInventory

Specified by:

removePage in interface PagedInventory

Parameters:

page - the page you want to remove

getPages

@NotNull
public @NotNull Map<Integer,Page> getPages()

Description copied from interface: PagedInventory

Returns a immutable map of the Pages this PagedInventory has

Specified by:

getPages in interface PagedInventory

Returns:

pages

setNavigationItem

public void setNavigationItem(int pos,
                              @NotNull
                              @NotNull NavigationItem item)

Description copied from interface: PagedInventory

Sets the specified NavigationItem on the specified Inventory position.

Specified by:

setNavigationItem in interface PagedInventory

Parameters:

pos - the inventory position you want the item on

item - the navigation item you want to set

removeNavigationItem

public void removeNavigationItem(int pos)

Description copied from interface: PagedInventory

Removes the specified NavigationItem on that position.

Specified by:

removeNavigationItem in interface PagedInventory

Parameters:

pos - the position of the navigation item you want to remove

getNavigationItems

@NotNull
public @NotNull Map<Integer,NavigationItem> getNavigationItems()

Description copied from interface: PagedInventory

Returns a immutable map of the NavigationItems added.

Specified by:

getNavigationItems in interface PagedInventory

Returns:

navigation items

open

public void open(@NotNull
                 @NotNull org.bukkit.entity.Player viewer,
                 int page)

Description copied from interface: PagedInventory

Opens the specified page and adds the Player to the cache.

Specified by:

open in interface PagedInventory

Parameters:

viewer - viewer

page - page

openPrevious

public void openPrevious(@NotNull
                         @NotNull org.bukkit.entity.Player viewer)

Description copied from interface: PagedInventory

Opens the previous page of the page viewed by the player if present

Specified by:

openPrevious in interface PagedInventory

Parameters:

viewer - player viewer

openNext

public void openNext(@NotNull
                     @NotNull org.bukkit.entity.Player viewer)

Description copied from interface: PagedInventory

Opens the next page of the page viewed by the player if present

Specified by:

openNext in interface PagedInventory

Parameters:

viewer - player viewer

getPageViewed

@NotNull
public @NotNull Optional<Page> getPageViewed(@NotNull
                                             @NotNull org.bukkit.entity.Player viewer)

Description copied from interface: PagedInventory

Returns the page, currently viewed by the specified Player viewer

Specified by:

getPageViewed in interface PagedInventory

Parameters:

viewer - player viewer

Returns:

page viewed if present

getViewers

@NotNull
public @NotNull Map<UUID,UUID> getViewers()

Description copied from interface: PagedInventory

Returns a immutable map of the known viewers and the viewed pages, key being a Player's UUID, and value being a Page's UUID

Specified by:

getViewers in interface PagedInventory

Returns:

viewers

getPagedInventoryUUID

@NotNull
public @NotNull UUID getPagedInventoryUUID()

Description copied from interface: PagedInventory

Returns the UniqueId of this PagedInventory, in case you want to store it somewhere

Specified by:

getPagedInventoryUUID in interface PagedInventory

Returns:

unique id