com.ericramirezs.commando4j.arguments

Class UnionArgument

java.lang.Object

com.ericramirezs.commando4j.arguments.Argument<UnionArgument,IArgument>

com.ericramirezs.commando4j.arguments.UnionArgument

All Implemented Interfaces:

IArgument<UnionArgument,IArgument>

public final class UnionArgument
extends Argument<UnionArgument,IArgument>

A type for command arguments that handles multiple other types.

It will try to parse arguments in the same order they're added. The first success will be the Value of this argument.

Make sure to use instanceof to check what of Argument was the valid one.

See Also:

IArgument

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
UnionArgument	addArgumentType(IArgument argument) Adds a new type of argument accepted by the UnionArgument
UnionArgument	clone() An argument clone is required to prevent a value traveling through different Command calls.
@NotNull List<IArgument>	getArguments()
@NotNull IArgument	parse(@NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event, String arg) To be called if all validations passed.
IArgument	parse(net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event, String arg) To be called if all validations passed.
@Nullable 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

UnionArgument

public UnionArgument(@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

addArgumentType

public UnionArgument addArgumentType(IArgument argument)

Adds a new type of argument accepted by the UnionArgument

Parameters:

argument - IArgument Object

Returns:

a reference to this object.

validate

@Nullable
public @Nullable 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

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

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.

Throws:

Exception - The method should NEVER throw an exception, any possible exceptions should be checked in the validate method.

See Also:

IArgument.validate(MessageReceivedEvent, String)

parse

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

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.

Throws:

Exception - The method should NEVER throw an exception, any possible exceptions should be checked in the validate method.

See Also:

IArgument.validate(MessageReceivedEvent, String)

getArguments

@Contract(value=" -> new")
 @NotNull
public @NotNull List<IArgument> getArguments()

clone

public UnionArgument 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<UnionArgument,IArgument>

Specified by:

clone in class Argument<UnionArgument,IArgument>

Returns:

a clone of this instance.