org.rvpf.pap.dnp3.object.groupCategory.counters

Enum FrozenCounterEventVariation

Object

Enum<FrozenCounterEventVariation>

FrozenCounterEventVariation

All Implemented Interfaces:

Serializable, Comparable<FrozenCounterEventVariation>, ObjectVariation, EnumCode

public enum FrozenCounterEventVariation
extends Enum<FrozenCounterEventVariation>
implements ObjectVariation

Frozen Counter Event variation enumeration.

Nested Class Summary

Nested classes/interfaces inherited from interface EnumCode

EnumCode.MapFactory

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY
UNSIGNED_WITH_FLAG
UNSIGNED_WITH_FLAG_TIME
WORD_WITH_FLAG
WORD_WITH_FLAG_TIME

Method Summary

Modifier and Type	Method and Description
int	getCode() Gets the code.
Optional<DataType>	getDataType() Gets the data type.
Class<? extends ObjectInstance>	getObjectClass() Gets the object class.
ObjectGroup	getObjectGroup() Gets the object group.
String	getTitle() Gets the variation title.
static FrozenCounterEventVariation	instance(int variationCode) Returns the instance for a variation code.
static FrozenCounterEventVariation	valueOf(String name) Returns the enum constant of this type with the specified name.
static FrozenCounterEventVariation[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ObjectVariation

getPointType, isAny, isPacked, newObjectInstance

Methods inherited from interface EnumCode

name

Enum Constant Detail

ANY

public static final FrozenCounterEventVariation ANY

UNSIGNED_WITH_FLAG

public static final FrozenCounterEventVariation UNSIGNED_WITH_FLAG

WORD_WITH_FLAG

public static final FrozenCounterEventVariation WORD_WITH_FLAG

UNSIGNED_WITH_FLAG_TIME

public static final FrozenCounterEventVariation UNSIGNED_WITH_FLAG_TIME

WORD_WITH_FLAG_TIME

public static final FrozenCounterEventVariation WORD_WITH_FLAG_TIME

Method Detail

values

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

Returns:

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

valueOf

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

instance

@Nonnull
 @CheckReturnValue
public static FrozenCounterEventVariation instance(int variationCode)

Returns the instance for a variation code.

Parameters:

variationCode - The variation code.

Returns:

The instance.

getCode

public int getCode()

Gets the code.

Specified by:

getCode in interface EnumCode

Returns:

The code.

getDataType

public Optional<DataType> getDataType()

Gets the data type.

Specified by:

getDataType in interface ObjectVariation

Returns:

The optional data type.

getObjectClass

public Class<? extends ObjectInstance> getObjectClass()

Gets the object class.

Specified by:

getObjectClass in interface ObjectVariation

Returns:

The object class.

getObjectGroup

public ObjectGroup getObjectGroup()

Gets the object group.

Specified by:

getObjectGroup in interface ObjectVariation

Returns:

The object group.

getTitle

public String getTitle()

Gets the variation title.

Specified by:

getTitle in interface ObjectVariation

Returns:

The variation title.