rx.observers

Class TestSubscriber<T>

java.lang.Object

rx.Subscriber<T>

rx.observers.TestSubscriber<T>

All Implemented Interfaces:

Observer<T>, Subscription

public class TestSubscriber<T>
extends Subscriber<T>

A TestSubscriber is a variety of Subscriber that you can use for unit testing, to perform assertions, inspect received events, or wrap a mocked Subscriber.

Constructor Summary

Constructors

Constructor and Description
TestSubscriber()
TestSubscriber(long initialRequest) Constructs a TestSubscriber with the initial request to be requested from upstream.
TestSubscriber(Observer<T> delegate)
TestSubscriber(Observer<T> delegate, long initialRequest) Constructs a TestSubscriber with the initial request to be requested from upstream and a delegate Observer to wrap.
TestSubscriber(Subscriber<T> delegate)

Method Summary

Methods

Modifier and Type	Method and Description
void	assertCompleted() Asserts that there is exactly one completion event.
void	assertError(java.lang.Class<? extends java.lang.Throwable> clazz) Asserts that there is exactly one error event which is a subclass of the given class.
void	assertError(java.lang.Throwable throwable) Asserts that there is a single onError event with the exact exception.
void	assertNoErrors() Asserts that this Subscriber has received no onError notifications.
void	assertNotCompleted() Asserts that there is no completion event.
void	assertNoTerminalEvent() Asserts that there are no onError and onCompleted events.
void	assertNoValues() Asserts that there are no onNext events received.
void	assertReceivedOnNext(java.util.List<T> items) Asserts that a particular sequence of items was received by this Subscriber in order.
void	assertTerminalEvent() Asserts that a single terminal event occurred, either onCompleted() or onError(java.lang.Throwable).
void	assertUnsubscribed() Asserts that this Subscriber is unsubscribed.
void	assertValue(T value) Asserts that there is only a single received onNext event and that it marks the emission of a specific item.
void	assertValueCount(int count) Asserts that the given number of onNext events are received.
void	assertValues(T... values) Asserts that the received onNext events, in order, are the specified items.
void	awaitTerminalEvent() Blocks until this Subscriber receives a notification that the Observable is complete (either an onCompleted or onError notification).
void	awaitTerminalEvent(long timeout, java.util.concurrent.TimeUnit unit) Blocks until this Subscriber receives a notification that the Observable is complete (either an onCompleted or onError notification), or until a timeout expires.
void	awaitTerminalEventAndUnsubscribeOnTimeout(long timeout, java.util.concurrent.TimeUnit unit) Blocks until this Subscriber receives a notification that the Observable is complete (either an onCompleted or onError notification), or until a timeout expires; if the Subscriber is interrupted before either of these events take place, this method unsubscribes the Subscriber from the Observable).
static <T> TestSubscriber<T>	create()
static <T> TestSubscriber<T>	create(long initialRequest)
static <T> TestSubscriber<T>	create(Observer<T> delegate)
static <T> TestSubscriber<T>	create(Observer<T> delegate, long initialRequest)
static <T> TestSubscriber<T>	create(Subscriber<T> delegate)
java.lang.Thread	getLastSeenThread() Returns the last thread that was in use when an item or notification was received by this Subscriber.
java.util.List<Notification<T>>	getOnCompletedEvents() Returns the Notifications representing each time this Subscriber was notified of sequence completion via onCompleted(), as a List.
java.util.List<java.lang.Throwable>	getOnErrorEvents() Returns the Throwables this Subscriber was notified of via onError(java.lang.Throwable) as a List.
java.util.List<T>	getOnNextEvents() Returns the sequence of items observed by this Subscriber, as an ordered List.
void	onCompleted() Notifies the Subscriber that the Observable has finished sending push-based notifications.
void	onError(java.lang.Throwable e) Notifies the Subscriber that the Observable has experienced an error condition.
void	onNext(T t) Provides the Subscriber with a new item to observe.
void	onStart() This method is invoked when the Subscriber and Observable have been connected but the Observable has not yet begun to emit items or send notifications to the Subscriber.
void	requestMore(long n) Allows calling the protected Subscriber.request(long) from unit tests.

Methods inherited from class rx.Subscriber

add, isUnsubscribed, request, setProducer, unsubscribe

Methods inherited from class java.lang.Object

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

Constructor Detail

TestSubscriber

@Experimental
public TestSubscriber(long initialRequest)

Constructs a TestSubscriber with the initial request to be requested from upstream.

Parameters:

initialRequest - the initial request value, negative value will revert to the default unbounded behavior

Since:

(if this graduates from "Experimental" replace this parenthetical with the release number)

TestSubscriber

@Experimental
public TestSubscriber(Observer<T> delegate,
                           long initialRequest)

Constructs a TestSubscriber with the initial request to be requested from upstream and a delegate Observer to wrap.

Parameters:

initialRequest - the initial request value, negative value will revert to the default unbounded behavior

delegate - the Observer instance to wrap

Since:

(if this graduates from "Experimental" replace this parenthetical with the release number)

TestSubscriber

public TestSubscriber(Subscriber<T> delegate)

TestSubscriber

public TestSubscriber(Observer<T> delegate)

TestSubscriber

public TestSubscriber()

Method Detail

create

@Experimental
public static <T> TestSubscriber<T> create()

create

@Experimental
public static <T> TestSubscriber<T> create(long initialRequest)

create

@Experimental
public static <T> TestSubscriber<T> create(Observer<T> delegate,
                                        long initialRequest)

create

@Experimental
public static <T> TestSubscriber<T> create(Subscriber<T> delegate)

create

@Experimental
public static <T> TestSubscriber<T> create(Observer<T> delegate)

onStart

public void onStart()

Description copied from class: Subscriber

This method is invoked when the Subscriber and Observable have been connected but the Observable has not yet begun to emit items or send notifications to the Subscriber. Override this method to add any useful initialization to your subscription, for instance to initiate backpressure.

Overrides:

onStart in class Subscriber<T>

onCompleted

public void onCompleted()

Notifies the Subscriber that the Observable has finished sending push-based notifications.

The Observable will not call this method if it calls onError(java.lang.Throwable).

getOnCompletedEvents

public java.util.List<Notification<T>> getOnCompletedEvents()

Returns the Notifications representing each time this Subscriber was notified of sequence completion via onCompleted(), as a List.

Returns:

a list of Notifications representing calls to this Subscriber's onCompleted() method

onError

public void onError(java.lang.Throwable e)

Notifies the Subscriber that the Observable has experienced an error condition.

If the Observable calls this method, it will not thereafter call onNext(T) or onCompleted().

Parameters:

e - the exception encountered by the Observable

getOnErrorEvents

public java.util.List<java.lang.Throwable> getOnErrorEvents()

Returns the Throwables this Subscriber was notified of via onError(java.lang.Throwable) as a List.

Returns:

a list of the Throwables that were passed to this Subscriber's onError(java.lang.Throwable) method

onNext

public void onNext(T t)

Provides the Subscriber 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 onCompleted() or onError(java.lang.Throwable).

Parameters:

t - the item emitted by the Observable

requestMore

public void requestMore(long n)

Allows calling the protected Subscriber.request(long) from unit tests.

Parameters:

n - the maximum number of items you want the Observable to emit to the Subscriber at this time, or Long.MAX_VALUE if you want the Observable to emit items at its own pace

getOnNextEvents

public java.util.List<T> getOnNextEvents()

Returns the sequence of items observed by this Subscriber, as an ordered List.

Returns:

a list of items observed by this Subscriber, in the order in which they were observed

assertReceivedOnNext

public void assertReceivedOnNext(java.util.List<T> items)

Asserts that a particular sequence of items was received by this Subscriber in order.

Parameters:

items - the sequence of items expected to have been observed

Throws:

java.lang.AssertionError - if the sequence of items observed does not exactly match items

assertTerminalEvent

public void assertTerminalEvent()

Asserts that a single terminal event occurred, either onCompleted() or onError(java.lang.Throwable).

Throws:

java.lang.AssertionError - if not exactly one terminal event notification was received

assertUnsubscribed

public void assertUnsubscribed()

Asserts that this Subscriber is unsubscribed.

Throws:

java.lang.AssertionError - if this Subscriber is not unsubscribed

assertNoErrors

public void assertNoErrors()

Asserts that this Subscriber has received no onError notifications.

Throws:

java.lang.AssertionError - if this Subscriber has received one or more onError notifications

awaitTerminalEvent

public void awaitTerminalEvent()

Blocks until this Subscriber receives a notification that the Observable is complete (either an onCompleted or onError notification).

Throws:

java.lang.RuntimeException - if the Subscriber is interrupted before the Observable is able to complete

awaitTerminalEvent

public void awaitTerminalEvent(long timeout,
                      java.util.concurrent.TimeUnit unit)

Blocks until this Subscriber receives a notification that the Observable is complete (either an onCompleted or onError notification), or until a timeout expires.

Parameters:

timeout - the duration of the timeout

unit - the units in which timeout is expressed

Throws:

java.lang.RuntimeException - if the Subscriber is interrupted before the Observable is able to complete

awaitTerminalEventAndUnsubscribeOnTimeout

public void awaitTerminalEventAndUnsubscribeOnTimeout(long timeout,
                                             java.util.concurrent.TimeUnit unit)

Blocks until this Subscriber receives a notification that the Observable is complete (either an onCompleted or onError notification), or until a timeout expires; if the Subscriber is interrupted before either of these events take place, this method unsubscribes the Subscriber from the Observable). If timeout expires then the Subscriber is unsubscribed from the Observable.

Parameters:

timeout - the duration of the timeout

unit - the units in which timeout is expressed

getLastSeenThread

public java.lang.Thread getLastSeenThread()

Returns the last thread that was in use when an item or notification was received by this Subscriber.

Returns:

the Thread on which this Subscriber last received an item or notification from the Observable it is subscribed to

assertCompleted

@Experimental
public void assertCompleted()

Asserts that there is exactly one completion event.

Throws:

java.lang.AssertionError - if there were zero, or more than one, onCompleted events

Since:

(if this graduates from "Experimental" replace this parenthetical with the release number)

assertNotCompleted

@Experimental
public void assertNotCompleted()

Asserts that there is no completion event.

Throws:

java.lang.AssertionError - if there were one or more than one onCompleted events

Since:

(if this graduates from "Experimental" replace this parenthetical with the release number)

assertError

@Experimental
public void assertError(java.lang.Class<? extends java.lang.Throwable> clazz)

Asserts that there is exactly one error event which is a subclass of the given class.

Parameters:

clazz - the class to check the error against.

Throws:

java.lang.AssertionError - if there were zero, or more than one, onError events, or if the single onError event did not carry an error of a subclass of the given class

Since:

(if this graduates from "Experimental" replace this parenthetical with the release number)

assertError

@Experimental
public void assertError(java.lang.Throwable throwable)

Asserts that there is a single onError event with the exact exception.

Parameters:

throwable - the throwable to check

Throws:

java.lang.AssertionError - if there were zero, or more than one, onError events, or if the single onError event did not carry an error that matches the specified throwable

Since:

(if this graduates from "Experimental" replace this parenthetical with the release number)

assertNoTerminalEvent

@Experimental
public void assertNoTerminalEvent()

Asserts that there are no onError and onCompleted events.

Throws:

java.lang.AssertionError - if there was either an onError or onCompleted event

Since:

(if this graduates from "Experimental" replace this parenthetical with the release number)

assertNoValues

@Experimental
public void assertNoValues()

Asserts that there are no onNext events received.

Throws:

java.lang.AssertionError - if there were any onNext events

Since:

(if this graduates from "Experimental" replace this parenthetical with the release number)

assertValueCount

@Experimental
public void assertValueCount(int count)

Asserts that the given number of onNext events are received.

Parameters:

count - the expected number of onNext events

Throws:

java.lang.AssertionError - if there were more or fewer onNext events than specified by count

Since:

(if this graduates from "Experimental" replace this parenthetical with the release number)

assertValues

@Experimental
public void assertValues(T... values)

Asserts that the received onNext events, in order, are the specified items.

Parameters:

values - the items to check

Throws:

java.lang.AssertionError - if the items emitted do not exactly match those specified by values

Since:

(if this graduates from "Experimental" replace this parenthetical with the release number)

assertValue

@Experimental
public void assertValue(T value)

Asserts that there is only a single received onNext event and that it marks the emission of a specific item.

Parameters:

value - the item to check

Throws:

java.lang.AssertionError - if the Observable does not emit only the single item specified by value

Since:

(if this graduates from "Experimental" replace this parenthetical with the release number)