/*******************************************************************************
* Copyright (c) 2006, 2015 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
* Matthew Hall - bug 208332, 194734
* Stefan Xenos <sxenos@gmail.com> - Bug 335792
* Stefan Xenos <sxenos@gmail.com> - Bug 474065
*******************************************************************************/
package org.eclipse.core.databinding.observable.set;
import java.util.Collection;
import java.util.Iterator;
import java.util.Set;
import org.eclipse.core.databinding.observable.AbstractObservable;
import org.eclipse.core.databinding.observable.ObservableTracker;
import org.eclipse.core.databinding.observable.Realm;
/**
*
* Abstract implementation of {@link IObservableSet}.
*
* <p>
* This class is thread safe. All state accessing methods must be invoked from
* the {@link Realm#isCurrent() current realm}. Methods for adding and removing
* listeners may be invoked from any thread.
* </p>
*
* @param <E>
* the type of the elements in this set
*
* @since 1.0
*/
public abstract class AbstractObservableSet<E> extends AbstractObservable
implements IObservableSet<E> {
private boolean stale = false;
protected AbstractObservableSet() {
this(Realm.getDefault());
}
@Override
protected void firstListenerAdded() {
super.firstListenerAdded();
}
@Override
protected void lastListenerRemoved() {
super.lastListenerRemoved();
}
protected AbstractObservableSet(Realm realm) {
super(realm);
}
@Override
public synchronized void addSetChangeListener(
ISetChangeListener<? super E> listener) {
addListener(SetChangeEvent.TYPE, listener);
}
@Override
public synchronized void removeSetChangeListener(
ISetChangeListener<? super E> listener) {
removeListener(SetChangeEvent.TYPE, listener);
}
protected abstract Set<E> getWrappedSet();
protected void fireSetChange(SetDiff<E> diff) {
// fire general change event first
super.fireChange();
fireEvent(new SetChangeEvent<>(this, diff));
}
@Override
public boolean contains(Object o) {
getterCalled();
return getWrappedSet().contains(o);
}
@Override
public boolean containsAll(Collection<?> c) {
getterCalled();
return getWrappedSet().containsAll(c);
}
@Override
public boolean equals(Object o) {
getterCalled();
return getWrappedSet().equals(o);
}
@Override
public int hashCode() {
getterCalled();
return getWrappedSet().hashCode();
}
@Override
public boolean isEmpty() {
getterCalled();
return getWrappedSet().isEmpty();
}
@Override
public Iterator<E> iterator() {
getterCalled();
final Iterator<E> wrappedIterator = getWrappedSet().iterator();
return new Iterator<E>() {
@Override
public void remove() {
throw new UnsupportedOperationException();
}
@Override
public boolean hasNext() {
ObservableTracker.getterCalled(AbstractObservableSet.this);
return wrappedIterator.hasNext();
}
@Override
public E next() {
ObservableTracker.getterCalled(AbstractObservableSet.this);
return wrappedIterator.next();
}
};
}
@Override
public int size() {
getterCalled();
return getWrappedSet().size();
}
@Override
public Object[] toArray() {
getterCalled();
return getWrappedSet().toArray();
}
@Override
public <T> T[] toArray(T[] a) {
getterCalled();
return getWrappedSet().toArray(a);
}
@Override
public String toString() {
getterCalled();
return getWrappedSet().toString();
}
protected void getterCalled() {
ObservableTracker.getterCalled(this);
}
@Override
public boolean add(E o) {
throw new UnsupportedOperationException();
}
@Override
public boolean addAll(Collection<? extends E> c) {
throw new UnsupportedOperationException();
}
@Override
public boolean remove(Object o) {
throw new UnsupportedOperationException();
}
@Override
public boolean removeAll(Collection<?> c) {
throw new UnsupportedOperationException();
}
@Override
public boolean retainAll(Collection<?> c) {
throw new UnsupportedOperationException();
}
@Override
public void clear() {
throw new UnsupportedOperationException();
}
/**
* @return Returns the stale state.
*/
@Override
public boolean isStale() {
getterCalled();
return stale;
}
/**
* @param stale
* The stale state to set. This will fire a stale event if the
* given boolean is true and this observable set was not already
* stale.
*/
public void setStale(boolean stale) {
checkRealm();
boolean wasStale = this.stale;
this.stale = stale;
if (!wasStale && stale) {
fireStale();
}
}
@Override
protected void fireChange() {
throw new RuntimeException(
"fireChange should not be called, use fireSetChange() instead"); //$NON-NLS-1$
}
}