ch.jalu.configme

Class SettingsManager

java.lang.Object

ch.jalu.configme.SettingsManager

public class SettingsManager
extends Object

Settings manager.

The settings manager unites a property resource, a migration service and the list of known properties (typically gathered from SettingsHolder classes).

The settings manager allows to look up and modify properties. Thus, the settings manager fulfills the most typical operations on a configuration in an application. After initializing the settings manager, it is usually the only class from ConfigMe you interact with.

See Also:

ConfigMe on Github, PropertyResource, MigrationService, SettingsHolder

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfigurationData	configurationData
protected MigrationService	migrationService
protected PropertyResource	resource

Constructor Summary

Constructors

Constructor and Description
SettingsManager(PropertyResource resource, MigrationService migrationService, Class<? extends SettingsHolder>... settingsClasses) Constructor.
SettingsManager(PropertyResource resource, MigrationService migrationService, ConfigurationData configurationData) Constructor.

Method Summary

Modifier and Type	Method and Description
static SettingsManager	createWithProperties(PropertyResource resource, MigrationService migrationService, Collection<? extends Property<?>> properties) Convenience method for creating a settings manager for the given collection of properties.
static SettingsManager	createWithYamlFile(File yamlFile, Class<? extends SettingsHolder>... settingsClasses) Convenience method for creating a settings manager for the provided YAML file with defaults.
<T> T	getProperty(Property<T> property) Gets the given property from the configuration.
void	reload() Reloads the configuration.
void	save() Saves the config file.
<T> void	setProperty(Property<T> property, T value) Sets a new value for the given property.
protected void	validateAndLoadOptions() Checks with the migration service if the configuration is up to date.

Methods inherited from class java.lang.Object

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

Field Detail

configurationData

protected final ConfigurationData configurationData

resource

protected final PropertyResource resource

migrationService

protected final MigrationService migrationService

Constructor Detail

SettingsManager

@SafeVarargs
public SettingsManager(PropertyResource resource,
                                    @Nullable
                                    MigrationService migrationService,
                                    Class<? extends SettingsHolder>... settingsClasses)

Constructor.

Parameters:

resource - the property resource to read and write properties to

migrationService - migration service to check the property resource with

settingsClasses - classes whose Property fields make up all known properties

SettingsManager

public SettingsManager(PropertyResource resource,
                       @Nullable
                       MigrationService migrationService,
                       ConfigurationData configurationData)

Constructor.

Parameters:

resource - the property resource to read and write properties to

migrationService - migration service to check the property resource with

configurationData - the configuration data

Method Detail

createWithProperties

public static SettingsManager createWithProperties(PropertyResource resource,
                                                   @Nullable
                                                   MigrationService migrationService,
                                                   Collection<? extends Property<?>> properties)

Convenience method for creating a settings manager for the given collection of properties.

Parameters:

resource - the property resource to read and write from

migrationService - migration service or null to skip migration check

properties - the properties

Returns:

the created settings manager

createWithYamlFile

@SafeVarargs
public static SettingsManager createWithYamlFile(File yamlFile,
                                                              Class<? extends SettingsHolder>... settingsClasses)

Convenience method for creating a settings manager for the provided YAML file with defaults. Creates the YAML file if it doesn't exist. Uses the default migration service, checking that all properties are present in the YAML file.

Parameters:

yamlFile - the file to read from and write to

settingsClasses - classes whose Property fields make up all known properties

Returns:

the created settings manager

getProperty

public <T> T getProperty(Property<T> property)

Gets the given property from the configuration.

Type Parameters:

T - The property's type

Parameters:

property - The property to retrieve

Returns:

The property's value

setProperty

public <T> void setProperty(Property<T> property,
                            T value)

Sets a new value for the given property.

Type Parameters:

T - The property's type

Parameters:

property - The property to modify

value - The new value to assign to the property

reload

public void reload()

Reloads the configuration.

save

public void save()

Saves the config file. Use after migrating one or more settings.

validateAndLoadOptions

protected void validateAndLoadOptions()

Checks with the migration service if the configuration is up to date. If not, saves the config.