net.obvj.performetrics.util

Enum Duration.FormatStyle

java.lang.Object

java.lang.Enum<Duration.FormatStyle>

net.obvj.performetrics.util.Duration.FormatStyle

All Implemented Interfaces:

Serializable, Comparable<Duration.FormatStyle>

Enclosing class:

Duration

public static enum Duration.FormatStyle
extends Enum<Duration.FormatStyle>

Enumerates different time format styles, each one with particular behaviors.

Since:

2.0.0

Author:

oswaldo.bapvic.jr

Enum Constant Summary

Enum Constants

Enum Constant and Description
FULL Formats a time duration in the following format: H:M:s:ns.
ISO_8601 Formats a time duration using ISO-8601 seconds based representation, such as PT8H6M12.345S.
SHORT Formats a time duration in any of the following formats: H:M:s:ns, M:S:ns, or S.ns, always choosing the shortest possible format.
SHORTER Formats a time duration in any of the following formats: H:M:s:ns, M:S:ns, or S.ns, suppressing trailing zeros from the nanosecond part.

Method Summary

Modifier and Type	Method and Description
abstract String	format(Duration duration, boolean printLegend) Formats a time duration.
static Duration.FormatStyle	valueOf(String name) Returns the enum constant of this type with the specified name.
static Duration.FormatStyle[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FULL

public static final Duration.FormatStyle FULL

Formats a time duration in the following format: H:M:s:ns. For example: 1:59:59.987654321

SHORT

public static final Duration.FormatStyle SHORT

Formats a time duration in any of the following formats: H:M:s:ns, M:S:ns, or S.ns, always choosing the shortest possible format.

Examples:

• 0.001000000 second(s)
• 3.200000000 second(s)
• 15:00.005890000 minute(s)

SHORTER

public static final Duration.FormatStyle SHORTER

Formats a time duration in any of the following formats: H:M:s:ns, M:S:ns, or S.ns, suppressing trailing zeros from the nanosecond part.

Examples:

• 0.001 second(s)
• 3.2 second(s)
• 15:00.00589 minute(s)

ISO_8601

public static final Duration.FormatStyle ISO_8601

Formats a time duration using ISO-8601 seconds based representation, such as PT8H6M12.345S.

Examples:

• PT0.001S
• PT3.2S
• PT15M0.00589S

Method Detail

values

public static Duration.FormatStyle[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Duration.FormatStyle c : Duration.FormatStyle.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Duration.FormatStyle valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

format

public abstract String format(Duration duration,
                              boolean printLegend)

Formats a time duration.

Parameters:

duration - the Duration to be formatted

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

Returns:

a formatted time duration