Package dev.bouncingelf10.timelesslib.api.time

Enum Class TimeFormat

java.lang.Object

java.lang.Enum<TimeFormat>

dev.bouncingelf10.timelesslib.api.time.TimeFormat

All Implemented Interfaces:

Serializable, Comparable<TimeFormat>, Constable

public enum TimeFormat
extends Enum<TimeFormat>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPACT	Compact format such as "1d 2h 3m 4s" omitting milliseconds.
COMPACT_MILLIS	Compact format that includes milliseconds, e.g.
DEBUG	Debug output including all units down to nanoseconds.
DIGITAL	Digital clock-style formatting such as "01:22:05".
DIGITAL_MILLIS	Digital formatting including milliseconds such as "00:10.532".
ISO_8601	ISO-8601 duration format, such as "PT30S" or "P2DT3H".
MINIMAL	Returns only the largest non-zero component, e.g.
MINIMAL_TWO	Returns the first two non-zero components, e.g.
VERBOSE	Verbose English format, e.g.
VERBOSE_SIMPLE	Verbose format without a conjunction, e.g.

Method Summary

Modifier and Type	Method	Description
abstract String	apply(long nanos)	Converts a nanosecond duration into a formatted string.
static TimeFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TimeFormat[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

COMPACT

public static final TimeFormat COMPACT

Compact format such as "1d 2h 3m 4s" omitting milliseconds.

COMPACT_MILLIS

public static final TimeFormat COMPACT_MILLIS

Compact format that includes milliseconds, e.g. "3s 250ms".

VERBOSE

public static final TimeFormat VERBOSE

Verbose English format, e.g. "2 days, 3 hours and 4 minutes".

VERBOSE_SIMPLE

public static final TimeFormat VERBOSE_SIMPLE

Verbose format without a conjunction, e.g. "2 days, 3 hours, 4 minutes".

DIGITAL

public static final TimeFormat DIGITAL

Digital clock-style formatting such as "01:22:05".

DIGITAL_MILLIS

public static final TimeFormat DIGITAL_MILLIS

Digital formatting including milliseconds such as "00:10.532".

MINIMAL

public static final TimeFormat MINIMAL

Returns only the largest non-zero component, e.g. "3h" or "20m".

MINIMAL_TWO

public static final TimeFormat MINIMAL_TWO

Returns the first two non-zero components, e.g. "3h 20m".

ISO_8601

public static final TimeFormat ISO_8601

ISO-8601 duration format, such as "PT30S" or "P2DT3H".

DEBUG

public static final TimeFormat DEBUG

Debug output including all units down to nanoseconds.

Method Details

values

public static TimeFormat[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static TimeFormat valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

apply

public abstract String apply(long nanos)

Converts a nanosecond duration into a formatted string.

Parameters:

nanos - duration in nanoseconds

Returns:

formatted representation of the duration