com.devexperts.qd.ng

Enum EventFlag

java.lang.Object

java.lang.Enum<EventFlag>

com.devexperts.qd.ng.EventFlag

All Implemented Interfaces:

Serializable, Comparable<EventFlag>

public enum EventFlag
extends Enum<EventFlag>

Event flags.

Enum Constant Summary

Enum Constants

Enum Constant and Description
REMOVE_EVENT
REMOVE_SYMBOL
SNAPSHOT_BEGIN
SNAPSHOT_END
SNAPSHOT_MODE
SNAPSHOT_SNIP
TX_PENDING

Method Summary

Modifier and Type	Method and Description
int	clear(int eventFlags)
int	flag()
static String	formatEventFlags(int eventFlags) Converts integer event flags bit mask into an event flags set string.
static String	formatEventFlags(int eventFlags, MessageType messageType) Converts integer event flags bit mask into an event flags set string.
static int	getSupportedEventFlags(ProtocolOption.Set optSet, MessageType messageType) Returns a mask of supported event flags for a given set of protocol options and message type.
boolean	in(int eventFlags)
int	of(boolean b)
static int	parseEventFlags(String s, MessageType messageType) Parses string set of event flags.
int	set(int eventFlags)
static EventFlag	valueOf(String name) Returns the enum constant of this type with the specified name.
static EventFlag[]	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

TX_PENDING

public static final EventFlag TX_PENDING

REMOVE_EVENT

public static final EventFlag REMOVE_EVENT

SNAPSHOT_BEGIN

public static final EventFlag SNAPSHOT_BEGIN

SNAPSHOT_END

public static final EventFlag SNAPSHOT_END

SNAPSHOT_SNIP

public static final EventFlag SNAPSHOT_SNIP

SNAPSHOT_MODE

public static final EventFlag SNAPSHOT_MODE

REMOVE_SYMBOL

public static final EventFlag REMOVE_SYMBOL

Method Detail

values

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

Returns:

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

valueOf

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

flag

public int flag()

of

public int of(boolean b)

in

public boolean in(int eventFlags)

set

public int set(int eventFlags)

clear

public int clear(int eventFlags)

getSupportedEventFlags

public static int getSupportedEventFlags(ProtocolOption.Set optSet,
                                         MessageType messageType)

Returns a mask of supported event flags for a given set of protocol options and message type.

Parameters:

optSet - the set of protocol options.

messageType - the message type.

Returns:

mask of supported event flags.

formatEventFlags

public static String formatEventFlags(int eventFlags,
                                      MessageType messageType)

Converts integer event flags bit mask into an event flags set string. Flags that are not supported for this message types are omitted.

Parameters:

eventFlags - event flags bit mask.

messageType - the message type.

Returns:

event flags set string.

formatEventFlags

public static String formatEventFlags(int eventFlags)

Converts integer event flags bit mask into an event flags set string. All flags (even non-supported) are output.

Parameters:

eventFlags - event flags bit mask.

Returns:

event flags set string.

parseEventFlags

public static int parseEventFlags(String s,
                                  MessageType messageType)

Parses string set of event flags. The result is an empty set when s is null, empty, or cannot be parsed.

Parameters:

s - string set of event flags.

messageType - the message type.

Returns:

set of event flags.