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

Class AbstractRepeatingTriggerManager

java.lang.Object

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

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

io.github.wysohn.triggerreactor.core.manager.trigger.repeating.AbstractRepeatingTriggerManager

Direct Known Subclasses:

RepeatingTriggerManager, RepeatingTriggerManager

public abstract class AbstractRepeatingTriggerManager
extends AbstractTriggerManager<RepeatingTrigger>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	AbstractRepeatingTriggerManager.ThrowableHandler

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
protected Map<String,Thread>	runningThreads
protected static String	TRIGGER

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
AbstractRepeatingTriggerManager(TriggerReactorCore plugin, File folder)

Method Summary

Modifier and Type	Method and Description
boolean	createTrigger(String triggerName, File file, String script, long interval) Create trigger.
boolean	createTrigger(String triggerName, String script) Create trigger.
boolean	isRunning(String triggerName) Checks whether the specified trigger is running.
void	reload() Reload all triggers
RepeatingTrigger	remove(String name)
void	showTriggerInfo(ICommandSender sender, RepeatingTrigger trigger)
boolean	startTrigger(String triggerName) Attempts to start the trigger with provided trigger name.
boolean	stopTrigger(String triggerName) Attempts to stop the trigger.

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

get, getAllTriggers, getFolder, getTriggerFile, getTriggerInfos, getTriggerList, has, put, reload, 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

TRIGGER

protected static final String TRIGGER

See Also:

Constant Field Values

runningThreads

protected final Map<String,Thread> runningThreads

Constructor Detail

AbstractRepeatingTriggerManager

public AbstractRepeatingTriggerManager(TriggerReactorCore plugin,
                                       File folder)

Method Detail

reload

public void reload()

Description copied from class: Manager

Reload all triggers

Overrides:

reload in class AbstractTriggerManager<RepeatingTrigger>

createTrigger

public boolean createTrigger(String triggerName,
                             File file,
                             String script,
                             long interval)
                      throws AbstractTriggerManager.TriggerInitFailedException,
                             IOException

Create trigger.

Parameters:

triggerName - name of the trigger.

script - the code.

interval - interval in milliseconds.

Returns:

true on success; false if already exists.

Throws:

IOException - See Trigger.init()

LexerException - See Trigger.init()

ParserException - See Trigger.init()

AbstractTriggerManager.TriggerInitFailedException

createTrigger

public boolean createTrigger(String triggerName,
                             String script)
                      throws AbstractTriggerManager.TriggerInitFailedException,
                             IOException

Create trigger. Interval is 1000L by default.

Parameters:

triggerName - name of the trigger.

script - the code.

Returns:

true on success; false if already exists.

Throws:

IOException - See Trigger.init()

LexerException - See Trigger.init()

ParserException - See Trigger.init()

AbstractTriggerManager.TriggerInitFailedException

remove

public RepeatingTrigger remove(String name)

Overrides:

remove in class AbstractTriggerManager<RepeatingTrigger>

isRunning

public boolean isRunning(String triggerName)

Checks whether the specified trigger is running. However, this also can return false even if the trigger with name 'triggerName' does not exists.

Parameters:

triggerName -

Returns:

startTrigger

public boolean startTrigger(String triggerName)

Attempts to start the trigger with provided trigger name. Return false if no such trigger with that name, yet return value of true does not necessarily start the thread; it checks if the trigger thread is already running, and if it is running, it will skip. So return value true actually just guarantees that the repeating trigger is running. If you want to check whether the repeating trigger is running, use isRunning(String) instead.

Parameters:

triggerName - name of the repeating trigger.

Returns:

true on success; false if trigger not found.

stopTrigger

public boolean stopTrigger(String triggerName)

Attempts to stop the trigger.

Parameters:

triggerName - name of the repeating trigger.

Returns:

true on success; false if no such trigger found with name.

showTriggerInfo

public void showTriggerInfo(ICommandSender sender,
                            RepeatingTrigger trigger)