Package dev.sympho.bot_utils.component

Class ButtonManager

java.lang.Object

dev.sympho.bot_utils.component.ComponentManager<ButtonInteractionEvent,ButtonManager.ButtonContext,ButtonManager.HandlerFunction,ButtonManager.Handler,ButtonManager.HandlerEntry>

dev.sympho.bot_utils.component.ButtonManager

public class ButtonManager
extends ComponentManager<ButtonInteractionEvent,ButtonManager.ButtonContext,ButtonManager.HandlerFunction,ButtonManager.Handler,ButtonManager.HandlerEntry>

Centralized manager for button interaction handling.

Since:

1.0

Version:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	ButtonManager.ButtonContext	The execution context of a button being pressed.
static final record	ButtonManager.Handler	Specification for the handling of a button.
static final record	ButtonManager.HandlerEntry	Specification for a handler to be registered.
static interface	ButtonManager.HandlerFunction	A function used to handle a button press event.

Nested classes/interfaces inherited from class dev.sympho.bot_utils.component.ComponentManager

ComponentManager.ComponentContext<E extends @NonNull ComponentInteractionEvent>

Field Summary

Fields inherited from class dev.sympho.bot_utils.component.ComponentManager

logger

Constructor Summary

Constructors

Constructor	Description
ButtonManager(GatewayDiscordClient client, AccessManager accessManager)	Creates a new manager that receives interactions from the given client.

Method Summary

Modifier and Type	Method	Description
protected Class<ButtonInteractionEvent>	getEventType()	Retrieves the interaction event type.
protected ButtonManager.ButtonContext	makeContext(ButtonInteractionEvent event, AccessManager accessManager)	Creates the interaction context.
static String	makeId(String id, String args)	Creates a custom ID for a button with arguments in a format that is compatible with this manager.
ButtonManager.HandlerFunction	mutex(ButtonManager.HandlerFunction handler)	Converts a handler into a mutually-exclusive handler, where concurrent interactions to buttons in the same message (not necessarily the same button, but any button in the message whose handler is also a mutex in this manager) will only allow one execution (namely the first) to proceeed while the others fail, until the executing handler finishes.
void	register(ButtonManager.HandlerEntry handler)	Registers an interaction handler.
protected Mono<String>	validateInteraction(ButtonManager.ButtonContext context, ButtonManager.Handler handler)	Validates that the interaction is allowed.

Methods inherited from class dev.sympho.bot_utils.component.ComponentManager

register, registerAll, start, stop, unregister

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ButtonManager

@SideEffectFree
public ButtonManager(GatewayDiscordClient client,
 AccessManager accessManager)

Creates a new manager that receives interactions from the given client.

Parameters:

client - The client to receive interactions from.

accessManager - The access manager to use.

Method Details

makeId

@SideEffectFree
public static String makeId(String id,
 String args)

Creates a custom ID for a button with arguments in a format that is compatible with this manager.

Parameters:

id - The button handler ID.

args - The interaction arguments.

Returns:

The assembled custom ID.

register

public void register(ButtonManager.HandlerEntry handler)

Description copied from class: ComponentManager

Registers an interaction handler.

Overrides:

register in class ComponentManager<ButtonInteractionEvent,ButtonManager.ButtonContext,ButtonManager.HandlerFunction,ButtonManager.Handler,ButtonManager.HandlerEntry>

Parameters:

handler - The handler to use.

getEventType

protected Class<ButtonInteractionEvent> getEventType()

Description copied from class: ComponentManager

Retrieves the interaction event type.

Specified by:

getEventType in class ComponentManager<ButtonInteractionEvent,ButtonManager.ButtonContext,ButtonManager.HandlerFunction,ButtonManager.Handler,ButtonManager.HandlerEntry>

Returns:

The interaction event type.

makeContext

protected ButtonManager.ButtonContext makeContext(ButtonInteractionEvent event,
 AccessManager accessManager)

Description copied from class: ComponentManager

Creates the interaction context.

Specified by:

makeContext in class ComponentManager<ButtonInteractionEvent,ButtonManager.ButtonContext,ButtonManager.HandlerFunction,ButtonManager.Handler,ButtonManager.HandlerEntry>

Parameters:

event - The interaction event.

accessManager - The access manager.

Returns:

The created context.

validateInteraction

protected Mono<String> validateInteraction(ButtonManager.ButtonContext context,
 ButtonManager.Handler handler)

Description copied from class: ComponentManager

Validates that the interaction is allowed.

Specified by:

validateInteraction in class ComponentManager<ButtonInteractionEvent,ButtonManager.ButtonContext,ButtonManager.HandlerFunction,ButtonManager.Handler,ButtonManager.HandlerEntry>

Parameters:

context - The interaction context.

handler - The invoked handler.

Returns:

A mono that completes empty if the interaction is allowed, otherwise issuing an error message to be sent to the user.

mutex

public ButtonManager.HandlerFunction mutex(ButtonManager.HandlerFunction handler)

Converts a handler into a mutually-exclusive handler, where concurrent interactions to buttons in the same message (not necessarily the same button, but any button in the message whose handler is also a mutex in this manager) will only allow one execution (namely the first) to proceeed while the others fail, until the executing handler finishes.

This method should be used to protect button-based features where only one execution should be allowed at once. Preferrably it should be used in conjunction with disabling the buttons, which by itself would not be sufficient due to the lag between the start of handling and the edit being processed.

Parameters:

handler - The handler to wrap.

Returns:

The wrapped mutex handler.