Class ConfigFactory
java.lang.Object
org.jfree.report.modules.preferences.base.ConfigFactory
The config factory is used to access the currently active config storage
implementation. The implementation itself allows to read or store a set of properties
stored under a certain path.
- Author:
- Thomas Morgner
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The selector configuration key that defines the active config storage implementation. -
Method Summary
Modifier and TypeMethodDescriptionvoid
defineSystemStorage
(ConfigStorage storage) Defines the system storage implementation that should be used.void
defineUserStorage
(ConfigStorage storage) Defines the user storage implementation that should be used.static String
encodePath
(String path) Encodes the given configuration path.static ConfigFactory
Returns the singleton instance of the config factory.Returns the system settings storage implementation used in the config subsystem.Returns the user settings storage implementation used in the config subsystem.static boolean
isValidPath
(String path) Checks, whether the given string denotes a valid config storage path.
-
Field Details
-
CONFIG_TARGET_KEY
The selector configuration key that defines the active config storage implementation.- See Also:
-
-
Method Details
-
getInstance
Returns the singleton instance of the config factory.- Returns:
- the config factory
-
defineUserStorage
Defines the user storage implementation that should be used. This method should only be called by the module initialization methods.- Parameters:
storage
- the user settings storage implementation.
-
defineSystemStorage
Defines the system storage implementation that should be used. This method should only be called by the module initialization methods.- Parameters:
storage
- the system settings storage implementation.
-
getUserStorage
Returns the user settings storage implementation used in the config subsystem.- Returns:
- the user settingsstorage provider.
-
getSystemStorage
Returns the system settings storage implementation used in the config subsystem.- Returns:
- the system settings storage provider.
-
isValidPath
Checks, whether the given string denotes a valid config storage path. Such an path must not contain whitespaces or non-alphanumeric characters.- Parameters:
path
- the path that should be tested.- Returns:
- true, if the path is valid, false otherwise.
-
encodePath
Encodes the given configuration path. All non-ascii characters get replaced by an escape sequence.- Parameters:
path
- the path.- Returns:
- the translated path.
-