lifecyclefactoryimpl.java

Please read your package and describe it at least 40 bytes in English. System will automatically de

/*
 * Copyright 2002-2004 the original author or authors.
 * 
 * Licensed 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 de.mindmatters.faces.lifecycle;

import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;

import javax.faces.lifecycle.Lifecycle;
import javax.faces.lifecycle.LifecycleFactory;

import org.springframework.util.Assert;

/**
 * <strong>LifecycleFactory</strong> is a factory object that creates (if
 * needed) and returns {@link Lifecycle} instances. This implementation delivers
 * a default lifecycle for the lifecycle-id
 * {@link LifecycleFactory#DEFAULT_LIFECYCLE} and a modified one for the key
 * {@link LifecycleImpl#JSF_SPRING_LIFECYCLE_ID} (which will be used for
 * integration purposes of SpringMVC).
 * 
 * @author Andreas Kuhrwahl
 * @see LifecycleImpl
 * 
 */
public class LifecycleFactoryImpl extends LifecycleFactory {

    /** The lifecycles handled by this factory. */
    private final Map lifecycleMap = new HashMap();

    /**
     * Default Constructor adding the default lifecycle to this factory.
     */
    public LifecycleFactoryImpl() {
        this.lifecycleMap.put(LifecycleFactory.DEFAULT_LIFECYCLE,
                createDefaultLifecycle());
    }

    /**
     * {@inheritDoc}
     */
    public final void addLifecycle(final String lifecycleId,
            final Lifecycle lifecycle) {
        synchronized (this.lifecycleMap) {
            if (lifecycleId == null || lifecycle == null) {
                throw new NullPointerException("LifecycleId or Lifecycle");
            }
            Assert.isTrue(!this.lifecycleMap.containsKey(lifecycleId),
                    "Lifecycle with id '" + lifecycleId + "' already added.");
            this.lifecycleMap.put(lifecycleId, lifecycle);
        }
    }

    /**
     * {@inheritDoc}
     */
    public final Lifecycle getLifecycle(final String lifecycleId) {
        synchronized (this.lifecycleMap) {
            if (lifecycleId == null) {
                throw new NullPointerException("LifecycleId");
            }
            Lifecycle lifecycle = (Lifecycle) lifecycleMap.get(lifecycleId);
            Assert.notNull(lifecycle, "Lifecycle with id '" + lifecycleId
                    + "' is not available.");
            return lifecycle;
        }
    }

    /**
     * {@inheritDoc}
     */
    public final Iterator getLifecycleIds() {
        synchronized (this.lifecycleMap) {
            return this.lifecycleMap.keySet().iterator();
        }
    }

    /**
     * Factory method for creating the default lifecycle. Defualt implementation
     * returns an instance of {@link LifecycleImpl}. May be overridden by
     * subclasses.
     * 
     * @return the default lifecycle
     */
    protected Lifecycle createDefaultLifecycle() {
        return LifecycleImpl.createDefaultLifecycle();
    }

}