Enum Class EventFlag
- All Implemented Interfaces:
Serializable
,Comparable<EventFlag>
,Constable
Informational flags about the received event.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe value sent by the plugin service was at least partially unrecognized indicating an upgrade of the PCC may be required to handle the value.The event was buffered indicating it was not received in real time. -
Method Summary
Modifier and TypeMethodDescriptiongetEventFlagsFromLong
(long longValue) Gets the set of flags contained in the given valuestatic long
getLongFromEventFlags
(EnumSet<EventFlag> eventFlags) Converts a set of flags to the equivalent raw long valuelong
Convert enum to equivalent long value.static EventFlag
Returns the enum constant of this class with the specified name.static EventFlag[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
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 Details
-
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
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 nameNullPointerException
- if the argument is null
-
getLongValue
public long getLongValue()Convert enum to equivalent long value.- Returns:
- long value equivalent
-
getEventFlagsFromLong
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
Converts a set of flags to the equivalent raw long value- Parameters:
eventFlags
- set of flags to convert- Returns:
- equivalent raw long value
-