Package org.openstreetmap.josm.data

Class PreferencesUtils

java.lang.Object

org.openstreetmap.josm.data.PreferencesUtils

public final class PreferencesUtils
extends java.lang.Object

Helper class to do specific Preferences operation - appending, replacing, deletion by key and by value

Since:

12634 (extracted from CustomConfigurator)

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.StringBuilder	summary

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PreferencesUtils()

Method Summary

Modifier and Type	Method	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	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 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	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)

Methods inherited from class java.lang.Object

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

Field Detail

summary

private static volatile java.lang.StringBuilder summary

Constructor Detail

PreferencesUtils

private PreferencesUtils()

Method Detail

log

public static void log(java.lang.String fmt,
                       java.lang.Object... vars)

Log a formatted message.

Parameters:

fmt - format

vars - arguments

Since:

12826

See Also:

String.format(java.lang.String, java.lang.Object...)

log

public static void log(java.lang.String s)

Log a message.

Parameters:

s - message to log

Since:

12826

log

public static void log(java.lang.Exception e,
                       java.lang.String s)

Log an exception.

Parameters:

e - exception to log

s - message prefix

Since:

12826

getLog

public static java.lang.String getLog()

Returns the log.

Returns:

the log

Since:

12826

resetLog

public static void resetLog()

Resets the log.

Since:

12826

replacePreferences

public static void replacePreferences(Preferences fragment,
                                      Preferences mainpref)

appendPreferences

public static void appendPreferences(Preferences fragment,
                                     Preferences mainpref)

deletePreferenceValues

public static void deletePreferenceValues(Preferences fragment,
                                          Preferences mainpref)

Delete items from mainpref collections that match items from fragment collections.

Parameters:

fragment - preferences

mainpref - main preferences

deletePreferenceKeyByPattern

public static void deletePreferenceKeyByPattern(java.lang.String pattern,
                                                Preferences pref)

deletePreferenceKey

public static void deletePreferenceKey(java.lang.String key,
                                       Preferences pref)

getList

private static java.util.List<java.lang.String> getList(Preferences mainpref,
                                                        java.lang.String key,
                                                        boolean warnUnknownDefault)

getListOfLists

private static java.util.List<java.util.List<java.lang.String>> getListOfLists(Preferences mainpref,
                                                                               java.lang.String key,
                                                                               boolean warnUnknownDefault)

getListOfStructs

private static java.util.List<java.util.Map<java.lang.String,java.lang.String>> getListOfStructs(Preferences mainpref,
                                                                                                       java.lang.String key,
                                                                                                       boolean warnUnknownDefault)

defaultUnknownWarning

private static void defaultUnknownWarning(java.lang.String key)

showPrefs

public static void showPrefs(Preferences tmpPref)

getBoolean

public static boolean getBoolean(IPreferences prefs,
                                 java.lang.String key,
                                 java.lang.String specName,
                                 boolean def)

Gets an boolean that may be specialized

Parameters:

prefs - the preferences

key - The basic key

specName - The sub-key to append to the key

def - The default value

Returns:

The boolean value or the default value if it could not be parsed

Since:

12891

getInteger

public static int getInteger(IPreferences prefs,
                             java.lang.String key,
                             java.lang.String specName,
                             int def)

Gets an integer that may be specialized

Parameters:

prefs - the preferences

key - The basic key

specName - The sub-key to append to the key

def - The default value

Returns:

The integer value or the default value if it could not be parsed

Since:

12891

removeFromList

public static void removeFromList(IPreferences prefs,
                                  java.lang.String key,
                                  java.lang.String value)

Removes a value from a given String list

Parameters:

prefs - the preferences

key - The preference key the list is stored with

value - The value that should be removed in the list

Since:

12894

putListBounded

public 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.

Parameters:

prefs - the preferences

key - key

maxsize - max number of items to save

val - value

Returns:

true, if something has changed (i.e. value is different than before)

Since:

12894