Package dev.agenor.core.dialogue.protocol

Enum Class ProtocolState

java.lang.Object

java.lang.Enum<ProtocolState>

dev.agenor.core.dialogue.protocol.ProtocolState

All Implemented Interfaces:

Serializable, Comparable<ProtocolState>, Constable

public enum ProtocolState
extends Enum<ProtocolState>

States for interaction protocol state machines.

Since:

0.5.0

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
AGREED	Parties have agreed
AWAITING_RESPONSE	Waiting for a response
CANCELLED	Protocol was cancelled
COMPLETED	Protocol completed successfully
FAILED	Action failed
INITIATED	Protocol has been initiated
REFUSED	Request was refused
TIMEOUT	Protocol timed out

Method Summary

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

INITIATED

public static final ProtocolState INITIATED

Protocol has been initiated

AWAITING_RESPONSE

public static final ProtocolState AWAITING_RESPONSE

Waiting for a response

AGREED

public static final ProtocolState AGREED

Parties have agreed

COMPLETED

public static final ProtocolState COMPLETED

Protocol completed successfully

REFUSED

public static final ProtocolState REFUSED

Request was refused

FAILED

public static final ProtocolState FAILED

Action failed

CANCELLED

public static final ProtocolState CANCELLED

Protocol was cancelled

TIMEOUT

public static final ProtocolState TIMEOUT

Protocol timed out

Method Details

values

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

isTerminal

public boolean isTerminal()

Returns:

true if this is a terminal state

isSuccess

public boolean isSuccess()

Returns:

true if this state represents success