com.rxc

Class TestSubscriber<T>

java.lang.Object

rx.Subscriber<T>

com.rxc.TestSubscriber<T>

Type Parameters:

T - The type of values that will be emitted by the Observable

All Implemented Interfaces:

rx.Observer<T>, rx.Subscription

public class TestSubscriber<T>
extends rx.Subscriber<T>

A Subscriber that records all events so that assertions can be made against them for testing purposes TestSubscriber is entirely thread safe and makes no assumptions about the Observable contract

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TestSubscriber.AssertionChain A fluent class used to walk the chain of events received by a TestSubscriber and make assertions against each event in the order received

Constructor Summary

Constructors

Constructor and Description
TestSubscriber()

Method Summary

Modifier and Type	Method and Description
void	assertDoesNotHaveEvent(org.hamcrest.Matcher<rx.Notification> matcher) Asserts that this Subscriber has not received an event matching the given matcher
void	assertHasEvent(org.hamcrest.Matcher<rx.Notification> matcher) Asserts that this Subscriber has received an event matching the given matcher
void	assertWellBehaved()
void	awaitEvent(org.hamcrest.Matcher<rx.Notification> matcher) Holds the current thread until the subscriber has received an events that match the given matcher
void	awaitEvent(org.hamcrest.Matcher<rx.Notification> matcher, int times) Holds the current thread until the subscriber has received a certain number of events that match the given matcher
void	awaitEvent(org.hamcrest.Matcher<rx.Notification> matcher, int times, long timeout, java.util.concurrent.TimeUnit timeUnit) Holds the current thread until the subscriber has received a certain number of events that match the given matcher
void	awaitEvent(org.hamcrest.Matcher<rx.Notification> matcher, long timeout, java.util.concurrent.TimeUnit timeUnit) Holds the current thread until the subscriber has received an events that match the given matcher
TestSubscriber.AssertionChain	beginAssertionChain() Begins a TestSubscriber.AssertionChain that will make assertions against all of the events that have been recorded
void	onCompleted()
void	onError(java.lang.Throwable e)
void	onNext(T t)

Methods inherited from class rx.Subscriber

add, isUnsubscribed, onStart, request, setProducer, unsubscribe

Methods inherited from class java.lang.Object

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

Constructor Detail

TestSubscriber

public TestSubscriber()

Method Detail

onCompleted

public void onCompleted()

onError

public void onError(java.lang.Throwable e)

onNext

public void onNext(T t)

awaitEvent

public void awaitEvent(org.hamcrest.Matcher<rx.Notification> matcher,
                       int times,
                       long timeout,
                       java.util.concurrent.TimeUnit timeUnit)
                throws java.lang.InterruptedException

Holds the current thread until the subscriber has received a certain number of events that match the given matcher

This is useful for waiting until a Observable is in a certain state before making assumptions against it's events

Fails: When the proper number of matching events aren't recorded before a timeout occurs

Parameters:

matcher - The matcher used for checking the events

times - How many events need to be seen that match before the thread is released

timeout - How long to wait before timing out

timeUnit - The unit to be used for the timeout

Throws:

java.lang.InterruptedException - When the thread is interrupted

awaitEvent

public void awaitEvent(org.hamcrest.Matcher<rx.Notification> matcher,
                       int times)
                throws java.lang.InterruptedException

Holds the current thread until the subscriber has received a certain number of events that match the given matcher

This is useful for waiting until a Observable is in a certain state before making assumptions against it's events

The wait will timeout after ms

Fails: When the proper number of matching events aren't recorded before a timeout occurs

Parameters:

matcher - The matcher used for checking the events

times - How many events need to be seen that match before the thread is released

Throws:

java.lang.InterruptedException - When the thread is interrupted

awaitEvent

public void awaitEvent(org.hamcrest.Matcher<rx.Notification> matcher,
                       long timeout,
                       java.util.concurrent.TimeUnit timeUnit)
                throws java.lang.InterruptedException

Holds the current thread until the subscriber has received an events that match the given matcher

This is useful for waiting until a Observable is in a certain state before making assumptions against it's events

Fails: When a matching event isn't recorded before a timeout occurs

Parameters:

matcher - The matcher used for checking the events

timeout - How long to wait before timing out

timeUnit - The unit to be used for the timeout

Throws:

java.lang.InterruptedException - When the thread is interrupted

awaitEvent

public void awaitEvent(org.hamcrest.Matcher<rx.Notification> matcher)
                throws java.lang.InterruptedException

Holds the current thread until the subscriber has received an events that match the given matcher

This is useful for waiting until a Observable is in a certain state before making assumptions against it's events

The wait will timeout after ms

Fails: When a matching event isn't recorded before a timeout occurs

Parameters:

matcher - The matcher used for checking the events

Throws:

java.lang.InterruptedException - When the thread is interrupted

beginAssertionChain

public TestSubscriber.AssertionChain beginAssertionChain()

Begins a TestSubscriber.AssertionChain that will make assertions against all of the events that have been recorded

Returns:

The AssertionChain to make AssertionsAgainst

assertHasEvent

public void assertHasEvent(org.hamcrest.Matcher<rx.Notification> matcher)

Asserts that this Subscriber has received an event matching the given matcher

Parameters:

matcher - The matcher to check with

assertDoesNotHaveEvent

public void assertDoesNotHaveEvent(org.hamcrest.Matcher<rx.Notification> matcher)

Asserts that this Subscriber has not received an event matching the given matcher

Parameters:

matcher - The matcher to check with

assertWellBehaved

public void assertWellBehaved()