1 /*
2 * Copyright (c) 2011, 2017, 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.property.MethodHelper;
29 import com.sun.javafx.property.adapter.Disposer;
30 import com.sun.javafx.property.adapter.ReadOnlyPropertyDescriptor;
31 import javafx.beans.property.ReadOnlyBooleanPropertyBase;
32
33 import java.lang.reflect.InvocationTargetException;
34 import java.lang.reflect.UndeclaredThrowableException;
35
36 import java.security.AccessController;
37 import java.security.AccessControlContext;
38 import java.security.PrivilegedAction;
39
40 /**
41 * A {@code ReadOnlyJavaBeanBooleanProperty} provides an adapter between a regular
42 * read only Java Bean property of type {@code boolean} or {@code Boolean} and a JavaFX
43 * {@code ReadOnlyBooleanProperty}. It cannot be created directly, but a
44 * {@link ReadOnlyJavaBeanBooleanPropertyBuilder} has to be used.
45 * <p>
46 * As a minimum, the Java Bean class must implement a getter for the
47 * property.
48 * The class, as well as the getter method, must be declared public.
49 * If the getter of an instance of this class is called, the property of
50 * the Java Bean is returned. If the Java Bean property is bound (i.e. it supports
51 * PropertyChangeListeners), this {@code ReadOnlyJavaBeanBooleanProperty} will be
52 * aware of changes in the Java Bean. Otherwise it can be notified about
53 * changes by calling {@link #fireValueChangedEvent()}.
54 * </p>
55 * <p><b>Deploying an Application as a Module</b></p>
56 * <p>
57 * If the Java Bean class is in a named module, then it must be reflectively
58 * accessible to the {@code javafx.base} module.
59 * A class is reflectively accessible if the module
60 * {@link Module#isOpen(String,Module) opens} the containing package to at
61 * least the {@code javafx.base} module.
62 * </p>
63 * <p>
64 * For example, if {@code com.foo.MyBeanClass} is in the {@code foo.app} module,
65 * the {@code module-info.java} might
66 * look like this:
67 * </p>
68 *
69 <pre>{@code module foo.app {
70 opens com.foo to javafx.base;
71 }}</pre>
72 *
73 * <p>
74 * Alternatively, a class is reflectively accessible if the module
75 * {@link Module#isExported(String) exports} the containing package
76 * unconditionally.
77 * </p>
78 *
79 * @see javafx.beans.property.ReadOnlyBooleanProperty
80 * @see ReadOnlyJavaBeanBooleanPropertyBuilder
81 * @since JavaFX 2.1
82 */
83 public final class ReadOnlyJavaBeanBooleanProperty extends ReadOnlyBooleanPropertyBase implements ReadOnlyJavaBeanProperty<Boolean> {
84
85 private final ReadOnlyPropertyDescriptor descriptor;
86 private final ReadOnlyPropertyDescriptor.ReadOnlyListener<Boolean> listener;
87
88 private final AccessControlContext acc = AccessController.getContext();
89
90 ReadOnlyJavaBeanBooleanProperty(ReadOnlyPropertyDescriptor descriptor, Object bean) {
91 this.descriptor = descriptor;
92 this.listener = descriptor.new ReadOnlyListener<Boolean>(bean, this);
93 descriptor.addListener(listener);
94 Disposer.addRecord(this, new DescriptorListenerCleaner(descriptor, listener));
95 }
96
97 /**
98 * {@inheritDoc}
99 *
100 * @throws UndeclaredThrowableException if calling the getter of the Java Bean
101 * property throws an {@code IllegalAccessException} or an
102 * {@code InvocationTargetException}.
103 */
104 @Override
105 public boolean get() {
106 return AccessController.doPrivileged((PrivilegedAction<Boolean>) () -> {
107 try {
108 return (Boolean)MethodHelper.invoke(descriptor.getGetter(), getBean(), (Object[])null);
109 } catch (IllegalAccessException e) {
110 throw new UndeclaredThrowableException(e);
111 } catch (InvocationTargetException e) {
112 throw new UndeclaredThrowableException(e);
113 }
114 }, acc);
115 }
116
117 /**
118 * {@inheritDoc}
119 */
120 @Override
121 public Object getBean() {
122 return listener.getBean();
123 }
124
125 /**
126 * {@inheritDoc}
127 */
128 @Override
129 public String getName() {
130 return descriptor.getName();
131 }
132
133 /**
134 * {@inheritDoc}
135 */
136 @Override
137 public void fireValueChangedEvent() {
138 super.fireValueChangedEvent();
139 }
140
141 /**
142 * {@inheritDoc}
143 */
144 @Override
145 public void dispose() {
146 descriptor.removeListener(listener);
147 }
148 }