org.vishia.event

Enum TimeOrderCmd

java.lang.Object

java.lang.Enum<TimeOrderCmd>

org.vishia.event.TimeOrderCmd

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TimeOrderCmd>

public enum TimeOrderCmd
extends java.lang.Enum<TimeOrderCmd>

This enum can be used to enhance for state machine events, which are used also as timeout. Non enhanced it is used for a EventCmdtype as generic for a timeout event type. It is checked and recognized in the operation EventCmdtype#isTimeout()-

Since:

2023-02-07

Enum Constant Summary

Enum Constants

Enum Constant and Description
abort Used typically on a abort situation of an order which calls progress between.
ask Used typically on a situation where a question is given of an order which calls progress between.
done Used typically on end of an order which calls progress between.
error Used typically on error of an order which calls progress between.
progress Used typical in a cyclically call of any order.
timeOrder Used typical in one call of any order for a delayed operation.
timeout Used typically in state machines for a timeout.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	ident

Method Summary

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

timeout

public static final TimeOrderCmd timeout

Used typically in state machines for a timeout.

timeOrder

public static final TimeOrderCmd timeOrder

Used typical in one call of any order for a delayed operation.

progress

public static final TimeOrderCmd progress

Used typical in a cyclically call of any order.

done

public static final TimeOrderCmd done

Used typically on end of an order which calls progress between.

error

public static final TimeOrderCmd error

Used typically on error of an order which calls progress between.

ask

public static final TimeOrderCmd ask

Used typically on a situation where a question is given of an order which calls progress between.

abort

public static final TimeOrderCmd abort

Used typically on a abort situation of an order which calls progress between.

Field Detail

ident

final java.lang.String ident

Method Detail

values

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

Returns:

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

valueOf

public static TimeOrderCmd valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null