Package edu.wpi.first.wpilibj

Enum Class SerialPort.FlowControl

java.lang.Object

java.lang.Enum<SerialPort.FlowControl>

edu.wpi.first.wpilibj.SerialPort.FlowControl

All Implemented Interfaces:

Serializable, Comparable<SerialPort.FlowControl>, Constable

Enclosing class:

SerialPort

public static enum SerialPort.FlowControl
extends Enum<SerialPort.FlowControl>

Represents what type of flow control to use for serial communication.

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
kDtsDsr	DTS/DSR flow control.
kNone	No flow control.
kRtsCts	RTS/CTS flow control.
kXonXoff	XON/XOFF flow control.

Field Summary

Fields

Modifier and Type	Field	Description
final int	value	FlowControl value.

Method Summary

Modifier and Type	Method	Description
static SerialPort.FlowControl	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SerialPort.FlowControl[]	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

kNone

public static final SerialPort.FlowControl kNone

No flow control.

kXonXoff

public static final SerialPort.FlowControl kXonXoff

XON/XOFF flow control.

kRtsCts

public static final SerialPort.FlowControl kRtsCts

RTS/CTS flow control.

kDtsDsr

public static final SerialPort.FlowControl kDtsDsr

DTS/DSR flow control.

Field Details

value

public final int value

FlowControl value.

Method Details

values

public static SerialPort.FlowControl[] 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 SerialPort.FlowControl 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