net.wesjd.anvilgui

Class AnvilGUI.Builder

java.lang.Object

net.wesjd.anvilgui.AnvilGUI.Builder

Enclosing class:

AnvilGUI

public static class AnvilGUI.Builder
extends Object

A builder class for an AnvilGUI object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AnvilGUI.Builder	item(org.bukkit.inventory.ItemStack item) Deprecated. As of version 1.4.0, use itemLeft
AnvilGUI.Builder	itemLeft(org.bukkit.inventory.ItemStack item) Sets the ItemStack to be put in the first slot
AnvilGUI.Builder	itemRight(org.bukkit.inventory.ItemStack item) Sets the ItemStack to be put in the second slot
AnvilGUI.Builder	onClose(java.util.function.Consumer<org.bukkit.entity.Player> closeListener) Listens for when the inventory is closed
AnvilGUI.Builder	onComplete(java.util.function.BiFunction<org.bukkit.entity.Player,String,AnvilGUI.Response> completeFunction) Handles the inventory output slot when it is clicked
AnvilGUI.Builder	onLeftInputClick(java.util.function.Consumer<org.bukkit.entity.Player> inputLeftClickListener) Listens for when the first input slot is clicked
AnvilGUI.Builder	onRightInputClick(java.util.function.Consumer<org.bukkit.entity.Player> inputRightClickListener) Listens for when the second input slot is clicked
AnvilGUI	open(org.bukkit.entity.Player player) Creates the anvil GUI and opens it for the player
AnvilGUI.Builder	plugin(org.bukkit.plugin.Plugin plugin) Sets the plugin for the AnvilGUI
AnvilGUI.Builder	preventClose() Prevents the closing of the anvil GUI by the user
AnvilGUI.Builder	text(String text) Sets the inital item-text that is displayed to the user
AnvilGUI.Builder	title(String title) Sets the AnvilGUI title that is to be displayed to the user

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

preventClose

public AnvilGUI.Builder preventClose()

Prevents the closing of the anvil GUI by the user

Returns:

The AnvilGUI.Builder instance

onClose

public AnvilGUI.Builder onClose(java.util.function.Consumer<org.bukkit.entity.Player> closeListener)

Listens for when the inventory is closed

Parameters:

closeListener - An Consumer that is called when the anvil GUI is closed

Returns:

The AnvilGUI.Builder instance

Throws:

IllegalArgumentException - when the closeListener is null

onLeftInputClick

public AnvilGUI.Builder onLeftInputClick(java.util.function.Consumer<org.bukkit.entity.Player> inputLeftClickListener)

Listens for when the first input slot is clicked

Parameters:

inputLeftClickListener - An Consumer that is called when the first input slot is clicked

Returns:

The AnvilGUI.Builder instance

onRightInputClick

public AnvilGUI.Builder onRightInputClick(java.util.function.Consumer<org.bukkit.entity.Player> inputRightClickListener)

Listens for when the second input slot is clicked

Parameters:

inputRightClickListener - An Consumer that is called when the second input slot is clicked

Returns:

The AnvilGUI.Builder instance

onComplete

public AnvilGUI.Builder onComplete(java.util.function.BiFunction<org.bukkit.entity.Player,String,AnvilGUI.Response> completeFunction)

Handles the inventory output slot when it is clicked

Parameters:

completeFunction - An BiFunction that is called when the user clicks the output slot

Returns:

The AnvilGUI.Builder instance

Throws:

IllegalArgumentException - when the completeFunction is null

plugin

public AnvilGUI.Builder plugin(org.bukkit.plugin.Plugin plugin)

Sets the plugin for the AnvilGUI

Parameters:

plugin - The Plugin this anvil GUI is associated with

Returns:

The AnvilGUI.Builder instance

Throws:

IllegalArgumentException - if the plugin is null

text

public AnvilGUI.Builder text(String text)

Sets the inital item-text that is displayed to the user

Parameters:

text - The initial name of the item in the anvil

Returns:

The AnvilGUI.Builder instance

Throws:

IllegalArgumentException - if the text is null

title

public AnvilGUI.Builder title(String title)

Sets the AnvilGUI title that is to be displayed to the user

Parameters:

title - The title that is to be displayed to the user

Returns:

The AnvilGUI.Builder instance

Throws:

IllegalArgumentException - if the title is null

item

@Deprecated
public AnvilGUI.Builder item(org.bukkit.inventory.ItemStack item)

Deprecated. As of version 1.4.0, use itemLeft

Sets the ItemStack to be put in the first slot

Parameters:

item - The ItemStack to be put in the first slot

Returns:

The AnvilGUI.Builder instance

Throws:

IllegalArgumentException - if the ItemStack is null

itemLeft

public AnvilGUI.Builder itemLeft(org.bukkit.inventory.ItemStack item)

Sets the ItemStack to be put in the first slot

Parameters:

item - The ItemStack to be put in the first slot

Returns:

The AnvilGUI.Builder instance

Throws:

IllegalArgumentException - if the ItemStack is null

itemRight

public AnvilGUI.Builder itemRight(org.bukkit.inventory.ItemStack item)

Sets the ItemStack to be put in the second slot

Parameters:

item - The ItemStack to be put in the second slot

Returns:

The AnvilGUI.Builder instance

open

public AnvilGUI open(org.bukkit.entity.Player player)

Creates the anvil GUI and opens it for the player

Parameters:

player - The Player the anvil GUI should open for

Returns:

The AnvilGUI instance from this builder

Throws:

IllegalArgumentException - when the onComplete function, plugin, or player is null