com.codelanx.codelanxlib.inventory.iinterface

Class InventoryInterface

java.lang.Object

com.codelanx.codelanxlib.inventory.iinterface.InventoryInterface

public final class InventoryInterface
extends Object

A collection of InventoryPanel objects with an opening reference TODO: Find way to persist menu linkings

Since:

0.0.1

Version:

0.1.0

Author:

1Rogue

Constructor Summary

Constructors

Constructor and Description
InventoryInterface() Generates a new seed and registers itself to an InterfaceListener

Method Summary

Modifier and Type	Method and Description
static InventoryInterface	deserialize(org.bukkit.plugin.Plugin p, File f) Reads an InventoryInterface from a YAML file
InventoryPanel	find(java.util.function.Predicate<? super InventoryPanel> filter) Searches for a specific InventoryPanel used in this interface
protected String	generateSeed(int length) Generates a new random ChatColor seed for a panel or interface.
InventoryPanel	getLinkedPanel(MenuIcon icon) Gets a linked InventoryPanel from a MenuIcon object.
InventoryPanel	getPanelBySeed(String title) Returns an InventoryPanel based on its generated seed
Collection<? extends InventoryPanel>	getPanels() Returns all InventoryPanel objects controlled by this interface
InventoryPanel	getRootPanel() Returns the root InventoryPanel.
protected String	getSeed() Returns the randomized ChatColor seed made for this interface
boolean	isLinked(MenuIcon icon) Determines if a MenuIcon is linked to an InventoryPanel
protected boolean	isRoot(InventoryPanel panel) Determines if a passed InventoryPanel is the root panel
protected void	linkPanel(MenuIcon icon, InventoryPanel panel) Links a MenuIcon to open an InventoryPanel
InventoryPanel	newPanel(int rows) Creates and returns an InventoryPanel for use as a menu
InventoryPanel	newPanel(String name, int rows) Creates and returns an InventoryPanel for use as a menu
void	openInterface(org.bukkit.entity.Player p) Opens the InventoryInterface for a player.
static void	serialize(InventoryInterface ii, File save) Saves an InventoryInterface to a specified File in YAML
void	setRootPanel(InventoryPanel panel) Sets the root panel of this InventoryInterface

Methods inherited from class java.lang.Object

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

Constructor Detail

InventoryInterface

public InventoryInterface()

Generates a new seed and registers itself to an InterfaceListener

Since:

0.0.1

Method Detail

getRootPanel

public InventoryPanel getRootPanel()

Returns the root InventoryPanel.

Returns:

The root InventoryPanel

Since:

0.0.1

openInterface

public void openInterface(org.bukkit.entity.Player p)

Opens the InventoryInterface for a player.

Parameters:

p - The Player to open the interface for

Throws:

IllegalStateException - if no root panel is set

Since:

0.0.1

newPanel

public InventoryPanel newPanel(String name,
                               int rows)

Creates and returns an InventoryPanel for use as a menu

Parameters:

name - The name (title) for the InventoryPanel

rows - The number of rows for the InventoryPanel

Returns:

The new InventoryPanel object

Since:

0.0.1

newPanel

public InventoryPanel newPanel(int rows)

Creates and returns an InventoryPanel for use as a menu

Parameters:

rows - The number of rows for the InventoryPanel

Returns:

The new InventoryPanel object

Since:

0.1.0

See Also:

newPanel(String, int)

getLinkedPanel

public InventoryPanel getLinkedPanel(MenuIcon icon)

Gets a linked InventoryPanel from a MenuIcon object. If the panel is not linked via InventoryPanel.linkIcon(MenuIcon), this method will return null.

Parameters:

icon - The MenuIcon to find a link from

Returns:

The linked InventoryPanel, or null if there is no linked panel.

Since:

0.0.1

getPanels

public Collection<? extends InventoryPanel> getPanels()

Returns all InventoryPanel objects controlled by this interface

Returns:

Any InventoryPanel objects in use

Since:

0.0.1

find

public InventoryPanel find(java.util.function.Predicate<? super InventoryPanel> filter)

Searches for a specific InventoryPanel used in this interface

Parameters:

filter - A Predicate<? super InventoryPanel> to search through active panels with.

Returns:

The first matching InventoryPanel, or null if nothing matches

Since:

0.0.1

setRootPanel

public void setRootPanel(InventoryPanel panel)

Sets the root panel of this InventoryInterface

Parameters:

panel - The InventoryPanel to set

Throws:

IllegalArgumentException - if panel is null

IllegalArgumentException - if this interface did not make the panel

Since:

0.0.1

isLinked

public boolean isLinked(MenuIcon icon)

Determines if a MenuIcon is linked to an InventoryPanel

Parameters:

icon - The MenuIcon to check

Returns:

true if the icon is linked to a panel

Since:

0.0.1

getPanelBySeed

public InventoryPanel getPanelBySeed(String title)

Returns an InventoryPanel based on its generated seed

Parameters:

title - The overall title of the panel (All seeds and the name)

Returns:

The relevant InventoryPanel, or null if not found

Since:

0.0.1

isRoot

protected boolean isRoot(InventoryPanel panel)

Determines if a passed InventoryPanel is the root panel

Parameters:

panel - The InventoryPanel to compare

Returns:

true if the passed panel object is the root panel

Since:

0.0.1

linkPanel

protected void linkPanel(MenuIcon icon,
                         InventoryPanel panel)

Links a MenuIcon to open an InventoryPanel

Parameters:

icon - The MenuIcon to link to a panel

panel - The InventoryPanel to link to

Since:

0.0.1

getSeed

protected String getSeed()

Returns the randomized ChatColor seed made for this interface

Returns:

The seed in use by this InventoryInterface

Since:

0.0.1

generateSeed

protected final String generateSeed(int length)

Generates a new random ChatColor seed for a panel or interface. Note the format of the seed for the overall panel is:

<Custom panel title><Panel seed><Interface seed>

As an example: My new Panel&1&2&3&4&5&6

Parameters:

length - The number of ChatColor objects to use

Returns:

A String containing all relevant objects

Since:

0.0.1

deserialize

public static InventoryInterface deserialize(org.bukkit.plugin.Plugin p,
                                             File f)

Reads an InventoryInterface from a YAML file

Parameters:

p - The Plugin associated with this File

f - The File to load from

Returns:

The deserialized InventoryInterface

Throws:

IllegalArgumentException - If a null parameter is provided

Since:

0.0.1

serialize

public static void serialize(InventoryInterface ii,
                             File save)
                      throws IOException

Saves an InventoryInterface to a specified File in YAML

Parameters:

ii - The InventoryInterface to save

save - The File to save to

Throws:

IOException - If the method failed to save to the file

Since:

0.0.1