public class

DateTimeFormatterFactoryStub

extends Object
implements DateTimeFormatterFactory
java.lang.Object
   ↳ com.atlassian.jira.datetime.DateTimeFormatterFactoryStub

Class Overview

Stub for DateTimeFormatterFactory, useful for unit tests.

Summary

Public Constructors
DateTimeFormatterFactoryStub()
Public Methods
DateTimeFormatter formatter()
Creates a new DateTimeFormatter that uses the JIRA default time zone, locale, and relative date style.
DateTimeFormatterFactoryStub jiraLocale(Locale locale)
DateTimeFormatterFactoryStub jiraTimeZone(DateTimeZone timeZone)
DateTimeFormatterFactoryStub relativeDates(boolean useRelativeDates)
DateTimeFormatterFactoryStub style(DateTimeStyle style)
DateTimeFormatterFactoryStub userLocale(Locale locale)
DateTimeFormatterFactoryStub userTimeZone(DateTimeZone timeZone)
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.datetime.DateTimeFormatterFactory

Public Constructors

public DateTimeFormatterFactoryStub ()

Public Methods

public DateTimeFormatter formatter ()

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.

Returns
  • a new DateTimeFormatter

public DateTimeFormatterFactoryStub jiraLocale (Locale locale)

public DateTimeFormatterFactoryStub jiraTimeZone (DateTimeZone timeZone)

public DateTimeFormatterFactoryStub relativeDates (boolean useRelativeDates)

public DateTimeFormatterFactoryStub style (DateTimeStyle style)

public DateTimeFormatterFactoryStub userLocale (Locale locale)

public DateTimeFormatterFactoryStub userTimeZone (DateTimeZone timeZone)