org.simonscode.telegrambots.framework

Class ModuleAdapter

java.lang.Object

org.simonscode.telegrambots.framework.ModuleAdapter

All Implemented Interfaces:

Module

public abstract class ModuleAdapter
extends java.lang.Object
implements Module

Constructor Summary

Constructors

Constructor and Description
ModuleAdapter()

Method Summary

Modifier and Type	Method and Description
java.lang.Class<? extends State>	getStateType()
void	initialize(State state) This function is called when you module is first loaded by the framework
void	postLoad(Bot bot) This function will be executed just after your module was loaded by a bot.
void	postUnload(Bot bot) This function will be executed after your module was unloaded.
void	preLoad(Bot bot) This function will be executed just before your module will be loaded by a bot.
void	preUnload(Bot bot) This function will be executed just before your module will be unloaded.
State	saveState(Bot bot) This method is called when the bot wants you to save.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.simonscode.telegrambots.framework.Module

getModuleInfo, processUpdate

Constructor Detail

ModuleAdapter

public ModuleAdapter()

Method Detail

initialize

public void initialize(State state)

Description copied from interface: Module

This function is called when you module is first loaded by the framework

Specified by:

initialize in interface Module

Parameters:

state - the state last returned by the save function or null, if no previous state has been found

preLoad

public void preLoad(Bot bot)

Description copied from interface: Module

This function will be executed just before your module will be loaded by a bot.

Specified by:

preLoad in interface Module

postLoad

public void postLoad(Bot bot)

Description copied from interface: Module

This function will be executed just after your module was loaded by a bot.

Specified by:

postLoad in interface Module

preUnload

public void preUnload(Bot bot)

Description copied from interface: Module

This function will be executed just before your module will be unloaded.

Specified by:

preUnload in interface Module

postUnload

public void postUnload(Bot bot)

Description copied from interface: Module

This function will be executed after your module was unloaded.

Specified by:

postUnload in interface Module

saveState

public State saveState(Bot bot)

Description copied from interface: Module

This method is called when the bot wants you to save.

Specified by:

saveState in interface Module

Parameters:

bot - the bot that wants you to save

Returns:

either the new state or null, if you do not wish to save at this moment

getStateType

public java.lang.Class<? extends State> getStateType()

Specified by:

getStateType in interface Module

Returns:

the class of your implementation of State