Package com.atlassian.confluence.user

Class ConfluenceUserPreferences

java.lang.Object

com.atlassian.confluence.user.ConfluenceUserPreferences

public class ConfluenceUserPreferences
extends Object

Provides strongly-typed accessors for Confluence user preferences. Use the no-args constructor for sensible defaults for anonymous user preferences.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConfluenceUserPreferences.PreferenceException

Constructor Summary

Constructors

Constructor	Description
ConfluenceUserPreferences()	Deprecated. since 8.8.
ConfluenceUserPreferences(com.opensymphony.module.propertyset.PropertySet properties)	Deprecated. since 8.8.

Method Summary

Modifier and Type	Method	Description
Optional<Boolean>	getBoolean(String key)
DateFormatter	getDateFormatter(FormatSettingsManager formatSettingsManager, LocaleManager localeManager)	Deprecated. since 8.8 use getTimeZone() and DateFormatter(java.util.TimeZone, FormatSettingsManager, LocaleManager)
Locale	getLocale()	Returns the user's preferred locale, or null if the site default locale should be used.
Optional<Long>	getLong(String key)
Optional<String>	getString(String key)
TimeZone	getTimeZone()
UserPreferences	getWrappedPreferences()	Deprecated. since 8.8 No.
boolean	isShowDifferencesInNotificationEmails()
boolean	isWatchingOwnContent()
void	remove(String key)
void	setBoolean(String key, boolean value)
void	setLong(String key, long value)
void	setString(String key, String value)
void	setTimeZone(String timeZoneID)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfluenceUserPreferences

@Deprecated
public ConfluenceUserPreferences()

Deprecated.

since 8.8. Use UserPreferencesAccessor.getConfluenceUserPreferences(com.atlassian.user.User)

No-args constructor is used for anonymous user preferences

ConfluenceUserPreferences

@Deprecated
public ConfluenceUserPreferences(com.opensymphony.module.propertyset.PropertySet properties)

Deprecated.

since 8.8. Use UserPreferencesAccessor.getConfluenceUserPreferences(com.atlassian.user.User)

Parameters:

properties - the PropertySet containing a user's preferences

Method Detail

getString

public Optional<String> getString(String key)

Since:

8.8

getBoolean

public Optional<Boolean> getBoolean(String key)

Since:

8.8

getLong

public Optional<Long> getLong(String key)

Since:

8.8

setString

public void setString(String key,
                      String value)
               throws ConfluenceUserPreferences.PreferenceException

Throws:

ConfluenceUserPreferences.PreferenceException

Since:

8.8

setLong

public void setLong(String key,
                    long value)
             throws ConfluenceUserPreferences.PreferenceException

Throws:

ConfluenceUserPreferences.PreferenceException

Since:

8.8

setBoolean

public void setBoolean(String key,
                       boolean value)
                throws ConfluenceUserPreferences.PreferenceException

Throws:

ConfluenceUserPreferences.PreferenceException

Since:

8.8

remove

public void remove(String key)
            throws ConfluenceUserPreferences.PreferenceException

Throws:

ConfluenceUserPreferences.PreferenceException

Since:

8.8

getTimeZone

public TimeZone getTimeZone()

getDateFormatter

@Deprecated
public DateFormatter getDateFormatter(FormatSettingsManager formatSettingsManager,
                                      LocaleManager localeManager)

Deprecated.

since 8.8 use getTimeZone() and DateFormatter(java.util.TimeZone, FormatSettingsManager, LocaleManager)

setTimeZone

public void setTimeZone(String timeZoneID)
                 throws com.atlassian.core.AtlassianCoreException

Throws:

com.atlassian.core.AtlassianCoreException

getLocale

public Locale getLocale()

Returns the user's preferred locale, or null if the site default locale should be used.

isShowDifferencesInNotificationEmails

public boolean isShowDifferencesInNotificationEmails()

isWatchingOwnContent

public boolean isWatchingOwnContent()

getWrappedPreferences

@Deprecated
public UserPreferences getWrappedPreferences()

Deprecated.

since 8.8 No. Just, no.