net.obvj.performetrics.util

Class DurationFormatter

java.lang.Object

net.obvj.performetrics.util.DurationFormatter

public class DurationFormatter
extends Object

A formatter for Duration objects.

Since:

2.2.0

Author:

oswaldo.bapvic.jr

Field Summary

Fields

Modifier and Type	Field and Description
static DurationFormat	DEFAULT_FORMAT The default DurationFormat to be applied.

Method Summary

Modifier and Type	Method and Description
static String	format(Duration duration) Returns a string representation of the given Duration using default format.
static String	format(Duration duration, DurationFormat format) Returns a string representation of the given Duration with a specific format.
static String	format(Duration duration, DurationFormat format, boolean printLegend) Returns a string representation of the given Duration with a specific format.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FORMAT

public static final DurationFormat DEFAULT_FORMAT

The default DurationFormat to be applied.

Method Detail

format

public static final String format(Duration duration)

Returns a string representation of the given Duration using default format.

Parameters:

duration - the Duration to be formatted

Returns:

a string representation of the given Duration using default format

Throws:

NullPointerException - if the specified duration is null

format

public static final String format(Duration duration,
                                  DurationFormat format)

Returns a string representation of the given Duration with a specific format.

Note: This is equivalent to calling: DurationFormatter.format(duration, format, true)

Parameters:

duration - the Duration to be formatted

format - the DurationFormat to be applied

Returns:

a string representation of the given Duration in the specified format

Throws:

NullPointerException - if either the specified duration or format is null

format

public static final String format(Duration duration,
                                  DurationFormat format,
                                  boolean printLegend)

Returns a string representation of the given Duration with a specific format.

Parameters:

duration - the Duration to be formatted

format - the DurationFormat to be applied

printLegend - a flag indicating whether of not to include a legend in the generated string

Returns:

a string representation of the given Duration in the specified format

Throws:

NullPointerException - if wither of the specified duration or format is null