Package it.polimi.ingsw.eriantys.server

Enum Class HelpContent

java.lang.Object

java.lang.Enum<HelpContent>

it.polimi.ingsw.eriantys.server.HelpContent

All Implemented Interfaces:

Serializable, Comparable<HelpContent>, Constable

public enum HelpContent
extends Enum<HelpContent>

An enumeration to enclose the /help command responses within a CLI client. The displayed content may vary with respect to the situation from which a client request is sent to the server.

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
GAME_SETUP
IN_GAME
NO_GAME
NOT_STARTED

Method Summary

Modifier and Type	Method	Description
String	getContent()	A getter for the text coded for an enumeration literal.
static HelpContent	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HelpContent[]	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

NO_GAME

public static final HelpContent NO_GAME

NOT_STARTED

public static final HelpContent NOT_STARTED

GAME_SETUP

public static final HelpContent GAME_SETUP

IN_GAME

public static final HelpContent IN_GAME

Method Details

values

public static HelpContent[] 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 HelpContent 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

getContent

public String getContent()

A getter for the text coded for an enumeration literal.

Returns:

the content of the *.txt resource file associated with the literal