io.github.wysohn.triggerreactor.core.manager

Class GlobalVariableManager

java.lang.Object

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

io.github.wysohn.triggerreactor.core.manager.GlobalVariableManager

All Implemented Interfaces:

IMigratable

public final class GlobalVariableManager
extends Manager
implements IMigratable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GlobalVariableManager.GlobalVariableAdapter

Field Summary

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

plugin

Constructor Summary

Constructors

Constructor and Description
GlobalVariableManager(TriggerReactorCore plugin)
GlobalVariableManager(TriggerReactorCore plugin, IConfigSource configSource)

Method Summary

Modifier and Type	Method and Description
Object	get(String key) get value saved with the 'key'
HashMap<Object,Object>	getGlobalVariableAdapter() Get global variable adapter that will be used by Triggers.
boolean	has(String key) Check if the key is set
boolean	isMigrationNeeded()
static boolean	isValidName(String str) Check if the string is valid as key.
void	migrate(IMigrationHelper migrationHelper)
void	put(String key, Object value) Save new value.
void	reload() Reload all triggers
void	remove(String key) Remove global variable named 'key.' The 'key' might can contains '.' to indicate the grouping of yaml.
void	saveAll() Save all triggers

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

Constructor Detail

GlobalVariableManager

public GlobalVariableManager(TriggerReactorCore plugin)

GlobalVariableManager

public GlobalVariableManager(TriggerReactorCore plugin,
                             IConfigSource configSource)

Method Detail

reload

public void reload()

Description copied from class: Manager

Reload all triggers

Specified by:

reload in class Manager

saveAll

public void saveAll()

Description copied from class: Manager

Save all triggers

Specified by:

saveAll in class Manager

isMigrationNeeded

public boolean isMigrationNeeded()

Specified by:

isMigrationNeeded in interface IMigratable

migrate

public void migrate(IMigrationHelper migrationHelper)

Specified by:

migrate in interface IMigratable

remove

public void remove(String key)

Remove global variable named 'key.' The 'key' might can contains '.' to indicate the grouping of yaml.

Parameters:

key - the key

has

public boolean has(String key)

Check if the key is set

Parameters:

key - the key

Returns:

true if set; false if nothing is set with 'key'

put

public void put(String key,
                Object value)

Save new value. This should replace the value if already exists.

Parameters:

key - the key. (This can contains '.' to indicate grouping of yaml)

value - the value to save

Throws:

Exception

get

public Object get(String key)

get value saved with the 'key'

Parameters:

key - the key

Returns:

the value object if exists; null if nothing found

getGlobalVariableAdapter

public HashMap<Object,Object> getGlobalVariableAdapter()

Get global variable adapter that will be used by Triggers. The adapter should extends HashMap and override get() put() has() remove() methods in order to work properly.

Returns:

isValidName

public static boolean isValidName(String str)

Check if the string is valid as key.

Parameters:

str - the string to test

Returns:

true if valid; false if cannot be used as key