reactor.test.subscriber

Class TestSubscriberBuilder

java.lang.Object

reactor.test.subscriber.TestSubscriberBuilder

public final class TestSubscriberBuilder
extends Object

A configuration builder used to create a fine-tuned TestSubscriber, also allowing for a Fuseable.ConditionalSubscriber variant. Notably, it allows the created instance to enforce fusion compatibility (by assuming a Fuseable source publisher and expecting a Fuseable.QueueSubscription).

See TestSubscriber.builder() to obtain a new builder.

Note that all methods mutate the builder configuration, so reuse is discouraged.

Author:

Simon Baslé

Method Summary

Modifier and Type	Method and Description
<T> TestSubscriber<T>	build() Create a TestSubscriber according to this builder.
<T> ConditionalTestSubscriber<T>	buildConditional(Predicate<? super T> tryOnNext) Create a Fuseable.ConditionalSubscriber variant of TestSubscriber according to this builder.
TestSubscriberBuilder	contextPut(Object key, Object value) Enrich the Context with a single entry.
TestSubscriberBuilder	contextPutAll(ContextView toAdd) Enrich the Context by putting all entries of the given ContextView in it.
TestSubscriberBuilder	initialRequest(long initialRequest) Set the request to be made upon receiving the Subscription in Subscriber.onSubscribe(Subscription).
TestSubscriberBuilder	initialRequestUnbounded() Set the request to be made upon receiving the Subscription in Subscriber.onSubscribe(Subscription) to be an unbounded request, ie.
TestSubscriberBuilder	requireFusion(int exactMode) Expect fusion to be possible with the TestSubscriber, with Fuseable.NONE) being a special case.
TestSubscriberBuilder	requireFusion(int requestedMode, int negotiatedMode) Expect fusion to be possible with the TestSubscriber, with both parameters set to Fuseable.NONE being a special case.
TestSubscriberBuilder	requireNotFuseable() Enforce that the Subscription passed to the TestSubscriber isn't a Fuseable.QueueSubscription.

Methods inherited from class java.lang.Object

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

Method Detail

contextPut

public TestSubscriberBuilder contextPut(Object key,
                                        Object value)

Enrich the Context with a single entry.

Parameters:

key - the key to put/set in the Context of the future TestSubscriber

value - the value to associate with the key

Returns:

this builder, mutated to have the key/value pair added to the Context

contextPutAll

public TestSubscriberBuilder contextPutAll(ContextView toAdd)

Enrich the Context by putting all entries of the given ContextView in it.

Parameters:

toAdd - the ContextView to add to the Context of the future TestSubscriber

Returns:

this builder, mutated to have all ContextView's key/value pairs added to the Context

initialRequest

public TestSubscriberBuilder initialRequest(long initialRequest)

Set the request to be made upon receiving the Subscription in Subscriber.onSubscribe(Subscription). Default is Long.MAX_VALUE.

Parameters:

initialRequest - the request to be made at subscription

Returns:

this builder, mutated to reflect the new request to be made at subscription

initialRequestUnbounded

public TestSubscriberBuilder initialRequestUnbounded()

Set the request to be made upon receiving the Subscription in Subscriber.onSubscribe(Subscription) to be an unbounded request, ie. Long.MAX_VALUE.

Returns:

this builder, mutated to reflect an unbounded request is to be made at subscription

requireFusion

public TestSubscriberBuilder requireFusion(int exactMode)

Expect fusion to be possible with the TestSubscriber, with Fuseable.NONE) being a special case. Fusion will be negotiated at subscription, enforcing the need for a Fuseable.QueueSubscription to be passed. Furthermore, the fusion mode returned from the negotiation with the Fuseable.QueueSubscription is expected to be the same as the provided mode.

Use requireFusion(Fuseable.NONE) to remove any previously fusion requirement, as well as removing type enforcement on the subscription (a vanilla Subscription becomes acceptable). Use requireNotFuseable() to strictly enforce that the Subscription MUST NOT be a Fuseable.QueueSubscription.

Parameters:

exactMode - the requested fusion mode, expected in return from the negotiation with the Fuseable.QueueSubscription

Returns:

this builder, mutated to require fusion with the given mode

requireFusion

public TestSubscriberBuilder requireFusion(int requestedMode,
                                           int negotiatedMode)

Expect fusion to be possible with the TestSubscriber, with both parameters set to Fuseable.NONE being a special case. Fusion will be negotiated at subscription, enforcing the need for a Fuseable.QueueSubscription to be passed. Furthermore, the negotiatedMode is expected to be negotiated by the subscription in response to requesting requestedMode.

Use requireFusion(Fuseable.NONE, Fuseable.NONE) to remove any previously fusion requirement, as well as removing type enforcement on the subscription (a vanilla Subscription becomes acceptable). Use requireNotFuseable() to strictly enforce that the Subscription MUST NOT be a Fuseable.QueueSubscription.

Parameters:

requestedMode - the fusion mode requested to the Fuseable.QueueSubscription

negotiatedMode - the fusion mode expected from the negotiation with the Fuseable.QueueSubscription

Returns:

this builder, mutated to require fusion with the given negotiated mode (in response to the given requested mode)

requireNotFuseable

public TestSubscriberBuilder requireNotFuseable()

Enforce that the Subscription passed to the TestSubscriber isn't a Fuseable.QueueSubscription. This is stricter than requireFusion(Fuseable.NONE, Fuseable.NONE), which merely disables fusion but still accepts the incoming subscription to be a QueueSubscription.

Returns:

this builder, mutated to reject all Fuseable.QueueSubscription

buildConditional

public <T> ConditionalTestSubscriber<T> buildConditional(Predicate<? super T> tryOnNext)

Create a Fuseable.ConditionalSubscriber variant of TestSubscriber according to this builder. The provided Predicate will be used as the implementation of Fuseable.ConditionalSubscriber.tryOnNext(Object).

Type Parameters:

T - the type of elements received by the TestSubscriber, defined by the predicate

Parameters:

tryOnNext - the Predicate to use as the tryOnNext implementation

Returns:

a ConditionalTestSubscriber

build

public <T> TestSubscriber<T> build()

Create a TestSubscriber according to this builder.

Type Parameters:

T - the type of elements to be received by the subscriber

Returns:

a new plain TestSubscriber