Package it.polimi.ingsw.eriantys.client.gui

Enum Class SceneName

java.lang.Object

java.lang.Enum<SceneName>

it.polimi.ingsw.eriantys.client.gui.SceneName

All Implemented Interfaces:

Serializable, Comparable<SceneName>, Constable

public enum SceneName
extends Enum<SceneName>

An enumeration to map *.fxml files to a name. The sources contain all the information and settings to render a scene.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOARD
CHARACTER_CARDS
LOBBIES
LOGIN
SCHOOLBOARD
WAITING_ROOM

Method Summary

Modifier and Type	Method	Description
String	getPath()	A getter for the relative path of the literal.
static SceneName	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SceneName[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LOGIN

public static final SceneName LOGIN

LOBBIES

public static final SceneName LOBBIES

WAITING_ROOM

public static final SceneName WAITING_ROOM

SCHOOLBOARD

public static final SceneName SCHOOLBOARD

BOARD

public static final SceneName BOARD

CHARACTER_CARDS

public static final SceneName CHARACTER_CARDS

Method Details

values

public static SceneName[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static SceneName valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getPath

public String getPath()

A getter for the relative path of the literal. The method can be used to load a target scene into the GUI application.

Returns:

the relative path to the *.fxml file