Package io.contract_testing.contractcase.definitions.interactions.functions

Class WillCallFunction.Builder

java.lang.Object

io.contract_testing.contractcase.definitions.interactions.functions.WillCallFunction.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<WillCallFunction>

Enclosing class:

WillCallFunction

@Stability(Stable)
public static final class WillCallFunction.Builder
extends Object
implements software.amazon.jsii.Builder<WillCallFunction>

A fluent builder for WillCallFunction.

Method Summary

Modifier and Type	Method	Description
WillCallFunction.Builder	arguments(List<? extends Object> arguments)	An array of expected function arguments (or test equivalence matchers for those arguments).
WillCallFunction	build()
static WillCallFunction.Builder	create()
WillCallFunction.Builder	functionName(String functionName)	The name of the function to be executed.
WillCallFunction.Builder	returnValue(Object returnValue)	A test equivalence matcher for the return value from this function.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(Stable)
public static WillCallFunction.Builder create()

Returns:

a new instance of WillCallFunction.Builder.

arguments

@Stability(Stable)
public WillCallFunction.Builder arguments(List<? extends Object> arguments)

An array of expected function arguments (or test equivalence matchers for those arguments).

Parameters:

arguments - An array of expected function arguments (or test equivalence matchers for those arguments). This parameter is required.

Returns:

this

functionName

@Stability(Stable)
public WillCallFunction.Builder functionName(String functionName)

The name of the function to be executed.

Doubles as the handle used by registerFunction.

Parameters:

functionName - The name of the function to be executed. This parameter is required.

Returns:

this

returnValue

@Stability(Stable)
public WillCallFunction.Builder returnValue(Object returnValue)

A test equivalence matcher for the return value from this function.

Parameters:

returnValue - A test equivalence matcher for the return value from this function. This parameter is required.

Returns:

this

build

@Stability(Stable)
public WillCallFunction build()

Specified by:

build in interface software.amazon.jsii.Builder<WillCallFunction>

Returns:

a newly built instance of WillCallFunction.