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 public abstract class LifecycleFactory implements
29 FacesWrapper<LifecycleFactory>
30 {
31 public static final java.lang.String DEFAULT_LIFECYCLE = "DEFAULT";
32
33 private LifecycleFactory delegate;
34
35 @Deprecated
36 public LifecycleFactory()
37 {
38 }
39
40 public LifecycleFactory(LifecycleFactory delegate)
41 {
42 this.delegate = delegate;
43 }
44
45 public abstract void addLifecycle(String lifecycleId,
46 Lifecycle lifecycle);
47
48 public abstract Lifecycle getLifecycle(String lifecycleId);
49
50 public abstract Iterator<String> getLifecycleIds();
51
52 /**
53 * If this factory has been decorated, the implementation doing the decorating may override this method to
54 * provide access to the implementation being wrapped. A default implementation is provided that returns
55 * <code>null</code>.
56 *
57 * @return the decorated <code>LifecycleFactory</code> if this factory decorates another,
58 * or <code>null</code> otherwise
59 *
60 * @since 2.0
61 */
62 public LifecycleFactory getWrapped()
63 {
64 return delegate;
65 }
66 }