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
|
/*******************************************************************************
* 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.internal.model.event;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import org.eclipse.jpt.utility.internal.model.Model;
/**
* A "collection change" event gets delivered whenever a model changes a "bound"
* or "constrained" collection. A CollectionChangeEvent is sent as an
* argument to the CollectionChangeListener.
*
* Normally a CollectionChangeEvent is accompanied by the collection name and
* the items that were added to or removed from the changed collection.
*
* Design options:
* - create a collection to wrap a single added or removed item
* (this is the option we implemented below and in collaborating code)
* since there is no way to optimize downstream code for
* single items, we take another performance hit by building
* a collection each time (@see Collections#singleton(Object))
* and forcing downstream code to use an iterator every time
*
* - fire a separate event for each item added or removed
* eliminates any potential for optimizations to downstream code
*
* - add protocol to support both single items and collections
* adds conditional logic to downstream code
*/
public class CollectionChangeEvent extends ChangeEvent {
/** Name of the collection that changed. */
private final String collectionName;
/** The items that were added to or removed from the collection. May be empty, if not known. */
private final Collection<?> items;
private static final long serialVersionUID = 1L;
/**
* Construct a new collection change event.
*
* @param source The object on which the event initially occurred.
* @param collectionName The programmatic name of the collection that was changed.
* @param items The items that were added to or removed from the collection.
*/
public CollectionChangeEvent(Model source, String collectionName, Collection<?> items) {
super(source);
if ((collectionName == null) || (items == null)) {
throw new NullPointerException();
}
this.collectionName = collectionName;
this.items = Collections.unmodifiableCollection(items);
}
/**
* Construct a new collection change event.
*
* @param source The object on which the event initially occurred.
* @param collectionName The programmatic name of the collection that was changed.
*/
@SuppressWarnings("unchecked")
public CollectionChangeEvent(Model source, String collectionName) {
this(source, collectionName, Collections.emptySet());
}
/**
* Return the programmatic name of the collection that was changed.
*/
public String collectionName() {
return this.collectionName;
}
/**
* Return an iterator on the items that were added to or
* removed from the collection.
* May be empty if inappropriate or unknown.
*/
public Iterator<?> items() {
return this.items.iterator();
}
/**
* Return the number of items that were added to or
* removed from the collection.
* May be 0 if inappropriate or unknown.
*/
public int itemsSize() {
return this.items.size();
}
@Override
public String aspectName() {
return this.collectionName;
}
/**
* Return a copy of the event with the specified source
* replacing the current source.
*/
@Override
public CollectionChangeEvent cloneWithSource(Model newSource) {
return new CollectionChangeEvent(newSource, this.collectionName, this.items);
}
/**
* Return a copy of the event with the specified source
* replacing the current source and collection name.
*/
public CollectionChangeEvent cloneWithSource(Model newSource, String newCollectionName) {
return new CollectionChangeEvent(newSource, newCollectionName, this.items);
}
}
|
