agi.foundation.time

(agi.foundation.core-2024r1.jar)

Enum Iso8601Format

java.lang.Object

java.lang.Enum<Iso8601Format>

agi.foundation.time.Iso8601Format

All Implemented Interfaces:

Enumeration, Serializable, Comparable<Iso8601Format>

public enum Iso8601Format
extends Enum<Iso8601Format>
implements Enumeration

Defines the representation of the ISO8601 date string generated by GregorianDate.toIso8601String(Iso8601Format).

Enum Constant Summary

Enum Constants

Enum Constant and Description
BASIC A complete ISO8601 date and time in the basic format, which omits the dash and colon separators used between time and date components.
COMPACT The shortest possible way to accurately represent an ISO8601 date and time.
EXTENDED A complete ISO8601 date and time in the extended format, which uses dash and colon separators between time and date components.

Method Summary

Modifier and Type	Method and Description
static Iso8601Format	getDefault() Get the enum constant that is considered to be the default.
static Iso8601Format	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static Iso8601Format	valueOf(String name) Returns the enum constant of this type with the specified name.
static Iso8601Format[]	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

BASIC

public static final Iso8601Format BASIC

A complete ISO8601 date and time in the basic format, which omits the dash and colon separators used between time and date components.

EXTENDED

public static final Iso8601Format EXTENDED

A complete ISO8601 date and time in the extended format, which uses dash and colon separators between time and date components.

COMPACT

public static final Iso8601Format COMPACT

The shortest possible way to accurately represent an ISO8601 date and time.

Method Detail

values

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

Returns:

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

valueOf

public static Iso8601Format 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

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static Iso8601Format getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static Iso8601Format getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.