uk.co.real_logic.sbe.xml

Enum Presence

java.lang.Object

java.lang.Enum<Presence>

uk.co.real_logic.sbe.xml.Presence

All Implemented Interfaces:

Serializable, Comparable<Presence>

public enum Presence
extends Enum<Presence>

Presence attribute values for a Type applied to a Field.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONSTANT The field value is constant and held in the schema and not passed on the wire.
OPTIONAL The field is optional and an optional value must be provided in the schema.
REQUIRED The field must be present in the message encoding.

Method Summary

Modifier and Type	Method and Description
static Presence	get(String name) Lookup Presence name and return enum.
String	value() The value as a String of the presence.
static Presence	valueOf(String name) Returns the enum constant of this type with the specified name.
static Presence[]	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

REQUIRED

public static final Presence REQUIRED

The field must be present in the message encoding.

CONSTANT

public static final Presence CONSTANT

The field value is constant and held in the schema and not passed on the wire.

OPTIONAL

public static final Presence OPTIONAL

The field is optional and an optional value must be provided in the schema.

Method Detail

values

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

Returns:

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

valueOf

public static Presence 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 String value()

The value as a String of the presence.

Returns:

the value as a String

get

public static Presence get(String name)

Lookup Presence name and return enum.

Parameters:

name - of presence to get

Returns:

the Presence matching the name

Throws:

IllegalArgumentException - if the name is not found