001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 *
019 */
020package org.apache.mina.statemachine.transition;
021
022import org.apache.mina.statemachine.context.StateContext;
023import org.apache.mina.statemachine.State;
024
025/**
026 * Abstract {@link SelfTransition} implementation.
027 *
028 * @author <a href="http://mina.apache.org">Apache MINA Project</a>
029 */
030
031public abstract class AbstractSelfTransition implements SelfTransition {
032    /**
033     * Creates a new instance
034     */
035    public AbstractSelfTransition() {
036
037    }
038
039    /**
040     * Executes this {@link SelfTransition}.
041     * 
042     * @param stateContext the context in which the execution should occur
043     * @param state the current state
044     * @return <tt>true</tt> if the {@link SelfTransition} has been executed
045     *         successfully
046     */
047    protected abstract boolean doExecute(StateContext stateContext, State state);
048
049    /**
050     * {@inheritDoc}
051     */
052    public boolean execute(StateContext stateContext, State state) {
053
054        return doExecute(stateContext, state);
055    }
056}