Enum Class Role

java.lang.Object

java.lang.Enum<Role>

edu.uky.cs.nil.tt.Role

All Implemented Interfaces:

Serializable, Comparable<Role>, Constable

public enum Role
extends Enum<Role>

Represents the two roles in a collaborative storytelling session: the Player, who typically controls a single character, and the Game Master, who controls all other characters and the environment.

Author:

Stephen G. Ware

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GAME_MASTER	The game master role, who controls all characters except the player character and the environment
PLAYER	The player role, who controls one characters, often the main character of the story

Method Summary

Modifier and Type	Method	Description
Role	getPartner()	Returns the partner of this role.
static Role	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Role[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GAME_MASTER

public static final Role GAME_MASTER

The game master role, who controls all characters except the player character and the environment

PLAYER

public static final Role PLAYER

The player role, who controls one characters, often the main character of the story

Method Details

values

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

getPartner

public Role getPartner()

Returns the partner of this role. If this role is the game master, this method returns the player. If this role is the player, this method return the game master.

Returns:

the partner of this role