com.sun.javafx.binding.ListExpressionHelper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of openjfx-78-backport Show documentation
Show all versions of openjfx-78-backport Show documentation
This is a backport of OpenJFX 8 to run on Java 7.
The newest version!
/*
* Copyright (c) 2011, 2013, 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 com.sun.javafx.binding;
import com.sun.javafx.collections.NonIterableChange;
import javafx.beans.InvalidationListener;
import javafx.beans.value.ChangeListener;
import javafx.beans.value.ObservableListValue;
import javafx.collections.FXCollections;
import javafx.collections.ListChangeListener;
import javafx.collections.ObservableList;
import java.util.Arrays;
import java.util.List;
import static javafx.collections.ListChangeListener.Change;
/**
* A convenience class for creating implementations of {@link javafx.beans.value.ObservableValue}.
* It contains all of the infrastructure support for value invalidation- and
* change event notification.
*
* This implementation can handle adding and removing listeners while the
* observers are being notified, but it is not thread-safe.
*
*
*/
public abstract class ListExpressionHelper extends ExpressionHelperBase {
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Static methods
public static ListExpressionHelper addListener(ListExpressionHelper helper, ObservableListValue observable, InvalidationListener listener) {
if ((observable == null) || (listener == null)) {
throw new NullPointerException();
}
observable.getValue(); // validate observable
return (helper == null)? new SingleInvalidation(observable, listener) : helper.addListener(listener);
}
public static ListExpressionHelper removeListener(ListExpressionHelper helper, InvalidationListener listener) {
if (listener == null) {
throw new NullPointerException();
}
return (helper == null)? null : helper.removeListener(listener);
}
public static ListExpressionHelper addListener(ListExpressionHelper helper, ObservableListValue observable, ChangeListener> listener) {
if ((observable == null) || (listener == null)) {
throw new NullPointerException();
}
return (helper == null)? new SingleChange(observable, listener) : helper.addListener(listener);
}
public static ListExpressionHelper removeListener(ListExpressionHelper helper, ChangeListener> listener) {
if (listener == null) {
throw new NullPointerException();
}
return (helper == null)? null : helper.removeListener(listener);
}
public static ListExpressionHelper addListener(ListExpressionHelper helper, ObservableListValue observable, ListChangeListener listener) {
if ((observable == null) || (listener == null)) {
throw new NullPointerException();
}
return (helper == null)? new SingleListChange(observable, listener) : helper.addListener(listener);
}
public static ListExpressionHelper removeListener(ListExpressionHelper helper, ListChangeListener listener) {
if (listener == null) {
throw new NullPointerException();
}
return (helper == null)? null : helper.removeListener(listener);
}
public static void fireValueChangedEvent(ListExpressionHelper helper) {
if (helper != null) {
helper.fireValueChangedEvent();
}
}
public static void fireValueChangedEvent(ListExpressionHelper helper, Change change) {
if (helper != null) {
helper.fireValueChangedEvent(change);
}
}
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Common implementations
protected final ObservableListValue observable;
protected ListExpressionHelper(ObservableListValue observable) {
this.observable = observable;
}
protected abstract ListExpressionHelper addListener(InvalidationListener listener);
protected abstract ListExpressionHelper removeListener(InvalidationListener listener);
protected abstract ListExpressionHelper addListener(ChangeListener> listener);
protected abstract ListExpressionHelper removeListener(ChangeListener> listener);
protected abstract ListExpressionHelper addListener(ListChangeListener listener);
protected abstract ListExpressionHelper removeListener(ListChangeListener listener);
protected abstract void fireValueChangedEvent();
protected abstract void fireValueChangedEvent(Change change);
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Implementations
private static class SingleInvalidation extends ListExpressionHelper {
private final InvalidationListener listener;
private SingleInvalidation(ObservableListValue observable, InvalidationListener listener) {
super(observable);
this.listener = listener;
}
@Override
protected ListExpressionHelper addListener(InvalidationListener listener) {
return new Generic(observable, this.listener, listener);
}
@Override
protected ListExpressionHelper removeListener(InvalidationListener listener) {
return (listener.equals(this.listener))? null : this;
}
@Override
protected ListExpressionHelper addListener(ChangeListener> listener) {
return new Generic(observable, this.listener, listener);
}
@Override
protected ListExpressionHelper removeListener(ChangeListener> listener) {
return this;
}
@Override
protected ListExpressionHelper addListener(ListChangeListener listener) {
return new Generic(observable, this.listener, listener);
}
@Override
protected ListExpressionHelper removeListener(ListChangeListener listener) {
return this;
}
@Override
protected void fireValueChangedEvent() {
listener.invalidated(observable);
}
@Override
protected void fireValueChangedEvent(Change change) {
listener.invalidated(observable);
}
}
private static class SingleChange extends ListExpressionHelper {
private final ChangeListener> listener;
private ObservableList currentValue;
private SingleChange(ObservableListValue observable, ChangeListener> listener) {
super(observable);
this.listener = listener;
this.currentValue = observable.getValue();
}
@Override
protected ListExpressionHelper addListener(InvalidationListener listener) {
return new Generic(observable, listener, this.listener);
}
@Override
protected ListExpressionHelper removeListener(InvalidationListener listener) {
return this;
}
@Override
protected ListExpressionHelper addListener(ChangeListener> listener) {
return new Generic(observable, this.listener, listener);
}
@Override
protected ListExpressionHelper removeListener(ChangeListener> listener) {
return (listener.equals(this.listener))? null : this;
}
@Override
protected ListExpressionHelper addListener(ListChangeListener listener) {
return new Generic(observable, this.listener, listener);
}
@Override
protected ListExpressionHelper removeListener(ListChangeListener listener) {
return this;
}
@Override
protected void fireValueChangedEvent() {
final ObservableList oldValue = currentValue;
currentValue = observable.getValue();
if (currentValue != oldValue) {
listener.changed(observable, oldValue, currentValue);
}
}
@Override
protected void fireValueChangedEvent(Change change) {
listener.changed(observable, currentValue, currentValue);
}
}
private static class SingleListChange extends ListExpressionHelper {
private final ListChangeListener listener;
private ObservableList currentValue;
private SingleListChange(ObservableListValue observable, ListChangeListener listener) {
super(observable);
this.listener = listener;
this.currentValue = observable.getValue();
}
@Override
protected ListExpressionHelper addListener(InvalidationListener listener) {
return new Generic(observable, listener, this.listener);
}
@Override
protected ListExpressionHelper removeListener(InvalidationListener listener) {
return this;
}
@Override
protected ListExpressionHelper addListener(ChangeListener> listener) {
return new Generic(observable, listener, this.listener);
}
@Override
protected ListExpressionHelper removeListener(ChangeListener> listener) {
return this;
}
@Override
protected ListExpressionHelper addListener(ListChangeListener listener) {
return new Generic(observable, this.listener, listener);
}
@Override
protected ListExpressionHelper removeListener(ListChangeListener listener) {
return (listener.equals(this.listener))? null : this;
}
@Override
protected void fireValueChangedEvent() {
final ObservableList oldValue = currentValue;
currentValue = observable.getValue();
if (currentValue != oldValue) {
final int safeSize = (currentValue == null)? 0 : currentValue.size();
final ObservableList safeOldValue = (oldValue == null)?
FXCollections.emptyObservableList()
: FXCollections.unmodifiableObservableList(oldValue);
final Change change = new NonIterableChange.GenericAddRemoveChange(0, safeSize, safeOldValue, observable);
listener.onChanged(change);
}
}
@Override
protected void fireValueChangedEvent(final Change change) {
listener.onChanged(new MappedChange(observable, change));
}
}
private static class Generic extends ListExpressionHelper {
private InvalidationListener[] invalidationListeners;
private ChangeListener>[] changeListeners;
private ListChangeListener[] listChangeListeners;
private int invalidationSize;
private int changeSize;
private int listChangeSize;
private boolean locked;
private ObservableList currentValue;
private Generic(ObservableListValue observable, InvalidationListener listener0, InvalidationListener listener1) {
super(observable);
this.invalidationListeners = new InvalidationListener[] {listener0, listener1};
this.invalidationSize = 2;
}
private Generic(ObservableListValue observable, ChangeListener> listener0, ChangeListener> listener1) {
super(observable);
this.changeListeners = new ChangeListener[] {listener0, listener1};
this.changeSize = 2;
this.currentValue = observable.getValue();
}
private Generic(ObservableListValue observable, ListChangeListener listener0, ListChangeListener listener1) {
super(observable);
this.listChangeListeners = new ListChangeListener[] {listener0, listener1};
this.listChangeSize = 2;
this.currentValue = observable.getValue();
}
private Generic(ObservableListValue observable, InvalidationListener invalidationListener, ChangeListener> changeListener) {
super(observable);
this.invalidationListeners = new InvalidationListener[] {invalidationListener};
this.invalidationSize = 1;
this.changeListeners = new ChangeListener[] {changeListener};
this.changeSize = 1;
this.currentValue = observable.getValue();
}
private Generic(ObservableListValue observable, InvalidationListener invalidationListener, ListChangeListener listChangeListener) {
super(observable);
this.invalidationListeners = new InvalidationListener[] {invalidationListener};
this.invalidationSize = 1;
this.listChangeListeners = new ListChangeListener[] {listChangeListener};
this.listChangeSize = 1;
this.currentValue = observable.getValue();
}
private Generic(ObservableListValue observable, ChangeListener> changeListener, ListChangeListener listChangeListener) {
super(observable);
this.changeListeners = new ChangeListener[] {changeListener};
this.changeSize = 1;
this.listChangeListeners = new ListChangeListener[] {listChangeListener};
this.listChangeSize = 1;
this.currentValue = observable.getValue();
}
@Override
protected ListExpressionHelper addListener(InvalidationListener listener) {
if (invalidationListeners == null) {
invalidationListeners = new InvalidationListener[] {listener};
invalidationSize = 1;
} else {
final int oldCapacity = invalidationListeners.length;
if (locked) {
final int newCapacity = (invalidationSize < oldCapacity)? oldCapacity : (oldCapacity * 3)/2 + 1;
invalidationListeners = Arrays.copyOf(invalidationListeners, newCapacity);
} else if (invalidationSize == oldCapacity) {
invalidationSize = trim(invalidationSize, invalidationListeners);
if (invalidationSize == oldCapacity) {
final int newCapacity = (oldCapacity * 3)/2 + 1;
invalidationListeners = Arrays.copyOf(invalidationListeners, newCapacity);
}
}
invalidationListeners[invalidationSize++] = listener;
}
return this;
}
@Override
protected ListExpressionHelper removeListener(InvalidationListener listener) {
if (invalidationListeners != null) {
for (int index = 0; index < invalidationSize; index++) {
if (listener.equals(invalidationListeners[index])) {
if (invalidationSize == 1) {
if ((changeSize == 1) && (listChangeSize == 0)) {
return new SingleChange(observable, changeListeners[0]);
} else if ((changeSize == 0) && (listChangeSize == 1)) {
return new SingleListChange(observable, listChangeListeners[0]);
}
invalidationListeners = null;
invalidationSize = 0;
} else if ((invalidationSize == 2) && (changeSize == 0) && (listChangeSize == 0)) {
return new SingleInvalidation(observable, invalidationListeners[1-index]);
} else {
final int numMoved = invalidationSize - index - 1;
final InvalidationListener[] oldListeners = invalidationListeners;
if (locked) {
invalidationListeners = new InvalidationListener[invalidationListeners.length];
System.arraycopy(oldListeners, 0, invalidationListeners, 0, index+1);
}
if (numMoved > 0) {
System.arraycopy(oldListeners, index+1, invalidationListeners, index, numMoved);
}
invalidationSize--;
if (!locked) {
invalidationListeners[invalidationSize] = null; // Let gc do its work
}
}
break;
}
}
}
return this;
}
@Override
protected ListExpressionHelper addListener(ChangeListener> listener) {
if (changeListeners == null) {
changeListeners = new ChangeListener[] {listener};
changeSize = 1;
} else {
final int oldCapacity = changeListeners.length;
if (locked) {
final int newCapacity = (changeSize < oldCapacity)? oldCapacity : (oldCapacity * 3)/2 + 1;
changeListeners = Arrays.copyOf(changeListeners, newCapacity);
} else if (changeSize == oldCapacity) {
changeSize = trim(changeSize, changeListeners);
if (changeSize == oldCapacity) {
final int newCapacity = (oldCapacity * 3)/2 + 1;
changeListeners = Arrays.copyOf(changeListeners, newCapacity);
}
}
changeListeners[changeSize++] = listener;
}
if (changeSize == 1) {
currentValue = observable.getValue();
}
return this;
}
@Override
protected ListExpressionHelper removeListener(ChangeListener> listener) {
if (changeListeners != null) {
for (int index = 0; index < changeSize; index++) {
if (listener.equals(changeListeners[index])) {
if (changeSize == 1) {
if ((invalidationSize == 1) && (listChangeSize == 0)) {
return new SingleInvalidation(observable, invalidationListeners[0]);
} else if ((invalidationSize == 0) && (listChangeSize == 1)) {
return new SingleListChange(observable, listChangeListeners[0]);
}
changeListeners = null;
changeSize = 0;
} else if ((changeSize == 2) && (invalidationSize == 0) && (listChangeSize == 0)) {
return new SingleChange(observable, changeListeners[1-index]);
} else {
final int numMoved = changeSize - index - 1;
final ChangeListener>[] oldListeners = changeListeners;
if (locked) {
changeListeners = new ChangeListener[changeListeners.length];
System.arraycopy(oldListeners, 0, changeListeners, 0, index+1);
}
if (numMoved > 0) {
System.arraycopy(oldListeners, index+1, changeListeners, index, numMoved);
}
changeSize--;
if (!locked) {
changeListeners[changeSize] = null; // Let gc do its work
}
}
break;
}
}
}
return this;
}
@Override
protected ListExpressionHelper addListener(ListChangeListener listener) {
if (listChangeListeners == null) {
listChangeListeners = new ListChangeListener[] {listener};
listChangeSize = 1;
} else {
final int oldCapacity = listChangeListeners.length;
if (locked) {
final int newCapacity = (listChangeSize < oldCapacity)? oldCapacity : (oldCapacity * 3)/2 + 1;
listChangeListeners = Arrays.copyOf(listChangeListeners, newCapacity);
} else if (listChangeSize == oldCapacity) {
listChangeSize = trim(listChangeSize, listChangeListeners);
if (listChangeSize == oldCapacity) {
final int newCapacity = (oldCapacity * 3)/2 + 1;
listChangeListeners = Arrays.copyOf(listChangeListeners, newCapacity);
}
}
listChangeListeners[listChangeSize++] = listener;
}
if (listChangeSize == 1) {
currentValue = observable.getValue();
}
return this;
}
@Override
protected ListExpressionHelper removeListener(ListChangeListener listener) {
if (listChangeListeners != null) {
for (int index = 0; index < listChangeSize; index++) {
if (listener.equals(listChangeListeners[index])) {
if (listChangeSize == 1) {
if ((invalidationSize == 1) && (changeSize == 0)) {
return new SingleInvalidation(observable, invalidationListeners[0]);
} else if ((invalidationSize == 0) && (changeSize == 1)) {
return new SingleChange(observable, changeListeners[0]);
}
listChangeListeners = null;
listChangeSize = 0;
} else if ((listChangeSize == 2) && (invalidationSize == 0) && (changeSize == 0)) {
return new SingleListChange(observable, listChangeListeners[1-index]);
} else {
final int numMoved = listChangeSize - index - 1;
final ListChangeListener[] oldListeners = listChangeListeners;
if (locked) {
listChangeListeners = new ListChangeListener[listChangeListeners.length];
System.arraycopy(oldListeners, 0, listChangeListeners, 0, index+1);
}
if (numMoved > 0) {
System.arraycopy(oldListeners, index+1, listChangeListeners, index, numMoved);
}
listChangeSize--;
if (!locked) {
listChangeListeners[listChangeSize] = null; // Let gc do its work
}
}
break;
}
}
}
return this;
}
@Override
protected void fireValueChangedEvent() {
if ((changeSize == 0) && (listChangeSize == 0)) {
notifyListeners(currentValue, null, false);
} else {
final ObservableList oldValue = currentValue;
currentValue = observable.getValue();
if ((currentValue == null)? (oldValue != null) : !currentValue.equals(oldValue)) {
Change change = null;
if (listChangeSize > 0) {
final int safeSize = (currentValue == null)? 0 : currentValue.size();
final ObservableList safeOldValue = (oldValue == null)?
FXCollections.emptyObservableList()
: FXCollections.unmodifiableObservableList(oldValue);
change = new NonIterableChange.GenericAddRemoveChange(0, safeSize, safeOldValue, observable);
}
notifyListeners(oldValue, change, false);
} else {
notifyListeners(currentValue, null, true);
}
}
}
@Override
protected void fireValueChangedEvent(final Change change) {
final Change mappedChange = (listChangeSize == 0)? null : new MappedChange(observable, change);
notifyListeners(currentValue, mappedChange, false);
}
private void notifyListeners(ObservableList oldValue, Change change, boolean noChange) {
final InvalidationListener[] curInvalidationList = invalidationListeners;
final int curInvalidationSize = invalidationSize;
final ChangeListener>[] curChangeList = changeListeners;
final int curChangeSize = changeSize;
final ListChangeListener[] curListChangeList = listChangeListeners;
final int curListChangeSize = listChangeSize;
try {
locked = true;
for (int i = 0; i < curInvalidationSize; i++) {
curInvalidationList[i].invalidated(observable);
}
if (!noChange) {
for (int i = 0; i < curChangeSize; i++) {
curChangeList[i].changed(observable, oldValue, currentValue);
}
if (change != null) {
for (int i = 0; i < curListChangeSize; i++) {
change.reset();
curListChangeList[i].onChanged(change);
}
}
}
} finally {
locked = false;
}
}
}
private static class MappedChange extends Change {
private final Change source;
private int[] perm;
private MappedChange(ObservableList list, Change source) {
super(list);
this.source = source;
}
@Override public boolean next() {return source.next();}
@Override public void reset() {source.reset();}
@Override public int getFrom() {return source.getFrom();}
@Override public int getTo() {return source.getTo();}
@Override public List getRemoved() {return (List)source.getRemoved();}
@Override protected int[] getPermutation() {
if (perm == null) {
if (source.wasPermutated()) {
final int from = source.getFrom();
final int n = source.getTo() - from;
perm = new int[n];
for (int i=0; i