blob: 5976a55adc151a3bc3dcae51da16373f4e53e105 (
plain) (
blame)
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
|
/*******************************************************************************
* 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.internal.model.value;
import java.util.Collection;
import java.util.EventListener;
import java.util.Iterator;
import org.eclipse.jpt.utility.internal.CollectionTools;
import org.eclipse.jpt.utility.internal.iterators.EmptyIterator;
import org.eclipse.jpt.utility.model.listener.CollectionChangeListener;
import org.eclipse.jpt.utility.model.value.CollectionValueModel;
import org.eclipse.jpt.utility.model.value.PropertyValueModel;
/**
* This {@link AspectAdapter} provides basic collection change support.
* This converts an "aspect" (as defined by subclasses) into
* a single {@link #VALUES} collection.
* <p>
* The typical subclass will override the following methods:<ul>
* <li>{@link #engageSubject_()}<p>
* implement this method to add the appropriate listener to the subject
* <li>{@link #disengageSubject_()}<p>
* implement this method to remove the appropriate listener from the subject
* <li>{@link #getIterable()}<p>
* at the very minimum, override this method to return an iterable containing the
* subject's collection aspect; it does not need to be overridden if either
* {@link #iterator_()} or {@link #iterator()} is overridden and its behavior changed
* <li>{@link #size_()}<p>
* override this method to improve performance; it does not need to be overridden if
* {@link #size()} is overridden and its behavior changed
* <li>{@link #iterator_()}<p>
* override this method to return an iterator on the
* subject's collection aspect if it is not possible to implement {@link #getIterable()};
* it does not need to be overridden if
* {@link #iterator()} is overridden and its behavior changed
* <li>{@link #iterator()}<p>
* override this method only if returning an empty iterator when the
* subject is null is unacceptable
* <li>{@link #size()}<p>
* override this method only if returning a zero when the
* subject is null is unacceptable
* </ul>
* To notify listeners, subclasses can call {@link #collectionChanged()}
* whenever the aspect has changed.
*/
public abstract class AspectCollectionValueModelAdapter<S, E>
extends AspectAdapter<S>
implements CollectionValueModel<E>
{
// ********** constructors **********
/**
* Construct a collection value model adapter for an aspect of the
* specified subject.
*/
protected AspectCollectionValueModelAdapter(PropertyValueModel<? extends S> subjectHolder) {
super(subjectHolder);
}
// ********** CollectionValueModel implementation **********
/**
* Return the elements of the subject's collection aspect.
*/
public Iterator<E> iterator() {
return (this.subject == null) ? EmptyIterator.<E>instance() : this.iterator_();
}
/**
* Return the elements of the subject's collection aspect.
* At this point we can be sure the subject is not null.
* @see #iterator()
*/
protected Iterator<E> iterator_() {
return this.getIterable().iterator();
}
/**
* Return the elements of the subject's collection aspect.
* At this point we can be sure the subject is not null.
* @see #iterator_()
*/
protected Iterable<E> getIterable() {
throw new RuntimeException("This method was not overridden."); //$NON-NLS-1$
}
/**
* Return the size of the subject's collection aspect.
*/
public int size() {
return (this.subject == null) ? 0 : this.size_();
}
/**
* Return the size of the subject's collection aspect.
* At this point we can be sure the subject is not null.
* @see #size()
*/
protected int size_() {
return CollectionTools.size(this.iterator());
}
// ********** AspectAdapter implementation **********
@Override
protected Object getValue() {
return this.buildValueCollection();
}
@Override
protected Class<? extends EventListener> getListenerClass() {
return CollectionChangeListener.class;
}
@Override
protected String getListenerAspectName() {
return VALUES;
}
@Override
protected boolean hasListeners() {
return this.hasAnyCollectionChangeListeners(VALUES);
}
@Override
protected void fireAspectChanged(Object oldValue, Object newValue) {
@SuppressWarnings("unchecked") Collection<E> newCollection = (Collection<E>) newValue;
this.fireCollectionChanged(VALUES, newCollection);
}
protected void collectionChanged() {
this.fireCollectionChanged(VALUES, this.buildValueCollection());
}
protected Collection<E> buildValueCollection() {
return CollectionTools.collection(this.iterator());
}
@Override
public void toString(StringBuilder sb) {
sb.append(this.buildValueCollection());
}
}
|
