org.datafx.concurrent.StreamFX Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of datafx-core Show documentation
There is a newer version: 8.0b5
/**
 * Copyright (c) 2011, 2013, Jonathan Giles, Johan Vos, Hendrik Ebbers
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *     * Neither the name of DataFX, the website javafxdata.org, nor the
 * names of its contributors may be used to endorse or promote products
 * derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL  BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.datafx.concurrent;

import java.util.function.Consumer;
import java.util.stream.Stream;

import javafx.application.Platform;
import javafx.beans.property.ObjectProperty;
import javafx.beans.property.SimpleObjectProperty;
import javafx.collections.ObservableList;

/**
 * Stream Helper class for JavaFX. Combines the Stream API with the JavaFX platform thread
 * @author Hendrik Ebbers
 *
 * @param  type of elements in Stream
 */
public class StreamFX {

    private Stream stream;

    /**
     * Create a StreamFX as a wrapper of a Stream
     * @param stream the stream to wrap
     */
    public StreamFX(Stream stream) {
        this.stream = stream;
    }

    /**
     * Performs an action for each element of this stream.
     * Each element is wrapped in a ObjectProperty and the action will run on the JavaFX Platform Thread
     * @param action action to perform on the elements
     */
    void forEach(final Consumer> action) {
        stream.forEach((Consumer) (t) -> {Platform.runLater(() -> action.accept(new SimpleObjectProperty(t)));});
    }

    /**
     * Performs an action for each element of this stream.
     * Each element is wrapped in a ObjectProperty and the action will run on the JavaFX Platform Thread
     * each element is processed in encounter order for streams that have a
     * defined encounter order
     * @param action action to perform on the elements
     */
    void forEachOrdered(final Consumer> action) {
        stream.forEachOrdered((Consumer) (t) -> {Platform.runLater(() -> action.accept(new SimpleObjectProperty(t)));});
    }

    /**
     * Publishes all elements of the stream to a ObservableList.
     * the action for each element will run on the JavaFX Platform Thread
     * @param list List to publish all elements to
     */
    public void publish(final ObservableList list) {
        stream.forEach((Consumer) (t) -> {Platform.runLater(() -> list.add(t));});
    }

    /**
     * Publishes all elements of the stream to a ObservableList.
     * the action for each element will run on the JavaFX Platform Thread
     * each element is processed in encounter order for streams that have a
     * defined encounter order
     * @param list List to publish all elements to
     */
    public void publishOrderer(final ObservableList list) {
        stream.forEachOrdered((Consumer) (t) -> {Platform.runLater(() -> list.add(t));});
    }
}