Package net.dv8tion.jda.api.interactions.commands

Class Command.Choice

java.lang.Object

net.dv8tion.jda.api.interactions.commands.Command.Choice

Enclosing interface:

Command

public static class Command.Choice
extends Object

Predefined choice used for options.

See Also:

• OptionData.addChoices(Command.Choice...)
• OptionData.addChoices(Collection)

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_NAME_LENGTH	The maximum length the name of a choice can be.
static final int	MAX_STRING_VALUE_LENGTH	The maximum length the STRING value of a choice can be.

Constructor Summary

Constructors

Constructor	Description
Choice(String name, double value)	Create a Choice tuple
Choice(String name, long value)	Create a Choice tuple
Choice(String name, String value)	Create a Choice tuple
Choice(DataObject json)	Create a Choice tuple

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
double	getAsDouble()	The value of this choice.
long	getAsLong()	The value of this choice.
String	getAsString()	The value of this choice.
String	getName()	The readable name of this choice.
LocalizationMap	getNameLocalizations()	The localizations of this choice's name for various languages.
OptionType	getType()	The OptionType this choice is for
int	hashCode()
Command.Choice	setName(String name)	Configure the choice name
Command.Choice	setNameLocalization(DiscordLocale locale, String name)	Sets the name localizations of this choice.
Command.Choice	setNameLocalizations(Map<DiscordLocale,String> map)	Sets the name localizations of this choice.
DataObject	toData(OptionType optionType)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

MAX_NAME_LENGTH

public static final int MAX_NAME_LENGTH

The maximum length the name of a choice can be.

See Also:

• Constant Field Values

MAX_STRING_VALUE_LENGTH

public static final int MAX_STRING_VALUE_LENGTH

The maximum length the STRING value of a choice can be.

See Also:

• Constant Field Values

Constructor Details

Choice

public Choice(@Nonnull
 String name,
 long value)

Create a Choice tuple

Parameters:

name - The display name of this choice, must be less than 100 characters

value - The integer value you receive in a command option

Throws:

IllegalArgumentException - If the name is null, empty, or not between 1-100 characters long, as defined by MAX_NAME_LENGTH

Choice

public Choice(@Nonnull
 String name,
 double value)

Create a Choice tuple

Parameters:

name - The display name of this choice, must be less than 100 characters

value - The double value you receive in a command option

Throws:

IllegalArgumentException - If the name is null, empty, or not between 1-100 characters long, as defined by MAX_NAME_LENGTH

Choice

public Choice(@Nonnull
 String name,
 @Nonnull
 String value)

Create a Choice tuple

Parameters:

name - The display name of this choice, must be less than 100 characters

value - The string value you receive in a command option

Throws:

IllegalArgumentException -

• If the name is null, empty, or not between 1-100 characters long, as defined by MAX_NAME_LENGTH
• If the value is null or longer than 100 characters long, as defined by MAX_STRING_VALUE_LENGTH

Choice

public Choice(@Nonnull
 DataObject json)

Create a Choice tuple

Parameters:

json - The serialized choice instance with name and value mapping

Throws:

IllegalArgumentException - If null is provided

ParsingException - If the data is not formatted correctly or missing required parameters

Method Details

getName

@Nonnull
public String getName()

The readable name of this choice.
This is shown to the user in the official client.

Returns:

The choice name

setName

@Nonnull
public Command.Choice setName(@Nonnull
 String name)

Configure the choice name

Parameters:

name - The choice name, 1-100 characters long

Returns:

The Choice instance, for chaining

Throws:

IllegalArgumentException - If the name is null, empty, or not between 1-100 characters long, as defined by MAX_NAME_LENGTH

getNameLocalizations

@Nonnull
public LocalizationMap getNameLocalizations()

The localizations of this choice's name for various languages.

Returns:

The LocalizationMap containing the mapping from DiscordLocale to the localized name

setNameLocalization

@Nonnull
public Command.Choice setNameLocalization(@Nonnull
 DiscordLocale locale,
 @Nonnull
 String name)

Sets the name localizations of this choice.

Parameters:

locale - The locale to associate the translated name with

name - The translated name to put

Returns:

This builder instance, for chaining

Throws:

IllegalArgumentException -

• If the locale is null
• If the name is null
• If the locale is DiscordLocale.UNKNOWN
• If the name does not pass the corresponding name check

setNameLocalizations

@Nonnull
public Command.Choice setNameLocalizations(@Nonnull
 Map<DiscordLocale,String> map)

Sets the name localizations of this choice.

Parameters:

map - The map from which to transfer the translated names

Returns:

This builder instance, for chaining

Throws:

IllegalArgumentException -

• If the map is null
• If the map contains an DiscordLocale.UNKNOWN key
• If the map contains a name which does not pass the corresponding name check

getAsDouble

public double getAsDouble()

The value of this choice.

Returns:

The double value, or NaN if this is not a numeric choice value

getAsLong

public long getAsLong()

The value of this choice.

Returns:

The long value

getAsString

@Nonnull
public String getAsString()

The value of this choice.

Returns:

The String value

getType

@Nonnull
public OptionType getType()

The OptionType this choice is for

Returns:

The option type of this choice

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toData

@Nonnull
public DataObject toData(OptionType optionType)