io.github.bananapuncher714.radioboard

Enum FrameManager

java.lang.Object

java.lang.Enum<FrameManager>

io.github.bananapuncher714.radioboard.FrameManager

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FrameManager>

public enum FrameManager
extends java.lang.Enum<FrameManager>

Singleton to hold all BoardFrame and MapDisplay objects

Author:

BananaPuncher714

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
java.util.Collection<BoardFrame>	getBoardFrames()
MapDisplay	getDisplay(java.lang.String id)
java.util.Collection<MapDisplay>	getDisplays()
BoardFrame	getFrame(java.lang.String id)
BoardFrame	getFrameAt(org.bukkit.Location location) Fetch a given BoardFrame at a given coordinate
void	registerBoard(java.lang.String id, BoardFrame frame) Register a new board with a given id, and remove previous ones if they exist
void	registerDisplay(MapDisplay display)
MapDisplay	removeDisplay(java.lang.String id)
BoardFrame	removeFrame(java.lang.String id)
static FrameManager	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FrameManager[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final FrameManager INSTANCE

Method Detail

values

public static FrameManager[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FrameManager c : FrameManager.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FrameManager valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

registerBoard

public void registerBoard(java.lang.String id,
                          BoardFrame frame)

Register a new board with a given id, and remove previous ones if they exist

Parameters:

id - The string id of the board provided

frame - The new BoardFrame to register

getFrame

public BoardFrame getFrame(java.lang.String id)

removeFrame

public BoardFrame removeFrame(java.lang.String id)

getBoardFrames

public java.util.Collection<BoardFrame> getBoardFrames()

registerDisplay

public void registerDisplay(MapDisplay display)

getDisplay

public MapDisplay getDisplay(java.lang.String id)

removeDisplay

public MapDisplay removeDisplay(java.lang.String id)

getDisplays

public java.util.Collection<MapDisplay> getDisplays()

getFrameAt

public BoardFrame getFrameAt(org.bukkit.Location location)

Fetch a given BoardFrame at a given coordinate

Parameters:

location - The location of a possible board

Returns:

The first board that exists at the given coordinate, or null if none exists