uk.co.real_logic.sbe.ir.generated

Enum PresenceCodec

java.lang.Object

java.lang.Enum<PresenceCodec>

uk.co.real_logic.sbe.ir.generated.PresenceCodec

All Implemented Interfaces:

Serializable, Comparable<PresenceCodec>

public enum PresenceCodec
extends Enum<PresenceCodec>

Field presence declaration.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NULL_VAL To be used to represent not present or null.
SBE_CONSTANT A field is a constant value.
SBE_OPTIONAL A field is optional.
SBE_REQUIRED A field is required.

Method Summary

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

SBE_REQUIRED

public static final PresenceCodec SBE_REQUIRED

A field is required.

SBE_OPTIONAL

public static final PresenceCodec SBE_OPTIONAL

A field is optional.

SBE_CONSTANT

public static final PresenceCodec SBE_CONSTANT

A field is a constant value.

NULL_VAL

public static final PresenceCodec NULL_VAL

To be used to represent not present or null.

Method Detail

values

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

Returns:

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

valueOf

public static PresenceCodec 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 short value()

The raw encoded value in the Java type representation.

Returns:

the raw value encoded.

get

public static PresenceCodec get(short value)

Lookup the enum value representing the value.

Parameters:

value - encoded to be looked up.

Returns:

the enum value representing the value.