Package com.mrivanplays.pagedinventory.api

Class PagedInventoryBuilder

java.lang.Object

com.mrivanplays.pagedinventory.api.PagedInventoryBuilder

public class PagedInventoryBuilder
extends Object

Represents a builder of PagedInventory

Method Summary

Modifier and Type	Method	Description
@NotNull PagedInventory	build()	Builds into a PagedInventory
@NotNull PagedInventoryBuilder	clickFunction(@NotNull Consumer<PageClick> clickListener)	Adds a click function to listen for click events on the inventories.
@NotNull PagedInventoryBuilder	closeFunction(@NotNull Consumer<PageClose> closeListener)	Adds a close function to listen for close events on the inventories.
static @NotNull PagedInventoryBuilder	createBuilder(@NotNull org.bukkit.plugin.Plugin plugin)	Creates a new builder instance
@NotNull PagedInventoryBuilder	navigationItem(int slot, @NotNull NavigationItem navigationItem)	Sets the specified inventory slot to the specified NavigationItem
@NotNull PagedInventoryBuilder	page(int pageNum, @NotNull Page page)	Sets the page number to the specified page
@NotNull PagedInventoryBuilder	page(int page, @NotNull org.bukkit.inventory.Inventory inventory)	Sets the page number to the specified page

Methods inherited from class java.lang.Object

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

Method Detail

createBuilder

@NotNull
public static @NotNull PagedInventoryBuilder createBuilder(@NotNull
                                                           @NotNull org.bukkit.plugin.Plugin plugin)

Creates a new builder instance

Parameters:

plugin - plugin owner

Returns:

builder

page

@NotNull
public @NotNull PagedInventoryBuilder page(int page,
                                           @NotNull
                                           @NotNull org.bukkit.inventory.Inventory inventory)

Sets the page number to the specified page

Parameters:

page - page number

inventory - page

Returns:

this instance for chaining

page

@NotNull
public @NotNull PagedInventoryBuilder page(int pageNum,
                                           @NotNull
                                           @NotNull Page page)

Sets the page number to the specified page

Parameters:

pageNum - page number

page - page

Returns:

this instance for chaining

navigationItem

@NotNull
public @NotNull PagedInventoryBuilder navigationItem(int slot,
                                                     @NotNull
                                                     @NotNull NavigationItem navigationItem)

Sets the specified inventory slot to the specified NavigationItem

Parameters:

slot - slot

navigationItem - navigation item

Returns:

this instance for chaining

clickFunction

@NotNull
public @NotNull PagedInventoryBuilder clickFunction(@NotNull
                                                    @NotNull Consumer<PageClick> clickListener)

Adds a click function to listen for click events on the inventories.

Parameters:

clickListener - click listener

Returns:

this instance for chaining

closeFunction

@NotNull
public @NotNull PagedInventoryBuilder closeFunction(@NotNull
                                                    @NotNull Consumer<PageClose> closeListener)

Adds a close function to listen for close events on the inventories.

Parameters:

closeListener - close listener

Returns:

this instance for chaining

build

@NotNull
public @NotNull PagedInventory build()

Builds into a PagedInventory

Returns:

paged inventory