io.aeron.cluster.codecs

Enum ClusterTimeUnit

java.lang.Object

java.lang.Enum<ClusterTimeUnit>

io.aeron.cluster.codecs.ClusterTimeUnit

All Implemented Interfaces:

Serializable, Comparable<ClusterTimeUnit>

public enum ClusterTimeUnit
extends Enum<ClusterTimeUnit>

Type the time unit used for timestamps.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MICROS Time unit of microseconds for timestamps.
MILLIS Time unit of milliseconds for timestamps.
NANOS Time unit of nanoseconds for timestamps.
NULL_VAL To be used to represent not present or null.

Method Summary

Modifier and Type	Method and Description
static ClusterTimeUnit	get(int value) Lookup the enum value representing the value.
int	value() The raw encoded value in the Java type representation.
static ClusterTimeUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static ClusterTimeUnit[]	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

MILLIS

public static final ClusterTimeUnit MILLIS

Time unit of milliseconds for timestamps.

MICROS

public static final ClusterTimeUnit MICROS

Time unit of microseconds for timestamps.

NANOS

public static final ClusterTimeUnit NANOS

Time unit of nanoseconds for timestamps.

NULL_VAL

public static final ClusterTimeUnit NULL_VAL

To be used to represent not present or null.

Method Detail

values

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

Returns:

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

valueOf

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

value

public int value()

The raw encoded value in the Java type representation.

Returns:

the raw value encoded.

get

public static ClusterTimeUnit get(int value)

Lookup the enum value representing the value.

Parameters:

value - encoded to be looked up.

Returns:

the enum value representing the value.