com.serialpundit.serial

Enum SerialComManager.FLOWCONTROL

java.lang.Object

java.lang.Enum<SerialComManager.FLOWCONTROL>

com.serialpundit.serial.SerialComManager.FLOWCONTROL

All Implemented Interfaces:

Serializable, Comparable<SerialComManager.FLOWCONTROL>

Enclosing class:

SerialComManager

public static enum SerialComManager.FLOWCONTROL
extends Enum<SerialComManager.FLOWCONTROL>

Pre-defined enum constants for controlling data flow between DTE and DCE or two serial devices.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DTR_DSR Operating system (or driver) will assert or de-assert DTR/DSR lines as per the amount of data in input buffers.
NONE No flow control; application is responsible to manage data buffers.
RTS_CTS Operating system (or driver) will assert or de-assert RTS/CTS lines as per the amount of data in input buffers.
XON_XOFF Operating system (or driver) will send XON or XOFF characters as per the amount of data in input buffers.

Method Summary

Methods

Modifier and Type	Method and Description
int	getValue()
static SerialComManager.FLOWCONTROL	valueOf(String name) Returns the enum constant of this type with the specified name.
static SerialComManager.FLOWCONTROL[]	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 SerialComManager.FLOWCONTROL NONE

No flow control; application is responsible to manage data buffers. Application can assert or de-assert RTS/CTS or DTR/DSR signals explicitly.

RTS_CTS

public static final SerialComManager.FLOWCONTROL RTS_CTS

Operating system (or driver) will assert or de-assert RTS/CTS lines as per the amount of data in input buffers.

DTR_DSR

public static final SerialComManager.FLOWCONTROL DTR_DSR

Operating system (or driver) will assert or de-assert DTR/DSR lines as per the amount of data in input buffers.

XON_XOFF

public static final SerialComManager.FLOWCONTROL XON_XOFF

Operating system (or driver) will send XON or XOFF characters as per the amount of data in input buffers. Upon reception of XOFF system will stop transmitting data and vice-versa.

Method Detail

values

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

Returns:

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

valueOf

public static SerialComManager.FLOWCONTROL 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

getValue

public int getValue()