com.atlassian.jira.util
Interface JiraDurationUtils.DurationFormatter

All Known Implementing Classes:

JiraDurationUtils.DaysDurationFormatter, JiraDurationUtils.HoursDurationFormatter, JiraDurationUtils.PrettyDurationFormatter

Enclosing class:

JiraDurationUtils

public static interface JiraDurationUtils.DurationFormatter

This interface defines methods for formatting time duration

Method Summary

String	format(Long duration) Formats a given time duration with default (system) locale.
String	format(Long duration, Locale locale) Formats a given time duration with given locale.
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

Method Detail

getI18nKey

String getI18nKey()

format

String format(Long duration)

Formats a given time duration with default (system) locale.

Parameters:

duration - time duration to format

Returns:

formatted time duration

format

String format(Long duration,
              Locale locale)

Formats a given time duration with given locale.

Parameters:

duration - time duration to format

locale - user's locale

Returns:

formatted time duration

shortFormat

String shortFormat(Long duration)

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

Parameters:

duration - time duration to format

Returns:

formatted time duration

shortFormat

String shortFormat(Long duration,
                   Locale locale)

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

Parameters:

duration - time duration in seconds

locale - locale to use

Returns:

formatted time duration