com.github.afarion1.command_handler.command.config

Class CommandArgumentConfigBuilder

java.lang.Object

com.github.afarion1.command_handler.command.config.CommandArgumentConfigBuilder

public final class CommandArgumentConfigBuilder
extends java.lang.Object

A sub-builder for CommandConfigBuilder, used in CommandConfigBuilder.addArguments(CommandArgumentConfigBuilder...)
Changes to this builder won't affect arguments configuration once CommandConfigBuilder.build() is called.

Constructor Summary

Constructors

Constructor and Description
CommandArgumentConfigBuilder(int id, java.lang.String argumentName) Default values: has no description isn't optional has no default string value shouldn't be parsed to Double has no default double value shouldn't be in quotes multi word choosing is disabled

Method Summary

Modifier and Type	Method and Description
CommandArgumentConfigBuilder	addDoubleValidators(java.util.function.DoublePredicate... validators) Adds predicates that will be used to validate double value. The argument must also be set to setParseToDouble(boolean)
CommandArgumentConfigBuilder	addStringValidators(java.util.function.Predicate<java.lang.String>... validators) Adds predicates that will be used to validate string value.
CommandArgumentConfigBuilder	enableCustomArgumentChoosing(boolean enable) Setting this to true enables custom argument choosing.
CommandArgumentConfigBuilder	setArgumentDescription(java.lang.String desc) The description will be shown in command inspection (command info) and in wrong-command-usage error message
CommandArgumentConfigBuilder	setArgumentOptions(java.lang.String... options) Execution of the argument's command will fail if given argument value doesn't match these options.
CommandArgumentConfigBuilder	setDefaultDoubleValue(double num) Sets default value that will be used if the argument is omitted.
@NotNull CommandArgumentConfigBuilder	setDefaultStringValue(java.lang.String str) Sets default value that will be used if the argument is omitted.
CommandArgumentConfigBuilder	setInQuotes(boolean bool) When set to true the argument will have to be typed in quotes (" "). This is useful for separation of arguments with spaces.
CommandArgumentConfigBuilder	setOptional(boolean bool) When set to true the argument will be optional and could be omitted.
CommandArgumentConfigBuilder	setParseToDouble(boolean bool) When set to true the argument's value will be parsed to Double and will be accessible using CommandArguments.getDoubleArgumentValue(int).

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandArgumentConfigBuilder

public CommandArgumentConfigBuilder(int id,
                                    java.lang.String argumentName)

Default values:

• has no description
• isn't optional
• has no default string value
• shouldn't be parsed to Double
• has no default double value
• shouldn't be in quotes
• multi word choosing is disabled

Parameters:

id - id of the argument which will be required to get it's value. The best practice is store the id in a static final field

argumentName - name of the argument which will be used in command description, command list and in wrong-command-usage error message

Method Detail

setArgumentDescription

public CommandArgumentConfigBuilder setArgumentDescription(java.lang.String desc)

The description will be shown in command inspection (command info) and in wrong-command-usage error message

addStringValidators

@SafeVarargs
public final CommandArgumentConfigBuilder addStringValidators(java.util.function.Predicate<java.lang.String>... validators)

Adds predicates that will be used to validate string value.
This option cannot be used if any of the following parameters is set to true:

• enableCustomArgumentChoosing(boolean)
• setParseToDouble(boolean)

addDoubleValidators

public CommandArgumentConfigBuilder addDoubleValidators(java.util.function.DoublePredicate... validators)

Adds predicates that will be used to validate double value.
The argument must also be set to setParseToDouble(boolean)

setArgumentOptions

public CommandArgumentConfigBuilder setArgumentOptions(java.lang.String... options)

Execution of the argument's command will fail if given argument value doesn't match these options. Additionally, these options will be displayed in command information.

setOptional

public CommandArgumentConfigBuilder setOptional(boolean bool)

When set to true the argument will be optional and could be omitted. There should be no non optional arguments after an optional argument. In other words, optional arguments could be only at the end of all arguments, and could be consecutive.
If an argument is set to be optional, then it's default value could be set as well, using one of the following methods:

• setDefaultStringValue(java.lang.String)
• setDefaultDoubleValue(double)

depending on whether the method is set to be parsed to Double or not

See Also:

setParseToDouble(boolean)

setInQuotes

public CommandArgumentConfigBuilder setInQuotes(boolean bool)

When set to true the argument will have to be typed in quotes (" ").
This is useful for separation of arguments with spaces.

setDefaultStringValue

@NotNull
public @NotNull CommandArgumentConfigBuilder setDefaultStringValue(java.lang.String str)

Sets default value that will be used if the argument is omitted. This method could be used if the argument is set to be optional.

See Also:

setOptional(boolean)

setDefaultDoubleValue

public CommandArgumentConfigBuilder setDefaultDoubleValue(double num)

Sets default value that will be used if the argument is omitted. This method could be used if the argument is set to be optional and to be parsed to Double.

See Also:

setParseToDouble(boolean), setOptional(boolean)

setParseToDouble

public CommandArgumentConfigBuilder setParseToDouble(boolean bool)

When set to true the argument's value will be parsed to Double and will be accessible using CommandArguments.getDoubleArgumentValue(int).

enableCustomArgumentChoosing

public CommandArgumentConfigBuilder enableCustomArgumentChoosing(boolean enable)

Setting this to true enables custom argument choosing. This means that instead of automatically splitting off all symbols before whitespace from arguments string, the string will be given to AbstractCommand.chooseArgumentSymbols(net.dv8tion.jda.api.events.message.MessageReceivedEvent, java.lang.String, int) and the method will be able to process the splitting itself.

See Also:

AbstractCommand.chooseArgumentSymbols(MessageReceivedEvent, String, int)