Package edu.wpi.first.wpilibj

Enum Class SerialPort.WriteBufferMode

java.lang.Object

java.lang.Enum<SerialPort.WriteBufferMode>

edu.wpi.first.wpilibj.SerialPort.WriteBufferMode

All Implemented Interfaces:

Serializable, Comparable<SerialPort.WriteBufferMode>, Constable

Enclosing class:

SerialPort

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

Represents which type of buffer mode to use when writing to a serial port.

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
kFlushOnAccess	Flush the buffer on each access.
kFlushWhenFull	Flush the buffer when it is full.

Field Summary

Fields

Modifier and Type	Field	Description
final int	value	WriteBufferMode value.

Method Summary

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

kFlushOnAccess

public static final SerialPort.WriteBufferMode kFlushOnAccess

Flush the buffer on each access.

kFlushWhenFull

public static final SerialPort.WriteBufferMode kFlushWhenFull

Flush the buffer when it is full.

Field Details

value

public final int value

WriteBufferMode value.

Method Details

values

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