io.reactivex.common

Class RxJavaCommonPlugins

java.lang.Object

io.reactivex.common.RxJavaCommonPlugins

public final class RxJavaCommonPlugins
extends java.lang.Object

Utility class to inject handlers to certain standard RxJava operations.

Method Summary

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 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 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 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 attempts a blocking await; the handler should return true to prevent the blocking and to signal an IllegalStateException instead.
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.

History: 2.0.5 - experimental

Parameters:

enable - enable or disable the feature

Since:

2.1

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.

History: 2.0.5 - experimental

Returns:

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

Since:

2.1

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

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.

History: 2.0. - experimental

Returns:

true if the blocking should be prevented

Since:

2.1

See Also:

setFailOnNonBlockingScheduler(boolean)

setOnBeforeBlocking

public static void setOnBeforeBlocking(@Nullable
                                       BooleanSupplier handler)

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

History: 2.0.5 - experimental

Parameters:

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

Since:

2.1

See Also:

onBeforeBlocking()

getOnBeforeBlocking

@Nullable
public static BooleanSupplier getOnBeforeBlocking()

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

History: 2.0.5 - experimental

Returns:

the current blocking handler or null if not specified

Since:

2.1

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.

History: 2.0.5 - experimental

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.1

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.

History: 2.0.5 - experimental

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.1

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.

History: 2.0.5 - experimental

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.1

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.

History: 2.0.5 - experimental

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.1