org.apache.commons.lang.time
Class DurationFormatUtils
public class DurationFormatUtils
Duration formatting utilities and constants. The following table describes the tokens
used in the pattern language for formatting.
character | duration element |
---|
y | years |
M | months |
d | days |
H | hours |
m | minutes |
s | seconds |
S | milliseconds |
$Id: DurationFormatUtils.java 165657 2005-05-02 18:31:49Z ggregory $static String | ISO_EXTENDED_FORMAT_PATTERN - Pattern used with
FastDateFormat and SimpleDateFormat
for the ISO8601 period format used in durations.
|
DurationFormatUtils() - DurationFormatUtils instances should NOT be constructed in standard programming.
|
static String | formatDuration(long durationMillis, String format) - Get the time gap as a string, using the specified format, and padding with zeros and
using the default timezone.
|
static String | formatDuration(long durationMillis, String format, boolean padWithZeros) - Get the time gap as a string, using the specified format.
|
static String | formatDurationHMS(long durationMillis) - Get the time gap as a string.
|
static String | formatDurationISO(long durationMillis) - Get the time gap as a string.
|
static String | formatDurationWords(long durationMillis, boolean suppressLeadingZeroElements, boolean suppressTrailingZeroElements) - Format an elapsed time into a plurialization correct string.
|
static String | formatPeriod(long startMillis, long endMillis, String format) - Get the time gap as a string, using the specified format.
|
static String | formatPeriod(long startMillis, long endMillis, String format, boolean padWithZeros, TimeZone timezone) - Get the time gap as a string, using the specified format.
|
static String | formatPeriodISO(long startMillis, long endMillis) - Get the time gap as a string.
|
ISO_EXTENDED_FORMAT_PATTERN
public static final String ISO_EXTENDED_FORMAT_PATTERN
Pattern used with FastDateFormat
and SimpleDateFormat
for the ISO8601 period format used in durations.
DurationFormatUtils
public DurationFormatUtils()
DurationFormatUtils instances should NOT be constructed in standard programming.
This constructor is public to permit tools that require a JavaBean instance
to operate.
formatDuration
public static String formatDuration(long durationMillis,
String format)
Get the time gap as a string, using the specified format, and padding with zeros and
using the default timezone.
This method formats durations using the days and lower fields of the
format pattern. Months and larger are not used.
durationMillis
- the duration to formatformat
- the way in which to format the duration
formatDuration
public static String formatDuration(long durationMillis,
String format,
boolean padWithZeros)
Get the time gap as a string, using the specified format.
Padding the left hand side of numbers with zeroes is optional and
the timezone may be specified.
This method formats durations using the days and lower fields of the
format pattern. Months and larger are not used.
durationMillis
- the duration to formatformat
- the way in which to format the durationpadWithZeros
- whether to pad the left hand side of numbers with 0's
formatDurationHMS
public static String formatDurationHMS(long durationMillis)
Get the time gap as a string.
The format used is ISO8601-like:
H:
m:
s.
S.
durationMillis
- the duration to format
formatDurationISO
public static String formatDurationISO(long durationMillis)
Get the time gap as a string.
The format used is the ISO8601 period format.
This method formats durations using the days and lower fields of the
ISO format pattern, such as P7D6H5M4.321S.
durationMillis
- the duration to format
formatDurationWords
public static String formatDurationWords(long durationMillis,
boolean suppressLeadingZeroElements,
boolean suppressTrailingZeroElements)
Format an elapsed time into a plurialization correct string.
This method formats durations using the days and lower fields of the
format pattern. Months and larger are not used.
durationMillis
- the elapsed time to report in millisecondssuppressLeadingZeroElements
- suppresses leading 0 elementssuppressTrailingZeroElements
- suppresses trailing 0 elements
- the formatted text in days/hours/minutes/seconds
formatPeriod
public static String formatPeriod(long startMillis,
long endMillis,
String format)
Get the time gap as a string, using the specified format.
Padding the left hand side of numbers with zeroes is optional.
startMillis
- the start of the durationendMillis
- the end of the durationformat
- the way in which to format the duration
formatPeriod
public static String formatPeriod(long startMillis,
long endMillis,
String format,
boolean padWithZeros,
TimeZone timezone)
Get the time gap as a string, using the specified format.
Padding the left hand side of numbers with zeroes is optional and
the timezone may be specified.
startMillis
- the start of the durationendMillis
- the end of the durationformat
- the way in which to format the durationpadWithZeros
- whether to pad the left hand side of numbers with 0'stimezone
- the millis are defined in
formatPeriodISO
public static String formatPeriodISO(long startMillis,
long endMillis)
Get the time gap as a string.
The format used is the ISO8601 period format.
startMillis
- the start of the duration to formatendMillis
- the end of the duration to format
Copyright © 2001-2005 - Apache Software Foundation