Module org.refcodes.serial.ext.handshake

Package org.refcodes.serial.ext.handshake

Enum Class AcknowledgeMode

java.lang.Object

java.lang.Enum<AcknowledgeMode>

org.refcodes.serial.ext.handshake.AcknowledgeMode

All Implemented Interfaces:

Serializable, Comparable<AcknowledgeMode>, Constable

public enum AcknowledgeMode
extends Enum<AcknowledgeMode>

The AcknowledgeMode defines the mode of transmission, e.g. acknowledged or "fire-and-forget".

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
ACKNOWLEDGED	A transmission is acknowledged, e.g. directly or the response of a request.
NOT_ACKNOWLEDGED	A transmission is not acknowledged, e.g.

Method Summary

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

ACKNOWLEDGED

public static final AcknowledgeMode ACKNOWLEDGED

A transmission is acknowledged, e.g. directly or the response of a request.

NOT_ACKNOWLEDGED

public static final AcknowledgeMode NOT_ACKNOWLEDGED

A transmission is not acknowledged, e.g. "fire-and-forget", no acknowledge or negative acknowledge is sent upon receival failure.

Method Details

values

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