Package io.contract_testing.contractcase.definitions.interactions.base

Class ContractCaseCoreBehaviour.Builder

java.lang.Object

io.contract_testing.contractcase.definitions.interactions.base.ContractCaseCoreBehaviour.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ContractCaseCoreBehaviour>

Enclosing interface:

ContractCaseCoreBehaviour

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

A builder for ContractCaseCoreBehaviour

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ContractCaseCoreBehaviour	build()	Builds the configured instance.
ContractCaseCoreBehaviour.Builder	mockType(String mockType)	Sets the value of ContractCaseCoreBehaviour.getMockType()
ContractCaseCoreBehaviour.Builder	stateVariables(String stateVariables)	Sets the value of ContractCaseCoreBehaviour.getStateVariables()
ContractCaseCoreBehaviour.Builder	triggers(String triggers)	Sets the value of ContractCaseCoreBehaviour.getTriggers()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

mockType

@Stability(Stable)
public ContractCaseCoreBehaviour.Builder mockType(String mockType)

Sets the value of ContractCaseCoreBehaviour.getMockType()

Parameters:

mockType - The type of this mock. This parameter is required. Usually this is inverted on read vs write, for example, a written MOCK_HTTP_CLIENT might become a MOCK_HTTP_SERVER during reading.

This will almost always be the same as the top level type for your mock during read - but if it is different, ContractCase will respect this value.

Returns:

this

stateVariables

@Stability(Stable)
public ContractCaseCoreBehaviour.Builder stateVariables(String stateVariables)

Sets the value of ContractCaseCoreBehaviour.getStateVariables()

Parameters:

stateVariables - Whether or not this mock mode will invoke state handlers. This parameter is required. If set to "default" then ContractCase will not invoke or require the state handlers and will use the default values for all state variables. If set to "state", then ContractCase will invoke the state handlers and require the expected variables to be returned.

All other values are errors.

Returns:

this

triggers

@Stability(Stable)
public ContractCaseCoreBehaviour.Builder triggers(String triggers)

Sets the value of ContractCaseCoreBehaviour.getTriggers()

Parameters:

triggers - Whether or not this mock mode needs to be triggered by user-provided code. This parameter is required. If "provided" then ContractCase will require the user to provide a trigger and a test function (eg, for testing an HTTP Client, code that will invoke it must be provided). If "generated", then ContractCase will not require user provided triggers as it will generate them (eg, if the system under test is an HTTP server, ContractCase will generate client calls).

Returns:

this

build

@Stability(Stable)
public ContractCaseCoreBehaviour build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ContractCaseCoreBehaviour

Throws:

NullPointerException - if any required attribute was not provided