Summary: Inherited Fields | Ctors | Methods | Inherited Methods | [Expand All]

public class

TestObserver

extends BaseTestConsumer<T, U extends BaseTestConsumer<T, U>>
implements CompletableObserver MaybeObserver<T> Observer<T> SingleObserver<T> Disposable

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

Class Overview

An Observer that records events and allows making assertions about them.

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

The TestObserver implements Disposable for convenience where dispose calls cancel.

Summary

[Expand]

Inherited Fields

From class io.reactivex.observers.BaseTestConsumer

Public Constructors
	TestObserver() Constructs a non-forwarding TestObserver.
	TestObserver(Observer<? super T> actual) Constructs a forwarding TestObserver.

Public Methods
final TestObserver<T>	assertNotSubscribed() Assert that the onSubscribe method hasn't been called at all.
final TestObserver<T>	assertOf(Consumer<? super TestObserver<T>> check) Run a check consumer with this TestObserver instance.
final TestObserver<T>	assertSubscribed() Assert that the onSubscribe method was called exactly once.
final void	cancel() Cancels the TestObserver (before or after the subscription happened).
static <T> TestObserver<T>	create(Observer<? super T> delegate) Constructs a forwarding TestObserver.
static <T> TestObserver<T>	create() Constructs a non-forwarding TestObserver.
final void	dispose() Dispose the resource, the operation should be idempotent.
final boolean	hasSubscription() Returns true if this TestObserver received a subscription.
final boolean	isCancelled() Returns true if this TestObserver has been cancelled.
final boolean	isDisposed() Returns true if this resource has been disposed.
void	onComplete() Called once the deferred computation completes normally.
void	onError(Throwable t) Called once if the deferred computation 'throws' an exception.
void	onNext(T t) Provides the Observer with a new item to observe.
void	onSubscribe(Disposable s) Called once by the Completable to set a Disposable on this instance which then can be used to cancel the subscription at any time.
void	onSuccess(T value) Notifies the MaybeObserver with one item and that the `Maybe` has finished sending push-based notifications.

[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.CompletableObserver

From interface io.reactivex.MaybeObserver

From interface io.reactivex.Observer

From interface io.reactivex.SingleObserver

From interface io.reactivex.disposables.Disposable

Public Constructors

public TestObserver ()

Constructs a non-forwarding TestObserver.

public TestObserver (Observer<? super T> actual)

Constructs a forwarding TestObserver.

Parameters

actual	the actual Observer to forward events to

Public Methods

public final TestObserver<T> assertNotSubscribed ()

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

Returns

this;

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

Run a check consumer with this TestObserver instance.

Parameters

check	the check consumer to run

Returns

this

public final TestObserver<T> assertSubscribed ()

Assert that the onSubscribe method was called exactly once.

Returns

this;

public final void cancel ()

Cancels the TestObserver (before or after the subscription happened).

This operation is thread-safe.

This method is provided as a convenience when converting Flowable tests that cancel.

public static TestObserver<T> create (Observer<? super T> delegate)

Constructs a forwarding TestObserver.

Parameters

delegate	the actual Observer to forward events to

Returns

the new TestObserver instance

public static TestObserver<T> create ()

Constructs a non-forwarding TestObserver.

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 TestObserver received a subscription.

Returns

true if this TestObserver received a subscription

public final boolean isCancelled ()

Returns true if this TestObserver has been cancelled.

Returns

true if this TestObserver 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 ()

Called once the deferred computation completes normally.

public void onError (Throwable t)

Called once if the deferred computation 'throws' an exception.

Parameters

t	the exception, not null.

public void onNext (T t)

Provides the Observer with a new item to observe.

The Observable may call this method 0 or more times.

The Observable will not call this method again after it calls either onComplete() or onError(Throwable).

Parameters

t	the item emitted by the Observable

public void onSubscribe (Disposable s)

Called once by the Completable to set a Disposable on this instance which then can be used to cancel the subscription at any time.

Parameters

s	the Disposable instance to call dispose on for cancellation, not null

public void onSuccess (T value)

Notifies the MaybeObserver with one item and that the Maybe has finished sending push-based notifications.

The Maybe will not call this method if it calls onError(Throwable).

Parameters

value	the item emitted by the Maybe

Classes

Enums

TestObserver

Class Overview

Summary

Public Constructors

public TestObserver ()

public TestObserver (Observer<? super T> actual)

Parameters

Public Methods

public final TestObserver<T> assertNotSubscribed ()

Returns

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

Parameters

Returns

public final TestObserver<T> assertSubscribed ()

Returns

public final void cancel ()

public static TestObserver<T> create (Observer<? super T> delegate)

Parameters

Returns

public static TestObserver<T> create ()

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)

Parameters

public void onNext (T t)

Parameters

public void onSubscribe (Disposable s)

Parameters

public void onSuccess (T value)

Parameters