com.atlassian.sal.api.timezone

Interface TimeZoneManager

public interface TimeZoneManager

Since:

v2.6.0

Method Summary

Modifier and Type	Method and Description
TimeZone	getDefaultTimeZone() Returns the default time zone for the application.
TimeZone	getUserTimeZone() Returns the time zone of the logged in user.
TimeZone	getUserTimeZone(UserKey user) Returns the time zone of the given user.

Method Detail

getUserTimeZone

@Nonnull
TimeZone getUserTimeZone()

Returns the time zone of the logged in user. NB: This is guaranteed to return a non-null value. If no user is logged in (anonymous user) or the system doesn't support time zone configuration or no specific time zone is configured, it should still return a time zone. (e.g. the default time zone for the system).

Returns:

the user's time zone. Should never return null.

getUserTimeZone

@Nonnull
TimeZone getUserTimeZone(@Nonnull
                                  UserKey user)

Returns the time zone of the given user. NB: This is guaranteed to return a non-null value. If given user doesn't exists or invalid or the system doesn't support time zone configuration or no specific time zone is configured, for the given user then method still returns a time zone. (e.g. the default time zone for the system).

Parameters:

user - to return time zone for

Returns:

the user's time zone or default time if user not found, is invalid or has no specific time zone configured

Throws:

NullPointerException - if given user is null

Since:

v2.13.0

getDefaultTimeZone

@Nonnull
TimeZone getDefaultTimeZone()

Returns the default time zone for the application. NB: This is guaranteed to return a non-null value. If the system doesn't support time zone configuration, it should still return a time zone (e.g. the JVM time zone).

Returns:

the default time zone of the system. Should never return null.