| /******************************************************************************* |
| * 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 221351) |
| * Brad Reynolds - through JavaBeanObservableArrayBasedListTest.java |
| * Matthew Hall - bug 213145, 244098, 246103, 194734, 268688, 301774 |
| ******************************************************************************/ |
| |
| package org.eclipse.core.tests.internal.databinding.beans; |
| |
| import java.beans.PropertyChangeEvent; |
| import java.beans.PropertyChangeListener; |
| import java.beans.PropertyDescriptor; |
| import java.util.Arrays; |
| import java.util.Collection; |
| import java.util.Collections; |
| import java.util.HashSet; |
| import java.util.Set; |
| |
| import junit.framework.Test; |
| import junit.framework.TestSuite; |
| |
| import org.eclipse.core.databinding.beans.BeanProperties; |
| import org.eclipse.core.databinding.beans.BeansObservables; |
| import org.eclipse.core.databinding.beans.IBeanObservable; |
| import org.eclipse.core.databinding.beans.IBeanProperty; |
| import org.eclipse.core.databinding.observable.DecoratingObservableCollection; |
| import org.eclipse.core.databinding.observable.IObservable; |
| import org.eclipse.core.databinding.observable.IObservableCollection; |
| import org.eclipse.core.databinding.observable.Realm; |
| import org.eclipse.core.databinding.observable.set.IObservableSet; |
| import org.eclipse.core.databinding.observable.set.SetChangeEvent; |
| import org.eclipse.core.databinding.observable.set.SetDiff; |
| import org.eclipse.jface.databinding.conformance.MutableObservableSetContractTest; |
| import org.eclipse.jface.databinding.conformance.delegate.AbstractObservableCollectionContractDelegate; |
| import org.eclipse.jface.databinding.conformance.util.CurrentRealm; |
| import org.eclipse.jface.databinding.conformance.util.SetChangeEventTracker; |
| import org.eclipse.jface.databinding.swt.SWTObservables; |
| import org.eclipse.jface.tests.databinding.AbstractDefaultRealmTestCase; |
| import org.eclipse.swt.widgets.Display; |
| |
| /** |
| * @since 1.1 |
| */ |
| public class JavaBeanObservableArrayBasedSetTest extends |
| AbstractDefaultRealmTestCase { |
| private IObservableSet set; |
| private IBeanObservable beanObservable; |
| |
| private PropertyDescriptor propertyDescriptor; |
| |
| private Bean bean; |
| |
| private String propertyName; |
| |
| protected void setUp() throws Exception { |
| super.setUp(); |
| |
| propertyName = "array"; |
| propertyDescriptor = ((IBeanProperty) BeanProperties.set(Bean.class, |
| propertyName)).getPropertyDescriptor(); |
| bean = new Bean(new HashSet()); |
| |
| set = BeansObservables.observeSet( |
| SWTObservables.getRealm(Display.getDefault()), bean, |
| propertyName); |
| beanObservable = (IBeanObservable) set; |
| } |
| |
| public void testGetObserved() throws Exception { |
| assertEquals(bean, beanObservable.getObserved()); |
| } |
| |
| public void testGetPropertyDescriptor() throws Exception { |
| assertEquals(propertyDescriptor, beanObservable.getPropertyDescriptor()); |
| } |
| |
| public void testRegistersListenerAfterFirstListenerIsAdded() |
| throws Exception { |
| assertFalse(bean.changeSupport.hasListeners(propertyName)); |
| SetChangeEventTracker.observe(set); |
| assertTrue(bean.changeSupport.hasListeners(propertyName)); |
| } |
| |
| public void testRemovesListenerAfterLastListenerIsRemoved() |
| throws Exception { |
| SetChangeEventTracker listener = SetChangeEventTracker.observe(set); |
| |
| assertTrue(bean.changeSupport.hasListeners(propertyName)); |
| set.removeSetChangeListener(listener); |
| assertFalse(bean.changeSupport.hasListeners(propertyName)); |
| } |
| |
| public void testSetBeanProperty_FiresSetChangeEvents() throws Exception { |
| SetChangeEventTracker listener = SetChangeEventTracker.observe(set); |
| |
| assertEquals(0, listener.count); |
| bean.setArray(new String[] { "element" }); |
| assertEquals(1, listener.count); |
| } |
| |
| public void testAdd_AddsElement() throws Exception { |
| assertEquals(0, set.size()); |
| |
| String element = "1"; |
| set.add(element); |
| |
| assertEquals(1, set.size()); |
| assertEquals(element, bean.getArray()[0]); |
| } |
| |
| public void testAdd_SetChangeEvent() throws Exception { |
| SetChangeEventTracker listener = SetChangeEventTracker.observe(set); |
| assertEquals(0, listener.count); |
| |
| String element = "1"; |
| set.add(element); |
| |
| assertEquals(1, listener.count); |
| SetChangeEvent event = listener.event; |
| |
| assertSame(set, event.getObservableSet()); |
| assertEquals(Collections.singleton(element), event.diff.getAdditions()); |
| assertEquals(Collections.EMPTY_SET, event.diff.getRemovals()); |
| } |
| |
| public void testAdd_FiresPropertyChangeEvent() throws Exception { |
| assertPropertyChangeEvent(bean, new Runnable() { |
| public void run() { |
| set.add("0"); |
| } |
| }); |
| } |
| |
| public void testRemove() throws Exception { |
| String element = "1"; |
| set.add(element); |
| |
| assertEquals(1, bean.getArray().length); |
| set.remove(element); |
| assertEquals(0, bean.getArray().length); |
| } |
| |
| public void testRemove_SetChangeEvent() throws Exception { |
| String element = "1"; |
| set.add(element); |
| assertEquals(1, set.size()); |
| |
| SetChangeEventTracker listener = SetChangeEventTracker.observe(set); |
| assertEquals(0, listener.count); |
| |
| set.remove(element); |
| |
| assertEquals(1, listener.count); |
| SetChangeEvent event = listener.event; |
| assertEquals(set, event.getObservableSet()); |
| assertEquals(Collections.singleton(element), event.diff.getRemovals()); |
| assertEquals(Collections.EMPTY_SET, event.diff.getAdditions()); |
| } |
| |
| public void testRemovePropertyChangeEvent() throws Exception { |
| set.add("0"); |
| |
| assertPropertyChangeEvent(bean, new Runnable() { |
| public void run() { |
| set.remove("0"); |
| } |
| }); |
| } |
| |
| public void testAddAll() throws Exception { |
| Collection elements = Arrays.asList(new String[] { "1", "2" }); |
| assertEquals(0, set.size()); |
| |
| set.addAll(elements); |
| |
| assertEquals(2, bean.getArray().length); |
| } |
| |
| public void testAddAll_SetChangeEvent() throws Exception { |
| Collection elements = Arrays.asList(new String[] { "1", "2" }); |
| assertEquals(0, set.size()); |
| |
| SetChangeEventTracker listener = SetChangeEventTracker.observe(set); |
| assertEquals(0, listener.count); |
| |
| set.addAll(elements); |
| |
| assertEquals(1, listener.count); |
| SetChangeEvent event = listener.event; |
| assertEquals(set, event.getObservableSet()); |
| |
| assertEquals(new HashSet(elements), event.diff.getAdditions()); |
| assertEquals(Collections.EMPTY_SET, event.diff.getRemovals()); |
| } |
| |
| public void testAddAllPropertyChangeEvent() throws Exception { |
| assertPropertyChangeEvent(bean, new Runnable() { |
| public void run() { |
| set.addAll(Arrays.asList(new String[] { "0", "1" })); |
| } |
| }); |
| } |
| |
| public void testRemoveAll() throws Exception { |
| Collection elements = Arrays.asList(new String[] { "1", "2" }); |
| set.addAll(elements); |
| |
| assertEquals(2, bean.getArray().length); |
| set.removeAll(elements); |
| |
| assertEquals(0, bean.getArray().length); |
| } |
| |
| public void testRemoveAll_SetChangeEvent() throws Exception { |
| Collection elements = Arrays.asList(new String[] { "1", "2" }); |
| set.addAll(elements); |
| |
| SetChangeEventTracker listener = SetChangeEventTracker.observe(set); |
| assertEquals(0, listener.count); |
| |
| set.removeAll(elements); |
| |
| SetChangeEvent event = listener.event; |
| assertEquals(set, event.getObservableSet()); |
| assertEquals(Collections.EMPTY_SET, event.diff.getAdditions()); |
| assertEquals(new HashSet(elements), event.diff.getRemovals()); |
| } |
| |
| public void testRemoveAllPropertyChangeEvent() throws Exception { |
| set.add("0"); |
| assertPropertyChangeEvent(bean, new Runnable() { |
| public void run() { |
| set.removeAll(Arrays.asList(new String[] { "0" })); |
| } |
| }); |
| } |
| |
| public void testRetainAll() throws Exception { |
| set.addAll(Arrays.asList(new String[] { "0", "1", "2", "3" })); |
| |
| assertEquals(4, bean.getArray().length); |
| |
| set.retainAll(Arrays.asList(new String[] { "0", "1" })); |
| assertEquals(2, bean.getArray().length); |
| |
| assertTrue(set.containsAll(Arrays.asList(new String[] { "1", "0" }))); |
| } |
| |
| public void testRetainAll_SetChangeEvent() throws Exception { |
| set.addAll(Arrays.asList(new String[] { "0", "1", "2", "3" })); |
| |
| SetChangeEventTracker listener = SetChangeEventTracker.observe(set); |
| |
| assertEquals(0, listener.count); |
| set.retainAll(Arrays.asList(new String[] { "0", "1" })); |
| |
| assertEquals(1, listener.count); |
| SetChangeEvent event = listener.event; |
| assertEquals(set, event.getObservableSet()); |
| assertEquals(Collections.EMPTY_SET, event.diff.getAdditions()); |
| assertEquals(new HashSet(Arrays.asList(new String[] { "2", "3" })), |
| event.diff.getRemovals()); |
| } |
| |
| public void testRetainAllPropertyChangeEvent() throws Exception { |
| set.addAll(Arrays.asList(new String[] { "0", "1" })); |
| |
| assertPropertyChangeEvent(bean, new Runnable() { |
| public void run() { |
| set.retainAll(Arrays.asList(new String[] { "0" })); |
| } |
| }); |
| } |
| |
| public void testSetChangeEventFiresWhenNewSetIsSet() throws Exception { |
| Bean[] elements = new Bean[] { new Bean(), new Bean() }; |
| |
| SetChangeEventTracker listener = SetChangeEventTracker.observe(set); |
| |
| assertEquals(0, listener.count); |
| bean.setArray(elements); |
| assertEquals(1, listener.count); |
| } |
| |
| public void testSetBeanProperty_CorrectForNullOldAndNewValues() { |
| // The java bean spec allows the old and new values in a |
| // PropertyChangeEvent to be null, which indicates that an unknown |
| // change occured. |
| |
| // This test ensures that JavaBeanObservableValue fires the correct |
| // value diff even if the bean implementor is lazy :-P |
| |
| Bean bean = new AnnoyingBean(); |
| bean.setArray(new Object[] { "old" }); |
| IObservableSet observable = BeansObservables.observeSet( |
| new CurrentRealm(true), bean, "array"); |
| SetChangeEventTracker tracker = SetChangeEventTracker |
| .observe(observable); |
| bean.setArray(new Object[] { "new" }); |
| assertEquals(1, tracker.count); |
| assertEquals(Collections.singleton("old"), |
| tracker.event.diff.getRemovals()); |
| assertEquals(Collections.singleton("new"), |
| tracker.event.diff.getAdditions()); |
| } |
| |
| public void testModifyObservableSet_FiresSetChange() { |
| Bean bean = new Bean(new Object[] {}); |
| IObservableSet observable = BeansObservables.observeSet(bean, "array"); |
| SetChangeEventTracker tracker = SetChangeEventTracker |
| .observe(observable); |
| |
| observable.add("new"); |
| |
| assertEquals(1, tracker.count); |
| assertDiff(tracker.event.diff, Collections.EMPTY_SET, |
| Collections.singleton("new")); |
| } |
| |
| public void testSetBeanPropertyOutsideRealm_FiresEventInsideRealm() { |
| Bean bean = new Bean(new Object[0]); |
| CurrentRealm realm = new CurrentRealm(true); |
| IObservableSet observable = BeansObservables.observeSet(realm, bean, |
| "array"); |
| SetChangeEventTracker tracker = SetChangeEventTracker |
| .observe(observable); |
| |
| realm.setCurrent(false); |
| bean.setArray(new Object[] { "element" }); |
| assertEquals(0, tracker.count); |
| |
| realm.setCurrent(true); |
| assertEquals(1, tracker.count); |
| assertDiff(tracker.event.diff, Collections.EMPTY_SET, |
| Collections.singleton("element")); |
| } |
| |
| private static void assertDiff(SetDiff diff, Set oldSet, Set newSet) { |
| oldSet = new HashSet(oldSet); // defensive copy in case arg is |
| // unmodifiable |
| diff.applyTo(oldSet); |
| assertEquals("applying diff to list did not produce expected result", |
| newSet, oldSet); |
| } |
| |
| private static void assertPropertyChangeEvent(Bean bean, Runnable runnable) { |
| PropertyChangeTracker listener = new PropertyChangeTracker(); |
| bean.addPropertyChangeListener(listener); |
| |
| Object[] old = bean.getArray(); |
| assertEquals(0, listener.count); |
| |
| runnable.run(); |
| |
| PropertyChangeEvent event = listener.evt; |
| assertEquals("event did not fire", 1, listener.count); |
| assertEquals("array", event.getPropertyName()); |
| assertTrue("old value", |
| Arrays.equals(old, (Object[]) event.getOldValue())); |
| assertTrue("new value", |
| Arrays.equals(bean.getArray(), (Object[]) event.getNewValue())); |
| assertFalse("sets are equal", Arrays.equals(bean.getArray(), old)); |
| } |
| |
| private static class PropertyChangeTracker implements |
| PropertyChangeListener { |
| int count; |
| |
| PropertyChangeEvent evt; |
| |
| public void propertyChange(PropertyChangeEvent evt) { |
| count++; |
| this.evt = evt; |
| } |
| } |
| |
| public static Test suite() { |
| TestSuite suite = new TestSuite( |
| JavaBeanObservableArrayBasedSetTest.class.getName()); |
| suite.addTestSuite(JavaBeanObservableArrayBasedSetTest.class); |
| suite.addTest(MutableObservableSetContractTest.suite(new Delegate())); |
| return suite; |
| } |
| |
| static class Delegate extends AbstractObservableCollectionContractDelegate { |
| public IObservableCollection createObservableCollection(Realm realm, |
| int elementCount) { |
| String propertyName = "array"; |
| Object bean = new Bean(new Object[0]); |
| |
| IObservableSet set = BeansObservables.observeSet(realm, bean, |
| propertyName, String.class); |
| for (int i = 0; i < elementCount; i++) |
| set.add(createElement(set)); |
| return set; |
| } |
| |
| public Object createElement(IObservableCollection collection) { |
| Class elementType = getElementType(collection); |
| try { |
| return elementType.getConstructor().newInstance(); |
| } catch (Exception e) { |
| return new Object(); |
| } |
| } |
| |
| public Class getElementType(IObservableCollection collection) { |
| if (collection instanceof DecoratingObservableCollection) { |
| DecoratingObservableCollection x = (DecoratingObservableCollection) collection; |
| if (x.getElementClass() != null) { |
| return x.getElementClass(); |
| } |
| } |
| |
| return String.class; |
| } |
| |
| public void change(IObservable observable) { |
| IObservableSet set = (IObservableSet) observable; |
| set.add(createElement(set)); |
| } |
| } |
| } |