ch.jalu.configme

Class SettingsManagerImpl

java.lang.Object

ch.jalu.configme.SettingsManagerImpl

All Implemented Interfaces:

SettingsManager

public class SettingsManagerImpl
extends Object
implements SettingsManager

Default implementation of SettingsManager. Use the SettingsManagerBuilder to create instances.

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:

PropertyResource, ConfigurationData, MigrationService

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SettingsManagerImpl(@NotNull PropertyResource resource, @NotNull ConfigurationData configurationData, @Nullable MigrationService migrationService) Constructor.

Method Summary

Modifier and Type	Method and Description
protected @NotNull ConfigurationData	getConfigurationData()
protected @Nullable MigrationService	getMigrationService()
<T> T	getProperty(@NotNull Property<T> property) Gets the given property from the configuration.
protected @NotNull PropertyResource	getPropertyResource()
protected void	loadFromResourceAndValidate() Reads the configuration file and executes the migration service (if present).
void	reload() Reloads the configuration.
void	save() Saves the properties to the configuration file.
<T> void	setProperty(@NotNull Property<T> property, T value) Sets a new value for the given property.

Methods inherited from class java.lang.Object

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

Constructor Detail

SettingsManagerImpl

protected SettingsManagerImpl(@NotNull
                              @NotNull PropertyResource resource,
                              @NotNull
                              @NotNull ConfigurationData configurationData,
                              @Nullable
                              @Nullable MigrationService migrationService)

Constructor. Use SettingsManagerBuilder to create instances.

Parameters:

resource - the property resource to read from and write to

configurationData - the configuration data

migrationService - migration service to check the property resource with

Method Detail

getProperty

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

Gets the given property from the configuration.

Specified by:

getProperty in interface SettingsManager

Type Parameters:

T - the property's type

Parameters:

property - the property to retrieve

Returns:

the property's value

setProperty

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

Sets a new value for the given property.

Specified by:

setProperty in interface SettingsManager

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()

Description copied from interface: SettingsManager

Reloads the configuration.

Specified by:

reload in interface SettingsManager

save

public void save()

Description copied from interface: SettingsManager

Saves the properties to the configuration file.

Specified by:

save in interface SettingsManager

loadFromResourceAndValidate

protected void loadFromResourceAndValidate()

Reads the configuration file and executes the migration service (if present). Saves the file if migrations have been applied.

getPropertyResource

@NotNull
protected final @NotNull PropertyResource getPropertyResource()

getConfigurationData

@NotNull
protected final @NotNull ConfigurationData getConfigurationData()

getMigrationService

@Nullable
protected final @Nullable MigrationService getMigrationService()