Added method to map the values of an ObservableList prior to linking them to a ListProperty from JavaFX. This does not work with sets as there's no guarantee the mapper will consistently return the same object for a given input object.

Author: FHannes

build.gradle

@@ -4,7 +4,7 @@ subprojects {
     apply plugin: 'signing'
 
     group 'net.fhannes.rx'
-    version '0.2.0'
+    version '0.2.1'
     archivesBaseName = "rxjavacollections"
 
     sourceCompatibility = 1.8

core/src/main/java/net/fhannes/rx/collections/ObservableList.java

@@ -18,7 +18,6 @@
  */
 package net.fhannes.rx.collections;
 
-import com.sun.javafx.scene.transform.TransformUtils;
 import io.reactivex.Observable;
 import io.reactivex.subjects.BehaviorSubject;
 import io.reactivex.subjects.PublishSubject;

core/src/main/java/net/fhannes/rx/collections/util/Pair.java

@@ -21,7 +21,7 @@
 import java.util.Objects;
 
 /**
- * A utility class representing a pair of objects.
+ * An immutable  utility class representing a pair of objects.
  *
  * @param <A> The type of the first object.
  * @param <B> The type of the second object.
@@ -48,10 +48,20 @@ public static <A, B> Pair<A, B> of(A a, Pair<?, B> p) {
         this.b = b;
     }
 
+    /**
+     * Returns the first value of the value pair.
+     *
+     * @return The stored object.
+     */
     public A getA() {
         return a;
     }
 
+    /**
+     * Returns the second value of the value pair.
+     *
+     * @return The stored object.
+     */
     public B getB() {
         return b;
     }

javafx/src/main/java/net/fhannes/rx/collections/fx/JavaFXAdaptor.java

@@ -18,6 +18,7 @@
  */
 package net.fhannes.rx.collections.fx;
 
+import io.reactivex.functions.Function;
 import net.fhannes.rx.collections.ObservableList;
 import net.fhannes.rx.collections.ObservableSet;
 
@@ -35,6 +36,27 @@ private JavaFXAdaptor() {
 
     }
 
+    /**
+     * Creates an adaptor which maps an {@link ObservableList} object from RxJavaCollections onto a new
+     * {@link javafx.collections.ObservableList} from JavaFX. The method takes a mapper argument to map the elements in
+     * the given observable to a different value.
+     *
+     * @param list The given reactive list.
+     * @param mapper Maps the elements of the given list to a different value.
+     * @param <E> The type of the elements stored in the list.
+     * @param <R> The type of the mapped elements stored in the {@link javafx.collections.ObservableList} object.
+     * @return The newly constructed list which updates automatically when the given list is updated.
+     */
+    public static <E, R> javafx.collections.ObservableList<R> adapt(ObservableList<E> list,
+                                                                    Function<? super E, ? extends R> mapper) {
+        javafx.collections.ObservableList<R> newList = javafx.collections.FXCollections.observableArrayList();
+        list.observable().map(mapper).subscribe(newList::add);
+        list.onAdded().subscribe(c -> newList.add(c.getIndex(), mapper.apply(c.getValue())));
+        list.onRemoved().subscribe(c -> newList.remove(c.getIndex()));
+        list.onUpdatedChanged().subscribe(c -> newList.set(c.getIndex(), mapper.apply(c.getValue())));
+        return newList;
+    }
+
     /**
      * Creates an adaptor which maps an {@link ObservableList} object from RxJavaCollections onto a new
      * {@link javafx.collections.ObservableList} from JavaFX.
@@ -56,15 +78,15 @@ public static <E> javafx.collections.ObservableList<E> adapt(ObservableList<E> l
      * Creates an adaptor which maps an {@link ObservableSet} object from RxJavaCollections onto a new
      * {@link javafx.collections.ObservableSet} from JavaFX.
      *
-     * @param list The given reactive set.
+     * @param set The given reactive set.
      * @param <E> The type of the elements stored in the set.
      * @return The newly constructed set which updates automatically when the given set is updated.
      */
-    public static <E> javafx.collections.ObservableSet<E> adapt(ObservableSet<E> list) {
+    public static <E> javafx.collections.ObservableSet<E> adapt(ObservableSet<E> set) {
         javafx.collections.ObservableSet<E> newSet = javafx.collections.FXCollections.observableSet(new HashSet<>());
-        list.observable().subscribe(newSet::add);
-        list.onAdded().subscribe(newSet::add);
-        list.onRemoved().subscribe(newSet::remove);
+        set.observable().subscribe(newSet::add);
+        set.onAdded().subscribe(newSet::add);
+        set.onRemoved().subscribe(newSet::remove);
         return newSet;
     }