Added ComponentIdInteractor delegate

[Zabuzard]

Overview

This adds a new class called ComponentIdInteractor, which effectively is a delegate-pattern solution to provide component-ID generation based out of a class that can be used as delegate for composition, instead of relying on the existing BotCommandAdapter inheritance.

Essentially, the existing code to generate component IDs has been moved out of BotCommandAdapter into this class instead. BotCommandAdapter now delegates to ComponentIdInteractor for this functionality.

Advantage

The benefit is that non-BotCommand classes, in particular Routines can now easily access this functionality as well. For example, a routine might now easily create buttons like this:

public class FooRoutine implements Routine, UserInteractor {
  // Create the delegate
  private final ComponentIdInteractor componentIdInteractor = new ComponentIdInteractor(getInteractionType(), getName());

  // Stuff from Routine
  @Override
  public Schedule createSchedule() { ... }

  @Override
  public void runRoutine(JDA jda) {
    ...
    // Create some button using the delegate, and later attach it to some message
    Button button = Button.success(
      componentIdInteractor.generateComponentId("John"),
      "click me");
    ...
  }

  // Stuff from UserInteractor
  @Override
  public String getName() {
    return "foo";
  }

  @Override
  public UserInteractionType getInteractionType() {
    return UserInteractionType.OTHER;
  }

  @Override
  public void acceptComponentIdGenerator(ComponentIdGenerator generator) {
    componentIdInteractor.acceptComponentIdGenerator(generator); // delegate
  }

  @Override
  public void onButtonClick(ButtonInteractionEvent event, List<String> args) {
    System.out.println("Hello " + args.get(0)); // Hello John
  }

  @Override
  public void onSelectionMenu(SelectMenuInteractionEvent event, List<String> args) {
    // Not interested in
  }
}

Redesign prefix

While at it, the whole topic with UserInteractorPrefix was redesigned. It is now essentially renamed to UserInteractionType and will not only be used for prefixes, but essentailly just represents the type of interaction.

This is then used by BotCore for prefix-based-forwarding. Implementations of UserInteractor now have to explicitly tell their type instead of the system being based on the classes and reflection.

This gives maximum flexibility. At the same time, it is still convenient though, since everything is hidden behind the adapters for 99% of the use cases. BotCommandAdapter now auto-infers the type based on the JDA command types, for the commands its responsible for (slash, user context, message context).

Checklist

• Implement
• Let ScamBlocker use the delegate
• Wait for Command rework, attempt number 2 #558
• redesign prefix stuff

[Zabuzard]

(FYI @SquidXTV )

[Tais993]

The issue with the prefix enum before was that the component ID generation needed the prefixed name.

But that still is the case, so what have you actually changed?

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

0.0% Coverage
0.0% Duplication