View Javadoc
1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License.
18   *
19   */
20  package org.apache.mina.statemachine.transition;
21  
22  import org.apache.mina.statemachine.context.StateContext;
23  import org.apache.mina.statemachine.State;
24  
25  /**
26   * Abstract {@link SelfTransition} implementation.
27   *
28   * @author <a href="http://mina.apache.org">Apache MINA Project</a>
29   */
30  
31  public abstract class AbstractSelfTransition implements SelfTransition {
32      /**
33       * Creates a new instance
34       */
35      public AbstractSelfTransition() {
36  
37      }
38  
39      /**
40       * Executes this {@link SelfTransition}.
41       * 
42       * @param stateContext the context in which the execution should occur
43       * @param state the current state
44       * @return <tt>true</tt> if the {@link SelfTransition} has been executed
45       *         successfully
46       */
47      protected abstract boolean doExecute(StateContext stateContext, State state);
48  
49      /**
50       * {@inheritDoc}
51       */
52      public boolean execute(StateContext stateContext, State state) {
53  
54          return doExecute(stateContext, state);
55      }
56  }