rxdogtag2

Class RxDogTag.Builder

java.lang.Object

rxdogtag2.RxDogTag.Builder

Enclosing class:

RxDogTag

public static final class RxDogTag.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
RxDogTag.Builder	addIgnoredPackages(java.util.Collection<java.lang.String> packages)
RxDogTag.Builder	addIgnoredPackages(java.lang.String... packages)
RxDogTag.Builder	addObserverHandlers(java.util.Collection<ObserverHandler> handlers)
RxDogTag.Builder	addObserverHandlers(ObserverHandler... handlers)
RxDogTag.Builder	configureWith(RxDogTag.Configurer configurer) Can be used to compose this builder with a RxDogTag.Configurer in a way that doesn't break the builder chain.
RxDogTag.Builder	disableAnnotations() Disables stacktrace annotations.
RxDogTag.Builder	disableRepackagingOnErrorNotImplementedExceptions() By default, RxDogTag will repackage OnErrorNotImplementedExceptions with its own custom, simplified one with no stacktrace and the original cause's message copied in.
RxDogTag.Builder	guardObserverCallbacks(boolean guardObserverCallbacks)
void	install() Initializes RxDogTag by installing custom onSubscribe hooks via RxJavaPlugins.

Methods inherited from class java.lang.Object

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

Method Detail

disableAnnotations

public RxDogTag.Builder disableAnnotations()

Disables stacktrace annotations. No headers like RxDogTag.STACK_ELEMENT_TRACE_HEADER will be present in the stack if this is disabled.

Returns:

this builder for fluent chaining.

addObserverHandlers

public RxDogTag.Builder addObserverHandlers(ObserverHandler... handlers)

Parameters:

handlers - any number of ObserverHandler instances to potentially unpack or decorate observers. Note that order matters here, and the first one to return a LambdaConsumerIntrospection with no custom error handling will be used.

Returns:

this builder for fluent chaining.

addObserverHandlers

public RxDogTag.Builder addObserverHandlers(java.util.Collection<ObserverHandler> handlers)

Parameters:

handlers - a list of ObserverHandler instances to potentially unpack or decorate observers. Note that order matters here, and the first one to return a LambdaConsumerIntrospection with no custom error handling will be used.

Returns:

this builder for fluent chaining.

addIgnoredPackages

public RxDogTag.Builder addIgnoredPackages(java.lang.String... packages)

Parameters:

packages - ignorable packages. Useful if decorating observers that you know can be safely ignored when deducing a target subscribe() point. It's recommended that classes in these packages have their names kept in Proguard/R8 obfuscation as well.

Returns:

this builder for fluent chaining.

addIgnoredPackages

public RxDogTag.Builder addIgnoredPackages(java.util.Collection<java.lang.String> packages)

Parameters:

packages - ignorable packages. Useful if decorating observers that you know can be safely ignored when deducing a target subscribe() point. It's recommended that classes in these packages have their names kept in Proguard/R8 obfuscation as well.

Returns:

this builder for fluent chaining.

guardObserverCallbacks

public RxDogTag.Builder guardObserverCallbacks(boolean guardObserverCallbacks)

Parameters:

guardObserverCallbacks - Guards observer callbacks so that any exceptions that occur during observer callbacks are intercepted and routed to RxDogTag's error handling that will give you more info on the subscription point. Set to true by default.

Returns:

this builder for fluent chaining.

configureWith

public RxDogTag.Builder configureWith(RxDogTag.Configurer configurer)

Can be used to compose this builder with a RxDogTag.Configurer in a way that doesn't break the builder chain.

Example:

   RxDogTag.builder()
       .configureWith(AutoDisposeConfigurer::configure)
       .install();
 

Parameters:

configurer - an RxDogTag.Configurer instance to be called.

Returns:

this builder for fluent chaining.

disableRepackagingOnErrorNotImplementedExceptions

public RxDogTag.Builder disableRepackagingOnErrorNotImplementedExceptions()

By default, RxDogTag will repackage OnErrorNotImplementedExceptions with its own custom, simplified one with no stacktrace and the original cause's message copied in. This is effectively the same behavior as any other type of exception.

If you don't want this behavior, you can use this configuration to disable that behavior. This should only be disabled if you throw your own custom OnErrorNotImplementedException that you want visible in the stacktrace.

Returns:

this builder for fluent chaining.

install

public void install()

Initializes RxDogTag by installing custom onSubscribe hooks via RxJavaPlugins. Note that calling this calls the following methods:

• RxJavaPlugins.setOnFlowableSubscribe(BiFunction)
• RxJavaPlugins.setOnObservableSubscribe(BiFunction)
• RxJavaPlugins.setOnMaybeSubscribe(BiFunction)
• RxJavaPlugins.setOnSingleSubscribe(BiFunction)
• RxJavaPlugins.setOnCompletableSubscribe(BiFunction)

See Also:

RxDogTag.extractStackElementTag(Throwable, Set)