View Javadoc

1   package com.atlassian.sal.api.timezone;
2   
3   import java.util.TimeZone;
4   
5   /**
6    *
7    * @since v2.6.0
8    */
9   public interface TimeZoneManager
10  {
11  
12      /**
13       * Returns the time zone of the logged in user.
14       * NB: This is guaranteed to return a non-null value.
15       * If no user is logged in (anonymous user) or the system doesn't support time zone configuration or no specific time zone is configured,
16       * it should still return a time zone. (e.g. the default time zone for the system).
17       *
18       * @return the user's time zone. Should never return null.
19       */
20      TimeZone getUserTimeZone();
21  
22      /**
23       * Returns the default time zone for the application.
24       * NB: This is guaranteed to return a non-null value.
25       *
26       * If the system doesn't support time zone configuration, it should still return a time zone (e.g. the JVM time zone).
27       *
28       * @return the default time zone of the system. Should never return null.
29       */
30      TimeZone getDefaultTimeZone();
31  }