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
|
/*******************************************************************************
* Copyright (c) 2007, 2016 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.common.utility.internal.model.value;
import java.util.ArrayList;
import java.util.EventListener;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;
import org.eclipse.jpt.common.utility.internal.collection.CollectionTools;
import org.eclipse.jpt.common.utility.internal.collection.ListTools;
import org.eclipse.jpt.common.utility.internal.iterator.IteratorTools;
import org.eclipse.jpt.common.utility.model.Model;
import org.eclipse.jpt.common.utility.model.event.StateChangeEvent;
import org.eclipse.jpt.common.utility.model.listener.ListChangeListener;
import org.eclipse.jpt.common.utility.model.listener.StateChangeAdapter;
import org.eclipse.jpt.common.utility.model.listener.StateChangeListener;
import org.eclipse.jpt.common.utility.model.value.ListValueModel;
import org.eclipse.jpt.common.utility.model.value.PropertyValueModel;
/**
* This extension of {@link AspectAdapter} provides list change support
* by adapting a subject's state change events to a minimum set
* of list change events.
*
* @param <S> the type of the adapter's subject
* @param <E> the type of the adapter's list's elements
*/
public abstract class ListCurator<S extends Model, E>
extends AspectAdapter<S, List<E>>
implements ListValueModel<E>
{
/** How the list looked before the last state change */
private final ArrayList<E> record;
/** A listener that listens for the subject's state to change */
private final StateChangeListener stateChangeListener;
// ********** constructors **********
/**
* Construct a curator for the specified subject.
*/
protected ListCurator(S subject) {
this(PropertyValueModelTools.staticPropertyValueModel(subject));
}
/**
* Construct a curator for the specified subject model.
* The subject model cannot be <code>null</code>.
*/
protected ListCurator(PropertyValueModel<? extends S> subjectModel) {
super(subjectModel);
this.record = new ArrayList<E>();
this.stateChangeListener = this.buildStateChangeListener();
}
// ********** initialization **********
/**
* The subject's state has changed, do inventory and report to listeners.
*/
protected StateChangeListener buildStateChangeListener() {
return new SubjectStateChangeListener();
}
protected class SubjectStateChangeListener
extends StateChangeAdapter
{
@Override
public void stateChanged(StateChangeEvent event) {
ListCurator.this.submitInventoryReport();
}
}
// ********** ListValueModel implementation **********
public ListIterator<E> iterator() {
return this.listIterator();
}
public ListIterator<E> listIterator() {
return IteratorTools.readOnly(this.record.listIterator());
}
/**
* Return the item at the specified index of the subject's list aspect.
*/
public E get(int index) {
return this.record.get(index);
}
/**
* Return the size of the subject's list aspect.
*/
public int size() {
return this.record.size();
}
/**
* Return an array manifestation of the subject's list aspect.
*/
public Object[] toArray() {
return this.record.toArray();
}
// ********** AspectAdapter implementation **********
@Override
protected List<E> getAspectValue() {
return this.record;
}
@Override
protected Class<? extends EventListener> getListenerClass() {
return ListChangeListener.class;
}
@Override
protected String getListenerAspectName() {
return LIST_VALUES;
}
@Override
public boolean hasListeners() {
return this.hasAnyListChangeListeners(LIST_VALUES);
}
/**
* The aspect has changed, notify listeners appropriately.
*/
@Override
protected void fireAspectChanged(List<E> oldValue, List<E> newValue) {
this.fireListChanged(LIST_VALUES, this.record);
}
/**
* The subject is not null - add our listener.
*/
@Override
protected void engageSubject_() {
((Model) this.subject).addStateChangeListener(this.stateChangeListener);
// sync our list *after* we start listening to the subject,
// since its value might change when a listener is added
CollectionTools.addAll(this.record, this.iteratorForRecord());
}
/**
* The subject is not null - remove our listener.
*/
@Override
protected void disengageSubject_() {
((Model) this.subject).removeStateChangeListener(this.stateChangeListener);
// clear out the list when we are not listening to the subject
this.record.clear();
}
// ********** ListCurator protocol **********
/**
* This is intended to be different from {@link ListValueModel#iterator()}.
* It is intended to be used only when the subject changes or the
* subject's "state" changes (as signified by a state change event).
*/
protected abstract Iterator<E> iteratorForRecord();
// ********** behavior **********
void submitInventoryReport() {
List<E> newRecord = ListTools.arrayList(this.iteratorForRecord());
int recordIndex = 0;
// add items from the new record
for (E newItem : newRecord) {
this.inventoryNewItem(recordIndex, newItem);
recordIndex++;
}
// clean out items that are no longer in the new record
for (recordIndex = 0; recordIndex < this.record.size(); ) {
E item = this.record.get(recordIndex);
if (newRecord.contains(item)) {
recordIndex++;
} else {
this.removeItemFromInventory(recordIndex, item);
}
}
}
private void inventoryNewItem(int recordIndex, E newItem) {
List<E> rec = new ArrayList<E>(this.record);
if ((recordIndex < rec.size()) && rec.get(recordIndex).equals(newItem)) {
return;
}
if (rec.contains(newItem)) {
this.removeItemFromInventory(recordIndex, rec.get(recordIndex));
this.inventoryNewItem(recordIndex, newItem);
} else {
this.addItemToInventory(recordIndex, newItem);
}
}
private void addItemToInventory(int index, E item) {
this.addItemToList(index, item, this.record, LIST_VALUES);
}
private void removeItemFromInventory(int index, @SuppressWarnings("unused") E item) {
this.removeItemFromList(index, this.record, LIST_VALUES);
}
@Override
public void toString(StringBuilder sb) {
sb.append(this.record);
}
}
|
