Interface UserProfile
public interface UserProfile
A user profile, where user preferences can be stored.
In MMStudio and its plugins, all user preferences should be stored in the current user profile, not in the standard Java preferences.
This works similarly to Preferences, except that
it is possible to switch between multiple profiles within a single operating
system user account. This is provided because sharing an OS account by all
users is a widespread practice on computers attached to scientific equipment.
The user profile stores the same kinds of values as PropertyMap,
but is mutable and periodically saves any modifications (if thus set up by
the system).
-
Method Summary
Modifier and TypeMethodDescriptionvoidReset this user profile, deleting all settings.getBoolean(Class<?> c, String key, Boolean fallback) Deprecated.Boolean[]getBooleanArray(Class<?> c, String key, Boolean[] fallback) Deprecated.usegetSettings(c).getBooleanList(key, fallback)insteadDeprecated.usegetSettings(c).getDouble(key, fallback)insteadDouble[]getDoubleArray(Class<?> c, String key, Double[] fallback) Deprecated.usegetSettings(c).getDoubleList(key, fallback)insteadDeprecated.usegetSettings(c).getInteger(key, fallback)insteadInteger[]getIntArray(Class<?> c, String key, Integer[] fallback) Deprecated.usegetSettings(c).getIntegerList(key, fallback)insteadDeprecated.usegetSettings(c).getLong(key, fallback)insteadLong[]getLongArray(Class<?> c, String key, Long[] fallback) Deprecated.usegetSettings(c).getLongList(key, fallback)insteadReturns the name of this profile as displayed to the user.getSettings(Class<?> owner) Get an interface to save and retrieve settings.Deprecated.usegetSettings(c).getString(key, fallback)insteadString[]getStringArray(Class<?> c, String key, String[] fallback) Deprecated.usegetSettings(c).getStringList(key, fallback)insteadvoidsetBoolean(Class<?> c, String key, Boolean value) Deprecated.usegetSettings(c).putBoolean(key, value)insteadvoidsetBooleanArray(Class<?> c, String key, Boolean[] value) Deprecated.usegetSettings(c).putBooleanList(key, value)insteadvoidDeprecated.usegetSettings(c).putDouble(key, value)insteadvoidsetDoubleArray(Class<?> c, String key, Double[] value) Deprecated.usegetSettings(c).putDoubleList(key, value)insteadvoidDeprecated.usegetSettings(c).putInteger(key, value)insteadvoidsetIntArray(Class<?> c, String key, Integer[] value) Deprecated.usegetSettings(c).putIntegerList(key, value)insteadvoidDeprecated.usegetSettings(c).putLong(key, value)insteadvoidsetLongArray(Class<?> c, String key, Long[] value) Deprecated.usegetSettings(c).putLongList(key, value)insteadvoidDeprecated.usegetSettings(c).putString(key, value)insteadvoidsetStringArray(Class<?> c, String key, String[] value) Deprecated.usegetSettings(c).putStringList(key, value)instead
-
Method Details
-
getProfileName
String getProfileName()Returns the name of this profile as displayed to the user.- Returns:
- the profile name
-
getSettings
Get an interface to save and retrieve settings.This is the main interface for accessing values in the user profile.
- Parameters:
owner- the class that "owns" the settings- Returns:
- an object allowing settings to be set and retrieved
-
clearSettingsForAllClasses
void clearSettingsForAllClasses()Reset this user profile, deleting all settings.Do not confuse with
getSettings(owner).clear()! -
getString
Deprecated.usegetSettings(c).getString(key, fallback)insteadDeprecated. -
getStringArray
Deprecated.usegetSettings(c).getStringList(key, fallback)insteadDeprecated. -
setString
Deprecated.usegetSettings(c).putString(key, value)insteadDeprecated. -
setStringArray
Deprecated.usegetSettings(c).putStringList(key, value)insteadDeprecated. -
getInt
Deprecated.usegetSettings(c).getInteger(key, fallback)insteadDeprecated. -
getIntArray
Deprecated.usegetSettings(c).getIntegerList(key, fallback)insteadDeprecated. -
setInt
Deprecated.usegetSettings(c).putInteger(key, value)insteadDeprecated. -
setIntArray
Deprecated.usegetSettings(c).putIntegerList(key, value)insteadDeprecated. -
getLong
Deprecated.usegetSettings(c).getLong(key, fallback)insteadDeprecated. -
getLongArray
Deprecated.usegetSettings(c).getLongList(key, fallback)insteadDeprecated. -
setLong
Deprecated.usegetSettings(c).putLong(key, value)insteadDeprecated. -
setLongArray
Deprecated.usegetSettings(c).putLongList(key, value)insteadDeprecated. -
getDouble
Deprecated.usegetSettings(c).getDouble(key, fallback)insteadDeprecated. -
getDoubleArray
Deprecated.usegetSettings(c).getDoubleList(key, fallback)insteadDeprecated. -
setDouble
Deprecated.usegetSettings(c).putDouble(key, value)insteadDeprecated. -
setDoubleArray
Deprecated.usegetSettings(c).putDoubleList(key, value)insteadDeprecated. -
getBoolean
Deprecated.usegetSettings(c).getBoolean(key, fallback)insteadDeprecated. -
getBooleanArray
Deprecated.usegetSettings(c).getBooleanList(key, fallback)insteadDeprecated. -
setBoolean
Deprecated.usegetSettings(c).putBoolean(key, value)insteadDeprecated. -
setBooleanArray
Deprecated.usegetSettings(c).putBooleanList(key, value)insteadDeprecated.
-
getSettings(c).getBoolean(key, fallback)instead