SettingsManager (WebLaF core library 1.2.13 API)

java.lang.Object
- com.alee.managers.settings.SettingsManager

```
public final class SettingsManager
extends Object
```
This manager allows you to quickly and easily save any serializable data into settings files using simple XML format. You can define settings group file name (they are equal to the SettingsGroup name and should be unique), its location on local or remote drive and each separate property key. Any amount of properties could be stored in each group. Also there are some additional manager settings that allows you to configure SettingsManager to work the way you want it to. The rest of the work is done by the SettingsManager - it decides where, when and how to save the settings files. Settings data aliasing (see XStream documentation and XmlUtils class) or SettingsGroup file location changes should be done before requesting any of the settings, preferably right at the application startup. Otherwise data might not be properly read and settings will appear empty.

Author:

Mikle Garin

See Also:

How to use SettingsManager, XmlUtils

Constructor Summary

Constructors
Constructor and Description

SettingsManager()

Constructors
Constructor and Description
`SettingsManager()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addSettingsListener(SettingsListener listener)` Adds new global `SettingsListener`.
`static void`	`addSettingsListener(String key, SettingsListener listener)` Adds new specific `SettingsListener`.
`static void`	`addSettingsListener(String group, String key, SettingsListener listener)` Adds new specific `SettingsListener`.
`static void`	`disableSave()` Disables saving settings into files.
`static void`	`enableSave()` Enables saving settings into files.
`static <T> T`	`get(String key)` Returns stored settings.
`static <T> T`	`get(String group, String key, Supplier<T> defaultValueSupplier)` Returns stored settings.
`static <T> T`	`get(String group, String key, T defaultValue)` Returns stored settings.
`static <T> T`	`get(String key, Supplier<T> defaultValueSupplier)` Returns stored settings.
`static <T> T`	`get(String key, T defaultValue)` Returns stored settings.
`static String`	`getBackupFilesExtension()` Returns backup files extension.
`static String`	`getDefaultSettingsDir()` Returns default settings directory.
`static String`	`getDefaultSettingsDirName()` Returns default settings directory name.
`static String`	`getDefaultSettingsGroup()` Returns default `SettingsGroup` name.
`static String`	`getGroupFilePath(String group)` Returns directory where settings group file is saved.
`static List<SettingsGroup>`	`getLoadedGroups()` Returns list of all loaded settings groups.
`static Map<String,SettingsGroup>`	`getLoadedGroupsMap()` Returns map of all loaded settings groups.
`static long`	`getSaveOnChangeDelay()` Returns save-on-change delay in milliseconds.
`static Object`	`getSettings(String fileName)` Returns value read from the settings file.
`static <T> T`	`getSettings(String fileName, Supplier<T> defaultValue)` Returns value read from the settings file.
`static <T> T`	`getSettings(String fileName, T defaultValue)` Returns value read from the settings file.
`static String`	`getSettingsFilesExtension()` Returns settings files extension.
`static SettingsGroup`	`getSettingsGroup(String group)` Returns settings group for the specified name.
`SettingsGroupState`	`getSettingsGroupState(String group)` Returns `SettingsGroupState` for the `SettingsGroup` with the specified name.
`static void`	`initialize()` Initializes `SettingsManager`.
`static boolean`	`isAllowSave()` Returns whether should allow saving settings into files or not.
`static boolean`	`isSaveDefaultValues()` Sets whether or not should save default value created as a result of `get(...)` calls.
`static boolean`	`isSaveLoggingEnabled()` Returns whether settings save log is enabled or not.
`static boolean`	`isSaveOnChange()` Returns whether should save settings right after any changes made or not.
`static void`	`removeSettingsListener(SettingsListener listener)` Removes global `SettingsListener`.
`static void`	`removeSettingsListener(String key, SettingsListener listener)` Removes specific `SettingsListener`.
`static void`	`removeSettingsListener(String group, String key, SettingsListener listener)` Removes specific `SettingsListener`.
`static void`	`resetDefaultGroup()` Resets all settings within the default settings group.
`static void`	`resetGroup(String group)` Resets all settings within the specified settings group.
`static <T> T`	`resetValue(String key)` Resets settings under the key within the default settings group.
`static <T> T`	`resetValue(String group, String key)` Resets settings under the key within the specified settings group.
`static void`	`saveSettings()` Saves all `SettingsGroup`s and settings files.
`static void`	`saveSettingsGroup(SettingsGroup settingsGroup)` Saves specified `SettingsGroup`.
`static void`	`saveSettingsGroup(String group)` Saves `SettingsGroup` with the specified name.
`static <T> T`	`set(String group, String key, T object)` Sets value for the specified settings group and key.
`static <T> T`	`set(String key, T object)` Sets value for the specified settings key.
`static void`	`setAllowSave(boolean allowSave)` Sets whether should allow saving settings into files or not.
`static void`	`setBackupFilesExtension(String backupFilesExtension)` Sets backup files extension
`static void`	`setDefaultSettingsDir(String defaultSettingsDir)` Sets default settings directory.
`static void`	`setDefaultSettingsDirName(String defaultSettingsDir)` Sets default settings directory name.
`static void`	`setDefaultSettingsGroup(String defaultSettingsGroup)` Sets default `SettingsGroup` name.
`static void`	`setGroupFilePath(String group, String dir)` Sets custom directory where settings group file will be saved.
`static void`	`setSaveDefaultValues(boolean saveDefaultValues)` Sets whether or not should save default value created as a result of `get(...)` calls.
`static void`	`setSaveLoggingEnabled(boolean enabled)` Sets whether settings save log is enabled or not.
`static void`	`setSaveOnChange(boolean saveOnChange)` Sets whether should save settings right after any changes made or not.
`static void`	`setSaveOnChangeDelay(long saveOnChangeDelay)` Sets save-on-change delay in milliseconds.
`static void`	`setSettings(String fileName, Object settings)` Sets and saves value into settings file with the specified name.
`static void`	`setSettingsFilesExtension(String settingsFilesExtension)` Sets settings files extension
`static boolean`	`settingsExists(String fileName)` Returns whether settings file with the specified name exists or not.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SettingsManager
```
public SettingsManager()
```
- Method Detail
  - initialize
```
public static void initialize()
```
    Initializes SettingsManager.
  - getLoadedGroups
```
public static List<SettingsGroup> getLoadedGroups()
```
    Returns list of all loaded settings groups.
    
    Returns:
    
    list of all loaded settings groups
  - getLoadedGroupsMap
```
public static Map<String,SettingsGroup> getLoadedGroupsMap()
```
    Returns map of all loaded settings groups.
    
    Returns:
    
    map of all loaded settings groups
  - get
```
public static <T> T get(String key)
```
    Returns stored settings. The only type of exceptions that is ignored here is ClassCastException. Whenever a ClassCastException there will be a warning logged and default value will be used.
    
    Type Parameters:
    
    T - settings type
    
    Parameters:
    
    key - settings key
    
    Returns:
    
    stored settings
  - get
```
public static <T> T get(String key,
                        T defaultValue)
```
    Returns stored settings. The only type of exceptions that is ignored here is ClassCastException. Whenever a ClassCastException there will be a warning logged and default value will be used.
    
    Type Parameters:
    
    T - settings type
    
    Parameters:
    
    key - settings key
    
    defaultValue - default value
    
    Returns:
    
    stored settings
  - get
```
public static <T> T get(String key,
                        Supplier<T> defaultValueSupplier)
```
    Returns stored settings. The only type of exceptions that is ignored here is ClassCastException. Whenever a ClassCastException there will be a warning logged and default value will be used.
    
    Type Parameters:
    
    T - settings type
    
    Parameters:
    
    key - settings key
    
    defaultValueSupplier - Supplier for default value
    
    Returns:
    
    stored settings
  - get
```
public static <T> T get(String group,
                        String key,
                        T defaultValue)
```
    Returns stored settings. The only type of exceptions that is ignored here is ClassCastException. Whenever a ClassCastException there will be a warning logged and default value will be used.
    
    Type Parameters:
    
    T - settings type
    
    Parameters:
    
    group - settings group
    
    key - settings key
    
    defaultValue - default value
    
    Returns:
    
    stored settings
  - get
```
public static <T> T get(String group,
                        String key,
                        Supplier<T> defaultValueSupplier)
```
    Returns stored settings. The only type of exceptions that is ignored here is ClassCastException. Whenever a ClassCastException there will be a warning logged and default value will be used.
    
    Type Parameters:
    
    T - settings type
    
    Parameters:
    
    group - settings group
    
    key - settings key
    
    defaultValueSupplier - Supplier for default value
    
    Returns:
    
    stored settings
  - set
```
public static <T> T set(String key,
                        T object)
```
    Sets value for the specified settings key.
    
    Type Parameters:
    
    T - new value type
    
    Parameters:
    
    key - settings key
    
    object - new value
    
    Returns:
    
    old value for the specified settings key
  - set
```
public static <T> T set(String group,
                        String key,
                        T object)
```
    Sets value for the specified settings group and key.
    
    Type Parameters:
    
    T - new value type
    
    Parameters:
    
    group - settings group
    
    key - settings key
    
    object - new value
    
    Returns:
    
    old value for the specified settings key
  - resetDefaultGroup
```
public static void resetDefaultGroup()
```
    Resets all settings within the default settings group.
  - resetGroup
```
public static void resetGroup(String group)
```
    Resets all settings within the specified settings group. This will also reset saved settings to ensure they won't be read again.
    
    Parameters:
    
    group - settings group
  - resetValue
```
public static <T> T resetValue(String key)
```
    Resets settings under the key within the default settings group.
    
    Type Parameters:
    
    T - value type
    
    Parameters:
    
    key - settings key to reset
    
    Returns:
    
    resetted value
  - resetValue
```
public static <T> T resetValue(String group,
                               String key)
```
    Resets settings under the key within the specified settings group.
    
    Type Parameters:
    
    T - value type
    
    Parameters:
    
    group - settings group
    
    key - settings key to reset
    
    Returns:
    
    resetted value
  - getSettingsGroup
```
public static SettingsGroup getSettingsGroup(String group)
```
    Returns settings group for the specified name.
    
    Parameters:
    
    group - settings group name
    
    Returns:
    
    settings group for the specified name
  - saveSettings
```
public static void saveSettings()
```
    Saves all SettingsGroups and settings files.
  - saveSettingsGroup
```
public static void saveSettingsGroup(String group)
```
    Saves SettingsGroup with the specified name.
    
    Parameters:
    
    group - name of the SettingsGroup to save
  - saveSettingsGroup
```
public static void saveSettingsGroup(SettingsGroup settingsGroup)
```
    Saves specified SettingsGroup.
    
    Parameters:
    
    settingsGroup - SettingsGroup to save
  - getSettingsGroupState
```
public SettingsGroupState getSettingsGroupState(String group)
```
    Returns SettingsGroupState for the SettingsGroup with the specified name.
    
    Parameters:
    
    group - SettingsGroup name to retrieve SettingsGroupState for
    
    Returns:
    
    SettingsGroupState for the SettingsGroup with the specified name
  - getSettings
```
public static Object getSettings(String fileName)
```
    Returns value read from the settings file.
    
    Parameters:
    
    fileName - settings file name
    
    Returns:
    
    value read from the settings file
  - getSettings
```
public static <T> T getSettings(String fileName,
                                T defaultValue)
```
    Returns value read from the settings file.
    
    Type Parameters:
    
    T - default value type
    
    Parameters:
    
    fileName - settings file name
    
    defaultValue - default value
    
    Returns:
    
    value read from the settings file
  - getSettings
```
public static <T> T getSettings(String fileName,
                                Supplier<T> defaultValue)
```
    Returns value read from the settings file.
    
    Type Parameters:
    
    T - default value type
    
    Parameters:
    
    fileName - settings file name
    
    defaultValue - default value supplier
    
    Returns:
    
    value read from the settings file
  - setSettings
```
public static void setSettings(String fileName,
                               Object settings)
```
    Sets and saves value into settings file with the specified name.
    
    Parameters:
    
    fileName - settings file name
    
    settings - value
  - settingsExists
```
public static boolean settingsExists(String fileName)
```
    Returns whether settings file with the specified name exists or not.
    
    Parameters:
    
    fileName - settings file name
    
    Returns:
    
    true if settings file with the specified name exists, false otherwise
  - getSettingsFilesExtension
```
public static String getSettingsFilesExtension()
```
    Returns settings files extension.
    
    Returns:
    
    settings files extension
  - setSettingsFilesExtension
```
public static void setSettingsFilesExtension(String settingsFilesExtension)
```
    Sets settings files extension
    
    Parameters:
    
    settingsFilesExtension - new settings files extension
  - getBackupFilesExtension
```
public static String getBackupFilesExtension()
```
    Returns backup files extension.
    
    Returns:
    
    backup files extension
  - setBackupFilesExtension
```
public static void setBackupFilesExtension(String backupFilesExtension)
```
    Sets backup files extension
    
    Parameters:
    
    backupFilesExtension - new backup files extension
  - getDefaultSettingsDir
```
public static String getDefaultSettingsDir()
```
    Returns default settings directory.
    
    Returns:
    
    default settings directory
  - setDefaultSettingsDir
```
public static void setDefaultSettingsDir(String defaultSettingsDir)
```
    Sets default settings directory.
    
    Parameters:
    
    defaultSettingsDir - new default settings directory
  - getDefaultSettingsDirName
```
public static String getDefaultSettingsDirName()
```
    Returns default settings directory name.
    
    Returns:
    
    default settings directory name
  - setDefaultSettingsDirName
```
public static void setDefaultSettingsDirName(String defaultSettingsDir)
```
    Sets default settings directory name.
    
    Parameters:
    
    defaultSettingsDir - new default settings directory name
  - getDefaultSettingsGroup
```
public static String getDefaultSettingsGroup()
```
    Returns default SettingsGroup name.
    
    Returns:
    
    default SettingsGroup name
  - setDefaultSettingsGroup
```
public static void setDefaultSettingsGroup(String defaultSettingsGroup)
```
    Sets default SettingsGroup name.
    
    Parameters:
    
    defaultSettingsGroup - new default SettingsGroup name
  - setGroupFilePath
```
public static void setGroupFilePath(String group,
                                    String dir)
```
    Sets custom directory where settings group file will be saved. Location that was used for this group before will be simply ignored.
    
    Parameters:
    
    group - settings group name
    
    dir - settings group file directory
  - getGroupFilePath
```
public static String getGroupFilePath(String group)
```
    Returns directory where settings group file is saved.
    
    Parameters:
    
    group - settings group name
    
    Returns:
    
    directory where settings group file is saved
  - isSaveOnChange
```
public static boolean isSaveOnChange()
```
    Returns whether should save settings right after any changes made or not.
    
    Returns:
    
    true if should save settings right after any changes made, false otherwise
  - setSaveOnChange
```
public static void setSaveOnChange(boolean saveOnChange)
```
    Sets whether should save settings right after any changes made or not.
    
    Parameters:
    
    saveOnChange - whether should save settings right after any changes made or not
  - isSaveDefaultValues
```
public static boolean isSaveDefaultValues()
```
    Sets whether or not should save default value created as a result of get(...) calls.
    
    Returns:
    
    true if should save default value created as a result of get(...) calls, false otherwise
  - setSaveDefaultValues
```
public static void setSaveDefaultValues(boolean saveDefaultValues)
```
    Sets whether or not should save default value created as a result of get(...) calls.
    
    Parameters:
    
    saveDefaultValues - whether or not should save default value created as a result of get(...) calls
  - getSaveOnChangeDelay
```
public static long getSaveOnChangeDelay()
```
    Returns save-on-change delay in milliseconds.
    
    Returns:
    
    save-on-change delay in milliseconds.
  - setSaveOnChangeDelay
```
public static void setSaveOnChangeDelay(long saveOnChangeDelay)
```
    Sets save-on-change delay in milliseconds. If larger than 0 then settings will be accumulated and saved all at once as soon as no new changes came within the delay time.
    
    Parameters:
    
    saveOnChangeDelay - new save-on-change delay in milliseconds
  - isSaveLoggingEnabled
```
public static boolean isSaveLoggingEnabled()
```
    Returns whether settings save log is enabled or not.
    
    Returns:
    
    true if settings save log is enabled, false otherwise
  - setSaveLoggingEnabled
```
public static void setSaveLoggingEnabled(boolean enabled)
```
    Sets whether settings save log is enabled or not.
    
    Parameters:
    
    enabled - whether settings save log is enabled or not
  - isAllowSave
```
public static boolean isAllowSave()
```
    Returns whether should allow saving settings into files or not.
    
    Returns:
    
    true if should allow saving settings into files, false otherwise
  - setAllowSave
```
public static void setAllowSave(boolean allowSave)
```
    Sets whether should allow saving settings into files or not.
    
    Parameters:
    
    allowSave - whether should allow saving settings into files or not
  - disableSave
```
public static void disableSave()
```
    Disables saving settings into files.
  - enableSave
```
public static void enableSave()
```
    Enables saving settings into files.
  - addSettingsListener
```
public static void addSettingsListener(SettingsListener listener)
```
    Adds new global SettingsListener.
    
    Parameters:
    
    listener - SettingsListener to add
  - addSettingsListener
```
public static void addSettingsListener(String key,
                                       SettingsListener listener)
```
    Adds new specific SettingsListener.
    
    Parameters:
    
    key - settings key to listen to
    
    listener - SettingsListener to add
  - addSettingsListener
```
public static void addSettingsListener(String group,
                                       String key,
                                       SettingsListener listener)
```
    Adds new specific SettingsListener.
    
    Parameters:
    
    group - name of the SettingsGroup to add SettingsListener for
    
    key - settings key to listen to
    
    listener - SettingsListener to add
  - removeSettingsListener
```
public static void removeSettingsListener(SettingsListener listener)
```
    Removes global SettingsListener.
    
    Parameters:
    
    listener - SettingsListener to remove
  - removeSettingsListener
```
public static void removeSettingsListener(String key,
                                          SettingsListener listener)
```
    Removes specific SettingsListener.
    
    Parameters:
    
    key - listened settings key
    
    listener - SettingsListener to remove
  - removeSettingsListener
```
public static void removeSettingsListener(String group,
                                          String key,
                                          SettingsListener listener)
```
    Removes specific SettingsListener.
    
    Parameters:
    
    group - name of the SettingsGroup to remove SettingsListener from
    
    key - listened settings key
    
    listener - SettingsListener to remove

Class SettingsManager

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SettingsManager

Method Detail

initialize

getLoadedGroups

getLoadedGroupsMap

get

get

get

get

get

set

set

resetDefaultGroup

resetGroup

resetValue

resetValue

getSettingsGroup

saveSettings

saveSettingsGroup

saveSettingsGroup

getSettingsGroupState

getSettings

getSettings

getSettings

setSettings

settingsExists

getSettingsFilesExtension

setSettingsFilesExtension

getBackupFilesExtension

setBackupFilesExtension

getDefaultSettingsDir

setDefaultSettingsDir

getDefaultSettingsDirName

setDefaultSettingsDirName

getDefaultSettingsGroup

setDefaultSettingsGroup

setGroupFilePath

getGroupFilePath

isSaveOnChange

setSaveOnChange

isSaveDefaultValues

setSaveDefaultValues

getSaveOnChangeDelay

setSaveOnChangeDelay

isSaveLoggingEnabled

setSaveLoggingEnabled

isAllowSave

setAllowSave

disableSave

enableSave

addSettingsListener

addSettingsListener

addSettingsListener

removeSettingsListener

removeSettingsListener

removeSettingsListener