com.jesus_crie.modularbot.messagedecorator.decorator

Class ReactionDecorator

java.lang.Object

com.jesus_crie.modularbot.messagedecorator.decorator.MessageDecorator<net.dv8tion.jda.core.events.message.react.GenericMessageReactionEvent>

com.jesus_crie.modularbot.messagedecorator.decorator.ReactionDecorator

Direct Known Subclasses:

DisposableReactionDecorator, PermanentReactionDecorator

public abstract class ReactionDecorator
extends MessageDecorator<net.dv8tion.jda.core.events.message.react.GenericMessageReactionEvent>

Decorator made to interact with the reactions of a message.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<DecoratorButton>	buttons

Fields inherited from class com.jesus_crie.modularbot.messagedecorator.decorator.MessageDecorator

binding, creationTime, isAlive, listener, listeners, timeout

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ReactionDecorator(net.dv8tion.jda.core.entities.Message binding, long timeout, DecoratorButton... buttons) Initialize the decorator.

Method Summary

Modifier and Type	Method and Description
protected com.jesus_crie.modularbot.core.utils.Waiter.WaiterListener<net.dv8tion.jda.core.events.message.react.GenericMessageReactionEvent>	createListener(java.lang.Object... args) Used to create the listener.
void	destroy() Destroy the decorator.
void	destroyButtons() Remove the reaction of the button.
protected void	onTimeout() Triggered when the decorator times out.
protected boolean	onTrigger(net.dv8tion.jda.core.events.message.react.GenericMessageReactionEvent event) Called when the decorator is triggered.
void	setup() Used to setup the decorator, this must be triggered out of the constructor.

Methods inherited from class com.jesus_crie.modularbot.messagedecorator.decorator.MessageDecorator

checkTimeout, equals, getBinding, getExpireTime, isAlive, register, register, toString, updateMessage

Methods inherited from class java.lang.Object

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

Field Detail

buttons

protected final java.util.List<DecoratorButton> buttons

Constructor Detail

ReactionDecorator

protected ReactionDecorator(@Nonnull
                            net.dv8tion.jda.core.entities.Message binding,
                            long timeout,
                            @Nonnull
                            DecoratorButton... buttons)

Initialize the decorator.

Parameters:

binding - The bound message.

timeout - The amount of milliseconds before this decorator expire or 0 for infinite.

buttons - The buttons (reaction) that can trigger this decorator.

See Also:

MessageDecorator

Method Detail

setup

public void setup()

Used to setup the decorator, this must be triggered out of the constructor. Initialize each button and then register the waiter.

Overrides:

setup in class MessageDecorator<net.dv8tion.jda.core.events.message.react.GenericMessageReactionEvent>

createListener

@Nonnull
protected com.jesus_crie.modularbot.core.utils.Waiter.WaiterListener<net.dv8tion.jda.core.events.message.react.GenericMessageReactionEvent> createListener(@Nonnull
                                                                                                                                                                    java.lang.Object... args)

Description copied from class: MessageDecorator

Used to create the listener. By default, no listener is created and an exception is thrown instead.

Overrides:

createListener in class MessageDecorator<net.dv8tion.jda.core.events.message.react.GenericMessageReactionEvent>

onTrigger

protected boolean onTrigger(@Nonnull
                            net.dv8tion.jda.core.events.message.react.GenericMessageReactionEvent event)

Called when the decorator is triggered.

Parameters:

event - The event that was thrown.

Returns:

True if the event has triggered a button, otherwise false.

onTimeout

protected void onTimeout()

Description copied from class: MessageDecorator

Triggered when the decorator times out. If this method isn't overridden, it will throw an exception but this method isn't called by default.

On the other hand, an implementation like ReactionDecorator will call MessageDecorator.destroy() on timeout which is an expected behaviour.

Overrides:

onTimeout in class MessageDecorator<net.dv8tion.jda.core.events.message.react.GenericMessageReactionEvent>

destroyButtons

public void destroyButtons()

Remove the reaction of the button. This method isn't called by default but some implementations might call it from destroy().

destroy

public void destroy()

Description copied from class: MessageDecorator

Destroy the decorator.

The effect of this method might depend of the implementation. Depending of the implementation this method can also be called as a result of MessageDecorator.onTimeout().

Specified by:

destroy in class MessageDecorator<net.dv8tion.jda.core.events.message.react.GenericMessageReactionEvent>