Module org.refcodes.serial.ext.handshake

Package org.refcodes.serial.ext.handshake

Enum AcknowledgeType

java.lang.Object

java.lang.Enum<AcknowledgeType>

org.refcodes.serial.ext.handshake.AcknowledgeType

All Implemented Interfaces:

Serializable, Comparable<AcknowledgeType>, java.lang.constant.Constable

public enum AcknowledgeType
extends Enum<AcknowledgeType>

The AcknowledgeType defines the type of an AcknowledgeMessage confirmation mode in response to a TransmissionMessage.

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
ACKNOWLEDGE	Sent when a transmission was received.
PONG	Identifies a a fire-and-forget pong (not to be acknowledged) reply in response to a simple ping request.
REQUEST_DISMISSED	Sent when a request was received but dismissed by a receiver .
RESPONSE	A request is acknowledged by a response which in turn is acknowledged.
TRANSMISSION_DISMISSED	Sent in case a transmission was received and dismissed by a receiver.

Method Summary

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

ACKNOWLEDGE

public static final AcknowledgeType ACKNOWLEDGE

Sent when a transmission was received.

TRANSMISSION_DISMISSED

public static final AcknowledgeType TRANSMISSION_DISMISSED

Sent in case a transmission was received and dismissed by a receiver.

RESPONSE

public static final AcknowledgeType RESPONSE

A request is acknowledged by a response which in turn is acknowledged.

REQUEST_DISMISSED

public static final AcknowledgeType REQUEST_DISMISSED

Sent when a request was received but dismissed by a receiver .

PONG

public static final AcknowledgeType PONG

Identifies a a fire-and-forget pong (not to be acknowledged) reply in response to a simple ping request.

Method Details

values

public static AcknowledgeType[] values()

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

Returns:

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

valueOf

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