com.jesus_crie.modularbot.messagedecorator

Class MessageDecoratorModule

java.lang.Object

com.jesus_crie.modularbot.core.module.Module

com.jesus_crie.modularbot.messagedecorator.MessageDecoratorModule

All Implemented Interfaces:

com.jesus_crie.modularbot.core.module.Lifecycle

public class MessageDecoratorModule
extends com.jesus_crie.modularbot.core.module.Module

Nested Class Summary

Nested classes/interfaces inherited from class com.jesus_crie.modularbot.core.module.Module

com.jesus_crie.modularbot.core.module.Module.ModuleInfo

Nested classes/interfaces inherited from interface com.jesus_crie.modularbot.core.module.Lifecycle

com.jesus_crie.modularbot.core.module.Lifecycle.State

Field Summary

Fields inherited from class com.jesus_crie.modularbot.core.module.Module

bot, info

Constructor Summary

Constructors

Constructor and Description
MessageDecoratorModule(com.jesus_crie.modularbot.nightconfig.NightConfigWrapperModule config, java.io.File cachePath)
MessageDecoratorModule(com.jesus_crie.modularbot.nightconfig.NightConfigWrapperModule config, java.lang.String cachePath)

Method Summary

Modifier and Type	Method and Description
int	cleanup()
java.util.Collection<MessageDecorator<?>>	getDecorators()
void	onShardsReady(com.jesus_crie.modularbot.core.ModularBot bot)
void	onShutdownShards()
void	registerDecorator(MessageDecorator<?> decorator) Register a decorator in this module.
void	unregisterBoundDecorator(long bindingId) Destroy and unregister a bound decorator by its binding's id.

Methods inherited from class com.jesus_crie.modularbot.core.module.Module

getBot, getInfo, getState, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jesus_crie.modularbot.core.module.Lifecycle

onInitialization, onLoad, onPostInitialization, onPrepareShards, onShardsCreated, onUnload

Constructor Detail

MessageDecoratorModule

public MessageDecoratorModule(@Nonnull
                              com.jesus_crie.modularbot.nightconfig.NightConfigWrapperModule config,
                              @Nonnull
                              java.lang.String cachePath)

MessageDecoratorModule

public MessageDecoratorModule(@Nonnull
                              com.jesus_crie.modularbot.nightconfig.NightConfigWrapperModule config,
                              @Nonnull
                              java.io.File cachePath)

Method Detail

onShardsReady

public void onShardsReady(@Nonnull
                          com.jesus_crie.modularbot.core.ModularBot bot)

Specified by:

onShardsReady in interface com.jesus_crie.modularbot.core.module.Lifecycle

Overrides:

onShardsReady in class com.jesus_crie.modularbot.core.module.Module

onShutdownShards

public void onShutdownShards()

registerDecorator

public void registerDecorator(@Nonnull
                              MessageDecorator<?> decorator)

Register a decorator in this module. If you want your decorator to be serialized and restored after a shutdown, you need to register it.

Can also be performed by MessageDecorator.register(MessageDecoratorModule).

Parameters:

decorator - The decorator to register.

See Also:

MessageDecorator.register(MessageDecoratorModule), MessageDecorator.register(ModularBot)

unregisterBoundDecorator

public void unregisterBoundDecorator(long bindingId)

Destroy and unregister a bound decorator by its binding's id. If the binding has not registered decorator attached, it will be ignored.

Parameters:

bindingId - The id of the decorator's binding.

getDecorators

public java.util.Collection<MessageDecorator<?>> getDecorators()

cleanup

public int cleanup()