com.ghgande.j2mod.modbus.slave

Enum ModbusSlaveType

java.lang.Object

java.lang.Enum<ModbusSlaveType>

com.ghgande.j2mod.modbus.slave.ModbusSlaveType

All Implemented Interfaces:

Serializable, Comparable<ModbusSlaveType>

public enum ModbusSlaveType
extends Enum<ModbusSlaveType>

Descibes the types of Modbus Slaves

Enum Constant Summary

Enum Constants

Enum Constant and Description
SERIAL
TCP
UDP

Method Summary

Modifier and Type	Method and Description
String	getKey(int port) Returns a unique key for this port and type
String	getKey(String port) Returns a unique key for this port and type
boolean	is(ModbusSlaveType... types) Returns true if this type is one of those listed
static ModbusSlaveType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ModbusSlaveType[]	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

TCP

public static final ModbusSlaveType TCP

UDP

public static final ModbusSlaveType UDP

SERIAL

public static final ModbusSlaveType SERIAL

Method Detail

values

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

Returns:

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

valueOf

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

is

public boolean is(ModbusSlaveType... types)

Returns true if this type is one of those listed

Parameters:

types - Array of types to check for

Returns:

True if this is one of the array

getKey

public String getKey(int port)

Returns a unique key for this port and type

Parameters:

port - Port number

Returns:

Unique key

getKey

public String getKey(String port)

Returns a unique key for this port and type

Parameters:

port - Port number

Returns:

Unique key