com.atlassian.jira.datetime
Class DateTimeFormatterFactoryImpl

java.lang.Object
  extended by com.atlassian.jira.datetime.DateTimeFormatterFactoryImpl
All Implemented Interfaces:
DateTimeFormatterFactory

public class DateTimeFormatterFactoryImpl
extends Object
implements DateTimeFormatterFactory

This class is responsible for providing DateTimeFormatter instances to JIRA and plugin code.

Since:
v4.4

Constructor Summary
DateTimeFormatterFactoryImpl(TimeZoneResolver timeZoneResolver, JiraAuthenticationContext jiraAuthenticationContext, ApplicationProperties applicationProperties, I18nHelper.BeanFactory i18nFactory)
           
 
Method Summary
 DateTimeFormatter formatter()
          Creates a new DateTimeFormatter that uses the JIRA default time zone, locale, and relative date style.
 void onClearCache(ClearCacheEvent event)
          Clears this instance's cache.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DateTimeFormatterFactoryImpl

public DateTimeFormatterFactoryImpl(TimeZoneResolver timeZoneResolver,
                                    JiraAuthenticationContext jiraAuthenticationContext,
                                    ApplicationProperties applicationProperties,
                                    I18nHelper.BeanFactory i18nFactory)
Method Detail

formatter

public DateTimeFormatter formatter()
Description copied from interface: DateTimeFormatterFactory
Creates a new DateTimeFormatter that uses the JIRA default time zone, locale, and relative date style. To get a "smart" formatter that automatically uses the time zone and locale of the currently logged in user, create a new formatter by calling DateTimeFormatter.forLoggedInUser() on the formatter returned by this method, e.g.:

     DateTimeFormatter userFormatter = dateTimeFormatterFactory.formatter().forLoggedInUser();
 
Note that since JIRA 5.0 you can get a DateTimeFormatter injected directly into your class (in that case there is no need to use this factory class).

A formatter obtained in this fashion may be safely reused across requests.

Specified by:
formatter in interface DateTimeFormatterFactory
Returns:
a new DateTimeFormatter

onClearCache

@EventListener
public void onClearCache(ClearCacheEvent event)
Clears this instance's cache.

Parameters:
event - a ClearCacheEvent


Copyright © 2002-2013 Atlassian. All Rights Reserved.