Enum Class MapLayer.Scope

java.lang.Object

java.lang.Enum<MapLayer.Scope>

fr.fidorial.map.MapLayer.Scope

All Implemented Interfaces:

Serializable, Comparable<MapLayer.Scope>, Constable

Enclosing interface:

MapLayer

public static enum MapLayer.Scope
extends Enum<MapLayer.Scope>

For whom a layer is painted.

Since:

0.1.0

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
PER_VIEWER	Once for each player who sees the map.
SHARED	Once, for everyone who sees the map.

Method Summary

Modifier and Type	Method	Description
static MapLayer.Scope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MapLayer.Scope[]	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

SHARED

public static final MapLayer.Scope SHARED

Once, for everyone who sees the map.

PER_VIEWER

public static final MapLayer.Scope PER_VIEWER

Once for each player who sees the map.

Method Details

values

public static MapLayer.Scope[] 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 MapLayer.Scope 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