rename InteractionControllerInstantiator to Instantiator

Author: Kaktushose

core/src/main/java/io/github/kaktushose/jdac/JDACBuilder.java

@@ -15,7 +15,7 @@
 import io.github.kaktushose.jdac.dispatching.adapter.TypeAdapter;
 import io.github.kaktushose.jdac.dispatching.adapter.internal.TypeAdapters;
 import io.github.kaktushose.jdac.dispatching.expiration.ExpirationStrategy;
-import io.github.kaktushose.jdac.dispatching.instance.InteractionControllerInstantiator;
+import io.github.kaktushose.jdac.dispatching.instance.Instantiator;
 import io.github.kaktushose.jdac.dispatching.middleware.Middleware;
 import io.github.kaktushose.jdac.dispatching.middleware.Priority;
 import io.github.kaktushose.jdac.dispatching.middleware.internal.Middlewares;
@@ -73,7 +73,7 @@
 ///
 /// - [#descriptor(Descriptor)]
 /// - [#classFinders(ClassFinder...)]
-/// - [#instanceProvider(InteractionControllerInstantiator)]
+/// - [#instantiator(Instantiator)]
 ///
 ///
 /// In addition to manually configuring this builder, you can also provide implementations of [Extension] trough Javas [`service
@@ -233,9 +233,9 @@ public JDACBuilder localizer(Localizer localizer) {
         return addUserProperty(LOCALIZER, _ -> localizer);
     }
 
-    /// @param instanceProvider the implementation of [InteractionControllerInstantiator] to use
-    public JDACBuilder instanceProvider(InteractionControllerInstantiator instanceProvider) {
-        return addUserProperty(INTERACTION_CONTROLLER_INSTANTIATOR, _ -> instanceProvider);
+    /// @param instantiator the implementation of [Instantiator] to use
+    public JDACBuilder instantiator(Instantiator instantiator) {
+        return addUserProperty(INSTANTIATOR, _ -> instantiator);
     }
 
     /// @param strategy The [ExpirationStrategy] to be used

core/src/main/java/io/github/kaktushose/jdac/configuration/Extension.java

@@ -5,7 +5,7 @@
 import io.github.kaktushose.jdac.annotations.IntrospectionAccess;
 import io.github.kaktushose.jdac.configuration.Property.Category;
 import io.github.kaktushose.jdac.definitions.description.Descriptor;
-import io.github.kaktushose.jdac.dispatching.instance.InteractionControllerInstantiator;
+import io.github.kaktushose.jdac.dispatching.instance.Instantiator;
 import io.github.kaktushose.jdac.introspection.Introspection;
 import io.github.kaktushose.jdac.introspection.Stage;
 import org.jspecify.annotations.Nullable;
@@ -22,7 +22,7 @@
 /// 
 /// ## Properties
 /// By implementing [#properties()] and returning a collection of [PropertyProvider]s, you can
-/// for example provide an own implementation of [InteractionControllerInstantiator] 
+/// for example provide an own implementation of [Instantiator]
 /// or [Descriptor]. These implementations will override the default ones. 
 ///
 /// It's important to know, that you can only return [PropertyProvider]s of [Property]s 
@@ -38,7 +38,7 @@
 /// This allows further configuration, e.g. through the [Introspection] API by using [JDACommands#introspection()].
 ///
 /// ## Example
-/// This example extension provides an own implementation of [InteractionControllerInstantiator].
+/// This example extension provides an own implementation of [Instantiator].
 /// ```java
 /// public class DIExtension implements Extension<DIExtensionData> {
 ///
@@ -54,7 +54,7 @@
 ///     @Override
 ///     public Collection<PropertyProvider<?>> properties() {
 ///         return List.of(PropertyProvider.create(
-///                 Property.INTERACTION_CONTROLLER_INSTANTIATOR,
+///                 Property.INSTANTIATOR,
 ///                 2000,
 ///                 _ -> new CustomInteractionClassProvider(this))
 ///         );

core/src/main/java/io/github/kaktushose/jdac/configuration/Property.java

@@ -13,7 +13,7 @@
 import io.github.kaktushose.jdac.dispatching.context.KeyValueStore;
 import io.github.kaktushose.jdac.dispatching.events.Event;
 import io.github.kaktushose.jdac.dispatching.expiration.ExpirationStrategy;
-import io.github.kaktushose.jdac.dispatching.instance.InteractionControllerInstantiator;
+import io.github.kaktushose.jdac.dispatching.instance.Instantiator;
 import io.github.kaktushose.jdac.dispatching.middleware.Middleware;
 import io.github.kaktushose.jdac.dispatching.middleware.Priority;
 import io.github.kaktushose.jdac.dispatching.validation.Validator;
@@ -106,10 +106,9 @@ public sealed interface Property<T> permits Property.Enumeration, Property.Singl
     Property<Localizer> LOCALIZER =
             new Singleton<>("LOCALIZER", Category.LOADABLE, Localizer.class, Stage.CONFIGURATION);
 
-    /// @see JDACBuilder#instanceProvider(InteractionControllerInstantiator)
+    /// @see JDACBuilder#instantiator(Instantiator)
     @PropertyInformation(stage = Stage.CONFIGURATION, category = Category.LOADABLE)
-    Property<InteractionControllerInstantiator> INTERACTION_CONTROLLER_INSTANTIATOR =
-            new Singleton<>("INTERACTION_CONTROLLER_INSTANTIATOR", Category.LOADABLE, InteractionControllerInstantiator.class, Stage.CONFIGURATION);
+    Property<Instantiator> INSTANTIATOR = new Singleton<>("INSTANTIATOR", Category.LOADABLE, Instantiator.class, Stage.CONFIGURATION);
 
     /// MIDDLEWARE property holds multiple [Middleware]s associated with their [Priority]
     /// @see JDACBuilder#middleware(Priority, Middleware)

core/src/main/java/io/github/kaktushose/jdac/configuration/PropertyProvider.java

@@ -34,10 +34,10 @@
 /// class Foo {
 ///     public bar(...) {
 ///         var provider = new PropertyProvider(
-///             Type.INTERACTION_CONTROLLER_INSTANTIATOR,
+///             Property.INSTANTIATOR,
 ///             2000, // just some random priority
 ///             Foo.class, // used as a waypoint for debugging
-///             ctx -> new MyInteractionControllerInstantiator(ctx.get(Property.I18N)) // needs the I18n instance
+///             ctx -> new MyInstantiator(ctx.get(Property.I18N)) // needs the I18n instance
 ///         )
 ///     }
 /// }

core/src/main/java/io/github/kaktushose/jdac/definitions/interactions/command/OptionDataDefinition.java

@@ -17,16 +17,13 @@
 import io.github.kaktushose.jdac.dispatching.events.interactions.CommandEvent;
 import io.github.kaktushose.jdac.dispatching.events.interactions.ComponentEvent;
 import io.github.kaktushose.jdac.dispatching.events.interactions.ModalEvent;
-import io.github.kaktushose.jdac.dispatching.instance.InteractionControllerInstantiator;
 import io.github.kaktushose.jdac.dispatching.validation.Validator;
 import io.github.kaktushose.jdac.dispatching.validation.internal.Validators;
 import io.github.kaktushose.jdac.exceptions.ConfigurationException;
 import io.github.kaktushose.jdac.exceptions.InternalException;
 import io.github.kaktushose.jdac.exceptions.InvalidDeclarationException;
 import io.github.kaktushose.jdac.internal.Helpers;
 import io.github.kaktushose.jdac.introspection.Introspection;
-import io.github.kaktushose.jdac.introspection.internal.IntrospectionAccess;
-import io.github.kaktushose.jdac.introspection.internal.IntrospectionImpl;
 import io.github.kaktushose.jdac.message.resolver.MessageResolver;
 import io.github.kaktushose.proteus.Proteus;
 import io.github.kaktushose.proteus.type.Type;
@@ -265,7 +262,7 @@ private static List<Choice> indexChoices(ClassDescription classDescription, Para
                 Helpers.checkParametrizedType(method.genericReturnType(), List.class, String.class);
 
                 try {
-                    var instantiator = introspection.get(Property.INTERACTION_CONTROLLER_INSTANTIATOR);
+                    var instantiator = introspection.get(Property.INSTANTIATOR);
                     List<Object> arguments = method.parameters().stream()
                             .map(ParameterDescription::type)
                             .map(it -> (Object) instantiator.instance(it, introspection))

core/src/main/java/io/github/kaktushose/jdac/dispatching/FrameworkContext.java

@@ -138,7 +138,7 @@ public KeyValueStore keyValueStore() {
     }
 
     public <T> T interactionInstance(Class<T> clazz) {
-        return introspection.get(Property.INTERACTION_CONTROLLER_INSTANTIATOR).instance(clazz, introspection);
+        return introspection.get(Property.INSTANTIATOR).instance(clazz, introspection);
     }
 
     @Override

core/src/main/java/io/github/kaktushose/jdac/dispatching/Runtime.java

@@ -0,0 +1,26 @@
+package io.github.kaktushose.jdac.dispatching.instance;
+
+import io.github.kaktushose.jdac.annotations.IntrospectionAccess;
+import io.github.kaktushose.jdac.annotations.interactions.Interaction;
+import io.github.kaktushose.jdac.introspection.Introspection;
+import io.github.kaktushose.jdac.introspection.Stage;
+import io.github.kaktushose.jdac.message.resolver.MessageResolver;
+
+/// An [Instantiator] is used get instances of classes, if needed creating those.
+///
+/// For classes annotated with [Interaction], there can be only one instance per class of those per
+/// [`Runtime`]({@docRoot}/index.html#runtime-concept-heading). Instances of interactions should be treated like
+/// runtime scoped singletons, so to speak.
+@FunctionalInterface
+public interface Instantiator {
+
+    /// This method will be called each time an instance of a class is needed.
+    ///
+    /// The provided [Introspection] instance or [Introspection#accessScoped()] can be used to retrieve other
+    /// components/parts of this framework, e.g. [MessageResolver].
+    ///
+    /// @param clazz         the [Class] of needed instance
+    /// @param introspection the [Introspection] instance of this runtime (stage = [Stage#RUNTIME]).
+    @IntrospectionAccess(Stage.RUNTIME)
+    <T> T instance(Class<T> clazz, Introspection introspection);
+}

core/src/main/java/io/github/kaktushose/jdac/dispatching/instance/Instantiator.java

@@ -4,7 +4,7 @@
 import io.github.kaktushose.jdac.annotations.IntrospectionAccess;
 import io.github.kaktushose.jdac.configuration.Property;
 import io.github.kaktushose.jdac.dispatching.context.InvocationContext;
-import io.github.kaktushose.jdac.dispatching.instance.InteractionControllerInstantiator;
+import io.github.kaktushose.jdac.dispatching.instance.Instantiator;
 import io.github.kaktushose.jdac.dispatching.middleware.Middleware;
 import net.dv8tion.jda.api.events.interaction.GenericInteractionCreateEvent;
 
@@ -13,7 +13,7 @@
 /// JDA-Commands has the following stages in this order:
 /// 1. [#CONFIGURATION] -> setting of builder properties, extension loading, construction of framework components
 /// 2. [#INITIALIZED] -> after starting the framework (basically after [JDACBuilder#start()] completed), e.g. all definitions are indexed etc.
-/// 3. [#RUNTIME] -> inside a runtime but outside of processing an [GenericInteractionCreateEvent], e.g. when [InteractionControllerInstantiator#instance(Class, Introspection)] is called
+/// 3. [#RUNTIME] -> inside a runtime but outside of processing an [GenericInteractionCreateEvent], e.g. when [Instantiator#instance(Class, Introspection)] is called
 /// 4. [#PREPARATION] -> during the preparation of an [GenericInteractionCreateEvent] for the [#INTERACTION] stage, e.g. where type adapters get called
 /// 5. [#INTERACTION] -> when processing an [GenericInteractionCreateEvent], e.g. in [Middleware#accept(InvocationContext)] or inside a user defined interaction controller method
 ///