hu.akarnokd.rxjava2.plugins

Class RxJavaPlugins

java.lang.Object

hu.akarnokd.rxjava2.plugins.RxJavaPlugins

public final class RxJavaPlugins
extends java.lang.Object

Utility class to inject handlers to certain standard RxJava operations.

Method Summary

Modifier and Type	Method and Description
static Consumer<java.lang.Throwable>	errorConsumer() Returns a consumer which relays the received Throwable to RxJavaPlugins.onError().
static Function<Scheduler,Scheduler>	getComputationSchedulerHandler()
static <T> Function<org.reactivestreams.Publisher<T>,org.reactivestreams.Publisher<T>>	getCreateHandler()
static Consumer<java.lang.Throwable>	getErrorHandler()
static Function<Scheduler,Scheduler>	getInitComputationSchedulerHandler()
static Function<Scheduler,Scheduler>	getInitIOSchedulerHandler()
static Function<Scheduler,Scheduler>	getInitNewThreadSchedulerHandler()
static Function<Scheduler,Scheduler>	getInitSingleSchedulerHandler()
static Function<Scheduler,Scheduler>	getIOSchedulerHandler()
static <T> Function<NbpObservable.NbpSubscriber<T>,NbpObservable.NbpSubscriber<T>>	getNbpSubscribeHandler()
static Function<Scheduler,Scheduler>	getNewThreadSchedulerHandler()
static Function<java.lang.Runnable,java.lang.Runnable>	getScheduleHandler()
static Function<Scheduler,Scheduler>	getSingleSchedulerHandler()
static <T> Function<org.reactivestreams.Subscriber<T>,org.reactivestreams.Subscriber<T>>	getSubscribeHandler()
static Scheduler	initComputationScheduler(Scheduler defaultScheduler)
static Scheduler	initIOScheduler(Scheduler defaultScheduler)
static Scheduler	initNewThreadScheduler(Scheduler defaultScheduler)
static Scheduler	initSingleScheduler(Scheduler defaultScheduler)
static boolean	isLockdown() Returns true if the plugins were locked down.
static void	lockdown() Prevents changing the plugins from then on.
static Scheduler	onComputationScheduler(Scheduler defaultScheduler)
static <T> org.reactivestreams.Publisher<T>	onCreate(org.reactivestreams.Publisher<T> publisher) Called when an Observable is created.
static void	onError(java.lang.Throwable error) Called when an undeliverable error occurs.
static Scheduler	onIOScheduler(Scheduler defaultScheduler)
static <T> NbpObservable.NbpSubscriber<T>	onNbpSubscribe(NbpObservable.NbpSubscriber<T> subscriber) Called when a subscriber subscribes to an observable.
static Scheduler	onNewThreadScheduler(Scheduler defaultScheduler)
static java.lang.Runnable	onSchedule(java.lang.Runnable run) Called when a task is scheduled.
static Scheduler	onSingleScheduler(Scheduler defaultScheduler)
static <T> NbpObservable.NbpSubscriber<T>	onSubscribe(NbpObservable.NbpSubscriber<T> subscriber) Called when a subscriber subscribes to an observable.
static <T> org.reactivestreams.Subscriber<T>	onSubscribe(org.reactivestreams.Subscriber<T> subscriber) Called when a subscriber subscribes to an observable.
static void	reset() Removes all handlers and resets the default behavior.
static void	setComputationSchedulerHandler(Function<Scheduler,Scheduler> handler)
static <T> void	setCreateHandler(Function<org.reactivestreams.Publisher<T>,org.reactivestreams.Publisher<T>> handler)
static void	setErrorHandler(Consumer<java.lang.Throwable> handler)
static void	setInitComputationSchedulerHandler(Function<Scheduler,Scheduler> handler)
static void	setInitIOSchedulerHandler(Function<Scheduler,Scheduler> handler)
static void	setInitNewThreadSchedulerHandler(Function<Scheduler,Scheduler> handler)
static void	setInitSingleSchedulerHandler(Function<Scheduler,Scheduler> handler)
static void	setIOSchedulerHandler(Function<Scheduler,Scheduler> handler)
static <T> void	setNbpSubscribeHandler(Function<NbpObservable.NbpSubscriber<T>,NbpObservable.NbpSubscriber<T>> handler)
static void	setNewThreadSchedulerHandler(Function<Scheduler,Scheduler> handler)
static void	setScheduleHandler(Function<java.lang.Runnable,java.lang.Runnable> handler)
static void	setSingleSchedulerHandler(Function<Scheduler,Scheduler> handler)
static <T> void	setSubscribeHandler(Function<org.reactivestreams.Subscriber<T>,org.reactivestreams.Subscriber<T>> handler)

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

getComputationSchedulerHandler

public static Function<Scheduler,Scheduler> getComputationSchedulerHandler()

getCreateHandler

public static <T> Function<org.reactivestreams.Publisher<T>,org.reactivestreams.Publisher<T>> getCreateHandler()

getErrorHandler

public static Consumer<java.lang.Throwable> getErrorHandler()

getInitComputationSchedulerHandler

public static Function<Scheduler,Scheduler> getInitComputationSchedulerHandler()

getInitIOSchedulerHandler

public static Function<Scheduler,Scheduler> getInitIOSchedulerHandler()

getInitNewThreadSchedulerHandler

public static Function<Scheduler,Scheduler> getInitNewThreadSchedulerHandler()

getInitSingleSchedulerHandler

public static Function<Scheduler,Scheduler> getInitSingleSchedulerHandler()

getIOSchedulerHandler

public static Function<Scheduler,Scheduler> getIOSchedulerHandler()

getNewThreadSchedulerHandler

public static Function<Scheduler,Scheduler> getNewThreadSchedulerHandler()

getScheduleHandler

public static Function<java.lang.Runnable,java.lang.Runnable> getScheduleHandler()

getSingleSchedulerHandler

public static Function<Scheduler,Scheduler> getSingleSchedulerHandler()

getSubscribeHandler

public static <T> Function<org.reactivestreams.Subscriber<T>,org.reactivestreams.Subscriber<T>> getSubscribeHandler()

getNbpSubscribeHandler

public static <T> Function<NbpObservable.NbpSubscriber<T>,NbpObservable.NbpSubscriber<T>> getNbpSubscribeHandler()

initComputationScheduler

public static Scheduler initComputationScheduler(Scheduler defaultScheduler)

initIOScheduler

public static Scheduler initIOScheduler(Scheduler defaultScheduler)

initNewThreadScheduler

public static Scheduler initNewThreadScheduler(Scheduler defaultScheduler)

initSingleScheduler

public static Scheduler initSingleScheduler(Scheduler defaultScheduler)

onComputationScheduler

public static Scheduler onComputationScheduler(Scheduler defaultScheduler)

onCreate

public static <T> org.reactivestreams.Publisher<T> onCreate(org.reactivestreams.Publisher<T> publisher)

Called when an Observable is created.

Type Parameters:

T - the value type

Parameters:

publisher - the original publisher

Returns:

the replacement publisher

onError

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

Called when an undeliverable error occurs.

Parameters:

error - the error to report

onIOScheduler

public static Scheduler onIOScheduler(Scheduler defaultScheduler)

onNewThreadScheduler

public static Scheduler onNewThreadScheduler(Scheduler defaultScheduler)

onSchedule

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

Called when a task is scheduled.

Parameters:

run - the runnable instance

Returns:

the replacement runnable

onSingleScheduler

public static Scheduler onSingleScheduler(Scheduler defaultScheduler)

onSubscribe

public static <T> org.reactivestreams.Subscriber<T> onSubscribe(org.reactivestreams.Subscriber<T> subscriber)

Called when a subscriber subscribes to an observable.

Type Parameters:

T - the value type

Parameters:

subscriber - the original subscriber

Returns:

the subscriber replacement

onNbpSubscribe

public static <T> NbpObservable.NbpSubscriber<T> onNbpSubscribe(NbpObservable.NbpSubscriber<T> subscriber)

Called when a subscriber subscribes to an observable.

Type Parameters:

T - the value type

Parameters:

subscriber - the original NbpSubscriber

Returns:

the replacement NbpSubscriber

onSubscribe

public static <T> NbpObservable.NbpSubscriber<T> onSubscribe(NbpObservable.NbpSubscriber<T> subscriber)

Called when a subscriber subscribes to an observable.

Type Parameters:

T - the value type

Parameters:

subscriber - the original subscriber

Returns:

the replacement subscriber

reset

public static void reset()

Removes all handlers and resets the default behavior.

setComputationSchedulerHandler

public static void setComputationSchedulerHandler(Function<Scheduler,Scheduler> handler)

setCreateHandler

public static <T> void setCreateHandler(Function<org.reactivestreams.Publisher<T>,org.reactivestreams.Publisher<T>> handler)

setErrorHandler

public static void setErrorHandler(Consumer<java.lang.Throwable> handler)

setInitComputationSchedulerHandler

public static void setInitComputationSchedulerHandler(Function<Scheduler,Scheduler> handler)

setInitIOSchedulerHandler

public static void setInitIOSchedulerHandler(Function<Scheduler,Scheduler> handler)

setInitNewThreadSchedulerHandler

public static void setInitNewThreadSchedulerHandler(Function<Scheduler,Scheduler> handler)

setInitSingleSchedulerHandler

public static void setInitSingleSchedulerHandler(Function<Scheduler,Scheduler> handler)

setIOSchedulerHandler

public static void setIOSchedulerHandler(Function<Scheduler,Scheduler> handler)

setNewThreadSchedulerHandler

public static void setNewThreadSchedulerHandler(Function<Scheduler,Scheduler> handler)

setScheduleHandler

public static void setScheduleHandler(Function<java.lang.Runnable,java.lang.Runnable> handler)

setSingleSchedulerHandler

public static void setSingleSchedulerHandler(Function<Scheduler,Scheduler> handler)

setSubscribeHandler

public static <T> void setSubscribeHandler(Function<org.reactivestreams.Subscriber<T>,org.reactivestreams.Subscriber<T>> handler)

setNbpSubscribeHandler

public static <T> void setNbpSubscribeHandler(Function<NbpObservable.NbpSubscriber<T>,NbpObservable.NbpSubscriber<T>> handler)

errorConsumer

public static final Consumer<java.lang.Throwable> errorConsumer()

Returns a consumer which relays the received Throwable to RxJavaPlugins.onError().

Returns:

the consumer