org.micromanager

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 Type	Method and Description
void	clearSettingsForAllClasses() Reset this user profile, deleting all settings.
java.lang.Boolean	getBoolean(java.lang.Class<?> c, java.lang.String key, java.lang.Boolean fallback) Deprecated. use getSettings(c).getBoolean(key, fallback) instead
java.lang.Boolean[]	getBooleanArray(java.lang.Class<?> c, java.lang.String key, java.lang.Boolean[] fallback) Deprecated. use getSettings(c).getBooleanList(key, fallback) instead
java.lang.Double	getDouble(java.lang.Class<?> c, java.lang.String key, java.lang.Double fallback) Deprecated. use getSettings(c).getDouble(key, fallback) instead
java.lang.Double[]	getDoubleArray(java.lang.Class<?> c, java.lang.String key, java.lang.Double[] fallback) Deprecated. use getSettings(c).getDoubleList(key, fallback) instead
java.lang.Integer	getInt(java.lang.Class<?> c, java.lang.String key, java.lang.Integer fallback) Deprecated. use getSettings(c).getInteger(key, fallback) instead
java.lang.Integer[]	getIntArray(java.lang.Class<?> c, java.lang.String key, java.lang.Integer[] fallback) Deprecated. use getSettings(c).getIntegerList(key, fallback) instead
java.lang.Long	getLong(java.lang.Class<?> c, java.lang.String key, java.lang.Long fallback) Deprecated. use getSettings(c).getLong(key, fallback) instead
java.lang.Long[]	getLongArray(java.lang.Class<?> c, java.lang.String key, java.lang.Long[] fallback) Deprecated. use getSettings(c).getLongList(key, fallback) instead
java.lang.String	getProfileName() Returns the name of this profile as displayed to the user.
MutablePropertyMapView	getSettings(java.lang.Class<?> owner) Get an interface to save and retrieve settings.
java.lang.String	getString(java.lang.Class<?> c, java.lang.String key, java.lang.String fallback) Deprecated. use getSettings(c).getString(key, fallback) instead
java.lang.String[]	getStringArray(java.lang.Class<?> c, java.lang.String key, java.lang.String[] fallback) Deprecated. use getSettings(c).getStringList(key, fallback) instead
void	setBoolean(java.lang.Class<?> c, java.lang.String key, java.lang.Boolean value) Deprecated. use getSettings(c).putBoolean(key, value) instead
void	setBooleanArray(java.lang.Class<?> c, java.lang.String key, java.lang.Boolean[] value) Deprecated. use getSettings(c).putBooleanList(key, value) instead
void	setDouble(java.lang.Class<?> c, java.lang.String key, java.lang.Double value) Deprecated. use getSettings(c).putDouble(key, value) instead
void	setDoubleArray(java.lang.Class<?> c, java.lang.String key, java.lang.Double[] value) Deprecated. use getSettings(c).putDoubleList(key, value) instead
void	setInt(java.lang.Class<?> c, java.lang.String key, java.lang.Integer value) Deprecated. use getSettings(c).putInteger(key, value) instead
void	setIntArray(java.lang.Class<?> c, java.lang.String key, java.lang.Integer[] value) Deprecated. use getSettings(c).putIntegerList(key, value) instead
void	setLong(java.lang.Class<?> c, java.lang.String key, java.lang.Long value) Deprecated. use getSettings(c).putLong(key, value) instead
void	setLongArray(java.lang.Class<?> c, java.lang.String key, java.lang.Long[] value) Deprecated. use getSettings(c).putLongList(key, value) instead
void	setString(java.lang.Class<?> c, java.lang.String key, java.lang.String value) Deprecated. use getSettings(c).putString(key, value) instead
void	setStringArray(java.lang.Class<?> c, java.lang.String key, java.lang.String[] value) Deprecated. use getSettings(c).putStringList(key, value) instead

Method Detail

getProfileName

java.lang.String getProfileName()

Returns the name of this profile as displayed to the user.

Returns:

the profile name

getSettings

MutablePropertyMapView getSettings(java.lang.Class<?> owner)

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
java.lang.String getString(java.lang.Class<?> c,
                                       java.lang.String key,
                                       java.lang.String fallback)

Deprecated. use getSettings(c).getString(key, fallback) instead

Deprecated.

getStringArray

@Deprecated
java.lang.String[] getStringArray(java.lang.Class<?> c,
                                              java.lang.String key,
                                              java.lang.String[] fallback)

Deprecated. use getSettings(c).getStringList(key, fallback) instead

Deprecated.

setString

@Deprecated
void setString(java.lang.Class<?> c,
                           java.lang.String key,
                           java.lang.String value)

Deprecated. use getSettings(c).putString(key, value) instead

Deprecated.

setStringArray

@Deprecated
void setStringArray(java.lang.Class<?> c,
                                java.lang.String key,
                                java.lang.String[] value)

Deprecated. use getSettings(c).putStringList(key, value) instead

Deprecated.

getInt

@Deprecated
java.lang.Integer getInt(java.lang.Class<?> c,
                                     java.lang.String key,
                                     java.lang.Integer fallback)

Deprecated. use getSettings(c).getInteger(key, fallback) instead

Deprecated.

getIntArray

@Deprecated
java.lang.Integer[] getIntArray(java.lang.Class<?> c,
                                            java.lang.String key,
                                            java.lang.Integer[] fallback)

Deprecated. use getSettings(c).getIntegerList(key, fallback) instead

Deprecated.

setInt

@Deprecated
void setInt(java.lang.Class<?> c,
                        java.lang.String key,
                        java.lang.Integer value)

Deprecated. use getSettings(c).putInteger(key, value) instead

Deprecated.

setIntArray

@Deprecated
void setIntArray(java.lang.Class<?> c,
                             java.lang.String key,
                             java.lang.Integer[] value)

Deprecated. use getSettings(c).putIntegerList(key, value) instead

Deprecated.

getLong

@Deprecated
java.lang.Long getLong(java.lang.Class<?> c,
                                   java.lang.String key,
                                   java.lang.Long fallback)

Deprecated. use getSettings(c).getLong(key, fallback) instead

Deprecated.

getLongArray

@Deprecated
java.lang.Long[] getLongArray(java.lang.Class<?> c,
                                          java.lang.String key,
                                          java.lang.Long[] fallback)

Deprecated. use getSettings(c).getLongList(key, fallback) instead

Deprecated.

setLong

@Deprecated
void setLong(java.lang.Class<?> c,
                         java.lang.String key,
                         java.lang.Long value)

Deprecated. use getSettings(c).putLong(key, value) instead

Deprecated.

setLongArray

@Deprecated
void setLongArray(java.lang.Class<?> c,
                              java.lang.String key,
                              java.lang.Long[] value)

Deprecated. use getSettings(c).putLongList(key, value) instead

Deprecated.

getDouble

@Deprecated
java.lang.Double getDouble(java.lang.Class<?> c,
                                       java.lang.String key,
                                       java.lang.Double fallback)

Deprecated. use getSettings(c).getDouble(key, fallback) instead

Deprecated.

getDoubleArray

@Deprecated
java.lang.Double[] getDoubleArray(java.lang.Class<?> c,
                                              java.lang.String key,
                                              java.lang.Double[] fallback)

Deprecated. use getSettings(c).getDoubleList(key, fallback) instead

Deprecated.

setDouble

@Deprecated
void setDouble(java.lang.Class<?> c,
                           java.lang.String key,
                           java.lang.Double value)

Deprecated. use getSettings(c).putDouble(key, value) instead

Deprecated.

setDoubleArray

@Deprecated
void setDoubleArray(java.lang.Class<?> c,
                                java.lang.String key,
                                java.lang.Double[] value)

Deprecated. use getSettings(c).putDoubleList(key, value) instead

Deprecated.

getBoolean

@Deprecated
java.lang.Boolean getBoolean(java.lang.Class<?> c,
                                         java.lang.String key,
                                         java.lang.Boolean fallback)

Deprecated. use getSettings(c).getBoolean(key, fallback) instead

Deprecated.

getBooleanArray

@Deprecated
java.lang.Boolean[] getBooleanArray(java.lang.Class<?> c,
                                                java.lang.String key,
                                                java.lang.Boolean[] fallback)

Deprecated. use getSettings(c).getBooleanList(key, fallback) instead

Deprecated.

setBoolean

@Deprecated
void setBoolean(java.lang.Class<?> c,
                            java.lang.String key,
                            java.lang.Boolean value)

Deprecated. use getSettings(c).putBoolean(key, value) instead

Deprecated.

setBooleanArray

@Deprecated
void setBooleanArray(java.lang.Class<?> c,
                                 java.lang.String key,
                                 java.lang.Boolean[] value)

Deprecated. use getSettings(c).putBooleanList(key, value) instead

Deprecated.