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  package javax.faces.context;
20  
21  import javax.faces.FacesException;
22  import javax.faces.FacesWrapper;
23  import javax.faces.lifecycle.Lifecycle;
24  
25  /**
26   * see Javadoc of <a href="http://java.sun.com/javaee/javaserverfaces/1.2/docs/api/index.html">JSF Specification</a>
27   * 
28   * @author Manfred Geiler (latest modification by $Author: bommel $)
29   * @version $Revision: 1187700 $ $Date: 2011-10-22 07:19:37 -0500 (Sat, 22 Oct 2011) $
30   */
31  public abstract class FacesContextFactory implements FacesWrapper<FacesContextFactory>
32  {
33      public abstract FacesContext getFacesContext(Object context, Object request, Object response, Lifecycle lifecycle)
34              throws FacesException;
35  
36      /**
37       * If this factory has been decorated, the implementation doing the decorating may override this method to provide
38       * access to the implementation being wrapped. A default implementation is provided that returns <code>null</code>.
39       * 
40       * @return the decorated <code>FacesContextFactory</code> if this factory decorates another, or <code>null</code>
41       *         otherwise
42       * 
43       * @since 2.0
44       */
45      public FacesContextFactory getWrapped()
46      {
47          return null;
48      }
49  }