/*
* Copyright (c) 2011, 2017, 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.property.MethodHelper;
import com.sun.javafx.property.adapter.Disposer;
import com.sun.javafx.property.adapter.ReadOnlyPropertyDescriptor;
import javafx.beans.property.ReadOnlyLongPropertyBase;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.UndeclaredThrowableException;
import java.security.AccessController;
import java.security.AccessControlContext;
import java.security.PrivilegedAction;
A ReadOnlyJavaBeanLongProperty provides an adapter between a regular read only Java Bean property of type long or Long and a JavaFX ReadOnlyLongProperty. It cannot be created directly, but a ReadOnlyJavaBeanLongPropertyBuilder has to be used. As a minimum, the Java Bean class must implement a getter for the property. The class, as well as the getter method, 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 Java Bean property is bound (i.e. it supports PropertyChangeListeners), this ReadOnlyJavaBeanLongProperty will be aware of changes in the Java Bean. Otherwise it can be notified about changes by calling fireValueChangedEvent().
Deploying an Application as a Module
If the Java Bean class is in a named module, then it must be reflectively accessible to the javafx.base module. A class is reflectively accessible if the module opens the containing package to at least the javafx.base module.
For example, if com.foo.MyBeanClass is in the foo.app module, the module-info.java might look like this:
module foo.app {
opens com.foo to javafx.base;
Alternatively, a class is reflectively accessible if the module exports the containing package unconditionally.
See Also: Since: JavaFX 2.1
/**
* A {@code ReadOnlyJavaBeanLongProperty} provides an adapter between a regular
* read only Java Bean property of type {@code long} or {@code Long} and a JavaFX
* {@code ReadOnlyLongProperty}. It cannot be created directly, but a
* {@link ReadOnlyJavaBeanLongPropertyBuilder} has to be used.
* <p>
* As a minimum, the Java Bean class must implement a getter for the
* property.
* The class, as well as the getter method, 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 Java Bean property is bound (i.e. it supports
* PropertyChangeListeners), this {@code ReadOnlyJavaBeanLongProperty} will be
* aware of changes in the Java Bean. Otherwise it can be notified about
* changes by calling {@link #fireValueChangedEvent()}.
* </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.ReadOnlyLongProperty
* @see ReadOnlyJavaBeanLongPropertyBuilder
* @since JavaFX 2.1
*/
public final class ReadOnlyJavaBeanLongProperty extends ReadOnlyLongPropertyBase implements ReadOnlyJavaBeanProperty<Number> {
private final ReadOnlyPropertyDescriptor descriptor;
private final ReadOnlyPropertyDescriptor.ReadOnlyListener<Number> listener;
private final AccessControlContext acc = AccessController.getContext();
ReadOnlyJavaBeanLongProperty(ReadOnlyPropertyDescriptor descriptor, Object bean) {
this.descriptor = descriptor;
this.listener = descriptor.new ReadOnlyListener<Number>(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
IllegalAccessException or an InvocationTargetException.
/**
* {@inheritDoc}
*
* @throws UndeclaredThrowableException if calling the getter of the Java Bean
* property throws an {@code IllegalAccessException} or an
* {@code InvocationTargetException}.
*/
@Override
public long get() {
return AccessController.doPrivileged((PrivilegedAction<Long>) () -> {
try {
return ((Number)MethodHelper.invoke(
descriptor.getGetter(), getBean(), (Object[])null)).longValue();
} catch (IllegalAccessException e) {
throw new UndeclaredThrowableException(e);
} catch (InvocationTargetException e) {
throw new UndeclaredThrowableException(e);
}
}, acc);
}
{@inheritDoc}
/**
* {@inheritDoc}
*/
@Override
public Object getBean() {
return listener.getBean();
}
{@inheritDoc}
/**
* {@inheritDoc}
*/
@Override
public String getName() {
return descriptor.getName();
}
{@inheritDoc}
/**
* {@inheritDoc}
*/
@Override
public void fireValueChangedEvent() {
super.fireValueChangedEvent();
}
{@inheritDoc}
/**
* {@inheritDoc}
*/
@Override
public void dispose() {
descriptor.removeListener(listener);
}
}