com.github.afarion1.command_handler.command

Class CommandHandlerBuilder

java.lang.Object

com.github.afarion1.command_handler.command.CommandHandlerBuilder

public final class CommandHandlerBuilder
extends java.lang.Object

Represents configuration of Command handler for convenient instance building.
Parameters set through methods override the ones from config file.

Constructor Summary

Constructors

Constructor and Description
CommandHandlerBuilder() Creates fluent configuration object for CommandHandler instance creation. Equivalent of CommandHandlerBuilder(boolean) with parameter true.
CommandHandlerBuilder(boolean createConfigIfAbsent) Creates fluent configuration object for CommandHandler instance creation. The single parameter determines whether a configuration file should be created in root directory.

Method Summary

Modifier and Type	Method and Description
CommandHandler	build()
CommandHandlerBuilder	cleanDbOnStartup(boolean cleanDbOnStartup) Setting to false will prevent outdated cooldown entries from being deleted from the DB.
CommandHandlerBuilder	disableCommandList() Disables internal Command List command.
CommandHandlerBuilder	disableInspectCommand() Disables internal Inspect Command command.
CommandHandlerBuilder	setCommandListEmbedColor(java.awt.Color helpColor)
CommandHandlerBuilder	setCommandPrefix(java.lang.String commandsPrefix) Default prefix is ~
CommandHandlerBuilder	setErrorEmbedColor(java.awt.Color errorColor)
CommandHandlerBuilder	setExecutorService(java.util.concurrent.ExecutorService executor) A thread pool with size of available processors amount is used by default.
CommandHandlerBuilder	setInspectCommandEmbedColor(java.awt.Color inspectColor)
CommandHandlerBuilder	setJda(net.dv8tion.jda.api.JDA jda)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandHandlerBuilder

public CommandHandlerBuilder()

Creates fluent configuration object for CommandHandler instance creation.
Equivalent of CommandHandlerBuilder(boolean) with parameter true. A configuration file will be created in root directory, to prevent the file creation use CommandHandlerBuilder(boolean) with parameter false. CommandHandler's parameters from the configuration are overridden by parameters set using methods of the CommandHandlerBuilder.
Before calling build() to create CommandHandler instance, JDA should be set using setJda(JDA)
Default values:

• Command prefix is ~
• Command list is enabled
• Command inspection is enabled
• Outdated cooldown entries will be removed from database
• Command list's embed color is Color.yellow
• Command inspection's embed color is Color.yellow
• Error's embed color is Color.red

If no executor for command processing is specified, a FixedThreadPool with size of amount of available processors will be used.

CommandHandlerBuilder

public CommandHandlerBuilder(boolean createConfigIfAbsent)

Creates fluent configuration object for CommandHandler instance creation.
The single parameter determines whether a configuration file should be created in root directory. CommandHandler's parameters from the configuration are overridden by parameters set using methods of the CommandHandlerBuilder.
Before calling build() to create CommandHandler instance, JDA should be set using setJda(JDA)
Default values:

• Command prefix is ~
• Command list is enabled
• Command inspection is enabled
• Outdated cooldown entries will be removed from database
• Command list's embed color is Color.yellow
• Command inspection's embed color is Color.yellow
• Error's embed color is Color.red

If no executor for command processing is specified, a FixedThreadPool with size of amount of available processors will be used.

Method Detail

setJda

public CommandHandlerBuilder setJda(net.dv8tion.jda.api.JDA jda)

Parameters:

jda - the JDA the CommandHandler will be handling messages from.

Returns:

instance of CommandHandlerBuilder. Useful for chaining

cleanDbOnStartup

public CommandHandlerBuilder cleanDbOnStartup(boolean cleanDbOnStartup)

Setting to false will prevent outdated cooldown entries from being deleted from the DB.
True by default.

Returns:

instance of CommandHandlerBuilder. Useful for chaining

setExecutorService

public CommandHandlerBuilder setExecutorService(java.util.concurrent.ExecutorService executor)

A thread pool with size of available processors amount is used by default.

Parameters:

executor - the executor will be used for commands processing.

Returns:

instance of CommandHandlerBuilder. Useful for chaining

setCommandPrefix

public CommandHandlerBuilder setCommandPrefix(java.lang.String commandsPrefix)

Default prefix is ~

Parameters:

commandsPrefix - the prefix will be used to detect command call.

Returns:

instance of CommandHandlerBuilder. Useful for chaining

setCommandListEmbedColor

public CommandHandlerBuilder setCommandListEmbedColor(java.awt.Color helpColor)

Parameters:

helpColor - the color will be used for Command List's embed (the color to left of a message).

Returns:

instance of CommandHandlerBuilder. Useful for chaining

setErrorEmbedColor

public CommandHandlerBuilder setErrorEmbedColor(java.awt.Color errorColor)

Parameters:

errorColor - the color will be used for error embed (the color to left of a message).

Returns:

instance of CommandHandlerBuilder. Useful for chaining

setInspectCommandEmbedColor

public CommandHandlerBuilder setInspectCommandEmbedColor(java.awt.Color inspectColor)

Parameters:

inspectColor - the color will be used for Inspect Command's embed (the color to left of a message).

Returns:

instance of CommandHandlerBuilder. Useful for chaining

disableCommandList

public CommandHandlerBuilder disableCommandList()

Disables internal Command List command.

Returns:

instance of CommandHandlerBuilder. Useful for chaining

disableInspectCommand

public CommandHandlerBuilder disableInspectCommand()

Disables internal Inspect Command command.

Returns:

instance of CommandHandlerBuilder. Useful for chaining

build

public CommandHandler build()

Returns:

CommandHandler instance with the given configuration