Class JDACBuilderData

java.lang.Object

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

Direct Known Subclasses:

JDACBuilder

public sealed class JDACBuilderData
extends Object
permits JDACBuilder

Readonly view of a JDACBuilder. Acts as a snapshot of the current builder state during jda-commands startup.

Implementation Note:

This class is used to give implementations of Extension access to properties involved in the creation of JDACommands.

Please note that this class only gives read not write access to the JDACBuilder.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Class<?>	baseClass
protected Collection<ClassFinder>	classFinders
protected final JDAContext	context
protected @Nullable InteractionControllerInstantiator	controllerInstantiator
protected @Nullable Descriptor	descriptor
protected @Nullable Embeds	embeds
protected Collection<EmojiSource>	emojiSources
protected @Nullable ErrorMessageFactory	errorMessageFactory
protected ExpirationStrategy	expirationStrategy
protected final Map<Class<? extends Extension.Data>, Extension.Data>	extensionData
protected ExtensionFilter	extensionFilter
protected CommandDefinition.CommandConfig	globalCommandConfig
protected InteractionDefinition.ReplyConfig	globalReplyConfig
protected @Nullable GuildScopeProvider	guildScopeProvider
protected @Nullable Collection<Extension<Extension.Data>>	loadedExtensions
protected boolean	localizeCommands
protected @Nullable Localizer	localizer
static final org.slf4j.Logger	log
protected final Set<Map.Entry<Priority, Middleware>>	middlewares
protected final String[]	packages
protected @Nullable PermissionsProvider	permissionsProvider
protected boolean	shutdownJDA
protected final Map<Map.Entry<io.github.kaktushose.proteus.type.Type<?>, io.github.kaktushose.proteus.type.Type<?>>, TypeAdapter<?,?>>	typeAdapters
protected final Map<Class<? extends Annotation>, Validator<?,?>>	validators

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JDACBuilderData(Class<?> baseClass, String[] packages, JDAContext context)

Method Summary

Modifier and Type	Method	Description
Class<?>	baseClass()	the base class provided by the user for classpath scanning
Collection<ClassFinder>	classFinders()
JDAContext	context()	the JDAContext to be used
InteractionControllerInstantiator	controllerInstantiator()
Descriptor	descriptor()
protected Embeds	embeds(MessageResolver messageResolver)
Collection<EmojiSource>	emojiSources()
ErrorMessageFactory	errorMessageFactory()
ExpirationStrategy	expirationStrategy()
CommandDefinition.CommandConfig	globalCommandConfig()
InteractionDefinition.ReplyConfig	globalReplyConfig()
GuildScopeProvider	guildScopeProvider()
I18n	i18n()
boolean	localizeCommands()
Localizer	localizer()
ClassFinder	mergedClassFinder()
protected MessageResolver	messageResolver()
Collection<Map.Entry<Priority, Middleware>>	middlewares()
String[]	packages()	the packages provided by the user for classpath scanning
PermissionsProvider	permissionsProvider()
boolean	shutdownJDA()
Map<Map.Entry<io.github.kaktushose.proteus.type.Type<?>, io.github.kaktushose.proteus.type.Type<?>>, TypeAdapter<?,?>>	typeAdapters()
Map<Class<? extends Annotation>, Validator<?,?>>	validators()

Methods inherited from class java.lang.Object

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

Field Details

log

public static final org.slf4j.Logger log

baseClass

protected final Class<?> baseClass

packages

protected final String[] packages

context

protected final JDAContext context

loadedExtensions

protected @Nullable Collection<Extension<Extension.Data>> loadedExtensions

extensionData

protected final Map<Class<? extends Extension.Data>, Extension.Data> extensionData

extensionFilter

protected ExtensionFilter extensionFilter

controllerInstantiator

protected @Nullable InteractionControllerInstantiator controllerInstantiator

expirationStrategy

protected ExpirationStrategy expirationStrategy

permissionsProvider

protected @Nullable PermissionsProvider permissionsProvider

errorMessageFactory

protected @Nullable ErrorMessageFactory errorMessageFactory

guildScopeProvider

protected @Nullable GuildScopeProvider guildScopeProvider

descriptor

protected @Nullable Descriptor descriptor

localizer

protected @Nullable Localizer localizer

emojiSources

protected Collection<EmojiSource> emojiSources

classFinders

protected Collection<ClassFinder> classFinders

middlewares

protected final Set<Map.Entry<Priority, Middleware>> middlewares

validators

protected final Map<Class<? extends Annotation>, Validator<?,?>> validators

typeAdapters

protected final Map<Map.Entry<io.github.kaktushose.proteus.type.Type<?>, io.github.kaktushose.proteus.type.Type<?>>, TypeAdapter<?,?>> typeAdapters

globalReplyConfig

protected InteractionDefinition.ReplyConfig globalReplyConfig

globalCommandConfig

protected CommandDefinition.CommandConfig globalCommandConfig

shutdownJDA

protected boolean shutdownJDA

localizeCommands

protected boolean localizeCommands

embeds

protected @Nullable Embeds embeds

Constructor Details

JDACBuilderData

protected JDACBuilderData(Class<?> baseClass,
 String[] packages,
 JDAContext context)

Method Details

packages

public String[] packages()

the packages provided by the user for classpath scanning

context

public JDAContext context()

the JDAContext to be used

baseClass

public Class<?> baseClass()

the base class provided by the user for classpath scanning

globalReplyConfig

public InteractionDefinition.ReplyConfig globalReplyConfig()

Returns:

the global InteractionDefinition.ReplyConfig provided by the user

globalCommandConfig

public CommandDefinition.CommandConfig globalCommandConfig()

expirationStrategy

public ExpirationStrategy expirationStrategy()

Returns:

the ExpirationStrategy to be used

shutdownJDA

public boolean shutdownJDA()

Returns:

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

localizeCommands

public boolean localizeCommands()

Returns:

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

controllerInstantiator

public InteractionControllerInstantiator controllerInstantiator()

Returns:

the InteractionControllerInstantiator to be used. Can be added via an Extension

localizer

public Localizer localizer()

Returns:

the Localizer to be used. Can be added via an Extension

permissionsProvider

public PermissionsProvider permissionsProvider()

Returns:

the PermissionsProvider to be used. Can be added via an Extension

errorMessageFactory

public ErrorMessageFactory errorMessageFactory()

Returns:

the ErrorMessageFactory to be used. Can be added via an Extension

guildScopeProvider

public GuildScopeProvider guildScopeProvider()

Returns:

the GuildScopeProvider to be used. Can be added via an Extension

descriptor

public Descriptor descriptor()

Returns:

the Descriptor to be used. Can be added via an Extension

classFinders

public Collection<ClassFinder> classFinders()

Returns:

the ClassFinders to be used. Can be added via an Extension

emojiSources

public Collection<EmojiSource> emojiSources()

Returns:

the EmojiSources to be used. Can be added via an Extension

mergedClassFinder

public ClassFinder mergedClassFinder()

Returns:

a ClassFinder that searches in all ClassFinders returned by classFinders()

middlewares

public Collection<Map.Entry<Priority, Middleware>> middlewares()

Returns:

the Middlewares to be used. Can be added via an Extension

validators

public Map<Class<? extends Annotation>, Validator<?,?>> validators()

Returns:

the Validators to be used. Can be added via an Extension

typeAdapters

public Map<Map.Entry<io.github.kaktushose.proteus.type.Type<?>, io.github.kaktushose.proteus.type.Type<?>>, TypeAdapter<?,?>> typeAdapters()

Returns:

the TypeAdapters to be used. Can be added via an Extension

embeds

protected Embeds embeds(MessageResolver messageResolver)

i18n

public I18n i18n()

Returns:

the used I18n instance

messageResolver

protected MessageResolver messageResolver()

Returns:

the used MessageResolver instance