1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
|
/*******************************************************************************
* Copyright (c) 2007 Oracle. 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:
* Oracle - initial API and implementation
******************************************************************************/
package org.eclipse.jpt.utility.tests.internal.model.value.prefs;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.prefs.NodeChangeEvent;
import java.util.prefs.NodeChangeListener;
import java.util.prefs.PreferenceChangeListener;
import java.util.prefs.Preferences;
import org.eclipse.jpt.utility.internal.ClassTools;
import org.eclipse.jpt.utility.internal.model.event.CollectionChangeEvent;
import org.eclipse.jpt.utility.internal.model.event.PropertyChangeEvent;
import org.eclipse.jpt.utility.internal.model.listener.CollectionChangeListener;
import org.eclipse.jpt.utility.internal.model.listener.PropertyChangeListener;
import org.eclipse.jpt.utility.internal.model.value.CollectionValueModel;
import org.eclipse.jpt.utility.internal.model.value.WritablePropertyValueModel;
import org.eclipse.jpt.utility.internal.model.value.SimplePropertyValueModel;
import org.eclipse.jpt.utility.internal.model.value.PropertyValueModel;
import org.eclipse.jpt.utility.internal.model.value.prefs.PreferencePropertyValueModel;
import org.eclipse.jpt.utility.internal.model.value.prefs.PreferencesCollectionValueModel;
public class PreferencesCollectionValueModelTests extends PreferencesTestCase {
private Map<String, String> expectedValues;
private WritablePropertyValueModel<Preferences> nodeHolder;
PreferencesCollectionValueModel<String> preferencesAdapter;
CollectionChangeEvent event;
CollectionChangeListener listener;
private PropertyChangeListener itemListener;
boolean listenerRemoved = false;
private static final String KEY_NAME_1 = "foo 1";
private static final String KEY_NAME_2 = "foo 2";
private static final String KEY_NAME_3 = "foo 3";
private static final String STRING_VALUE_1 = "original string value 1";
private static final String STRING_VALUE_2 = "original string value 2";
private static final String STRING_VALUE_3 = "original string value 3";
public PreferencesCollectionValueModelTests(String name) {
super(name);
}
@Override
protected void setUp() throws Exception {
super.setUp();
this.expectedValues = new HashMap<String, String>();
this.testNode.put(KEY_NAME_1, STRING_VALUE_1); this.expectedValues.put(KEY_NAME_1, STRING_VALUE_1);
this.testNode.put(KEY_NAME_2, STRING_VALUE_2); this.expectedValues.put(KEY_NAME_2, STRING_VALUE_2);
this.testNode.put(KEY_NAME_3, STRING_VALUE_3); this.expectedValues.put(KEY_NAME_3, STRING_VALUE_3);
this.nodeHolder = new SimplePropertyValueModel<Preferences>(this.testNode);
this.preferencesAdapter = new PreferencesCollectionValueModel<String>(this.nodeHolder);
this.listener = this.buildCollectionChangeListener();
this.itemListener = this.buildItemListener();
this.preferencesAdapter.addCollectionChangeListener(CollectionValueModel.VALUES, this.listener);
this.event = null;
}
private CollectionChangeListener buildCollectionChangeListener() {
return new CollectionChangeListener() {
public void collectionChanged(CollectionChangeEvent e) {
this.logEvent(e);
}
public void collectionCleared(CollectionChangeEvent e) {
this.logEvent(e);
}
public void itemsAdded(CollectionChangeEvent e) {
this.logEvent(e);
}
public void itemsRemoved(CollectionChangeEvent e) {
this.logEvent(e);
}
private void logEvent(CollectionChangeEvent e) {
if (PreferencesCollectionValueModelTests.this.event != null) {
throw new IllegalStateException("unexpected this.event: " + e);
}
PreferencesCollectionValueModelTests.this.event = e;
}
};
}
private PropertyChangeListener buildItemListener() {
return new PropertyChangeListener() {
public void propertyChanged(PropertyChangeEvent e) {
throw new IllegalStateException("unexpected this.event: " + e);
}
};
}
public void testSubjectHolder() throws Exception {
this.verifyAdapter(this.preferencesAdapter);
assertNull(this.event);
String ANOTHER_KEY_NAME_1 = "another key 1";
String ANOTHER_KEY_NAME_2 = "another key 2";
String ANOTHER_KEY_NAME_3 = "another key 3";
String ANOTHER_STRING_VALUE_1 = "another string value 1";
String ANOTHER_STRING_VALUE_2 = "another string value 2";
String ANOTHER_STRING_VALUE_3 = "another string value 3";
Preferences anotherNode = this.classNode.node("another test node");
this.expectedValues.clear();
anotherNode.put(ANOTHER_KEY_NAME_1, ANOTHER_STRING_VALUE_1); this.expectedValues.put(ANOTHER_KEY_NAME_1, ANOTHER_STRING_VALUE_1);
anotherNode.put(ANOTHER_KEY_NAME_2, ANOTHER_STRING_VALUE_2); this.expectedValues.put(ANOTHER_KEY_NAME_2, ANOTHER_STRING_VALUE_2);
anotherNode.put(ANOTHER_KEY_NAME_3, ANOTHER_STRING_VALUE_3); this.expectedValues.put(ANOTHER_KEY_NAME_3, ANOTHER_STRING_VALUE_3);
this.nodeHolder.setValue(anotherNode);
// collectionChanged does not pass any items in the this.event
this.verifyEvent(Collections.<String, String>emptyMap());
this.verifyAdapter(this.preferencesAdapter);
this.event = null;
this.expectedValues.clear();
this.nodeHolder.setValue(null);
this.verifyEvent(this.expectedValues);
assertFalse(this.preferencesAdapter.iterator().hasNext());
this.event = null;
this.nodeHolder.setValue(this.testNode);
this.verifyEvent(Collections.<String, String>emptyMap());
this.expectedValues.clear();
this.expectedValues.put(KEY_NAME_1, STRING_VALUE_1);
this.expectedValues.put(KEY_NAME_2, STRING_VALUE_2);
this.expectedValues.put(KEY_NAME_3, STRING_VALUE_3);
this.verifyAdapter(this.preferencesAdapter);
}
public void testAddPreference() throws Exception {
this.verifyAdapter(this.preferencesAdapter);
assertNull(this.event);
String ANOTHER_KEY_NAME = "another key";
String ANOTHER_STRING_VALUE = "another string value";
this.testNode.put(ANOTHER_KEY_NAME, ANOTHER_STRING_VALUE);
this.waitForEventQueueToClear();
Map<String, String> expectedItems = new HashMap<String, String>();
expectedItems.put(ANOTHER_KEY_NAME, ANOTHER_STRING_VALUE);
this.verifyEvent(expectedItems);
this.expectedValues.put(ANOTHER_KEY_NAME, ANOTHER_STRING_VALUE);
this.verifyAdapter(this.preferencesAdapter);
}
public void testRemovePreference() throws Exception {
this.verifyAdapter(this.preferencesAdapter);
assertNull(this.event);
this.testNode.remove(KEY_NAME_2);
this.waitForEventQueueToClear();
assertNotNull(this.event);
assertEquals(this.preferencesAdapter, this.event.getSource());
assertEquals(CollectionValueModel.VALUES, this.event.collectionName());
assertEquals(1, this.event.itemsSize());
@SuppressWarnings("unchecked")
String key = ((PreferencePropertyValueModel<String>) this.event.items().next()).key();
assertEquals(KEY_NAME_2, key);
this.expectedValues.remove(KEY_NAME_2);
this.verifyAdapter(this.preferencesAdapter);
}
public void testChangePreference() throws Exception {
this.verifyAdapter(this.preferencesAdapter);
assertNull(this.event);
String DIFFERENT = "something completely different";
this.testNode.put(KEY_NAME_2, DIFFERENT);
this.waitForEventQueueToClear();
assertNull(this.event);
this.expectedValues.put(KEY_NAME_2, DIFFERENT);
this.verifyAdapter(this.preferencesAdapter);
}
public void testValues() throws Exception {
this.verifyNode(this.testNode);
this.verifyAdapter(this.preferencesAdapter);
}
/**
* test a situation where
* - we are listening to the node when it gets removed from the preferences "repository"
* - we get notification that it has been removed
* - we try to remove our this.listener
* - the node will throw an IllegalStateException - the adapter should handle it OK...
*/
public void testRemoveNode() throws Exception {
assertTrue(this.preferencesAdapter.hasAnyCollectionChangeListeners(CollectionValueModel.VALUES));
Preferences parent = this.testNode.parent();
parent.addNodeChangeListener(this.buildParentNodeChangeListener());
this.testNode.removeNode();
this.testNode.flush(); // this seems to be required for the this.event to trigger...
this.waitForEventQueueToClear();
assertTrue(this.listenerRemoved);
assertFalse(this.preferencesAdapter.hasAnyCollectionChangeListeners(CollectionValueModel.VALUES));
}
private NodeChangeListener buildParentNodeChangeListener() {
return new NodeChangeListener() {
public void childAdded(NodeChangeEvent e) {
throw new IllegalStateException("unexpected this.event: " + e);
}
public void childRemoved(NodeChangeEvent e) {
if (e.getChild() == PreferencesCollectionValueModelTests.this.testNode) {
PreferencesCollectionValueModelTests.this.preferencesAdapter.removeCollectionChangeListener(CollectionValueModel.VALUES, PreferencesCollectionValueModelTests.this.listener);
// this line of code will not execute if the line above triggers an exception
PreferencesCollectionValueModelTests.this.listenerRemoved = true;
}
}
};
}
public void testHasListeners() throws Exception {
assertTrue(this.preferencesAdapter.hasAnyCollectionChangeListeners(CollectionValueModel.VALUES));
assertTrue(this.nodeHasAnyPrefListeners(this.testNode));
this.preferencesAdapter.removeCollectionChangeListener(CollectionValueModel.VALUES, this.listener);
assertFalse(this.nodeHasAnyPrefListeners(this.testNode));
assertFalse(this.preferencesAdapter.hasAnyCollectionChangeListeners(CollectionValueModel.VALUES));
CollectionChangeListener listener2 = this.buildCollectionChangeListener();
this.preferencesAdapter.addCollectionChangeListener(listener2);
assertTrue(this.preferencesAdapter.hasAnyCollectionChangeListeners(CollectionValueModel.VALUES));
assertTrue(this.nodeHasAnyPrefListeners(this.testNode));
this.preferencesAdapter.removeCollectionChangeListener(listener2);
assertFalse(this.nodeHasAnyPrefListeners(this.testNode));
assertFalse(this.preferencesAdapter.hasAnyCollectionChangeListeners(CollectionValueModel.VALUES));
}
private void verifyEvent(Map<String, String> items) {
assertNotNull(this.event);
assertEquals(this.preferencesAdapter, this.event.getSource());
assertEquals(CollectionValueModel.VALUES, this.event.collectionName());
assertEquals(items.size(), this.event.itemsSize());
@SuppressWarnings("unchecked")
Iterator<PreferencePropertyValueModel<String>> eventItems = (Iterator<PreferencePropertyValueModel<String>>) this.event.items();
this.verifyItems(items, eventItems);
}
private void verifyNode(Preferences node) throws Exception {
String[] keys = node.keys();
assertEquals(this.expectedValues.size(), keys.length);
for (int i = 0; i < keys.length; i++) {
assertEquals(this.expectedValues.get(keys[i]), node.get(keys[i], "<missing preference>"));
}
}
private void verifyAdapter(PreferencesCollectionValueModel<String> cvm) {
assertEquals(this.expectedValues.size(), cvm.size());
this.verifyItems(this.expectedValues, cvm.iterator());
}
private void verifyItems(Map<String, String> expected, Iterator<PreferencePropertyValueModel<String>> stream) {
while (stream.hasNext()) {
PreferencePropertyValueModel<String> model = stream.next();
model.addPropertyChangeListener(PropertyValueModel.VALUE, this.itemListener);
assertEquals(expected.get(model.key()), model.value());
model.removePropertyChangeListener(PropertyValueModel.VALUE, this.itemListener);
}
}
private boolean nodeHasAnyPrefListeners(Preferences node) throws Exception {
PreferenceChangeListener[] prefListeners = (PreferenceChangeListener[]) ClassTools.fieldValue(node, "prefListeners");
return prefListeners.length > 0;
}
}
|
