Class JDACBuilder

java.lang.Object

com.github.kaktushose.jda.commands.extension.JDACBuilderData

com.github.kaktushose.jda.commands.JDACBuilder

public final class JDACBuilder
extends JDACBuilderData

This builder is used to build instances of JDACommands.

Please note that values that can be set have a default implementation. These following implementations are based on reflections. If you want to avoid reflections, you have to provide your own implementations for:

• descriptor(Descriptor)
• classFinders(ClassFinder...)
• instanceProvider(InteractionControllerInstantiator)

In addition to manually configuring this builder, you can also provide implementations of Extension trough Javas service provider interface, which are applied during JDACommands creation. Values manually defined by this builder will always override loaded and default ones, except for:

• middleware(Priority, Middleware)
• adapter(Class, Class, TypeAdapter)
• validator(Class, Validator)

which will add to the default and loaded ones.

These implementations of Extension can be additionally configured by adding the according implementation of Extension.Data by calling extensionData(Extension.Data...). (if supported by the extension)

If any exception while configuration/start of JDA-Commands is thrown, the JDA instance if shutdown per default. This can be configured by settings shutdownJDA(boolean).

Example

JDACommands jdaCommands = JDACommands.builder(jda, Main.class)
    .middleware(Priority.NORMAL, new TestMiddleware())
    .globalReplyConfig(new InteractionDefinition.ReplyConfig(false, false, true))
    .classFinders(ClassFinder.reflective(Main.class), ClassFinders.explicit(ButtonInteraction.class))
    .start();

See Also:

• Extension

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	JDACBuilder.FilterStrategy	The two available filter strategies

Field Summary

Fields inherited from class com.github.kaktushose.jda.commands.extension.JDACBuilderData

baseClass, classFinders, context, controllerInstantiator, descriptor, embeds, emojiSources, errorMessageFactory, expirationStrategy, extensionData, extensionFilter, globalCommandConfig, globalReplyConfig, guildScopeProvider, loadedExtensions, localizeCommands, localizer, log, middlewares, packages, permissionsProvider, shutdownJDA, typeAdapters, validators

Method Summary

Modifier and Type	Method	Description
JDACBuilder	adapter(Class<?> source, Class<?> target, TypeAdapter<?,?> adapter)
JDACBuilder	classFinders(ClassFinder... classFinders)
JDACBuilder	descriptor(Descriptor descriptor)
JDACBuilder	embeds(Consumer<EmbedConfig> consumer)	Configuration step for the Embed API of JDA-Commands.
JDACBuilder	emojiSources(EmojiSource... sources)	Application emojis loaded from EmojiSources will be registered upon startup with help of JDA.createApplicationEmoji(String, Icon).
JDACBuilder	errorMessageFactory(ErrorMessageFactory errorMessageFactory)
JDACBuilder	expirationStrategy(ExpirationStrategy expirationStrategy)
JDACBuilder	extensionData(Extension.Data... data)	Registers Extension.Data that will be passed to the respective Extensions to configure them properly.
JDACBuilder	filterExtensions(JDACBuilder.FilterStrategy strategy, String... classes)	Specifies a way to filter found implementations of Extension if you have clashing or cycling dependencies for example.
JDACBuilder	globalCommandConfig(CommandDefinition.CommandConfig config)
JDACBuilder	globalReplyConfig(InteractionDefinition.ReplyConfig globalReplyConfig)
JDACBuilder	guildScopeProvider(GuildScopeProvider guildScopeProvider)
JDACBuilder	instanceProvider(InteractionControllerInstantiator instanceProvider)
JDACBuilder	localizeCommands(boolean localize)	Whether JDA-Commands should use the I18n feature to localize commands.
JDACBuilder	localizer(Localizer localizer)
JDACBuilder	middleware(Priority priority, Middleware middleware)
JDACBuilder	permissionsProvider(PermissionsProvider permissionsProvider)
JDACBuilder	shutdownJDA(boolean shutdown)	Whether the JDA instance should be shutdown if the configuration/start of JDA-Commands fails or if JDACommands.shutdown() is called
JDACommands	start()	This method applies all found implementations of Extension, instantiates an instance of JDACommands and starts the framework.
JDACBuilder	validator(Class<? extends Annotation> annotation, Validator<?,?> validator)

Methods inherited from class com.github.kaktushose.jda.commands.extension.JDACBuilderData

baseClass, classFinders, context, controllerInstantiator, descriptor, embeds, emojiSources, errorMessageFactory, expirationStrategy, globalCommandConfig, globalReplyConfig, guildScopeProvider, i18n, localizeCommands, localizer, mergedClassFinder, messageResolver, middlewares, packages, permissionsProvider, shutdownJDA, typeAdapters, validators

Methods inherited from class java.lang.Object

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

Method Details

classFinders

public JDACBuilder classFinders(ClassFinder... classFinders)

Parameters:

classFinders - the to be used ClassFinders

API Note:

This method overrides the underlying collection instead of adding to it. If you want to add own ClassFinders while keeping the default reflective implementation, you have to add it explicitly via

invalid reference

ClassFinder#reflective(Class, String...)

too.

emojiSources

public JDACBuilder emojiSources(EmojiSource... sources)

Application emojis loaded from EmojiSources will be registered upon startup with help of JDA.createApplicationEmoji(String, Icon).

Parameters:

sources - the to be used EmojiSources

API Note:

This method overrides the underlying collection instead of adding to it. If you want to add own EmojiSources while keeping the default reflective implementation, you have to add it explicitly via

invalid reference

EmojiSource#reflective(Class, String...)

too.

descriptor

public JDACBuilder descriptor(Descriptor descriptor)

Parameters:

descriptor - the Descriptor to be used

embeds

public JDACBuilder embeds(Consumer<EmbedConfig> consumer)

Configuration step for the Embed API of JDA-Commands.

Use the given EmbedConfig to declare placeholders or data sources.

localizer

public JDACBuilder localizer(Localizer localizer)

Parameters:

localizer - The Localizer to use

instanceProvider

public JDACBuilder instanceProvider(InteractionControllerInstantiator instanceProvider)

Parameters:

instanceProvider - the implementation of InteractionControllerInstantiator to use

expirationStrategy

public JDACBuilder expirationStrategy(ExpirationStrategy expirationStrategy)

Parameters:

expirationStrategy - The ExpirationStrategy to be used

middleware

public JDACBuilder middleware(Priority priority,
 Middleware middleware)

Parameters:

priority - The Priority with what the Middleware should be registered

middleware - The to be registered Middleware

adapter

public JDACBuilder adapter(Class<?> source,
 Class<?> target,
 TypeAdapter<?,?> adapter)

Parameters:

source - The source type that the given TypeAdapter can handle

target - The target type that the given TypeAdapter can handle

adapter - The TypeAdapter to be registered

validator

public JDACBuilder validator(Class<? extends Annotation> annotation,
 Validator<?,?> validator)

Parameters:

annotation - The annotation for which the given Validator should be called

validator - The Validator to be registered

permissionsProvider

public JDACBuilder permissionsProvider(PermissionsProvider permissionsProvider)

Parameters:

permissionsProvider - The PermissionsProvider that should be used

errorMessageFactory

public JDACBuilder errorMessageFactory(ErrorMessageFactory errorMessageFactory)

Parameters:

errorMessageFactory - The ErrorMessageFactory that should be used

guildScopeProvider

public JDACBuilder guildScopeProvider(GuildScopeProvider guildScopeProvider)

Parameters:

guildScopeProvider - The GuildScopeProvider that should be used

globalReplyConfig

public JDACBuilder globalReplyConfig(InteractionDefinition.ReplyConfig globalReplyConfig)

Parameters:

globalReplyConfig - the InteractionDefinition.ReplyConfig to be used as a global fallback option

globalCommandConfig

public JDACBuilder globalCommandConfig(CommandDefinition.CommandConfig config)

Parameters:

config - the CommandDefinition.CommandConfig to be used as a global fallback option

extensionData

public JDACBuilder extensionData(Extension.Data... data)

Registers Extension.Data that will be passed to the respective Extensions to configure them properly.

Parameters:

data - the instances of Extension.Data to be used

shutdownJDA

public JDACBuilder shutdownJDA(boolean shutdown)

Whether the JDA instance should be shutdown if the configuration/start of JDA-Commands fails or if JDACommands.shutdown() is called

Parameters:

shutdown - whether to shut down the JDA instance, default true

localizeCommands

public JDACBuilder localizeCommands(boolean localize)

Whether JDA-Commands should use the I18n feature to localize commands.

Parameters:

localize - whether to localize commands, default true

See Also:

• LocalizationFunction
• FluavaLocalizer

filterExtensions

public JDACBuilder filterExtensions(JDACBuilder.FilterStrategy strategy,
 String... classes)

Specifies a way to filter found implementations of Extension if you have clashing or cycling dependencies for example.

Parameters:

strategy - the filtering strategy to be used either JDACBuilder.FilterStrategy.INCLUDE or JDACBuilder.FilterStrategy.EXCLUDE

classes - the classes to be filtered

API Note:

This method compares the fully classified class name of all Extension implementations by using String.startsWith(String), so it's possible to include/exclude a bunch of classes in the same package by just providing the package name.

start

public JDACommands start()

This method applies all found implementations of Extension, instantiates an instance of JDACommands and starts the framework.