io.aeron.cluster.codecs

Enum MetaAttribute

java.lang.Object

java.lang.Enum<MetaAttribute>

io.aeron.cluster.codecs.MetaAttribute

All Implemented Interfaces:

Serializable, Comparable<MetaAttribute>

public enum MetaAttribute
extends Enum<MetaAttribute>

Meta attribute enum for selecting a particular meta attribute value.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EPOCH The epoch or start of time.
PRESENCE Field presence indication.
SEMANTIC_TYPE The type relationship to a FIX tag value encoded type.
TIME_UNIT Time unit applied to the epoch.

Method Summary

Modifier and Type	Method and Description
static MetaAttribute	valueOf(String name) Returns the enum constant of this type with the specified name.
static MetaAttribute[]	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

EPOCH

public static final MetaAttribute EPOCH

The epoch or start of time. Default is 'UNIX' which is midnight 1st January 1970 UTC.

TIME_UNIT

public static final MetaAttribute TIME_UNIT

Time unit applied to the epoch. Can be second, millisecond, microsecond, or nanosecond.

SEMANTIC_TYPE

public static final MetaAttribute SEMANTIC_TYPE

The type relationship to a FIX tag value encoded type. For reference only.

PRESENCE

public static final MetaAttribute PRESENCE

Field presence indication. Can be optional, required, or constant.

Method Detail

values

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

Returns:

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

valueOf

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