org.spongepowered.api.command.args

Enum CommandFlags.UnknownFlagBehavior

java.lang.Object

java.lang.Enum<CommandFlags.UnknownFlagBehavior>

org.spongepowered.api.command.args.CommandFlags.UnknownFlagBehavior

All Implemented Interfaces:

Serializable, Comparable<CommandFlags.UnknownFlagBehavior>

Enclosing class:

CommandFlags

public static enum CommandFlags.UnknownFlagBehavior
extends Enum<CommandFlags.UnknownFlagBehavior>

Indicates to the flag parser how it should treat an argument that looks like a flag that it does not recognise.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCEPT_NONVALUE Mark the flag as a non-value flag.
ACCEPT_VALUE Mark the flag as a string-valued flag.
ERROR Throw an ArgumentParseException when an unknown flag is encountered.
IGNORE Act as if the unknown flag is an ordinary argument, allowing the parsers specified in CommandFlags.Builder.buildWith(CommandElement) to attempt to parse the element instead.

Method Summary

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

ERROR

public static final CommandFlags.UnknownFlagBehavior ERROR

Throw an ArgumentParseException when an unknown flag is encountered.

ACCEPT_NONVALUE

public static final CommandFlags.UnknownFlagBehavior ACCEPT_NONVALUE

Mark the flag as a non-value flag.

ACCEPT_VALUE

public static final CommandFlags.UnknownFlagBehavior ACCEPT_VALUE

Mark the flag as a string-valued flag.

IGNORE

public static final CommandFlags.UnknownFlagBehavior IGNORE

Act as if the unknown flag is an ordinary argument, allowing the parsers specified in CommandFlags.Builder.buildWith(CommandElement) to attempt to parse the element instead.

Method Detail

values

public static CommandFlags.UnknownFlagBehavior[] 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 (CommandFlags.UnknownFlagBehavior c : CommandFlags.UnknownFlagBehavior.values())
    System.out.println(c);

Returns:

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

valueOf

public static CommandFlags.UnknownFlagBehavior 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