Package com.djrapitops.plan.extension

Enum Class FormatType

java.lang.Object

java.lang.Enum<FormatType>

com.djrapitops.plan.extension.FormatType

All Implemented Interfaces:

Serializable, Comparable<FormatType>, Constable

public enum FormatType
extends Enum<FormatType>

Enum for determining additional formatter for a value given by a NumberProvider.

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
DATE_SECOND	Formats a long value (Epoch ms) to a readable timestamp, second is important.
DATE_YEAR	Formats a long value (Epoch ms) to a readable timestamp, year is important.
NONE	Applies no formatting to the value.
TIME_MILLISECONDS	Formats a long value (ms) to a readable format.

Method Summary

Modifier and Type	Method	Description
static Optional<FormatType>	getByName(String name)	Get a format type by the enum name without exception.
static FormatType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FormatType[]	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

DATE_YEAR

public static final FormatType DATE_YEAR

Formats a long value (Epoch ms) to a readable timestamp, year is important.

DATE_SECOND

public static final FormatType DATE_SECOND

Formats a long value (Epoch ms) to a readable timestamp, second is important.

TIME_MILLISECONDS

public static final FormatType TIME_MILLISECONDS

Formats a long value (ms) to a readable format.

NONE

public static final FormatType NONE

Applies no formatting to the value.

Method Details

values

public static FormatType[] 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 FormatType 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

getByName

public static Optional<FormatType> getByName(String name)

Get a format type by the enum name without exception.

Parameters:

name - FormatType#name()

Returns:

Optional if the format type is found by that name, empty if not found.