TestSubscriber (rxjava2-backport 2.0.0-RC2 API)

java.lang.Object
- hu.akarnokd.rxjava2.subscribers.TestSubscriber<T>

Type Parameters:

T - the value type

All Implemented Interfaces:

Disposable, org.reactivestreams.Subscriber<T>, org.reactivestreams.Subscription
```
public class TestSubscriber<T>
extends java.lang.Object
implements org.reactivestreams.Subscriber<T>, org.reactivestreams.Subscription, Disposable
```
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 desing).
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.

Constructor Summary

Constructors
Constructor and Description
`TestSubscriber()` Constructs a non-forwarding TestSubscriber with an initial request value of Long.MAX_VALUE.
`TestSubscriber(java.lang.Long initialRequest)` Constructs a non-forwarding TestSubscriber with the specified initial request value.
`TestSubscriber(org.reactivestreams.Subscriber<? super T> actual)` Constructs a forwarding TestSubscriber but leaves the requesting to the wrapped subscriber.
`TestSubscriber(org.reactivestreams.Subscriber<? super T> actual, java.lang.Long initialRequest)` Constructs a forwarding TestSubscriber with the specified initial request value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`assertComplete()` Assert that this TestSubscriber received exactly one onComplete event.
`void`	`assertError(java.lang.Class<? extends java.lang.Throwable> errorClass)` Asserts that this TestSubscriber received exactly one onError event which is an instance of the specified errorClass class.
`void`	`assertError(java.lang.Throwable error)` Assert that this TestSubscriber received exactly the specified onError event value.
`void`	`assertErrorMessage(java.lang.String message)`
`void`	`assertNoErrors()` Assert that this TestSubscriber has not received any onError event.
`void`	`assertNotComplete()` Assert that this TestSubscriber has not received any onComplete event.
`void`	`assertNotSubscribed()` Assert that the onSubscribe method hasn't been called at all.
`void`	`assertNotTerminated()` Assert that the TestSubscriber has not terminated (i.e., the terminal latch is still non-zero).
`void`	`assertNoValues()` Assert that this TestSubscriber has not received any onNext events.
`void`	`assertSubscribed()` Assert that the onSubscribe method was called exactly once.
`void`	`assertTerminated()` Assert that the TestSubscriber terminated (i.e., the terminal latch reached zero).
`void`	`assertValue(T value)` Assert that this TestSubscriber received exactly one onNext value which is equal to the given value with respect to Objects.equals.
`void`	`assertValueCount(int count)` Assert that this TestSubscriber received the specified number onNext events.
`void`	`assertValues(T... values)` Assert that the TestSubscriber received only the specified values in the specified order.
`void`	`assertValueSequence(java.lang.Iterable<? extends T> sequence)` Assert that the TestSubscriber received only the specified sequence of values in the same order.
`void`	`assertValueSet(java.util.Collection<? extends T> values)` Assert that the TestSubscriber received only the specified values in any order.
`void`	`await()` Awaits until this TestSubscriber receives an onError or onComplete events.
`boolean`	`await(long time, java.util.concurrent.TimeUnit unit)` Awaits the specified amount of time or until this TestSubscriber receives an onError or onComplete events, whichever happens first.
`boolean`	`awaitTerminalEvent()` Waits until the any terminal event has been received by this TestSubscriber or returns false if the wait has been interrupted.
`boolean`	`awaitTerminalEvent(long duration, java.util.concurrent.TimeUnit unit)` Awaits the specified amount of time or until this TestSubscriber receives an onError or onComplete events, whichever happens first.
`void`	`cancel()`
`long`	`completions()` Returns the number of times onComplete was called.
`void`	`dispose()` Dispose the resource, the operation should be idempotent.
`int`	`errorCount()` Returns the number of onError exceptions received.
`java.util.List<java.lang.Throwable>`	`errors()` Returns a shared list of received onError exceptions.
`java.util.List<java.util.List<java.lang.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.
`boolean`	`hasSubscription()` Returns true if this TestSubscriber received a subscription.
`boolean`	`isCancelled()` Returns true if this TestSubscriber has been cancelled.
`boolean`	`isTerminated()` Returns true if TestSubscriber received any onError or onComplete events.
`java.lang.Thread`	`lastThread()` Returns the last thread which called the onXXX methods of this TestSubscriber.
`void`	`onComplete()`
`void`	`onError(java.lang.Throwable t)`
`void`	`onNext(T t)`
`void`	`onSubscribe(org.reactivestreams.Subscription s)`
`void`	`request(long n)`
`int`	`valueCount()` Returns the number of onNext values received.
`java.util.List<T>`	`values()` Returns a shared list of received onNext values.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TestSubscriber
```
public TestSubscriber()
```
    Constructs a non-forwarding TestSubscriber with an initial request value of Long.MAX_VALUE.
  - TestSubscriber
```
public TestSubscriber(java.lang.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 if not null
  - TestSubscriber
```
public TestSubscriber(org.reactivestreams.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
  - TestSubscriber
```
public TestSubscriber(org.reactivestreams.Subscriber<? super T> actual,
                      java.lang.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 if not null
- Method Detail
  - onSubscribe
```
public void onSubscribe(org.reactivestreams.Subscription s)
```
    Specified by:
    
    onSubscribe in interface org.reactivestreams.Subscriber<T>
  - onNext
```
public void onNext(T t)
```
    Specified by:
    
    onNext in interface org.reactivestreams.Subscriber<T>
  - onError
```
public void onError(java.lang.Throwable t)
```
    Specified by:
    
    onError in interface org.reactivestreams.Subscriber<T>
  - onComplete
```
public void onComplete()
```
    Specified by:
    
    onComplete in interface org.reactivestreams.Subscriber<T>
  - request
```
public void request(long n)
```
    Specified by:
    
    request in interface org.reactivestreams.Subscription
  - cancel
```
public void cancel()
```
    Specified by:
    
    cancel in interface org.reactivestreams.Subscription
  - isCancelled
```
public final boolean isCancelled()
```
    Returns true if this TestSubscriber has been cancelled.
    
    Returns:
    
    true if this TestSubscriber has been cancelled
  - dispose
```
public final void dispose()
```
    Description copied from interface: Disposable
    
    Dispose the resource, the operation should be idempotent.
    
    Specified by:
    
    dispose in interface Disposable
  - lastThread
```
public final java.lang.Thread lastThread()
```
    Returns the last thread which called the onXXX methods of this TestSubscriber.
    
    Returns:
    
    the last thread which called the onXXX methods
  - values
```
public final java.util.List<T> values()
```
    Returns a shared list of received onNext values.
    
    Returns:
    
    a list of received onNext values
  - errors
```
public final java.util.List<java.lang.Throwable> errors()
```
    Returns a shared list of received onError exceptions.
    
    Returns:
    
    a list of received events onError exceptions
  - completions
```
public final long completions()
```
    Returns the number of times onComplete was called.
    
    Returns:
    
    the number of times onComplete was called
  - isTerminated
```
public final boolean isTerminated()
```
    Returns true if TestSubscriber received any onError or onComplete events.
    
    Returns:
    
    true if TestSubscriber received any onError or onComplete events
  - valueCount
```
public final int valueCount()
```
    Returns the number of onNext values received.
    
    Returns:
    
    the number of onNext values received
  - errorCount
```
public final int errorCount()
```
    Returns the number of onError exceptions received.
    
    Returns:
    
    the number of onError exceptions received
  - hasSubscription
```
public final boolean hasSubscription()
```
    Returns true if this TestSubscriber received a subscription.
    
    Returns:
    
    true if this TestSubscriber received a subscription
  - await
```
public final void await()
                 throws java.lang.InterruptedException
```
    Awaits until this TestSubscriber receives an onError or onComplete events.
    
    Throws:
    
    java.lang.InterruptedException - if the current thread is interrupted while waiting
    
    See Also:
    
    awaitTerminalEvent()
  - await
```
public final boolean await(long time,
                           java.util.concurrent.TimeUnit unit)
                    throws java.lang.InterruptedException
```
    Awaits the specified amount of time or until this TestSubscriber receives an onError or onComplete events, whichever happens first.
    
    Parameters:
    
    time - the waiting time
    
    unit - the time unit of the waiting time
    
    Returns:
    
    true if the TestSubscriber terminated, false if timeout happened
    
    Throws:
    
    java.lang.InterruptedException - if the current thread is interrupted while waiting
    
    See Also:
    
    awaitTerminalEvent(long, TimeUnit)
  - assertComplete
```
public void assertComplete()
```
    Assert that this TestSubscriber received exactly one onComplete event.
  - assertNotComplete
```
public void assertNotComplete()
```
    Assert that this TestSubscriber has not received any onComplete event.
  - assertNoErrors
```
public void assertNoErrors()
```
    Assert that this TestSubscriber has not received any onError event.
  - assertError
```
public void assertError(java.lang.Throwable error)
```
    Assert that this TestSubscriber received exactly the specified onError event value.
    The comparison is performed via Objects.equals(); since most exceptions don't implement equals(), this assertion may fail. Use the assertError(Class) overload to test against the class of an error instead of an instance of an error.
    
    Parameters:
    
    error - the error to check
    
    See Also:
    
    assertError(Class)
  - assertError
```
public void assertError(java.lang.Class<? extends java.lang.Throwable> errorClass)
```
    Asserts that this TestSubscriber received exactly one onError event which is an instance of the specified errorClass class.
    
    Parameters:
    
    errorClass - the error class to expect
  - assertValue
```
public final void assertValue(T value)
```
    Assert that this TestSubscriber received exactly one onNext value which is equal to the given value with respect to Objects.equals.
    
    Parameters:
    
    value - the value to expect
  - assertValueCount
```
public final void assertValueCount(int count)
```
    Assert that this TestSubscriber received the specified number onNext events.
    
    Parameters:
    
    count - the expected number of onNext events
  - assertNoValues
```
public final void assertNoValues()
```
    Assert that this TestSubscriber has not received any onNext events.
  - assertValues
```
public final void assertValues(T... values)
```
    Assert that the TestSubscriber received only the specified values in the specified order.
    
    Parameters:
    
    values - the values expected
    
    See Also:
    
    assertValueSet(Collection)
  - assertValueSet
```
public final void assertValueSet(java.util.Collection<? extends T> values)
```
    Assert that the TestSubscriber received only the specified values in any order.
    This helps asserting when the order of the values is not guaranteed, i.e., when merging asynchronous streams.
    
    Parameters:
    
    values - the collection of values expected in any order
  - assertValueSequence
```
public final void assertValueSequence(java.lang.Iterable<? extends T> sequence)
```
    Assert that the TestSubscriber received only the specified sequence of values in the same order.
    
    Parameters:
    
    sequence - the sequence of expected values in order
  - assertTerminated
```
public final void assertTerminated()
```
    Assert that the TestSubscriber terminated (i.e., the terminal latch reached zero).
  - assertNotTerminated
```
public final void assertNotTerminated()
```
    Assert that the TestSubscriber has not terminated (i.e., the terminal latch is still non-zero).
  - assertSubscribed
```
public final void assertSubscribed()
```
    Assert that the onSubscribe method was called exactly once.
  - assertNotSubscribed
```
public final void assertNotSubscribed()
```
    Assert that the onSubscribe method hasn't been called at all.
  - awaitTerminalEvent
```
public boolean awaitTerminalEvent()
```
    Waits until the any terminal event has been received by this TestSubscriber or returns false if the wait has been interrupted.
    
    Returns:
    
    true if the TestSubscriber terminated, false if the wait has been interrupted
  - awaitTerminalEvent
```
public boolean awaitTerminalEvent(long duration,
                                  java.util.concurrent.TimeUnit unit)
```
    Awaits the specified amount of time or until this TestSubscriber receives an onError or onComplete events, whichever happens first.
    
    Parameters:
    
    duration - the waiting time
    
    unit - the time unit of the waiting time
    
    Returns:
    
    true if the TestSubscriber terminated, false if timeout or interrupt happened
  - assertErrorMessage
```
public void assertErrorMessage(java.lang.String message)
```
  - getEvents
```
public java.util.List<java.util.List<java.lang.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.
    
    Returns:
    
    a list of (values, errors, completion-notifications)

Class TestSubscriber<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TestSubscriber

TestSubscriber

TestSubscriber

TestSubscriber

Method Detail

onSubscribe

onNext

onError

onComplete

request

cancel

isCancelled

dispose

lastThread

values

errors

completions

isTerminated

valueCount

errorCount

hasSubscription

await

await

assertComplete

assertNotComplete

assertNoErrors

assertError

assertError

assertValue

assertValueCount

assertNoValues

assertValues

assertValueSet

assertValueSequence

assertTerminated

assertNotTerminated

assertSubscribed

assertNotSubscribed

awaitTerminalEvent

awaitTerminalEvent

assertErrorMessage

getEvents