Package me.s3ns3iw00.jcommands.argument.type

Class ComboArgument

java.lang.Object

me.s3ns3iw00.jcommands.argument.Argument<O>

me.s3ns3iw00.jcommands.argument.InputArgument<java.lang.Object,Choice>

me.s3ns3iw00.jcommands.argument.type.ComboArgument

public class ComboArgument
extends InputArgument<java.lang.Object,Choice>

Represents an InputArgument that has multiple choices, and they are the only valid values for the user to pick The values are key value pairs The key is String and the value can be String or Long

Constructor Summary

Constructors

Constructor	Description
ComboArgument(java.lang.String name, java.lang.String description, org.javacord.api.interaction.SlashCommandOptionType type)	Constructs the argument with the default requirements

Method Summary

Modifier and Type	Method	Description
void	addChoice(java.lang.String key, long value)	Adds a choice
void	addChoice(java.lang.String key, java.lang.String value)	Adds a choice
Choice	getChoice(java.lang.Object value)	Returns the choice based on value
org.javacord.api.interaction.SlashCommandOption	getCommandOption()
java.lang.Class<Choice>	getResultType()

Methods inherited from class me.s3ns3iw00.jcommands.argument.InputArgument

convertResult, getArgumentValidator, getResultConverter, isOptional, setOptional

Methods inherited from class me.s3ns3iw00.jcommands.argument.Argument

getDescription, getMismatchListener, getName, getType, setOnMismatch

Methods inherited from class java.lang.Object

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

Constructor Detail

ComboArgument

public ComboArgument(java.lang.String name,
                     java.lang.String description,
                     org.javacord.api.interaction.SlashCommandOptionType type)

Constructs the argument with the default requirements

Parameters:

name - the argument's name

description - the argument's description

type - the type of the input value, can be SlashCommandOptionType.STRING or SlashCommandOptionType.LONG

Method Detail

addChoice

public void addChoice(java.lang.String key,
                      java.lang.String value)

Adds a choice

Parameters:

key - is the name of the argument

value - is the value of the argument as String

addChoice

public void addChoice(java.lang.String key,
                      long value)

Adds a choice

Parameters:

key - the name of the argument

value - the value of the argument as Long

getChoice

public Choice getChoice(java.lang.Object value)

Returns the choice based on value

Parameters:

value - the value

getResultType

public java.lang.Class<Choice> getResultType()

Overrides:

getResultType in class InputArgument<java.lang.Object,Choice>

Returns:

the class of the result's type

getCommandOption

public org.javacord.api.interaction.SlashCommandOption getCommandOption()

Overrides:

getCommandOption in class InputArgument<java.lang.Object,Choice>

Returns:

the command option that need for to register the argument