Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 85dab8137025c4980a24afe09df54a8a611ca1d5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
/***************************************************************************
 * Copyright (c) 2004, 2005, 2006 Eike Stepper, Fuggerstr. 39, 10777 Berlin, Germany.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *    Eike Stepper - initial API and implementation
 **************************************************************************/
package org.eclipse.net4j.util.fsm;


import org.apache.log4j.Logger;


public abstract class StateMachine<SUBJECT> implements IStateMachine<SUBJECT>
{
  private static final Logger logger = Logger.getLogger(StateMachine.class.getName());

  private String[] stateNames;

  private String[] eventNames;

  private ITransition<SUBJECT>[][] matrix;

  public StateMachine(String[] stateNames, String[] eventNames,
      ITransition<SUBJECT> defaultTransition)
  {
    this.stateNames = stateNames;
    this.eventNames = eventNames;

    matrix = new ITransition[stateNames.length][eventNames.length];

    if (defaultTransition != null)
    {
      for (int state = 0; state < stateNames.length; state++)
      {
        for (int event = 0; event < eventNames.length; event++)
        {
          handle(state, event, defaultTransition);
        }
      }
    }
  }

  public StateMachine(String[] stateNames, String[] eventNames)
  {
    this(stateNames, eventNames, null);
  }

  public int getStateCount()
  {
    return stateNames.length;
  }

  public int getEventCount()
  {
    return eventNames.length;
  }

  public String getStateName(int state)
  {
    return stateNames[state];
  }

  public String getEventName(int event)
  {
    return eventNames[event];
  }

  public ITransition<SUBJECT> getIdentityTransition()
  {
    return new ITransition<SUBJECT>()
    {
      public void process(SUBJECT subject, int event, Object data) throws Exception
      {
        if (getLogger().isDebugEnabled())
        {
          int state = getState(subject);
          getLogger().debug("Ignoring   " + makeLabel(subject, state, event));
        }
      }
    };
  }

  public void handle(int state, int event, ITransition<SUBJECT> transition)
  {
    matrix[state][event] = transition;
  }

  public void handle(int state, int event, final int newState)
  {
    handle(state, event, new ITransition<SUBJECT>()
    {
      public void process(SUBJECT subject, int event, Object data) throws Exception
      {
        setState(subject, newState);
      }
    });
  }

  public void ignore(int state, int event)
  {
    handle(state, event, getIdentityTransition());
  }

  public void cancel(int state, int event)
  {
    handle(state, event, null);
  }

  public void process(SUBJECT subject, int event, Object data) throws Exception
  {
    int state = getState(subject);
    ITransition<SUBJECT> transition = matrix[state][event];

    if (transition == null)
    {
      if (getLogger().isDebugEnabled())
      {
        getLogger().warn("Ignoring   " + makeLabel(subject, state, event));
      }

      return;
    }

    if (getLogger().isDebugEnabled())
    {
      getLogger().debug("Processing " + makeLabel(subject, state, event));
    }

    transition.process(subject, event, data);

    if (getLogger().isDebugEnabled())
    {
      int newState = getState(subject);
      getLogger()
          .debug(
              "Finished   " + makeLabel(subject, state, event) + ", newState="
                  + getStateName(newState));
    }
  }

  protected Logger getLogger()
  {
    return logger;
  }

  protected String makeLabel(SUBJECT subject, int state, int event)
  {
    return "event " + eventNames[event] + " in state " + stateNames[state] + " for subject "
        + subject;
  }

  protected abstract int getState(SUBJECT subject);

  protected abstract void setState(SUBJECT subject, int state);
}

Back to the top