com.dsi.ant.plugins.antplus.pcc.defines

Enum EventFlag

java.lang.Object

java.lang.Enum<EventFlag>

com.dsi.ant.plugins.antplus.pcc.defines.EventFlag

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EventFlag>

public enum EventFlag
extends java.lang.Enum<EventFlag>

Informational flags about the received event.

Enum Constant Summary

Enum Constants

Enum Constant and Description
UNRECOGNIZED_FLAG_PRESENT The value sent by the plugin service was at least partially unrecognized indicating an upgrade of the PCC may be required to handle the value.
WAS_BUFFERED The event was buffered indicating it was not received in real time.

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.EnumSet<EventFlag>	getEventFlagsFromLong(long longValue) Gets the set of flags contained in the given value
static long	getLongFromEventFlags(java.util.EnumSet<EventFlag> eventFlags) Converts a set of flags to the equivalent raw long value
long	getLongValue() Convert enum to equivalent long value.
static EventFlag	valueOf(java.lang.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

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNRECOGNIZED_FLAG_PRESENT

public static final EventFlag UNRECOGNIZED_FLAG_PRESENT

The value sent by the plugin service was at least partially unrecognized indicating an upgrade of the PCC may be required to handle the value.

WAS_BUFFERED

public static final EventFlag WAS_BUFFERED

The event was buffered indicating it was not received in real time.

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(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getLongValue

public long getLongValue()

Convert enum to equivalent long value.

Returns:

long value equivalent

getEventFlagsFromLong

public static java.util.EnumSet<EventFlag> getEventFlagsFromLong(long longValue)

Gets the set of flags contained in the given value

Parameters:

longValue - raw long value containing flags

Returns:

set of flags contained in the given value

getLongFromEventFlags

public static long getLongFromEventFlags(java.util.EnumSet<EventFlag> eventFlags)

Converts a set of flags to the equivalent raw long value

Parameters:

eventFlags - set of flags to convert

Returns:

equivalent raw long value