bundles/org.eclipse.wst.xml.core/src/org/eclipse/wst/xml/core/internal/propagate/PropagatingAdapterFactoryImpl.java

/*******************************************************************************
 * Copyright (c) 2001, 2004 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Jens Lukowski/Innoopract - initial renaming/restructuring
 *     
 *******************************************************************************/
package org.eclipse.wst.xml.core.internal.propagate;


import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import org.eclipse.wst.sse.core.AbstractAdapterFactory;
import org.eclipse.wst.sse.core.IAdapterFactory;
import org.eclipse.wst.sse.core.INodeAdapter;
import org.eclipse.wst.sse.core.INodeNotifier;
import org.eclipse.wst.sse.core.internal.PropagatingAdapter;
import org.eclipse.wst.sse.core.internal.PropagatingAdapterFactory;


/**
 * The PropagatingAdapterFactory is part of the "adapt on create" mechanism. A
 * PropagatingAdapter, once added to a node, will cause proagating adapters to
 * be created for all child nodes. A side effect of creating a
 * PropagatingAdapter for a node is that is is also creates adapters for and
 * adapts the Node for all other registered 'create on adapt' Adapters. This
 * other adapters are registered by registering their factories via plugin
 * extension point.
 */
public class PropagatingAdapterFactoryImpl extends AbstractAdapterFactory implements PropagatingAdapterFactory {

	private PropagatingAdapter adapterInstance;
	protected List contributedFactories = null;

	/**
	 * PropagatingAdapterFactory constructor comment.
	 */
	public PropagatingAdapterFactoryImpl() {
		this(PropagatingAdapter.class, true);
	}

	protected PropagatingAdapterFactoryImpl(Object adapterKey, boolean registerAdapters) { //,
		// Object
		// modelType)
		// {
		super(adapterKey, registerAdapters);
	}

	public void addContributedFactories(IAdapterFactory factory) {
		if (contributedFactories != null) {
			contributedFactories.add(factory);
		}

	}

	public IAdapterFactory copy() {
		PropagatingAdapterFactory clonedInstance = new PropagatingAdapterFactoryImpl(this.adapterKey, this.shouldRegisterAdapter);
		// clone this adapters specific list of adapter factories too
		if (contributedFactories != null) {
			Iterator iterator = contributedFactories.iterator();
			clonedInstance.setContributedFactories(new ArrayList());
			while (iterator.hasNext()) {
				IAdapterFactory existingFactory = (IAdapterFactory) iterator.next();
				clonedInstance.addContributedFactories(existingFactory.copy());
			}
		}
		return clonedInstance;
	}

	/**
	 * createAdapter method comment.
	 */
	protected INodeAdapter createAdapter(INodeNotifier target) {
		// every notifier get's one of these
		// (and the same instance of it)
		return getAdapterInstance();
	}

	/**
	 * Gets the adapterInstance.
	 * 
	 * @return Returns a PropagatingAdapter
	 */
	protected PropagatingAdapter getAdapterInstance() {
		if (adapterInstance == null) {
			adapterInstance = new PropagatingAdapterImpl();
			if (contributedFactories != null) {
				for (int i = 0; i < contributedFactories.size(); i++)
					adapterInstance.addAdaptOnCreateFactory((PropagatingAdapterFactory) contributedFactories.get(i));
			}
		}
		return adapterInstance;
	}

	public void release() {
		// give the adapter instance a chance to release its factories
		getAdapterInstance().release();

	}

	public void setContributedFactories(ArrayList list) {
		contributedFactories = list;

	}

}