net.solarnetwork.io.modbus.serial

Enum SerialParity

java.lang.Object

java.lang.Enum<SerialParity>

net.solarnetwork.io.modbus.serial.SerialParity

All Implemented Interfaces:

Serializable, Comparable<SerialParity>

public enum SerialParity
extends Enum<SerialParity>

Enumeration of serial parity settings.

Enum Constant Summary

Enum Constants

Enum Constant	Description
Even	An even parity bit will be sent with each data character, i.e.
Mark	A 1 parity bit will be sent with each data character.
None	No parity bit will be sent with each data character at all.
Odd	An odd parity bit will be sent with each data character, i.e.
Space	A 0 parity bit will be sent with each data character.

Field Summary

Fields

Modifier and Type	Field	Description
static int	EVEN_PARITY	Code value for even parity.
static String	EVEN_PARITY_ABBREVIATION	Abbreviation value for even parity.
static int	MARK_PARITY	Code value for mark parity.
static String	MARK_PARITY_ABBREVIATION	Abbreviation value for mark parity.
static int	NO_PARITY	Code value for no parity.
static String	NO_PARITY_ABBREVIATION	Abbreviation value for no parity.
static int	ODD_PARITY	Code value for odd parity.
static String	ODD_PARITY_ABBREVIATION	Abbreviation value for odd parity.
static int	SPACE_PARITY	Code value for space parity.
static String	SPACE_PARITY_ABBREVIATION	Abbreviation value for space parity.

Method Summary

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

No parity bit will be sent with each data character at all.

Odd

public static final SerialParity Odd

An odd parity bit will be sent with each data character, i.e. will be set to 1 if the data character contains an even number of bits set to 1.

Even

public static final SerialParity Even

An even parity bit will be sent with each data character, i.e. will be set to 1 if the data character contains an odd number of bits set to 1.

Mark

public static final SerialParity Mark

A 1 parity bit will be sent with each data character.

Space

public static final SerialParity Space

A 0 parity bit will be sent with each data character.

Field Detail

NO_PARITY

public static final int NO_PARITY

Code value for no parity.

See Also:

Constant Field Values

ODD_PARITY

public static final int ODD_PARITY

Code value for odd parity.

See Also:

Constant Field Values

EVEN_PARITY

public static final int EVEN_PARITY

Code value for even parity.

See Also:

Constant Field Values

MARK_PARITY

public static final int MARK_PARITY

Code value for mark parity.

See Also:

Constant Field Values

SPACE_PARITY

public static final int SPACE_PARITY

Code value for space parity.

See Also:

Constant Field Values

NO_PARITY_ABBREVIATION

public static final String NO_PARITY_ABBREVIATION

Abbreviation value for no parity.

See Also:

Constant Field Values

ODD_PARITY_ABBREVIATION

public static final String ODD_PARITY_ABBREVIATION

Abbreviation value for odd parity.

See Also:

Constant Field Values

EVEN_PARITY_ABBREVIATION

public static final String EVEN_PARITY_ABBREVIATION

Abbreviation value for even parity.

See Also:

Constant Field Values

MARK_PARITY_ABBREVIATION

public static final String MARK_PARITY_ABBREVIATION

Abbreviation value for mark parity.

See Also:

Constant Field Values

SPACE_PARITY_ABBREVIATION

public static final String SPACE_PARITY_ABBREVIATION

Abbreviation value for space parity.

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getAbbreviation

public String getAbbreviation()

Get an abbreviation for this parity.

Returns:

an abbreviation, one of N, O, E, M, and S for None, Odd, Even, Mark, and Space

forCode

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

forAbbreviation

public static SerialParity forAbbreviation(String abbreviation)

Get an enum instance for an abbreviation value.

The supported abbreviations are N, O, E, M, and S for None, Odd, Even, Mark, and Space. Lower-case versions of these are supported.

Parameters:

abbreviation - the abbreviation

Returns:

the enum

Throws:

IllegalArgumentException - if code is not a valid value