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 package org.apache.myfaces.lifecycle;
20
21 import javax.faces.context.FacesContext;
22 import javax.faces.event.PhaseId;
23
24 /**
25 * Implements the PhaseExecutor for a lifecycle
26 *
27 * @author Nikolay Petrov (latest modification by $Author$)
28 * @version $Revision$ $Date$
29 */
30 abstract class PhaseExecutor
31 {
32
33 /**
34 * Executes a phase of the JavaServer(tm) Faces lifecycle, like UpdateModelValues. The <code>execute</code> method
35 * is called by the lifecylce implementation's private <code>executePhase</code>.
36 *
37 * @param facesContext
38 * The <code>FacesContext</code> for the current request we are processing
39 * @return <code>true</code> if execution should be stopped
40 */
41 public abstract boolean execute(FacesContext facesContext);
42
43 /**
44 * Returns the <code>PhaseId</code> for which the implemented executor is invoked
45 *
46 * @return
47 */
48 public abstract PhaseId getPhase();
49
50 /**
51 * This method will be called by LifecycleImpl before the phase associated with this
52 * PhaseExecutor actually starts (before the before-PhaseListeners are called).
53 * Thus the PhaseExecutor implementation will be able to do some pre-phase initialisation work.
54 *
55 * @param facesContext
56 * @since 2.0.1
57 */
58 public void doPrePhaseActions(FacesContext facesContext)
59 {
60 // default: nothing
61 }
62
63 }