Enum Class GlobalCommandTarget.Target

java.lang.Object

java.lang.Enum<GlobalCommandTarget.Target>

VASSAL.counters.GlobalCommandTarget.Target

All Implemented Interfaces:

Serializable, Comparable<GlobalCommandTarget.Target>, Constable

Enclosing class:

GlobalCommandTarget

public static enum GlobalCommandTarget.Target
extends Enum<GlobalCommandTarget.Target>

Specifies the kind of target matching

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
CURATTACH
CURLOC
CURMAP
CURMAT
CURSTACK
CURZONE
DECK
LOCATION
MAP
XY
ZONE

Method Summary

Modifier and Type	Method	Description
static String[]	geti18nKeys()
static String[]	getKeys()
boolean	isCurrent()
String	toTranslatedString()
static GlobalCommandTarget.Target	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GlobalCommandTarget.Target[]	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

CURSTACK

public static final GlobalCommandTarget.Target CURSTACK

CURMAP

public static final GlobalCommandTarget.Target CURMAP

CURZONE

public static final GlobalCommandTarget.Target CURZONE

CURLOC

public static final GlobalCommandTarget.Target CURLOC

MAP

public static final GlobalCommandTarget.Target MAP

ZONE

public static final GlobalCommandTarget.Target ZONE

LOCATION

public static final GlobalCommandTarget.Target LOCATION

XY

public static final GlobalCommandTarget.Target XY

DECK

public static final GlobalCommandTarget.Target DECK

CURMAT

public static final GlobalCommandTarget.Target CURMAT

CURATTACH

public static final GlobalCommandTarget.Target CURATTACH

Method Details

values

public static GlobalCommandTarget.Target[] 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 GlobalCommandTarget.Target 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

isCurrent

public boolean isCurrent()

Returns:

true if our match is relative to an issuing piece or deck

toTranslatedString

public String toTranslatedString()

Returns:

Localizable key corresponding to target value

getKeys

public static String[] getKeys()

Returns:

Internal keys for all target types

geti18nKeys

public static String[] geti18nKeys()

Returns:

Localization keys for all target types