me.lucko.helper.time

Enum DurationFormatter

java.lang.Object

java.lang.Enum<DurationFormatter>

me.lucko.helper.time.DurationFormatter

All Implemented Interfaces:

Serializable, Comparable<DurationFormatter>

public enum DurationFormatter
extends Enum<DurationFormatter>

Formats durations to a readable form

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONCISE
CONCISE_LOW_ACCURACY
LONG

Method Summary

Modifier and Type	Method and Description
String	format(Duration duration) Formats duration as a string.
protected String	formatUnitPlural(ChronoUnit unit)
protected String	formatUnitSingular(ChronoUnit unit)
static DurationFormatter	valueOf(String name) Returns the enum constant of this type with the specified name.
static DurationFormatter[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LONG

public static final DurationFormatter LONG

CONCISE

public static final DurationFormatter CONCISE

CONCISE_LOW_ACCURACY

public static final DurationFormatter CONCISE_LOW_ACCURACY

Method Detail

values

public static DurationFormatter[] 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 (DurationFormatter c : DurationFormatter.values())
    System.out.println(c);

Returns:

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

valueOf

public static DurationFormatter 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 String format(Duration duration)

Formats duration as a string.

Parameters:

duration - the duration

Returns:

the formatted string

formatUnitPlural

protected String formatUnitPlural(ChronoUnit unit)

formatUnitSingular

protected String formatUnitSingular(ChronoUnit unit)