Package com.ultikits.ultitools.abstracts.command.validation

Enum Class CmdTargetComposition.Transition

java.lang.Object

java.lang.Enum<CmdTargetComposition.Transition>

com.ultikits.ultitools.abstracts.command.validation.CmdTargetComposition.Transition

All Implemented Interfaces:

Serializable, Comparable<CmdTargetComposition.Transition>, java.lang.constant.Constable

Enclosing class:

CmdTargetComposition

public static enum CmdTargetComposition.Transition
extends Enum<CmdTargetComposition.Transition>

How a method-level @CmdTarget value relates to the class-level one.

CmdTargetType is not a total order: BOTH is a superset of PLAYER and of CONSOLE, but PLAYER and CONSOLE are not comparable to each other. That is why this is a four-way enum rather than a two-way "same or different" - collapsing PLAYER-to-CONSOLE into WIDENING would be an arbitrary choice with no basis in the type's own structure.

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
LATERAL	PLAYER switches to CONSOLE, or CONSOLE switches to PLAYER.
NARROWING	BOTH narrows to PLAYER, or BOTH narrows to CONSOLE.
SAME	Class-level and method-level values are identical.
WIDENING	PLAYER widens to BOTH, or CONSOLE widens to BOTH.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Transition()

Method Summary

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

SAME

public static final CmdTargetComposition.Transition SAME

Class-level and method-level values are identical. Always legal.

NARROWING

public static final CmdTargetComposition.Transition NARROWING

BOTH narrows to PLAYER, or BOTH narrows to CONSOLE. Always legal.

WIDENING

public static final CmdTargetComposition.Transition WIDENING

PLAYER widens to BOTH, or CONSOLE widens to BOTH. Ambiguous - refused at load.

LATERAL

public static final CmdTargetComposition.Transition LATERAL

PLAYER switches to CONSOLE, or CONSOLE switches to PLAYER. Ambiguous - refused at load.

Constructor Details

Transition

private Transition()

Method Details

values

public static CmdTargetComposition.Transition[] 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 CmdTargetComposition.Transition 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