org.reactfx.Connectable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of reactfx Show documentation

Reactive event streams for JavaFX

There is a newer version: 2.0-M5

package org.reactfx;

/**
 * Interface for objects that can be (lazily) connected to event streams.
 * The semantics of a connection is left to the implementations of this
 * interface.
 */
public interface Connectable {

    /**
     * Connects this connectable object to {@code source} event stream.
     * Implementations of this method should subscribe to {@code source}
     * lazily, i.e. only subscribe to {@code source} when necessary, e.g.
     * when the connectable object itself is being observed (e.g. itself
     * has at least one subscriber).
     * A {@code Connectable} may be connected to multiple sources at
     * the same time.
     * @param source event stream to (lazily) connect to.
     * @return subscription that can be used to disconnect this connectable
     * object from {@code source}.
     */
    Subscription connectTo(EventStream source);
}