bundles/org.eclipse.core.databinding.property/src/org/eclipse/core/databinding/property/map/DelegatingMapProperty.java

/*******************************************************************************
 * Copyright (c) 2008, 2010 Matthew Hall 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:
 *     Matthew Hall - initial API and implementation (bug 247997)
 *     Matthew Hall - bug 264306
 ******************************************************************************/

package org.eclipse.core.databinding.property.map;

import java.util.Collections;
import java.util.Map;

import org.eclipse.core.databinding.observable.Realm;
import org.eclipse.core.databinding.observable.map.IObservableMap;
import org.eclipse.core.databinding.observable.map.MapDiff;
import org.eclipse.core.databinding.property.INativePropertyListener;
import org.eclipse.core.databinding.property.ISimplePropertyListener;

/**
 * @param <S>
 *            type of the source object
 * @param <K>
 *            type of the keys to the map
 * @param <V>
 *            type of the values in the map
 * @since 1.2
 * 
 */
public abstract class DelegatingMapProperty<S, K, V> extends
		MapProperty<S, K, V> {
	private final Object keyTypeAsObject;
	private final Object valueTypeAsObject;
	private final Class<K> keyType;
	private final Class<V> valueType;
	private final IMapProperty<S, K, V> nullProperty = new NullMapProperty();

	protected DelegatingMapProperty() {
		this.keyType = null;
		this.valueType = null;
		this.keyTypeAsObject = null;
		this.valueTypeAsObject = null;
	}

	/**
	 * 
	 * @param keyType
	 * @param valueType
	 * @deprecated use the constructor which takes Class as parameters. This is
	 *             safer because code in this plug-in fails anyway if a Class is
	 *             not passed.
	 */
	protected DelegatingMapProperty(Object keyType, Object valueType) {
		this.keyType = null;
		this.valueType = null;
		this.keyTypeAsObject = keyType;
		this.valueTypeAsObject = valueType;
	}

	/**
	 * 
	 * @param keyType
	 * @param valueType
	 * @since 1.5
	 */
	protected DelegatingMapProperty(Class<K> keyType, Class<V> valueType) {
		this.keyType = keyType;
		this.valueType = valueType;
		this.keyTypeAsObject = keyType;
		this.valueTypeAsObject = valueType;
	}

	/**
	 * Returns the property to delegate to for the specified source object.
	 * Repeated calls to this method with the same source object returns the
	 * same delegate instance.
	 * 
	 * @param source
	 *            the property source (may be null)
	 * @return the property to delegate to for the specified source object.
	 */
	public final IMapProperty<S, K, V> getDelegate(S source) {
		if (source == null)
			return nullProperty;
		IMapProperty<S, K, V> delegate = doGetDelegate(source);
		if (delegate == null)
			delegate = nullProperty;
		return delegate;
	}

	/**
	 * Returns the property to delegate to for the specified source object.
	 * Implementers must ensure that repeated calls to this method with the same
	 * source object returns the same delegate instance.
	 * 
	 * @param source
	 *            the property source
	 * @return the property to delegate to for the specified source object.
	 */
	protected abstract IMapProperty<S, K, V> doGetDelegate(S source);

	/**
	 * @deprecated use getKeyClass instead
	 */
	public Object getKeyType() {
		return keyTypeAsObject;
	}

	/**
	 * @since 1.5
	 */
	public Class<K> getKeyClass() {
		return keyType;
	}

	/**
	 * @deprecated use getValueClass instead
	 */
	public Object getValueType() {
		return valueTypeAsObject;
	}

	/**
	 * @since 1.5
	 */
	public Class<V> getValueClass() {
		return valueType;
	}

	protected Map<K, V> doGetMap(S source) {
		return getDelegate(source).getMap(source);
	}

	protected void doSetMap(S source, Map<K, V> map) {
		getDelegate(source).setMap(source, map);
	}

	protected void doUpdateMap(S source, MapDiff<K, V> diff) {
		getDelegate(source).updateMap(source, diff);
	}

	public IObservableMap<K, V> observe(S source) {
		return getDelegate(source).observe(source);
	}

	public IObservableMap<K, V> observe(Realm realm, S source) {
		return getDelegate(source).observe(realm, source);
	}

	private class NullMapProperty extends SimpleMapProperty<S, K, V> {
		protected Map<K, V> doGetMap(Object source) {
			return Collections.emptyMap();
		}

		protected void doSetMap(S source, Map<K, V> map, MapDiff<K, V> diff) {
		}

		protected void doSetMap(S source, Map<K, V> map) {
		}

		protected void doUpdateMap(S source, MapDiff<K, V> diff) {
		}

		public INativePropertyListener<S> adaptListener(
				ISimplePropertyListener<MapDiff<K, V>> listener) {
			return null;
		}

		public Object getKeyType() {
			return keyTypeAsObject;
		}

		public Object getValueType() {
			return valueTypeAsObject;
		}

		public Class<K> getKeyClass() {
			return keyType;
		}

		public Class<V> getValueClass() {
			return valueType;
		}
	}
}