com.jagrosh.jdautilities.command

Class CommandClientBuilder

java.lang.Object

com.jagrosh.jdautilities.command.CommandClientBuilder

public class CommandClientBuilder
extends java.lang.Object

A simple builder used to create a CommandClientImpl.

Once built, add the CommandClient as an EventListener to JDA and it will automatically handle commands with ease!

Author:

John Grosh (jagrosh)

Constructor Summary

Constructors

Constructor and Description
CommandClientBuilder()

Method Summary

Modifier and Type	Method and Description
CommandClientBuilder	addAnnotatedModule(java.lang.Object module) Adds an annotated command module to the CommandClientImpl for this session.
CommandClientBuilder	addAnnotatedModules(java.lang.Object... modules) Adds multiple annotated command modules to the CommandClientImpl for this session.
CommandClientBuilder	addCommand(Command command) Adds a Command and registers it to the CommandClientImpl for this session.
CommandClientBuilder	addCommands(Command... commands) Adds and registers multiple Commands to the CommandClientImpl for this session.
CommandClient	build() Builds a CommandClientImpl with the provided settings.
CommandClientBuilder	setAlternativePrefix(java.lang.String prefix) Sets the bot's alternative prefix.
CommandClientBuilder	setAnnotatedCompiler(AnnotatedModuleCompiler compiler) Sets the AnnotatedModuleCompiler for this CommandClientBuilder.
CommandClientBuilder	setCarbonitexKey(java.lang.String key) Sets the Carbonitex key for this bot's listing.
CommandClientBuilder	setCoOwnerIds(java.lang.String... coOwnerIds) Sets the one or more CoOwners of the bot.
CommandClientBuilder	setDiscordBotListKey(java.lang.String key) Sets the Discord Bot List API key for this bot's listing.
CommandClientBuilder	setDiscordBotsKey(java.lang.String key) Sets the Discord Bots API key for this bot's listing.
CommandClientBuilder	setEmojis(java.lang.String success, java.lang.String warning, java.lang.String error) Sets the emojis for success, warning, and failure.
CommandClientBuilder	setGame(net.dv8tion.jda.core.entities.Game game) Sets the Game to use when the bot is ready.
CommandClientBuilder	setGuildSettingsManager(GuildSettingsManager manager) Sets the GuildSettingsManager for the CommandClientImpl built using this builder.
CommandClientBuilder	setHelpConsumer(java.util.function.Consumer<CommandEvent> helpConsumer) Sets the consumer to run as the bot's help command.
CommandClientBuilder	setHelpWord(java.lang.String helpWord) Sets the word used to trigger the command list.
CommandClientBuilder	setLinkedCacheSize(int linkedCacheSize) 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.
CommandClientBuilder	setListener(CommandListener listener) Sets the CommandListener for the CommandClientImpl.
CommandClientBuilder	setOwnerId(java.lang.String ownerId) Sets the owner for the bot.
CommandClientBuilder	setPrefix(java.lang.String prefix) Sets the bot's prefix.
CommandClientBuilder	setScheduleExecutor(java.util.concurrent.ScheduledExecutorService executor) Sets the ScheduledExecutorService for the CommandClientImpl.
CommandClientBuilder	setServerInvite(java.lang.String serverInvite) Sets the bot's support server invite.
CommandClientBuilder	setStatus(net.dv8tion.jda.core.OnlineStatus status) Sets the OnlineStatus the bot will use once Ready This defaults to ONLINE
CommandClientBuilder	useDefaultGame() Sets the Game the bot will use as the default: 'Playing Type [prefix]help'
CommandClientBuilder	useHelpBuilder(boolean useHelp) Sets whether the CommandClient will use the builder to automatically create a help command or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandClientBuilder

public CommandClientBuilder()

Method Detail

build

public CommandClient build()

Builds a CommandClientImpl with the provided settings.
Once built, only the CommandListener, and Commands can be changed.

Returns:

The CommandClient built.

setOwnerId

public CommandClientBuilder setOwnerId(java.lang.String ownerId)

Sets the owner for the bot.
Make sure to verify that the ID provided is ISnowflake compatible when setting this. If it is not, this will warn the developer.

Parameters:

ownerId - The ID of the owner.

Returns:

This builder

setCoOwnerIds

public CommandClientBuilder setCoOwnerIds(java.lang.String... coOwnerIds)

Sets the one or more CoOwners of the bot.
Make sure to verify that all of the IDs provided are ISnowflake compatible when setting this. If it is not, this will warn the developer which ones are not.

Parameters:

coOwnerIds - The ID(s) of the CoOwners

Returns:

This builder

setPrefix

public CommandClientBuilder setPrefix(java.lang.String prefix)

Sets the bot's prefix.
If set null, empty, or not set at all, the bot will use a mention @Botname as a prefix.

Parameters:

prefix - The prefix for the bot to use

Returns:

This builder

setAlternativePrefix

public CommandClientBuilder setAlternativePrefix(java.lang.String prefix)

Sets the bot's alternative prefix.
If set null, the bot will only use its primary prefix prefix.

Parameters:

prefix - The alternative prefix for the bot to use

Returns:

This builder

useHelpBuilder

public CommandClientBuilder useHelpBuilder(boolean useHelp)

Sets whether the CommandClient will use the builder to automatically create a help command or not.

Parameters:

useHelp - false to disable the help command builder, otherwise the CommandClient will use either the default or one provided via setHelpConsumer(Consumer)}.

Returns:

This builder

setHelpConsumer

public CommandClientBuilder setHelpConsumer(java.util.function.Consumer<CommandEvent> helpConsumer)

Sets the consumer to run as the bot's help command.
Setting it to null or not setting this at all will cause the bot to use the default help builder.

Parameters:

helpConsumer - A consumer to accept a CommandEvent when a help command is called.

Returns:

This builder

setHelpWord

public CommandClientBuilder setHelpWord(java.lang.String helpWord)

Sets the word used to trigger the command list.
Setting this to null or not setting this at all will set the help word to "help".

Parameters:

helpWord - The word to trigger the help command

Returns:

This builder

setServerInvite

public CommandClientBuilder setServerInvite(java.lang.String serverInvite)

Sets the bot's support server invite.

Parameters:

serverInvite - The support server invite

Returns:

This builder

setEmojis

public CommandClientBuilder setEmojis(java.lang.String success,
                                      java.lang.String warning,
                                      java.lang.String error)

Sets the emojis for success, warning, and failure.

Parameters:

success - Emoji for success

warning - Emoji for warning

error - Emoji for failure

Returns:

This builder

setGame

public CommandClientBuilder setGame(net.dv8tion.jda.core.entities.Game game)

Sets the Game to use when the bot is ready.
Can be set to null for no game.

Parameters:

game - The Game to use when the bot is ready

Returns:

This builder

useDefaultGame

public CommandClientBuilder useDefaultGame()

Sets the Game the bot will use as the default: 'Playing Type [prefix]help'

Returns:

This builder

setStatus

public CommandClientBuilder setStatus(net.dv8tion.jda.core.OnlineStatus status)

Sets the OnlineStatus the bot will use once Ready This defaults to ONLINE

Parameters:

status - The status to set

Returns:

This builder

addCommand

public CommandClientBuilder addCommand(Command command)

Adds a Command and registers it to the CommandClientImpl for this session.

Parameters:

command - The command to add

Returns:

This builder

addCommands

public CommandClientBuilder addCommands(Command... commands)

Adds and registers multiple Commands to the CommandClientImpl for this session.
This is the same as calling addCommand(Command) multiple times.

Parameters:

commands - The Commands to add

Returns:

This builder

addAnnotatedModule

public CommandClientBuilder addAnnotatedModule(java.lang.Object module)

Adds an annotated command module to the CommandClientImpl for this session.

For more information on annotated command modules, see the annotation package documentation.

Parameters:

module - The annotated command module to add

Returns:

This builder

See Also:

AnnotatedModuleCompiler, JDACommand

addAnnotatedModules

public CommandClientBuilder addAnnotatedModules(java.lang.Object... modules)

Adds multiple annotated command modules to the CommandClientImpl for this session.
This is the same as calling addAnnotatedModule(Object) multiple times.

For more information on annotated command modules, see the annotation package documentation.

Parameters:

modules - The annotated command modules to add

Returns:

This builder

See Also:

AnnotatedModuleCompiler, JDACommand

setAnnotatedCompiler

public CommandClientBuilder setAnnotatedCompiler(AnnotatedModuleCompiler compiler)

Sets the AnnotatedModuleCompiler for this CommandClientBuilder.

If not set this will be the default implementation found here.

Parameters:

compiler - The AnnotatedModuleCompiler to use

Returns:

This builder

See Also:

AnnotatedModuleCompiler, JDACommand

setCarbonitexKey

public CommandClientBuilder setCarbonitexKey(java.lang.String key)

Sets the Carbonitex key for this bot's listing.

When set, the CommandClientImpl will automatically update it's Carbonitex listing with relevant information such as server count.

Parameters:

key - A Carbonitex key

Returns:

This builder

setDiscordBotsKey

public CommandClientBuilder setDiscordBotsKey(java.lang.String key)

Sets the Discord Bots API key for this bot's listing.

When set, the CommandClientImpl will automatically update it's Discord Bots listing with relevant information such as server count.

Parameters:

key - A Discord Bots API key

Returns:

This builder

setDiscordBotListKey

public CommandClientBuilder setDiscordBotListKey(java.lang.String key)

Sets the Discord Bot List API key for this bot's listing.

When set, the CommandClientImpl will automatically update it's Discord Bot List listing with relevant information such as server count.

Parameters:

key - A Discord Bot List API key

Returns:

This builder

setListener

public CommandClientBuilder setListener(CommandListener listener)

Sets the CommandListener for the CommandClientImpl.

Parameters:

listener - The CommandListener for the CommandClientImpl

Returns:

This builder

setScheduleExecutor

public CommandClientBuilder setScheduleExecutor(java.util.concurrent.ScheduledExecutorService executor)

Sets the ScheduledExecutorService for the CommandClientImpl.

Parameters:

executor - The ScheduledExecutorService for the CommandClientImpl

Returns:

This builder

setLinkedCacheSize

public CommandClientBuilder setLinkedCacheSize(int linkedCacheSize)

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.

Higher cache size means that decay of cache contents will most likely occur later, allowing the deletion of responses when the call is deleted to last for a longer duration. However this also means larger memory usage.

Setting 0 or negative will cause the client to not use linked caching at all.

Parameters:

linkedCacheSize - The maximum number of paired responses that can be cached, or <1 if the built CommandClient will not use linked caching.

Returns:

This builder

setGuildSettingsManager

public CommandClientBuilder setGuildSettingsManager(GuildSettingsManager manager)

Sets the GuildSettingsManager for the CommandClientImpl built using this builder.

Parameters:

manager - The GuildSettingsManager to set.

Returns:

This builder