forked from openjdk/jfx
/
JavaBeanObjectProperty.java
281 lines (254 loc) · 8.98 KB
/
JavaBeanObjectProperty.java
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
/*
* Copyright (c) 2011, 2020, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package javafx.beans.property.adapter;
import com.sun.javafx.binding.ExpressionHelper;
import com.sun.javafx.property.MethodHelper;
import com.sun.javafx.property.adapter.Disposer;
import com.sun.javafx.property.adapter.PropertyDescriptor;
import javafx.beans.InvalidationListener;
import javafx.beans.property.ObjectProperty;
import javafx.beans.value.ChangeListener;
import javafx.beans.value.ObservableValue;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.UndeclaredThrowableException;
import java.security.AccessController;
import java.security.AccessControlContext;
import java.security.PrivilegedAction;
/**
* A {@code JavaBeanObjectProperty} provides an adapter between a regular
* Java Bean property of type {@code T} and a JavaFX
* {@code ObjectProperty<T>}. It cannot be created directly, but a
* {@link JavaBeanObjectPropertyBuilder} has to be used.
* <p>
* As a minimum, the Java Bean class must implement a getter and a setter for the
* property.
* The class, as well as the getter and a setter methods, must be declared public.
* If the getter of an instance of this class is called, the property of
* the Java Bean is returned. If the setter is called, the value will be passed
* to the Java Bean property. If the Java Bean property is bound (i.e. it supports
* PropertyChangeListeners), this {@code JavaBeanObjectProperty} will be
* aware of changes in the Java Bean. Otherwise it can be notified about
* changes by calling {@link #fireValueChangedEvent()}. If the Java Bean property
* is also constrained (i.e. it supports VetoableChangeListeners), this
* {@code JavaBeanObjectProperty} will reject changes, if it is bound to an
* {@link javafx.beans.value.ObservableValue ObservableValue<Object>}.
* </p>
* <p><b>Deploying an Application as a Module</b></p>
* <p>
* If the Java Bean class is in a named module, then it must be reflectively
* accessible to the {@code javafx.base} module.
* A class is reflectively accessible if the module
* {@link Module#isOpen(String,Module) opens} the containing package to at
* least the {@code javafx.base} module.
* </p>
* <p>
* For example, if {@code com.foo.MyBeanClass} is in the {@code foo.app} module,
* the {@code module-info.java} might
* look like this:
* </p>
*
<pre>{@code module foo.app {
opens com.foo to javafx.base;
}}</pre>
*
* <p>
* Alternatively, a class is reflectively accessible if the module
* {@link Module#isExported(String) exports} the containing package
* unconditionally.
* </p>
*
* @see javafx.beans.property.ObjectProperty
* @see JavaBeanObjectPropertyBuilder
*
* @param <T> type of the wrapped {@code Object}
* @since JavaFX 2.1
*/
public final class JavaBeanObjectProperty<T> extends ObjectProperty<T> implements JavaBeanProperty<T> {
private final PropertyDescriptor descriptor;
private final PropertyDescriptor.Listener<T> listener;
private ObservableValue<? extends T> observable = null;
private ExpressionHelper<T> helper = null;
private final AccessControlContext acc = AccessController.getContext();
JavaBeanObjectProperty(PropertyDescriptor descriptor, Object bean) {
this.descriptor = descriptor;
this.listener = descriptor.new Listener<T>(bean, this);
descriptor.addListener(listener);
Disposer.addRecord(this, new DescriptorListenerCleaner(descriptor, listener));
}
/**
* {@inheritDoc}
*
* @throws UndeclaredThrowableException if calling the getter of the Java Bean
* property throws an {@code IllegalAccessException} or an
* {@code InvocationTargetException}.
*/
@SuppressWarnings("unchecked")
@Override
public T get() {
return AccessController.doPrivileged((PrivilegedAction<T>) () -> {
try {
return (T)MethodHelper.invoke(descriptor.getGetter(), getBean(), (Object[])null);
} catch (IllegalAccessException e) {
throw new UndeclaredThrowableException(e);
} catch (InvocationTargetException e) {
throw new UndeclaredThrowableException(e);
}
}, acc);
}
/**
* {@inheritDoc}
*
* @throws UndeclaredThrowableException if calling the getter of the Java Bean
* property throws an {@code IllegalAccessException} or an
* {@code InvocationTargetException}.
*/
@Override
public void set(final T value) {
if (isBound()) {
throw new RuntimeException("A bound value cannot be set.");
}
AccessController.doPrivileged((PrivilegedAction<Void>) () -> {
try {
MethodHelper.invoke(descriptor.getSetter(), getBean(), new Object[] {value});
ExpressionHelper.fireValueChangedEvent(helper);
} catch (IllegalAccessException e) {
throw new UndeclaredThrowableException(e);
} catch (InvocationTargetException e) {
throw new UndeclaredThrowableException(e);
}
return null;
}, acc);
}
/**
* {@inheritDoc}
*/
@Override
public void bind(ObservableValue<? extends T> observable) {
if (observable == null) {
throw new NullPointerException("Cannot bind to null");
}
if (!observable.equals(this.observable)) {
unbind();
set(observable.getValue());
this.observable = observable;
this.observable.addListener(listener);
}
}
/**
* {@inheritDoc}
*/
@Override
public void unbind() {
if (observable != null) {
observable.removeListener(listener);
observable = null;
}
}
/**
* {@inheritDoc}
*/
@Override
public boolean isBound() {
return observable != null;
}
/**
* {@inheritDoc}
*/
@Override
public Object getBean() {
return listener.getBean();
}
/**
* {@inheritDoc}
*/
@Override
public String getName() {
return descriptor.getName();
}
/**
* {@inheritDoc}
*/
@Override
public void addListener(ChangeListener<? super T> listener) {
helper = ExpressionHelper.addListener(helper, this, listener);
}
/**
* {@inheritDoc}
*/
@Override
public void removeListener(ChangeListener<? super T> listener) {
helper = ExpressionHelper.removeListener(helper, listener);
}
/**
* {@inheritDoc}
*/
@Override
public void addListener(InvalidationListener listener) {
helper = ExpressionHelper.addListener(helper, this, listener);
}
/**
* {@inheritDoc}
*/
@Override
public void removeListener(InvalidationListener listener) {
helper = ExpressionHelper.removeListener(helper, listener);
}
/**
* {@inheritDoc}
*/
@Override
public void fireValueChangedEvent() {
ExpressionHelper.fireValueChangedEvent(helper);
}
/**
* {@inheritDoc}
*/
@Override
public void dispose() {
descriptor.removeListener(listener);
}
/**
* Returns a string representation of this {@code JavaBeanObjectProperty} object.
* @return a string representation of this {@code JavaBeanObjectProperty} object.
*/
@Override
public String toString() {
final Object bean = getBean();
final String name = getName();
final StringBuilder result = new StringBuilder("ObjectProperty [");
if (bean != null) {
result.append("bean: ").append(bean).append(", ");
}
if ((name != null) && (!name.equals(""))) {
result.append("name: ").append(name).append(", ");
}
if (isBound()) {
result.append("bound, ");
}
result.append("value: ").append(get());
result.append("]");
return result.toString();
}
}