com.github.ms5984.api.menuman

Class ElementBuilder

java.lang.Object

com.github.ms5984.api.menuman.ElementBuilder

public final class ElementBuilder
extends Object

Fluent interface builder for menu elements

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ElementBuilder(MenuBuilder menuBuilder, MenuElement menuElement) Create an ElementBuilder for a MenuBuilder with a MenuElement.

Method Summary

Modifier and Type	Method and Description
ElementBuilder	addLore(@NotNull String line) Add a line to lore for this element.
MenuBuilder	assignToSlots(int... slots) Assign this element to slots of the menu.
ElementBuilder	setAction(ClickAction clickAction) Set a new action for this element.
ElementBuilder	setItem(@NotNull org.bukkit.inventory.ItemStack itemStack) Set a new base item for this element.
ElementBuilder	setLore(String... lore) Set new lore text for this element.
ElementBuilder	setText(String text) Set a new display text for this element.

Methods inherited from class java.lang.Object

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

Constructor Detail

ElementBuilder

protected ElementBuilder(MenuBuilder menuBuilder,
                         MenuElement menuElement)

Create an ElementBuilder for a MenuBuilder with a MenuElement.

Parameters:

menuBuilder - the target MenuBuilder

menuElement - a new MenuElement

Method Detail

setAction

public ElementBuilder setAction(ClickAction clickAction)

Set a new action for this element.

Parameters:

clickAction - which accepts MenuClick

Returns:

this builder

setItem

public ElementBuilder setItem(@NotNull
                              @NotNull org.bukkit.inventory.ItemStack itemStack)

Set a new base item for this element.

Parameters:

itemStack - a valid ItemStack

Returns:

this builder

setText

public ElementBuilder setText(String text)

Set a new display text for this element.

Parameters:

text - display name of item

Returns:

this builder

setLore

public ElementBuilder setLore(String... lore)

Set new lore text for this element.

Parameters:

lore - String varargs new lore

Returns:

this builder

addLore

public ElementBuilder addLore(@NotNull
                              @NotNull String line)

Add a line to lore for this element.

Parameters:

line - line of lore to be added

Returns:

this builder

assignToSlots

public MenuBuilder assignToSlots(int... slots)
                          throws IllegalArgumentException

Assign this element to slots of the menu.

Slots are zero-indexed: the first row is 0-8, not 1-9.

Parameters:

slots - varargs of desired slots

Returns:

the MenuBuilder

Throws:

IllegalArgumentException - if any int outside of inventory range