| /******************************************************************************* |
| * Copyright (c) 2007-2008 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 - bugs 221351, 213145, 244098, 240931 |
| ******************************************************************************/ |
| |
| package org.eclipse.core.tests.internal.databinding.beans; |
| |
| import java.beans.IntrospectionException; |
| import java.beans.PropertyChangeEvent; |
| import java.beans.PropertyChangeListener; |
| import java.beans.PropertyDescriptor; |
| import java.util.ArrayList; |
| import java.util.Arrays; |
| import java.util.Collection; |
| import java.util.List; |
| |
| import junit.framework.Test; |
| import junit.framework.TestSuite; |
| |
| 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.list.IListChangeListener; |
| import org.eclipse.core.databinding.observable.list.IObservableList; |
| import org.eclipse.core.databinding.observable.list.ListChangeEvent; |
| import org.eclipse.core.databinding.observable.list.ListDiffEntry; |
| import org.eclipse.core.internal.databinding.beans.JavaBeanObservableList; |
| import org.eclipse.jface.databinding.conformance.MutableObservableListContractTest; |
| import org.eclipse.jface.databinding.conformance.delegate.AbstractObservableCollectionContractDelegate; |
| import org.eclipse.jface.databinding.conformance.util.ChangeEventTracker; |
| import org.eclipse.jface.databinding.conformance.util.ListChangeEventTracker; |
| 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 JavaBeanObservableListTest extends AbstractDefaultRealmTestCase { |
| private JavaBeanObservableList list; |
| |
| private PropertyDescriptor propertyDescriptor; |
| |
| private Bean bean; |
| |
| private String propertyName; |
| |
| /* |
| * (non-Javadoc) |
| * |
| * @see junit.framework.TestCase#setUp() |
| */ |
| protected void setUp() throws Exception { |
| super.setUp(); |
| |
| propertyName = "list"; |
| propertyDescriptor = new PropertyDescriptor(propertyName, Bean.class); |
| bean = new Bean(new ArrayList()); |
| |
| list = new JavaBeanObservableList(SWTObservables.getRealm(Display |
| .getDefault()), bean, propertyDescriptor, String.class); |
| } |
| |
| public void testGetObserved() throws Exception { |
| assertEquals(bean, list.getObserved()); |
| } |
| |
| public void testGetPropertyDescriptor() throws Exception { |
| assertEquals(propertyDescriptor, list.getPropertyDescriptor()); |
| } |
| |
| public void testRegistersListenerOnCreation() throws Exception { |
| assertTrue(bean.changeSupport.hasListeners(propertyName)); |
| } |
| |
| public void testRemovesListenerOnDisposal() throws Exception { |
| list.dispose(); |
| assertFalse(bean.changeSupport.hasListeners(propertyName)); |
| } |
| |
| public void testFiresListChangeEvents() throws Exception { |
| ListChangeEventTracker listener = new ListChangeEventTracker(); |
| list.addListChangeListener(listener); |
| |
| assertEquals(0, listener.count); |
| bean.setList(Arrays.asList(new String[] { "value" })); |
| assertEquals(1, listener.count); |
| } |
| |
| public void testAddAddsElement() throws Exception { |
| int count = list.size(); |
| String element = "1"; |
| |
| assertEquals(0, count); |
| list.add(element); |
| assertEquals(count + 1, list.size()); |
| assertEquals(element, bean.getList().get(count)); |
| } |
| |
| public void testAddListChangeEvent() throws Exception { |
| ListChangeEventTracker listener = new ListChangeEventTracker(); |
| list.addListChangeListener(listener); |
| |
| assertEquals(0, listener.count); |
| String element = "1"; |
| |
| list.add(element); |
| |
| assertEquals(1, listener.count); |
| ListChangeEvent event = listener.event; |
| |
| assertEquals(list, event.getObservableList()); |
| assertEntry(event.diff.getDifferences()[0], true, 0, element); |
| } |
| |
| public void testAddFiresPropertyChangeEvent() throws Exception { |
| assertPropertyChangeEvent(bean, new Runnable() { |
| public void run() { |
| list.add("0"); |
| } |
| }); |
| } |
| |
| public void testAddAtIndex() throws Exception { |
| String element = "1"; |
| assertEquals(0, list.size()); |
| |
| list.add(0, element); |
| assertEquals(element, bean.getList().get(0)); |
| } |
| |
| public void testAddAtIndexListChangeEvent() throws Exception { |
| String element = "1"; |
| assertEquals(0, list.size()); |
| |
| ListChangeEventTracker listener = new ListChangeEventTracker(); |
| list.addListChangeListener(listener); |
| |
| list.add(0, element); |
| |
| ListChangeEvent event = listener.event; |
| assertEntry(event.diff.getDifferences()[0], true, 0, element); |
| } |
| |
| public void testAddAtIndexPropertyChangeEvent() throws Exception { |
| assertPropertyChangeEvent(bean, new Runnable() { |
| public void run() { |
| list.add(0, "0"); |
| } |
| }); |
| } |
| |
| public void testClear() throws Exception { |
| String element = "1"; |
| list.add(element); |
| |
| assertEquals(1, bean.getList().size()); |
| assertPropertyChangeEvent(bean, new Runnable(){ |
| public void run() { |
| list.clear(); |
| } |
| }); |
| assertEquals(0, bean.getList().size()); |
| } |
| |
| public void testRemove() throws Exception { |
| String element = "1"; |
| list.add(element); |
| |
| assertEquals(1, bean.getList().size()); |
| list.remove(element); |
| assertEquals(0, bean.getList().size()); |
| } |
| |
| public void testRemoveListChangeEvent() throws Exception { |
| String element = "1"; |
| list.add(element); |
| |
| assertEquals(1, list.size()); |
| ListChangeEventTracker listener = new ListChangeEventTracker(); |
| list.addListChangeListener(listener); |
| |
| list.remove(element); |
| |
| assertEquals(1, listener.count); |
| ListChangeEvent event = listener.event; |
| assertEquals(list, event.getObservableList()); |
| assertEntry(event.diff.getDifferences()[0], false, 0, element); |
| } |
| |
| public void testRemovePropertyChangeEvent() throws Exception { |
| list.add("0"); |
| |
| assertPropertyChangeEvent(bean, new Runnable() { |
| public void run() { |
| list.remove("0"); |
| } |
| }); |
| } |
| |
| public void testRemoveAtIndex() throws Exception { |
| String element = "1"; |
| list.add(element); |
| |
| assertEquals(element, bean.getList().get(0)); |
| |
| list.remove(0); |
| assertEquals(0, bean.getList().size()); |
| } |
| |
| public void testRemoveAtIndexListChangeEvent() throws Exception { |
| String element = "1"; |
| list.add(element); |
| |
| assertEquals(1, list.size()); |
| ListChangeEventTracker listener = new ListChangeEventTracker(); |
| list.addListChangeListener(listener); |
| |
| list.remove(0); |
| |
| assertEquals(1, listener.count); |
| ListChangeEvent event = listener.event; |
| assertEquals(list, event.getObservableList()); |
| assertEntry(event.diff.getDifferences()[0], false, 0, element); |
| } |
| |
| public void testRemoveAtIndexPropertyChangeEvent() throws Exception { |
| list.add("0"); |
| assertPropertyChangeEvent(bean, new Runnable() { |
| public void run() { |
| list.remove(0); |
| } |
| }); |
| } |
| |
| public void testAddAll() throws Exception { |
| Collection elements = Arrays.asList(new String[] { "1", "2" }); |
| assertEquals(0, list.size()); |
| |
| list.addAll(elements); |
| |
| assertEquals(2, bean.getList().size()); |
| } |
| |
| public void testAddAllListChangEvent() throws Exception { |
| List elements = Arrays.asList(new String[] { "1", "2" }); |
| assertEquals(0, list.size()); |
| |
| ListChangeEventTracker listener = new ListChangeEventTracker(); |
| list.addListChangeListener(listener); |
| assertEquals(0, listener.count); |
| |
| list.addAll(elements); |
| |
| assertEquals(1, listener.count); |
| ListChangeEvent event = listener.event; |
| assertEquals(list, event.getObservableList()); |
| |
| assertEntry(event.diff.getDifferences()[0], true, 0, elements.get(0)); |
| assertEntry(event.diff.getDifferences()[1], true, 1, elements.get(1)); |
| } |
| |
| public void testAddAllPropertyChangeEvent() throws Exception { |
| assertPropertyChangeEvent(bean, new Runnable() { |
| public void run() { |
| list.addAll(Arrays.asList(new String[] {"0", "1"})); |
| } |
| }); |
| } |
| |
| public void testAddAllAtIndex() throws Exception { |
| List elements = Arrays.asList(new String[] { "1", "2" }); |
| list.addAll(elements); |
| |
| assertEquals(2, list.size()); |
| |
| list.addAll(2, elements); |
| |
| assertEquals(4, bean.getList().size()); |
| assertEquals(elements.get(0), bean.getList().get(0)); |
| assertEquals(elements.get(1), bean.getList().get(1)); |
| } |
| |
| public void testAddAllAtIndexListChangeEvent() throws Exception { |
| List elements = Arrays.asList(new String[] { "1", "2" }); |
| list.addAll(elements); |
| |
| ListChangeEventTracker listener = new ListChangeEventTracker(); |
| list.addListChangeListener(listener); |
| |
| assertEquals(0, listener.count); |
| |
| list.addAll(2, elements); |
| |
| assertEquals(1, listener.count); |
| ListChangeEvent event = listener.event; |
| assertEquals(list, event.getObservableList()); |
| assertEntry(event.diff.getDifferences()[0], true, 2, elements.get(0)); |
| assertEntry(event.diff.getDifferences()[1], true, 3, elements.get(1)); |
| } |
| |
| public void testAddAllAtIndexPropertyChangeEvent() throws Exception { |
| assertPropertyChangeEvent(bean, new Runnable() { |
| public void run() { |
| list.addAll(0, Arrays.asList(new String[] {"1", "2"})); |
| } |
| }); |
| } |
| |
| public void testRemoveAll() throws Exception { |
| List elements = Arrays.asList(new String[] { "1", "2" }); |
| list.addAll(elements); |
| list.addAll(elements); |
| |
| assertEquals(4, bean.getList().size()); |
| list.removeAll(elements); |
| |
| assertEquals(2, bean.getList().size()); |
| assertEquals(elements.get(0), bean.getList().get(0)); |
| assertEquals(elements.get(1), bean.getList().get(1)); |
| } |
| |
| public void testRemoveAllListChangeEvent() throws Exception { |
| List elements = Arrays.asList(new String[] { "1", "2" }); |
| list.addAll(elements); |
| list.addAll(elements); |
| |
| ListChangeEventTracker listener = new ListChangeEventTracker(); |
| list.addListChangeListener(listener); |
| |
| assertEquals(0, listener.count); |
| list.removeAll(elements); |
| |
| ListChangeEvent event = listener.event; |
| assertEquals(list, event.getObservableList()); |
| assertEntry(event.diff.getDifferences()[0], false, 0, elements.get(0)); |
| assertEntry(event.diff.getDifferences()[1], false, 0, elements.get(1)); |
| } |
| |
| public void testRemoveAllPropertyChangeEvent() throws Exception { |
| list.add("0"); |
| assertPropertyChangeEvent(bean, new Runnable() { |
| public void run() { |
| list.removeAll(Arrays.asList(new String[] {"0"})); |
| } |
| }); |
| } |
| |
| public void testRetailAll() throws Exception { |
| List elements = Arrays.asList(new String[] { "0", "1", "2", "3" }); |
| list.addAll(elements); |
| |
| assertEquals(4, bean.getList().size()); |
| |
| list.retainAll(elements.subList(0, 2)); |
| assertEquals(2, bean.getList().size()); |
| |
| assertEquals(elements.get(0), bean.getList().get(0)); |
| assertEquals(elements.get(1), bean.getList().get(1)); |
| } |
| |
| public void testRetainAllListChangeEvent() throws Exception { |
| List elements = Arrays.asList(new String[] { "0", "1", "2", "3" }); |
| list.addAll(elements); |
| |
| ListChangeEventTracker listener = new ListChangeEventTracker(); |
| list.addListChangeListener(listener); |
| |
| assertEquals(0, listener.count); |
| list.retainAll(elements.subList(0, 2)); |
| |
| assertEquals(1, listener.count); |
| ListChangeEvent event = listener.event; |
| assertEquals(list, event.getObservableList()); |
| assertEntry(event.diff.getDifferences()[0], false, 2, elements.get(2)); |
| assertEntry(event.diff.getDifferences()[1], false, 2, elements.get(3)); |
| } |
| |
| public void testRetainAllPropertyChangeEvent() throws Exception { |
| list.addAll(Arrays.asList(new String[] {"0", "1"})); |
| |
| assertPropertyChangeEvent(bean, new Runnable() { |
| public void run() { |
| list.retainAll(Arrays.asList(new String[] {"0"})); |
| } |
| }); |
| } |
| |
| public void testSet() throws Exception { |
| String oldElement = "old"; |
| String newElement = "new"; |
| list.add(oldElement); |
| |
| assertEquals(oldElement, bean.getList().get(0)); |
| |
| list.set(0, newElement); |
| assertEquals(newElement, bean.getList().get(0)); |
| } |
| |
| public void testMove() throws Exception { |
| String element0 = "element0"; |
| String element1 = "element1"; |
| list.add(element0); |
| list.add(element1); |
| |
| assertEquals(2, bean.getList().size()); |
| assertEquals(element0, bean.getList().get(0)); |
| assertEquals(element1, bean.getList().get(1)); |
| |
| list.move(0, 1); |
| |
| assertEquals(2, bean.getList().size()); |
| assertEquals(element1, bean.getList().get(0)); |
| assertEquals(element0, bean.getList().get(1)); |
| } |
| |
| public void testSetListChangeEvent() throws Exception { |
| String oldElement = "old"; |
| String newElement = "new"; |
| list.add(oldElement); |
| |
| ListChangeEventTracker listener = ListChangeEventTracker.observe(list); |
| assertEquals(0, listener.count); |
| |
| list.set(0, newElement); |
| |
| assertEquals(1, listener.count); |
| ListChangeEvent event = listener.event; |
| assertEquals(list, event.getObservableList()); |
| assertEntry(event.diff.getDifferences()[0], false, 0, oldElement); |
| assertEntry(event.diff.getDifferences()[1], true, 0, newElement); |
| } |
| |
| public void testSetPropertyChangeEvent() throws Exception { |
| list.add("0"); |
| assertPropertyChangeEvent(bean, new Runnable() { |
| public void run() { |
| list.set(0, "1"); |
| } |
| }); |
| } |
| |
| public void testListChangeEventFiresWhenNewListIsSet() throws Exception { |
| List elements = Arrays.asList(new String[] { "1", "2" }); |
| |
| ListChangeEventTracker listener = new ListChangeEventTracker(); |
| list.addListChangeListener(listener); |
| |
| assertEquals(0, listener.count); |
| bean.setList(elements); |
| assertEquals(1, listener.count); |
| } |
| |
| public void testConstructor_RegistersListener() throws Exception { |
| Bean bean = new Bean(); |
| new JavaBeanObservableList(Realm.getDefault(), bean, |
| new PropertyDescriptor("list", Bean.class), Bean.class); |
| |
| assertTrue(bean.hasListeners("list")); |
| } |
| |
| public void testConstructor_SkipsRegisterListener() throws Exception { |
| Bean bean = new Bean(); |
| JavaBeanObservableList observable = new JavaBeanObservableList(Realm |
| .getDefault(), bean, |
| new PropertyDescriptor("list", Bean.class), Bean.class, false); |
| |
| assertFalse(bean.hasListeners("list")); |
| ChangeEventTracker.observe(observable); |
| assertFalse(bean.hasListeners("list")); |
| } |
| |
| public void testFirstListenerAdded_AfterLastListenerRemoved() throws Exception { |
| IListChangeListener listener = new IListChangeListener() { |
| public void handleListChange(ListChangeEvent event) { |
| // noop |
| } |
| }; |
| list.addListChangeListener(listener); |
| list.removeListChangeListener(listener); |
| list.addListChangeListener(listener); |
| } |
| |
| public void testDispose_DoubleInvocation() throws Exception { |
| list.dispose(); |
| list.dispose(); |
| } |
| |
| private static void assertEntry(ListDiffEntry entry, boolean addition, |
| int position, Object element) { |
| assertEquals("addition", addition, entry.isAddition()); |
| assertEquals("position", position, entry.getPosition()); |
| assertEquals("element", element, entry.getElement()); |
| } |
| |
| private static void assertPropertyChangeEvent(Bean bean, Runnable runnable) { |
| PropertyChangeTracker listener = new PropertyChangeTracker(); |
| bean.addPropertyChangeListener(listener); |
| |
| List old = bean.getList(); |
| assertEquals(0, listener.count); |
| |
| runnable.run(); |
| |
| PropertyChangeEvent event = listener.evt; |
| assertEquals("event did not fire", 1, listener.count); |
| assertEquals("list", event.getPropertyName()); |
| assertEquals("old value", old, event.getOldValue()); |
| assertEquals("new value", bean.getList(), event.getNewValue()); |
| assertFalse("lists are equal", bean.getList().equals(old)); |
| } |
| |
| private static class PropertyChangeTracker implements |
| PropertyChangeListener { |
| int count; |
| |
| PropertyChangeEvent evt; |
| |
| /* |
| * (non-Javadoc) |
| * |
| * @see java.beans.PropertyChangeListener#propertyChange(java.beans.PropertyChangeEvent) |
| */ |
| public void propertyChange(PropertyChangeEvent evt) { |
| count++; |
| this.evt = evt; |
| } |
| } |
| |
| public static Test suite() { |
| TestSuite suite = new TestSuite(JavaBeanObservableListTest.class.getName()); |
| suite.addTestSuite(JavaBeanObservableListTest.class); |
| suite.addTest(MutableObservableListContractTest.suite(new Delegate())); |
| return suite; |
| } |
| |
| static class Delegate extends AbstractObservableCollectionContractDelegate { |
| public IObservableCollection createObservableCollection(Realm realm, |
| int elementCount) { |
| String propertyName = "list"; |
| PropertyDescriptor propertyDescriptor; |
| try { |
| propertyDescriptor = new PropertyDescriptor(propertyName, |
| Bean.class); |
| } catch (IntrospectionException e) { |
| throw new RuntimeException(e); |
| } |
| Object bean = new Bean(new ArrayList()); |
| |
| IObservableList list = new JavaBeanObservableList(realm, bean, |
| propertyDescriptor, String.class); |
| for (int i = 0; i < elementCount; i++) |
| list.add(createElement(list)); |
| return list; |
| } |
| |
| public Object createElement(IObservableCollection collection) { |
| return new Object().toString(); |
| } |
| |
| public Object getElementType(IObservableCollection collection) { |
| return String.class; |
| } |
| |
| public void change(IObservable observable) { |
| IObservableList list = (IObservableList) observable; |
| list.add(createElement(list)); |
| } |
| } |
| } |