jakarta.faces.lifecycle.LifecycleFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of myfaces-api Show documentation

The public API classes of the Apache MyFaces CORE JSF-2.1 project

There is a newer version: 4.1.0-RC3

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 jakarta.faces.lifecycle;

import java.util.Iterator;

import jakarta.faces.FacesWrapper;

/**
 * see Javadoc of Faces Specification
 */
public abstract class LifecycleFactory implements
    FacesWrapper
{
    public static final java.lang.String DEFAULT_LIFECYCLE = "DEFAULT";

    private LifecycleFactory delegate;

    @Deprecated
    public LifecycleFactory()
    {
    }

    public LifecycleFactory(LifecycleFactory delegate)
    {
        this.delegate = delegate;
    }
    
    public abstract void addLifecycle(String lifecycleId,
                                      Lifecycle lifecycle);

    public abstract Lifecycle getLifecycle(String lifecycleId);

    public abstract Iterator getLifecycleIds();
    
    /**
     * If this factory has been decorated, the implementation doing the decorating may override this method to 
     * provide access to the implementation being wrapped. A default implementation is provided that returns 
     * null.
     * 
     * @return the decorated LifecycleFactory if this factory decorates another, 
     *         or null otherwise
     * 
     * @since 2.0
     */
    @Override
    public LifecycleFactory getWrapped()
    {
        return delegate;
    }    
}