IArgument

Type Parameters:

A - Self argument object that implements IArgument.

T - result object after parsing the argument.

All Known Implementing Classes:

AnnouncementChannelArgument, Argument, AudioChannelArgument, BooleanArgument, CategoryChannelArgument, ChannelArgument, CommandArgument, CustomEmojiArgument, FloatArgument, GuildArgument, IntegerArgument, LocalDateArgument, LocalTimeArgument, MemberArgument, MessageArgument, MessageChannelArgument, RoleArgument, StageChannelArgument, StringArgument, TextChannelArgument, ThreadChannelArgument, UnionArgument, URLArgument, UserArgument, VoiceChannelArgument
```
public interface IArgument<A extends IArgument,T>
```
Interface to implement in any object to be used as an argument for a Command.
An argument refers to any text entered by the user after the command name, which will be used to make a command function perform certain functions based on these arguments.

The goal of the implementation is to manage the validation and conversion of the parameter to a specific object, to simplify the development of the command.

See Also:

ICommand

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`A`	`addValidValues(T... validValues)` Add valid values to the argument.
`A`	`clone()` An argument clone is required to prevent a value traveling through different Command calls.
`T`	`getDefaultValue()` Get the default value of the argument if the user does not input a value.
`Double`	`getMax()` Get the maximum value allowed for this argument.
`Double`	`getMin()` Get the minimum value allowed for this argument.
`String`	`getName()` Get the argument's name.
`String`	`getPrompt()` Get the argument's prompt.
`String`	`getPrompt(net.dv8tion.jda.api.events.Event event)` Get the argument's prompt.
`ArgumentTypes`	`getType()` Gets the argument's type.
`List<T>`	`getValidValues()` return a list of valid values set for this argument.
`T`	`getValue()` Get the current value of the argument.
`boolean`	`isRequired()` Checks if the argument requires a value to be set.
`String`	`oneOf(T object, net.dv8tion.jda.api.events.Event event, Function<T,String> mapper, String errorMessageKey)` Checks if the argument is one of the specified valid values.
`T`	`parse(net.dv8tion.jda.api.events.message.MessageReceivedEvent event, String arg)` To be called if all validations passed.
`T`	`parse(net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event, String arg)` To be called if all validations passed.
`A`	`setSlashValue(net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event, Object value)` Sets the value when the command is called via discord's slash command.
`A`	`setValue(T value)` Set the parsed value after validations, to be used into the command.
`String`	`validate(net.dv8tion.jda.api.events.message.MessageReceivedEvent event, 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.
`String`	`validateNull(String arg, net.dv8tion.jda.api.events.message.MessageReceivedEvent event)` Checks if the argument accepts null values.

- Method Detail
  - isRequired
```
boolean isRequired()
```
    Checks if the argument requires a value to be set.
    
    Returns:
    
    true if value cannot be null, false otherwise.
    
    See Also:
    
    getValue()
  - getMax
```
Double getMax()
```
    Get the maximum value allowed for this argument. It may be used to limit a String length or a numeric max value.
    
    Returns:
    
    Maximum value related to the Object, null if not defined.
  - getMin
```
Double getMin()
```
    Get the minimum value allowed for this argument. It may be used to limit a String length or a numeric minimum value.
    
    Returns:
    
    Minimum value related to the Object, null if not defined.
  - getName
```
String getName()
```
    Get the argument's name.
    
    Returns:
    
    the argument's name.
  - getPrompt
```
String getPrompt()
```
    Get the argument's prompt. Used to give the final user a hint of the expected value.
    
    Returns:
    
    the argument's prompt.
  - getPrompt
```
String getPrompt(net.dv8tion.jda.api.events.Event event)
```
    Get the argument's prompt. Used to give the final user a hint of the expected value.
    
    Parameters:
    
    event - Discord event that triggered this function call.
    
    Returns:
    
    the argument's prompt.
  - validateNull
```
String validateNull(String arg,
                    net.dv8tion.jda.api.events.message.MessageReceivedEvent event)
```
    Checks if the argument accepts null values. If null values are not accepted and the value input by the user.
    
    Parameters:
    
    arg - argument input by the user.
    
    event - Discord event that triggered this function call.
    
    Returns:
    
    null if no problems found, Error message if the argument cannot be null, but the actual Value is null.
  - oneOf
```
String oneOf(T object,
             net.dv8tion.jda.api.events.Event event,
             Function<T,String> mapper,
             String errorMessageKey)
```
    Checks if the argument is one of the specified valid values.
    
    Parameters:
    
    object - Value input by the user.
    
    event - Discord event that triggered this function call.
    
    mapper - Mapper to convert the Valid object into readable String for the final user.
    
    errorMessageKey - Error message's key in resource bundle.
    
    Returns:
    
    null if no problems found, Error message if the argument is not a valid option.
  - validate
```
String validate(net.dv8tion.jda.api.events.message.MessageReceivedEvent event,
                String arg)
```
    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
```
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. 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.
  - getDefaultValue
```
T getDefaultValue()
```
    Get the default value of the argument if the user does not input a value.
    
    Returns:
    
    default value object for the argument.
  - getValue
```
T getValue()
```
    Get the current value of the argument.
    
    Returns:
    
    argument's value after parsing.
  - setValue
```
A setValue(T value)
```
    Set the parsed value after validations, to be used into the command.
    
    Parameters:
    
    value - final value after parsing.
    
    Returns:
    
    a reference to this object.
  - parse
```
T parse(net.dv8tion.jda.api.events.message.MessageReceivedEvent event,
        String arg)
 throws Exception
```
    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:
    
    validate(MessageReceivedEvent, String)
  - parse
```
T parse(net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event,
        String arg)
 throws Exception
```
    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:
    
    validate(MessageReceivedEvent, String)
  - getType
```
ArgumentTypes getType()
```
    Gets the argument's type.
    
    Returns:
    
    ArgumentTypes enum value.
  - setSlashValue
```
A setSlashValue(net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event,
                Object value)
         throws Exception
```
    Sets the value when the command is called via discord's slash command. Commands are only included as Slash if Slash interface is implemented.
    
    Parameters:
    
    event - Discord event that triggered this function call.
    
    value - final value after parsing.
    
    Returns:
    
    a reference to this object.
    
    Throws:
    
    Exception - Thrown when Validation fails.
    
    See Also:
    
    ICommand, Slash
  - getValidValues
```
List<T> getValidValues()
```
    return a list of valid values set for this argument.
    
    Returns:
    
    list of valid values.
  - addValidValues
```
A addValidValues(T... validValues)
```
    Add valid values to the argument.
    
    Parameters:
    
    validValues - list of valid values for the argument.
    
    Returns:
    
    a reference to this object.
  - clone
```
A clone()
```
    An argument clone is required to prevent a value traveling through different Command calls.
    
    Returns:
    
    a clone of this instance.

Interface IArgument<A extends IArgument,T>

Method Summary

Method Detail

isRequired

getMax

getMin

getName

getPrompt

getPrompt

validateNull

oneOf

validate

validate

getDefaultValue

getValue

setValue

parse

parse

getType

setSlashValue

getValidValues

addValidValues

clone