A B C D E F G H I J K L M N O P Q R S T V
All Classes All Packages

A

addItem(String, String, Function<Context, Mono<Void>>) - Method in class com.github.alex1304.ultimategdbot.api.utils.reply.ReplyMenuBuilder

ArgUtils - Class in com.github.alex1304.ultimategdbot.api.utils

Contains handy methods to deal with command arguments.

ArgUtils() - Constructor for class com.github.alex1304.ultimategdbot.api.utils.ArgUtils

B

Bot - Interface in com.github.alex1304.ultimategdbot.api

Represents the bot itself.

BOT_ADMIN - Static variable in interface com.github.alex1304.ultimategdbot.api.PermissionLevel

BOT_OWNER - Static variable in interface com.github.alex1304.ultimategdbot.api.PermissionLevel

BotAdmins - Class in com.github.alex1304.ultimategdbot.api.database

BotAdmins() - Constructor for class com.github.alex1304.ultimategdbot.api.database.BotAdmins

BotUtils - Class in com.github.alex1304.ultimategdbot.api.utils

Contains various utility methods.

build(String) - Method in class com.github.alex1304.ultimategdbot.api.utils.reply.ReplyMenuBuilder

build(String, Consumer<EmbedCreateSpec>) - Method in class com.github.alex1304.ultimategdbot.api.utils.reply.PaginatedReplyMenuBuilder

build(String, Consumer<EmbedCreateSpec>) - Method in class com.github.alex1304.ultimategdbot.api.utils.reply.ReplyMenuBuilder

BYTE - com.github.alex1304.ultimategdbot.api.utils.SystemUnit

C

chunkMessage(String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.BotUtils

Splits a message into several chunks.

chunkMessage(String, int) - Static method in class com.github.alex1304.ultimategdbot.api.utils.BotUtils

Splits a message into several chunks which size is specified.

closeReplyMenu(String) - Method in interface com.github.alex1304.ultimategdbot.api.CommandKernel

Closes a reply menu using its identifier.

com.github.alex1304.ultimategdbot.api - package com.github.alex1304.ultimategdbot.api

com.github.alex1304.ultimategdbot.api.database - package com.github.alex1304.ultimategdbot.api.database

com.github.alex1304.ultimategdbot.api.utils - package com.github.alex1304.ultimategdbot.api.utils

com.github.alex1304.ultimategdbot.api.utils.reply - package com.github.alex1304.ultimategdbot.api.utils.reply

Command - Interface in com.github.alex1304.ultimategdbot.api

Represents a bot command.

CommandFailedException - Exception in com.github.alex1304.ultimategdbot.api

Thrown when something goes wrong during the execution of a command.

CommandFailedException() - Constructor for exception com.github.alex1304.ultimategdbot.api.CommandFailedException

CommandFailedException(String) - Constructor for exception com.github.alex1304.ultimategdbot.api.CommandFailedException

CommandFailedException(String, Throwable) - Constructor for exception com.github.alex1304.ultimategdbot.api.CommandFailedException

CommandFailedException(String, Throwable, boolean, boolean) - Constructor for exception com.github.alex1304.ultimategdbot.api.CommandFailedException

CommandFailedException(Throwable) - Constructor for exception com.github.alex1304.ultimategdbot.api.CommandFailedException

CommandKernel - Interface in com.github.alex1304.ultimategdbot.api

The kernel for all bot commands.

CommandPermissionDeniedException - Exception in com.github.alex1304.ultimategdbot.api

CommandPermissionDeniedException() - Constructor for exception com.github.alex1304.ultimategdbot.api.CommandPermissionDeniedException

concatArgs(Context, int) - Static method in class com.github.alex1304.ultimategdbot.api.utils.ArgUtils

Concatenates all arguments from the specified index to the end.

configure() - Method in interface com.github.alex1304.ultimategdbot.api.Database

Initializes the database.

Context - Interface in com.github.alex1304.ultimategdbot.api

Context of a bot command.

convert(long) - Method in enum com.github.alex1304.ultimategdbot.api.utils.SystemUnit

Converts the given value to the unit represented by the current object

convertStringToUser(Bot, String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.BotUtils

D

Database - Interface in com.github.alex1304.ultimategdbot.api

Manages interactions with the database.

delete(Object) - Method in interface com.github.alex1304.ultimategdbot.api.Database

Deletes an object from database

E

equals(Object) - Method in class com.github.alex1304.ultimategdbot.api.database.NativeGuildSettings

escapeMarkdown(String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.BotUtils

Escapes characters used in Markdown syntax using a backslash

execute(Context) - Method in interface com.github.alex1304.ultimategdbot.api.Command

Executes the command

F

findByID(Class<T>, K) - Method in interface com.github.alex1304.ultimategdbot.api.Database

Allows to find a database entity by its ID.

findByIDOrCreate(Class<T>, K, BiConsumer<? super T, K>) - Method in interface com.github.alex1304.ultimategdbot.api.Database

Allows to find a database entity by its ID.

fork(List<String>) - Method in interface com.github.alex1304.ultimategdbot.api.Context

Creates a new Context that is an exact copy of this one, but with different arguments.

forkedFrom(Command, Function<Context, Mono<Void>>) - Static method in interface com.github.alex1304.ultimategdbot.api.Command

Creates a new Command instance which action is the provided function, and other attributes (alias, error actions, allowed channels, permission level, etc) are inherited from the given base command.

format(long) - Static method in enum com.github.alex1304.ultimategdbot.api.utils.SystemUnit

Formats the given value to a human readable format, using the appropriate unit

formatDiscordUsername(User) - Static method in class com.github.alex1304.ultimategdbot.api.utils.BotUtils

Formats the username of the user specified as argument with the format username#discriminator

formatTimeMillis(Duration) - Static method in class com.github.alex1304.ultimategdbot.api.utils.BotUtils

forSpecificRole(Function<Context, Mono<Snowflake>>) - Static method in interface com.github.alex1304.ultimategdbot.api.PermissionLevel

fromChannelId(long, long) - Method in class com.github.alex1304.ultimategdbot.api.utils.GuildSettingsValueConverter

fromNumber(Number, long) - Method in class com.github.alex1304.ultimategdbot.api.utils.GuildSettingsValueConverter

fromRoleId(long, long) - Method in class com.github.alex1304.ultimategdbot.api.utils.GuildSettingsValueConverter

G

generateDefaultDocumentation(Command, Context, String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.BotUtils

Generates a default documentation for the command in a String format.

getAliases() - Method in interface com.github.alex1304.ultimategdbot.api.Command

Gets the aliases for this command.

getArgAsInt(Context, int) - Static method in class com.github.alex1304.ultimategdbot.api.utils.ArgUtils

Gets the value of the argument at the specified index as int.

getArgAsLong(Context, int) - Static method in class com.github.alex1304.ultimategdbot.api.utils.ArgUtils

Gets the value of the argument at the specified index as long.

getArgs() - Method in interface com.github.alex1304.ultimategdbot.api.Context

Gets the arguments of the command.

getAttachmentsChannel() - Method in interface com.github.alex1304.ultimategdbot.api.Bot

Gets the channel where the bot can send attachments for its embeds.

getAuthLink() - Method in interface com.github.alex1304.ultimategdbot.api.Bot

Gets the authorization link to add the bot to a server.

getBot() - Method in interface com.github.alex1304.ultimategdbot.api.Context

Gets the bot instance.

getChannelTypesAllowed() - Method in interface com.github.alex1304.ultimategdbot.api.Command

Gets the type of channels this command is allowed for use in.

getCommand() - Method in interface com.github.alex1304.ultimategdbot.api.Context

Gets the command that created this context.

getCommand() - Method in exception com.github.alex1304.ultimategdbot.api.InvalidSyntaxException

Gets the command involved in the syntax error

getCommandKernel() - Method in interface com.github.alex1304.ultimategdbot.api.Bot

Gets the command kernel of this bot.

getCommands() - Method in interface com.github.alex1304.ultimategdbot.api.CommandKernel

Gets an unmodifiable set of all commands available in the kernel.

getCommandsGroupedByPlugins() - Method in interface com.github.alex1304.ultimategdbot.api.CommandKernel

Gets an unmodifiable map of all commands available in the kernel, grouped by plugin names.

getDatabase() - Method in interface com.github.alex1304.ultimategdbot.api.Bot

Gets the database of the bot.

getDatabaseMappingResources() - Method in interface com.github.alex1304.ultimategdbot.api.Plugin

Gets a set of resource names that corresponds to database mapping files.

getDebugLogChannel() - Method in interface com.github.alex1304.ultimategdbot.api.Bot

Gets the channel where the bot sends messages for debugging purposes.

getDefaultPrefix() - Method in interface com.github.alex1304.ultimategdbot.api.Bot

Gets the default prefix.

getDescription() - Method in interface com.github.alex1304.ultimategdbot.api.Command

Gets the description of the command.

getDiscordClients() - Method in interface com.github.alex1304.ultimategdbot.api.Bot

Gets the discord client.

getEmoji(String) - Method in interface com.github.alex1304.ultimategdbot.api.Bot

Gets the String representation of an emoji installed on one of the emoji servers.

getEntityClass() - Method in class com.github.alex1304.ultimategdbot.api.database.GuildSettingsEntry

getErrorActions() - Method in interface com.github.alex1304.ultimategdbot.api.Command

Allows to define an action to execute according to the type of error emitted when executing this command.

getEvent() - Method in interface com.github.alex1304.ultimategdbot.api.Context

Gets the message create event associated to this command.

getGuildConfigurationEntries() - Method in interface com.github.alex1304.ultimategdbot.api.Plugin

Gets a map of configuration entries for guilds.

getGuildId() - Method in interface com.github.alex1304.ultimategdbot.api.database.GuildSettings

Gets the guildID

getGuildId() - Method in class com.github.alex1304.ultimategdbot.api.database.NativeGuildSettings

getGuildSettings() - Method in interface com.github.alex1304.ultimategdbot.api.Context

Gets the guild settings

getGuildSettingsEntries() - Method in interface com.github.alex1304.ultimategdbot.api.Bot

Gets the guild settings entries loaded from plugins.

getLongDescription() - Method in interface com.github.alex1304.ultimategdbot.api.Command

Gets the long description of the command.

getName() - Method in interface com.github.alex1304.ultimategdbot.api.Plugin

Gets the name of the plugin.

getPermissionLevel() - Method in interface com.github.alex1304.ultimategdbot.api.Command

Gets the permission level required to execute this command.

getPrefix() - Method in class com.github.alex1304.ultimategdbot.api.database.NativeGuildSettings

getPrefixUsed() - Method in interface com.github.alex1304.ultimategdbot.api.Context

Gets the prefix used in the command that created this context.

getProvidedCommands() - Method in interface com.github.alex1304.ultimategdbot.api.Plugin

Gets the set of commands that this plugin provides.

getReleaseVersion() - Method in interface com.github.alex1304.ultimategdbot.api.Bot

Gets the release version of the bot.

getReplyMenuTimeout() - Method in interface com.github.alex1304.ultimategdbot.api.Bot

Gets the maximum time in seconds that the bot should wait for a reply when a reply menu is open.

getServerModRoleId() - Method in class com.github.alex1304.ultimategdbot.api.database.NativeGuildSettings

getSubcommands() - Method in interface com.github.alex1304.ultimategdbot.api.Command

Gets the subcommands.

getSupportServerInviteLink() - Method in interface com.github.alex1304.ultimategdbot.api.Bot

Gets the discord.gg link to the support server.

getSyntax() - Method in interface com.github.alex1304.ultimategdbot.api.Command

Gets the syntax of the command.

getToken() - Method in interface com.github.alex1304.ultimategdbot.api.Bot

Get the bot token.

getUserId() - Method in class com.github.alex1304.ultimategdbot.api.database.BotAdmins

getVar(String, Class<T>) - Method in interface com.github.alex1304.ultimategdbot.api.Context

Gets the value of a variable.

getVarOrDefault(String, T) - Method in interface com.github.alex1304.ultimategdbot.api.Context

Gets the value of a variable.

GIGABYTE - com.github.alex1304.ultimategdbot.api.utils.SystemUnit

GuildSettings - Interface in com.github.alex1304.ultimategdbot.api.database

GuildSettingsEntry<E extends GuildSettings,D> - Class in com.github.alex1304.ultimategdbot.api.database

Represents a guild configuration entry.

GuildSettingsEntry(Class<E>, Function<E, D>, BiConsumer<E, D>, BiFunction<String, Long, Mono<D>>, BiFunction<D, Long, Mono<String>>) - Constructor for class com.github.alex1304.ultimategdbot.api.database.GuildSettingsEntry

GuildSettingsValueConverter - Class in com.github.alex1304.ultimategdbot.api.utils

GuildSettingsValueConverter(Bot) - Constructor for class com.github.alex1304.ultimategdbot.api.utils.GuildSettingsValueConverter

H

hashCode() - Method in class com.github.alex1304.ultimategdbot.api.database.NativeGuildSettings

I

InvalidSyntaxException - Exception in com.github.alex1304.ultimategdbot.api

InvalidSyntaxException(Command) - Constructor for exception com.github.alex1304.ultimategdbot.api.InvalidSyntaxException

invokeCommand(Command, Context) - Method in interface com.github.alex1304.ultimategdbot.api.CommandKernel

Invokes a command with the specified context.

isGranted(Context) - Method in interface com.github.alex1304.ultimategdbot.api.PermissionLevel

Whether the user is granted the permission to use the command.

J

joinAliases(Set<String>) - Static method in class com.github.alex1304.ultimategdbot.api.utils.BotUtils

justCheck(String, long, Predicate<String>, String) - Method in class com.github.alex1304.ultimategdbot.api.utils.GuildSettingsValueConverter

K

KILOBYTE - com.github.alex1304.ultimategdbot.api.utils.SystemUnit

L

log(String) - Method in interface com.github.alex1304.ultimategdbot.api.Bot

Sends a message into the debug log channel.

log(Consumer<MessageCreateSpec>) - Method in interface com.github.alex1304.ultimategdbot.api.Bot

Sends a message into the debug log channel.

logStackTrace(Context, Throwable) - Method in interface com.github.alex1304.ultimategdbot.api.Bot

Prints a Throwable's stack trace in the log channel.

M

MEGABYTE - com.github.alex1304.ultimategdbot.api.utils.SystemUnit

N

NativeGuildSettings - Class in com.github.alex1304.ultimategdbot.api.database

NativeGuildSettings() - Constructor for class com.github.alex1304.ultimategdbot.api.database.NativeGuildSettings

noConversion(String, long) - Method in class com.github.alex1304.ultimategdbot.api.utils.GuildSettingsValueConverter

NONE_VALUE - Static variable in class com.github.alex1304.ultimategdbot.api.utils.GuildSettingsValueConverter

O

occurrences(String, String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.BotUtils

onBotReady() - Method in interface com.github.alex1304.ultimategdbot.api.Plugin

Action to execute when the bot is ready.

openReplyMenu(Context, Message, Map<String, Function<Context, Mono<Void>>>, boolean, boolean) - Method in interface com.github.alex1304.ultimategdbot.api.CommandKernel

Opens a new reply menu with the given items.

P

PaginatedReplyMenuBuilder - Class in com.github.alex1304.ultimategdbot.api.utils.reply

PaginatedReplyMenuBuilder(Command, Context, boolean, boolean, int) - Constructor for class com.github.alex1304.ultimategdbot.api.utils.reply.PaginatedReplyMenuBuilder

parse(String, Function<String, P>) - Method in class com.github.alex1304.ultimategdbot.api.utils.PropertyParser

Parses a value using the given function and returns it

parseArgs(String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.BotUtils

parseArgs(String, String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.BotUtils

parseAsInt(String) - Method in class com.github.alex1304.ultimategdbot.api.utils.PropertyParser

Convenient method that is similar as doing:

parseAsIntOrDefault(String, int) - Method in class com.github.alex1304.ultimategdbot.api.utils.PropertyParser

Convenient method that is similar as doing:

parseAsList(String, String, Function<String, E>) - Method in class com.github.alex1304.ultimategdbot.api.utils.PropertyParser

Attempts to parse the vale as a list of values, each element being separated with a separator character.

parseAsListOrEmpty(String, String, Function<String, E>) - Method in class com.github.alex1304.ultimategdbot.api.utils.PropertyParser

Same as PropertyParser.parseAsList(String, String, Function) but in case of error returns an empty list instead of throwing an IllegalArgumentException.

parseAsLong(String) - Method in class com.github.alex1304.ultimategdbot.api.utils.PropertyParser

Convenient method that is similar as doing:

parseAsLongOrDefault(String, long) - Method in class com.github.alex1304.ultimategdbot.api.utils.PropertyParser

Convenient method that is similar as doing:

parseAsString(String) - Method in class com.github.alex1304.ultimategdbot.api.utils.PropertyParser

Convenient method that is similar as doing:

parseAsStringOrDefault(String, String) - Method in class com.github.alex1304.ultimategdbot.api.utils.PropertyParser

Convenient method that is similar as doing:

parseCommandLine(String) - Method in interface com.github.alex1304.ultimategdbot.api.CommandKernel

Reads the command line and retrieves the corresponding Command instance.

parseCommandLine(List<String>) - Method in interface com.github.alex1304.ultimategdbot.api.CommandKernel

Reads the command line and retrieves the corresponding Command instance.

parseOrDefault(String, Function<String, P>, P) - Method in class com.github.alex1304.ultimategdbot.api.utils.PropertyParser

Parses a value using the given function and returns it.

PermissionLevel - Interface in com.github.alex1304.ultimategdbot.api

Permission level of a bot command.

Plugin - Interface in com.github.alex1304.ultimategdbot.api

Represents a plugin.

PropertyParser - Class in com.github.alex1304.ultimategdbot.api.utils

Allows to parse values from properties files.

PropertyParser(String, Properties) - Constructor for class com.github.alex1304.ultimategdbot.api.utils.PropertyParser

PUBLIC - Static variable in interface com.github.alex1304.ultimategdbot.api.PermissionLevel

Q

query(Class<T>, String, Object...) - Method in interface com.github.alex1304.ultimategdbot.api.Database

Makes a simple query to the database.

R

removeItem(String) - Method in class com.github.alex1304.ultimategdbot.api.utils.reply.ReplyMenuBuilder

removeQuotesUnlessEscaped(String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.BotUtils

reply(String) - Method in interface com.github.alex1304.ultimategdbot.api.Context

Sends a message in the same channel the command was sent.

reply(Consumer<? super MessageCreateSpec>) - Method in interface com.github.alex1304.ultimategdbot.api.Context

Sends a message in the same channel the command was sent.

ReplyMenuBuilder - Class in com.github.alex1304.ultimategdbot.api.utils.reply

Builds a reply menu.

ReplyMenuBuilder(Context, boolean, boolean) - Constructor for class com.github.alex1304.ultimategdbot.api.utils.reply.ReplyMenuBuilder

requireMinimumArgCount(Context, int) - Static method in class com.github.alex1304.ultimategdbot.api.utils.ArgUtils

Checks if the arguments of htis context has an argument count greater or equal to the given count.

requireMinimumArgCount(Context, int, String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.ArgUtils

Checks if the arguments of htis context has an argument count greater or equal to the given count.

S

save(Object) - Method in interface com.github.alex1304.ultimategdbot.api.Database

Saves an object in database

sendMultipleMessagesToOneChannel(Mono<Channel>, Iterable<Consumer<MessageCreateSpec>>) - Static method in class com.github.alex1304.ultimategdbot.api.utils.BotUtils

sendMultipleSimpleMessagesToOneChannel(Mono<Channel>, Iterable<String>) - Static method in class com.github.alex1304.ultimategdbot.api.utils.BotUtils

sendOneMessageToMultipleChannels(Flux<Channel>, Consumer<MessageCreateSpec>) - Static method in class com.github.alex1304.ultimategdbot.api.utils.BotUtils

SERVER_ADMIN - Static variable in interface com.github.alex1304.ultimategdbot.api.PermissionLevel

SERVER_MOD - Static variable in interface com.github.alex1304.ultimategdbot.api.PermissionLevel

setGuildId(long) - Method in interface com.github.alex1304.ultimategdbot.api.database.GuildSettings

Sets the guildID

setGuildId(long) - Method in class com.github.alex1304.ultimategdbot.api.database.NativeGuildSettings

setGuildSetting(String, String) - Method in interface com.github.alex1304.ultimategdbot.api.Context

Edits an entry of the guild settings.

setHeader(String) - Method in class com.github.alex1304.ultimategdbot.api.utils.reply.PaginatedReplyMenuBuilder

setHeader(String) - Method in class com.github.alex1304.ultimategdbot.api.utils.reply.ReplyMenuBuilder

setPrefix(String) - Method in class com.github.alex1304.ultimategdbot.api.database.NativeGuildSettings

setServerModRoleId(long) - Method in class com.github.alex1304.ultimategdbot.api.database.NativeGuildSettings

setup(Bot, PropertyParser) - Method in interface com.github.alex1304.ultimategdbot.api.Plugin

Code executed when the plugin is loaded.

setUserId(long) - Method in class com.github.alex1304.ultimategdbot.api.database.BotAdmins

setVar(String, Object) - Method in interface com.github.alex1304.ultimategdbot.api.Context

Adds a variable in this context.

setVarIfNotExists(String, Object) - Method in interface com.github.alex1304.ultimategdbot.api.Context

Adds a variable in this context.

SystemUnit - Enum in com.github.alex1304.ultimategdbot.api.utils

Enumerates system units (bytes, kilobytes, etc until terabytes) Provides methods for conversion and formatting.

T

TERABYTE - com.github.alex1304.ultimategdbot.api.utils.SystemUnit

toBoolean(String, long) - Method in class com.github.alex1304.ultimategdbot.api.utils.GuildSettingsValueConverter

toCategoryId(String, long) - Method in class com.github.alex1304.ultimategdbot.api.utils.GuildSettingsValueConverter

toNumber(String, long, Function<String, N>) - Method in class com.github.alex1304.ultimategdbot.api.utils.GuildSettingsValueConverter

toNumberWithCheck(String, long, Function<String, N>, Predicate<N>, String) - Method in class com.github.alex1304.ultimategdbot.api.utils.GuildSettingsValueConverter

toRoleId(String, long) - Method in class com.github.alex1304.ultimategdbot.api.utils.GuildSettingsValueConverter

toString() - Method in enum com.github.alex1304.ultimategdbot.api.utils.SystemUnit

toTextChannelId(String, long) - Method in class com.github.alex1304.ultimategdbot.api.utils.GuildSettingsValueConverter

toVoiceChannelId(String, long) - Method in class com.github.alex1304.ultimategdbot.api.utils.GuildSettingsValueConverter

V

valueAsStringToDatabase(Database, String, long) - Method in class com.github.alex1304.ultimategdbot.api.database.GuildSettingsEntry

valueFromDatabase(Database, long) - Method in class com.github.alex1304.ultimategdbot.api.database.GuildSettingsEntry

valueFromDatabaseAsString(Database, long) - Method in class com.github.alex1304.ultimategdbot.api.database.GuildSettingsEntry

valueOf(String) - Static method in enum com.github.alex1304.ultimategdbot.api.utils.SystemUnit

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.github.alex1304.ultimategdbot.api.utils.SystemUnit

Returns an array containing the constants of this enum type, in the order they are declared.

valueToDatabase(Database, D, long) - Method in class com.github.alex1304.ultimategdbot.api.database.GuildSettingsEntry

A B C D E F G H I J K L M N O P Q R S T V
All Classes All Packages