reactor.test

Class StepVerifierOptions

java.lang.Object

reactor.test.StepVerifierOptions

public class StepVerifierOptions
extends Object

Options for a StepVerifier, including the initial request amount, VirtualTimeScheduler supplier and toggles for some checks.

Author:

Simon Basle

Method Summary

Modifier and Type	Method and Description
StepVerifierOptions	checkUnderRequesting(boolean enabled) Activate or deactivate the StepVerifier check of request amount being too low.
static StepVerifierOptions	create() Create a new default set of options for a StepVerifier that can be tuned using the various available non-getter methods (which can be chained).
Context	getInitialContext()
long	getInitialRequest()
String	getScenarioName()
Supplier<? extends VirtualTimeScheduler>	getVirtualTimeSchedulerSupplier()
StepVerifierOptions	initialRequest(long initialRequest) Set the amount the StepVerifier should request initially.
boolean	isCheckUnderRequesting()
StepVerifierOptions	scenarioName(String scenarioName) Give a name to the whole scenario tested by the configured StepVerifier.
StepVerifierOptions	virtualTimeSchedulerSupplier(Supplier<? extends VirtualTimeScheduler> vtsLookup) Set a supplier for a VirtualTimeScheduler, which is mandatory for a StepVerifier to work with virtual time.
StepVerifierOptions	withInitialContext(Context context) Set an initial Context to be propagated by the StepVerifier when it subscribes to the sequence under test.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static StepVerifierOptions create()

Create a new default set of options for a StepVerifier that can be tuned using the various available non-getter methods (which can be chained).

checkUnderRequesting

public StepVerifierOptions checkUnderRequesting(boolean enabled)

Activate or deactivate the StepVerifier check of request amount being too low. Defauts to true.

Parameters:

enabled - true if the check should be enabled.

Returns:

this instance, to continue setting the options.

isCheckUnderRequesting

public boolean isCheckUnderRequesting()

Returns:

true if the StepVerifier receiving these options should activate the check of request amount being too low.

initialRequest

public StepVerifierOptions initialRequest(long initialRequest)

Set the amount the StepVerifier should request initially. Defaults to unbounded request (Long.MAX_VALUE).

Parameters:

initialRequest - the initial request amount.

Returns:

this instance, to continue setting the options.

getInitialRequest

public long getInitialRequest()

Returns:

the initial request amount to be made by the StepVerifier receiving these options.

virtualTimeSchedulerSupplier

public StepVerifierOptions virtualTimeSchedulerSupplier(Supplier<? extends VirtualTimeScheduler> vtsLookup)

Set a supplier for a VirtualTimeScheduler, which is mandatory for a StepVerifier to work with virtual time. Defaults to null.

Parameters:

vtsLookup - the supplier of VirtualTimeScheduler to use.

Returns:

this instance, to continue setting the options.

getVirtualTimeSchedulerSupplier

@Nullable
public Supplier<? extends VirtualTimeScheduler> getVirtualTimeSchedulerSupplier()

Returns:

the supplier of VirtualTimeScheduler to be used by the StepVerifier receiving these options.

withInitialContext

public StepVerifierOptions withInitialContext(Context context)

Set an initial Context to be propagated by the StepVerifier when it subscribes to the sequence under test.

Parameters:

context - the Context to propagate.

Returns:

this instance, to continue setting the options.

getInitialContext

@Nullable
public Context getInitialContext()

Returns:

the Context to be propagated initially by the StepVerifier.

scenarioName

public StepVerifierOptions scenarioName(@Nullable
                                        String scenarioName)

Give a name to the whole scenario tested by the configured StepVerifier. That name would be mentioned in exceptions and assertion errors raised by the StepVerifier, allowing to better distinguish error sources in unit tests where multiple StepVerifier are used.

Parameters:

scenarioName - the name of the scenario, null to deactivate

Returns:

this instance, to continue setting the options.

getScenarioName

@Nullable
public String getScenarioName()

Returns:

the name given to the configured StepVerifier, or null if none.