MessageDecorator (modularbot-message-decorator 2.5.0

java.lang.Object
- com.jesus_crie.modularbot.messagedecorator.decorator.MessageDecorator<T>

Direct Known Subclasses:

AutoDestroyMessageDecorator, ReactionDecorator
```
public abstract class MessageDecorator<T extends net.dv8tion.jda.core.events.Event>
extends java.lang.Object
```
Class that can extends the behaviour of a discord Message by interacting in specific manners with it. Some of the methods of this class aren't required by every type of decorator so they will throw exceptions.

Field Summary

Fields
Modifier and Type	Field and Description
`protected net.dv8tion.jda.core.entities.Message`	`binding`
`protected long`	`creationTime`
`protected boolean`	`isAlive`
`protected com.jesus_crie.modularbot.core.utils.Waiter.WaiterListener<T>`	`listener`
`protected java.util.List<DecoratorListener>`	`listeners`
`protected long`	`timeout`

Constructor Summary

Constructors
Modifier Constructor and Description

protected MessageDecorator(net.dv8tion.jda.core.entities.Message binding, long timeout)
Build the base of a decorator.

Constructors
Modifier	Constructor and Description
`protected`	`MessageDecorator(net.dv8tion.jda.core.entities.Message binding, long timeout)` Build the base of a decorator.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`checkTimeout(long timeout)` Used to check if the given timeout is valid or not.
`protected com.jesus_crie.modularbot.core.utils.Waiter.WaiterListener<T>`	`createListener(java.lang.Object... args)` Used to create the listener.
`abstract void`	`destroy()` Destroy the decorator.
`boolean`	`equals(java.lang.Object obj)` Check if 2 decorators are the same.
`net.dv8tion.jda.core.entities.Message`	`getBinding()` Get the bound message.
`long`	`getExpireTime()` Get the timestamp in milliseconds where the decorator will have expired or 0 for infinite or -1 if the decorator is dead.
`boolean`	`isAlive()` Check if the decorator is still alive.
`protected void`	`onTimeout()` Triggered when the decorator times out.
`void`	`register(MessageDecoratorModule module)` Register this decorator.
`void`	`register(com.jesus_crie.modularbot.core.ModularBot bot)` Register this decorator.
`void`	`setup()` Used to setup the decorator, this must be triggered out of the constructor.
`java.lang.String`	`toString()`
`protected void`	`updateMessage()` Update the reference to the bound message by querying it again from JDA.

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - binding
```
protected net.dv8tion.jda.core.entities.Message binding
```
  - creationTime
```
protected final long creationTime
```
  - timeout
```
protected final long timeout
```
  - listener
```
protected transient com.jesus_crie.modularbot.core.utils.Waiter.WaiterListener<T extends net.dv8tion.jda.core.events.Event> listener
```
  - listeners
```
protected transient java.util.List<DecoratorListener> listeners
```
  - isAlive
```
protected boolean isAlive
```
- Constructor Detail
  - MessageDecorator
```
protected MessageDecorator(@Nonnull
                           net.dv8tion.jda.core.entities.Message binding,
                           long timeout)
```
    Build the base of a decorator. If the given timeout isn't valid (base on checkTimeout(long)) the decorator will call destroy() and throw an exception right after.
    
    Parameters:
    
    binding - The message to bind to this decorator.
    
    timeout - The amount of time before the decorator expire.
    
    Throws:
    
    java.lang.IllegalArgumentException - If the given timeout is invalid.
- Method Detail
  - createListener
```
@Nonnull
protected com.jesus_crie.modularbot.core.utils.Waiter.WaiterListener<T> createListener(@Nonnull
                                                                                                java.lang.Object... args)
```
    Used to create the listener. By default, no listener is created and an exception is thrown instead.
  - setup
```
public void setup()
```
    Used to setup the decorator, this must be triggered out of the constructor.
  - register
```
public void register(@Nonnull
                     com.jesus_crie.modularbot.core.ModularBot bot)
```
    Register this decorator. You need to invoke this if you want it to be correctly handled and especially if you want it to be serialized.
    
    Parameters:
    
    bot - The current instance of ModularBot.
    
    See Also:
    
    register(MessageDecoratorModule)
  - register
```
public void register(@Nonnull
                     MessageDecoratorModule module)
```
    Register this decorator. You need to invoke this if you want it to be correctly handled and especially if you want it to be serialized.
    
    Parameters:
    
    module - The current MessageDecoratorModule.
    
    See Also:
    
    register(ModularBot)
  - onTimeout
```
protected void onTimeout()
```
    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 destroy() on timeout which is an expected behaviour.
  - destroy
```
public abstract void destroy()
```
    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 onTimeout().
  - checkTimeout
```
protected boolean checkTimeout(long timeout)
```
    Used to check if the given timeout is valid or not.
    
    Parameters:
    
    timeout - The timeout to check.
    
    Returns:
    
    True if the timeout is valid, otherwise false.
  - getExpireTime
```
public long getExpireTime()
```
    Get the timestamp in milliseconds where the decorator will have expired or 0 for infinite or -1 if the decorator is dead.
    
    Returns:
    
    A timestamp in milliseconds or 0.
  - getBinding
```
public net.dv8tion.jda.core.entities.Message getBinding()
```
    Get the bound message.
    
    Returns:
    
    The bound message.
  - updateMessage
```
protected void updateMessage()
```
    Update the reference to the bound message by querying it again from JDA.
  - isAlive
```
public boolean isAlive()
```
    Check if the decorator is still alive.
    
    Returns:
    
    True if its alive, otherwise false.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Check if 2 decorators are the same. They must be an instance of the same decorator and be bound to the same binding.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - The other potentially equal decorator.
    
    Returns:
    
    True if they are equivalent.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class MessageDecorator<T extends net.dv8tion.jda.core.events.Event>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

binding

creationTime

timeout

listener

listeners

isAlive

Constructor Detail

MessageDecorator

Method Detail

createListener

setup

register

register

onTimeout

destroy

checkTimeout

getExpireTime

getBinding

updateMessage

isAlive

equals

toString