org.spongepowered.api.command.args

Class CommandFlags.Builder

java.lang.Object

org.spongepowered.api.command.args.CommandFlags.Builder

Enclosing class:

CommandFlags

public static class CommandFlags.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
CommandElement	buildWith(CommandElement wrapped) Build a flag command element using the given command element to handle all non-flag arguments.
CommandFlags.Builder	flag(String... specs) Allow a flag with any of the provided specifications that has no value.
CommandFlags.Builder	permissionFlag(String flagPermission, String... specs) Allow a flag with any of the provided specifications that has no value but requires the source to have a specific permission to specify the command.
CommandFlags.Builder	setAcceptsArbitraryLongFlags(boolean acceptsArbitraryLongFlags) Deprecated. in favor of #setUnknownLongFlagBehavior(UnknownFlagBehavior).
CommandFlags.Builder	setAnchorFlags(boolean anchorFlags) Whether flags should be anchored to the beginning of the text (so flags will only be picked up if they are at the beginning of the input).
CommandFlags.Builder	setUnknownLongFlagBehavior(CommandFlags.UnknownFlagBehavior behavior) Sets how long flags that are not registered should be handled when encountered.
CommandFlags.Builder	setUnknownShortFlagBehavior(CommandFlags.UnknownFlagBehavior behavior) Sets how long flags that are not registered should be handled when encountered.
CommandFlags.Builder	valueFlag(CommandElement value, String... specs) Allow a flag with any of the provided specifications, with the given command element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

flag

public CommandFlags.Builder flag(String... specs)

Allow a flag with any of the provided specifications that has no value. This flag will be exposed in a CommandContext under the key equivalent to the first flag in the specification array. The specifications are handled as so for each element in the specs array:

• If the element starts with -, the remainder of the element is interpreted as a long flag (so, "-flag" means "--flag" will be matched in an argument string)
• Otherwise, each code point of the element is interpreted as a short flag (meaning "flag" will cause "-f", "-l", "-a" and "-g" to be matched in an argument string, storing "true" under the key "f".)

Parameters:

specs - The flag specifications

Returns:

this

permissionFlag

public CommandFlags.Builder permissionFlag(String flagPermission,
                                           String... specs)

Allow a flag with any of the provided specifications that has no value but requires the source to have a specific permission to specify the command.

Parameters:

flagPermission - The required permission

specs - The flag specifications

Returns:

this

See Also:

for details on the format

valueFlag

public CommandFlags.Builder valueFlag(CommandElement value,
                                      String... specs)

Allow a flag with any of the provided specifications, with the given command element. The flag may be present multiple times, and may therefore have multiple values.

Parameters:

value - The command element used to parse any occurrences

specs - The flag specifications

Returns:

this

See Also:

for information on how the flag specifications are parsed

setAcceptsArbitraryLongFlags

@Deprecated
public CommandFlags.Builder setAcceptsArbitraryLongFlags(boolean acceptsArbitraryLongFlags)

Deprecated. in favor of #setUnknownLongFlagBehavior(UnknownFlagBehavior).

If this is true, any long flag (--) will be accepted and added as a flag. If false, unknown long flags are considered errors.

Parameters:

acceptsArbitraryLongFlags - Whether any long flag is accepted

Returns:

this

setUnknownLongFlagBehavior

public CommandFlags.Builder setUnknownLongFlagBehavior(CommandFlags.UnknownFlagBehavior behavior)

Sets how long flags that are not registered should be handled when encountered.

Parameters:

behavior - The behavior to use

Returns:

this

setUnknownShortFlagBehavior

public CommandFlags.Builder setUnknownShortFlagBehavior(CommandFlags.UnknownFlagBehavior behavior)

Sets how long flags that are not registered should be handled when encountered.

If a command that supports flags accepts negative numbers (or arguments that may begin with a dash), setting this to CommandFlags.UnknownFlagBehavior.IGNORE will cause these elements to be ignored by the flag parser and will be parsed by the command's non-flag elements instead.

Parameters:

behavior - The behavior to use

Returns:

this

setAnchorFlags

public CommandFlags.Builder setAnchorFlags(boolean anchorFlags)

Whether flags should be anchored to the beginning of the text (so flags will only be picked up if they are at the beginning of the input).

Parameters:

anchorFlags - Whether flags are anchored

Returns:

this

buildWith

public CommandElement buildWith(CommandElement wrapped)

Build a flag command element using the given command element to handle all non-flag arguments.

If you wish to add multiple elements here, wrap them in GenericArguments.seq(CommandElement...)

Parameters:

wrapped - The wrapped command element

Returns:

the new command element