All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javafx.beans.property.adapter.JavaBeanLongProperty Maven / Gradle / Ivy

There is a newer version: 24-ea+15
Show newest version
/*
 * Copyright (c) 2011, 2022, 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.LongProperty;
import javafx.beans.value.ChangeListener;
import javafx.beans.value.ObservableValue;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.UndeclaredThrowableException;

/**
 * A {@code JavaBeanLongProperty} provides an adapter between a regular
 * Java Bean property of type {@code long} or {@code Long} and a JavaFX
 * {@code LongProperty}. It cannot be created directly, but a
 * {@link JavaBeanLongPropertyBuilder} 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 JavaBeanLongProperty} 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 JavaBeanLongProperty} will reject changes, if it is bound to an * {@link javafx.beans.value.ObservableValue ObservableValue<Long>}. *

*

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.LongProperty * @see JavaBeanLongPropertyBuilder * @since JavaFX 2.1 */ public final class JavaBeanLongProperty extends LongProperty implements JavaBeanProperty { private final PropertyDescriptor descriptor; private final PropertyDescriptor.Listener listener; private ObservableValue observable = null; private ExpressionHelper helper = null; JavaBeanLongProperty(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}. */ @Override public long get() { 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); } } /** * {@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 long value) { if (isBound()) { throw new RuntimeException("A bound value cannot be set."); } 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); } } /** * {@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().longValue()); 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); } /** * Returns a string representation of this {@code JavaBeanLongProperty} object. * @return a string representation of this {@code JavaBeanLongProperty} object. */ @Override public String toString() { final Object bean = getBean(); final String name = getName(); final StringBuilder result = new StringBuilder("LongProperty ["); 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(); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy