org.arch4j.clientcontroller
Class ErrorState

java.lang.Object
  |
  +--org.arch4j.clientcontroller.State
        |
        +--org.arch4j.clientcontroller.ErrorState

public class ErrorState

extends State

This class defines an error state. It will be instantiated solely by the root StateMachine when an event handling operation throws a StateMachineException. The constructor expects as an argument the root entry transition which allows the state machine to re-enter its valid default state.

State overview

• State name
• ErrorState
• Context values added on entry
• systemErrorMessage
• systemErrorStackTrace
• Context values removed on entry
• Context values added on exit
• Context values removed on exit
• systemErrorMessage
• systemErrorStackTrace
• Transitions by priority
1. The entry transition specified to the state machine

Version:

1.0

Author:

David Colwell

Constructor Summary

ErrorState(Transition anEntryTransition, StateMachineException aStateMachineException)
Constructor that sets the only transition for this error state to be the one specified.

Method Summary

void	buildTransitionList() Does nothing - defined only to satisfy the abstract superclass.
void	entryAction(StateContext context) Perform the entry action for this state.
void	exitAction(StateContext context) Perform the exit action for this state.
String	getStateName() Retrieves the state name.

Methods inherited from class org.arch4j.clientcontroller.State

appendTransition, createEmbeddedStateMachine, createEmbeddedStateMachine, getEmbeddedStateMachine, getTransitionList

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ErrorState

public ErrorState(Transition anEntryTransition,
                  StateMachineException aStateMachineException)

Constructor that sets the only transition for this error state to be the one specified.

Method Detail

getStateName

public String getStateName()

Retrieves the state name.

Specified by:

getStateName in class State

entryAction

public void entryAction(StateContext context)
                 throws StateMachineException

Perform the entry action for this state. Does nothing - defined only to satisfy the abstract superclass.

Overrides:

entryAction in class State

Throws:

StateMachineException - if there is any problem processing the request. This might include a missing key-value, application server problems, failed domain validation, or data access errors.

exitAction

public void exitAction(StateContext context)
                throws StateMachineException

Perform the exit action for this state. Does nothing - defined only to satisfy the abstract superclass.

Overrides:

exitAction in class State

Throws:

StateMachineException - if there is any problem processing the request. This might include a missing key-value, application server problems, failed domain validation, or data access errors.

buildTransitionList

public void buildTransitionList()

Does nothing - defined only to satisfy the abstract superclass.

Specified by:

buildTransitionList in class State