public class DurationFormatUtils
extends java.lang.Object
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 |
'text' | arbitrary text content |
Modifier and Type | Class and Description |
---|---|
(package private) static class |
DurationFormatUtils.Token
Element that is parsed from the format pattern.
|
Modifier and Type | Field and Description |
---|---|
(package private) static java.lang.Object |
d |
(package private) static java.lang.Object |
H |
static java.lang.String |
ISO_EXTENDED_FORMAT_PATTERN
Pattern used with
FastDateFormat and SimpleDateFormat
for the ISO 8601 period format used in durations. |
(package private) static java.lang.Object |
m |
(package private) static java.lang.Object |
M |
(package private) static java.lang.Object |
s |
(package private) static java.lang.Object |
S |
(package private) static java.lang.Object |
y |
Constructor and Description |
---|
DurationFormatUtils()
DurationFormatUtils instances should NOT be constructed in standard programming.
|
Modifier and Type | Method and Description |
---|---|
(package private) static java.lang.String |
format(DurationFormatUtils.Token[] tokens,
long years,
long months,
long days,
long hours,
long minutes,
long seconds,
long milliseconds,
boolean padWithZeros)
The internal method to do the formatting.
|
static java.lang.String |
formatDuration(long durationMillis,
java.lang.String format)
Formats the time gap as a string, using the specified format, and padding with zeros.
|
static java.lang.String |
formatDuration(long durationMillis,
java.lang.String format,
boolean padWithZeros)
Formats the time gap as a string, using the specified format.
|
static java.lang.String |
formatDurationHMS(long durationMillis)
Formats the time gap as a string.
|
static java.lang.String |
formatDurationISO(long durationMillis)
Formats the time gap as a string.
|
static java.lang.String |
formatDurationWords(long durationMillis,
boolean suppressLeadingZeroElements,
boolean suppressTrailingZeroElements)
Formats an elapsed time into a pluralization correct string.
|
static java.lang.String |
formatPeriod(long startMillis,
long endMillis,
java.lang.String format)
Formats the time gap as a string, using the specified format.
|
static java.lang.String |
formatPeriod(long startMillis,
long endMillis,
java.lang.String format,
boolean padWithZeros,
java.util.TimeZone timezone)
Formats the time gap as a string, using the specified format.
|
static java.lang.String |
formatPeriodISO(long startMillis,
long endMillis)
Formats the time gap as a string.
|
(package private) static DurationFormatUtils.Token[] |
lexx(java.lang.String format)
Parses a classic date format string into Tokens
|
private static java.lang.String |
paddedValue(long value,
boolean padWithZeros,
int count)
Converts a
long to a String with optional
zero padding. |
public static final java.lang.String ISO_EXTENDED_FORMAT_PATTERN
Pattern used with FastDateFormat
and SimpleDateFormat
for the ISO 8601 period format used in durations.
FastDateFormat
,
SimpleDateFormat
,
Constant Field Valuesstatic final java.lang.Object y
static final java.lang.Object M
static final java.lang.Object d
static final java.lang.Object H
static final java.lang.Object m
static final java.lang.Object s
static final java.lang.Object S
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.
public static java.lang.String formatDurationHMS(long durationMillis)
Formats the time gap as a string.
The format used is ISO 8601-like: HH:mm:ss.SSS
.
durationMillis
- the duration to formatjava.lang.IllegalArgumentException
- if durationMillis is negativepublic static java.lang.String formatDurationISO(long durationMillis)
Formats the time gap as a string.
The format used is the ISO 8601 period format.
This method formats durations using the days and lower fields of the ISO format pattern, such as P7D6TH5M4.321S.
durationMillis
- the duration to formatjava.lang.IllegalArgumentException
- if durationMillis is negativepublic static java.lang.String formatDuration(long durationMillis, java.lang.String format)
Formats the time gap as a string, using the specified format, and padding with zeros.
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, not nulljava.lang.IllegalArgumentException
- if durationMillis is negativepublic static java.lang.String formatDuration(long durationMillis, java.lang.String format, boolean padWithZeros)
Formats the time gap as a string, using the specified format. Padding the left hand side of numbers with zeroes is optional.
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, not nullpadWithZeros
- whether to pad the left hand side of numbers with 0'sjava.lang.IllegalArgumentException
- if durationMillis is negativepublic static java.lang.String formatDurationWords(long durationMillis, boolean suppressLeadingZeroElements, boolean suppressTrailingZeroElements)
Formats an elapsed time into a pluralization 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 elementsjava.lang.IllegalArgumentException
- if durationMillis is negativepublic static java.lang.String formatPeriodISO(long startMillis, long endMillis)
Formats the time gap as a string.
The format used is the ISO 8601 period format.
startMillis
- the start of the duration to formatendMillis
- the end of the duration to formatjava.lang.IllegalArgumentException
- if startMillis is greater than endMillispublic static java.lang.String formatPeriod(long startMillis, long endMillis, java.lang.String format)
Formats 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, not nulljava.lang.IllegalArgumentException
- if startMillis is greater than endMillispublic static java.lang.String formatPeriod(long startMillis, long endMillis, java.lang.String format, boolean padWithZeros, java.util.TimeZone timezone)
Formats 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.
When calculating the difference between months/days, it chooses to calculate months first. So when working out the number of months and days between January 15th and March 10th, it choose 1 month and 23 days gained by choosing January->February = 1 month and then calculating days forwards, and not the 1 month and 26 days gained by choosing March -> February = 1 month and then calculating days backwards.
For more control, the Joda-Time library is recommended.
startMillis
- the start of the durationendMillis
- the end of the durationformat
- the way in which to format the duration, not nullpadWithZeros
- whether to pad the left hand side of numbers with 0'stimezone
- the millis are defined injava.lang.IllegalArgumentException
- if startMillis is greater than endMillisstatic java.lang.String format(DurationFormatUtils.Token[] tokens, long years, long months, long days, long hours, long minutes, long seconds, long milliseconds, boolean padWithZeros)
The internal method to do the formatting.
tokens
- the tokensyears
- the number of yearsmonths
- the number of monthsdays
- the number of dayshours
- the number of hoursminutes
- the number of minutesseconds
- the number of secondsmilliseconds
- the number of millispadWithZeros
- whether to padprivate static java.lang.String paddedValue(long value, boolean padWithZeros, int count)
Converts a long
to a String
with optional
zero padding.
value
- the value to convertpadWithZeros
- whether to pad with zeroescount
- the size to pad to (ignored if padWithZeros
is false)static DurationFormatUtils.Token[] lexx(java.lang.String format)
format
- the format to parse, not null