Module org.refcodes.serial

Package org.refcodes.serial

Enum Class HandshakeProtocol

java.lang.Object

java.lang.Enum<HandshakeProtocol>

org.refcodes.serial.HandshakeProtocol

All Implemented Interfaces:

Serializable, Comparable<HandshakeProtocol>, Constable

public enum HandshakeProtocol
extends Enum<HandshakeProtocol>

Enumeration with the various protocol settings when receiving a transmission. A transmission may require an acknowledge handshake for a transmission.

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
NO_ACKNOWLEDGE	No CRC error detection and no acknowledge handshake.
REQUEST_FOR_ACKNOWLEDGE	No CRC error detection but acknowledge handshake.

Method Summary

Modifier and Type	Method	Description
boolean	isAcknowledge()	Determines whether an acknowledge handshake is to be established upon receival of a transmission.
static HandshakeProtocol	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HandshakeProtocol[]	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

NO_ACKNOWLEDGE

public static final HandshakeProtocol NO_ACKNOWLEDGE

No CRC error detection and no acknowledge handshake.

REQUEST_FOR_ACKNOWLEDGE

public static final HandshakeProtocol REQUEST_FOR_ACKNOWLEDGE

No CRC error detection but acknowledge handshake.

Method Details

values

public static HandshakeProtocol[] 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 HandshakeProtocol 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

isAcknowledge

public boolean isAcknowledge()

Determines whether an acknowledge handshake is to be established upon receival of a transmission.

Returns:

True in case of an acknowledge handshake.