| java.lang.Object
 org.apache.commons.lang.time.DurationFormatUtils
| DurationFormatUtils | | public class DurationFormatUtils (Code) | | 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 |
author:
Apache Ant - DateUtils
author:
Stephane Bailliez
author:
Stefan Bodewig
author:
Stephen Colebourne
author:
Gary Gregory
since:
2.1
version:
$Id: DurationFormatUtils.java 491654 2007-01-01 22:04:34Z ggregory $ |
| Inner Class :static class Token | |
| Method Summary | |
| static String | format(Token[] tokens, int years, int months, int days, int hours, int minutes, int seconds, int milliseconds, boolean padWithZeros)
| | public static String | formatDuration(long durationMillis, String format)
Formats 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. | | public static String | formatDuration(long durationMillis, 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 and
the timezone may be specified.
This method formats durations using the days and lower fields of the
format pattern. | | public static String | formatDurationHMS(long durationMillis)
| | public static String | formatDurationISO(long durationMillis)
| | public static String | formatDurationWords(long durationMillis, boolean suppressLeadingZeroElements, boolean suppressTrailingZeroElements)
Formats an elapsed time into a plurialization correct string.
This method formats durations using the days and lower fields of the
format pattern. | | public static String | formatPeriod(long startMillis, long endMillis, String format)
Formats the time gap as a string, using the specified format. | | public static String | formatPeriod(long startMillis, long endMillis, String format, boolean padWithZeros, 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. | | public static String | formatPeriodISO(long startMillis, long endMillis)
| | static Token[] | lexx(String format)
|
| DurationFormatUtils | | public DurationFormatUtils()(Code) | | DurationFormatUtils instances should NOT be constructed in standard programming.
This constructor is public to permit tools that require a JavaBean instance
to operate.
|
| format | | static String format(Token[] tokens, int years, int months, int days, int hours, int minutes, int seconds, int milliseconds, boolean padWithZeros)(Code) | | The internal method to do the formatting.
Parameters:
tokens - the tokens
Parameters:
years - the number of years
Parameters:
months - the number of months
Parameters:
days - the number of days
Parameters:
hours - the number of hours
Parameters:
minutes - the number of minutes
Parameters:
seconds - the number of seconds
Parameters:
milliseconds - the number of millis
Parameters:
padWithZeros - whether to pad the formatted string |
| formatDuration | | public static String formatDuration(long durationMillis, String format)(Code) | | Formats 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.
Parameters:
durationMillis - the duration to format
Parameters:
format - the way in which to format the duration the time as a String |
| formatDuration | | public static String formatDuration(long durationMillis, String format, boolean padWithZeros)(Code) | | 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.
This method formats durations using the days and lower fields of the
format pattern. Months and larger are not used.
Parameters:
durationMillis - the duration to format
Parameters:
format - the way in which to format the duration
Parameters:
padWithZeros - whether to pad the left hand side of numbers with 0's the time as a String |
| formatDurationHMS | | public static String formatDurationHMS(long durationMillis)(Code) | | Formats the time gap as a string.
The format used is ISO8601-like:
H:m:s.S.
Parameters:
durationMillis - the duration to format the time as a String |
| formatDurationISO | | public static String formatDurationISO(long durationMillis)(Code) | | Formats 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 P7D6TH5M4.321S.
Parameters:
durationMillis - the duration to format the time as a String |
| formatDurationWords | | public static String formatDurationWords(long durationMillis, boolean suppressLeadingZeroElements, boolean suppressTrailingZeroElements)(Code) | | Formats 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.
Parameters:
durationMillis - the elapsed time to report in milliseconds
Parameters:
suppressLeadingZeroElements - suppresses leading 0 elements
Parameters:
suppressTrailingZeroElements - suppresses trailing 0 elements the formatted text in days/hours/minutes/seconds |
| formatPeriod | | public static String formatPeriod(long startMillis, long endMillis, String format)(Code) | | Formats the time gap as a string, using the specified format.
Padding the left hand side of numbers with zeroes is optional.
Parameters:
startMillis - the start of the duration
Parameters:
endMillis - the end of the duration
Parameters:
format - the way in which to format the duration the time as a String |
| formatPeriod | | public static String formatPeriod(long startMillis, long endMillis, String format, boolean padWithZeros, TimeZone timezone)(Code) | | 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.
Parameters:
startMillis - the start of the duration
Parameters:
endMillis - the end of the duration
Parameters:
format - the way in which to format the duration
Parameters:
padWithZeros - whether to pad the left hand side of numbers with 0's
Parameters:
timezone - the millis are defined in the time as a String |
| formatPeriodISO | | public static String formatPeriodISO(long startMillis, long endMillis)(Code) | | Formats the time gap as a string.
The format used is the ISO8601 period format.
Parameters:
startMillis - the start of the duration to format
Parameters:
endMillis - the end of the duration to format the time as a String |
| lexx | | static Token[] lexx(String format)(Code) | | Parses a classic date format string into Tokens
Parameters:
format - to parse Token[] of tokens |
|
|