SubscriberWhiteboxVerification (reactive-streams-tck 1.0.2 API)

java.lang.Object
- org.reactivestreams.tck.WithHelperPublisher<T>
- - org.reactivestreams.tck.SubscriberWhiteboxVerification<T>

All Implemented Interfaces:

SubscriberWhiteboxVerificationRules
```
public abstract class SubscriberWhiteboxVerification<T>
extends WithHelperPublisher<T>
implements SubscriberWhiteboxVerificationRules
```
Provides whitebox style tests for verifying Subscriber and Subscription specification rules.

See Also:

Subscriber, Subscription

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`SubscriberWhiteboxVerification.BlackboxProbe<T>`
`static class`	`SubscriberWhiteboxVerification.BlackboxSubscriberProxy<T>`	This class is intented to be used as `Subscriber` decorator and should be used in `pub.subscriber(...)` calls, in order to allow intercepting calls on the underlying `Subscriber`.
`static interface`	`SubscriberWhiteboxVerification.SubscriberProbe<T>`
`static interface`	`SubscriberWhiteboxVerification.SubscriberPuppet`	Implement this puppet in your Whitebox style tests.
`static interface`	`SubscriberWhiteboxVerification.SubscriberPuppeteer`
`static class`	`SubscriberWhiteboxVerification.WhiteboxSubscriberProbe<T>`
`class`	`SubscriberWhiteboxVerification.WhiteboxTestStage`

Constructor Summary

Constructors
Modifier Constructor Description

protected SubscriberWhiteboxVerification(TestEnvironment env)

Constructors
Modifier	Constructor	Description
`protected`	`SubscriberWhiteboxVerification(TestEnvironment env)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract org.reactivestreams.Subscriber<T>`	`createSubscriber(SubscriberWhiteboxVerification.WhiteboxSubscriberProbe<T> probe)`	This is the main method you must implement in your test incarnation.
`void`	`notVerified()`
`void`	`notVerified(java.lang.String msg)`
`void`	`optionalSubscriberTestWithoutSetup(org.reactivestreams.tck.SubscriberWhiteboxVerification.TestStageTestRun body)`	Test for feature that MAY be implemented.
`java.util.concurrent.ExecutorService`	`publisherExecutorService()`	ExecutorService to be used by the provided helper `Publisher`
`void`	`required_exerciseWhiteboxHappyPath()`
`void`	`required_spec201_mustSignalDemandViaSubscriptionRequest()`
`void`	`required_spec203_mustNotCallMethodsOnSubscriptionOrPublisherInOnComplete()`
`void`	`required_spec203_mustNotCallMethodsOnSubscriptionOrPublisherInOnError()`
`void`	`required_spec205_mustCallSubscriptionCancelIfItAlreadyHasAnSubscriptionAndReceivesAnotherOnSubscribeSignal()`
`void`	`required_spec208_mustBePreparedToReceiveOnNextSignalsAfterHavingCalledSubscriptionCancel()`
`void`	`required_spec209_mustBePreparedToReceiveAnOnCompleteSignalWithoutPrecedingRequestCall()`
`void`	`required_spec209_mustBePreparedToReceiveAnOnCompleteSignalWithPrecedingRequestCall()`
`void`	`required_spec210_mustBePreparedToReceiveAnOnErrorSignalWithoutPrecedingRequestCall()`
`void`	`required_spec210_mustBePreparedToReceiveAnOnErrorSignalWithPrecedingRequestCall()`
`void`	`required_spec213_onError_mustThrowNullPointerExceptionWhenParametersAreNull()`
`void`	`required_spec213_onNext_mustThrowNullPointerExceptionWhenParametersAreNull()`
`void`	`required_spec213_onSubscribe_mustThrowNullPointerExceptionWhenParametersAreNull()`
`void`	`required_spec308_requestMustRegisterGivenNumberElementsToBeProduced()`
`void`	`setUp()`
`void`	`shutdownPublisherExecutorService()`
`void`	`startPublisherExecutorService()`
`void`	`subscriberTest(org.reactivestreams.tck.SubscriberWhiteboxVerification.TestStageTestRun body)`	Prepares subscriber and publisher pair (by subscribing the first to the latter), and then hands over the tests `SubscriberWhiteboxVerification.WhiteboxTestStage` over to the test.
`void`	`subscriberTestWithoutSetup(org.reactivestreams.tck.SubscriberWhiteboxVerification.TestStageTestRun body)`	Provides a `SubscriberWhiteboxVerification.WhiteboxTestStage` without performing any additional setup, like the `subscriberTest(SubscriberWhiteboxVerification.TestStageTestRun)` would.
`void`	`untested_spec202_shouldAsynchronouslyDispatch()`
`void`	`untested_spec204_mustConsiderTheSubscriptionAsCancelledInAfterRecievingOnCompleteOrOnError()`
`void`	`untested_spec206_mustCallSubscriptionCancelIfItIsNoLongerValid()`
`void`	`untested_spec207_mustEnsureAllCallsOnItsSubscriptionTakePlaceFromTheSameThreadOrTakeCareOfSynchronization()`
`void`	`untested_spec211_mustMakeSureThatAllCallsOnItsMethodsHappenBeforeTheProcessingOfTheRespectiveEvents()`
`void`	`untested_spec212_mustNotCallOnSubscribeMoreThanOnceBasedOnObjectEquality_specViolation()`
`void`	`untested_spec213_failingOnSignalInvocation()`
`void`	`untested_spec301_mustNotBeCalledOutsideSubscriberContext()`
`void`	`untested_spec310_requestMaySynchronouslyCallOnNextOnSubscriber()`
`void`	`untested_spec311_requestMaySynchronouslyCallOnCompleteOrOnError()`
`void`	`untested_spec314_cancelMayCauseThePublisherToShutdownIfNoOtherSubscriptionExists()`
`void`	`untested_spec315_cancelMustNotThrowExceptionAndMustSignalOnError()`
`void`	`untested_spec316_requestMustNotThrowExceptionAndMustOnErrorTheSubscriber()`

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

Methods inherited from class org.reactivestreams.tck.WithHelperPublisher
createElement, createHelperPublisher

- Constructor Detail
  - SubscriberWhiteboxVerification
```
protected SubscriberWhiteboxVerification(TestEnvironment env)
```
- Method Detail
  - createSubscriber
```
public abstract org.reactivestreams.Subscriber<T> createSubscriber(SubscriberWhiteboxVerification.WhiteboxSubscriberProbe<T> probe)
```
    This is the main method you must implement in your test incarnation. It must create a new Subscriber instance to be subjected to the testing logic. In order to be meaningfully testable your Subscriber must inform the given `WhiteboxSubscriberProbe` of the respective events having been received.
  - startPublisherExecutorService
```
public void startPublisherExecutorService()
```
  - shutdownPublisherExecutorService
```
public void shutdownPublisherExecutorService()
```
  - publisherExecutorService
```
public java.util.concurrent.ExecutorService publisherExecutorService()
```
    Description copied from class: WithHelperPublisher
    
    ExecutorService to be used by the provided helper Publisher
    
    Specified by:
    
    publisherExecutorService in class WithHelperPublisher<T>
  - setUp
```
public void setUp()
           throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - required_exerciseWhiteboxHappyPath
```
public void required_exerciseWhiteboxHappyPath()
                                        throws java.lang.Throwable
```
    Specified by:
    
    required_exerciseWhiteboxHappyPath in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Throwable
  - required_spec201_mustSignalDemandViaSubscriptionRequest
```
public void required_spec201_mustSignalDemandViaSubscriptionRequest()
                                                             throws java.lang.Throwable
```
    Specified by:
    
    required_spec201_mustSignalDemandViaSubscriptionRequest in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Throwable
  - untested_spec202_shouldAsynchronouslyDispatch
```
public void untested_spec202_shouldAsynchronouslyDispatch()
                                                   throws java.lang.Exception
```
    Specified by:
    
    untested_spec202_shouldAsynchronouslyDispatch in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Exception
  - required_spec203_mustNotCallMethodsOnSubscriptionOrPublisherInOnComplete
```
public void required_spec203_mustNotCallMethodsOnSubscriptionOrPublisherInOnComplete()
                                                                              throws java.lang.Throwable
```
    Specified by:
    
    required_spec203_mustNotCallMethodsOnSubscriptionOrPublisherInOnComplete in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Throwable
  - required_spec203_mustNotCallMethodsOnSubscriptionOrPublisherInOnError
```
public void required_spec203_mustNotCallMethodsOnSubscriptionOrPublisherInOnError()
                                                                           throws java.lang.Throwable
```
    Specified by:
    
    required_spec203_mustNotCallMethodsOnSubscriptionOrPublisherInOnError in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Throwable
  - untested_spec204_mustConsiderTheSubscriptionAsCancelledInAfterRecievingOnCompleteOrOnError
```
public void untested_spec204_mustConsiderTheSubscriptionAsCancelledInAfterRecievingOnCompleteOrOnError()
                                                                                                throws java.lang.Exception
```
    Specified by:
    
    untested_spec204_mustConsiderTheSubscriptionAsCancelledInAfterRecievingOnCompleteOrOnError in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Exception
  - required_spec205_mustCallSubscriptionCancelIfItAlreadyHasAnSubscriptionAndReceivesAnotherOnSubscribeSignal
```
public void required_spec205_mustCallSubscriptionCancelIfItAlreadyHasAnSubscriptionAndReceivesAnotherOnSubscribeSignal()
                                                                                                                throws java.lang.Throwable
```
    Specified by:
    
    required_spec205_mustCallSubscriptionCancelIfItAlreadyHasAnSubscriptionAndReceivesAnotherOnSubscribeSignal in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Throwable
  - untested_spec206_mustCallSubscriptionCancelIfItIsNoLongerValid
```
public void untested_spec206_mustCallSubscriptionCancelIfItIsNoLongerValid()
                                                                    throws java.lang.Exception
```
    Specified by:
    
    untested_spec206_mustCallSubscriptionCancelIfItIsNoLongerValid in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Exception
  - untested_spec207_mustEnsureAllCallsOnItsSubscriptionTakePlaceFromTheSameThreadOrTakeCareOfSynchronization
```
public void untested_spec207_mustEnsureAllCallsOnItsSubscriptionTakePlaceFromTheSameThreadOrTakeCareOfSynchronization()
                                                                                                               throws java.lang.Exception
```
    Specified by:
    
    untested_spec207_mustEnsureAllCallsOnItsSubscriptionTakePlaceFromTheSameThreadOrTakeCareOfSynchronization in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Exception
  - required_spec208_mustBePreparedToReceiveOnNextSignalsAfterHavingCalledSubscriptionCancel
```
public void required_spec208_mustBePreparedToReceiveOnNextSignalsAfterHavingCalledSubscriptionCancel()
                                                                                              throws java.lang.Throwable
```
    Specified by:
    
    required_spec208_mustBePreparedToReceiveOnNextSignalsAfterHavingCalledSubscriptionCancel in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Throwable
  - required_spec209_mustBePreparedToReceiveAnOnCompleteSignalWithPrecedingRequestCall
```
public void required_spec209_mustBePreparedToReceiveAnOnCompleteSignalWithPrecedingRequestCall()
                                                                                        throws java.lang.Throwable
```
    Specified by:
    
    required_spec209_mustBePreparedToReceiveAnOnCompleteSignalWithPrecedingRequestCall in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Throwable
  - required_spec209_mustBePreparedToReceiveAnOnCompleteSignalWithoutPrecedingRequestCall
```
public void required_spec209_mustBePreparedToReceiveAnOnCompleteSignalWithoutPrecedingRequestCall()
                                                                                           throws java.lang.Throwable
```
    Specified by:
    
    required_spec209_mustBePreparedToReceiveAnOnCompleteSignalWithoutPrecedingRequestCall in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Throwable
  - required_spec210_mustBePreparedToReceiveAnOnErrorSignalWithPrecedingRequestCall
```
public void required_spec210_mustBePreparedToReceiveAnOnErrorSignalWithPrecedingRequestCall()
                                                                                     throws java.lang.Throwable
```
    Specified by:
    
    required_spec210_mustBePreparedToReceiveAnOnErrorSignalWithPrecedingRequestCall in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Throwable
  - required_spec210_mustBePreparedToReceiveAnOnErrorSignalWithoutPrecedingRequestCall
```
public void required_spec210_mustBePreparedToReceiveAnOnErrorSignalWithoutPrecedingRequestCall()
                                                                                        throws java.lang.Throwable
```
    Specified by:
    
    required_spec210_mustBePreparedToReceiveAnOnErrorSignalWithoutPrecedingRequestCall in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Throwable
  - untested_spec211_mustMakeSureThatAllCallsOnItsMethodsHappenBeforeTheProcessingOfTheRespectiveEvents
```
public void untested_spec211_mustMakeSureThatAllCallsOnItsMethodsHappenBeforeTheProcessingOfTheRespectiveEvents()
                                                                                                         throws java.lang.Exception
```
    Specified by:
    
    untested_spec211_mustMakeSureThatAllCallsOnItsMethodsHappenBeforeTheProcessingOfTheRespectiveEvents in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Exception
  - untested_spec212_mustNotCallOnSubscribeMoreThanOnceBasedOnObjectEquality_specViolation
```
public void untested_spec212_mustNotCallOnSubscribeMoreThanOnceBasedOnObjectEquality_specViolation()
                                                                                            throws java.lang.Throwable
```
    Specified by:
    
    untested_spec212_mustNotCallOnSubscribeMoreThanOnceBasedOnObjectEquality_specViolation in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Throwable
  - untested_spec213_failingOnSignalInvocation
```
public void untested_spec213_failingOnSignalInvocation()
                                                throws java.lang.Exception
```
    Specified by:
    
    untested_spec213_failingOnSignalInvocation in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Exception
  - required_spec213_onSubscribe_mustThrowNullPointerExceptionWhenParametersAreNull
```
public void required_spec213_onSubscribe_mustThrowNullPointerExceptionWhenParametersAreNull()
                                                                                     throws java.lang.Throwable
```
    Specified by:
    
    required_spec213_onSubscribe_mustThrowNullPointerExceptionWhenParametersAreNull in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Throwable
  - required_spec213_onNext_mustThrowNullPointerExceptionWhenParametersAreNull
```
public void required_spec213_onNext_mustThrowNullPointerExceptionWhenParametersAreNull()
                                                                                throws java.lang.Throwable
```
    Specified by:
    
    required_spec213_onNext_mustThrowNullPointerExceptionWhenParametersAreNull in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Throwable
  - required_spec213_onError_mustThrowNullPointerExceptionWhenParametersAreNull
```
public void required_spec213_onError_mustThrowNullPointerExceptionWhenParametersAreNull()
                                                                                 throws java.lang.Throwable
```
    Specified by:
    
    required_spec213_onError_mustThrowNullPointerExceptionWhenParametersAreNull in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Throwable
  - untested_spec301_mustNotBeCalledOutsideSubscriberContext
```
public void untested_spec301_mustNotBeCalledOutsideSubscriberContext()
                                                              throws java.lang.Exception
```
    Specified by:
    
    untested_spec301_mustNotBeCalledOutsideSubscriberContext in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Exception
  - required_spec308_requestMustRegisterGivenNumberElementsToBeProduced
```
public void required_spec308_requestMustRegisterGivenNumberElementsToBeProduced()
                                                                         throws java.lang.Throwable
```
    Specified by:
    
    required_spec308_requestMustRegisterGivenNumberElementsToBeProduced in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Throwable
  - untested_spec310_requestMaySynchronouslyCallOnNextOnSubscriber
```
public void untested_spec310_requestMaySynchronouslyCallOnNextOnSubscriber()
                                                                    throws java.lang.Exception
```
    Specified by:
    
    untested_spec310_requestMaySynchronouslyCallOnNextOnSubscriber in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Exception
  - untested_spec311_requestMaySynchronouslyCallOnCompleteOrOnError
```
public void untested_spec311_requestMaySynchronouslyCallOnCompleteOrOnError()
                                                                     throws java.lang.Exception
```
    Specified by:
    
    untested_spec311_requestMaySynchronouslyCallOnCompleteOrOnError in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Exception
  - untested_spec314_cancelMayCauseThePublisherToShutdownIfNoOtherSubscriptionExists
```
public void untested_spec314_cancelMayCauseThePublisherToShutdownIfNoOtherSubscriptionExists()
                                                                                      throws java.lang.Exception
```
    Specified by:
    
    untested_spec314_cancelMayCauseThePublisherToShutdownIfNoOtherSubscriptionExists in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Exception
  - untested_spec315_cancelMustNotThrowExceptionAndMustSignalOnError
```
public void untested_spec315_cancelMustNotThrowExceptionAndMustSignalOnError()
                                                                      throws java.lang.Exception
```
    Specified by:
    
    untested_spec315_cancelMustNotThrowExceptionAndMustSignalOnError in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Exception
  - untested_spec316_requestMustNotThrowExceptionAndMustOnErrorTheSubscriber
```
public void untested_spec316_requestMustNotThrowExceptionAndMustOnErrorTheSubscriber()
                                                                              throws java.lang.Exception
```
    Specified by:
    
    untested_spec316_requestMustNotThrowExceptionAndMustOnErrorTheSubscriber in interface SubscriberWhiteboxVerificationRules
    
    Throws:
    
    java.lang.Exception
  - subscriberTest
```
public void subscriberTest(org.reactivestreams.tck.SubscriberWhiteboxVerification.TestStageTestRun body)
                    throws java.lang.Throwable
```
    Prepares subscriber and publisher pair (by subscribing the first to the latter), and then hands over the tests SubscriberWhiteboxVerification.WhiteboxTestStage over to the test. The test stage is, like in a puppet show, used to orchestrate what each participant should do. Since this is a whitebox test, this allows the stage to completely control when and how to signal / expect signals.
    
    Throws:
    
    java.lang.Throwable
  - subscriberTestWithoutSetup
```
public void subscriberTestWithoutSetup(org.reactivestreams.tck.SubscriberWhiteboxVerification.TestStageTestRun body)
                                throws java.lang.Throwable
```
    Provides a SubscriberWhiteboxVerification.WhiteboxTestStage without performing any additional setup, like the subscriberTest(SubscriberWhiteboxVerification.TestStageTestRun) would. Use this method to write tests in which you need full control over when and how the initial subscribe is signalled.
    
    Throws:
    
    java.lang.Throwable
  - optionalSubscriberTestWithoutSetup
```
public void optionalSubscriberTestWithoutSetup(org.reactivestreams.tck.SubscriberWhiteboxVerification.TestStageTestRun body)
                                        throws java.lang.Throwable
```
    Test for feature that MAY be implemented. This test will be marked as SKIPPED if it fails.
    
    Throws:
    
    java.lang.Throwable
  - notVerified
```
public void notVerified()
```
  - notVerified
```
public void notVerified(java.lang.String msg)
```

Class SubscriberWhiteboxVerification<T>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from class org.reactivestreams.tck.WithHelperPublisher

Constructor Detail

SubscriberWhiteboxVerification

Method Detail

createSubscriber

startPublisherExecutorService

shutdownPublisherExecutorService

publisherExecutorService

setUp

required_exerciseWhiteboxHappyPath

required_spec201_mustSignalDemandViaSubscriptionRequest

untested_spec202_shouldAsynchronouslyDispatch

required_spec203_mustNotCallMethodsOnSubscriptionOrPublisherInOnComplete

required_spec203_mustNotCallMethodsOnSubscriptionOrPublisherInOnError

untested_spec204_mustConsiderTheSubscriptionAsCancelledInAfterRecievingOnCompleteOrOnError

required_spec205_mustCallSubscriptionCancelIfItAlreadyHasAnSubscriptionAndReceivesAnotherOnSubscribeSignal

untested_spec206_mustCallSubscriptionCancelIfItIsNoLongerValid

untested_spec207_mustEnsureAllCallsOnItsSubscriptionTakePlaceFromTheSameThreadOrTakeCareOfSynchronization

required_spec208_mustBePreparedToReceiveOnNextSignalsAfterHavingCalledSubscriptionCancel

required_spec209_mustBePreparedToReceiveAnOnCompleteSignalWithPrecedingRequestCall

required_spec209_mustBePreparedToReceiveAnOnCompleteSignalWithoutPrecedingRequestCall

required_spec210_mustBePreparedToReceiveAnOnErrorSignalWithPrecedingRequestCall

required_spec210_mustBePreparedToReceiveAnOnErrorSignalWithoutPrecedingRequestCall

untested_spec211_mustMakeSureThatAllCallsOnItsMethodsHappenBeforeTheProcessingOfTheRespectiveEvents

untested_spec212_mustNotCallOnSubscribeMoreThanOnceBasedOnObjectEquality_specViolation

untested_spec213_failingOnSignalInvocation

required_spec213_onSubscribe_mustThrowNullPointerExceptionWhenParametersAreNull

required_spec213_onNext_mustThrowNullPointerExceptionWhenParametersAreNull

required_spec213_onError_mustThrowNullPointerExceptionWhenParametersAreNull

untested_spec301_mustNotBeCalledOutsideSubscriberContext

required_spec308_requestMustRegisterGivenNumberElementsToBeProduced

untested_spec310_requestMaySynchronouslyCallOnNextOnSubscriber

untested_spec311_requestMaySynchronouslyCallOnCompleteOrOnError

untested_spec314_cancelMayCauseThePublisherToShutdownIfNoOtherSubscriptionExists

untested_spec315_cancelMustNotThrowExceptionAndMustSignalOnError

untested_spec316_requestMustNotThrowExceptionAndMustOnErrorTheSubscriber

subscriberTest

subscriberTestWithoutSetup

optionalSubscriberTestWithoutSetup

notVerified

notVerified