Interface Property<T>

All Known Implementing Classes:

Property.Enumeration, Property.Map, Property.Singleton

public sealed interface Property<T>
permits Property.Enumeration<E>, Property.Singleton<T>, Property.Map<K,V>

Properties

An Property represent either...

• a config option to adjust the behaviour of JDA-Commands (like JDACBuilder.shutdownJDA(boolean))
• an implementation of exposed services (like Localizer)
• or a service provided by the framework that are exposed to the user (like I18n)

Although the user can provide custom values for these properties, the properties itself are all defined by the JDA-Commands and exposed as public static fields in this interface.

Categories

Properties are primarily categorized by 3 groups:

• user settable -> only configurable by using the designated JDACBuilder method
• user settable + loadable from extension -> above applies plus values can be provided by Extensions
• provided -> service that are provided by JDA-Commands, the user can use but not create/replace them

Types

Additionally, there are 3 types of properties:

• Property.Singleton -> the property will have the value of the provider with the highest priority
• Property.Map -> the property represents a Map with a key and value. The value of all providers will be accumulated and providers with higher priorities take precedence
• Property.Enumeration -> the property represents a Collection. The value of all providers will be accumulated

The only exception to this general accumulation rule are fallback values. Whether they are accumulated with other providers or overwritten is defined by fallbackBehaviour().

Stages

A Property's value is only set during some stages during the frameworks runtime and in the process of execution user interactions. To know in what stage a property's value is accessible take a look at the fields IntrospectionAccess annotation

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Property.Category	The category of a property defines how values for it can be provided.
static final record	Property.Enumeration<E>	A Property.Enumeration property basically represents a Collection of multiple values.
static enum	Property.FallbackBehaviour	The fallback behaviour defines whether the fallback value provided by JDA-Commands should be accumulated together with the user defined ones or overwritten.
static final record	Property.Map<K,V>	A Property.Map property basically represents a Map, where each value belongs target a specific key.
static final record	Property.Singleton<T>	A Property.Singleton property just hols one value.

Field Summary

Fields

Modifier and Type	Field	Description
static final Property<Collection<ClassFinder>>	CLASS_FINDER
static final Property<Definitions>	DEFINITIONS	The Definitions instance available after fully starting the framework.
static final Property<Descriptor>	DESCRIPTOR
static final Property<Consumer<EmbedConfig>>	EMBED_CONFIG
static final Property<Collection<EmbedDataSource>>	EMBED_SOURCES
static final Property<EmojiResolver>	EMOJI_RESOLVER	The EmojiResolver service provided by JDA-Commands.
static final Property<Collection<EmojiSource>>	EMOJI_SOURCES
static final Property<ErrorMessageFactory>	ERROR_MESSAGE_FACTORY
static final Property<ExpirationStrategy>	EXPIRATION_STRATEGY
static final Property<Map<Class<? extends Extension.Data>, Extension.Data>>	EXTENSION_DATA
static final Property<ExtensionFilter>	EXTENSION_FILTER
static final Property<CommandDefinition.CommandConfig>	GLOBAL_COMMAND_CONFIG
static final Property<InteractionDefinition.ReplyConfig>	GLOBAL_REPLY_CONFIG
static final Property<GuildScopeProvider>	GUILD_SCOPE_PROVIDER
static final Property<I18n>	I18N	The I18n service provided by JDA-Commands.
static final Property<Instantiator>	INSTANTIATOR
static final Property<Introspection>	INTROSPECTION	The Introspection instance itself used to retrieve properties in this scope.
static final Property<InvocationContext<?>>	INVOCATION_CONTEXT	The InvocationContext of this interaction.
static final Property<net.dv8tion.jda.api.JDA>	JDA	The JDA instance bound to this specific Runtime.
static final Property<JDACommands>	JDA_COMMANDS	The JDACommands instance available after fully starting the framework.
static final Property<net.dv8tion.jda.api.events.interaction.GenericInteractionCreateEvent>	JDA_EVENT	The GenericInteractionCreateEvent of this interaction.
static final Property<KeyValueStore>	KEY_VALUE_STORE	The KeyValueStore associated with this runtime.
static final Collection<Property<?>>	LOADABLE	A collection consisting of all Propertys that are settable by the user and loadable through extensions
static final Property<net.dv8tion.jda.api.interactions.commands.localization.LocalizationFunction>	LOCALIZATION_FUNCTION	The LocalizationFunction backed by MessageResolver used to localize/resolve commands and descriptions.
static final Property<Boolean>	LOCALIZE_COMMANDS
static final Property<Localizer>	LOCALIZER
static final Property<ClassFinder>	MERGED_CLASS_FINDER	An ClassFinder instance that is backed by all ClassFinder of CLASS_FINDER.
static final Property<MessageResolver>	MESSAGE_RESOLVER	The MessageResolver service provided byt JDA-Commands.
static final Property<Collection<Map.Entry<Priority, Middleware>>>	MIDDLEWARE	MIDDLEWARE property holds multiple Middlewares associated with their Priority
static final Property<Collection<String>>	PACKAGES
static final Property<PermissionsProvider>	PERMISSION_PROVIDER
static final Property<PlaceholderResolver>	PLACEHOLDER_RESOLVER	The PlaceholderResolver service provided by JDA-Commands.
static final Collection<Property<?>>	PROVIDED	A collection consisting of all Propertys that are provided by JDA-Commands
static final Property<String>	RUNTIME_ID	The identifier bound to this runtime.
static final Property<Boolean>	SHUTDOWN_JDA
static final Property<Collection<Resolver<String>>>	STRING_RESOLVER
static final Property<Map<AdapterType<?,?>, TypeAdapter<?,?>>>	TYPE_ADAPTER	The TYPE_ADAPTER property maps AdapterTypes containing the source and targets Types to their associated TypeAdapter
static final Collection<Property<?>>	USER_SETTABLE	A collection consisting of all Propertys that are settable by the user
static final Property<Map<Class<? extends Annotation>, Validator<?,?>>>	VALIDATOR	The VALIDATOR property maps a Validator to its identifying annotation.

Method Summary

Modifier and Type	Method	Description
Property.Category	category()	The category of the property defines the way a value for it can be provided.
Property.FallbackBehaviour	fallbackBehaviour()	Whether the fallback values provided by JDA-Commands should be accumulated together with other user provided PropertyProviders for this property.
String	name()	The name of the property is a user and machine-readable unique identifier for a property
Stage	stage()	The stage or "level" at which this property has a value set.

Field Details

CLASS_FINDER

@PropertyInformation(stage=CONFIGURATION,
                     category=LOADABLE,
                     fallbackBehaviour=OVERRIDE)
static final Property<Collection<ClassFinder>> CLASS_FINDER

See Also:

• JDACBuilder.classFinders(ClassFinder...)

EMOJI_SOURCES

@PropertyInformation(stage=CONFIGURATION,
                     category=LOADABLE,
                     fallbackBehaviour=OVERRIDE)
static final Property<Collection<EmojiSource>> EMOJI_SOURCES

See Also:

• JDACBuilder.emojiSource(EmojiSource...)

EMBED_SOURCES

@PropertyInformation(stage=CONFIGURATION,
                     category=LOADABLE,
                     fallbackBehaviour=ACCUMULATE)
static final Property<Collection<EmbedDataSource>> EMBED_SOURCES

See Also:

• EmbedConfig.sources(EmbedDataSource...)

DESCRIPTOR

@PropertyInformation(stage=CONFIGURATION,
                     category=LOADABLE)
static final Property<Descriptor> DESCRIPTOR

See Also:

• JDACBuilder.descriptor(Descriptor)

LOCALIZER

@PropertyInformation(stage=CONFIGURATION,
                     category=LOADABLE)
static final Property<Localizer> LOCALIZER

See Also:

• JDACBuilder.localizer(Localizer)

INSTANTIATOR

@PropertyInformation(stage=CONFIGURATION,
                     category=LOADABLE)
static final Property<Instantiator> INSTANTIATOR

See Also:

• JDACBuilder.instantiator(Instantiator)

MIDDLEWARE

@PropertyInformation(stage=CONFIGURATION,
                     category=LOADABLE,
                     fallbackBehaviour=ACCUMULATE)
static final Property<Collection<Map.Entry<Priority, Middleware>>> MIDDLEWARE

MIDDLEWARE property holds multiple Middlewares associated with their Priority

See Also:

• JDACBuilder.middleware(Priority, Middleware)

TYPE_ADAPTER

@PropertyInformation(stage=CONFIGURATION,
                     category=LOADABLE,
                     fallbackBehaviour=ACCUMULATE)
static final Property<Map<AdapterType<?,?>, TypeAdapter<?,?>>> TYPE_ADAPTER

The TYPE_ADAPTER property maps AdapterTypes containing the source and targets Types to their associated TypeAdapter

See Also:

• JDACBuilder.adapter(Class, Class, TypeAdapter)

VALIDATOR

@PropertyInformation(stage=CONFIGURATION,
                     category=LOADABLE,
                     fallbackBehaviour=ACCUMULATE)
static final Property<Map<Class<? extends Annotation>, Validator<?,?>>> VALIDATOR

The VALIDATOR property maps a Validator to its identifying annotation.

See Also:

• JDACBuilder.validator(Class, Validator)

PERMISSION_PROVIDER

@PropertyInformation(stage=CONFIGURATION,
                     category=LOADABLE)
static final Property<PermissionsProvider> PERMISSION_PROVIDER

See Also:

• JDACBuilder.permissionsProvider(PermissionsProvider)

ERROR_MESSAGE_FACTORY

@PropertyInformation(stage=CONFIGURATION,
                     category=LOADABLE)
static final Property<ErrorMessageFactory> ERROR_MESSAGE_FACTORY

See Also:

• JDACBuilder.errorMessageFactory(ErrorMessageFactory)

GUILD_SCOPE_PROVIDER

@PropertyInformation(stage=CONFIGURATION,
                     category=LOADABLE)
static final Property<GuildScopeProvider> GUILD_SCOPE_PROVIDER

See Also:

• JDACBuilder.guildScopeProvider(GuildScopeProvider)

STRING_RESOLVER

@PropertyInformation(stage=CONFIGURATION,
                     category=LOADABLE,
                     fallbackBehaviour=ACCUMULATE)
static final Property<Collection<Resolver<String>>> STRING_RESOLVER

See Also:

• JDACBuilder.stringResolver(Resolver...)

GLOBAL_COMMAND_CONFIG

@PropertyInformation(stage=CONFIGURATION,
                     category=USER_SETTABLE)
static final Property<CommandDefinition.CommandConfig> GLOBAL_COMMAND_CONFIG

See Also:

• JDACBuilder.globalCommandConfig(CommandDefinition.CommandConfig)

GLOBAL_REPLY_CONFIG

@PropertyInformation(stage=CONFIGURATION,
                     category=USER_SETTABLE)
static final Property<InteractionDefinition.ReplyConfig> GLOBAL_REPLY_CONFIG

See Also:

• JDACBuilder.globalReplyConfig(ReplyConfig)

PACKAGES

@PropertyInformation(stage=CONFIGURATION,
                     category=USER_SETTABLE,
                     fallbackBehaviour=ACCUMULATE)
static final Property<Collection<String>> PACKAGES

See Also:

• JDACBuilder.packages(String...)

EXPIRATION_STRATEGY

@PropertyInformation(stage=CONFIGURATION,
                     category=USER_SETTABLE)
static final Property<ExpirationStrategy> EXPIRATION_STRATEGY

See Also:

• JDACBuilder.expirationStrategy(ExpirationStrategy)

LOCALIZE_COMMANDS

@PropertyInformation(stage=CONFIGURATION,
                     category=USER_SETTABLE)
static final Property<Boolean> LOCALIZE_COMMANDS

See Also:

• JDACBuilder.localizeCommands(boolean)

SHUTDOWN_JDA

@PropertyInformation(stage=CONFIGURATION,
                     category=USER_SETTABLE)
static final Property<Boolean> SHUTDOWN_JDA

See Also:

• JDACBuilder.shutdownJDA(boolean)

EXTENSION_DATA

@PropertyInformation(stage=CONFIGURATION,
                     category=USER_SETTABLE,
                     fallbackBehaviour=ACCUMULATE)
static final Property<Map<Class<? extends Extension.Data>, Extension.Data>> EXTENSION_DATA

See Also:

• JDACBuilder.extensionData(Extension.Data...)

EXTENSION_FILTER

@PropertyInformation(stage=CONFIGURATION,
                     category=USER_SETTABLE)
static final Property<ExtensionFilter> EXTENSION_FILTER

See Also:

• JDACBuilder.filterExtensions(ExtensionFilter.FilterStrategy, String...)

EMBED_CONFIG

@PropertyInformation(stage=CONFIGURATION,
                     category=USER_SETTABLE)
static final Property<Consumer<EmbedConfig>> EMBED_CONFIG

See Also:

• JDACBuilder.embeds(Consumer)

INTROSPECTION

@PropertyInformation(stage=CONFIGURATION,
                     category=PROVIDED)
static final Property<Introspection> INTROSPECTION

The Introspection instance itself used to retrieve properties in this scope. Can also be used to retrieve the used Introspection instance via PropertyProvider.Context.get(Property). (which will have stage = Stage.CONFIGURATION)

I18N

@PropertyInformation(stage=CONFIGURATION,
                     category=PROVIDED)
static final Property<I18n> I18N

The I18n service provided by JDA-Commands. Needs the values of DESCRIPTOR and LOCALIZER.

Implementation Note:

the PropertyProvider for this value is defined in the constructor of JDACBuilder

LOCALIZATION_FUNCTION

@PropertyInformation(stage=CONFIGURATION,
                     category=PROVIDED)
static final Property<net.dv8tion.jda.api.interactions.commands.localization.LocalizationFunction> LOCALIZATION_FUNCTION

The LocalizationFunction backed by MessageResolver used to localize/resolve commands and descriptions.

See Also:

• LocalizationFunction

MESSAGE_RESOLVER

@PropertyInformation(stage=CONFIGURATION,
                     category=PROVIDED)
static final Property<MessageResolver> MESSAGE_RESOLVER

The MessageResolver service provided byt JDA-Commands. Needs the values of I18N and EMOJI_RESOLVER.

Implementation Note:

the PropertyProvider for this value is defined in the constructor of JDACBuilder

EMOJI_RESOLVER

@PropertyInformation(stage=CONFIGURATION,
                     category=PROVIDED)
static final Property<EmojiResolver> EMOJI_RESOLVER

The EmojiResolver service provided by JDA-Commands. Needs the value of EMOJI_RESOLVER.

Implementation Note:

the PropertyProvider for this value is defined in the constructor of JDACBuilder

PLACEHOLDER_RESOLVER

@PropertyInformation(stage=CONFIGURATION,
                     category=PROVIDED)
static final Property<PlaceholderResolver> PLACEHOLDER_RESOLVER

The PlaceholderResolver service provided by JDA-Commands.

Implementation Note:

the PropertyProvider for this value is defined in the constructor of JDACBuilder

MERGED_CLASS_FINDER

@PropertyInformation(stage=CONFIGURATION,
                     category=PROVIDED)
static final Property<ClassFinder> MERGED_CLASS_FINDER

An ClassFinder instance that is backed by all ClassFinder of CLASS_FINDER. It will search in all registered ClassFinder for the requested class.

Implementation Note:

the PropertyProvider for this value is defined in the constructor of JDACBuilder

JDA_COMMANDS

@PropertyInformation(stage=INITIALIZED,
                     category=PROVIDED)
static final Property<JDACommands> JDA_COMMANDS

The JDACommands instance available after fully starting the framework.

DEFINITIONS

@PropertyInformation(stage=INITIALIZED,
                     category=PROVIDED)
static final Property<Definitions> DEFINITIONS

The Definitions instance available after fully starting the framework.

JDA

@PropertyInformation(stage=RUNTIME,
                     category=PROVIDED)
static final Property<net.dv8tion.jda.api.JDA> JDA

The JDA instance bound to this specific Runtime.

RUNTIME_ID

@PropertyInformation(stage=RUNTIME,
                     category=PROVIDED)
static final Property<String> RUNTIME_ID

The identifier bound to this runtime. Same as Event.runtimeId().

KEY_VALUE_STORE

@PropertyInformation(stage=RUNTIME,
                     category=PROVIDED)
static final Property<KeyValueStore> KEY_VALUE_STORE

The KeyValueStore associated with this runtime. Same as InvocationContext.keyValueStore() or Event.kv().

JDA_EVENT

@PropertyInformation(stage=PREPARATION,
                     category=PROVIDED)
static final Property<net.dv8tion.jda.api.events.interaction.GenericInteractionCreateEvent> JDA_EVENT

The GenericInteractionCreateEvent of this interaction. Same as Event.jdaEvent().

INVOCATION_CONTEXT

@PropertyInformation(stage=INTERACTION,
                     category=PROVIDED)
static final Property<InvocationContext<?>> INVOCATION_CONTEXT

The InvocationContext of this interaction. Same as in Middleware.accept(InvocationContext).

LOADABLE

static final Collection<Property<?>> LOADABLE

A collection consisting of all Propertys that are settable by the user and loadable through extensions

See Also:

• Property.Category.LOADABLE

USER_SETTABLE

static final Collection<Property<?>> USER_SETTABLE

A collection consisting of all Propertys that are settable by the user

See Also:

• Property.Category.USER_SETTABLE

PROVIDED

static final Collection<Property<?>> PROVIDED

A collection consisting of all Propertys that are provided by JDA-Commands

See Also:

• Property.Category.PROVIDED

Method Details

fallbackBehaviour

Property.FallbackBehaviour fallbackBehaviour()

Whether the fallback values provided by JDA-Commands should be accumulated together with other user provided PropertyProviders for this property.

Returns:

the fallback behaviour

name

String name()

The name of the property is a user and machine-readable unique identifier for a property

Returns:

the name of the property

category

Property.Category category()

The category of the property defines the way a value for it can be provided.

Returns:

the category of the property

stage

Stage stage()

The stage or "level" at which this property has a value set.