org.jperipheral

Enum SerialPort.Parity

java.lang.Object

java.lang.Enum<SerialPort.Parity>

org.jperipheral.SerialPort.Parity

All Implemented Interfaces:

Serializable, Comparable<SerialPort.Parity>

Enclosing class:

SerialPort

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

The parity mode used to detect errors.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EVEN Indicates that the number of bits in a word must be even.
MARK Indicates that the parity bit is always 1.
NONE Indicates that parity checking is disabled.
ODD Indicates that the number of bits in a word must be odd.
SPACE Indicates that the parity bit is always 0.

Method Summary

Methods

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

EVEN

public static final SerialPort.Parity EVEN

Indicates that the number of bits in a word must be even.

MARK

public static final SerialPort.Parity MARK

Indicates that the parity bit is always 1.

NONE

public static final SerialPort.Parity NONE

Indicates that parity checking is disabled.

ODD

public static final SerialPort.Parity ODD

Indicates that the number of bits in a word must be odd.

SPACE

public static final SerialPort.Parity SPACE

Indicates that the parity bit is always 0.

Method Detail

values

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

Returns:

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

valueOf

public static SerialPort.Parity 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