hu.akarnokd.rxjava2.debug.validator

Class RxJavaProtocolValidator

java.lang.Object

hu.akarnokd.rxjava2.debug.validator.RxJavaProtocolValidator

public final class RxJavaProtocolValidator
extends java.lang.Object

Installs assembly hooks that validate the Reactive-Streams and derived protocols are honored.

Since:

0.17.4

See Also:

setOnViolationHandler(PlainConsumer), enable()

Method Summary

Modifier and Type	Method and Description
static void	disable() Disables the validation hooks be resetting the assembly hooks to none.
static void	enable() Enable the protocol violation hooks.
static SavedHooks	enableAndChain() Enable the protocol violation hooks by chaining it before any existing hook.
static PlainConsumer<ProtocolNonConformanceException>	getOnViolationHandler() Returns the current custom violation callback handler.
static boolean	isEnabled() Returns true if the validation hooks have been installed.
static void	setOnViolationHandler(PlainConsumer<ProtocolNonConformanceException> handler) Set a custom violation callback handler.

Methods inherited from class java.lang.Object

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

Method Detail

enable

public static void enable()

Enable the protocol violation hooks.

See Also:

enableAndChain(), disable()

enableAndChain

public static SavedHooks enableAndChain()

Enable the protocol violation hooks by chaining it before any existing hook.

Returns:

the SavedHooks instance that allows restoring the previous assembly hook handlers overridden by this method

See Also:

enable()

disable

public static void disable()

Disables the validation hooks be resetting the assembly hooks to none.

isEnabled

public static boolean isEnabled()

Returns true if the validation hooks have been installed.

Returns:

true if the validation hooks have been installed

setOnViolationHandler

public static void setOnViolationHandler(@Nullable
                                         PlainConsumer<ProtocolNonConformanceException> handler)

Set a custom violation callback handler.

Call this method before enabling the validation hooks via enable().

Calling with null restores the default handler which forwards the exception to the global RxJavaPlugins.onError(Throwable) handler.

Parameters:

handler - the handler that will receive the ProtocolNonConformanceException violation exceptions

getOnViolationHandler

@Nullable
public static PlainConsumer<ProtocolNonConformanceException> getOnViolationHandler()

Returns the current custom violation callback handler.

Returns:

the current custom violation callback handler or null if not set