net.solarnetwork.io.modbus.serial

Enum SerialFlowControl

java.lang.Object

java.lang.Enum<SerialFlowControl>

net.solarnetwork.io.modbus.serial.SerialFlowControl

All Implemented Interfaces:

Serializable, Comparable<SerialFlowControl>

public enum SerialFlowControl
extends Enum<SerialFlowControl>

Enumeration of serial flow control settings.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CTS No flow control.
DSR No flow control.
DTR No flow control.
None No flow control.
RTS No flow control.
XonXoffIn No flow control.
XonXoffOut No flow control.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CTS_FLOW_CONTROL Code value for CTS flow control.
static String	CTS_FLOW_CONTROL_ABBREVIATION Abbreviation value for CTS flow control.
static int	DSR_FLOW_CONTROL Code value for DSR flow control.
static String	DSR_FLOW_CONTROL_ABBREVIATION Abbreviation value for DSR flow control.
static int	DTR_FLOW_CONTROL Code value for DTR flow control.
static String	DTR_FLOW_CONTROL_ABBREVIATION Abbreviation value for DTR flow control.
static int	NO_FLOW_CONTROL Code value for no flow control.
static String	NO_FLOW_CONTROL_ABBREVIATION Abbreviation value for no flow control.
static int	RTS_FLOW_CONTROL Code value for RTS flow control.
static String	RTS_FLOW_CONTROL_ABBREVIATION Abbreviation value for RTS flow control.
static int	XONXOFF_IN_FLOW_CONTROL Code value for Xon Xoff in flow control.
static String	XONXOFF_IN_FLOW_CONTROL_ABBREVIATION Abbreviation value for Xon Xoff in flow control.
static int	XONXOFF_OUT_FLOW_CONTROL Code value for Xon Xoff out flow control.
static String	XONXOFF_OUT_FLOW_CONTROL_ABBREVIATION Abbreviation value for Xon Xoff out flow control.

Method Summary

Modifier and Type	Method and Description
static Set<SerialFlowControl>	forAbbreviation(String value) Get an enumeration set for an abbreviation value.
static SerialFlowControl	forCode(int code) Get an enum instance for a code value.
int	getCode() Get the code value.
static SerialFlowControl	valueOf(String name) Returns the enum constant of this type with the specified name.
static SerialFlowControl[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

None

public static final SerialFlowControl None

No flow control.

RTS

public static final SerialFlowControl RTS

No flow control.

CTS

public static final SerialFlowControl CTS

No flow control.

DSR

public static final SerialFlowControl DSR

No flow control.

DTR

public static final SerialFlowControl DTR

No flow control.

XonXoffIn

public static final SerialFlowControl XonXoffIn

No flow control.

XonXoffOut

public static final SerialFlowControl XonXoffOut

No flow control.

Field Detail

NO_FLOW_CONTROL

public static final int NO_FLOW_CONTROL

Code value for no flow control.

See Also:

Constant Field Values

RTS_FLOW_CONTROL

public static final int RTS_FLOW_CONTROL

Code value for RTS flow control.

See Also:

Constant Field Values

CTS_FLOW_CONTROL

public static final int CTS_FLOW_CONTROL

Code value for CTS flow control.

See Also:

Constant Field Values

DSR_FLOW_CONTROL

public static final int DSR_FLOW_CONTROL

Code value for DSR flow control.

See Also:

Constant Field Values

DTR_FLOW_CONTROL

public static final int DTR_FLOW_CONTROL

Code value for DTR flow control.

See Also:

Constant Field Values

XONXOFF_IN_FLOW_CONTROL

public static final int XONXOFF_IN_FLOW_CONTROL

Code value for Xon Xoff in flow control.

See Also:

Constant Field Values

XONXOFF_OUT_FLOW_CONTROL

public static final int XONXOFF_OUT_FLOW_CONTROL

Code value for Xon Xoff out flow control.

See Also:

Constant Field Values

NO_FLOW_CONTROL_ABBREVIATION

public static final String NO_FLOW_CONTROL_ABBREVIATION

Abbreviation value for no flow control.

See Also:

Constant Field Values

RTS_FLOW_CONTROL_ABBREVIATION

public static final String RTS_FLOW_CONTROL_ABBREVIATION

Abbreviation value for RTS flow control.

See Also:

Constant Field Values

CTS_FLOW_CONTROL_ABBREVIATION

public static final String CTS_FLOW_CONTROL_ABBREVIATION

Abbreviation value for CTS flow control.

See Also:

Constant Field Values

DSR_FLOW_CONTROL_ABBREVIATION

public static final String DSR_FLOW_CONTROL_ABBREVIATION

Abbreviation value for DSR flow control.

See Also:

Constant Field Values

DTR_FLOW_CONTROL_ABBREVIATION

public static final String DTR_FLOW_CONTROL_ABBREVIATION

Abbreviation value for DTR flow control.

See Also:

Constant Field Values

XONXOFF_IN_FLOW_CONTROL_ABBREVIATION

public static final String XONXOFF_IN_FLOW_CONTROL_ABBREVIATION

Abbreviation value for Xon Xoff in flow control.

See Also:

Constant Field Values

XONXOFF_OUT_FLOW_CONTROL_ABBREVIATION

public static final String XONXOFF_OUT_FLOW_CONTROL_ABBREVIATION

Abbreviation value for Xon Xoff out flow control.

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getCode

public int getCode()

Get the code value.

Returns:

the code

forCode

public static SerialFlowControl forCode(int code)

Get an enum instance for a code value.

Parameters:

code - the code

Returns:

the enum

Throws:

IllegalArgumentException - if code is not a valid value

forAbbreviation

public static Set<SerialFlowControl> forAbbreviation(String value)

Get an enumeration set for an abbreviation value.

Multiple abbreviations can be provided by using a / delimiter, for example RTS/CTS or Xon/Xoff.

Parameters:

value - the slash-delimited list of abbreviations to parse

Returns:

the enum set, never null

Throws:

IllegalArgumentException - if value is not empty but contains no valid abbreviation