bundles/org.eclipse.core.databinding.beans/src/org/eclipse/core/internal/databinding/beans/BeanObservableListDecorator.java

/*******************************************************************************
 * Copyright (c) 2007 Brad Reynolds 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:
 *     Brad Reynolds - initial API and implementation
 *     Matthew Hall - bug 208858
 ******************************************************************************/

package org.eclipse.core.internal.databinding.beans;

import java.beans.PropertyDescriptor;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;

import org.eclipse.core.databinding.beans.IBeanObservable;
import org.eclipse.core.databinding.observable.IStaleListener;
import org.eclipse.core.databinding.observable.ObservableTracker;
import org.eclipse.core.databinding.observable.StaleEvent;
import org.eclipse.core.databinding.observable.list.AbstractObservableList;
import org.eclipse.core.databinding.observable.list.IListChangeListener;
import org.eclipse.core.databinding.observable.list.IObservableList;
import org.eclipse.core.databinding.observable.list.ListChangeEvent;
import org.eclipse.core.internal.databinding.Util;

/**
 * {@link IBeanObservable} decorator for an {@link IObservableList}.
 * 
 * @since 3.3
 */
public class BeanObservableListDecorator extends AbstractObservableList
		implements IBeanObservable {
	private IObservableList delegate;
	private IStaleListener delegateStaleListener;
	private IListChangeListener delegateListChangeListener;

	private Object observed;
	private PropertyDescriptor propertyDescriptor;

	/**
	 * @param delegate
	 * @param observed
	 * @param propertyDescriptor
	 */
	public BeanObservableListDecorator(IObservableList delegate,
			Object observed, PropertyDescriptor propertyDescriptor) {
		super(delegate.getRealm());
		this.delegate = delegate;
		this.observed = observed;
		this.propertyDescriptor = propertyDescriptor;
	}

	public void add(int index, Object element) {
		delegate.add(index, element);
	}

	public boolean add(Object o) {
		return delegate.add(o);
	}

	public boolean addAll(Collection c) {
		return delegate.addAll(c);
	}

	public boolean addAll(int index, Collection c) {
		return delegate.addAll(index, c);
	}

	public void clear() {
		delegate.clear();
	}

	public void dispose() {
		delegate.dispose();
		super.dispose();
	}

	public boolean equals(Object o) {
		getterCalled();
		if (o instanceof BeanObservableListDecorator) {
			BeanObservableListDecorator other = (BeanObservableListDecorator) o;
			return Util.equals(other.delegate, delegate);
		}
		return Util.equals(delegate, o);
	}

	public Object get(int index) {
		getterCalled();
		return delegate.get(index);
	}

	public Object getElementType() {
		return delegate.getElementType();
	}

	public int hashCode() {
		getterCalled();
		return delegate.hashCode();
	}

	public int indexOf(Object o) {
		getterCalled();
		return delegate.indexOf(o);
	}

	public Iterator iterator() {
		getterCalled();
		return delegate.iterator();
	}

	public int lastIndexOf(Object o) {
		getterCalled();
		return delegate.lastIndexOf(o);
	}

	public ListIterator listIterator() {
		getterCalled();
		return delegate.listIterator();
	}

	public ListIterator listIterator(int index) {
		getterCalled();
		return delegate.listIterator(index);
	}

	public Object move(int oldIndex, int newIndex) {
		return delegate.move(oldIndex, newIndex);
	}

	public Object remove(int index) {
		return delegate.remove(index);
	}

	public boolean remove(Object o) {
		return delegate.remove(o);
	}

	public boolean removeAll(Collection c) {
		return delegate.removeAll(c);
	}

	public boolean retainAll(Collection c) {
		return delegate.retainAll(c);
	}

	public Object set(int index, Object element) {
		return delegate.set(index, element);
	}

	protected int doGetSize() {
		return delegate.size();
	}

	public List subList(int fromIndex, int toIndex) {
		getterCalled();
		return delegate.subList(fromIndex, toIndex);
	}

	public Object[] toArray() {
		getterCalled();
		return delegate.toArray();
	}

	public Object[] toArray(Object[] a) {
		return delegate.toArray(a);
	}

	protected void firstListenerAdded() {
		delegateStaleListener = new IStaleListener() {
			public void handleStale(StaleEvent staleEvent) {
				fireStale();
			}
		};
		delegate.addStaleListener(delegateStaleListener);

		delegateListChangeListener = new IListChangeListener() {
			public void handleListChange(ListChangeEvent event) {
				fireListChange(event.diff);
			}
		};
		delegate.addListChangeListener(delegateListChangeListener);
	}

	protected void lastListenerRemoved() {
		delegate.removeStaleListener(delegateStaleListener);
		delegateStaleListener = null;

		delegate.removeListChangeListener(delegateListChangeListener);
		delegateListChangeListener = null;
	}

	private void getterCalled() {
		ObservableTracker.getterCalled(this);
	}

	/**
	 * @return list being delegated to
	 */
	public IObservableList getDelegate() {
		return delegate;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.core.databinding.beans.IBeanObservable#getObserved()
	 */
	public Object getObserved() {
		return observed;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.core.databinding.beans.IBeanObservable#getPropertyDescriptor()
	 */
	public PropertyDescriptor getPropertyDescriptor() {
		return propertyDescriptor;
	}
}