com.atlassian.jira.user.preferences

Interface UserPreferencesManager

All Known Implementing Classes:

DefaultUserPreferencesManager, MockUserPreferencesManager

@PublicApi
public interface UserPreferencesManager

A simple manager for retrieving, caching and updating user preferences objects.

Since:

3.10

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCache() Deprecated. These objects are flyweights so there is no longer any point in them being cached. This method no longer does anything. Since v6.2.
ExtendedPreferences	getExtendedPreferences(ApplicationUser user) Returns The user preferences for a user.
com.atlassian.core.user.preferences.Preferences	getPreferences(ApplicationUser user) Deprecated. Use getExtendedPreferences(ApplicationUser) instead. Since v6.0.
com.atlassian.core.user.preferences.Preferences	getPreferences(com.atlassian.crowd.embedded.api.User user) Deprecated. Use getExtendedPreferences(ApplicationUser) instead. Since v6.0.

Method Detail

getExtendedPreferences

ExtendedPreferences getExtendedPreferences(ApplicationUser user)

Returns The user preferences for a user. If user is null, then the preferences will be for an anonymous user and reflect only the system's default settings. The preferences for the anonymous user cannot be modified directly.

Returns:

The user preferences for a user.

getPreferences

com.atlassian.core.user.preferences.Preferences getPreferences(ApplicationUser user)

Deprecated. Use getExtendedPreferences(ApplicationUser) instead. Since v6.0.

Returns The user preferences for a user. If user is null, then the preferences will be for an anonymous user and reflect only the system's default settings. The preferences for the anonymous user cannot be modified directly. Although not declared as such to avoid breaking API use of this method, the returned preferences object is guaranteed to implement ExtendedPreferences.

Returns:

The user preferences for a user.

getPreferences

com.atlassian.core.user.preferences.Preferences getPreferences(com.atlassian.crowd.embedded.api.User user)

Deprecated. Use getExtendedPreferences(ApplicationUser) instead. Since v6.0.

Returns The user preferences for a user. If user is null, then the preferences will be for an anonymous user and reflect only the system's default settings. The preferences for the anonymous user cannot be modified directly. Although not declared as such to avoid breaking API use of this method, the returned preferences object is guaranteed to implement ExtendedPreferences.

Returns:

The user preferences for a user.

clearCache

void clearCache()

Deprecated. These objects are flyweights so there is no longer any point in them being cached. This method no longer does anything. Since v6.2.