javafx.beans.property.adapter.JavaBeanStringProperty Maven / Gradle / Ivy
/*
* Copyright (c) 2011, 2021, 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.StringProperty;
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 JavaBeanStringProperty} provides an adapter between a regular
* Java Bean property of type {@code String} and a JavaFX
* {@code StringProperty}. It cannot be created directly, but a
* {@link JavaBeanStringPropertyBuilder} has to be used.
*
* 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 JavaBeanStringProperty} 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 JavaBeanStringProperty} will reject changes, if it is bound to an
* {@link javafx.beans.value.ObservableValue ObservableValue<String>}.
*
* Deploying an Application as a Module
*
* 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.
*
*
* For example, if {@code com.foo.MyBeanClass} is in the {@code foo.app} module,
* the {@code module-info.java} might
* look like this:
*
*
{@code module foo.app {
opens com.foo to javafx.base;
}}
*
*
* Alternatively, a class is reflectively accessible if the module
* {@link Module#isExported(String) exports} the containing package
* unconditionally.
*
*
* @see javafx.beans.property.StringProperty
* @see JavaBeanStringPropertyBuilder
* @since JavaFX 2.1
*/
public final class JavaBeanStringProperty extends StringProperty implements JavaBeanProperty {
private final PropertyDescriptor descriptor;
private final PropertyDescriptor.Listener listener;
private ObservableValue observable = null;
private ExpressionHelper helper = null;
@SuppressWarnings("removal")
private final AccessControlContext acc = AccessController.getContext();
JavaBeanStringProperty(PropertyDescriptor descriptor, Object bean) {
this.descriptor = descriptor;
this.listener = descriptor.new Listener(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("removal")
@Override
public String get() {
return AccessController.doPrivileged((PrivilegedAction) () -> {
try {
return (String)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}.
*/
@SuppressWarnings("removal")
@Override
public void set(final String value) {
if (isBound()) {
throw new RuntimeException("A bound value cannot be set.");
}
AccessController.doPrivileged((PrivilegedAction) () -> {
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 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 listener) {
helper = ExpressionHelper.addListener(helper, this, listener);
}
/**
* {@inheritDoc}
*/
@Override
public void removeListener(ChangeListener 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);
}
}