io.github.wysohn.triggerreactor.core.manager.trigger.command

Class AbstractCommandTriggerManager

java.lang.Object

io.github.wysohn.triggerreactor.core.manager.Manager

io.github.wysohn.triggerreactor.core.manager.trigger.AbstractTriggerManager<CommandTrigger>

io.github.wysohn.triggerreactor.core.manager.trigger.command.AbstractCommandTriggerManager

Direct Known Subclasses:

CommandTriggerManager, CommandTriggerManager

public abstract class AbstractCommandTriggerManager
extends AbstractTriggerManager<CommandTrigger>

Nested Class Summary

Nested classes/interfaces inherited from class io.github.wysohn.triggerreactor.core.manager.trigger.AbstractTriggerManager

AbstractTriggerManager.TriggerFilter, AbstractTriggerManager.TriggerInitFailedException

Field Summary

Fields

Modifier and Type	Field and Description
static String	CANDIDATES
static String	HINT
static String	TABS

Fields inherited from class io.github.wysohn.triggerreactor.core.manager.trigger.AbstractTriggerManager

configSourceFactory, folder, loader

Fields inherited from class io.github.wysohn.triggerreactor.core.manager.Manager

plugin

Constructor Summary

Constructors

Constructor and Description
AbstractCommandTriggerManager(TriggerReactorCore plugin, File folder)

Method Summary

Modifier and Type	Method and Description
boolean	addCommandTrigger(ICommandSender adding, String cmd, String script)
CommandTrigger	createTempCommandTrigger(String script)
protected abstract boolean	registerCommand(String triggerName, CommandTrigger trigger) Register this command to command map.
void	reload() Reload all triggers
void	reload(String triggerName)
CommandTrigger	remove(String name)
void	reregisterCommand(String triggerName)
protected abstract void	synchronizeCommandMap()
protected abstract boolean	unregisterCommand(String triggerName) Unregister this command from command map.

Methods inherited from class io.github.wysohn.triggerreactor.core.manager.trigger.AbstractTriggerManager

get, getAllTriggers, getFolder, getTriggerFile, getTriggerInfos, getTriggerList, has, put, reportWarnings, saveAll

Methods inherited from class io.github.wysohn.triggerreactor.core.manager.Manager

disable, getManagers

Methods inherited from class java.lang.Object

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

Field Detail

TABS

public static final String TABS

See Also:

Constant Field Values

HINT

public static final String HINT

See Also:

Constant Field Values

CANDIDATES

public static final String CANDIDATES

See Also:

Constant Field Values

Constructor Detail

AbstractCommandTriggerManager

public AbstractCommandTriggerManager(TriggerReactorCore plugin,
                                     File folder)

Method Detail

reload

public void reload()

Description copied from class: Manager

Reload all triggers

Overrides:

reload in class AbstractTriggerManager<CommandTrigger>

reload

public void reload(String triggerName)

Overrides:

reload in class AbstractTriggerManager<CommandTrigger>

remove

public CommandTrigger remove(String name)

Overrides:

remove in class AbstractTriggerManager<CommandTrigger>

addCommandTrigger

public boolean addCommandTrigger(ICommandSender adding,
                                 String cmd,
                                 String script)

Parameters:

adding - CommandSender to send error message on script error

cmd - command to intercept

script - script to be executed

Returns:

true on success; false if cmd already binded.

createTempCommandTrigger

public CommandTrigger createTempCommandTrigger(String script)
                                        throws AbstractTriggerManager.TriggerInitFailedException

Throws:

AbstractTriggerManager.TriggerInitFailedException

registerCommand

protected abstract boolean registerCommand(String triggerName,
                                           CommandTrigger trigger)

Register this command to command map. If the command is already in use by another plugin, the original command will be overriden, and the original command will be recovered when the trigger is un-registered. However, if the trigger's name is already registered and also overriden by another command trigger, this method does nothing and return false.

Parameters:

triggerName - name of the trigger to register

trigger - the actual trigger instance

Returns:

true if registered; false if the command is already overriden by another command trigger and is also already registered trigger, it will return false.

unregisterCommand

protected abstract boolean unregisterCommand(String triggerName)

Unregister this command from command map.

Parameters:

triggerName - name of trigger to remove

Returns:

true if unregistered; false if can't find the registered command.

synchronizeCommandMap

protected abstract void synchronizeCommandMap()

reregisterCommand

public void reregisterCommand(String triggerName)