org.hkijena.jipipe.api.registries

Class JIPipeApplicationSettingsRegistry

java.lang.Object

org.hkijena.jipipe.api.registries.JIPipeApplicationSettingsRegistry

public class JIPipeApplicationSettingsRegistry
extends Object

Registry for settings. Settings are organized in "sheets" (parameter collections)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeApplicationSettingsRegistry.ChangedEvent
static class	JIPipeApplicationSettingsRegistry.ChangedEventEmitter
static interface	JIPipeApplicationSettingsRegistry.ChangedEventListener

Constructor Summary

Constructors

Constructor and Description
JIPipeApplicationSettingsRegistry(JIPipe jiPipe)

Method Summary

Modifier and Type	Method and Description
<T extends JIPipeSettingsSheet> T	getById(String id, Class<T> klass) Gets the settings instance with given ID
<T extends JIPipeSettingsSheet> T	getByType(Class<T> klass) Gets the settings instance with given ID
JIPipeApplicationSettingsRegistry.ChangedEventEmitter	getChangedEventEmitter()
JIPipe	getJIPipe()
static Path	getPropertyFile()
static com.fasterxml.jackson.databind.JsonNode	getRawNode() Gets the raw property files Json node
com.google.common.collect.BiMap<String,JIPipeApplicationSettingsSheet>	getRegisteredSheets()
void	load(Path file) Loads settings from the specified file
void	register(JIPipeApplicationSettingsSheet sheet) Registers a new settings sheet
void	reload() Reloads the settings from the default file if it exists
void	save() Saves the settings to the default settings file
void	save(Path file) Saves the settings to the specified file
void	saveLater()

Methods inherited from class java.lang.Object

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

Constructor Detail

JIPipeApplicationSettingsRegistry

public JIPipeApplicationSettingsRegistry(JIPipe jiPipe)

Method Detail

getRawNode

public static com.fasterxml.jackson.databind.JsonNode getRawNode()

Gets the raw property files Json node

Returns:

the node. Never null.

getPropertyFile

public static Path getPropertyFile()

Returns:

The location of the file where the settings are stored

register

public void register(JIPipeApplicationSettingsSheet sheet)

Registers a new settings sheet

Parameters:

sheet - the sheet

getById

public <T extends JIPipeSettingsSheet> T getById(String id,
                                                 Class<T> klass)

Gets the settings instance with given ID

Type Parameters:

T - the settings class

Parameters:

id - the ID

klass - the settings class

Returns:

the settings instance.

getByType

public <T extends JIPipeSettingsSheet> T getByType(Class<T> klass)

Gets the settings instance with given ID

Type Parameters:

T - the settings class

Parameters:

klass - the settings class

Returns:

the settings instance.

getRegisteredSheets

public com.google.common.collect.BiMap<String,JIPipeApplicationSettingsSheet> getRegisteredSheets()

save

public void save(Path file)

Saves the settings to the specified file

Parameters:

file - the file path

save

public void save()

Saves the settings to the default settings file

load

public void load(Path file)

Loads settings from the specified file

Parameters:

file - the file

reload

public void reload()

Reloads the settings from the default file if it exists

getJIPipe

public JIPipe getJIPipe()

saveLater

public void saveLater()

getChangedEventEmitter

public JIPipeApplicationSettingsRegistry.ChangedEventEmitter getChangedEventEmitter()