public class

TestSubscriber

extends BaseTestConsumer<T, U extends BaseTestConsumer<T, U>>
implements FlowableSubscriber<T> Disposable Subscription

java.lang.Object
↳	io.reactivex.observers.BaseTestConsumer<T, U extends io.reactivex.observers.BaseTestConsumer<T, U>>
	↳	io.reactivex.subscribers.TestSubscriber<T>

Class Overview

A subscriber that records events and allows making assertions about them.

You can override the onSubscribe, onNext, onError, onComplete, request and cancel methods but not the others (this is by design).

The TestSubscriber implements Disposable for convenience where dispose calls cancel.

When calling the default request method, you are requesting on behalf of the wrapped actual subscriber.

Summary

[Expand]

Inherited Fields

From class io.reactivex.observers.BaseTestConsumer

Public Constructors
	TestSubscriber() Constructs a non-forwarding TestSubscriber with an initial request value of Long.MAX_VALUE.
	TestSubscriber(long initialRequest) Constructs a non-forwarding TestSubscriber with the specified initial request value.
	TestSubscriber(Subscriber<? super T> actual) Constructs a forwarding TestSubscriber but leaves the requesting to the wrapped subscriber.
	TestSubscriber(Subscriber<? super T> actual, long initialRequest) Constructs a forwarding TestSubscriber with the specified initial request value.

Public Methods
final TestSubscriber<T>	assertNotSubscribed() Assert that the onSubscribe method hasn't been called at all.
final TestSubscriber<T>	assertOf(Consumer<? super TestSubscriber<T>> check) Run a check consumer with this TestSubscriber instance.
final TestSubscriber<T>	assertSubscribed() Assert that the onSubscribe method was called exactly once.
final void	cancel()
static <T> TestSubscriber<T>	create(long initialRequested) Creates a TestSubscriber with the given initial request.
static <T> TestSubscriber<T>	create() Creates a TestSubscriber with Long.MAX_VALUE initial request.
static <T> TestSubscriber<T>	create(Subscriber<? super T> delegate) Constructs a forwarding TestSubscriber.
final void	dispose() Dispose the resource, the operation should be idempotent.
final boolean	hasSubscription() Returns true if this TestSubscriber received a subscription.
final boolean	isCancelled() Returns true if this TestSubscriber has been cancelled.
final boolean	isDisposed() Returns true if this resource has been disposed.
void	onComplete()
void	onError(Throwable t)
void	onNext(T t)
void	onSubscribe(Subscription s) Implementors of this method should make sure everything that needs to be visible in `onNext(Object)` is established before calling `request(long)`.
final void	request(long n)
final TestSubscriber<T>	requestMore(long n) Calls `request(long)` and returns this.

Protected Methods
void	onStart() Called after the onSubscribe is called and handled.

[Expand]

Inherited Methods

From class io.reactivex.observers.BaseTestConsumer

final U	assertComplete() Assert that this TestObserver/TestSubscriber received exactly one onComplete event.
final U	assertEmpty() Assert that the TestObserver/TestSubscriber has received a Disposable but no other events.
final U	assertError(Throwable error) Assert that this TestObserver/TestSubscriber received exactly the specified onError event value.
final U	assertError(Class<? extends Throwable> errorClass) Asserts that this TestObserver/TestSubscriber received exactly one onError event which is an instance of the specified errorClass class.
final U	assertError(Predicate<Throwable> errorPredicate) Asserts that this TestObserver/TestSubscriber received exactly one onError event for which the provided predicate returns true.
final U	assertErrorMessage(String message) Assert that there is a single error and it has the given message.
final U	assertFailure(Predicate<Throwable> errorPredicate, T... values) Assert that the upstream signalled the specified values in order and then failed with a Throwable for which the provided predicate returns true.
final U	assertFailure(Class<? extends Throwable> error, T... values) Assert that the upstream signalled the specified values in order and then failed with a specific class or subclass of Throwable.
final U	assertFailureAndMessage(Class<? extends Throwable> error, String message, T... values) Assert that the upstream signalled the specified values in order, then failed with a specific class or subclass of Throwable and with the given exact error message.
final U	assertNever(Predicate<? super T> valuePredicate) Asserts that this TestObserver/TestSubscriber did not receive any onNext value for which the provided predicate returns true.
final U	assertNever(T value) Assert that this TestObserver/TestSubscriber did not receive an onNext value which is equal to the given value with respect to Objects.equals.
final U	assertNoErrors() Assert that this TestObserver/TestSubscriber has not received any onError event.
final U	assertNoTimeout() Asserts that some awaitX method has not timed out.
final U	assertNoValues() Assert that this TestObserver/TestSubscriber has not received any onNext events.
final U	assertNotComplete() Assert that this TestObserver/TestSubscriber has not received any onComplete event.
abstract U	assertNotSubscribed() Assert that the onSubscribe method hasn't been called at all.
final U	assertNotTerminated() Assert that the TestObserver/TestSubscriber has not terminated (i.e., the terminal latch is still non-zero).
final U	assertResult(T... values) Assert that the upstream signalled the specified values in order and completed normally.
abstract U	assertSubscribed() Assert that the onSubscribe method was called exactly once.
final U	assertTerminated() Assert that the TestObserver/TestSubscriber terminated (i.e., the terminal latch reached zero).
final U	assertTimeout() Asserts that some awaitX method has timed out.
final U	assertValue(Predicate<T> valuePredicate) Asserts that this TestObserver/TestSubscriber received exactly one onNext value for which the provided predicate returns true.
final U	assertValue(T value) Assert that this TestObserver/TestSubscriber received exactly one onNext value which is equal to the given value with respect to Objects.equals.
final U	assertValueAt(int index, Predicate<T> valuePredicate) Asserts that this TestObserver/TestSubscriber received an onNext value at the given index for the provided predicate returns true.
final U	assertValueCount(int count) Assert that this TestObserver/TestSubscriber received the specified number onNext events.
final U	assertValueSequence(Iterable<? extends T> sequence) Assert that the TestObserver/TestSubscriber received only the specified sequence of values in the same order.
final U	assertValueSet(Collection<? extends T> expected) Assert that the TestObserver/TestSubscriber received only the specified values in any order.
final U	assertValues(T... values) Assert that the TestObserver/TestSubscriber received only the specified values in the specified order.
final U	await() Awaits until this TestObserver/TestSubscriber receives an onError or onComplete events.
final boolean	await(long time, TimeUnit unit) Awaits the specified amount of time or until this TestObserver/TestSubscriber receives an onError or onComplete events, whichever happens first.
final U	awaitCount(int atLeast, Runnable waitStrategy) Await until the TestObserver/TestSubscriber receives the given number of items or terminates by waiting according to the wait strategy and up to 5000 milliseconds of timeout.
final U	awaitCount(int atLeast, Runnable waitStrategy, long timeoutMillis) Await until the TestObserver/TestSubscriber receives the given number of items or terminates.
final U	awaitCount(int atLeast) Await until the TestObserver/TestSubscriber receives the given number of items or terminates by sleeping 10 milliseconds at a time up to 5000 milliseconds of timeout.
final U	awaitDone(long time, TimeUnit unit) Awaits until the internal latch is counted down.
final boolean	awaitTerminalEvent(long duration, TimeUnit unit) Awaits the specified amount of time or until this TestObserver/TestSubscriber receives an onError or onComplete events, whichever happens first.
final boolean	awaitTerminalEvent() Waits until the any terminal event has been received by this TestObserver/TestSubscriber or returns false if the wait has been interrupted.
final U	clearTimeout() Clears the timeout flag set by the await methods when they timed out.
final long	completions() Returns the number of times onComplete was called.
final int	errorCount() Returns the number of onError exceptions received.
final List<Throwable>	errors() Returns a shared list of received onError exceptions.
final AssertionError	fail(String message) Fail with the given message and add the sequence of errors as suppressed ones.
final List<List<Object>>	getEvents() Returns a list of 3 other lists: the first inner list contains the plain values received; the second list contains the potential errors and the final list contains the potential completions as Notifications.
final boolean	isTerminated() Returns true if TestObserver/TestSubscriber received any onError or onComplete events.
final boolean	isTimeout()
final Thread	lastThread() Returns the last thread which called the onXXX methods of this TestObserver/TestSubscriber.
static String	valueAndClass(Object o) Appends the class name to a non-null value.
final int	valueCount() Returns the number of onNext values received.
final List<T>	values() Returns a shared list of received onNext values.
final U	withTag(CharSequence tag) Set the tag displayed along with an assertion failure's other state information.

From class java.lang.Object

From interface io.reactivex.FlowableSubscriber

From interface io.reactivex.disposables.Disposable

From interface org.reactivestreams.Subscriber

From interface org.reactivestreams.Subscription

Public Constructors

public TestSubscriber ()

Constructs a non-forwarding TestSubscriber with an initial request value of Long.MAX_VALUE.

public TestSubscriber (long initialRequest)

Constructs a non-forwarding TestSubscriber with the specified initial request value.

The TestSubscriber doesn't validate the initialRequest value so one can test sources with invalid values as well.

Parameters

initialRequest	the initial request value

public TestSubscriber (Subscriber<? super T> actual)

Constructs a forwarding TestSubscriber but leaves the requesting to the wrapped subscriber.

Parameters

actual	the actual Subscriber to forward events to

public TestSubscriber (Subscriber<? super T> actual, long initialRequest)

Constructs a forwarding TestSubscriber with the specified initial request value.

The TestSubscriber doesn't validate the initialRequest value so one can test sources with invalid values as well.

Parameters

actual	the actual Subscriber to forward events to
initialRequest	the initial request value

Public Methods

public final TestSubscriber<T> assertNotSubscribed ()

Assert that the onSubscribe method hasn't been called at all.

Returns

this

public final TestSubscriber<T> assertOf (Consumer<? super TestSubscriber<T>> check)

Run a check consumer with this TestSubscriber instance.

Parameters

check	the check consumer to run

Returns

this

public final TestSubscriber<T> assertSubscribed ()

Assert that the onSubscribe method was called exactly once.

Returns

this

public final void cancel ()

public static TestSubscriber<T> create (long initialRequested)

Creates a TestSubscriber with the given initial request.

Parameters

initialRequested	the initial requested amount

Returns

the new TestSubscriber instance.

public static TestSubscriber<T> create ()

Creates a TestSubscriber with Long.MAX_VALUE initial request.

Returns

the new TestSubscriber instance.

public static TestSubscriber<T> create (Subscriber<? super T> delegate)

Constructs a forwarding TestSubscriber.

Parameters

delegate	the actual Subscriber to forward events to

Returns

the new TestObserver instance

public final void dispose ()

Dispose the resource, the operation should be idempotent.

public final boolean hasSubscription ()

Returns true if this TestSubscriber received a subscription.

Returns

true if this TestSubscriber received a subscription

public final boolean isCancelled ()

Returns true if this TestSubscriber has been cancelled.

Returns

true if this TestSubscriber has been cancelled

public final boolean isDisposed ()

Returns true if this resource has been disposed.

Returns

true if this resource has been disposed

public void onComplete ()

public void onError (Throwable t)

public void onNext (T t)

public void onSubscribe (Subscription s)

Implementors of this method should make sure everything that needs to be visible in onNext(Object) is established before calling request(long). In practice this means no initialization should happen after the request() call and additional behavior is thread safe in respect to onNext.

public final void request (long n)

public final TestSubscriber<T> requestMore (long n)

Calls request(long) and returns this.

History: 2.0.1 - experimental

Parameters

n	the request amount

Classes

TestSubscriber

Class Overview

Summary

Public Constructors

public TestSubscriber ()

public TestSubscriber (long initialRequest)

Parameters

public TestSubscriber (Subscriber<? super T> actual)

Parameters

public TestSubscriber (Subscriber<? super T> actual, long initialRequest)

Parameters

Public Methods

public final TestSubscriber<T> assertNotSubscribed ()

Returns

public final TestSubscriber<T> assertOf (Consumer<? super TestSubscriber<T>> check)

Parameters

Returns

public final TestSubscriber<T> assertSubscribed ()

Returns

public final void cancel ()

public static TestSubscriber<T> create (long initialRequested)

Parameters

Returns

public static TestSubscriber<T> create ()

Returns

public static TestSubscriber<T> create (Subscriber<? super T> delegate)

Parameters

Returns

public final void dispose ()

public final boolean hasSubscription ()

Returns

public final boolean isCancelled ()

Returns

public final boolean isDisposed ()

Returns

public void onComplete ()

public void onError (Throwable t)

public void onNext (T t)

public void onSubscribe (Subscription s)

public final void request (long n)

public final TestSubscriber<T> requestMore (long n)

Parameters

Returns

Protected Methods

protected void onStart ()