net.solarnetwork.io.modbus.serial

Enum SerialStopBits

java.lang.Object

java.lang.Enum<SerialStopBits>

net.solarnetwork.io.modbus.serial.SerialStopBits

All Implemented Interfaces:

Serializable, Comparable<SerialStopBits>

public enum SerialStopBits
extends Enum<SerialStopBits>

Enumeration of serial "stopbit" settings.

Enum Constant Summary

Enum Constants

Enum Constant and Description
One One stop bit.
OnePointFive One and a half stop bits.
Two Two stop bits.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ONE_POINT_FIVE_STOP_BITS Code value for 1.5 stop bits.
static int	ONE_STOP_BIT Code value for one stop bit.
static int	TWO_STOP_BITS Code value for two stop bits.

Method Summary

Modifier and Type	Method and Description
static SerialStopBits	forCode(int code) Get an enum instance for a code value.
int	getCode() Get the code value.
static SerialStopBits	valueOf(String name) Returns the enum constant of this type with the specified name.
static SerialStopBits[]	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

One

public static final SerialStopBits One

One stop bit.

OnePointFive

public static final SerialStopBits OnePointFive

One and a half stop bits.

Two

public static final SerialStopBits Two

Two stop bits.

Field Detail

ONE_STOP_BIT

public static final int ONE_STOP_BIT

Code value for one stop bit.

See Also:

Constant Field Values

ONE_POINT_FIVE_STOP_BITS

public static final int ONE_POINT_FIVE_STOP_BITS

Code value for 1.5 stop bits.

See Also:

Constant Field Values

TWO_STOP_BITS

public static final int TWO_STOP_BITS

Code value for two stop bits.

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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