io.reactivex.flowable

Class RxJavaFlowablePlugins

java.lang.Object

io.reactivex.flowable.RxJavaFlowablePlugins

public final class RxJavaFlowablePlugins
extends java.lang.Object

Utility class to inject handlers to certain standard RxJava operations.

Method Summary

Modifier and Type	Method and Description
static io.reactivex.common.Scheduler	createComputationScheduler(java.util.concurrent.ThreadFactory threadFactory) Create an instance of the default Scheduler used for Schedulers.computation() except using threadFactory for thread creation.
static io.reactivex.common.Scheduler	createIoScheduler(java.util.concurrent.ThreadFactory threadFactory) Create an instance of the default Scheduler used for Schedulers.io() except using threadFactory for thread creation.
static io.reactivex.common.Scheduler	createNewThreadScheduler(java.util.concurrent.ThreadFactory threadFactory) Create an instance of the default Scheduler used for Schedulers.newThread() except using threadFactory for thread creation.
static io.reactivex.common.Scheduler	createSingleScheduler(java.util.concurrent.ThreadFactory threadFactory) Create an instance of the default Scheduler used for Schedulers.single() except using threadFactory for thread creation.
static io.reactivex.common.functions.Function<? super ConnectableFlowable,? extends ConnectableFlowable>	getOnConnectableFlowableAssembly() Returns the current hook function.
static io.reactivex.common.functions.Function<? super Flowable,? extends Flowable>	getOnFlowableAssembly() Returns the current hook function.
static io.reactivex.common.functions.BiFunction<? super Flowable,? super org.reactivestreams.Subscriber,? extends org.reactivestreams.Subscriber>	getOnFlowableSubscribe() Returns the current hook function.
static io.reactivex.common.functions.Function<? super ParallelFlowable,? extends ParallelFlowable>	getOnParallelAssembly() Returns the current hook function.
static boolean	isLockdown() Returns true if the plugins were locked down.
static void	lockdown() Prevents changing the plugins from then on.
static <T> ConnectableFlowable<T>	onAssembly(ConnectableFlowable<T> source) Calls the associated hook function.
static <T> Flowable<T>	onAssembly(Flowable<T> source) Calls the associated hook function.
static <T> ParallelFlowable<T>	onAssembly(ParallelFlowable<T> source) Calls the associated hook function.
static <T> org.reactivestreams.Subscriber<? super T>	onSubscribe(Flowable<T> source, org.reactivestreams.Subscriber<? super T> subscriber) Calls the associated hook function.
static void	reset() Removes all handlers and resets to default behavior.
static void	setOnConnectableFlowableAssembly(io.reactivex.common.functions.Function<? super ConnectableFlowable,? extends ConnectableFlowable> onConnectableFlowableAssembly) Sets the specific hook function.
static void	setOnFlowableAssembly(io.reactivex.common.functions.Function<? super Flowable,? extends Flowable> onFlowableAssembly) Sets the specific hook function.
static void	setOnFlowableSubscribe(io.reactivex.common.functions.BiFunction<? super Flowable,? super org.reactivestreams.Subscriber,? extends org.reactivestreams.Subscriber> onFlowableSubscribe) Sets the specific hook function.
static void	setOnParallelAssembly(io.reactivex.common.functions.Function<? super ParallelFlowable,? extends ParallelFlowable> handler) Sets the specific hook function.

Methods inherited from class java.lang.Object

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

Method Detail

lockdown

public static void lockdown()

Prevents changing the plugins from then on.

This allows container-like environments to prevent clients messing with plugins.

isLockdown

public static boolean isLockdown()

Returns true if the plugins were locked down.

Returns:

true if the plugins were locked down

reset

public static void reset()

Removes all handlers and resets to default behavior.

getOnFlowableAssembly

@Nullable
public static io.reactivex.common.functions.Function<? super Flowable,? extends Flowable> getOnFlowableAssembly()

Returns the current hook function.

Returns:

the hook function, may be null

getOnConnectableFlowableAssembly

@Nullable
public static io.reactivex.common.functions.Function<? super ConnectableFlowable,? extends ConnectableFlowable> getOnConnectableFlowableAssembly()

Returns the current hook function.

Returns:

the hook function, may be null

getOnFlowableSubscribe

@Nullable
public static io.reactivex.common.functions.BiFunction<? super Flowable,? super org.reactivestreams.Subscriber,? extends org.reactivestreams.Subscriber> getOnFlowableSubscribe()

Returns the current hook function.

Returns:

the hook function, may be null

setOnFlowableAssembly

public static void setOnFlowableAssembly(@Nullable
                                         io.reactivex.common.functions.Function<? super Flowable,? extends Flowable> onFlowableAssembly)

Sets the specific hook function.

Parameters:

onFlowableAssembly - the hook function to set, null allowed

setOnConnectableFlowableAssembly

public static void setOnConnectableFlowableAssembly(@Nullable
                                                    io.reactivex.common.functions.Function<? super ConnectableFlowable,? extends ConnectableFlowable> onConnectableFlowableAssembly)

Sets the specific hook function.

Parameters:

onConnectableFlowableAssembly - the hook function to set, null allowed

setOnFlowableSubscribe

public static void setOnFlowableSubscribe(@Nullable
                                          io.reactivex.common.functions.BiFunction<? super Flowable,? super org.reactivestreams.Subscriber,? extends org.reactivestreams.Subscriber> onFlowableSubscribe)

Sets the specific hook function.

Parameters:

onFlowableSubscribe - the hook function to set, null allowed

onSubscribe

@NonNull
public static <T> org.reactivestreams.Subscriber<? super T> onSubscribe(@NonNull
                                                                                  Flowable<T> source,
                                                                                  @NonNull
                                                                                  org.reactivestreams.Subscriber<? super T> subscriber)

Calls the associated hook function.

Type Parameters:

T - the value type

Parameters:

source - the hook's input value

subscriber - the subscriber

Returns:

the value returned by the hook

onAssembly

@NonNull
public static <T> Flowable<T> onAssembly(@NonNull
                                                   Flowable<T> source)

Calls the associated hook function.

Type Parameters:

T - the value type

Parameters:

source - the hook's input value

Returns:

the value returned by the hook

onAssembly

@NonNull
public static <T> ConnectableFlowable<T> onAssembly(@NonNull
                                                              ConnectableFlowable<T> source)

Calls the associated hook function.

Type Parameters:

T - the value type

Parameters:

source - the hook's input value

Returns:

the value returned by the hook

setOnParallelAssembly

public static void setOnParallelAssembly(@Nullable
                                         io.reactivex.common.functions.Function<? super ParallelFlowable,? extends ParallelFlowable> handler)

Sets the specific hook function.

Parameters:

handler - the hook function to set, null allowed

Since:

2.0.6 - experimental

getOnParallelAssembly

@Nullable
public static io.reactivex.common.functions.Function<? super ParallelFlowable,? extends ParallelFlowable> getOnParallelAssembly()

Returns the current hook function.

Returns:

the hook function, may be null

Since:

2.0.6 - experimental

onAssembly

@NonNull
public static <T> ParallelFlowable<T> onAssembly(@NonNull
                                                           ParallelFlowable<T> source)

Calls the associated hook function.

Type Parameters:

T - the value type of the source

Parameters:

source - the hook's input value

Returns:

the value returned by the hook

Since:

2.0.6 - experimental

createComputationScheduler

@NonNull
public static io.reactivex.common.Scheduler createComputationScheduler(@NonNull
                                                                                 java.util.concurrent.ThreadFactory threadFactory)

Create an instance of the default Scheduler used for Schedulers.computation() except using threadFactory for thread creation.

Parameters:

threadFactory - thread factory to use for creating worker threads. Note that this takes precedence over any system properties for configuring new thread creation. Cannot be null.

Returns:

the created Scheduler instance

Since:

2.0.5 - experimental

createIoScheduler

@NonNull
public static io.reactivex.common.Scheduler createIoScheduler(@NonNull
                                                                        java.util.concurrent.ThreadFactory threadFactory)

Create an instance of the default Scheduler used for Schedulers.io() except using threadFactory for thread creation.

Parameters:

threadFactory - thread factory to use for creating worker threads. Note that this takes precedence over any system properties for configuring new thread creation. Cannot be null.

Returns:

the created Scheduler instance

Since:

2.0.5 - experimental

createNewThreadScheduler

@NonNull
public static io.reactivex.common.Scheduler createNewThreadScheduler(@NonNull
                                                                               java.util.concurrent.ThreadFactory threadFactory)

Create an instance of the default Scheduler used for Schedulers.newThread() except using threadFactory for thread creation.

Parameters:

threadFactory - thread factory to use for creating worker threads. Note that this takes precedence over any system properties for configuring new thread creation. Cannot be null.

Returns:

the created Scheduler instance

Since:

2.0.5 - experimental

createSingleScheduler

@NonNull
public static io.reactivex.common.Scheduler createSingleScheduler(@NonNull
                                                                            java.util.concurrent.ThreadFactory threadFactory)

Create an instance of the default Scheduler used for Schedulers.single() except using threadFactory for thread creation.

Parameters:

threadFactory - thread factory to use for creating worker threads. Note that this takes precedence over any system properties for configuring new thread creation. Cannot be null.

Returns:

the created Scheduler instance

Since:

2.0.5 - experimental