abstractphase.java

Please read your package and describe it at least 40 bytes in English. System will automatically de

/*
 * Copyright 2002-2004 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package de.mindmatters.faces.lifecycle;

import javax.faces.context.FacesContext;

/**
 * Convenience superclass for phase implementations, using the Template Method
 * design pattern which invokes {@link #beforePhase(FacesContext)} at the
 * beginning and {@link #afterPhase(FacesContext)} at the end of phase
 * execution.
 * 
 * @author Andreas Kuhrwahl
 * 
 */
public abstract class AbstractPhase implements Phase {

    /**
     * {@inheritDoc}
     */
    public final void execute(final FacesContext context) {
        beforePhase(context);
        executePhase(context);
        afterPhase(context);
    }

    /**
     * Perform all state transitions required by the current phase of the
     * request processing {@link javax.faces.lifecycle.Lifecycle} for a
     * particular request.
     * 
     * @param context
     *            FacesContext for the current request being processed
     * @throws javax.faces.FacesException
     *             if a processing error occurred while executing this phase
     * @see Phase#execute(FacesContext)
     */
    protected abstract void executePhase(FacesContext context);

    /**
     * Template method. Subclasses can override this. This method will be
     * invoked <strong>before</strong> the concrete phase is executed. Default
     * implementation does nothing.
     * 
     * @param context
     *            FacesContext for the current request being processed
     * @throws javax.faces.FacesException
     *             if a processing error occurred while executing this phase
     */
    protected void beforePhase(final FacesContext context) {
    }

    /**
     * Template method. Subclasses can override this. This method will be
     * invoked <strong>after</strong> the concrete phase is executed. Default
     * implementation does nothing.
     * 
     * @param context
     *            FacesContext for the current request being processed
     * @throws javax.faces.FacesException
     *             if a processing error occurred while executing this phase
     */
    protected void afterPhase(final FacesContext context) {
    }

}