Package cloud.commandframework.arguments.compound

Class FlagArgument<C>

java.lang.Object

cloud.commandframework.arguments.CommandArgument<C,Object>

cloud.commandframework.arguments.compound.FlagArgument<C>

Type Parameters:

C - Command sender type

All Implemented Interfaces:

CloudKeyHolder<Object>, Comparable<CommandArgument<?,?>>

@API(status=STABLE)
public final class FlagArgument<C>
extends CommandArgument<C,Object>

Container for flag parsing logic. This should not be be used directly. Internally, a flag argument is a special case of a CompoundArgument.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FlagArgument.FailureReason	Reasons for which flag parsing may fail
static final class	FlagArgument.FlagArgumentParser<C>
static final class	FlagArgument.FlagParseException	Flag parse exception

Nested classes/interfaces inherited from class cloud.commandframework.arguments.CommandArgument

CommandArgument.Builder<C,T>, CommandArgument.TypedBuilder<C,T,B extends CommandArgument.Builder<C,T>>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FLAG_META	Deprecated. Use FLAG_META_KEY instead
static final CloudKey<String>	FLAG_META_KEY	Meta data for the last argument that was suggested
static final Object	FLAG_PARSE_RESULT_OBJECT	Dummy object that indicates that flags were parsed successfully
static final CloudKey<Set<CommandFlag<?>>>	PARSED_FLAGS	Meta data for the set of parsed flags, used to detect duplicates.

Constructor Summary

Constructors

Constructor	Description
FlagArgument(Collection<CommandFlag<?>> flags)	Construct a new flag argument

Method Summary

Modifier and Type	Method	Description
@NonNull Collection<@NonNull CommandFlag<?>>	getFlags()	Get the flags registered in the argument

Methods inherited from class cloud.commandframework.arguments.CommandArgument

addPreprocessor, compareTo, copy, equals, getDefaultDescription, getDefaultValue, getKey, getName, getOwningCommand, getParser, getSuggestionsProvider, getValueType, hasDefaultValue, hashCode, isArgumentRegistered, isRequired, ofType, ofType, preprocess, setArgumentRegistered, setOwningCommand, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

FLAG_PARSE_RESULT_OBJECT

public static final Object FLAG_PARSE_RESULT_OBJECT

Dummy object that indicates that flags were parsed successfully

FLAG_META

@Deprecated
public static final String FLAG_META

Deprecated.

Use FLAG_META_KEY instead

Meta data for the last argument that was suggested

See Also:

• Constant Field Values

FLAG_META_KEY

public static final CloudKey<String> FLAG_META_KEY

Meta data for the last argument that was suggested

PARSED_FLAGS

@API(status=EXPERIMENTAL,
     since="1.8.0")
public static final CloudKey<Set<CommandFlag<?>>> PARSED_FLAGS

Meta data for the set of parsed flags, used to detect duplicates.

Since:

1.8.0

Constructor Details

FlagArgument

public FlagArgument(Collection<CommandFlag<?>> flags)

Construct a new flag argument

Parameters:

flags - Flags

Method Details

getFlags

public @NonNull Collection<@NonNull CommandFlag<?>> getFlags()

Get the flags registered in the argument

Returns:

Unmodifiable view of flags