Argument

java.lang.Object
- com.ericramirezs.commando4j.arguments.Argument<A,T>

Type Parameters:

A - Self argument object that implements Argument.

T - result object after parsing the argument.

All Implemented Interfaces:

IArgument<A,T>

Direct Known Subclasses:

AnnouncementChannelArgument, AudioChannelArgument, BooleanArgument, CategoryChannelArgument, ChannelArgument, CommandArgument, CustomEmojiArgument, FloatArgument, GuildArgument, IntegerArgument, LocalDateArgument, LocalTimeArgument, MemberArgument, MessageArgument, MessageChannelArgument, RoleArgument, StageChannelArgument, StringArgument, TextChannelArgument, ThreadChannelArgument, UnionArgument, URLArgument, UserArgument, VoiceChannelArgument
```
public abstract class Argument<A extends Argument,T>
extends Object
implements IArgument<A,T>
```
Implementation class of the IArgument Interface.

See Also:

IArgument

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Argument(@NotNull String name, @NotNull String prompt, @NotNull ArgumentTypes type)` Creates an instance of an Argument Object.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`A`	`addValidValues(T... validValues)` Add valid values to the argument.
`abstract A`	`clone()` An argument clone is required to prevent a value traveling through different Command calls.
`protected A`	`clone(A clone)`
`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.
`String`	`getPromptRaw()` Get the raw value of prompt property.
`ArgumentTypes`	`getType()` Gets the argument's type.
`@NotNull List<T>`	`getValidValues()` return a list of valid values set for this argument.
`T`	`getValue()` Get the current value of the argument.
`protected com.ericramirezs.commando4j.arguments.RangeError`	`inRange(double arg)` Checks if the value is between the expected range.
`protected com.ericramirezs.commando4j.arguments.RangeError`	`inRange(float arg)` Checks if the value is between the expected range.
`protected com.ericramirezs.commando4j.arguments.RangeError`	`inRange(int arg)` Checks if the value is between the expected range.
`protected com.ericramirezs.commando4j.arguments.RangeError`	`inRange(long arg)` Checks if the value is between the expected range.
`protected com.ericramirezs.commando4j.arguments.RangeError`	`inRange(Number arg)` Checks if the value is between the expected range.
`protected com.ericramirezs.commando4j.arguments.RangeError`	`inRange(@NotNull String arg)` Checks if the value is between the expected range.
`boolean`	`isRequired()` Checks if the argument requires a value to be set.
`@Nullable 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.
`A`	`setDefaultValue(Supplier<T> defaultValueFunction)` Set a function to be called if the user did not input a value for this argument.
`A`	`setDefaultValue(T defaultValue)` Set the default value if the user did not input a value for this argument.
`A`	`setMax(Double max)` Set the maximum value allowed for this argument.
`A`	`setMax(float max)` Set the maximum value allowed for this argument.
`A`	`setMax(int max)` Set the maximum value allowed for this argument.
`A`	`setMax(long max)` Set the maximum value allowed for this argument.
`A`	`setMin(Double min)` Set the minimum value allowed for this argument.
`A`	`setMin(float min)` Set the minimum value allowed for this argument.
`A`	`setMin(int min)` Set the minimum value allowed for this argument.
`A`	`setMin(long min)` Set the minimum value allowed for this argument.
`void`	`setPromptParser(Function<net.dv8tion.jda.api.events.Event,String> f)` set a function to handle Argument's prompt.
`A`	`setRequired()` Set if the argument usage is mandatory for the user.
`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`	`validateNull(@Nullable String arg, net.dv8tion.jda.api.events.message.MessageReceivedEvent event)` Checks if the argument accepts null values.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ericramirezs.commando4j.arguments.IArgument
parse, parse, validate, validate

- Constructor Detail
  - Argument
```
protected Argument(@NotNull
                   @NotNull String name,
                   @NotNull
                   @NotNull String prompt,
                   @NotNull
                   @NotNull ArgumentTypes type)
```
    Creates an instance of an Argument Object.
    
    Parameters:
    
    name - Readable name to display to the final
    
    prompt - Hint to indicate the user the expected value to be passed to this argument.
    
    type - Category of the argument implementation.
- Method Detail
  - setPromptParser
```
public void setPromptParser(Function<net.dv8tion.jda.api.events.Event,String> f)
```
    set a function to handle Argument's prompt.
    
    Parameters:
    
    f - function.
  - getPromptRaw
```
public String getPromptRaw()
```
    Get the raw value of prompt property.
    
    Returns:
    
    prompt value's.
  - setDefaultValue
```
public A setDefaultValue(T defaultValue)
```
    Set the default value if the user did not input a value for this argument.
    
    Parameters:
    
    defaultValue - Value to be used if no value was input by the user.
    
    Returns:
    
    a reference to this object.
  - setDefaultValue
```
public A setDefaultValue(Supplier<T> defaultValueFunction)
```
    Set a function to be called if the user did not input a value for this argument.
    
    Parameters:
    
    defaultValueFunction - function to generate a default value.
    
    Returns:
    
    a reference to this object.
  - setRequired
```
public A setRequired()
```
    Set if the argument usage is mandatory for the user.
    
    Returns:
    
    a reference to this object.
  - setMax
```
public A setMax(int max)
```
    Set the maximum value allowed for this argument. It may be used to limit a String length or a numeric max value.
    
    Parameters:
    
    max - maximum value
    
    Returns:
    
    a reference to this object.
  - setMax
```
public A setMax(long max)
```
    Set the maximum value allowed for this argument. It may be used to limit a String length or a numeric max value.
    
    Parameters:
    
    max - maximum value
    
    Returns:
    
    a reference to this object.
  - setMax
```
public A setMax(Double max)
```
    Set the maximum value allowed for this argument. It may be used to limit a String length or a numeric max value.
    
    Parameters:
    
    max - maximum value
    
    Returns:
    
    a reference to this object.
  - setMax
```
public A setMax(float max)
```
    Set the maximum value allowed for this argument. It may be used to limit a String length or a numeric max value.
    
    Parameters:
    
    max - maximum value
    
    Returns:
    
    a reference to this object.
  - setMin
```
public A setMin(int min)
```
    Set the minimum value allowed for this argument. It may be used to limit a String length or a numeric max value.
    
    Parameters:
    
    min - minimum value
    
    Returns:
    
    a reference to this object.
  - setMin
```
public A setMin(long min)
```
    Set the minimum value allowed for this argument. It may be used to limit a String length or a numeric max value.
    
    Parameters:
    
    min - minimum value
    
    Returns:
    
    a reference to this object.
  - setMin
```
public A setMin(Double min)
```
    Set the minimum value allowed for this argument. It may be used to limit a String length or a numeric max value.
    
    Parameters:
    
    min - minimum value
    
    Returns:
    
    a reference to this object.
  - setMin
```
public A setMin(float min)
```
    Set the minimum value allowed for this argument. It may be used to limit a String length or a numeric max value.
    
    Parameters:
    
    min - minimum value
    
    Returns:
    
    a reference to this object.
  - inRange
```
protected com.ericramirezs.commando4j.arguments.RangeError inRange(Number arg)
```
    Checks if the value is between the expected range.
    
    Parameters:
    
    arg - value.
    
    Returns:
    
    Range error type enum, RangeError.NONE if no error was found.
    
    See Also:
    
    RangeError
  - inRange
```
protected com.ericramirezs.commando4j.arguments.RangeError inRange(int arg)
```
    Checks if the value is between the expected range.
    
    Parameters:
    
    arg - value.
    
    Returns:
    
    Range error type enum, RangeError.NONE if no error was found.
    
    See Also:
    
    RangeError
  - inRange
```
protected com.ericramirezs.commando4j.arguments.RangeError inRange(long arg)
```
    Checks if the value is between the expected range.
    
    Parameters:
    
    arg - value.
    
    Returns:
    
    Range error type enum, RangeError.NONE if no error was found.
    
    See Also:
    
    RangeError
  - inRange
```
protected com.ericramirezs.commando4j.arguments.RangeError inRange(float arg)
```
    Checks if the value is between the expected range.
    
    Parameters:
    
    arg - value.
    
    Returns:
    
    Range error type enum, RangeError.NONE if no error was found.
    
    See Also:
    
    RangeError
  - inRange
```
protected com.ericramirezs.commando4j.arguments.RangeError inRange(@NotNull
                                                                   @NotNull String arg)
```
    Checks if the value is between the expected range.
    
    Parameters:
    
    arg - value.
    
    Returns:
    
    Range error type enum, RangeError.NONE if no error was found.
    
    See Also:
    
    RangeError
  - inRange
```
protected com.ericramirezs.commando4j.arguments.RangeError inRange(double arg)
```
    Checks if the value is between the expected range.
    
    Parameters:
    
    arg - value.
    
    Returns:
    
    Range error type enum, RangeError.NONE if no error was found.
    
    See Also:
    
    RangeError
  - isRequired
```
public boolean isRequired()
```
    Description copied from interface: IArgument
    
    Checks if the argument requires a value to be set.
    
    Specified by:
    
    isRequired in interface IArgument<A extends Argument,T>
    
    Returns:
    
    true if value cannot be null, false otherwise.
    
    See Also:
    
    IArgument.getValue()
  - getValue
```
public T getValue()
```
    Description copied from interface: IArgument
    
    Get the current value of the argument.
    
    Specified by:
    
    getValue in interface IArgument<A extends Argument,T>
    
    Returns:
    
    argument's value after parsing.
  - setValue
```
public A setValue(T value)
```
    Description copied from interface: IArgument
    
    Set the parsed value after validations, to be used into the command.
    
    Specified by:
    
    setValue in interface IArgument<A extends Argument,T>
    
    Parameters:
    
    value - final value after parsing.
    
    Returns:
    
    a reference to this object.
  - getName
```
public String getName()
```
    Description copied from interface: IArgument
    
    Get the argument's name.
    
    Specified by:
    
    getName in interface IArgument<A extends Argument,T>
    
    Returns:
    
    the argument's name.
  - getPrompt
```
public String getPrompt()
```
    Description copied from interface: IArgument
    
    Get the argument's prompt. Used to give the final user a hint of the expected value.
    
    Specified by:
    
    getPrompt in interface IArgument<A extends Argument,T>
    
    Returns:
    
    the argument's prompt.
  - getPrompt
```
public String getPrompt(net.dv8tion.jda.api.events.Event event)
```
    Description copied from interface: IArgument
    
    Get the argument's prompt. Used to give the final user a hint of the expected value.
    
    Specified by:
    
    getPrompt in interface IArgument<A extends Argument,T>
    
    Parameters:
    
    event - Discord event that triggered this function call.
    
    Returns:
    
    the argument's prompt.
  - getDefaultValue
```
public T getDefaultValue()
```
    Description copied from interface: IArgument
    
    Get the default value of the argument if the user does not input a value.
    
    Specified by:
    
    getDefaultValue in interface IArgument<A extends Argument,T>
    
    Returns:
    
    default value object for the argument.
  - addValidValues
```
@SafeVarargs
public final A addValidValues(T... validValues)
```
    Description copied from interface: IArgument
    
    Add valid values to the argument.
    
    Specified by:
    
    addValidValues in interface IArgument<A extends Argument,T>
    
    Parameters:
    
    validValues - list of valid values for the argument.
    
    Returns:
    
    a reference to this object.
  - getMax
```
public Double getMax()
```
    Description copied from interface: IArgument
    
    Get the maximum value allowed for this argument. It may be used to limit a String length or a numeric max value.
    
    Specified by:
    
    getMax in interface IArgument<A extends Argument,T>
    
    Returns:
    
    Maximum value related to the Object, null if not defined.
  - getMin
```
public Double getMin()
```
    Description copied from interface: IArgument
    
    Get the minimum value allowed for this argument. It may be used to limit a String length or a numeric minimum value.
    
    Specified by:
    
    getMin in interface IArgument<A extends Argument,T>
    
    Returns:
    
    Minimum value related to the Object, null if not defined.
  - getValidValues
```
@Contract(value=" -> new")
 @NotNull
public @NotNull List<T> getValidValues()
```
    Description copied from interface: IArgument
    
    return a list of valid values set for this argument.
    
    Specified by:
    
    getValidValues in interface IArgument<A extends Argument,T>
    
    Returns:
    
    list of valid values.
  - getType
```
public ArgumentTypes getType()
```
    Description copied from interface: IArgument
    
    Gets the argument's type.
    
    Specified by:
    
    getType in interface IArgument<A extends Argument,T>
    
    Returns:
    
    ArgumentTypes enum value.
  - validateNull
```
public final String validateNull(@Nullable
                                 @Nullable String arg,
                                 net.dv8tion.jda.api.events.message.MessageReceivedEvent event)
```
    Description copied from interface: IArgument
    
    Checks if the argument accepts null values. If null values are not accepted and the value input by the user.
    
    Specified by:
    
    validateNull in interface IArgument<A extends Argument,T>
    
    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
```
@Nullable
public @Nullable String oneOf(T object,
                                         net.dv8tion.jda.api.events.Event event,
                                         Function<T,String> mapper,
                                         String errorMessageKey)
```
    Description copied from interface: IArgument
    
    Checks if the argument is one of the specified valid values.
    
    Specified by:
    
    oneOf in interface IArgument<A extends Argument,T>
    
    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.
  - setSlashValue
```
public A setSlashValue(net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event,
                       Object value)
                throws Exception
```
    Description copied from interface: IArgument
    
    Sets the value when the command is called via discord's slash command. Commands are only included as Slash if Slash interface is implemented.
    
    Specified by:
    
    setSlashValue in interface IArgument<A extends Argument,T>
    
    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
  - clone
```
public abstract A clone()
```
    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<A extends Argument,T>
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    a clone of this instance.
  - clone
```
protected A clone(@NotNull
                  A clone)
```

Class Argument<A extends Argument,T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.ericramirezs.commando4j.arguments.IArgument

Constructor Detail

Argument

Method Detail

setPromptParser

getPromptRaw

setDefaultValue

setDefaultValue

setRequired

setMax

setMax

setMax

setMax

setMin

setMin

setMin

setMin

inRange

inRange

inRange

inRange

inRange

inRange

isRequired

getValue

setValue

getName

getPrompt

getPrompt

getDefaultValue

addValidValues

getMax

getMin

getValidValues

getType

validateNull

oneOf

setSlashValue

clone

clone