Package uk.co.real_logic.sbe.ir

Enum Class Encoding.Presence

java.lang.Object

java.lang.Enum<Encoding.Presence>

uk.co.real_logic.sbe.ir.Encoding.Presence

All Implemented Interfaces:

Serializable, Comparable<Encoding.Presence>, Constable

Enclosing class:

Encoding

public static enum Encoding.Presence
extends Enum<Encoding.Presence>

Indicates the presence status of a primitive encoded field in a message.

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
CONSTANT	The field presence is a constant.
OPTIONAL	The field presence is optional.
REQUIRED	The field presence is required.

Method Summary

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

REQUIRED

public static final Encoding.Presence REQUIRED

The field presence is required.

OPTIONAL

public static final Encoding.Presence OPTIONAL

The field presence is optional.

CONSTANT

public static final Encoding.Presence CONSTANT

The field presence is a constant.

Method Details

values

public static Encoding.Presence[] 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 Encoding.Presence 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