ReactFX 2.0-M5 · org.reactfx.EventStreams · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
private static class	EventStreams.ExclusivePocket<T>
private static class	EventStreams.Never<T>
private static class	EventStreams.Pocket<T>

Modifier and Type	Field and Description
private static final EventStream<?>	NEVER

Access	Constructor and Description
public	EventStreams()

Method Summary

Modifier and Type	Method and Description
public static EventStream<Long>	animationFrames() Returns a stream that, on each animation frame, emits the duration elapsed since the previous animation frame, in nanoseconds.
public static EventStream<Long>	animationTicks() Returns an event stream that emits a timestamp of the current frame in nanoseconds on every frame.
public static <T> EventStream<Change<T>>	changesOf(ObservableValue<T> observable)
public static <T> EventStream<ListChangeListener.Change<? extends T>>	changesOf(ObservableList<T> list)
public static <T> EventStream<SetChangeListener.Change<? extends T>>	changesOf(ObservableSet<T> set)
public static <K, V> EventStream<MapChangeListener.Change<? extends K, ? extends V>>	changesOf(ObservableMap<K, V> map)
public static <A, B> EventStream<Tuple2<A, B>>	combine(EventStream<A> srcA, EventStream<B> srcB)
public static <A, B, C> EventStream<Tuple3<A, B, C>>	combine(EventStream<A> srcA, EventStream<B> srcB, EventStream<C> srcC)
public static <A, B, C, D> EventStream<Tuple4<A, B, C, D>>	combine(EventStream<A> srcA, EventStream<B> srcB, EventStream<C> srcC, EventStream<D> srcD)
public static <A, B, C, D, E> EventStream<Tuple5<A, B, C, D, E>>	combine(EventStream<A> srcA, EventStream<B> srcB, EventStream<C> srcC, EventStream<D> srcD, EventStream<E> srcE)
public static <A, B, C, D, E, F> EventStream<Tuple6<A, B, C, D, E, F>>	combine(EventStream<A> srcA, EventStream<B> srcB, EventStream<C> srcC, EventStream<D> srcD, EventStream<E> srcE, EventStream<F> srcF)
private static <T> EventStream<T>	create(Supplier<? extends T> computeValue, Observable... dependencies)
public static <T extends Event> EventStream<T>	eventsOf(Node node, EventType<T> eventType)
public static <T extends Event> EventStream<T>	eventsOf(Scene scene, EventType<T> eventType)
public static <T extends Event> EventStream<T>	eventsOf(MenuItem menuItem, EventType<T> eventType)
public static <T extends Event> EventStream<T>	eventsOf(Window window, EventType<T> eventType)
public static <L, R> Tuple2<EventStream<L>, EventStream<R>>	fork(EventStream<? extends Either<L, R>> stream)
public static EventStream<Void>	invalidationsOf(Observable observable) Creates an event stream that emits an impulse on every invalidation of the given observable.
public static <T> EventStream<T>	merge(EventStream<? extends T>... inputs) Returns an event stream that emits all the events emitted from any of the `inputs`.
public static <T> EventStream<T>	merge(ObservableSet<? extends EventStream<T>> set) Returns an event stream that emits all the events emitted from any of the event streams in the given observable set.
public static <T, U> EventStream<U>	merge(ObservableSet<? extends T> observable set of elements set, Function<? super T, ? extends EventStream<U>> function to obtain an event stream from an element f) A more general version of `merge(ObservableSet)` for a set of arbitrary element type and a function to obtain an event stream from the element.
public static <T> EventStream<T>	never() Returns an event stream that never emits any value.
public static <T> EventStream<T>	nonNullValuesOf(ObservableValue<T> observable)
public static <O extends Observable> EventStream<O>	repeatOnInvalidation(O observable) Creates an event stream that emits the given observable immediately for every subscriber and re-emits it on every subsequent invalidation of the observable.
public static EventStream<?>	restartableTicks(Duration - the amount of time that passes until this stream emits its next tick interval, EventStream<?> - the EventStream that resets this EventStream's internal timer impulse) Returns a `ticks(Duration)` EventStream whose timer restarts whenever impulse emits an event.
public static EventStream<?>	restartableTicks0(Duration - the amount of time that passes until this stream emits its next tick interval, EventStream<?> - the EventStream that resets this EventStream's internal timer impulse) Returns a `ticks0(Duration)` EventStream whose timer restarts whenever impulse emits an event.
public static <T> EventStream<ListModification<? extends T>>	simpleChangesOf(ObservableList<T> list) Use only when the subscriber does not cause `list` modification of the underlying list.
public static <C extends Collection<?> & Observable> EventStream<Integer>	sizeOf(C collection)
public static EventStream<Integer>	sizeOf(ObservableMap<?, ?> map)
public static EventStream<?>	ticks(Duration interval) Returns an event stream that emits periodic ticks.
public static EventStream<?>	ticks(Duration interval, ScheduledExecutorService scheduler used to schedule periodic emissions. scheduler, Executor single-thread executor used to emit the ticks. eventThreadExecutor) Returns an event stream that emits periodic ticks on the given `eventThreadExecutor`.
public static EventStream<?>	ticks0(Duration interval) Returns an event stream that emits periodic ticks.
public static <T> EventStream<T>	valuesOf(ObservableValue<T> observable) Creates an event stream that emits the value of the given `ObservableValue` immediately for every subscriber and then on every change.
public static <A, B> EventStream<Tuple2<A, B>>	zip(EventStream<A> srcA, EventStream<B> srcB)
public static <A, B, C> EventStream<Tuple3<A, B, C>>	zip(EventStream<A> srcA, EventStream<B> srcB, EventStream<C> srcC)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

NEVER	back to summary
private static final EventStream<?> NEVER

EventStreams	back to summary
public EventStreams()

Method Detail

animationFrames	back to summary
public static EventStream<Long> animationFrames() Returns a stream that, on each animation frame, emits the duration elapsed since the previous animation frame, in nanoseconds.

animationTicks	back to summary
public static EventStream<Long> animationTicks() Returns an event stream that emits a timestamp of the current frame in nanoseconds on every frame. The timestamp has the same meaning as the argument of the `AnimationTimer#handle(long)` method.

changesOf	back to summary
public static <T> EventStream<Change<T>> changesOf(ObservableValue<T> observable)

changesOf	back to summary
public static <T> EventStream<ListChangeListener.Change<? extends T>> changesOf(ObservableList<T> list) See Also `LiveList#changesOf(ObservableList)`

changesOf	back to summary
public static <T> EventStream<SetChangeListener.Change<? extends T>> changesOf(ObservableSet<T> set)

changesOf	back to summary
public static <K, V> EventStream<MapChangeListener.Change<? extends K, ? extends V>> changesOf(ObservableMap<K, V> map)

combine	back to summary
public static <A, B> EventStream<Tuple2<A, B>> combine(EventStream<A> srcA, EventStream<B> srcB)

combine	back to summary
public static <A, B, C> EventStream<Tuple3<A, B, C>> combine(EventStream<A> srcA, EventStream<B> srcB, EventStream<C> srcC)

combine	back to summary
public static <A, B, C, D> EventStream<Tuple4<A, B, C, D>> combine(EventStream<A> srcA, EventStream<B> srcB, EventStream<C> srcC, EventStream<D> srcD)

combine	back to summary
public static <A, B, C, D, E> EventStream<Tuple5<A, B, C, D, E>> combine(EventStream<A> srcA, EventStream<B> srcB, EventStream<C> srcC, EventStream<D> srcD, EventStream<E> srcE)

combine	back to summary
public static <A, B, C, D, E, F> EventStream<Tuple6<A, B, C, D, E, F>> combine(EventStream<A> srcA, EventStream<B> srcB, EventStream<C> srcC, EventStream<D> srcD, EventStream<E> srcE, EventStream<F> srcF)

create	back to summary
private static <T> EventStream<T> create(Supplier<? extends T> computeValue, Observable... dependencies)

eventsOf	back to summary
public static <T extends Event> EventStream<T> eventsOf(Node node, EventType<T> eventType)

eventsOf	back to summary
public static <T extends Event> EventStream<T> eventsOf(Scene scene, EventType<T> eventType)

eventsOf	back to summary
public static <T extends Event> EventStream<T> eventsOf(MenuItem menuItem, EventType<T> eventType)

eventsOf	back to summary
public static <T extends Event> EventStream<T> eventsOf(Window window, EventType<T> eventType)

fork	back to summary
public static <L, R> Tuple2<EventStream<L>, EventStream<R>> fork(EventStream<? extends Either<L, R>> stream)

invalidationsOf	back to summary
public static EventStream<Void> invalidationsOf(Observable observable) Creates an event stream that emits an impulse on every invalidation of the given observable.

merge back to summary

merge	back to summary
public static <T> EventStream<T> merge(EventStream<? extends T>... inputs) Returns an event stream that emits all the events emitted from any of the `inputs`. The event type of the returned stream is the nearest common super-type of all the `inputs`. Annotations @SafeVarargs See Also `EventStream#or(EventStream)`

public static <T> EventStream<T> merge(EventStream<? extends T>... inputs)

Returns an event stream that emits all the events emitted from any of the inputs. The event type of the returned stream is the nearest common super-type of all the inputs.

Annotations

@SafeVarargs

See Also

EventStream#or(EventStream)

merge	back to summary
public static <T> EventStream<T> merge(ObservableSet<? extends EventStream<T>> set) Returns an event stream that emits all the events emitted from any of the event streams in the given observable set. When an event stream is added to the set, the returned stream will start emitting its events. When an event stream is removed from the set, its events will no longer be emitted from the returned stream.

merge

back to summary

public static <T> EventStream<T> merge(ObservableSet<? extends EventStream<T>> set)

Returns an event stream that emits all the events emitted from any of the event streams in the given observable set. When an event stream is added to the set, the returned stream will start emitting its events. When an event stream is removed from the set, its events will no longer be emitted from the returned stream.

merge back to summary

merge	back to summary
public static <T, U> EventStream<U> merge(ObservableSet<? extends T> set, Function<? super T, ? extends EventStream<U>> f) A more general version of `merge(ObservableSet)` for a set of arbitrary element type and a function to obtain an event stream from the element. Parameters set:ObservableSet<? extends T> observable set of elements f:Function<? super T, ? extends EventStream<U>> function to obtain an event stream from an element

public static <T, U> EventStream<U> merge(ObservableSet<? extends T> set, Function<? super T, ? extends EventStream<U>> f)

A more general version of merge(ObservableSet) for a set of arbitrary element type and a function to obtain an event stream from the element.

Parameters

set:ObservableSet<? extends T>: observable set of elements
f:Function<? super T, ? extends EventStream<U>>: function to obtain an event stream from an element

never	back to summary
public static <T> EventStream<T> never() Returns an event stream that never emits any value. Annotations @SuppressWarnings:unchecked

never

back to summary

public static <T> EventStream<T> never()

Returns an event stream that never emits any value.

Annotations

@SuppressWarnings:unchecked

nonNullValuesOf	back to summary
public static <T> EventStream<T> nonNullValuesOf(ObservableValue<T> observable)

repeatOnInvalidation	back to summary
public static <O extends Observable> EventStream<O> repeatOnInvalidation(O observable) Creates an event stream that emits the given observable immediately for every subscriber and re-emits it on every subsequent invalidation of the observable.

restartableTicks back to summary

restartableTicks	back to summary
public static EventStream<?> restartableTicks(Duration interval, EventStream<?> impulse) Returns a `ticks(Duration)` EventStream whose timer restarts whenever impulse emits an event. Parameters interval:Duration - the amount of time that passes until this stream emits its next tick impulse:EventStream<?> - the EventStream that resets this EventStream's internal timer

public static EventStream<?> restartableTicks(Duration interval, EventStream<?> impulse)

Returns a ticks(Duration) EventStream whose timer restarts whenever impulse emits an event.

Parameters

interval:Duration: - the amount of time that passes until this stream emits its next tick
impulse:EventStream<?>: - the EventStream that resets this EventStream's internal timer

restartableTicks0 back to summary

restartableTicks0	back to summary
public static EventStream<?> restartableTicks0(Duration interval, EventStream<?> impulse) Returns a `ticks0(Duration)` EventStream whose timer restarts whenever impulse emits an event. Note since `ticks0(Duration)` is used, restarting the timer will make the returned EventStream immediately emit a new tick. Parameters interval:Duration - the amount of time that passes until this stream emits its next tick impulse:EventStream<?> - the EventStream that resets this EventStream's internal timer

public static EventStream<?> restartableTicks0(Duration interval, EventStream<?> impulse)

Returns a ticks0(Duration) EventStream whose timer restarts whenever impulse emits an event.

Note

since ticks0(Duration) is used, restarting the timer will make the returned EventStream immediately emit a new tick.

Parameters

interval:Duration: - the amount of time that passes until this stream emits its next tick
impulse:EventStream<?>: - the EventStream that resets this EventStream's internal timer

simpleChangesOf	back to summary
public static <T> EventStream<ListModification<? extends T>> simpleChangesOf(ObservableList<T> list) Use only when the subscriber does not cause `list` modification of the underlying list.

sizeOf	back to summary
public static <C extends Collection<?> & Observable> EventStream<Integer> sizeOf(C collection)

sizeOf	back to summary
public static EventStream<Integer> sizeOf(ObservableMap<?, ?> map)

ticks back to summary

ticks	back to summary
public static EventStream<?> ticks(Duration interval) Returns an event stream that emits periodic ticks. The first tick is emitted after `interval` amount of time has passed. The returned stream may only be used on the JavaFX application thread. As with all lazily bound streams, ticks are emitted only when there is at least one subscriber to the returned stream. This means that to release associated resources, it suffices to unsubscribe from the returned stream.

public static EventStream<?> ticks(Duration interval)

Returns an event stream that emits periodic ticks. The first tick is emitted after interval amount of time has passed. The returned stream may only be used on the JavaFX application thread.

As with all lazily bound streams, ticks are emitted only when there is at least one subscriber to the returned stream. This means that to release associated resources, it suffices to unsubscribe from the returned stream.

ticks back to summary

ticks	back to summary
public static EventStream<?> ticks(Duration interval, ScheduledExecutorService scheduler, Executor eventThreadExecutor) Returns an event stream that emits periodic ticks on the given `eventThreadExecutor`. The returned stream may only be used from that executor's thread. As with all lazily bound streams, ticks are emitted only when there is at least one subscriber to the returned stream. This means that to release associated resources, it suffices to unsubscribe from the returned stream. Parameters scheduler:ScheduledExecutorService scheduler used to schedule periodic emissions. eventThreadExecutor:Executor single-thread executor used to emit the ticks.

public static EventStream<?> ticks(Duration interval, ScheduledExecutorService scheduler, Executor eventThreadExecutor)

Returns an event stream that emits periodic ticks on the given eventThreadExecutor. The returned stream may only be used from that executor's thread.

Parameters

scheduler:ScheduledExecutorService: scheduler used to schedule periodic emissions.
eventThreadExecutor:Executor: single-thread executor used to emit the ticks.

ticks0	back to summary
public static EventStream<?> ticks0(Duration interval) Returns an event stream that emits periodic ticks. The first tick is emitted at time 0. The returned stream may only be used on the JavaFX application thread. As with all lazily bound streams, ticks are emitted only when there is at least one subscriber to the returned stream. This means that to release associated resources, it suffices to unsubscribe from the returned stream.

ticks0

back to summary

public static EventStream<?> ticks0(Duration interval)

Returns an event stream that emits periodic ticks. The first tick is emitted at time 0. The returned stream may only be used on the JavaFX application thread.

valuesOf	back to summary
public static <T> EventStream<T> valuesOf(ObservableValue<T> observable) Creates an event stream that emits the value of the given `ObservableValue` immediately for every subscriber and then on every change.

zip	back to summary
public static <A, B> EventStream<Tuple2<A, B>> zip(EventStream<A> srcA, EventStream<B> srcB)

zip	back to summary
public static <A, B, C> EventStream<Tuple3<A, B, C>> zip(EventStream<A> srcA, EventStream<B> srcB, EventStream<C> srcC)

Modifier and Type	Method and Description
public void	clear()
public T	get()
public T	getAndClear()
public boolean	hasValue()
public void	set(T value)

public Class EventStreams

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class EventStreams.ExclusivePocket<T>

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class EventStreams.Never<T>

Constructor Summary

Method Summary

Constructor Detail

private Class EventStreams.Pocket<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail