revxrsal.commands.jda

Class JDAUtils

java.lang.Object

revxrsal.commands.jda.JDAUtils

public final class JDAUtils
extends java.lang.Object

Includes utilities for the JDA platform

Method Summary

Modifier and Type	Method and Description
static @Nullable net.dv8tion.jda.api.entities.channel.ChannelType	channelType(@NotNull java.lang.Class<? extends net.dv8tion.jda.api.entities.channel.Channel> channelInterface) Returns the ChannelType that corresponds to the given channel interface
static <A extends revxrsal.commands.command.CommandActor> @NotNull java.util.Optional<revxrsal.commands.command.ExecutableCommand<A>>	findCommand(@NotNull revxrsal.commands.Lamp<A> lamp, @NotNull java.lang.String fullPath, @NotNull java.util.List<net.dv8tion.jda.api.interactions.commands.OptionMapping> options) Finds the most suitable ExecutableCommand from the given path and options
static <A extends revxrsal.commands.command.CommandActor> @NotNull java.lang.Object	fromOption(@NotNull net.dv8tion.jda.api.interactions.commands.OptionMapping option, @NotNull revxrsal.commands.node.ParameterNode<A,?> parameter) Parses the object inside the OptionMapping safely to be fed into a ParameterNode
static <A extends revxrsal.commands.command.CommandActor> @NotNull java.lang.String	getRequiredPath(@NotNull revxrsal.commands.command.ExecutableCommand<A> command) Returns the required literal path of the given command.
static @NotNull net.dv8tion.jda.api.interactions.commands.Command.Choice	toChoice(@NotNull java.lang.String suggestion, @NotNull net.dv8tion.jda.api.interactions.commands.OptionType type) Maps the given suggestion to a Command.Choice.
static @NotNull java.util.List<net.dv8tion.jda.api.interactions.commands.Command.Choice>	toChoices(@NotNull java.util.Collection<java.lang.String> suggestions, @NotNull net.dv8tion.jda.api.interactions.commands.OptionType type) Maps the given list of suggestions to a list of Command.Choices.
static <A extends SlashCommandActor> @NotNull net.dv8tion.jda.api.interactions.commands.build.OptionData	toOptionData(@NotNull revxrsal.commands.node.ParameterNode<A,java.lang.Object> parameter) Creates OptionData from the given ParameterNode.
static <A extends SlashCommandActor> @NotNull net.dv8tion.jda.api.interactions.commands.OptionType	toOptionType(revxrsal.commands.node.ParameterNode<A,java.lang.Object> parameter) Finds a suitable OptionType for the given ParameterNode.

Methods inherited from class java.lang.Object

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

Method Detail

findCommand

@NotNull
public static <A extends revxrsal.commands.command.CommandActor> @NotNull java.util.Optional<revxrsal.commands.command.ExecutableCommand<A>> findCommand(@NotNull
                                                                                                                                                                  @NotNull revxrsal.commands.Lamp<A> lamp,
                                                                                                                                                                  @NotNull
                                                                                                                                                                  @NotNull java.lang.String fullPath,
                                                                                                                                                                  @NotNull
                                                                                                                                                                  @NotNull java.util.List<net.dv8tion.jda.api.interactions.commands.OptionMapping> options)

Finds the most suitable ExecutableCommand from the given path and options

Type Parameters:

A - The actor type

Parameters:

lamp - The Lamp instance

fullPath - The full path of literals

options - The supplied list of options

Returns:

The command, or Optional.empty() if not found.

fromOption

@NotNull
public static <A extends revxrsal.commands.command.CommandActor> @NotNull java.lang.Object fromOption(@NotNull
                                                                                                               @NotNull net.dv8tion.jda.api.interactions.commands.OptionMapping option,
                                                                                                               @NotNull
                                                                                                               @NotNull revxrsal.commands.node.ParameterNode<A,?> parameter)

Parses the object inside the OptionMapping safely to be fed into a ParameterNode

Type Parameters:

A - The actor type

Parameters:

option - The option to parse from

parameter - The parameter to adapt for

Returns:

The resolved value

toOptionData

@Contract(value="_ -> new",
          pure=true)
 @NotNull
public static <A extends SlashCommandActor> @NotNull net.dv8tion.jda.api.interactions.commands.build.OptionData toOptionData(@NotNull
                                                                                                                                                                                        @NotNull revxrsal.commands.node.ParameterNode<A,java.lang.Object> parameter)

Creates OptionData from the given ParameterNode. This will respect the following annotations:

• @NSFW
• @Range
• @Length
• @Choices

If the parameter type is an enum, it will also use its values as predefined choices

Type Parameters:

A - The actor type

Parameters:

parameter - The parameter to parse for

Returns:

The created OptionData.

toOptionType

@NotNull
public static <A extends SlashCommandActor> @NotNull net.dv8tion.jda.api.interactions.commands.OptionType toOptionType(revxrsal.commands.node.ParameterNode<A,java.lang.Object> parameter)

Finds a suitable OptionType for the given ParameterNode. This will never return null. In cases of an odd parameter type, this will return an OptionType.STRING.

Type Parameters:

A - The actor type

Parameters:

parameter - The parameter to find for

Returns:

The best option type

toChoice

@NotNull
public static @NotNull net.dv8tion.jda.api.interactions.commands.Command.Choice toChoice(@NotNull
                                                                                                  @NotNull java.lang.String suggestion,
                                                                                                  @NotNull
                                                                                                  @NotNull net.dv8tion.jda.api.interactions.commands.OptionType type)

Maps the given suggestion to a Command.Choice. This will convert it to a double or integer if necessary

Parameters:

suggestion - Suggestion to map

type - The option type

Returns:

The choice

toChoices

@NotNull
public static @NotNull java.util.List<net.dv8tion.jda.api.interactions.commands.Command.Choice> toChoices(@NotNull
                                                                                                                   @NotNull java.util.Collection<java.lang.String> suggestions,
                                                                                                                   @NotNull
                                                                                                                   @NotNull net.dv8tion.jda.api.interactions.commands.OptionType type)

Maps the given list of suggestions to a list of Command.Choices. This will convert them to doubles or integers if necessary.

Parameters:

suggestions - Suggestions to map

type - The suggestions type

Returns:

The list of choices

getRequiredPath

@Contract(pure=true)
 @NotNull
public static <A extends revxrsal.commands.command.CommandActor> @NotNull java.lang.String getRequiredPath(@NotNull
                                                                                                                                          @NotNull revxrsal.commands.command.ExecutableCommand<A> command)

Returns the required literal path of the given command. This will join all the paths of literals until it encounters a non-literal.

Type Parameters:

A - The actor type

Parameters:

command - Command to get the path for

Returns:

The path

channelType

@Nullable
public static @Nullable net.dv8tion.jda.api.entities.channel.ChannelType channelType(@NotNull
                                                                                               @NotNull java.lang.Class<? extends net.dv8tion.jda.api.entities.channel.Channel> channelInterface)

Returns the ChannelType that corresponds to the given channel interface

Parameters:

channelInterface - The interface to check for

Returns:

The channel type, or null if not found.