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
|
/*******************************************************************************
* Copyright (c) 2009 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.model.event;
import java.util.Collection;
import org.eclipse.jpt.utility.internal.StringTools;
import org.eclipse.jpt.utility.internal.iterables.ArrayIterable;
import org.eclipse.jpt.utility.model.Model;
/**
* A "collection remove" event gets delivered whenever a model removes items
* from a "bound" or "constrained" collection. A <code>CollectionRemoveEvent</code> is sent
* as an argument to the {@link org.eclipse.jpt.utility.model.listener.CollectionChangeListener}.
* <p>
* Provisional API: This class is part of an interim API that is still
* under development and expected to change significantly before reaching
* stability. It is available at this early stage to solicit feedback from
* pioneering adopters on the understanding that any code that uses this API
* will almost certainly be broken (repeatedly) as the API evolves.
*/
/*
* See design discussion in CollectionAddEvent
*/
public final class CollectionRemoveEvent extends CollectionEvent {
/** The items removed from the collection. */
private final Object[] items;
private static final long serialVersionUID = 1L;
// ********** constructors **********
/**
* Construct a new collection remove event.
*
* @param source The object on which the event initially occurred.
* @param collectionName The programmatic name of the collection that was changed.
* @param item The item removed from the collection.
*/
public CollectionRemoveEvent(Model source, String collectionName, Object item) {
this(source, collectionName, new Object[] {item});
}
/**
* Construct a new collection remove 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 removed from the collection.
*/
public CollectionRemoveEvent(Model source, String collectionName, Collection<?> items) {
this(source, collectionName, items.toArray()); // NPE if 'items' is null
}
private CollectionRemoveEvent(Model source, String collectionName, Object[] items) {
super(source, collectionName);
this.items = items;
}
// ********** standard state **********
/**
* Return the items removed from the collection.
*/
public Iterable<?> getItems() {
return new ArrayIterable<Object>(this.items);
}
/**
* Return the number of items removed from the collection.
*/
public int getItemsSize() {
return this.items.length;
}
@Override
protected void toString(StringBuilder sb) {
super.toString(sb);
sb.append(": "); //$NON-NLS-1$
StringTools.append(sb, this.items);
}
// ********** cloning **********
/**
* Return a copy of the event with the specified source
* replacing the current source.
*/
public CollectionRemoveEvent clone(Model newSource) {
return this.clone(newSource, this.collectionName);
}
/**
* Return a copy of the event with the specified source and collection name
* replacing the current source and collection name.
*/
public CollectionRemoveEvent clone(Model newSource, String newCollectionName) {
return new CollectionRemoveEvent(newSource, newCollectionName, this.items);
}
}
|
