com.ericramirezs.commando4j.arguments

Class StringArgument

java.lang.Object

com.ericramirezs.commando4j.arguments.Argument<StringArgument,String>

com.ericramirezs.commando4j.arguments.StringArgument

All Implemented Interfaces:

IArgument<StringArgument,String>

public final class StringArgument
extends Argument<StringArgument,String>

Class to request an argument of type String to the user.

Constructor Summary

Constructors

Constructor and Description
StringArgument(@NotNull String name, @NotNull String prompt) Creates an instance of this Argument implementation

Method Summary

Modifier and Type	Method and Description
StringArgument	clone() An argument clone is required to prevent a value traveling through different Command calls.
String	getRegex() Get the regex for validation
String	parse(@NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event, String arg) To be called if all validations passed.
String	parse(net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event, String arg) To be called if all validations passed.
StringArgument	setRegex(String regex) Set a regex that the input string must match in order to be valid
StringArgument	setRegex(String regex, Function<net.dv8tion.jda.api.events.Event,String> regexVerboseGetter) Set a regex that the input string must match in order to be valid
StringArgument	setRegex(String regex, String verbose) Set a regex that the input string must match in order to be valid
String	validate(@NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event, @NotNull String arg) Validates if the argument input by the user is a valid value.
String	validate(net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event, String arg) Validates if the argument input by the user is a valid value.

Methods inherited from class com.ericramirezs.commando4j.arguments.Argument

addValidValues, clone, getDefaultValue, getMax, getMin, getName, getPrompt, getPrompt, getPromptRaw, getType, getValidValues, getValue, inRange, inRange, inRange, inRange, inRange, inRange, isRequired, oneOf, setDefaultValue, setDefaultValue, setMax, setMax, setMax, setMax, setMin, setMin, setMin, setMin, setPromptParser, setRequired, setSlashValue, setValue, validateNull

Methods inherited from class java.lang.Object

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

Constructor Detail

StringArgument

public StringArgument(@NotNull
                      @NotNull String name,
                      @NotNull
                      @NotNull String prompt)

Creates an instance of this Argument implementation

Parameters:

name - Readable name to display to the final

prompt - Hint to indicate the user the expected value to be passed to this argument.

Method Detail

validate

public String validate(@NotNull
                       @NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event,
                       @NotNull
                       @NotNull String arg)

Description copied from interface: IArgument

Validates if the argument input by the user is a valid value. This method validates any possible problem with the value input by the user.

Parameters:

event - Discord event that triggered this function call.

arg - argument input by the user.

Returns:

null if no argument is valid, Error message if the argument has a problem to parse it.

validate

public String validate(net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event,
                       String arg)

Description copied from interface: IArgument

Validates if the argument input by the user is a valid value. This method validates any possible problem with the value input by the user.

Parameters:

event - Discord event that triggered this function call.

arg - argument input by the user.

Returns:

null if no argument is valid, Error message if the argument has a problem to parse it.

parse

public String parse(@NotNull
                    @NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event,
                    String arg)

Description copied from interface: IArgument

To be called if all validations passed. Convert's the input String argument into the expected final object.

Parameters:

event - Discord event that triggered this function call.

arg - argument input by the user.

Returns:

parsed argument.

See Also:

IArgument.validate(MessageReceivedEvent, String)

parse

public String parse(net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event,
                    String arg)

Description copied from interface: IArgument

To be called if all validations passed. Convert's the input String argument into the expected final object.

Parameters:

event - Discord event that triggered this function call.

arg - argument input by the user.

Returns:

parsed argument.

See Also:

IArgument.validate(MessageReceivedEvent, String)

setRegex

public StringArgument setRegex(String regex,
                               String verbose)

Set a regex that the input string must match in order to be valid

Parameters:

regex - Regular expression

verbose - Explanation of regular expression

Returns:

a reference to this object.

setRegex

public StringArgument setRegex(String regex,
                               Function<net.dv8tion.jda.api.events.Event,String> regexVerboseGetter)

Set a regex that the input string must match in order to be valid

Parameters:

regex - Regular expression

regexVerboseGetter - Function to get the explanation of regular expression

Returns:

a reference to this object.

setRegex

public StringArgument setRegex(String regex)

Set a regex that the input string must match in order to be valid

Parameters:

regex - Regular expression

Returns:

a reference to this object.

getRegex

public String getRegex()

Get the regex for validation

Returns:

Regular expression

clone

public StringArgument clone()

Description copied from class: Argument

An argument clone is required to prevent a value traveling through different Command calls.

If your Argument child doesn't have additional attribute, you may just do return clone(new MyArgument(getName(), getPrompt()));

Specified by:

clone in interface IArgument<StringArgument,String>

Specified by:

clone in class Argument<StringArgument,String>

Returns:

a clone of this instance.