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
|
/*******************************************************************************
* Copyright (c) 2007, 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.common.utility.model.event;
import java.util.List;
import org.eclipse.jpt.common.utility.internal.StringTools;
import org.eclipse.jpt.common.utility.internal.iterables.ArrayIterable;
import org.eclipse.jpt.common.utility.model.Model;
/**
* A "list change" event gets delivered whenever a model changes a "bound"
* or "constrained" list in a manner that is not easily characterized by
* the other list events.
* A <code>ListChangeEvent</code> is sent as an
* argument to the {@link org.eclipse.jpt.common.utility.model.listener.ListChangeListener}.
* A <code>ListChangeEvent</code> is accompanied by the list name and
* the current state of the list.
* <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.
*/
public final class ListChangeEvent extends ListEvent {
/**
* The the list in its current state.
* Clients will need to calculate the necessary changes to synchronize
* with the list.
*/
private final Object[] list;
private static final long serialVersionUID = 1L;
// ********** constructors **********
/**
* Construct a new list change event.
*
* @param source The object on which the event initially occurred.
* @param listName The programmatic name of the list that was changed.
*/
public ListChangeEvent(Model source, String listName, List<?> list) {
this(source, listName, list.toArray()); // NPE if 'list' is null
}
private ListChangeEvent(Model source, String listName, Object[] list) {
super(source, listName);
this.list = list;
}
// ********** standard state **********
/**
* Return the current state of the list.
*/
public Iterable<?> getList() {
return new ArrayIterable<Object>(this.list);
}
/**
* Return the number of items in the current state of the list.
*/
public int getListSize() {
return this.list.length;
}
@Override
protected void toString(StringBuilder sb) {
super.toString(sb);
sb.append(": "); //$NON-NLS-1$
StringTools.append(sb, this.list);
}
// ********** cloning **********
/**
* Return a copy of the event with the specified source
* replacing the current source.
*/
public ListChangeEvent clone(Model newSource) {
return this.clone(newSource, this.listName);
}
/**
* Return a copy of the event with the specified source and list name
* replacing the current source and list name.
*/
public ListChangeEvent clone(Model newSource, String newListName) {
return new ListChangeEvent(newSource, newListName, this.list);
}
}
|
