Kaktushose · Kaktushose · Jan 5, 2025 · Dec 23, 2024 · Dec 25, 2024 · Dec 25, 2024
diff --git a/pom.xml b/pom.xml
@@ -43,6 +43,23 @@
                         <link>https://javadoc.io/doc/net.dv8tion/JDA/5.0.2</link>
                     </links>
                     <docfilessubdirs>true</docfilessubdirs>
+                    <tags>
+                        <tag>
+                            <name>apiNote</name>
+                            <placement>a</placement>
+                            <head>API Note:</head>
+                        </tag>
+                        <tag>
+                            <name>implSpec</name>
+                            <placement>a</placement>
+                            <head>Implementation Requirements:</head>
+                        </tag>
+                        <tag>
+                            <name>implNote</name>
+                            <placement>a</placement>
+                            <head>Implementation Note:</head>
+                        </tag>
+                    </tags>
                 </configuration>
             </plugin>
             <plugin>

diff --git a/src/main/java/com/github/kaktushose/jda/commands/JDACommands.java b/src/main/java/com/github/kaktushose/jda/commands/JDACommands.java
@@ -2,12 +2,18 @@
 
 import com.github.kaktushose.jda.commands.annotations.interactions.EntitySelectMenu;
 import com.github.kaktushose.jda.commands.annotations.interactions.StringSelectMenu;
+import com.github.kaktushose.jda.commands.definitions.description.reflective.ReflectiveClassFinder;
+import com.github.kaktushose.jda.commands.definitions.description.reflective.ReflectiveDescriptor;
+import com.github.kaktushose.jda.commands.definitions.interactions.CustomId;
+import com.github.kaktushose.jda.commands.definitions.interactions.InteractionRegistry;
+import com.github.kaktushose.jda.commands.definitions.interactions.component.ButtonDefinition;
+import com.github.kaktushose.jda.commands.definitions.interactions.component.menu.SelectMenuDefinition;
 import com.github.kaktushose.jda.commands.dependency.DefaultDependencyInjector;
 import com.github.kaktushose.jda.commands.dependency.DependencyInjector;
-import com.github.kaktushose.jda.commands.dispatching.ExpirationStrategy;
-import com.github.kaktushose.jda.commands.dispatching.internal.JDAEventListener;
-import com.github.kaktushose.jda.commands.dispatching.internal.Runtime;
+import com.github.kaktushose.jda.commands.dispatching.ImplementationRegistry;
+import com.github.kaktushose.jda.commands.dispatching.JDAEventListener;
 import com.github.kaktushose.jda.commands.dispatching.adapter.TypeAdapterRegistry;
+import com.github.kaktushose.jda.commands.dispatching.expiration.ExpirationStrategy;
 import com.github.kaktushose.jda.commands.dispatching.handling.DispatchingContext;
 import com.github.kaktushose.jda.commands.dispatching.middleware.MiddlewareRegistry;
 import com.github.kaktushose.jda.commands.dispatching.middleware.Priority;
@@ -17,10 +23,6 @@
 import com.github.kaktushose.jda.commands.dispatching.validation.ValidatorRegistry;
 import com.github.kaktushose.jda.commands.internal.JDAContext;
 import com.github.kaktushose.jda.commands.internal.register.SlashCommandUpdater;
-import com.github.kaktushose.jda.commands.reflect.ImplementationRegistry;
-import com.github.kaktushose.jda.commands.reflect.InteractionRegistry;
-import com.github.kaktushose.jda.commands.reflect.interactions.components.ButtonDefinition;
-import com.github.kaktushose.jda.commands.reflect.interactions.components.menus.GenericSelectMenuDefinition;
 import net.dv8tion.jda.api.JDA;
 import net.dv8tion.jda.api.interactions.commands.localization.LocalizationFunction;
 import net.dv8tion.jda.api.interactions.commands.localization.ResourceBundleLocalizationFunction;
@@ -39,7 +41,7 @@ public record JDACommands(
         TypeAdapterRegistry adapterRegistry,
         ValidatorRegistry validatorRegistry,
         DependencyInjector dependencyInjector,
-        InteractionRegistry interactionRegistry,
+        InteractionRegistry registry,
         SlashCommandUpdater updater) {
     private static final Logger log = LoggerFactory.getLogger(JDACommands.class);
 
@@ -53,7 +55,7 @@ private static JDACommands startInternal(Object jda, Class<?> clazz, Localizatio
         var adapterRegistry = new TypeAdapterRegistry();
         var validatorRegistry = new ValidatorRegistry();
         var implementationRegistry = new ImplementationRegistry(dependencyInjector, middlewareRegistry, adapterRegistry, validatorRegistry);
-        var interactionRegistry = new InteractionRegistry(validatorRegistry, dependencyInjector, function);
+        var interactionRegistry = new InteractionRegistry(dependencyInjector, validatorRegistry, function, new ReflectiveDescriptor());
 
         middlewareRegistry.register(Priority.PERMISSIONS, new PermissionsMiddleware(implementationRegistry));
         middlewareRegistry.register(Priority.NORMAL, new ConstraintMiddleware(implementationRegistry), new CooldownMiddleware(implementationRegistry));
@@ -62,7 +64,7 @@ private static JDACommands startInternal(Object jda, Class<?> clazz, Localizatio
 
         implementationRegistry.index(clazz, packages);
 
-        interactionRegistry.index(clazz, packages);
+        interactionRegistry.index(ReflectiveClassFinder.find(clazz, packages));
 
         var updater = new SlashCommandUpdater(jdaContext, implementationRegistry.getGuildScopeProvider(), interactionRegistry);
         updater.updateAllCommands();
@@ -188,38 +190,22 @@ public void updateGuildCommands() {
     /// @return the JDA [Button]
     @NotNull
     public Button getButton(@NotNull String button) {
-        if (!button.matches("[a-zA-Z]+\\.[a-zA-Z]+")) {
-            throw new IllegalArgumentException("Unknown Button");
-        }
-
-        String sanitizedId = button.replaceAll("\\.", "");
-        ButtonDefinition buttonDefinition = interactionRegistry.getButtons().stream()
-                .filter(it -> it.getDefinitionId().equals(sanitizedId))
-                .findFirst().orElseThrow(() -> new IllegalArgumentException("Unknown Button"));
-
-        return buttonDefinition.toButton().withId(buttonDefinition.independentCustomId());
+        var id = String.valueOf(button.replaceAll("\\.", "").hashCode());
+        var definition = registry.find(ButtonDefinition.class, false, it -> it.definitionId().equals(id));
+        return definition.toJDAEntity(CustomId.independent(definition.definitionId()));
     }
 
     /// Gets a [StringSelectMenu] or [EntitySelectMenu] based on the method name and transforms it into a JDA [SelectMenu].
     ///
     /// The select menu will be [`Runtime`]({@docRoot}/index.html#runtime-concept-heading) independent. This may be useful if you want to send a component
     /// without using the framework.
     ///
-    /// @param <S>  the type of [SelectMenu]
     /// @param menu the name of the select menu
     /// @return the JDA [SelectMenu]
-    @SuppressWarnings("unchecked")
     @NotNull
-    public <S extends SelectMenu> S getSelectMenu(@NotNull String menu) {
-        if (!menu.matches("[a-zA-Z]+\\.[a-zA-Z]+")) {
-            throw new IllegalArgumentException("Unknown Select Menu");
-        }
-
-        String sanitizedId = menu.replaceAll("\\.", "");
-        GenericSelectMenuDefinition<?> selectMenuDefinition = interactionRegistry.getSelectMenus().stream()
-                .filter(it -> it.getDefinitionId().equals(sanitizedId))
-                .findFirst().orElseThrow(() -> new IllegalArgumentException("Unknown Select Menu"));
-
-        return (S) selectMenuDefinition.toSelectMenu(selectMenuDefinition.independentCustomId(), true);
+    public SelectMenu getSelectMenu(@NotNull String menu) {
+        var id = String.valueOf(menu.replaceAll("\\.", "").hashCode());
+        var definition = registry.find(SelectMenuDefinition.class, false, it -> it.definitionId().equals(id));
+        return (SelectMenu) definition.toJDAEntity(CustomId.independent(definition.definitionId()));
     }
 }
diff --git a/src/main/java/com/github/kaktushose/jda/commands/annotations/Implementation.java b/src/main/java/com/github/kaktushose/jda/commands/annotations/Implementation.java
@@ -1,46 +1,38 @@
 package com.github.kaktushose.jda.commands.annotations;
 
 import com.github.kaktushose.jda.commands.annotations.constraints.Constraint;
+import com.github.kaktushose.jda.commands.dispatching.ImplementationRegistry;
+import com.github.kaktushose.jda.commands.dispatching.middleware.Middleware;
 import com.github.kaktushose.jda.commands.dispatching.middleware.Priority;
+import com.github.kaktushose.jda.commands.dispatching.validation.Validator;
 import com.github.kaktushose.jda.commands.embeds.error.ErrorMessageFactory;
 
 import java.lang.annotation.*;
 
-/**
- * Indicates that the annotated class is a custom implementation that should replace the default implementation.
- *
- * @see com.github.kaktushose.jda.commands.reflect.ImplementationRegistry ImplementationRegistry
- * @see com.github.kaktushose.jda.commands.dispatching.middleware.Middleware Middleware
- * @see com.github.kaktushose.jda.commands.dispatching.validation.Validator Validator
- * @see com.github.kaktushose.jda.commands.dispatching.adapter.TypeAdapter TypeAdapter
- * @see com.github.kaktushose.jda.commands.permissions.PermissionsProvider PermissionsProvider
- * @see com.github.kaktushose.jda.commands.scope.GuildScopeProvider GuildScopeProvider
- * @see ErrorMessageFactory ErrorMessageFactory
- * @since 2.0.0
- */
+/// Indicates that the annotated class is a custom implementation that should replace the default implementation.
+///
+/// @see ImplementationRegistry ImplementationRegistry
+/// @see Middleware Middleware
+/// @see Validator Validator
+/// @see com.github.kaktushose.jda.commands.dispatching.adapter.TypeAdapter TypeAdapter
+/// @see com.github.kaktushose.jda.commands.permissions.PermissionsProvider PermissionsProvider
+/// @see com.github.kaktushose.jda.commands.scope.GuildScopeProvider GuildScopeProvider
+/// @see ErrorMessageFactory ErrorMessageFactory
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
 public @interface Implementation {
 
-    /**
-     * Gets the {@link Priority} to register the
-     * {@link com.github.kaktushose.jda.commands.dispatching.middleware.Middleware Middleware} with. If this
-     * implementation is not a subtype
-     * of {@link com.github.kaktushose.jda.commands.dispatching.middleware.Middleware Middleware}, this field can be
-     * ignored.
-     *
-     * @return the {@link Priority}
-     */
+    /// Gets the [Priority] to register the [Middleware] with. If this implementation is not a subtype of [Middleware],
+    /// this field can be ignored.
+    ///
+    /// @return the [Priority]
     Priority priority() default Priority.NORMAL;
 
-    /**
-     * Gets the annotation the {@link com.github.kaktushose.jda.commands.dispatching.validation.Validator Validator}
-     * should be mapped to. If this class is not a subtype of
-     * {@link com.github.kaktushose.jda.commands.dispatching.validation.Validator Validator}, this field can be ignored.
-     *
-     * @return the annotation the {@link com.github.kaktushose.jda.commands.dispatching.validation.Validator Validator}
-     * should be mapped to
-     */
+    /// Gets the annotation the [Validator] should be mapped to. If this class is not a subtype of [Validator],
+    /// this field can be ignored.
+    ///
+    /// @return the annotation the [Validator]
+    /// should be mapped to
     Class<? extends Annotation> annotation() default Constraint.class;
 
 }
diff --git a/src/main/java/com/github/kaktushose/jda/commands/annotations/Inject.java b/src/main/java/com/github/kaktushose/jda/commands/annotations/Inject.java
@@ -5,14 +5,11 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
-/**
- * Fields annotated with Inject will be assigned a value that is provided by a {@link Produces} method.
- * If no Producer for the field type is available then the field will be assigned {@code null}. Please note, that each
- * field type can only have one producer.
- *
- * @see Produces
- * @since 1.0.0
- */
+/// Fields annotated with Inject will be assigned a value that is provided by a [Produces] method.
+/// If no Producer for the field type is available then the field will be assigned `null`. Please note, that each
+/// field type can only have one producer.
+///
+/// @see Produces
 @Target(ElementType.FIELD)
 @Retention(RetentionPolicy.RUNTIME)
 public @interface Inject {

diff --git a/src/main/java/com/github/kaktushose/jda/commands/annotations/Produces.java b/src/main/java/com/github/kaktushose/jda/commands/annotations/Produces.java
@@ -1,42 +1,37 @@
 package com.github.kaktushose.jda.commands.annotations;
 
+import com.github.kaktushose.jda.commands.annotations.interactions.Interaction;
+import com.github.kaktushose.jda.commands.dependency.DependencyInjector;
+
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
-/**
- * Methods annotated with Produces will be used to get the instance of a dependency.
- *
- * <p>The instances provided by producer methods are used to inject values to the fields inside a
- * {@link com.github.kaktushose.jda.commands.annotations.interactions.Interaction Interaction}
- * that are annotated with {@link Inject}. The access modifier of a producer method must be
- * public.
- *
- * <p>Classes containing producer methods will be found automatically on startup. They can also be registered via
- * {@link com.github.kaktushose.jda.commands.dependency.DependencyInjector#registerProvider(Object)
- * DependencyInjector.registerProvider(Object)}
- *
- * <p>Please note that this is only a very basic implementation of dependency injection and can only be used inside
- * interaction controller classes or custom {@link Implementation implementations}. Furthermore, each type can only
- * have one producer. In other words you cannot register different instances of the same dependency.
- *
- * @see Inject
- * @see com.github.kaktushose.jda.commands.dependency.DependencyInjector DependencyInjector
- * @since 1.0.0
- */
+/// Methods annotated with Produces will be used to get the instance of a dependency.
+///
+/// The instances provided by producer methods are used to inject values to the fields inside a [Interaction]
+/// that are annotated with [Inject]. The access modifier of a producer method must be
+/// public.
+///
+/// Classes containing producer methods will be found automatically on startup. They can also be registered via
+/// [DependencyInjector#registerProvider(Object)]
+///
+/// Please note that this is only a very basic implementation of dependency injection and can only be used inside
+/// interaction controller classes or custom [Implementation]s. Furthermore, each type can only
+/// have one producer. In other words you cannot register different instances of the same dependency.
+///
+/// @see Inject
+/// @see com.github.kaktushose.jda.commands.dependency.DependencyInjector DependencyInjector
 @Target(ElementType.METHOD)
 @Retention(RetentionPolicy.RUNTIME)
 public @interface Produces {
 
-    /**
-     * Whether jda-commands should ignore this method at indexing during startup. Useful if you wish to register your
-     * dependency providers manually by calling
-     * {@link com.github.kaktushose.jda.commands.dependency.DependencyInjector#registerProvider(Object)
-     * DependencyInjector#registerProvider(Object)}
-     *
-     * @return Whether jda-commands should ignore this method, default {@code true}
-     */
+    /// Whether jda-commands should ignore this method at indexing during startup. Useful if you wish to register your
+    /// dependency providers manually by calling
+    /// [DependencyInjector#registerProvider(Object)]
+    ///
+    /// @return Whether jda-commands should ignore this method, default `true`
     boolean skipIndexing() default false;
 
 }
diff --git a/src/main/java/com/github/kaktushose/jda/commands/annotations/constraints/Constraint.java b/src/main/java/com/github/kaktushose/jda/commands/annotations/constraints/Constraint.java
@@ -5,21 +5,16 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
-/**
- * Indicates that an annotation type can be used for parameter validation. When implementing custom validators, the
- * annotation type must be annotated with this annotation.
- *
- * @see com.github.kaktushose.jda.commands.dispatching.validation.ValidatorRegistry ValidatorRegistry
- * @since 2.0.0
- */
+/// Indicates that an annotation type can be used for parameter validation. When implementing custom validators, the
+/// annotation type must be annotated with this annotation.
+///
+/// @see com.github.kaktushose.jda.commands.dispatching.validation.ValidatorRegistry ValidatorRegistry
 @Target(ElementType.ANNOTATION_TYPE)
 @Retention(RetentionPolicy.RUNTIME)
 public @interface Constraint {
 
-    /**
-     * Returns an array of all types this annotation can be used for.
-     *
-     * @return an array of all types this annotation can be used for
-     */
+    /// Returns an array of all types this annotation can be used for.
+    ///
+    /// @return an array of all types this annotation can be used for
     Class<?>[] value();
 }
diff --git a/src/main/java/com/github/kaktushose/jda/commands/annotations/constraints/Max.java b/src/main/java/com/github/kaktushose/jda/commands/annotations/constraints/Max.java
@@ -5,28 +5,21 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
-/**
- * The annotated element must be a number whose value must be lower or equal to the specified maximum.
- *
- * @see Constraint
- * @since 2.0.0
- */
+/// The annotated element must be a number whose value must be lower or equal to the specified maximum.
+///
+/// @see Constraint
 @Target(ElementType.PARAMETER)
 @Retention(RetentionPolicy.RUNTIME)
 @Constraint({Byte.class, Short.class, Integer.class, Long.class, Float.class, Double.class})
 public @interface Max {
 
-    /**
-     * Returns the value the element must be lower or equal to.
-     *
-     * @return Returns the value the element must be lower or equal to
-     */
+    /// Returns the value the element must be less or equal to.
+    ///
+    /// @return Returns the value the element must be less or equal to
     long value();
 
-    /**
-     * Returns the error message that will be displayed if the constraint fails.
-     *
-     * @return the error message
-     */
+    /// Returns the error message that will be displayed if the constraint fails.
+    ///
+    /// @return the error message
     String message() default "Parameter exceeds maximum value";
 }
diff --git a/src/main/java/com/github/kaktushose/jda/commands/annotations/constraints/Min.java b/src/main/java/com/github/kaktushose/jda/commands/annotations/constraints/Min.java
@@ -5,28 +5,21 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
-/**
- * The annotated element must be a number whose value must be greater or equal to the specified minimum.
- *
- * @see Constraint
- * @since 2.0.0
- */
+/// The annotated element must be a number whose value must be greater or equal to the specified minimum.
+///
+/// @see Constraint
 @Target(ElementType.PARAMETER)
 @Retention(RetentionPolicy.RUNTIME)
 @Constraint({Byte.class, Short.class, Integer.class, Long.class, Float.class, Double.class})
 public @interface Min {
 
-    /**
-     * Returns the value the element must be greater or equal to.
-     *
-     * @return Returns the value the element must be greater or equal to
-     */
+    /// Returns the value the element must be greater or equal to.
+    ///
+    /// @return Returns the value the element must be greater or equal to
     long value();
 
-    /**
-     * Returns the error message that will be displayed if the constraint fails.
-     *
-     * @return the error message
-     */
+    /// Returns the error message that will be displayed if the constraint fails.
+    ///
+    /// @return the error message
     String message() default "Parameter falls below minimum value";
 }