Index

A B C D E F G H I J L M N O P R S T U V W

A

AboutCommand - Class in com.jagrosh.jdautilities.examples.command
AboutCommand(Color, String, String[], Permission...) - Constructor for class com.jagrosh.jdautilities.examples.command.AboutCommand
add(K, V) - Method in class com.jagrosh.jdautilities.commons.utils.FixedSizeCache: Adds a key and pairs it with a value.
addAlias(String) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Adds a alias for the Command built from this CommandBuilder.
addAliases(String...) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Adds aliases for the Command built from this CommandBuilder.
addAnnotatedModule(Object) - Method in interface com.jagrosh.jdautilities.command.CommandClient: Compiles the provided Object annotated with JDACommand.Module into a List of Commands and adds them to this CommandClient in the order they are listed.
addAnnotatedModule(Object, Function<Command, Integer>) - Method in interface com.jagrosh.jdautilities.command.CommandClient: Compiles the provided Object annotated with JDACommand.Module into a List of Commands and adds them to this CommandClient via the Function provided.
addAnnotatedModule(Object) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Adds an annotated command module to the CommandClientImpl for this session.
addAnnotatedModule(Object) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
addAnnotatedModule(Object, Function<Command, Integer>) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
addAnnotatedModules(Object...) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Adds multiple annotated command modules to the CommandClientImpl for this session.
addChild(Command) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Adds a child Command to the Command built from this CommandBuilder.
addChildren(Command...) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Adds child Commands to the Command built from this CommandBuilder.
addChoice(String) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu.Builder: Adds a single String unicode emoji as a button choice.
addChoice(Emote) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu.Builder: Adds a single custom Emote as button choices.
addChoice(String) - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder: Adds a single String choice.
addChoices(String...) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu.Builder: Adds String unicode emojis as button choices.
addChoices(Emote...) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu.Builder: Adds custom Emotes as button choices.
addChoices(String...) - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder: Adds the String choices.
addChoices(String...) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder: Adds String choices to be shown as selections.
addCommand(Command) - Method in interface com.jagrosh.jdautilities.command.CommandClient: Adds a single Command to this CommandClient's registered Commands.
addCommand(Command, int) - Method in interface com.jagrosh.jdautilities.command.CommandClient: Adds a single Command to this CommandClient's registered Commands at the specified index.
addCommand(Command) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Adds a Command and registers it to the CommandClientImpl for this session.
addCommand(Command) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
addCommand(Command, int) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
addCommands(Command...) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Adds and registers multiple Commands to the CommandClientImpl for this session.
addItems(String...) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder: Adds String items to the list of items to paginate.
addItems(String...) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder: Adds String items to the list of items to paginate.
addRoles(Role...) - Method in class com.jagrosh.jdautilities.menu.Menu.Builder: Adds Roles that are allowed to use the Menu that will be built.
addUsers(User...) - Method in class com.jagrosh.jdautilities.menu.Menu.Builder: Adds Users that are allowed to use the Menu that will be built.
aliases - Variable in class com.jagrosh.jdautilities.command.Command: The aliases of the command, when calling a command these function identically to calling the Command.name.
allowTextInput(boolean) - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder: If true, Users can type the number or letter of the input to make their selection, in addition to the reaction option.
allowTextInput(boolean) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder: Sets the Paginator to allow a page number to be specified by a user via text.
allowTextInput(boolean) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder: Sets the Slideshow to allow a slide number to be specified by a user via text.
AnnotatedModuleCompiler - Interface in com.jagrosh.jdautilities.command: A "compiler" for Objects that uses Annotations as helpers for creating Commands.
AnnotatedModuleCompilerImpl - Class in com.jagrosh.jdautilities.command.impl: Default implementation for AnnotatedModuleCompiler.
AnnotatedModuleCompilerImpl() - Constructor for class com.jagrosh.jdautilities.command.impl.AnnotatedModuleCompilerImpl
applyCooldown(String, int) - Method in interface com.jagrosh.jdautilities.command.CommandClient: Applies the specified cooldown with the provided name.
applyCooldown(String, int) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
arguments - Variable in class com.jagrosh.jdautilities.command.Command: An arguments format String for the command, used in the default help builder.
async(Runnable) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Uses the client's executor to run the provided Runnable asynchronously without blocking the thread this is called in.
AUTHOR - Static variable in class com.jagrosh.jdautilities.commons.JDAUtilitiesInfo
Author - Annotation Type in com.jagrosh.jdautilities.examples.doc: Annotation to mark a command's specific author.
Author.Converter - Class in com.jagrosh.jdautilities.examples.doc

B

BIG_LEFT - Static variable in class com.jagrosh.jdautilities.menu.Paginator
BIG_LEFT - Static variable in class com.jagrosh.jdautilities.menu.Slideshow
BIG_RIGHT - Static variable in class com.jagrosh.jdautilities.menu.Paginator
BIG_RIGHT - Static variable in class com.jagrosh.jdautilities.menu.Slideshow
botPermissions - Variable in class com.jagrosh.jdautilities.command.Command: Any Permissions the bot must have to use a command.
build(Consumer<CommandEvent>) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Builds the Command using the previously provided information.
build(BiConsumer<Command, CommandEvent>) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Builds the Command using the previously provided information.
build() - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Builds a CommandClientImpl with the provided settings.
build() - Method in class com.jagrosh.jdautilities.menu.ButtonMenu.Builder: Builds the ButtonMenu with this Builder.
build() - Method in class com.jagrosh.jdautilities.menu.Menu.Builder: Builds the Menu corresponding to this Menu.Builder.
build() - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder: Builds the OrderedMenu with this Builder.
build() - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder: Builds the Paginator with this Builder.
build() - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder: Builds the SelectionDialog with this Builder.
build() - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder: Builds the Slideshow with this Builder.
Builder() - Constructor for class com.jagrosh.jdautilities.menu.ButtonMenu.Builder
Builder() - Constructor for class com.jagrosh.jdautilities.menu.Menu.Builder
Builder() - Constructor for class com.jagrosh.jdautilities.menu.OrderedMenu.Builder
Builder() - Constructor for class com.jagrosh.jdautilities.menu.Paginator.Builder
Builder() - Constructor for class com.jagrosh.jdautilities.menu.SelectionDialog.Builder
Builder() - Constructor for class com.jagrosh.jdautilities.menu.Slideshow.Builder
ButtonMenu - Class in com.jagrosh.jdautilities.menu: A Menu implementation that creates a organized display of emotes/emojis as buttons paired with options, and below the menu reactions corresponding to each button.
ButtonMenu.Builder - Class in com.jagrosh.jdautilities.menu: The Menu.Builder for a ButtonMenu.

C

CANCEL - Static variable in class com.jagrosh.jdautilities.menu.OrderedMenu
CANCEL - Static variable in class com.jagrosh.jdautilities.menu.SelectionDialog
category - Variable in class com.jagrosh.jdautilities.command.Command: The Category of the command.
Category(String) - Constructor for class com.jagrosh.jdautilities.command.Command.Category: A Command Category containing a name.
Category(String, Predicate<CommandEvent>) - Constructor for class com.jagrosh.jdautilities.command.Command.Category: A Command Category containing a name and a Predicate.
Category(String, String, Predicate<CommandEvent>) - Constructor for class com.jagrosh.jdautilities.command.Command.Category: A Command Category containing a name, a Predicate, and a failure response.
CHANNEL_MENTION - Static variable in class com.jagrosh.jdautilities.commons.utils.FinderUtil
checkId(String) - Static method in class com.jagrosh.jdautilities.commons.utils.SafeIdUtil: Checks if the provided String ID is usable with MiscUtil.parseSnowflake(String).
children - Variable in class com.jagrosh.jdautilities.command.Command: The child commands of the command.
cleanCooldowns() - Method in interface com.jagrosh.jdautilities.command.CommandClient: Cleans up expired cooldowns to reduce memory.
cleanCooldowns() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
clearChoices() - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder: Clears all previously set choices.
clearChoices() - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder: Clears the choices to be shown.
clearItems() - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder: Clears the list of String items to paginate.
com.jagrosh.jdautilities.command - package com.jagrosh.jdautilities.command: Items in this package pertain to the CommandClient and Commands.
com.jagrosh.jdautilities.command.annotation - package com.jagrosh.jdautilities.command.annotation
com.jagrosh.jdautilities.command.impl - package com.jagrosh.jdautilities.command.impl
com.jagrosh.jdautilities.commons - package com.jagrosh.jdautilities.commons: Common package for all package for all utilities, used both internally and available for developer usage outside of the extension library.
com.jagrosh.jdautilities.commons.utils - package com.jagrosh.jdautilities.commons.utils
com.jagrosh.jdautilities.commons.waiter - package com.jagrosh.jdautilities.commons.waiter
com.jagrosh.jdautilities.doc - package com.jagrosh.jdautilities.doc: Items in this package pertain to the DocGenerator.
com.jagrosh.jdautilities.doc.standard - package com.jagrosh.jdautilities.doc.standard
com.jagrosh.jdautilities.examples.command - package com.jagrosh.jdautilities.examples.command
com.jagrosh.jdautilities.examples.doc - package com.jagrosh.jdautilities.examples.doc
com.jagrosh.jdautilities.menu - package com.jagrosh.jdautilities.menu: Menus package.
Contains the Menu class and all standard implementations of it: ButtonMenu
A menu where users select a choice via "reaction-buttons". OrderedMenu
A menu with 1 - 10 ordered items, each with their own reaction to choose them with. Paginator
A menu that paginates a number of items across a number of pages and uses reactions to traverse between them. SelectionDialog
A menu that orders choices and uses a indicator and reactions to choose one of the choices. Slideshow
A menu similar to the Paginator that displays a picture on each page. All menus also come with an implementation of a Menu.Builder as a static inner class of the corresponding Menu implementation, which are the main entryway to create said implementations for usage.
Command - Class in com.jagrosh.jdautilities.command: Commands In JDA-Utilities
Command() - Constructor for class com.jagrosh.jdautilities.command.Command
Command.Category - Class in com.jagrosh.jdautilities.command: To be used in Commands as a means of organizing commands into "Categories" as well as terminate command usage when the calling CommandEvent doesn't meet certain requirements.
Command.CooldownScope - Enum in com.jagrosh.jdautilities.command: A series of Enums used for defining the scope size for a Command's cooldown.
CommandBuilder - Class in com.jagrosh.jdautilities.command: A chain-setter based builder for Commands.
CommandBuilder() - Constructor for class com.jagrosh.jdautilities.command.CommandBuilder
CommandClient - Interface in com.jagrosh.jdautilities.command: A Bot Client interface implemented on objects used to hold bot data.
CommandClientBuilder - Class in com.jagrosh.jdautilities.command: A simple builder used to create a CommandClientImpl.
CommandClientBuilder() - Constructor for class com.jagrosh.jdautilities.command.CommandClientBuilder
CommandClientImpl - Class in com.jagrosh.jdautilities.command.impl: An implementation of CommandClient to be used by a bot.
CommandClientImpl(String, String[], String, String, Game, OnlineStatus, String, String, String, String, String, String, String, ArrayList<Command>, boolean, Consumer<CommandEvent>, String, ScheduledExecutorService, int, AnnotatedModuleCompiler, GuildSettingsManager) - Constructor for class com.jagrosh.jdautilities.command.impl.CommandClientImpl
CommandEvent - Class in com.jagrosh.jdautilities.command: A wrapper class for a MessageReceivedEvent, CommandClient, and String user arguments compatible with all Commands.
CommandEvent(MessageReceivedEvent, String, CommandClient) - Constructor for class com.jagrosh.jdautilities.command.CommandEvent: Constructor for a CommandEvent.
CommandInfo - Annotation Type in com.jagrosh.jdautilities.doc.standard: A CommandDoc Annotation that contains basic information on command usage, declaration, and requirements.
CommandInfo.Converter - Class in com.jagrosh.jdautilities.doc.standard: The DocConverter for the @CommandInfo annotation.
CommandListener - Interface in com.jagrosh.jdautilities.command: An implementable "Listener" that can be added to a CommandClient and used to handle events relating to Commands.
compile(Object) - Method in interface com.jagrosh.jdautilities.command.AnnotatedModuleCompiler: Compiles one or more Commands using method annotations as for properties from the specified Object.
compile(Object) - Method in class com.jagrosh.jdautilities.command.impl.AnnotatedModuleCompilerImpl
contains(K) - Method in class com.jagrosh.jdautilities.commons.utils.FixedSizeCache: Checks if this FixedSizeCache contains a key.
ConvertedBy - Annotation Type in com.jagrosh.jdautilities.doc: Specifies an Annotation can be converted using the specified DocConverter value.
Converter() - Constructor for class com.jagrosh.jdautilities.doc.standard.CommandInfo.Converter
Converter() - Constructor for class com.jagrosh.jdautilities.doc.standard.Error.Converter
Converter() - Constructor for class com.jagrosh.jdautilities.doc.standard.RequiredPermissions.Converter
Converter() - Constructor for class com.jagrosh.jdautilities.examples.doc.Author.Converter
cooldown - Variable in class com.jagrosh.jdautilities.command.Command: An int number of seconds users must wait before using this command again.
cooldownScope - Variable in class com.jagrosh.jdautilities.command.Command: The CooldownScope of the command.

D

DISCORD_ID - Static variable in class com.jagrosh.jdautilities.commons.utils.FinderUtil
display(MessageChannel) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu: Shows the ButtonMenu as a new Message in the provided MessageChannel.
display(Message) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu: Displays this ButtonMenu by editing the provided Message.
display(MessageChannel) - Method in class com.jagrosh.jdautilities.menu.Menu: Displays this Menu in a MessageChannel.
display(Message) - Method in class com.jagrosh.jdautilities.menu.Menu: Displays this Menu as a designated Message.
display(MessageChannel) - Method in class com.jagrosh.jdautilities.menu.OrderedMenu: Shows the OrderedMenu as a new Message in the provided MessageChannel.
display(Message) - Method in class com.jagrosh.jdautilities.menu.OrderedMenu: Displays this OrderedMenu by editing the provided Message.
display(MessageChannel) - Method in class com.jagrosh.jdautilities.menu.Paginator: Begins pagination on page 1 as a new Message in the provided MessageChannel.
display(Message) - Method in class com.jagrosh.jdautilities.menu.Paginator: Begins pagination on page 1 displaying this Pagination by editing the provided Message.
display(MessageChannel) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog: Shows the SelectionDialog as a new Message in the provided MessageChannel, starting with the first selection.
display(Message) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog: Displays this SelectionDialog by editing the provided Message, starting with the first selection.
display(MessageChannel) - Method in class com.jagrosh.jdautilities.menu.Slideshow: Begins pagination on page 1 as a new Message in the provided MessageChannel.
display(Message) - Method in class com.jagrosh.jdautilities.menu.Slideshow: Begins pagination on page 1 displaying this by editing the provided Message.
DocConverter<T extends java.lang.annotation.Annotation> - Interface in com.jagrosh.jdautilities.doc: Converts an annotation of the specified type T into a String to be collected with other conversions into a single String documenting a class or method representing a command for a bot.
DocGenerator - Class in com.jagrosh.jdautilities.doc: An instance based documentation engine for bot commands written in JDA.
DocGenerator() - Constructor for class com.jagrosh.jdautilities.doc.DocGenerator: Gets a blank DocGenerator with no conversions loaded.
DocGenerator(int) - Constructor for class com.jagrosh.jdautilities.doc.DocGenerator: Gets a blank DocGenerator with no conversions loaded, and a cache with the specified max-size.
DocGenerator(String, int) - Constructor for class com.jagrosh.jdautilities.doc.DocGenerator: Gets a blank DocGenerator with no conversions loaded and with the specified separator, and a cache with the specified max-size.
DocMultiple - Annotation Type in com.jagrosh.jdautilities.doc: A helper Annotation, useful for formatting multiple occurrences of the same CommandDoc annotation.
DOWN - Static variable in class com.jagrosh.jdautilities.menu.SelectionDialog

E

EMOTE_MENTION - Static variable in class com.jagrosh.jdautilities.commons.utils.FinderUtil
equals(Object) - Method in class com.jagrosh.jdautilities.command.Command.Category
Error - Annotation Type in com.jagrosh.jdautilities.doc.standard: A CommandDoc Annotation that describes a possible error or termination clause a Command might have during it's runtime.
Error.Converter - Class in com.jagrosh.jdautilities.doc.standard: The DocConverter for the @Error annotation.
Errors - Annotation Type in com.jagrosh.jdautilities.doc.standard: The @Repeatable value for @Error.
EventWaiter - Class in com.jagrosh.jdautilities.commons.waiter: The EventWaiter is capable of handling specialized forms of Event that must meet criteria not normally specifiable without implementation of an EventListener.
EventWaiter() - Constructor for class com.jagrosh.jdautilities.commons.waiter.EventWaiter: Constructs an empty EventWaiter.
EventWaiter(ScheduledExecutorService, boolean) - Constructor for class com.jagrosh.jdautilities.commons.waiter.EventWaiter: Constructs an EventWaiter using the provided Executor as it's threadpool.
execute(CommandEvent) - Method in class com.jagrosh.jdautilities.command.Command: The main body method of a Command.
execute(CommandEvent) - Method in class com.jagrosh.jdautilities.examples.command.AboutCommand
execute(CommandEvent) - Method in class com.jagrosh.jdautilities.examples.command.GuildlistCommand
execute(CommandEvent) - Method in class com.jagrosh.jdautilities.examples.command.PingCommand
execute(CommandEvent) - Method in class com.jagrosh.jdautilities.examples.command.ShutdownCommand

F

findBannedUsers(String, Guild) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil: Queries a provided Guild for a banned User.
findCategories(String, JDA) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil: Queries a provided instance of JDA for Categories.
findCategories(String, Guild) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil: Queries a provided Guild for Categories.
findEmotes(String, JDA) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil: Queries a provided instance of JDA for Emotes.
findEmotes(String, Guild) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil: Queries a provided Guild for Emotes.
FinderUtil - Class in com.jagrosh.jdautilities.commons.utils: A series of query based utilities for finding entities, either globally across all accessible Guilds, or locally to a specified Guild.
findMembers(String, Guild) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil: Queries a provided Guild for Members.
findRoles(String, Guild) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil: Queries a provided Guild for Roles.
findShardCategories(String, JDA) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil: Queries a provided instance of JDA for Categories.
findShardEmotes(String, JDA) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil: Queries a provided instance of JDA for Emotes.
findShardTextChannels(String, JDA) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil: Queries a provided instance of JDA for TextChannels.
findShardUsers(String, JDA) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil: Queries a provided instance of JDA for Users.
findShardVoiceChannels(String, JDA) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil: Queries a provided instance of JDA for VoiceChannels.
findTextChannels(String, JDA) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil: Queries a provided instance of JDA for TextChannels.
findTextChannels(String, Guild) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil: Queries a provided Guild for TextChannels.
findUsers(String, JDA) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil: Queries a provided instance of JDA for Users.
findVoiceChannels(String, JDA) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil: Queries a provided instance of JDA for VoiceChannels.
findVoiceChannels(String, Guild) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil: Queries a provided Guild for VoiceChannels.
FixedSizeCache<K,V> - Class in com.jagrosh.jdautilities.commons.utils: A simple first-in-first-out key-value storage that uses a HashMap to store keys and values while simultaneously registering the keys to an array to maintain a specified maximum capacity.
FixedSizeCache(int) - Constructor for class com.jagrosh.jdautilities.commons.utils.FixedSizeCache: Constructs a new FixedSizeCache with a set maximum capacity.
FULL_USER_REF - Static variable in class com.jagrosh.jdautilities.commons.utils.FinderUtil

G

get(K) - Method in class com.jagrosh.jdautilities.commons.utils.FixedSizeCache: Retrieves a value from this FixedSizeCache corresponding to the specified key, or null if there is no corresponding value to be retrieved.
getAliases() - Method in class com.jagrosh.jdautilities.command.Command: Gets the Command.aliases for the Command.
getAltPrefix() - Method in interface com.jagrosh.jdautilities.command.CommandClient: Gets the Client's alternate prefix.
getAltPrefix() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
getArgs() - Method in class com.jagrosh.jdautilities.command.CommandEvent: Returns the user's String arguments for the command.
getArguments() - Method in class com.jagrosh.jdautilities.command.Command: Gets the Command.arguments for the Command.
getAuthor() - Method in class com.jagrosh.jdautilities.command.CommandEvent: Gets the User who triggered this CommandEvent.
getBotPermissions() - Method in class com.jagrosh.jdautilities.command.Command: Gets the Command.botPermissions for the Command.
getCategory() - Method in class com.jagrosh.jdautilities.command.Command: Gets the Command.category for the Command.
getChannel() - Method in class com.jagrosh.jdautilities.command.CommandEvent: Gets the MessageChannel that the CommandEvent was triggered on.
getChannelType() - Method in class com.jagrosh.jdautilities.command.CommandEvent: Gets the ChannelType of the MessageChannel that the CommandEvent was triggered on.
getChildren() - Method in class com.jagrosh.jdautilities.command.Command: Gets the Command.children for the Command.
getClient() - Method in class com.jagrosh.jdautilities.command.CommandEvent: Returns the CommandClient that initiated this CommandEvent.
getCommands() - Method in interface com.jagrosh.jdautilities.command.CommandClient: Returns the list of registered Commands during this session.
getCommands() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
getCommandUses(Command) - Method in interface com.jagrosh.jdautilities.command.CommandClient: Gets the number of uses for the provide Command during this session, or 0 if the command is not registered to this CommandClient.
getCommandUses(String) - Method in interface com.jagrosh.jdautilities.command.CommandClient: Gets the number of uses for a Command during this session matching the provided String name, or 0 if there is no Command with the name.
getCommandUses(Command) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
getCommandUses(String) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
getCooldown() - Method in class com.jagrosh.jdautilities.command.Command: Gets the Command.cooldown for the Command.
getCooldown(String) - Method in interface com.jagrosh.jdautilities.command.CommandClient: Gets the OffsetDateTime that the specified cooldown expires.
getCooldown(String) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
getCooldownError(CommandEvent, int) - Method in class com.jagrosh.jdautilities.command.Command: Gets an error message for this Command under the provided CommanEvent.
getCooldownKey(CommandEvent) - Method in class com.jagrosh.jdautilities.command.Command: Gets the proper cooldown key for this Command under the provided CommanEvent.
getCoOwnerIds() - Method in interface com.jagrosh.jdautilities.command.CommandClient: Gets the ID(s) of any CoOwners of this bot as a String Array.
getCoOwnerIds() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
getCoOwnerIdsLong() - Method in interface com.jagrosh.jdautilities.command.CommandClient: Gets the ID(s) of any CoOwners of this bot as a long Array.
getCoOwnerIdsLong() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
getDefaultGenerator() - Static method in class com.jagrosh.jdautilities.doc.DocGenerator: Gets a default DocGenerator with standard conversions loaded.
getDocFor(Class<?>) - Method in class com.jagrosh.jdautilities.doc.DocGenerator: Reads CommandDoc from the provided Class and returns the String formatted and from it.
getDocFor(Method) - Method in class com.jagrosh.jdautilities.doc.DocGenerator: Reads CommandDoc from the provided Method and returns the String formatted and from it.
getDocForMethods(Class<?>) - Method in class com.jagrosh.jdautilities.doc.DocGenerator: Reads all Methods from the provided Class and returns a List of CommandDoc of each.
getError() - Method in interface com.jagrosh.jdautilities.command.CommandClient: Gets the error emoji.
getError() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
getEvent() - Method in class com.jagrosh.jdautilities.command.CommandEvent: Returns the underlying MessageReceivedEvent for this CommandEvent.
getFailureResponse() - Method in class com.jagrosh.jdautilities.command.Command.Category: Gets the failure response of the Category.
getGroup() - Method in class com.jagrosh.jdautilities.command.CommandEvent: Gets the Group that this CommandEvent was triggered in.
getGuild() - Method in class com.jagrosh.jdautilities.command.CommandEvent: Gets the Guild that this CommandEvent was triggered on.
getHelp() - Method in class com.jagrosh.jdautilities.command.Command: Gets the Command.help for the Command.
getHelpWord() - Method in interface com.jagrosh.jdautilities.command.CommandClient: Gets the word used to invoke a help DM.
getHelpWord() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
getJDA() - Method in class com.jagrosh.jdautilities.command.CommandEvent: Gets the instance of JDA that this CommandEvent was caught by.
getListener() - Method in interface com.jagrosh.jdautilities.command.CommandClient: Returns the current CommandListener.
getListener() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
getMember() - Method in class com.jagrosh.jdautilities.command.CommandEvent: Gets the Member that triggered this CommandEvent.
getMessage() - Method in class com.jagrosh.jdautilities.command.CommandEvent: Gets the Message responsible for triggering this CommandEvent.
getName() - Method in class com.jagrosh.jdautilities.command.Command.Category: Gets the name of the Category.
getName() - Method in class com.jagrosh.jdautilities.command.Command: Gets the Command.name for the Command.
getOwnerId() - Method in interface com.jagrosh.jdautilities.command.CommandClient: Gets the ID of the owner of this bot as a String.
getOwnerId() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
getOwnerIdLong() - Method in interface com.jagrosh.jdautilities.command.CommandClient: Gets the ID of the owner of this bot as a long.
getOwnerIdLong() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
getPrefix() - Method in interface com.jagrosh.jdautilities.command.CommandClient: Gets the Client's prefix.
getPrefix() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
getPrefixes() - Method in interface com.jagrosh.jdautilities.command.GuildSettingsProvider: Gets a Collection of String prefixes available for the Guild represented by this implementation.
getPrivateChannel() - Method in class com.jagrosh.jdautilities.command.CommandEvent: Gets the PrivateChannel that this CommandEvent may have taken place on, or null if it didn't happen on a PrivateChannel.
getRemainingCooldown(String) - Method in interface com.jagrosh.jdautilities.command.CommandClient: Gets the remaining number of seconds on the specified cooldown.
getRemainingCooldown(String) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
getRequiredRole() - Method in class com.jagrosh.jdautilities.command.Command: Gets the Command.requiredRole for the Command.
getResponseNumber() - Method in class com.jagrosh.jdautilities.command.CommandEvent: Gets the response number for the MessageReceivedEvent.
getScheduleExecutor() - Method in interface com.jagrosh.jdautilities.command.CommandClient: Gets the ScheduledExecutorService held by this client.
getScheduleExecutor() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
getSelfMember() - Method in class com.jagrosh.jdautilities.command.CommandEvent: Gets a Member representing the bot, or null if the event does not take place on a Guild.
getSelfUser() - Method in class com.jagrosh.jdautilities.command.CommandEvent: Gets a SelfUser representing the bot.
getServerInvite() - Method in interface com.jagrosh.jdautilities.command.CommandClient: Gets the invite to the bot's support server.
getServerInvite() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
getSettings(Guild) - Method in interface com.jagrosh.jdautilities.command.GuildSettingsManager: Gets settings for a specified Guild as an object of the specified type T, or null if the guild has no settings.
getSettingsFor(Guild) - Method in interface com.jagrosh.jdautilities.command.CommandClient: Returns an Object of the type parameter that should contain settings relating to the specified Guild.
getSettingsFor(Guild) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
getSettingsManager() - Method in interface com.jagrosh.jdautilities.command.CommandClient: Returns the type of GuildSettingsManager, the same type of one provided when building this CommandClient, or null if one was not provided there.
getSettingsManager() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
getStartTime() - Method in interface com.jagrosh.jdautilities.command.CommandClient: Gets the time this CommandClient implementation was created.
getStartTime() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
getSuccess() - Method in interface com.jagrosh.jdautilities.command.CommandClient: Gets the success emoji.
getSuccess() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
getTextChannel() - Method in class com.jagrosh.jdautilities.command.CommandEvent: Gets the TextChannel that this CommandEvent may have taken place on, or null if it didn't happen on a TextChannel.
getTextualPrefix() - Method in interface com.jagrosh.jdautilities.command.CommandClient: Returns the visual representation of the bot's prefix.
getTextualPrefix() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
getTotalGuilds() - Method in interface com.jagrosh.jdautilities.command.CommandClient: Gets an a recently updated count of all the Guilds the bot is connected to on all shards.
getTotalGuilds() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
getUserPermissions() - Method in class com.jagrosh.jdautilities.command.Command: Gets the Command.userPermissions for the Command.
getWarning() - Method in interface com.jagrosh.jdautilities.command.CommandClient: Gets the warning emoji.
getWarning() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
GITHUB - Static variable in class com.jagrosh.jdautilities.commons.JDAUtilitiesInfo
GuildlistCommand - Class in com.jagrosh.jdautilities.examples.command
GuildlistCommand(EventWaiter) - Constructor for class com.jagrosh.jdautilities.examples.command.GuildlistCommand
guildOnly - Variable in class com.jagrosh.jdautilities.command.Command: true if the command may only be used in a Guild, false if it may be used in both a Guild and a DM.
GuildSettingsManager<T> - Interface in com.jagrosh.jdautilities.command: An implementable frame for classes that handle Guild-Specific settings.
GuildSettingsProvider - Interface in com.jagrosh.jdautilities.command: A basic frame that is optionally implementable by objects returned from GuildSettingsManager#getSettings(Guild).

H

hashCode() - Method in class com.jagrosh.jdautilities.command.Command.Category
help - Variable in class com.jagrosh.jdautilities.command.Command: A small help String that summarizes the function of the command, used in the default help builder.
helpBiConsumer - Variable in class com.jagrosh.jdautilities.command.Command: The BiConsumer for creating a help response to the format [prefix]<command name> help.
hidden - Variable in class com.jagrosh.jdautilities.command.Command: true if this command should be hidden from the help.

I

init() - Method in interface com.jagrosh.jdautilities.command.GuildSettingsManager: Called when JDA has fired a ReadyEvent.
isAllowed(TextChannel) - Method in class com.jagrosh.jdautilities.command.Command: Checks whether a command is allowed in a TextChannel by searching the channel topic for topic tags relating to the command.
isCommandFor(String) - Method in class com.jagrosh.jdautilities.command.Command: Checks if the given input represents this Command
isFromType(ChannelType) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Compares a provided ChannelType with the one this CommandEvent occurred on, returning true if they are the same ChannelType.
isGuildOnly() - Method in class com.jagrosh.jdautilities.command.Command: Checks if this Command can only be used in a Guild.
isHidden() - Method in class com.jagrosh.jdautilities.command.Command: Checks whether or not this command should be hidden from the help
isOwner() - Method in class com.jagrosh.jdautilities.command.CommandEvent: Tests whether or not the User who triggered this event is an owner of the bot.
isOwnerCommand() - Method in class com.jagrosh.jdautilities.command.Command: Checks whether or not this command is an owner only Command.
isShutdown() - Method in class com.jagrosh.jdautilities.commons.waiter.EventWaiter: Gets whether the EventWaiter's internal ScheduledExecutorService is shutdown.
isValidUser(User) - Method in class com.jagrosh.jdautilities.menu.Menu: Checks to see if the provided User is valid to interact with this Menu.
isValidUser(User, Guild) - Method in class com.jagrosh.jdautilities.menu.Menu: Checks to see if the provided User is valid to interact with this Menu.

J

JDACommand - Annotation Type in com.jagrosh.jdautilities.command.annotation: An Annotation applicable to Methods that will act as Commands when added to a Client using CommandClientBuilder#addAnnotatedModule() serving as metadata "constructors" for what would be a class extending Command of the same functionality and settings.
JDACommand.Category - Annotation Type in com.jagrosh.jdautilities.command.annotation: A helper annotation to assist in location of Category instance.
JDACommand.Cooldown - Annotation Type in com.jagrosh.jdautilities.command.annotation: A value wrapper for what would be Command#cooldown and Command#cooldownScope.
JDACommand.Module - Annotation Type in com.jagrosh.jdautilities.command.annotation: A helper annotation to assist in location of methods that will generate into Commands.
JDAUtilitiesInfo - Class in com.jagrosh.jdautilities.commons: Information regarding the library.
JDAUtilitiesInfo() - Constructor for class com.jagrosh.jdautilities.commons.JDAUtilitiesInfo

L

LEFT - Static variable in class com.jagrosh.jdautilities.menu.Paginator
LEFT - Static variable in class com.jagrosh.jdautilities.menu.Slideshow
LETTERS - Static variable in class com.jagrosh.jdautilities.menu.OrderedMenu
linkId(Message) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Links a Message with the calling Message contained by this CommandEvent.
linkIds(long, Message) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl: DO NOT USE THIS!

M

MAX_MESSAGES - Static variable in class com.jagrosh.jdautilities.command.CommandEvent
Menu - Class in com.jagrosh.jdautilities.menu: A frame for wrapping an EventWaiter into a "action, reaction" menu that waits on forms of user input such as reactions, or key-phrases.
Menu(EventWaiter, Set<User>, Set<Role>, long, TimeUnit) - Constructor for class com.jagrosh.jdautilities.menu.Menu
Menu.Builder<T extends Menu.Builder<T,V>,V extends Menu> - Class in com.jagrosh.jdautilities.menu: An extendable frame for a chain-method builder that constructs a specified type of Menu.

N

name - Variable in class com.jagrosh.jdautilities.command.Command: The name of the command, allows the command to be called the format: [prefix]<command name>.
NUMBERS - Static variable in class com.jagrosh.jdautilities.menu.OrderedMenu

O

onCommand(CommandEvent, Command) - Method in interface com.jagrosh.jdautilities.command.CommandListener: Called when a Command is triggered by a CommandEvent.
onCommandException(CommandEvent, Command, Throwable) - Method in interface com.jagrosh.jdautilities.command.CommandListener: Called when a Command catches a Throwable during execution.
onCompletedCommand(CommandEvent, Command) - Method in interface com.jagrosh.jdautilities.command.CommandListener: Called when a Command is triggered by a CommandEvent after it's completed successfully.
onEvent(Event) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
onEvent(Event) - Method in class com.jagrosh.jdautilities.commons.waiter.EventWaiter
onNonCommandMessage(MessageReceivedEvent) - Method in interface com.jagrosh.jdautilities.command.CommandListener: Called when a MessageReceivedEvent is caught by the Client Listener's but doesn't correspond to a Command.
onTerminatedCommand(CommandEvent, Command) - Method in interface com.jagrosh.jdautilities.command.CommandListener: Called when a Command is triggered by a CommandEvent but is terminated before completion.
OrderedMenu - Class in com.jagrosh.jdautilities.menu: A Menu of ordered buttons signified by numbers or letters, each with a reaction linked to it for users to click.
OrderedMenu.Builder - Class in com.jagrosh.jdautilities.menu: The Menu.Builder for an OrderedMenu.
ownerCommand - Variable in class com.jagrosh.jdautilities.command.Command: true if the command may only be used by a User with an ID matching the Owners or any of the CoOwners.

P

paginate(MessageChannel, int) - Method in class com.jagrosh.jdautilities.menu.Paginator: Begins pagination as a new Message in the provided MessageChannel, starting on whatever page number is provided.
paginate(Message, int) - Method in class com.jagrosh.jdautilities.menu.Paginator: Begins pagination displaying this Pagination by editing the provided Message, starting on whatever page number is provided.
paginate(MessageChannel, int) - Method in class com.jagrosh.jdautilities.menu.Slideshow: Begins pagination as a new Message in the provided MessageChannel, starting on whatever page number is provided.
paginate(Message, int) - Method in class com.jagrosh.jdautilities.menu.Slideshow: Begins pagination displaying this by editing the provided Message, starting on whatever page number is provided.
Paginator - Class in com.jagrosh.jdautilities.menu: A Menu implementation that paginates a set of one or more text items across one or more pages.
Paginator.Builder - Class in com.jagrosh.jdautilities.menu: The Menu.Builder for a Paginator.
PingCommand - Class in com.jagrosh.jdautilities.examples.command
PingCommand() - Constructor for class com.jagrosh.jdautilities.examples.command.PingCommand

R

reactError() - Method in class com.jagrosh.jdautilities.command.CommandEvent: Adds an error reaction to the calling Message.
reactSuccess() - Method in class com.jagrosh.jdautilities.command.CommandEvent: Adds a success reaction to the calling Message.
reactWarning() - Method in class com.jagrosh.jdautilities.command.CommandEvent: Adds a warning reaction to the calling Message.
read(T) - Method in interface com.jagrosh.jdautilities.doc.DocConverter: Returns a String processed from the contents of the provided Annotation.
read(CommandInfo) - Method in class com.jagrosh.jdautilities.doc.standard.CommandInfo.Converter
read(Error) - Method in class com.jagrosh.jdautilities.doc.standard.Error.Converter
read(RequiredPermissions) - Method in class com.jagrosh.jdautilities.doc.standard.RequiredPermissions.Converter
read(Author) - Method in class com.jagrosh.jdautilities.examples.doc.Author.Converter
register(Class<T>, Object...) - Method in class com.jagrosh.jdautilities.doc.DocGenerator: Registers a CommandDoc Annotation to this DocGenerator.
register(Class<T>, DocConverter<T>) - Method in class com.jagrosh.jdautilities.doc.DocGenerator: Registers a CommandDoc Annotation to this DocGenerator with the provided DocConverter.
removeCommand(String) - Method in interface com.jagrosh.jdautilities.command.CommandClient: Removes a single Command from this CommandClient's registered Commands at the index linked to the provided name/alias.
removeCommand(String) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
reply(String) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a String message.
reply(String, Consumer<Message>) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a String message and then queues a Consumer.
reply(String, Consumer<Message>, Consumer<Throwable>) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a String message and then queues a Consumer.
reply(MessageEmbed) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a MessageEmbed.
reply(MessageEmbed, Consumer<Message>) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a MessageEmbed and then queues a Consumer.
reply(MessageEmbed, Consumer<Message>, Consumer<Throwable>) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a MessageEmbed and then queues a Consumer.
reply(Message) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a Message.
reply(Message, Consumer<Message>) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a Message and then queues a Consumer.
reply(Message, Consumer<Message>, Consumer<Throwable>) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a Message and then queues a Consumer.
reply(File, String) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a File with the provided name, or a default name if left null.
reply(String, File, String) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a String message and a File with the provided name, or a default name if left null.
replyError(String) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a String message and a prefixed error emoji.
replyError(String, Consumer<Message>) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a String message and a prefixed error emoji and then queues a Consumer.
replyFormatted(String, Object...) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a formatted String message using the provided arguments.
replyInDm(String) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a String message sent to the calling User's PrivateChannel.
replyInDm(String, Consumer<Message>) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a String message sent to the calling User's PrivateChannel.
replyInDm(String, Consumer<Message>, Consumer<Throwable>) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a String message sent to the calling User's PrivateChannel.
replyInDm(MessageEmbed) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a MessageEmbed sent to the calling User's PrivateChannel.
replyInDm(MessageEmbed, Consumer<Message>) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a MessageEmbed sent to the calling User's PrivateChannel.
replyInDm(MessageEmbed, Consumer<Message>, Consumer<Throwable>) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a MessageEmbed sent to the calling User's PrivateChannel.
replyInDm(Message) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a Message sent to the calling User's PrivateChannel.
replyInDm(Message, Consumer<Message>) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a Message sent to the calling User's PrivateChannel.
replyInDm(Message, Consumer<Message>, Consumer<Throwable>) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a Message sent to the calling User's PrivateChannel.
replyInDm(String, File, String) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a String message and a File with the provided name, or a default name if left null, and sent to the calling User's PrivateChannel.
replyOrAlternate(MessageEmbed, String) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a MessageEmbed if possible, or just a String message if it cannot send the embed.
replyOrAlternate(String, File, String, String) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a String message and a File with the provided name, or a default name if left null.
replySuccess(String) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a String message, and a prefixed success emoji.
replySuccess(String, Consumer<Message>) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a String message and a prefixed success emoji and then queues a Consumer.
replyWarning(String) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a String message, and a prefixed warning emoji.
replyWarning(String, Consumer<Message>) - Method in class com.jagrosh.jdautilities.command.CommandEvent: Replies with a String message and a prefixed warning emoji and then queues a Consumer.
RequiredPermissions - Annotation Type in com.jagrosh.jdautilities.doc.standard: A CommandDoc Annotation that lists required Permissions a bot must have to use a command on a Guild.
RequiredPermissions.Converter - Class in com.jagrosh.jdautilities.doc.standard: The DocConverter for the @RequiredPermissions annotation.
requiredRole - Variable in class com.jagrosh.jdautilities.command.Command: A String name of a role required to use this command.
RIGHT - Static variable in class com.jagrosh.jdautilities.menu.Paginator
RIGHT - Static variable in class com.jagrosh.jdautilities.menu.Slideshow
ROLE_MENTION - Static variable in class com.jagrosh.jdautilities.commons.utils.FinderUtil
roles - Variable in class com.jagrosh.jdautilities.menu.Menu.Builder
roles - Variable in class com.jagrosh.jdautilities.menu.Menu
run(CommandEvent) - Method in class com.jagrosh.jdautilities.command.Command: Runs checks for the Command with the given CommandEvent that called it.

S

safeConvert(String) - Static method in class com.jagrosh.jdautilities.commons.utils.SafeIdUtil: Safely convert the provided String ID to a long usable with MiscUtil.parseSnowflake(String).
SafeIdUtil - Class in com.jagrosh.jdautilities.commons.utils: A Utilities class for safely checking and converting String IDs to longs usable with MiscUtil.parseSnowflake(String), a utility used in several Object#getXById(String) methods.
SELECT - Static variable in class com.jagrosh.jdautilities.menu.SelectionDialog
SelectionDialog - Class in com.jagrosh.jdautilities.menu: A Menu implementation that creates a listed display of text choices horizontally that users can scroll through using reactions and make selections.
SelectionDialog.Builder - Class in com.jagrosh.jdautilities.menu: The Menu.Builder for a SelectuibDialog.
setAction(Consumer<MessageReaction.ReactionEmote>) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu.Builder: Sets the Consumer action to perform upon selecting a button.
setAliases(String...) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Sets the aliases of the Command built from this CommandBuilder.
setAliases(Collection<String>) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Sets the aliases of the Command built from this CommandBuilder.
setAlternativePrefix(String) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Sets the bot's alternative prefix.
setAnnotatedCompiler(AnnotatedModuleCompiler) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Sets the AnnotatedModuleCompiler for this CommandClientBuilder.
setArguments(String) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Sets the arguments of the Command built from this CommandBuilder.
setBotPermissions(Permission...) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Sets the required bot permissions of the Command built from this CommandBuilder.
setBotPermissions(Collection<Permission>) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Sets the required bot permissions of the Command built from this CommandBuilder.
setBulkSkipNumber(int) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder: Sets the Paginator's bulk-skip function to skip multiple pages using alternate forward and backwards
setBulkSkipNumber(int) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder: Sets the Slideshow's bulk-skip function to skip multiple pages using alternate forward and backwards
setCancel(Consumer<Message>) - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder: Sets the Consumer to perform if the OrderedMenu is cancelled.
setCanceled(Consumer<Message>) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder: Sets a Consumer action to take if the menu is cancelled, either via the cancel button being used, or if the SelectionDialog times out.
setCarbonitexKey(String) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Sets the Carbonitex key for this bot's listing.
setCategory(Command.Category) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Sets the category of the Command built from this CommandBuilder.
setChildren(Command...) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Sets the children of the Command built from this CommandBuilder.
setChildren(Collection<Command>) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Sets the children of the Command built from this CommandBuilder.
setChoices(String...) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu.Builder: Sets the String unicode emojis as button choices.
setChoices(Emote...) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu.Builder: Sets the Emotes as button choices.
setChoices(String...) - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder: Sets the String choices.
setChoices(String...) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder: Sets the String choices to be shown as selections.
setColor(Color) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu.Builder: Sets the Color of the MessageEmbed.
setColor(Color) - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder: Sets the Color of the MessageEmbed.
setColor(Color) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder: Sets the Color of the MessageEmbed.
setColor(BiFunction<Integer, Integer, Color>) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder: Sets the Color of the MessageEmbed, relative to the total page number and the current page as determined by the provided BiFunction.
setColor(Color) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder: Sets the Color of the MessageEmbed.
setColor(Function<Integer, Color>) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder: Sets the Color of the MessageEmbed, relative to the current selection number as determined by the provided Function.
setColor(Color) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder: Sets the Color of the MessageEmbed.
setColor(BiFunction<Integer, Integer, Color>) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder: Sets the Color of the MessageEmbed, relative to the total page number and the current page as determined by the provided BiFunction.
setColumns(int) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder: Sets the number of columns each page will have.
setCooldown(int) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Sets the cooldown of the Command built from this CommandBuilder.
setCooldownScope(Command.CooldownScope) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Sets the cooldown scope of the Command built from this CommandBuilder.
setCoOwnerIds(String...) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Sets the one or more CoOwners of the bot.
setDefaultEnds(String, String) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder: Sets the text to use on either side of all unselected items.
setDescription(String) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu.Builder: Sets the description to be placed in an MessageEmbed.
setDescription(String) - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder: Sets the description to be placed in an MessageEmbed.
setDescription(String) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder: Sets the description of the MessageEmbed in the Message to be displayed when the Slideshow is built.
setDescription(BiFunction<Integer, Integer, String>) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder: Sets the description of the MessageEmbed in the Message to be displayed relative to the total page number and the current page as determined by the provided BiFunction.
setDiscordBotListKey(String) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Sets the Discord Bot List API key for this bot's listing.
setDiscordBotsKey(String) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Sets the Discord Bots API key for this bot's listing.
setEmojis(String, String, String) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Sets the emojis for success, warning, and failure.
setEventWaiter(EventWaiter) - Method in class com.jagrosh.jdautilities.menu.Menu.Builder: Sets the EventWaiter that will do Menu operations.
setFinalAction(Consumer<Message>) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu.Builder: Sets the Consumer to perform if the ButtonMenu is done, either via cancellation, a timeout, or a selection being made.
setFinalAction(Consumer<Message>) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder: Sets the Consumer to perform if the Paginator times out.
setFinalAction(Consumer<Message>) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder: Sets the Consumer to perform if the Slideshow times out.
setGame(Game) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Sets the Game to use when the bot is ready.
setGuildOnly(boolean) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Sets the Command built to be guild only.
setGuildSettingsManager(GuildSettingsManager) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Sets the GuildSettingsManager for the CommandClientImpl built using this builder.
setHelp(String) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Sets the help snippet of the Command built from this CommandBuilder.
setHelpBiConsumer(BiConsumer<CommandEvent, Command>) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Sets the help BiConsumer of the Command built from this CommandBuilder.
setHelpConsumer(Consumer<CommandEvent>) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Sets the consumer to run as the bot's help command.
setHelpWord(String) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Sets the word used to trigger the command list.
setHidden(boolean) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Sets the Command built to be hidden from the help builder.
setIsAuthor(boolean) - Method in class com.jagrosh.jdautilities.examples.command.AboutCommand
setItems(String...) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder: Sets the String list of items to paginate.
setItemsPerPage(int) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder: Sets the number of items that will appear on each page.
setLeftRightText(String, String) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder: Sets the Paginator to traverse left or right when a provided text input is sent in the form of a Message to the Channel the menu is displayed in.
setLeftRightText(String, String) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder: Sets the Slideshow to traverse left or right when a provided text input is sent in the form of a Message to the Channel the menu is displayed in.
setLinkedCacheSize(int) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Sets the internal size of the client's FixedSizeCache used for caching and pairing the bot's response Messages with the calling Message's ID.
setListener(CommandListener) - Method in interface com.jagrosh.jdautilities.command.CommandClient: Sets the CommandListener to catch command-related events thrown by this CommandClient.
setListener(CommandListener) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Sets the CommandListener for the CommandClientImpl.
setListener(CommandListener) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
setName(String) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Sets the name of the Command built from this CommandBuilder.
setOwnerCommand(boolean) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Sets the Command built to be owner only.
setOwnerId(String) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Sets the owner for the bot.
setPrefix(String) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Sets the bot's prefix.
setReplacementCharacter(String) - Method in class com.jagrosh.jdautilities.examples.command.AboutCommand
setRequiredRole(String) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Sets the name of a required role to use the Command built from this CommandBuilder.
setRoles(Role...) - Method in class com.jagrosh.jdautilities.menu.Menu.Builder: Sets Roles that are allowed to use the Menu that will be built.
setScheduleExecutor(ScheduledExecutorService) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Sets the ScheduledExecutorService for the CommandClientImpl.
setSelectedEnds(String, String) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder: Sets the text to use on either end of the selected item.
setSelection(BiConsumer<Message, Integer>) - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder: Sets the BiConsumer action to perform upon selecting a option.
setSelectionConsumer(BiConsumer<Message, Integer>) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder: Sets a BiConsumer action to perform once a selection is made.
setServerInvite(String) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Sets the bot's support server invite.
setStatus(OnlineStatus) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Sets the OnlineStatus the bot will use once Ready This defaults to ONLINE
setText(String) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu.Builder: Sets the text of the Message to be displayed when the ButtonMenu is built.
setText(String) - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder: Sets the text of the Message to be displayed when the OrderedMenu is built.
setText(String) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder: Sets the text of the Message to be displayed when the Paginator is built.
setText(BiFunction<Integer, Integer, String>) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder: Sets the text of the Message to be displayed relative to the total page number and the current page as determined by the provided BiFunction.
setText(String) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder: Sets the text of the Message to be displayed when the SelectionDialog is built.
setText(Function<Integer, String>) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder: Sets the text of the Message to be displayed relative to the current selection number as determined by the provided Function.
setText(String) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder: Sets the text of the Message to be displayed when the Slideshow is built.
setText(BiFunction<Integer, Integer, String>) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder: Sets the text of the Message to be displayed relative to the total page number and the current page as determined by the provided BiFunction.
setTimeout(long, TimeUnit) - Method in class com.jagrosh.jdautilities.menu.Menu.Builder: Sets the timeout that the Menu should stay available.
setUrls(String...) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder: Sets the String list of urls to paginate.
setUserPermissions(Permission...) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Sets the required user permissions of the Command built from this CommandBuilder.
setUserPermissions(Collection<Permission>) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Sets the required user permissions of the Command built from this CommandBuilder.
setUsers(User...) - Method in class com.jagrosh.jdautilities.menu.Menu.Builder: Sets Users that are allowed to use the Menu that will be built.
setUsesTopicTags(boolean) - Method in class com.jagrosh.jdautilities.command.CommandBuilder: Sets the Command built to use TopicTags.
showDialog(MessageChannel, int) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog: Shows the SelectionDialog as a new Message in the provided MessageChannel, starting with the number selection provided.
showDialog(Message, int) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog: Displays this SelectionDialog by editing the provided Message, starting with the number selection provided.
showPageNumbers(boolean) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder: Sets whether or not the page number will be shown.
showPageNumbers(boolean) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder: Sets whether or not the page number will be shown.
shutdown() - Method in interface com.jagrosh.jdautilities.command.GuildSettingsManager: Called when JDA has fired a ShutdownEvent.
shutdown() - Method in class com.jagrosh.jdautilities.commons.waiter.EventWaiter: Closes this EventWaiter if it doesn't normally shutdown automatically.
ShutdownCommand - Class in com.jagrosh.jdautilities.examples.command
ShutdownCommand() - Constructor for class com.jagrosh.jdautilities.examples.command.ShutdownCommand
Slideshow - Class in com.jagrosh.jdautilities.menu: A Menu implementation, nearly identical to Paginator, that displays an individual image on each page instead of a list of text items.
Slideshow.Builder - Class in com.jagrosh.jdautilities.menu: The Menu.Builder for a Slideshow.
splitMessage(String) - Static method in class com.jagrosh.jdautilities.command.CommandEvent: Splits a String into one or more Strings who's length does not exceed 2000 characters.
STOP - Static variable in class com.jagrosh.jdautilities.menu.Paginator
STOP - Static variable in class com.jagrosh.jdautilities.menu.Slideshow

T

test(CommandEvent) - Method in class com.jagrosh.jdautilities.command.Command.Category: Runs a test of the provided Predicate.
timeout - Variable in class com.jagrosh.jdautilities.menu.Menu.Builder
timeout - Variable in class com.jagrosh.jdautilities.menu.Menu

U

unit - Variable in class com.jagrosh.jdautilities.menu.Menu.Builder
unit - Variable in class com.jagrosh.jdautilities.menu.Menu
UP - Static variable in class com.jagrosh.jdautilities.menu.SelectionDialog
useCancelButton(boolean) - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder: If true, adds a cancel button that performs the timeout action when selected.
useDefaultGame() - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Sets the Game the bot will use as the default: 'Playing Type [prefix]help'
useHelpBuilder(boolean) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder: Sets whether the CommandClient will use the builder to automatically create a help command or not.
useLetters() - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder: Sets the builder to build an OrderedMenu using letters for ordering and reactions (IE: A, B, C, etc.).
useLooping(boolean) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder: Sets if moving up when at the top selection jumps to the bottom, and visa-versa.
useNumberedItems(boolean) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder: Sets whether or not the items will be automatically numbered.
useNumbers() - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder: Sets the builder to build an OrderedMenu using numbers for ordering and reactions (IE: A, B, C, etc.).
USER_MENTION - Static variable in class com.jagrosh.jdautilities.commons.utils.FinderUtil
userPermissions - Variable in class com.jagrosh.jdautilities.command.Command: Any Permissions a Member must have to use this command.
users - Variable in class com.jagrosh.jdautilities.menu.Menu.Builder
users - Variable in class com.jagrosh.jdautilities.menu.Menu
usesLinkedDeletion() - Method in interface com.jagrosh.jdautilities.command.CommandClient: Gets whether this CommandClient uses linked deletion.
usesLinkedDeletion() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl
usesTopicTags - Variable in class com.jagrosh.jdautilities.command.Command: true if this command checks a channel topic for topic-tags.

V

valueOf(String) - Static method in enum com.jagrosh.jdautilities.command.Command.CooldownScope: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.jagrosh.jdautilities.command.Command.CooldownScope: Returns an array containing the constants of this enum type, in the order they are declared.
VERSION - Static variable in class com.jagrosh.jdautilities.commons.JDAUtilitiesInfo
VERSION_MAJOR - Static variable in class com.jagrosh.jdautilities.commons.JDAUtilitiesInfo
VERSION_MINOR - Static variable in class com.jagrosh.jdautilities.commons.JDAUtilitiesInfo

W

waiter - Variable in class com.jagrosh.jdautilities.menu.Menu.Builder
waiter - Variable in class com.jagrosh.jdautilities.menu.Menu
waitForEvent(Class<T>, Predicate<T>, Consumer<T>) - Method in class com.jagrosh.jdautilities.commons.waiter.EventWaiter: Waits an indefinite amount of time for an Event that returns true when tested with the provided Predicate.
waitForEvent(Class<T>, Predicate<T>, Consumer<T>, long, TimeUnit, Runnable) - Method in class com.jagrosh.jdautilities.commons.waiter.EventWaiter: Waits a predetermined amount of time for an Event that returns true when tested with the provided Predicate.
waitOnSinglePage(boolean) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder: Sets whether the Paginator will instantly timeout, and possibly run a provided Runnable, if only a single slide is available to display.
waitOnSinglePage(boolean) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder: Sets whether the Slideshow will instantly timeout, and possibly run a provided Runnable, if only a single slide is available to display.
wrapPageEnds(boolean) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder: Sets the Paginator to wrap from the last page to the first when traversing right and visa versa from the left.
wrapPageEnds(boolean) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder: Sets the Slideshow to wrap from the last page to the first when traversing right and visa versa from the left.

A B C D E F G H I J L M N O P R S T U V W