1 /*
2 * Copyright (c) 2011, 2015, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package javafx.beans.property.adapter;
27
28 import com.sun.javafx.binding.ExpressionHelper;
29 import com.sun.javafx.property.adapter.Disposer;
30 import com.sun.javafx.property.adapter.PropertyDescriptor;
31 import javafx.beans.InvalidationListener;
32 import javafx.beans.property.LongProperty;
33 import javafx.beans.value.ChangeListener;
34 import javafx.beans.value.ObservableValue;
35
36 import java.lang.reflect.InvocationTargetException;
37 import java.lang.reflect.UndeclaredThrowableException;
38
39 import java.security.AccessControlContext;
40 import java.security.AccessController;
41 import java.security.PrivilegedAction;
42
43 import sun.reflect.misc.MethodUtil;
44
45 /**
46 * A {@code JavaBeanLongProperty} provides an adapter between a regular
47 * Java Bean property of type {@code long} or {@code Long} and a JavaFX
48 * {@code LongProperty}. It cannot be created directly, but a
49 * {@link JavaBeanLongPropertyBuilder} has to be used.
50 * <p>
51 * As a minimum, the Java Bean must implement a getter and a setter for the
52 * property. If the getter of an instance of this class is called, the property of
53 * the Java Bean is returned. If the setter is called, the value will be passed
54 * to the Java Bean property. If the Java Bean property is bound (i.e. it supports
55 * PropertyChangeListeners), this {@code JavaBeanLongProperty} will be
56 * aware of changes in the Java Bean. Otherwise it can be notified about
57 * changes by calling {@link #fireValueChangedEvent()}. If the Java Bean property
58 * is also constrained (i.e. it supports VetoableChangeListeners), this
59 * {@code JavaBeanLongProperty} will reject changes, if it is bound to an
60 * {@link javafx.beans.value.ObservableValue ObservableValue<Long>}.
61 *
62 * @see javafx.beans.property.LongProperty
63 * @see JavaBeanLongPropertyBuilder
64 * @since JavaFX 2.1
65 */
66 public final class JavaBeanLongProperty extends LongProperty implements JavaBeanProperty<Number> {
67
68 private final PropertyDescriptor descriptor;
69 private final PropertyDescriptor.Listener<Number> listener;
70
71 private ObservableValue<? extends Number> observable = null;
72 private ExpressionHelper<Number> helper = null;
73
74 private final AccessControlContext acc = AccessController.getContext();
75
76 JavaBeanLongProperty(PropertyDescriptor descriptor, Object bean) {
77 this.descriptor = descriptor;
78 this.listener = descriptor.new Listener<Number>(bean, this);
79 descriptor.addListener(listener);
80 Disposer.addRecord(this, new DescriptorListenerCleaner(descriptor, listener));
81 }
82
83 /**
84 * {@inheritDoc}
85 *
86 * @throws UndeclaredThrowableException if calling the getter of the Java Bean
87 * property throws an {@code IllegalAccessException} or an
88 * {@code InvocationTargetException}.
89 */
90 @Override
91 public long get() {
92 return AccessController.doPrivileged((PrivilegedAction<Long>) () -> {
93 try {
94 return ((Number)MethodUtil.invoke(
95 descriptor.getGetter(), getBean(), (Object[])null)).longValue();
96 } catch (IllegalAccessException e) {
97 throw new UndeclaredThrowableException(e);
98 } catch (InvocationTargetException e) {
99 throw new UndeclaredThrowableException(e);
100 }
101 }, acc);
102 }
103
104 /**
105 * {@inheritDoc}
106 *
107 * @throws UndeclaredThrowableException if calling the getter of the Java Bean
108 * property throws an {@code IllegalAccessException} or an
109 * {@code InvocationTargetException}.
110 */
111 @Override
112 public void set(final long value) {
113 if (isBound()) {
114 throw new RuntimeException("A bound value cannot be set.");
115 }
116 AccessController.doPrivileged((PrivilegedAction<Void>) () -> {
117 try {
118 MethodUtil.invoke(descriptor.getSetter(), getBean(), new Object[] {value});
119 ExpressionHelper.fireValueChangedEvent(helper);
120 } catch (IllegalAccessException e) {
121 throw new UndeclaredThrowableException(e);
122 } catch (InvocationTargetException e) {
123 throw new UndeclaredThrowableException(e);
124 }
125 return null;
126 }, acc);
127 }
128
129 /**
130 * {@inheritDoc}
131 */
132 @Override
133 public void bind(ObservableValue<? extends Number> observable) {
134 if (observable == null) {
135 throw new NullPointerException("Cannot bind to null");
136 }
137
138 if (!observable.equals(this.observable)) {
139 unbind();
140 set(observable.getValue().longValue());
141 this.observable = observable;
142 this.observable.addListener(listener);
143 }
144 }
145
146 /**
147 * {@inheritDoc}
148 */
149 @Override
150 public void unbind() {
151 if (observable != null) {
152 observable.removeListener(listener);
153 observable = null;
154 }
155 }
156
157 /**
158 * {@inheritDoc}
159 */
160 @Override
161 public boolean isBound() {
162 return observable != null;
163 }
164
165 /**
166 * {@inheritDoc}
167 */
168 @Override
169 public Object getBean() {
170 return listener.getBean();
171 }
172
173 /**
174 * {@inheritDoc}
175 */
176 @Override
177 public String getName() {
178 return descriptor.getName();
179 }
180
181 /**
182 * {@inheritDoc}
183 */
184 @Override
185 public void addListener(ChangeListener<? super Number> listener) {
186 helper = ExpressionHelper.addListener(helper, this, listener);
187 }
188
189 /**
190 * {@inheritDoc}
191 */
192 @Override
193 public void removeListener(ChangeListener<? super Number> listener) {
194 helper = ExpressionHelper.removeListener(helper, listener);
195 }
196
197 /**
198 * {@inheritDoc}
199 */
200 @Override
201 public void addListener(InvalidationListener listener) {
202 helper = ExpressionHelper.addListener(helper, this, listener);
203 }
204
205 /**
206 * {@inheritDoc}
207 */
208 @Override
209 public void removeListener(InvalidationListener listener) {
210 helper = ExpressionHelper.removeListener(helper, listener);
211 }
212
213 /**
214 * {@inheritDoc}
215 */
216 @Override
217 public void fireValueChangedEvent() {
218 ExpressionHelper.fireValueChangedEvent(helper);
219 }
220
221 /**
222 * {@inheritDoc}
223 */
224 @Override
225 public void dispose() {
226 descriptor.removeListener(listener);
227
228 }
229
230 /**
231 * Returns a string representation of this {@code JavaBeanLongProperty} object.
232 * @return a string representation of this {@code JavaBeanLongProperty} object.
233 */
234 @Override
235 public String toString() {
236 final Object bean = getBean();
237 final String name = getName();
238 final StringBuilder result = new StringBuilder("LongProperty [");
239 if (bean != null) {
240 result.append("bean: ").append(bean).append(", ");
241 }
242 if ((name != null) && (!name.equals(""))) {
243 result.append("name: ").append(name).append(", ");
244 }
245 if (isBound()) {
246 result.append("bound, ");
247 }
248 result.append("value: ").append(get());
249 result.append("]");
250 return result.toString();
251 }
252 }