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.lifecycle;
20  
21  import java.util.Iterator;
22  
23  import javax.faces.FacesWrapper;
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: 1187701 $ $Date: 2011-10-22 12:21:54 +0000 (Sat, 22 Oct 2011) $
30   */
31  public abstract class LifecycleFactory implements
32      FacesWrapper<LifecycleFactory>
33  {
34      public static final java.lang.String DEFAULT_LIFECYCLE = "DEFAULT";
35  
36      public abstract void addLifecycle(String lifecycleId,
37                                        Lifecycle lifecycle);
38  
39      public abstract Lifecycle getLifecycle(String lifecycleId);
40  
41      public abstract Iterator<String> getLifecycleIds();
42      
43      /**
44       * If this factory has been decorated, the implementation doing the decorating may override this method to 
45       * provide access to the implementation being wrapped. A default implementation is provided that returns 
46       * <code>null</code>.
47       * 
48       * @return the decorated <code>LifecycleFactory</code> if this factory decorates another, 
49       *         or <code>null</code> otherwise
50       * 
51       * @since 2.0
52       */
53      public LifecycleFactory getWrapped()
54      {
55          return null;
56      }    
57  }