com.atlassian.jira.util

Class JiraDurationUtils.DaysDurationFormatter

java.lang.Object

com.atlassian.jira.util.JiraDurationUtils.DaysDurationFormatter

All Implemented Interfaces:

JiraDurationUtils.DurationFormatter

Enclosing class:

JiraDurationUtils

public static class JiraDurationUtils.DaysDurationFormatter
extends Object
implements JiraDurationUtils.DurationFormatter

This formatter formats time duration to days only. The resulting string returned is a real number representing the number of days. This value is then formatted according to system or user's locale.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_FORMAT_DAYS

Constructor Summary

Constructors

Constructor and Description
DaysDurationFormatter(BigDecimal hoursPerDay, I18nHelper i18nBean)
DaysDurationFormatter(int hoursPerDay, I18nHelper i18nBean) Deprecated. #DaysDurationFormatter(BigDecimal, I18nHelper) is preferred now that we can fractional number of hours per day

Method Summary

Modifier and Type	Method and Description
String	format(Long duration) Converts the given time duration into days and formats it based on the system locale.
String	format(Long duration, Locale locale) Converts the given time duration into days and formats it based on the given user's locale.
BigDecimal	getHoursPerDay()
String	getI18nKey()
String	shortFormat(Long duration) Formats a given time duration with given locale in the most compact way possible.
String	shortFormat(Long duration, Locale locale) Formats a given time duration with the given locale in the most compact way possible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_FORMAT_DAYS

public static final String KEY_FORMAT_DAYS

See Also:

Constant Field Values

Constructor Detail

DaysDurationFormatter

@Deprecated
public DaysDurationFormatter(int hoursPerDay,
                                         I18nHelper i18nBean)

Deprecated. #DaysDurationFormatter(BigDecimal, I18nHelper) is preferred now that we can fractional number of hours per day

Parameters:

hoursPerDay - numbers of hours in a day

i18nBean - i18nHelper to translate strings

DaysDurationFormatter

public DaysDurationFormatter(BigDecimal hoursPerDay,
                             I18nHelper i18nBean)

Method Detail

getI18nKey

public String getI18nKey()

Specified by:

getI18nKey in interface JiraDurationUtils.DurationFormatter

format

public String format(Long duration)

Converts the given time duration into days and formats it based on the system locale. If the duration given is a negative number, returns an empty string.

Specified by:

format in interface JiraDurationUtils.DurationFormatter

Parameters:

duration - time duration to format

Returns:

formatted time duration or an empty string

format

public String format(Long duration,
                     Locale locale)

Converts the given time duration into days and formats it based on the given user's locale. If the duration given is a negative number, returns an empty string.

Specified by:

format in interface JiraDurationUtils.DurationFormatter

Parameters:

duration - time duration to format

locale - user's locale

Returns:

formatted time duration or an empty string

shortFormat

public String shortFormat(Long duration)

Description copied from interface: JiraDurationUtils.DurationFormatter

Formats a given time duration with given locale in the most compact way possible.

Specified by:

shortFormat in interface JiraDurationUtils.DurationFormatter

Parameters:

duration - time duration to format

Returns:

formatted time duration

shortFormat

public String shortFormat(Long duration,
                          Locale locale)

Description copied from interface: JiraDurationUtils.DurationFormatter

Formats a given time duration with the given locale in the most compact way possible

Specified by:

shortFormat in interface JiraDurationUtils.DurationFormatter

Parameters:

duration - time duration in seconds

locale - locale to use

Returns:

formatted time duration

getHoursPerDay

public BigDecimal getHoursPerDay()