Summary: Methods | [Expand All]
@PublicApi public interface

UserPreferencesManager

com.atlassian.jira.user.preferences.UserPreferencesManager
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

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

Summary

Public Methods
void clearCache()
This method is 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.
Preferences getPreferences(ApplicationUser user)
This method is deprecated. Use getExtendedPreferences(ApplicationUser) instead. Since v6.0.

Public Methods

public void clearCache ()

This method is 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.

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

public Preferences getPreferences (ApplicationUser user)

This method is 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.