Enum Class Configurer.ContextLevel

java.lang.Object

java.lang.Enum<Configurer.ContextLevel>

VASSAL.configure.Configurer.ContextLevel

All Implemented Interfaces:

Serializable, Comparable<Configurer.ContextLevel>, Constable

Enclosing class:

Configurer

public static enum Configurer.ContextLevel
extends Enum<Configurer.ContextLevel>

The ContextLevel of a Configurer defines the level that it is defined at. It is used by the FunctionBuilder (FB) to provide better contextual help for Function calls. o PIECE - The Configurer is defined at the Piece level. Pieces move around, so we can make no assumptions about where the piece may be. All functions are to be displayed by the FB o MAP - The Configurer is defined at the Map level, with the actual Map recorded in context FB will not show 'Trait Only' versions of functions. Any reference to map or zone level properties on a different map to be wrapped in an appropriate GetXXXProperty function. o MODULE - The Configurer is defined at the Module level FB will not show 'Trait Only' versions of functions. Any references to Map or Zone level properties to be wrapped in an appropriate GetXXXProperty function.

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
MAP
MODULE
PIECE

Method Summary

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

PIECE

public static final Configurer.ContextLevel PIECE

MAP

public static final Configurer.ContextLevel MAP

MODULE

public static final Configurer.ContextLevel MODULE

Method Details

values

public static Configurer.ContextLevel[] 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 Configurer.ContextLevel 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