Package com.atlassian.confluence.user

Class ConfluenceUserPreferences

java.lang.Object

com.atlassian.confluence.user.ConfluenceUserPreferences

All Implemented Interfaces:

UserPreferences

public class ConfluenceUserPreferences
extends Object
implements UserPreferences

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 final class	ConfluenceUserPreferences.PreferenceException

Constructor Summary

Constructors

Constructor	Description
ConfluenceUserPreferences()	Deprecated. since 8.8.
ConfluenceUserPreferences(@Nullable 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)
Optional<Integer>	getInt(String key)
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	setInt(String key, int 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 Details

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(@Nullable 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 Details

getString

public Optional<String> getString(String key)

Specified by:

getString in interface UserPreferences

Since:

8.8

getBoolean

public Optional<Boolean> getBoolean(String key)

Specified by:

getBoolean in interface UserPreferences

Since:

8.8

getLong

public Optional<Long> getLong(String key)

Specified by:

getLong in interface UserPreferences

Since:

8.8

getInt

public Optional<Integer> getInt(String key)

Since:

9.3

setString

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

Specified by:

setString in interface UserPreferences

Throws:

ConfluenceUserPreferences.PreferenceException

Since:

8.8

setLong

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

Specified by:

setLong in interface UserPreferences

Throws:

ConfluenceUserPreferences.PreferenceException

Since:

8.8

setInt

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

Throws:

ConfluenceUserPreferences.PreferenceException

Since:

9.3

setBoolean

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

Specified by:

setBoolean in interface UserPreferences

Throws:

ConfluenceUserPreferences.PreferenceException

Since:

8.8

remove

public void remove(String key)
            throws ConfluenceUserPreferences.PreferenceException

Specified by:

remove in interface UserPreferences

Throws:

ConfluenceUserPreferences.PreferenceException

Since:

8.8

getTimeZone

public TimeZone getTimeZone()

Specified by:

getTimeZone in interface UserPreferences

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.

Specified by:

getLocale in interface UserPreferences

isShowDifferencesInNotificationEmails

public boolean isShowDifferencesInNotificationEmails()

Specified by:

isShowDifferencesInNotificationEmails in interface UserPreferences

isWatchingOwnContent

public boolean isWatchingOwnContent()

Specified by:

isWatchingOwnContent in interface UserPreferences

getWrappedPreferences

@Deprecated
public UserPreferences getWrappedPreferences()

Deprecated.

since 8.8 No. Just, no.