public final class PreferencesUtils extends java.lang.Object
CustomConfigurator
)Modifier and Type | Field and Description |
---|---|
private static java.lang.StringBuilder |
summary |
Modifier | Constructor and Description |
---|---|
private |
PreferencesUtils() |
Modifier and Type | Method and Description |
---|---|
static void |
appendPreferences(Preferences fragment,
Preferences mainpref) |
private static void |
defaultUnknownWarning(java.lang.String key) |
static void |
deletePreferenceKey(java.lang.String key,
Preferences pref) |
static void |
deletePreferenceKeyByPattern(java.lang.String pattern,
Preferences pref) |
static void |
deletePreferenceValues(Preferences fragment,
Preferences mainpref)
Delete items from
mainpref collections that match items from fragment collections. |
static boolean |
getBoolean(IPreferences prefs,
java.lang.String key,
java.lang.String specName,
boolean def)
Gets an boolean that may be specialized
|
static int |
getInteger(IPreferences prefs,
java.lang.String key,
java.lang.String specName,
int def)
Gets an integer that may be specialized
|
private static java.util.List<java.lang.String> |
getList(Preferences mainpref,
java.lang.String key,
boolean warnUnknownDefault) |
private static java.util.List<java.util.List<java.lang.String>> |
getListOfLists(Preferences mainpref,
java.lang.String key,
boolean warnUnknownDefault) |
private static java.util.List<java.util.Map<java.lang.String,java.lang.String>> |
getListOfStructs(Preferences mainpref,
java.lang.String key,
boolean warnUnknownDefault) |
static java.lang.String |
getLog()
Returns the log.
|
static void |
loadPrefsToJS(javax.script.ScriptEngine engine,
Preferences tmpPref,
java.lang.String whereToPutInJS,
boolean includeDefaults)
Convert preferences data structures to JavaScript object
|
static void |
log(java.lang.Exception e,
java.lang.String s)
Log an exception.
|
static void |
log(java.lang.String s)
Log a message.
|
static void |
log(java.lang.String fmt,
java.lang.Object... vars)
Log a formatted message.
|
static void |
modifyPreferencesByScript(javax.script.ScriptEngine engine,
Preferences tmpPref,
java.lang.String js) |
static boolean |
putListBounded(IPreferences prefs,
java.lang.String key,
int maxsize,
java.util.List<java.lang.String> val)
Saves at most
maxsize items of list val . |
static void |
readPrefsFromJS(javax.script.ScriptEngine engine,
Preferences tmpPref,
java.lang.String varInJS)
Convert JavaScript preferences object to preferences data structures
|
static void |
removeFromList(IPreferences prefs,
java.lang.String key,
java.lang.String value)
Removes a value from a given String list
|
static void |
replacePreferences(Preferences fragment,
Preferences mainpref) |
static void |
resetLog()
Resets the log.
|
static void |
showPrefs(Preferences tmpPref) |
private static volatile java.lang.StringBuilder summary
private PreferencesUtils()
public static void log(java.lang.String fmt, java.lang.Object... vars)
fmt
- formatvars
- argumentsString.format(java.lang.String, java.lang.Object...)
public static void log(java.lang.String s)
s
- message to logpublic static void log(java.lang.Exception e, java.lang.String s)
e
- exception to logs
- message prefixpublic static java.lang.String getLog()
public static void resetLog()
public static void replacePreferences(Preferences fragment, Preferences mainpref)
public static void appendPreferences(Preferences fragment, Preferences mainpref)
public static void deletePreferenceValues(Preferences fragment, Preferences mainpref)
mainpref
collections that match items from fragment
collections.fragment
- preferencesmainpref
- main preferencespublic static void deletePreferenceKeyByPattern(java.lang.String pattern, Preferences pref)
public static void deletePreferenceKey(java.lang.String key, Preferences pref)
private static java.util.List<java.lang.String> getList(Preferences mainpref, java.lang.String key, boolean warnUnknownDefault)
private static java.util.List<java.util.List<java.lang.String>> getListOfLists(Preferences mainpref, java.lang.String key, boolean warnUnknownDefault)
private static java.util.List<java.util.Map<java.lang.String,java.lang.String>> getListOfStructs(Preferences mainpref, java.lang.String key, boolean warnUnknownDefault)
private static void defaultUnknownWarning(java.lang.String key)
public static void showPrefs(Preferences tmpPref)
public static void modifyPreferencesByScript(javax.script.ScriptEngine engine, Preferences tmpPref, java.lang.String js) throws javax.script.ScriptException
javax.script.ScriptException
public static void readPrefsFromJS(javax.script.ScriptEngine engine, Preferences tmpPref, java.lang.String varInJS) throws javax.script.ScriptException
engine
- - JS engine to put objecttmpPref
- - preferences to fill from JSvarInJS
- - JS variable name, where preferences are storedjavax.script.ScriptException
- if the evaluation failspublic static void loadPrefsToJS(javax.script.ScriptEngine engine, Preferences tmpPref, java.lang.String whereToPutInJS, boolean includeDefaults) throws javax.script.ScriptException
engine
- - JS engine to put objecttmpPref
- - preferences to convertwhereToPutInJS
- - variable name to store preferences in JSincludeDefaults
- - include known default values to JS objectsjavax.script.ScriptException
- if the evaluation failspublic static boolean getBoolean(IPreferences prefs, java.lang.String key, java.lang.String specName, boolean def)
prefs
- the preferenceskey
- The basic keyspecName
- The sub-key to append to the keydef
- The default valuepublic static int getInteger(IPreferences prefs, java.lang.String key, java.lang.String specName, int def)
prefs
- the preferenceskey
- The basic keyspecName
- The sub-key to append to the keydef
- The default valuepublic static void removeFromList(IPreferences prefs, java.lang.String key, java.lang.String value)
prefs
- the preferenceskey
- The preference key the list is stored withvalue
- The value that should be removed in the listpublic static boolean putListBounded(IPreferences prefs, java.lang.String key, int maxsize, java.util.List<java.lang.String> val)
maxsize
items of list val
.prefs
- the preferenceskey
- keymaxsize
- max number of items to saveval
- valuetrue
, if something has changed (i.e. value is different than before)