Module polimi.ingsw.am21.codex

Package polimi.ingsw.am21.codex.controller

Enum Class GameController.EventDispatchMode

java.lang.Object

java.lang.Enum<GameController.EventDispatchMode>

polimi.ingsw.am21.codex.controller.GameController.EventDispatchMode

All Implemented Interfaces:

Serializable, Comparable<GameController.EventDispatchMode>, Constable

Enclosing class:

GameController

public static enum GameController.EventDispatchMode
extends Enum<GameController.EventDispatchMode>

Used to describe how the events should be dispatched under different circumstances. For each mode we provide a description of the logic structured this way: EVENT_NAME context of the client that caused the event: - listeners that will receive the event

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
BOTH_WAYS	menu: - menu listeners lobby: - lobby listeners - game listeners game: - game listeners - lobby listeners
BOTH_WAYS_FULL	menu: - menu listeners - game listeners - lobby listeners lobby: - lobby listeners - game listeners - menu listeners game: - game listeners - lobby listeners - menu listeners
BOTTOM_UP	menu: - menu listeners lobby: - lobby listeners - game listeners game: - game listeners
BOTTOM_UP_FULL	menu: - menu listeners - lobby listeners - game listeners lobby: - lobby listeners - game listeners game: - game listeners
SAME_CONTEXT	menu: - menu listeners lobby: - lobby listeners game: - game listeners
TOP_DOWN	menu: - menu listeners lobby: - lobby listeners game: - game listeners - lobby listeners
TOP_DOWN_FULL	menu: - menu listeners lobby: - lobby listeners - menu listeners game: - game listeners - lobby listeners - menu listeners

Method Summary

Modifier and Type	Method	Description
Boolean	checkDispatchable(GameController.UserGameContextStatus dispatcher, GameController.UserGameContextStatus listener)
static GameController.EventDispatchMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GameController.EventDispatchMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TOP_DOWN

public static final GameController.EventDispatchMode TOP_DOWN

menu:
- menu listeners
lobby:
- lobby listeners
game:
- game listeners
- lobby listeners

BOTTOM_UP

public static final GameController.EventDispatchMode BOTTOM_UP

menu:
- menu listeners
lobby:
- lobby listeners
- game listeners
game:
- game listeners

TOP_DOWN_FULL

public static final GameController.EventDispatchMode TOP_DOWN_FULL

menu:
- menu listeners
lobby:
- lobby listeners
- menu listeners
game:
- game listeners
- lobby listeners
- menu listeners

BOTTOM_UP_FULL

public static final GameController.EventDispatchMode BOTTOM_UP_FULL

menu:
- menu listeners
- lobby listeners
- game listeners
lobby:
- lobby listeners
- game listeners
game:
- game listeners

BOTH_WAYS

public static final GameController.EventDispatchMode BOTH_WAYS

menu:
- menu listeners
lobby:
- lobby listeners
- game listeners
game:
- game listeners
- lobby listeners

BOTH_WAYS_FULL

public static final GameController.EventDispatchMode BOTH_WAYS_FULL

menu:
- menu listeners
- game listeners
- lobby listeners
lobby:
- lobby listeners
- game listeners
- menu listeners
game:
- game listeners
- lobby listeners
- menu listeners

SAME_CONTEXT

public static final GameController.EventDispatchMode SAME_CONTEXT

menu:
- menu listeners
lobby:
- lobby listeners
game:
- game listeners

Method Details

values

public static GameController.EventDispatchMode[] 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 GameController.EventDispatchMode 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

checkDispatchable

public Boolean checkDispatchable(GameController.UserGameContextStatus dispatcher,
 GameController.UserGameContextStatus listener)