io.hektor.fsm.builder.exceptions

Enum FSMBuilderException.ErrorCode

java.lang.Object

java.lang.Enum<FSMBuilderException.ErrorCode>

io.hektor.fsm.builder.exceptions.FSMBuilderException.ErrorCode

All Implemented Interfaces:

Serializable, Comparable<FSMBuilderException.ErrorCode>

Enclosing class:

FSMBuilderException

public static enum FSMBuilderException.ErrorCode
extends Enum<FSMBuilderException.ErrorCode>

There are many different issues that can occur when building the state machine and instead of having individual exceptions for everything, we have these error codes. The reason is that some of the issues that may arise may be hard to understand and generic exceptions will not catch those scenarios so it is important that we have enough documentation around those cases so the user, you, understand why building the FSM failed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ILLEGAL_TRANSFORMATION_ON_TRANSITION You can optionally specify a transformation with your transition but you can only do so if the state you are transitioning to is a so-called transient state.
NO_FINAL_STATE Every FSM must have its final state defined.
NO_INITIAL_STATE Every FSM must have an initial state or we do not know where to start off with.

Method Summary

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

NO_INITIAL_STATE

public static final FSMBuilderException.ErrorCode NO_INITIAL_STATE

Every FSM must have an initial state or we do not know where to start off with.

NO_FINAL_STATE

public static final FSMBuilderException.ErrorCode NO_FINAL_STATE

Every FSM must have its final state defined.

ILLEGAL_TRANSFORMATION_ON_TRANSITION

public static final FSMBuilderException.ErrorCode ILLEGAL_TRANSFORMATION_ON_TRANSITION

You can optionally specify a transformation with your transition but you can only do so if the state you are transitioning to is a so-called transient state. See TransitionBuilder.withTransformation(Function)

Method Detail

values

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

Returns:

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

valueOf

public static FSMBuilderException.ErrorCode 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

getTemplate

public String getTemplate()