Interface JDACProperty<T>

All Superinterfaces:

SpecificProperty<T>

All Known Implementing Classes:

JDACEnumerationProperty, JDACMappingProperty, JDACSingletonProperty

public interface JDACProperty<T>
extends SpecificProperty<T>

A JDACProperty is an identifier for a certain component of a JDA-Commands.

A JDA-Commands component is just some sort of arbitrary information. That could be some service like MessageResolver, some setting configured by the user via a builder (like JDACBuilder.localizeCommands(boolean)), a custom implementation of an interface (like Instantiator) or something else.

There are basically 3 types of properties:

• Singleton for values consisting of one instance
• Enumeration for values consisting of multiple instances (reference to Collection)
• Mapping for values representing a mapping between keys and values (reference to Map)

Beside their purpose, each type hold a slightly different set of information, but they share some common values: - a unique name - a scope to which this property is bound - a source, from which the values of this property can be retrieved.

See Also:

• JDACIntrospection
• Property
• SpecificProperty

Field Summary

Fields

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

Method Summary

Methods inherited from interface SpecificProperty

generalized, scopedGet

Field Details

CLASS_FINDER

@PropertyInformation(scope=CONFIGURATION,
                     source=EXTENSION,
                     fallbackBehaviour=IGNORE)
static final JDACProperty<Collection<ClassFinder>> CLASS_FINDER

See Also:

• JDACBuilder.classFinders(ClassFinder...)

EMOJI_SOURCES

@PropertyInformation(scope=CONFIGURATION,
                     source=EXTENSION,
                     fallbackBehaviour=IGNORE)
static final JDACProperty<Collection<EmojiSource>> EMOJI_SOURCES

See Also:

• JDACBuilder.emojiSource(EmojiSource...)

EMBED_SOURCES

@PropertyInformation(scope=CONFIGURATION,
                     source=EXTENSION,
                     fallbackBehaviour=COMBINE)
static final JDACProperty<Collection<EmbedDataSource>> EMBED_SOURCES

See Also:

• EmbedConfig.sources(EmbedDataSource...)

DESCRIPTOR

@PropertyInformation(scope=CONFIGURATION,
                     source=EXTENSION)
static final JDACProperty<Descriptor> DESCRIPTOR

See Also:

• JDACBuilder.descriptor(Descriptor)

LOCALIZER

@PropertyInformation(scope=CONFIGURATION,
                     source=EXTENSION)
static final JDACProperty<Localizer> LOCALIZER

See Also:

• JDACBuilder.localizer(Localizer)

INSTANTIATOR

@PropertyInformation(scope=CONFIGURATION,
                     source=EXTENSION)
static final JDACProperty<Instantiator> INSTANTIATOR

See Also:

• JDACBuilder.instantiator(Instantiator)

MIDDLEWARE

@PropertyInformation(scope=CONFIGURATION,
                     source=EXTENSION,
                     fallbackBehaviour=COMBINE)
static final JDACProperty<Collection<Map.Entry<Priority, Middleware>>> MIDDLEWARE

MIDDLEWARE property holds multiple Middlewares associated with their Priority

See Also:

• JDACBuilder.middleware(Priority, Middleware)

TYPE_ADAPTER

@PropertyInformation(scope=CONFIGURATION,
                     source=EXTENSION,
                     fallbackBehaviour=COMBINE)
static final JDACProperty<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(scope=CONFIGURATION,
                     source=EXTENSION,
                     fallbackBehaviour=COMBINE)
static final JDACProperty<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(scope=CONFIGURATION,
                     source=EXTENSION)
static final JDACProperty<PermissionsProvider> PERMISSION_PROVIDER

See Also:

• JDACBuilder.permissionsProvider(PermissionsProvider)

ERROR_MESSAGE_FACTORY

@PropertyInformation(scope=CONFIGURATION,
                     source=EXTENSION)
static final JDACProperty<ErrorMessageFactory> ERROR_MESSAGE_FACTORY

See Also:

• JDACBuilder.errorMessageFactory(ErrorMessageFactory)

GUILD_SCOPE_PROVIDER

@PropertyInformation(scope=CONFIGURATION,
                     source=EXTENSION)
static final JDACProperty<GuildScopeProvider> GUILD_SCOPE_PROVIDER

See Also:

• JDACBuilder.guildScopeProvider(GuildScopeProvider)

STRING_RESOLVER

@PropertyInformation(scope=CONFIGURATION,
                     source=EXTENSION,
                     fallbackBehaviour=COMBINE)
static final JDACProperty<Collection<Resolver<String>>> STRING_RESOLVER

See Also:

• JDACBuilder.stringResolver(Resolver...)

GLOBAL_COMMAND_CONFIG

@PropertyInformation(scope=CONFIGURATION,
                     source=BUILDER)
static final JDACProperty<CommandDefinition.CommandConfig> GLOBAL_COMMAND_CONFIG

See Also:

• JDACBuilder.globalCommandConfig(CommandDefinition.CommandConfig)

GLOBAL_REPLY_CONFIG

@PropertyInformation(scope=CONFIGURATION,
                     source=BUILDER)
static final JDACProperty<InteractionDefinition.ReplyConfig> GLOBAL_REPLY_CONFIG

See Also:

• JDACBuilder.globalReplyConfig(InteractionDefinition.ReplyConfig)

PACKAGES

@PropertyInformation(scope=CONFIGURATION,
                     source=BUILDER,
                     fallbackBehaviour=COMBINE)
static final JDACProperty<Collection<String>> PACKAGES

See Also:

• JDACBuilder.packages(String...)

EXPIRATION_STRATEGY

@PropertyInformation(scope=CONFIGURATION,
                     source=BUILDER)
static final JDACProperty<ExpirationStrategy> EXPIRATION_STRATEGY

See Also:

• JDACBuilder.expirationStrategy(ExpirationStrategy)

LOCALIZE_COMMANDS

@PropertyInformation(scope=CONFIGURATION,
                     source=BUILDER)
static final JDACProperty<Boolean> LOCALIZE_COMMANDS

See Also:

• JDACBuilder.localizeCommands(boolean)

SHUTDOWN_JDA

@PropertyInformation(scope=CONFIGURATION,
                     source=BUILDER)
static final JDACProperty<Boolean> SHUTDOWN_JDA

See Also:

• JDACBuilder.shutdownJDA(boolean)

EXTENSION_DATA

@PropertyInformation(scope=CONFIGURATION,
                     source=BUILDER,
                     fallbackBehaviour=COMBINE)
static final JDACProperty<Map<Class<? extends Extension.Data>, Extension.Data>> EXTENSION_DATA

See Also:

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

EXTENSION_FILTER

@PropertyInformation(scope=CONFIGURATION,
                     source=BUILDER)
static final JDACProperty<ExtensionFilter> EXTENSION_FILTER

See Also:

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

EMBED_CONFIG

@PropertyInformation(scope=CONFIGURATION,
                     source=BUILDER)
static final JDACProperty<Consumer<EmbedConfig>> EMBED_CONFIG

See Also:

• JDACBuilder.embeds(Consumer)

INTROSPECTION

@PropertyInformation(scope=CONFIGURATION,
                     source=PROVIDED)
static final JDACProperty<JDACIntrospection> INTROSPECTION

The JDACIntrospection instance itself used to retrieve properties in this scope.

I18N

@PropertyInformation(scope=CONFIGURATION,
                     source=PROVIDED)
static final JDACProperty<I18n> I18N

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

Implementation Note:

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

MESSAGE_RESOLVER

@PropertyInformation(scope=CONFIGURATION,
                     source=PROVIDED)
static final JDACProperty<MessageResolver> MESSAGE_RESOLVER

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

Implementation Note:

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

EMOJI_RESOLVER

@PropertyInformation(scope=CONFIGURATION,
                     source=PROVIDED)
static final JDACProperty<EmojiResolver> EMOJI_RESOLVER

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

Implementation Note:

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

PLACEHOLDER_RESOLVER

@PropertyInformation(scope=CONFIGURATION,
                     source=PROVIDED)
static final JDACProperty<PlaceholderResolver> PLACEHOLDER_RESOLVER

The PlaceholderResolver service provided by JDA-Commands.

Implementation Note:

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

MERGED_CLASS_FINDER

@PropertyInformation(scope=CONFIGURATION,
                     source=PROVIDED)
static final JDACProperty<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 JDACPropertyProvider for this value is defined in the constructor of JDACBuilder

JDA_COMMANDS

@PropertyInformation(scope=INITIALIZED,
                     source=PROVIDED)
static final JDACProperty<JDACommands> JDA_COMMANDS

The JDACommands instance available after fully starting the framework.

DEFINITIONS

@PropertyInformation(scope=INITIALIZED,
                     source=PROVIDED)
static final JDACProperty<Definitions> DEFINITIONS

The Definitions instance available after fully starting the framework.

LOCALIZATION_FUNCTION

@PropertyInformation(scope=INITIALIZED,
                     source=PROVIDED)
static final JDACProperty<LocalizationFunction> LOCALIZATION_FUNCTION

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

See Also:

• LocalizationFunction

JDA

@PropertyInformation(scope=RUNTIME,
                     source=PROVIDED)
static final JDACProperty<JDA> JDA

The JDA instance bound to this specific Runtime.

RUNTIME_ID

@PropertyInformation(scope=RUNTIME,
                     source=PROVIDED)
static final JDACProperty<String> RUNTIME_ID

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

KEY_VALUE_STORE

@PropertyInformation(scope=RUNTIME,
                     source=PROVIDED)
static final JDACProperty<KeyValueStore> KEY_VALUE_STORE

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

JDA_EVENT

@PropertyInformation(scope=PREPARATION,
                     source=PROVIDED)
static final JDACProperty<GenericInteractionCreateEvent> JDA_EVENT

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

INVOCATION_CONTEXT

@PropertyInformation(scope=INTERACTION,
                     source=PROVIDED)
static final JDACProperty<InvocationContext<?>> INVOCATION_CONTEXT

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

EXTENSION

static final Collection<JDACProperty<?>> EXTENSION

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

See Also:

• Property.Source.EXTENSION

BUILDER

static final Collection<JDACProperty<?>> BUILDER

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

See Also:

• Property.Source.BUILDER

PROVIDED

static final Collection<JDACProperty<?>> PROVIDED

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

See Also:

• Property.Source.PROVIDED