hu.akarnokd.rxjava2.operators

Class FlowableTransformers

java.lang.Object

hu.akarnokd.rxjava2.operators.FlowableTransformers

public final class FlowableTransformers
extends java.lang.Object

Additional operators in the form of FlowableTransformer, use Flowable.compose(FlowableTransformer) to apply the operators to an existing sequence.

Since:

0.7.2

Method Summary

Modifier and Type	Method and Description
static <T> io.reactivex.FlowableTransformer<T,T>	valve(org.reactivestreams.Publisher<java.lang.Boolean> other) Relays values until the other Publisher signals false and resumes if the other Publisher signals true again, like closing and opening a valve and not losing any items from the main source.
static <T> io.reactivex.FlowableTransformer<T,T>	valve(org.reactivestreams.Publisher<java.lang.Boolean> other, boolean defaultOpen) Relays values until the other Publisher signals false and resumes if the other Publisher signals true again, like closing and opening a valve and not losing any items from the main source and starts with the specivied valve state.
static <T> io.reactivex.FlowableTransformer<T,T>	valve(org.reactivestreams.Publisher<java.lang.Boolean> other, boolean defaultOpen, int bufferSize) Relays values until the other Publisher signals false and resumes if the other Publisher signals true again, like closing and opening a valve and not losing any items from the main source and starts with the specivied valve state and the specified buffer size hint.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

valve

@SchedulerSupport(value="none")
 @BackpressureSupport(value=PASS_THROUGH)
public static <T> io.reactivex.FlowableTransformer<T,T> valve(org.reactivestreams.Publisher<java.lang.Boolean> other)

Relays values until the other Publisher signals false and resumes if the other Publisher signals true again, like closing and opening a valve and not losing any items from the main source.

Properties:

• The operator starts with an open valve.
• If the other Publisher completes, the sequence terminates with an IllegalStateException.
• The operator doesn't run on any particular Scheduler.
• The operator is a pass-through for backpressure and uses an internal unbounded buffer of size Flowable.bufferSize() to hold onto values if the valve is closed.

Type Parameters:

T - the value type of the main source

Parameters:

other - the other source

Returns:

the new FlowableTransformer instance

Throws:

java.lang.NullPointerException - if other is null

Since:

0.7.2

valve

public static <T> io.reactivex.FlowableTransformer<T,T> valve(org.reactivestreams.Publisher<java.lang.Boolean> other,
                                                              boolean defaultOpen)

Relays values until the other Publisher signals false and resumes if the other Publisher signals true again, like closing and opening a valve and not losing any items from the main source and starts with the specivied valve state.

Properties:

• If the other Publisher completes, the sequence terminates with an IllegalStateException.
• The operator doesn't run on any particular Scheduler.
• The operator is a pass-through for backpressure and uses an internal unbounded buffer of size Flowable.bufferSize() to hold onto values if the valve is closed.

Type Parameters:

T - the value type of the main source

Parameters:

other - the other source

defaultOpen - should the valve start as open?

Returns:

the new FlowableTransformer instance

Throws:

java.lang.NullPointerException - if other is null

Since:

0.7.2

valve

public static <T> io.reactivex.FlowableTransformer<T,T> valve(org.reactivestreams.Publisher<java.lang.Boolean> other,
                                                              boolean defaultOpen,
                                                              int bufferSize)

Relays values until the other Publisher signals false and resumes if the other Publisher signals true again, like closing and opening a valve and not losing any items from the main source and starts with the specivied valve state and the specified buffer size hint.

Properties:

• If the other Publisher completes, the sequence terminates with an IllegalStateException.
• The operator doesn't run on any particular Scheduler.

Type Parameters:

T - the value type of the main source

Parameters:

other - the other source

defaultOpen - should the valve start as open?

bufferSize - the buffer size hint (the chunk size of the underlying unbounded buffer)

Returns:

the new FlowableTransformer instance

Throws:

java.lang.IllegalArgumentException - if bufferSize <= 0

java.lang.NullPointerException - if other is null

Since:

0.7.2