AssertableSubscriber (RxJava Javadoc 1.3.8)

Type Parameters:

T - the value type consumed by this Observer

All Superinterfaces:

Observer, Subscription
```
public interface AssertableSubscriber
extends Observer, Subscription
```
Interface for asserting the state of a sequence under testing with a test() method of a reactive base class.
This interface is not intended to be implemented outside of RxJava.
This interface extends Observer and allows injecting onXXX signals into the testing process.
History: 1.2.3 - experimental

Since:

1.3

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AssertableSubscriber<T>`	`assertCompleted()` Assert that this Observer received exaclty one `onCompleted` signal.
`AssertableSubscriber<T>`	`assertError(java.lang.Class clazz)` Assert that this Observer received one `onError` signal with the given subclass of a Throwable as type.
`AssertableSubscriber<T>`	`assertError(java.lang.Throwable throwable)` Assert that this Observer received one `onError` signal with the object-equals of the given Throwable instance
`AssertableSubscriber<T>`	`assertFailure(java.lang.Class errorClass, T... values)` Assert that this Observer received the specified items in the given order followed by an error signal of the given type (but no completion signal).
`AssertableSubscriber<T>`	`assertFailureAndMessage(java.lang.Class errorClass, java.lang.String message, T... values)` Assert that this Observer received the specified items in the given order followed by an error signal of the given type and with the exact error message (but no completion signal).
`AssertableSubscriber<T>`	`assertNoErrors()` Assert that this Observer has not received any `onError` signal.
`AssertableSubscriber<T>`	`assertNotCompleted()` Assert that this Observer received no `onCompleted` signal.
`AssertableSubscriber<T>`	`assertNoTerminalEvent()` Assert that no `onError` or `onCompleted` signals were received so far.
`AssertableSubscriber<T>`	`assertNoValues()` Assert that no `onNext` signals were received so far.
`AssertableSubscriber<T>`	`assertReceivedOnNext(java.util.List<T> items)` Assert that this Observer received the given list of items as `onNext` signals in the same order and with the default null-safe object equals comparison.
`AssertableSubscriber<T>`	`assertResult(T... values)` Assert that this Observer received the specified items in the given order followed by a completion signal and no errors.
`AssertableSubscriber<T>`	`assertTerminalEvent()` Assert that this Observer received either an `onError` or `onCompleted` signal.
`AssertableSubscriber<T>`	`assertUnsubscribed()` Assert that this Observer has been unsubscribed via `unsubscribe()` or by a wrapping `SafeSubscriber`.
`AssertableSubscriber<T>`	`assertValue(T value)` Assert that this Observer received exactly the given single expected value (compared via null-safe object equals).
`AssertableSubscriber<T>`	`assertValueCount(int count)` Assert that this Observer received exactly the given count of `onNext` signals.
`AssertableSubscriber<T>`	`assertValues(T... values)` Assert that this Observer received exactly the given expected values (compared via null-safe object equals) in the given order.
`AssertableSubscriber<T>`	`assertValuesAndClear(T expectedFirstValue, T... expectedRestValues)` Assert that this Observer received exactly the given values (compared via null-safe object equals) and if so, clears the internal buffer of the underlying Subscriber of these values.
`AssertableSubscriber<T>`	`awaitTerminalEvent()` Waits for an `onError` or {code onCompleted} terminal event indefinitely.
`AssertableSubscriber<T>`	`awaitTerminalEvent(long timeout, java.util.concurrent.TimeUnit unit)` Waits for an `onError` or {code onCompleted} terminal event for the given amount of timeout.
`AssertableSubscriber<T>`	`awaitTerminalEventAndUnsubscribeOnTimeout(long timeout, java.util.concurrent.TimeUnit unit)` Waits for an `onError` or {code onCompleted} terminal event for the given amount of timeout and unsubscribes the sequence if the timeout passed or the wait itself is interrupted.
`AssertableSubscriber<T>`	`awaitValueCount(int expected, long timeout, java.util.concurrent.TimeUnit unit)` Assert that this Observer receives at least the given number of `onNext` signals within the specified timeout period.
`int`	`getCompletions()` Returns the number of `onCompleted` signals received by this Observer.
`java.lang.Thread`	`getLastSeenThread()` Returns the Thread that has called the last `onNext`, `onError` or `onCompleted` methods of this Observer.
`java.util.List`	`getOnErrorEvents()` Returns a list of received `onError` signals.
`java.util.List<T>`	`getOnNextEvents()` Returns the list of received `onNext` events.
`int`	`getValueCount()` Returns the number of `onNext` signals received by this Observer in a thread-safe manner; one can read up to this number of elements from the `List` returned by `getOnNextEvents()`.
`boolean`	`isUnsubscribed()` Indicates whether this `Subscription` is currently unsubscribed.
`void`	`onStart()` Allows manually calling the `onStart` method of the underlying Subscriber.
`AssertableSubscriber<T>`	`perform(Action0 action)` Performs an action given by the Action0 callback in a fluent manner.
`AssertableSubscriber<T>`	`requestMore(long n)` Requests the specified amount of items from upstream.
`void`	`setProducer(Producer p)` Allows manually calling the `setProducer` method of the underlying Subscriber.
`void`	`unsubscribe()` Stops the receipt of notifications on the `Subscriber` that was registered when this Subscription was received.

Methods inherited from interface rx.Observer
onCompleted, onError, onNext

- Method Detail
  - onStart
```
void onStart()
```
    Allows manually calling the onStart method of the underlying Subscriber.
  - setProducer
```
void setProducer(Producer p)
```
    Allows manually calling the setProducer method of the underlying Subscriber.
    
    Parameters:
    
    p - the producer to use, not null
  - getCompletions
```
int getCompletions()
```
    Returns the number of onCompleted signals received by this Observer.
    
    Returns:
    
    the number of onCompleted signals received
  - getOnErrorEvents
```
java.util.List getOnErrorEvents()
```
    Returns a list of received onError signals.
    
    Returns:
    
    this
  - getValueCount
```
int getValueCount()
```
    Returns the number of onNext signals received by this Observer in a thread-safe manner; one can read up to this number of elements from the List returned by getOnNextEvents().
    
    Returns:
    
    the number of onNext signals received.
  - requestMore
```
AssertableSubscriber<T> requestMore(long n)
```
    Requests the specified amount of items from upstream.
    
    Parameters:
    
    n - the amount requested, non-negative
    
    Returns:
    
    this
  - getOnNextEvents
```
java.util.List<T> getOnNextEvents()
```
    Returns the list of received onNext events.
    If the sequence hasn't completed yet and is asynchronous, use the getValueCount() method to determine how many elements are safe to be read from the list returned by this method.
    
    Returns:
    
    the List of received onNext events.
  - assertReceivedOnNext
```
AssertableSubscriber<T> assertReceivedOnNext(java.util.List<T> items)
```
    Assert that this Observer received the given list of items as onNext signals in the same order and with the default null-safe object equals comparison.
    
    Parameters:
    
    items - the List of items expected
    
    Returns:
    
    this
  - awaitValueCount
```
AssertableSubscriber<T> awaitValueCount(int expected,
                                        long timeout,
                                        java.util.concurrent.TimeUnit unit)
```
    Assert that this Observer receives at least the given number of onNext signals within the specified timeout period.
    Note that it is possible the AssertionError thrown by this method will contain an actual value >= to the expected one in case there is an emission race or unexpected delay on the emitter side. In this case, increase the timeout amount to avoid false positives.
    
    Parameters:
    
    expected - the expected (at least) number of onNext signals
    
    timeout - the timeout to wait to receive the given number of onNext events
    
    unit - the time unit
    
    Returns:
    
    this
  - assertTerminalEvent
```
AssertableSubscriber<T> assertTerminalEvent()
```
    Assert that this Observer received either an onError or onCompleted signal.
    
    Returns:
    
    this
  - assertUnsubscribed
```
AssertableSubscriber<T> assertUnsubscribed()
```
    Assert that this Observer has been unsubscribed via unsubscribe() or by a wrapping SafeSubscriber.
    
    Returns:
    
    this
  - assertNoErrors
```
AssertableSubscriber<T> assertNoErrors()
```
    Assert that this Observer has not received any onError signal.
    
    Returns:
    
    this
  - awaitTerminalEvent
```
AssertableSubscriber<T> awaitTerminalEvent()
```
    Waits for an onError or {code onCompleted} terminal event indefinitely.
    
    Returns:
    
    this
  - awaitTerminalEvent
```
AssertableSubscriber<T> awaitTerminalEvent(long timeout,
                                           java.util.concurrent.TimeUnit unit)
```
    Waits for an onError or {code onCompleted} terminal event for the given amount of timeout.
    
    Parameters:
    
    timeout - the time to wait for the terminal event
    
    unit - the time unit of the wait time
    
    Returns:
    
    this
  - awaitTerminalEventAndUnsubscribeOnTimeout
```
AssertableSubscriber<T> awaitTerminalEventAndUnsubscribeOnTimeout(long timeout,
                                                                  java.util.concurrent.TimeUnit unit)
```
    Waits for an onError or {code onCompleted} terminal event for the given amount of timeout and unsubscribes the sequence if the timeout passed or the wait itself is interrupted.
    
    Parameters:
    
    timeout - the time to wait for the terminal event
    
    unit - the time unit of the wait time
    
    Returns:
    
    this
  - getLastSeenThread
```
java.lang.Thread getLastSeenThread()
```
    Returns the Thread that has called the last onNext, onError or onCompleted methods of this Observer.
    
    Returns:
    
    this
  - assertCompleted
```
AssertableSubscriber<T> assertCompleted()
```
    Assert that this Observer received exaclty one onCompleted signal.
    
    Returns:
    
    this
  - assertNotCompleted
```
AssertableSubscriber<T> assertNotCompleted()
```
    Assert that this Observer received no onCompleted signal.
    
    Returns:
    
    this
  - assertError
```
AssertableSubscriber<T> assertError(java.lang.Class clazz)
```
    Assert that this Observer received one onError signal with the given subclass of a Throwable as type.
    
    Parameters:
    
    clazz - the expected type of the onError signal received
    
    Returns:
    
    this
  - assertError
```
AssertableSubscriber<T> assertError(java.lang.Throwable throwable)
```
    Assert that this Observer received one onError signal with the object-equals of the given Throwable instance
    
    Parameters:
    
    throwable - the Throwable instance expected
    
    Returns:
    
    this
  - assertNoTerminalEvent
```
AssertableSubscriber<T> assertNoTerminalEvent()
```
    Assert that no onError or onCompleted signals were received so far.
    
    Returns:
    
    this
  - assertNoValues
```
AssertableSubscriber<T> assertNoValues()
```
    Assert that no onNext signals were received so far.
    
    Returns:
    
    this
  - assertValueCount
```
AssertableSubscriber<T> assertValueCount(int count)
```
    Assert that this Observer received exactly the given count of onNext signals.
    
    Parameters:
    
    count - the expected number of onNext signals
    
    Returns:
    
    this
  - assertValues
```
AssertableSubscriber<T> assertValues(T... values)
```
    Assert that this Observer received exactly the given expected values (compared via null-safe object equals) in the given order.
    
    Parameters:
    
    values - the expected values
    
    Returns:
    
    this
  - assertValue
```
AssertableSubscriber<T> assertValue(T value)
```
    Assert that this Observer received exactly the given single expected value (compared via null-safe object equals).
    
    Parameters:
    
    value - the single value expected
    
    Returns:
    
    this
  - assertValuesAndClear
```
AssertableSubscriber<T> assertValuesAndClear(T expectedFirstValue,
                                             T... expectedRestValues)
```
    Assert that this Observer received exactly the given values (compared via null-safe object equals) and if so, clears the internal buffer of the underlying Subscriber of these values.
    
    Parameters:
    
    expectedFirstValue - the first value expected
    
    expectedRestValues - the rest of the values expected
    
    Returns:
    
    this
  - perform
```
AssertableSubscriber<T> perform(Action0 action)
```
    Performs an action given by the Action0 callback in a fluent manner.
    
    Parameters:
    
    action - the action to perform, not null
    
    Returns:
    
    this
  - unsubscribe
```
void unsubscribe()
```
    Description copied from interface: Subscription
    
    Stops the receipt of notifications on the Subscriber that was registered when this Subscription was received.
    This allows deregistering an Subscriber before it has finished receiving all events (i.e. before onCompleted is called).
    
    Specified by:
    
    unsubscribe in interface Subscription
  - isUnsubscribed
```
boolean isUnsubscribed()
```
    Description copied from interface: Subscription
    
    Indicates whether this Subscription is currently unsubscribed.
    
    Specified by:
    
    isUnsubscribed in interface Subscription
    
    Returns:
    
    true if this Subscription is currently unsubscribed, false otherwise
  - assertResult
```
AssertableSubscriber<T> assertResult(T... values)
```
    Assert that this Observer received the specified items in the given order followed by a completion signal and no errors.
    
    Parameters:
    
    values - the values expected
    
    Returns:
    
    this
  - assertFailure
```
AssertableSubscriber<T> assertFailure(java.lang.Class errorClass,
                                      T... values)
```
    Assert that this Observer received the specified items in the given order followed by an error signal of the given type (but no completion signal).
    
    Parameters:
    
    errorClass - the expected Throwable subclass type
    
    values - the expected values
    
    Returns:
    
    this
  - assertFailureAndMessage
```
AssertableSubscriber<T> assertFailureAndMessage(java.lang.Class errorClass,
                                                java.lang.String message,
                                                T... values)
```
    Assert that this Observer received the specified items in the given order followed by an error signal of the given type and with the exact error message (but no completion signal).
    
    Parameters:
    
    errorClass - the expected Throwable subclass type
    
    message - the expected error message returned by Throwable.getMessage()
    
    values - the expected values
    
    Returns:
    
    this

Interface AssertableSubscriber

Method Summary

Methods inherited from interface rx.Observer

Method Detail

onStart

setProducer

getCompletions

getOnErrorEvents

getValueCount

requestMore

getOnNextEvents

assertReceivedOnNext

awaitValueCount

assertTerminalEvent

assertUnsubscribed

assertNoErrors

awaitTerminalEvent

awaitTerminalEvent

awaitTerminalEventAndUnsubscribeOnTimeout

getLastSeenThread

assertCompleted

assertNotCompleted

assertError

assertError

assertNoTerminalEvent

assertNoValues

assertValueCount

assertValues

assertValue

assertValuesAndClear

perform

unsubscribe

isUnsubscribed

assertResult

assertFailure

assertFailureAndMessage