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 InteractionControllerInstantiator	controllerInstantiator
protected Descriptor	descriptor
protected ErrorMessageFactory	errorMessageFactory
protected ExpirationStrategy	expirationStrategy
protected final Map<Class<? extends Extension.Data>,Extension.Data>	extensionData
protected ExtensionFilter	extensionFilter
protected InteractionDefinition.ReplyConfig	globalReplyConfig
protected GuildScopeProvider	guildScopeProvider
protected Collection<Extension>	loadedExtensions
protected LocalizationFunction	localizationFunction
static final org.slf4j.Logger	log
protected final Set<Map.Entry<Priority,Middleware>>	middlewares
protected final String[]	packages
protected PermissionsProvider	permissionsProvider
protected final Map<Class<?>,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
@NotNull Class<?>	baseClass()	the base class provided by the user for classpath scanning
@NotNull Collection<ClassFinder>	classFinders()
@NotNull JDAContext	context()	the JDAContext to be used
@NotNull InteractionControllerInstantiator	controllerInstantiator()
@NotNull Descriptor	descriptor()
@NotNull ErrorMessageFactory	errorMessageFactory()
@NotNull ExpirationStrategy	expirationStrategy()
InteractionDefinition.ReplyConfig	globalReplyConfig()
@NotNull GuildScopeProvider	guildScopeProvider()
@NotNull LocalizationFunction	localizationFunction()
@NotNull ClassFinder	mergedClassFinder()
@NotNull Collection<Map.Entry<Priority,Middleware>>	middlewares()
@NotNull String[]	packages()	the packages provided by the user for classpath scanning
@NotNull PermissionsProvider	permissionsProvider()
@NotNull Map<Class<?>,TypeAdapter<?>>	typeAdapters()
@NotNull 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 Collection<Extension> loadedExtensions

extensionData

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

extensionFilter

protected ExtensionFilter extensionFilter

controllerInstantiator

protected InteractionControllerInstantiator controllerInstantiator

expirationStrategy

protected ExpirationStrategy expirationStrategy

permissionsProvider

protected PermissionsProvider permissionsProvider

errorMessageFactory

protected ErrorMessageFactory errorMessageFactory

guildScopeProvider

protected GuildScopeProvider guildScopeProvider

descriptor

protected Descriptor descriptor

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<Class<?>,TypeAdapter<?>> typeAdapters

globalReplyConfig

protected InteractionDefinition.ReplyConfig globalReplyConfig

localizationFunction

protected LocalizationFunction localizationFunction

Constructor Details

JDACBuilderData

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

Method Details

packages

@NotNull
public @NotNull String[] packages()

the packages provided by the user for classpath scanning

context

@NotNull
public @NotNull JDAContext context()

the JDAContext to be used

baseClass

@NotNull
public @NotNull Class<?> baseClass()

the base class provided by the user for classpath scanning

globalReplyConfig

@NotNull
public InteractionDefinition.ReplyConfig globalReplyConfig()

Returns:

the global InteractionDefinition.ReplyConfig provided by the user

expirationStrategy

@NotNull
public @NotNull ExpirationStrategy expirationStrategy()

Returns:

the ExpirationStrategy to be used

localizationFunction

@NotNull
public @NotNull LocalizationFunction localizationFunction()

Returns:

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

controllerInstantiator

@NotNull
public @NotNull InteractionControllerInstantiator controllerInstantiator()

Returns:

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

permissionsProvider

@NotNull
public @NotNull PermissionsProvider permissionsProvider()

Returns:

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

errorMessageFactory

@NotNull
public @NotNull ErrorMessageFactory errorMessageFactory()

Returns:

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

guildScopeProvider

@NotNull
public @NotNull GuildScopeProvider guildScopeProvider()

Returns:

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

descriptor

@NotNull
public @NotNull Descriptor descriptor()

Returns:

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

classFinders

@NotNull
public @NotNull Collection<ClassFinder> classFinders()

Returns:

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

mergedClassFinder

@NotNull
public @NotNull ClassFinder mergedClassFinder()

Returns:

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

middlewares

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

Returns:

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

validators

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

Returns:

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

typeAdapters

@NotNull
public @NotNull Map<Class<?>,TypeAdapter<?>> typeAdapters()

Returns:

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