Package net.solarnetwork.node.io.modbus

Enum Class ModbusWordOrder

java.lang.Object

java.lang.Enum<ModbusWordOrder>

net.solarnetwork.node.io.modbus.ModbusWordOrder

All Implemented Interfaces:

Serializable, Comparable<ModbusWordOrder>, Constable

public enum ModbusWordOrder
extends Enum<ModbusWordOrder>

A word-ordering for multi-register data types in Modbus.

Since:

2.7

Version:

1.0

Author:

matt

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LeastToMostSignificant	Least to most word order (low 16 bits followed by high 16 bits).
MostToLeastSignificant	Most to least word order (high 16 bits followed by low 16 bits).

Method Summary

Modifier and Type	Method	Description
static ModbusWordOrder	forKey(char key)	Get an enum instance for a key value.
char	getKey()	Get the key value for this enum.
String	toDisplayString()	Get a friendly display string for this enum.
static ModbusWordOrder	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ModbusWordOrder[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MostToLeastSignificant

public static final ModbusWordOrder MostToLeastSignificant

Most to least word order (high 16 bits followed by low 16 bits).

LeastToMostSignificant

public static final ModbusWordOrder LeastToMostSignificant

Least to most word order (low 16 bits followed by high 16 bits).

Method Details

values

public static ModbusWordOrder[] 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

public static ModbusWordOrder valueOf(String name)

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 name

NullPointerException - if the argument is null

getKey

public char getKey()

Get the key value for this enum.

Returns:

the key

forKey

public static ModbusWordOrder forKey(char key)

Get an enum instance for a key value.

Parameters:

key - the key

Returns:

the enum

Throws:

IllegalArgumentException - if key is not a valid value

toDisplayString

public String toDisplayString()

Get a friendly display string for this enum.

Returns:

the display string