io.reactivex.plugins

Class RxJavaPlugins

java.lang.Object

io.reactivex.plugins.RxJavaPlugins

public final class RxJavaPlugins
extends java.lang.Object

Utility class to inject handlers to certain standard RxJava operations.

Method Summary

Methods

Modifier and Type	Method and Description
static 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 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 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 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 Function<? super Scheduler,? extends Scheduler>	getComputationSchedulerHandler() Returns the current hook function.
static Consumer<? super java.lang.Throwable>	getErrorHandler() Returns the a hook consumer.
static Function<? super java.util.concurrent.Callable<Scheduler>,? extends Scheduler>	getInitComputationSchedulerHandler() Returns the current hook function.
static Function<? super java.util.concurrent.Callable<Scheduler>,? extends Scheduler>	getInitIoSchedulerHandler() Returns the current hook function.
static Function<? super java.util.concurrent.Callable<Scheduler>,? extends Scheduler>	getInitNewThreadSchedulerHandler() Returns the current hook function.
static Function<? super java.util.concurrent.Callable<Scheduler>,? extends Scheduler>	getInitSingleSchedulerHandler() Returns the current hook function.
static Function<? super Scheduler,? extends Scheduler>	getIoSchedulerHandler() Returns the current hook function.
static Function<? super Scheduler,? extends Scheduler>	getNewThreadSchedulerHandler() Returns the current hook function.
static BooleanSupplier	getOnBeforeBlocking() Returns the current blocking handler or null if no custom handler is set.
static Function<? super Completable,? extends Completable>	getOnCompletableAssembly() Returns the current hook function.
static BiFunction<? super Completable,? super CompletableObserver,? extends CompletableObserver>	getOnCompletableSubscribe() Returns the current hook function.
static Function<? super ConnectableFlowable,? extends ConnectableFlowable>	getOnConnectableFlowableAssembly() Returns the current hook function.
static Function<? super ConnectableObservable,? extends ConnectableObservable>	getOnConnectableObservableAssembly() Returns the current hook function.
static Function<? super Flowable,? extends Flowable>	getOnFlowableAssembly() Returns the current hook function.
static BiFunction<? super Flowable,? super org.reactivestreams.Subscriber,? extends org.reactivestreams.Subscriber>	getOnFlowableSubscribe() Returns the current hook function.
static Function<? super Maybe,? extends Maybe>	getOnMaybeAssembly() Returns the current hook function.
static BiFunction<? super Maybe,? super MaybeObserver,? extends MaybeObserver>	getOnMaybeSubscribe() Returns the current hook function.
static Function<? super Observable,? extends Observable>	getOnObservableAssembly() Returns the current hook function.
static BiFunction<? super Observable,? super Observer,? extends Observer>	getOnObservableSubscribe() Returns the current hook function.
static Function<? super ParallelFlowable,? extends ParallelFlowable>	getOnParallelAssembly() Returns the current hook function.
static Function<? super Single,? extends Single>	getOnSingleAssembly() Returns the current hook function.
static BiFunction<? super Single,? super SingleObserver,? extends SingleObserver>	getOnSingleSubscribe() Returns the current hook function.
static Function<? super java.lang.Runnable,? extends java.lang.Runnable>	getScheduleHandler() Returns the current hook function.
static Function<? super Scheduler,? extends Scheduler>	getSingleSchedulerHandler() Returns the current hook function.
static Scheduler	initComputationScheduler(java.util.concurrent.Callable<Scheduler> defaultScheduler) Calls the associated hook function.
static Scheduler	initIoScheduler(java.util.concurrent.Callable<Scheduler> defaultScheduler) Calls the associated hook function.
static Scheduler	initNewThreadScheduler(java.util.concurrent.Callable<Scheduler> defaultScheduler) Calls the associated hook function.
static Scheduler	initSingleScheduler(java.util.concurrent.Callable<Scheduler> defaultScheduler) Calls the associated hook function.
static boolean	isFailOnNonBlockingScheduler() Returns true if the blockingX operators fail with an IllegalStateException on a non-blocking scheduler such as computation or single.
static boolean	isLockdown() Returns true if the plugins were locked down.
static void	lockdown() Prevents changing the plugins from then on.
static Completable	onAssembly(Completable source) Calls the associated hook function.
static <T> ConnectableFlowable<T>	onAssembly(ConnectableFlowable<T> source) Calls the associated hook function.
static <T> ConnectableObservable<T>	onAssembly(ConnectableObservable<T> source) Calls the associated hook function.
static <T> Flowable<T>	onAssembly(Flowable<T> source) Calls the associated hook function.
static <T> Maybe<T>	onAssembly(Maybe<T> source) Calls the associated hook function.
static <T> Observable<T>	onAssembly(Observable<T> source) Calls the associated hook function.
static <T> ParallelFlowable<T>	onAssembly(ParallelFlowable<T> source) Calls the associated hook function.
static <T> Single<T>	onAssembly(Single<T> source) Calls the associated hook function.
static boolean	onBeforeBlocking() Called before an operator attempts a blocking operation such as awaiting a condition or signal and should return true to indicate the operator should not block but throw an IllegalArgumentException.
static Scheduler	onComputationScheduler(Scheduler defaultScheduler) Calls the associated hook function.
static void	onError(java.lang.Throwable error) Called when an undeliverable error occurs.
static Scheduler	onIoScheduler(Scheduler defaultScheduler) Calls the associated hook function.
static Scheduler	onNewThreadScheduler(Scheduler defaultScheduler) Calls the associated hook function.
static java.lang.Runnable	onSchedule(java.lang.Runnable run) Called when a task is scheduled.
static Scheduler	onSingleScheduler(Scheduler defaultScheduler) Calls the associated hook function.
static CompletableObserver	onSubscribe(Completable source, CompletableObserver observer) 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 <T> MaybeObserver<? super T>	onSubscribe(Maybe<T> source, MaybeObserver<? super T> subscriber) Calls the associated hook function.
static <T> Observer<? super T>	onSubscribe(Observable<T> source, Observer<? super T> observer) Calls the associated hook function.
static <T> SingleObserver<? super T>	onSubscribe(Single<T> source, SingleObserver<? super T> observer) Calls the associated hook function.
static void	reset() Removes all handlers and resets to default behavior.
static void	setComputationSchedulerHandler(Function<? super Scheduler,? extends Scheduler> handler) Sets the specific hook function.
static void	setErrorHandler(Consumer<? super java.lang.Throwable> handler) Sets the specific hook function.
static void	setFailOnNonBlockingScheduler(boolean enable) Enables or disables the blockingX operators to fail with an IllegalStateException on a non-blocking scheduler such as computation or single.
static void	setInitComputationSchedulerHandler(Function<? super java.util.concurrent.Callable<Scheduler>,? extends Scheduler> handler) Sets the specific hook function.
static void	setInitIoSchedulerHandler(Function<? super java.util.concurrent.Callable<Scheduler>,? extends Scheduler> handler) Sets the specific hook function.
static void	setInitNewThreadSchedulerHandler(Function<? super java.util.concurrent.Callable<Scheduler>,? extends Scheduler> handler) Sets the specific hook function.
static void	setInitSingleSchedulerHandler(Function<? super java.util.concurrent.Callable<Scheduler>,? extends Scheduler> handler) Sets the specific hook function.
static void	setIoSchedulerHandler(Function<? super Scheduler,? extends Scheduler> handler) Sets the specific hook function.
static void	setNewThreadSchedulerHandler(Function<? super Scheduler,? extends Scheduler> handler) Sets the specific hook function.
static void	setOnBeforeBlocking(BooleanSupplier handler) Set the handler that is called when an operator attemts a blocking await; the handler should return true to prevent the blocking and to signal an IllegalStateException instead.
static void	setOnCompletableAssembly(Function<? super Completable,? extends Completable> onCompletableAssembly) Sets the specific hook function.
static void	setOnCompletableSubscribe(BiFunction<? super Completable,? super CompletableObserver,? extends CompletableObserver> onCompletableSubscribe) Sets the specific hook function.
static void	setOnConnectableFlowableAssembly(Function<? super ConnectableFlowable,? extends ConnectableFlowable> onConnectableFlowableAssembly) Sets the specific hook function.
static void	setOnConnectableObservableAssembly(Function<? super ConnectableObservable,? extends ConnectableObservable> onConnectableObservableAssembly) Sets the specific hook function.
static void	setOnFlowableAssembly(Function<? super Flowable,? extends Flowable> onFlowableAssembly) Sets the specific hook function.
static void	setOnFlowableSubscribe(BiFunction<? super Flowable,? super org.reactivestreams.Subscriber,? extends org.reactivestreams.Subscriber> onFlowableSubscribe) Sets the specific hook function.
static void	setOnMaybeAssembly(Function<? super Maybe,? extends Maybe> onMaybeAssembly) Sets the specific hook function.
static void	setOnMaybeSubscribe(BiFunction<? super Maybe,MaybeObserver,? extends MaybeObserver> onMaybeSubscribe) Sets the specific hook function.
static void	setOnObservableAssembly(Function<? super Observable,? extends Observable> onObservableAssembly) Sets the specific hook function.
static void	setOnObservableSubscribe(BiFunction<? super Observable,? super Observer,? extends Observer> onObservableSubscribe) Sets the specific hook function.
static void	setOnParallelAssembly(Function<? super ParallelFlowable,? extends ParallelFlowable> handler) Sets the specific hook function.
static void	setOnSingleAssembly(Function<? super Single,? extends Single> onSingleAssembly) Sets the specific hook function.
static void	setOnSingleSubscribe(BiFunction<? super Single,? super SingleObserver,? extends SingleObserver> onSingleSubscribe) Sets the specific hook function.
static void	setScheduleHandler(Function<? super java.lang.Runnable,? extends java.lang.Runnable> handler) Sets the specific hook function.
static void	setSingleSchedulerHandler(Function<? super Scheduler,? extends Scheduler> 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

setFailOnNonBlockingScheduler

public static void setFailOnNonBlockingScheduler(boolean enable)

Enables or disables the blockingX operators to fail with an IllegalStateException on a non-blocking scheduler such as computation or single.

Parameters:

enable - enable or disable the feature

Since:

2.0.5 - experimental

isFailOnNonBlockingScheduler

public static boolean isFailOnNonBlockingScheduler()

Returns true if the blockingX operators fail with an IllegalStateException on a non-blocking scheduler such as computation or single.

Returns:

true if the blockingX operators fail on a non-blocking scheduler

Since:

2.0.5 - experimental

getComputationSchedulerHandler

@Nullable
public static Function<? super Scheduler,? extends Scheduler> getComputationSchedulerHandler()

Returns the current hook function.

Returns:

the hook function, may be null

getErrorHandler

@Nullable
public static Consumer<? super java.lang.Throwable> getErrorHandler()

Returns the a hook consumer.

Returns:

the hook consumer, may be null

getInitComputationSchedulerHandler

@Nullable
public static Function<? super java.util.concurrent.Callable<Scheduler>,? extends Scheduler> getInitComputationSchedulerHandler()

Returns the current hook function.

Returns:

the hook function, may be null

getInitIoSchedulerHandler

@Nullable
public static Function<? super java.util.concurrent.Callable<Scheduler>,? extends Scheduler> getInitIoSchedulerHandler()

Returns the current hook function.

Returns:

the hook function, may be null

getInitNewThreadSchedulerHandler

@Nullable
public static Function<? super java.util.concurrent.Callable<Scheduler>,? extends Scheduler> getInitNewThreadSchedulerHandler()

Returns the current hook function.

Returns:

the hook function, may be null

getInitSingleSchedulerHandler

@Nullable
public static Function<? super java.util.concurrent.Callable<Scheduler>,? extends Scheduler> getInitSingleSchedulerHandler()

Returns the current hook function.

Returns:

the hook function, may be null

getIoSchedulerHandler

@Nullable
public static Function<? super Scheduler,? extends Scheduler> getIoSchedulerHandler()

Returns the current hook function.

Returns:

the hook function, may be null

getNewThreadSchedulerHandler

@Nullable
public static Function<? super Scheduler,? extends Scheduler> getNewThreadSchedulerHandler()

Returns the current hook function.

Returns:

the hook function, may be null

getScheduleHandler

@Nullable
public static Function<? super java.lang.Runnable,? extends java.lang.Runnable> getScheduleHandler()

Returns the current hook function.

Returns:

the hook function, may be null

getSingleSchedulerHandler

@Nullable
public static Function<? super Scheduler,? extends Scheduler> getSingleSchedulerHandler()

Returns the current hook function.

Returns:

the hook function, may be null

initComputationScheduler

@NonNull
public static Scheduler initComputationScheduler(@NonNull
                                         java.util.concurrent.Callable<Scheduler> defaultScheduler)

Calls the associated hook function.

Parameters:

defaultScheduler - a Callable which returns the hook's input value

Returns:

the value returned by the hook, not null

Throws:

java.lang.NullPointerException - if the callable parameter or its result are null

initIoScheduler

@NonNull
public static Scheduler initIoScheduler(@NonNull
                                java.util.concurrent.Callable<Scheduler> defaultScheduler)

Calls the associated hook function.

Parameters:

defaultScheduler - a Callable which returns the hook's input value

Returns:

the value returned by the hook, not null

Throws:

java.lang.NullPointerException - if the callable parameter or its result are null

initNewThreadScheduler

@NonNull
public static Scheduler initNewThreadScheduler(@NonNull
                                       java.util.concurrent.Callable<Scheduler> defaultScheduler)

Calls the associated hook function.

Parameters:

defaultScheduler - a Callable which returns the hook's input value

Returns:

the value returned by the hook, not null

Throws:

java.lang.NullPointerException - if the callable parameter or its result are null

initSingleScheduler

@NonNull
public static Scheduler initSingleScheduler(@NonNull
                                    java.util.concurrent.Callable<Scheduler> defaultScheduler)

Calls the associated hook function.

Parameters:

defaultScheduler - a Callable which returns the hook's input value

Returns:

the value returned by the hook, not null

Throws:

java.lang.NullPointerException - if the callable parameter or its result are null

onComputationScheduler

@NonNull
public static Scheduler onComputationScheduler(@NonNull
                                       Scheduler defaultScheduler)

Calls the associated hook function.

Parameters:

defaultScheduler - the hook's input value

Returns:

the value returned by the hook

onError

public static void onError(@NonNull
           java.lang.Throwable error)

Called when an undeliverable error occurs.

Parameters:

error - the error to report

onIoScheduler

@NonNull
public static Scheduler onIoScheduler(@NonNull
                              Scheduler defaultScheduler)

Calls the associated hook function.

Parameters:

defaultScheduler - the hook's input value

Returns:

the value returned by the hook

onNewThreadScheduler

@NonNull
public static Scheduler onNewThreadScheduler(@NonNull
                                     Scheduler defaultScheduler)

Calls the associated hook function.

Parameters:

defaultScheduler - the hook's input value

Returns:

the value returned by the hook

onSchedule

@NonNull
public static java.lang.Runnable onSchedule(@NonNull
                                    java.lang.Runnable run)

Called when a task is scheduled.

Parameters:

run - the runnable instance

Returns:

the replacement runnable

onSingleScheduler

@NonNull
public static Scheduler onSingleScheduler(@NonNull
                                  Scheduler defaultScheduler)

Calls the associated hook function.

Parameters:

defaultScheduler - the hook's input value

Returns:

the value returned by the hook

reset

public static void reset()

Removes all handlers and resets to default behavior.

setComputationSchedulerHandler

public static void setComputationSchedulerHandler(@Nullable
                                  Function<? super Scheduler,? extends Scheduler> handler)

Sets the specific hook function.

Parameters:

handler - the hook function to set, null allowed

setErrorHandler

public static void setErrorHandler(@Nullable
                   Consumer<? super java.lang.Throwable> handler)

Sets the specific hook function.

Parameters:

handler - the hook function to set, null allowed

setInitComputationSchedulerHandler

public static void setInitComputationSchedulerHandler(@Nullable
                                      Function<? super java.util.concurrent.Callable<Scheduler>,? extends Scheduler> handler)

Sets the specific hook function.

Parameters:

handler - the hook function to set, null allowed, but the function may not return null

setInitIoSchedulerHandler

public static void setInitIoSchedulerHandler(@Nullable
                             Function<? super java.util.concurrent.Callable<Scheduler>,? extends Scheduler> handler)

Sets the specific hook function.

Parameters:

handler - the hook function to set, null allowed, but the function may not return null

setInitNewThreadSchedulerHandler

public static void setInitNewThreadSchedulerHandler(@Nullable
                                    Function<? super java.util.concurrent.Callable<Scheduler>,? extends Scheduler> handler)

Sets the specific hook function.

Parameters:

handler - the hook function to set, null allowed, but the function may not return null

setInitSingleSchedulerHandler

public static void setInitSingleSchedulerHandler(@Nullable
                                 Function<? super java.util.concurrent.Callable<Scheduler>,? extends Scheduler> handler)

Sets the specific hook function.

Parameters:

handler - the hook function to set, null allowed, but the function may not return null

setIoSchedulerHandler

public static void setIoSchedulerHandler(@Nullable
                         Function<? super Scheduler,? extends Scheduler> handler)

Sets the specific hook function.

Parameters:

handler - the hook function to set, null allowed

setNewThreadSchedulerHandler

public static void setNewThreadSchedulerHandler(@Nullable
                                Function<? super Scheduler,? extends Scheduler> handler)

Sets the specific hook function.

Parameters:

handler - the hook function to set, null allowed

setScheduleHandler

public static void setScheduleHandler(@Nullable
                      Function<? super java.lang.Runnable,? extends java.lang.Runnable> handler)

Sets the specific hook function.

Parameters:

handler - the hook function to set, null allowed

setSingleSchedulerHandler

public static void setSingleSchedulerHandler(@Nullable
                             Function<? super Scheduler,? extends Scheduler> handler)

Sets the specific hook function.

Parameters:

handler - the hook function to set, null allowed

getOnCompletableAssembly

@Nullable
public static Function<? super Completable,? extends Completable> getOnCompletableAssembly()

Returns the current hook function.

Returns:

the hook function, may be null

getOnCompletableSubscribe

@Nullable
public static BiFunction<? super Completable,? super CompletableObserver,? extends CompletableObserver> getOnCompletableSubscribe()

Returns the current hook function.

Returns:

the hook function, may be null

getOnFlowableAssembly

@Nullable
public static Function<? super Flowable,? extends Flowable> getOnFlowableAssembly()

Returns the current hook function.

Returns:

the hook function, may be null

getOnConnectableFlowableAssembly

@Nullable
public static Function<? super ConnectableFlowable,? extends ConnectableFlowable> getOnConnectableFlowableAssembly()

Returns the current hook function.

Returns:

the hook function, may be null

getOnFlowableSubscribe

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

Returns the current hook function.

Returns:

the hook function, may be null

getOnMaybeSubscribe

@Nullable
public static BiFunction<? super Maybe,? super MaybeObserver,? extends MaybeObserver> getOnMaybeSubscribe()

Returns the current hook function.

Returns:

the hook function, may be null

getOnMaybeAssembly

@Nullable
public static Function<? super Maybe,? extends Maybe> getOnMaybeAssembly()

Returns the current hook function.

Returns:

the hook function, may be null

getOnSingleAssembly

@Nullable
public static Function<? super Single,? extends Single> getOnSingleAssembly()

Returns the current hook function.

Returns:

the hook function, may be null

getOnSingleSubscribe

@Nullable
public static BiFunction<? super Single,? super SingleObserver,? extends SingleObserver> getOnSingleSubscribe()

Returns the current hook function.

Returns:

the hook function, may be null

getOnObservableAssembly

@Nullable
public static Function<? super Observable,? extends Observable> getOnObservableAssembly()

Returns the current hook function.

Returns:

the hook function, may be null

getOnConnectableObservableAssembly

@Nullable
public static Function<? super ConnectableObservable,? extends ConnectableObservable> getOnConnectableObservableAssembly()

Returns the current hook function.

Returns:

the hook function, may be null

getOnObservableSubscribe

@Nullable
public static BiFunction<? super Observable,? super Observer,? extends Observer> getOnObservableSubscribe()

Returns the current hook function.

Returns:

the hook function, may be null

setOnCompletableAssembly

public static void setOnCompletableAssembly(@Nullable
                            Function<? super Completable,? extends Completable> onCompletableAssembly)

Sets the specific hook function.

Parameters:

onCompletableAssembly - the hook function to set, null allowed

setOnCompletableSubscribe

public static void setOnCompletableSubscribe(@Nullable
                             BiFunction<? super Completable,? super CompletableObserver,? extends CompletableObserver> onCompletableSubscribe)

Sets the specific hook function.

Parameters:

onCompletableSubscribe - the hook function to set, null allowed

setOnFlowableAssembly

public static void setOnFlowableAssembly(@Nullable
                         Function<? super Flowable,? extends Flowable> onFlowableAssembly)

Sets the specific hook function.

Parameters:

onFlowableAssembly - the hook function to set, null allowed

setOnMaybeAssembly

public static void setOnMaybeAssembly(@Nullable
                      Function<? super Maybe,? extends Maybe> onMaybeAssembly)

Sets the specific hook function.

Parameters:

onMaybeAssembly - the hook function to set, null allowed

setOnConnectableFlowableAssembly

public static void setOnConnectableFlowableAssembly(@Nullable
                                    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
                          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

setOnMaybeSubscribe

public static void setOnMaybeSubscribe(@Nullable
                       BiFunction<? super Maybe,MaybeObserver,? extends MaybeObserver> onMaybeSubscribe)

Sets the specific hook function.

Parameters:

onMaybeSubscribe - the hook function to set, null allowed

setOnObservableAssembly

public static void setOnObservableAssembly(@Nullable
                           Function<? super Observable,? extends Observable> onObservableAssembly)

Sets the specific hook function.

Parameters:

onObservableAssembly - the hook function to set, null allowed

setOnConnectableObservableAssembly

public static void setOnConnectableObservableAssembly(@Nullable
                                      Function<? super ConnectableObservable,? extends ConnectableObservable> onConnectableObservableAssembly)

Sets the specific hook function.

Parameters:

onConnectableObservableAssembly - the hook function to set, null allowed

setOnObservableSubscribe

public static void setOnObservableSubscribe(@Nullable
                            BiFunction<? super Observable,? super Observer,? extends Observer> onObservableSubscribe)

Sets the specific hook function.

Parameters:

onObservableSubscribe - the hook function to set, null allowed

setOnSingleAssembly

public static void setOnSingleAssembly(@Nullable
                       Function<? super Single,? extends Single> onSingleAssembly)

Sets the specific hook function.

Parameters:

onSingleAssembly - the hook function to set, null allowed

setOnSingleSubscribe

public static void setOnSingleSubscribe(@Nullable
                        BiFunction<? super Single,? super SingleObserver,? extends SingleObserver> onSingleSubscribe)

Sets the specific hook function.

Parameters:

onSingleSubscribe - 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

onSubscribe

@NonNull
public static <T> Observer<? super T> onSubscribe(@NonNull
                                          Observable<T> source,
                                          @NonNull
                                          Observer<? super T> observer)

Calls the associated hook function.

Type Parameters:

T - the value type

Parameters:

source - the hook's input value

observer - the observer

Returns:

the value returned by the hook

onSubscribe

@NonNull
public static <T> SingleObserver<? super T> onSubscribe(@NonNull
                                                Single<T> source,
                                                @NonNull
                                                SingleObserver<? super T> observer)

Calls the associated hook function.

Type Parameters:

T - the value type

Parameters:

source - the hook's input value

observer - the observer

Returns:

the value returned by the hook

onSubscribe

@NonNull
public static CompletableObserver onSubscribe(@NonNull
                                      Completable source,
                                      @NonNull
                                      CompletableObserver observer)

Calls the associated hook function.

Parameters:

source - the hook's input value

observer - the observer

Returns:

the value returned by the hook

onSubscribe

@NonNull
public static <T> MaybeObserver<? super T> onSubscribe(@NonNull
                                               Maybe<T> source,
                                               @NonNull
                                               MaybeObserver<? 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> Maybe<T> onAssembly(@NonNull
                              Maybe<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> 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

onAssembly

@NonNull
public static <T> Observable<T> onAssembly(@NonNull
                                   Observable<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> ConnectableObservable<T> onAssembly(@NonNull
                                              ConnectableObservable<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> Single<T> onAssembly(@NonNull
                               Single<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 Completable onAssembly(@NonNull
                             Completable source)

Calls the associated hook function.

Parameters:

source - the hook's input value

Returns:

the value returned by the hook

setOnParallelAssembly

public static void setOnParallelAssembly(@Nullable
                         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 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

onBeforeBlocking

public static boolean onBeforeBlocking()

Called before an operator attempts a blocking operation such as awaiting a condition or signal and should return true to indicate the operator should not block but throw an IllegalArgumentException.

Returns:

true if the blocking should be prevented

Since:

2.0.5 - experimental

See Also:

setFailOnNonBlockingScheduler(boolean)

setOnBeforeBlocking

public static void setOnBeforeBlocking(@Nullable
                       BooleanSupplier handler)

Set the handler that is called when an operator attemts a blocking await; the handler should return true to prevent the blocking and to signal an IllegalStateException instead.

Parameters:

handler - the handler to set, null resets to the default handler that always returns false

Since:

2.0.5 - experimental

See Also:

onBeforeBlocking()

getOnBeforeBlocking

@Nullable
public static BooleanSupplier getOnBeforeBlocking()

Returns the current blocking handler or null if no custom handler is set.

Returns:

the current blocking handler or null if not specified

Since:

2.0.5 - experimental

createComputationScheduler

@NonNull
public static 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 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 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 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