Class JDACBuilder

java.lang.Object

io.github.kaktushose.jdac.JDACBuilder

public class JDACBuilder
extends Object

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...)
• instantiator(Instantiator)

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 and

• classFinders(ClassFinder...)
• emojiSource(EmojiSource...)

which will override the default but add to the 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 is shutdown per default. This can be configured by settings shutdownJDA(boolean).

Example

JDACommands jdaCommands = JDACommands.builder(jda)
    .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

Method Summary

Modifier and Type	Method	Description
<S,T> JDACBuilder	adapter(Class<S> source, Class<T> target, TypeAdapter<S,T> adapter)
JDACBuilder	classFinders(ClassFinder... classFinders)
JDACBuilder	descriptor(Descriptor descriptor)
JDACBuilder	embeds(Consumer<EmbedConfig> consumer)	Configuration step for the Embed API of JDA-Commands.
JDACBuilder	emojiSource(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 strategy)
JDACBuilder	extensionData(Extension.Data... data)	Registers Extension.Data that will be passed to the respective Extensions to configure them properly.
JDACBuilder	filterExtensions(ExtensionFilter.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	instantiator(Instantiator instantiator)
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	packages(String... packages)	Some default implementations like ClassFinder.reflective(String...) will scan the classpath to find classes and resource.
JDACBuilder	permissionsProvider(PermissionsProvider permissionsProvider)
<T> JDACBuilder	setProperty(JDACProperty<T> property, Function<JDACIntrospection, T> supplier)	Allows the dynamic configuration of JDA-Commands by setting JDACPropertys directly.
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.
final JDACBuilder	stringResolver(Resolver<String>... resolvers)	Adds a Resolver in the resolution chain for strings provided by the user in annotations, components etc.
JDACBuilder	validator(Class<? extends Annotation> annotation, Validator<?,?> validator)

Methods inherited from class Object

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

Method Details

packages

public JDACBuilder packages(String... packages)

Some default implementations like ClassFinder.reflective(String...) will scan the classpath to find classes and resource. This config option allows you to restrict the to be scanned packages.

Parameters:

packages - the packages to scan recursively

classFinders

public JDACBuilder classFinders(ClassFinder... classFinders)

Parameters:

classFinders - the to be used ClassFinders

API Note:

This method overrides the default/fallback value but adds to the loaded ones. If you want to add own ClassFinders while keeping the default reflective implementation, you have to add it explicitly via ClassFinder.reflective(String...) too.

emojiSource

public JDACBuilder emojiSource(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 default/fallback value but adds to the loaded ones. If you want to add own EmojiSources while keeping the default reflective implementation, you have to add it explicitly via EmojiSource.reflective(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

instantiator

public JDACBuilder instantiator(Instantiator instantiator)

Parameters:

instantiator - the implementation of Instantiator to use

expirationStrategy

public JDACBuilder expirationStrategy(ExpirationStrategy strategy)

Parameters:

strategy - 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 <S,T> JDACBuilder adapter(Class<S> source,
 Class<T> target,
 TypeAdapter<S,T> 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(ExtensionFilter.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 ExtensionFilter.FilterStrategy.INCLUDE or ExtensionFilter.FilterStrategy.EXCLUDE

classes - the classes to be filtered

See Also:

• ExtensionFilter

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 extensions sharing the same base package by just providing the package name.

stringResolver

@SafeVarargs
public final JDACBuilder stringResolver(Resolver<String>... resolvers)

Adds a Resolver in the resolution chain for strings provided by the user in annotations, components etc.

All Resolvers are accumulated by MessageResolver. This method adds to the default resolvers like localization, placeholders and emojis

Parameters:

resolvers - the Resolvers to add

See Also:

• MessageResolver
• Resolver

setProperty

public <T> JDACBuilder setProperty(JDACProperty<T> property,
 Function<JDACIntrospection, T> supplier)

Allows the dynamic configuration of JDA-Commands by setting JDACPropertys directly.

Parameters:

property - the JDACProperty to be set

supplier - the function providing the custom value for it (PropertyProviderSkeleton.supplier())

See Also:

• JDACProperty
• PropertyProviderSkeleton.supplier()

Implementation Note:

the values will be added as JDACPropertyProviders with priority set to Integer.MAX_VALUE like they were set by any other method of this class.

start

public JDACommands start()

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