com.sk89q.worldedit.util.command.parametric

Enum BindingBehavior

java.lang.Object

java.lang.Enum<BindingBehavior>

com.sk89q.worldedit.util.command.parametric.BindingBehavior

All Implemented Interfaces:

Serializable, Comparable<BindingBehavior>

public enum BindingBehavior
extends Enum<BindingBehavior>

Determines the type of binding.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONSUMES Always consumes from a ArgumentStack.
INDETERMINATE Sometimes consumes from a ArgumentStack.
PROVIDES Never consumes from a ArgumentStack.

Method Summary

Modifier and Type	Method and Description
static BindingBehavior	valueOf(String name) Returns the enum constant of this type with the specified name.
static BindingBehavior[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CONSUMES

public static final BindingBehavior CONSUMES

Always consumes from a ArgumentStack.

INDETERMINATE

public static final BindingBehavior INDETERMINATE

Sometimes consumes from a ArgumentStack.

Bindings that exhibit this behavior must be defined as a Switch by commands utilizing the given binding.

PROVIDES

public static final BindingBehavior PROVIDES

Never consumes from a ArgumentStack.

Bindings that exhibit this behavior generate objects from other sources, such as from a CommandLocals. These are "magic" bindings that inject variables.

Method Detail

values

public static BindingBehavior[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BindingBehavior c : BindingBehavior.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BindingBehavior valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null