com.norconex.commons.lang.time

Class DurationUtil

java.lang.Object

com.norconex.commons.lang.time.DurationUtil

public final class DurationUtil
extends Object

Utility class for duration-related features. English and French are the two supported locale languages. An unsupported locale will fallback to English.

Author:

Pascal Essiembre

Method Summary

Modifier and Type	Method and Description
static String	formatLong(Locale locale, long duration) Formats a duration using time units full names according to supplied locale.
static String	formatLong(Locale locale, long duration, int maxUnits) Formats a duration using time units full names according to supplied locale.
static String	formatShort(Locale locale, long duration) Formats a duration using time units abbreviations according to supplied locale.
static String	formatShort(Locale locale, long duration, int maxUnits) Formats a duration using time units abbreviations according to supplied locale.

Methods inherited from class java.lang.Object

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

Method Detail

formatShort

public static String formatShort(Locale locale,
                                 long duration)

Formats a duration using time units abbreviations according to supplied locale. All matching units are returned.

Parameters:

locale - locale of time unit names

duration - the duration to format

Returns:

formatted duration

formatLong

public static String formatLong(Locale locale,
                                long duration)

Formats a duration using time units full names according to supplied locale. All matching units are returned.

Parameters:

locale - locale of time unit names

duration - the duration to format

Returns:

formatted duration

formatShort

public static String formatShort(Locale locale,
                                 long duration,
                                 int maxUnits)

Formats a duration using time units abbreviations according to supplied locale.

Parameters:

locale - locale of time unit names

duration - the duration to format

maxUnits - the number of different time units to return (zero or less returns all matching units)

Returns:

formatted duration

formatLong

public static String formatLong(Locale locale,
                                long duration,
                                int maxUnits)

Formats a duration using time units full names according to supplied locale.

Parameters:

locale - locale of time unit names

duration - the duration to format

maxUnits - the number of different time units to return (zero or less returns all matching units)

Returns:

formatted duration