com.cloudhopper.commons.util

Class PeriodFormatterUtil

java.lang.Object

com.cloudhopper.commons.util.PeriodFormatterUtil

public class PeriodFormatterUtil
extends Object

Utility class to create useful Joda PeriodFormatters.

Author:

joelauer (twitter: @jjlauer or http://twitter.com/jjlauer)

Constructor Summary

Constructors

Constructor and Description
PeriodFormatterUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static org.joda.time.Period	createDayHourMinSecPeriod(long durationInMillis) Creates a new Period that can be used properly with the "Uptime" styles returned by this utility class.
static org.joda.time.PeriodType	getDayHourMinSecPeriodType() Gets a PeriodType that can be used to create a Period that is normalized to only include the fields Day, Hour, Minute, and Second.
static org.joda.time.format.PeriodFormatter	getLinuxUptimeStyle() Gets a PeriodFormatter in the Linux OS style such as "0 days, 01:05:12" or "2 days, 07:00:00".
static org.joda.time.format.PeriodFormatter	getStandardUptimeStyle() Gets a PeriodFormatter in the standard Uptime style such as "0 days 0 hours 1 min 50 secs" or "2 days 7 hours 1 min 50 secs".
static String	toLinuxUptimeStyleString(long durationInMillis) Helper method to create a "Linux" uptime styled string that represents the duration (in milliseconds).
static String	toStandardUptimeStyleString(long durationInMillis) Helper method to create a "Standard" uptime styled string that represents the duration (in milliseconds).

Methods inherited from class java.lang.Object

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

Constructor Detail

PeriodFormatterUtil

public PeriodFormatterUtil()

Method Detail

getDayHourMinSecPeriodType

public static org.joda.time.PeriodType getDayHourMinSecPeriodType()

Gets a PeriodType that can be used to create a Period that is normalized to only include the fields Day, Hour, Minute, and Second. Basically, this PeriodType would max out at days, so that someting like 40 days does not get converted to 1 month, 1 week, and 3 days like it normally would with the Joda library.

Returns:

A PeriodType that only includes Days, Hours, Minutes, and Seconds.

See Also:

createDayHourMinSecPeriod(long)

createDayHourMinSecPeriod

public static org.joda.time.Period createDayHourMinSecPeriod(long durationInMillis)

Creates a new Period that can be used properly with the "Uptime" styles returned by this utility class. This period normalizes the internal fields to only include days, hours, minutes, and seconds.

Parameters:

durationInMillis - The length of the duration in milliseconds

Returns:

A new normalized Period

getLinuxUptimeStyle

public static org.joda.time.format.PeriodFormatter getLinuxUptimeStyle()

Gets a PeriodFormatter in the Linux OS style such as "0 days, 01:05:12" or "2 days, 07:00:00". NOTE: You need to be careful with the Period used with this formatter object. It needs to be normalized to max out with the days fields (not include years, months, weeks, or millis).

Returns:

The global PeriodFormatter instance

See Also:

createDayHourMinSecPeriod(long)

getStandardUptimeStyle

public static org.joda.time.format.PeriodFormatter getStandardUptimeStyle()

Gets a PeriodFormatter in the standard Uptime style such as "0 days 0 hours 1 min 50 secs" or "2 days 7 hours 1 min 50 secs". NOTE: You need to be careful with the Period used with this formatter object. It needs to be normalized to max out with the days fields (not include years, months, weeks, or millis).

Returns:

The global PeriodFormatter instance

See Also:

createDayHourMinSecPeriod(long)

toLinuxUptimeStyleString

public static String toLinuxUptimeStyleString(long durationInMillis)

Helper method to create a "Linux" uptime styled string that represents the duration (in milliseconds). This method will only call other methods publicly available on this class. Converts the duration into a String such as "0 days, 01:05:12" or "2 days, 07:00:00".

Parameters:

durationInMillis - The duration (in millis)

Returns:

A styled String of the duration

toStandardUptimeStyleString

public static String toStandardUptimeStyleString(long durationInMillis)

Helper method to create a "Standard" uptime styled string that represents the duration (in milliseconds). This method will only call other methods publicly available on this class. Converts the duration into a String such as "0 days 0 hours 1 min 50 secs" or "2 days 7 hours 1 min 50 secs".

Parameters:

durationInMillis - The duration (in millis)

Returns:

A styled String of the duration