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
|
/*******************************************************************************
* 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.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 add" event gets delivered whenever a model adds items to a
* "bound" or "constrained" list. A <code>ListAddEvent</code> is sent as an
* argument to the {@link org.eclipse.jpt.common.utility.model.listener.ListChangeListener}.
* <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 ListAddEvent extends ListEvent {
/** The index at which the items were added. */
private final int index;
/** The items added to the list. */
private final Object[] items;
private static final long serialVersionUID = 1L;
// ********** constructors **********
/**
* Construct a new list add event.
*
* @param source The object on which the event initially occurred.
* @param listName The programmatic name of the list that was changed.
* @param index The index at which the items were added.
* @param item The item added to the list.
*/
public ListAddEvent(Model source, String listName, int index, Object item) {
this(source, listName, index, new Object[] {item});
}
/**
* Construct a new list add event.
*
* @param source The object on which the event initially occurred.
* @param listName The programmatic name of the list that was changed.
* @param index The index at which the items were added.
* @param items The items added to the list.
*/
public ListAddEvent(Model source, String listName, int index, List<?> items) {
this(source, listName, index, items.toArray()); // NPE if 'items' is null
}
private ListAddEvent(Model source, String listName, int index, Object[] items) {
super(source, listName);
this.index = index;
this.items = items;
}
// ********** standard state **********
/**
* Return the index at which the items were added to the list.
*/
public int getIndex() {
return this.index;
}
/**
* Return the items added to the list.
*/
public Iterable<?> getItems() {
return new ArrayIterable<Object>(this.items);
}
/**
* Return the number of items added to the list.
*/
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 ListAddEvent 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 ListAddEvent clone(Model newSource, String newListName) {
return this.clone(newSource, newListName, 0);
}
/**
* Return a copy of the event with the specified source and list name
* replacing the current source and list name and displacing
* the index by the specified amount.
*/
public ListAddEvent clone(Model newSource, String newListName, int offset) {
return new ListAddEvent(newSource, newListName, this.index + offset, this.items);
}
}
|
