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

Interface ContractCaseCoreBehaviour

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ContractCaseCoreBehaviour.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-08-20T01:46:20.831Z")
@Stability(Stable)
public interface ContractCaseCoreBehaviour
extends software.amazon.jsii.JsiiSerializable

This type defines the core behaviour that ContractCase has with this mock.

If you are using the included example types from ContractCase (or any extension libraries), you do not need to use this class (or understand this documentation).

This documentation is only necessary for people extending ContractCase to include new mock types.

See the definitions in the case-entities-internal package for more details.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ContractCaseCoreBehaviour.Builder	A builder for ContractCaseCoreBehaviour
static class	ContractCaseCoreBehaviour.Jsii$Proxy	An implementation for ContractCaseCoreBehaviour

Method Summary

Modifier and Type	Method	Description
static ContractCaseCoreBehaviour.Builder	builder()
String	getMockType()	The type of this mock.
String	getStateVariables()	Whether or not this mock mode will invoke state handlers.
String	getTriggers()	Whether or not this mock mode needs to be triggered by user-provided code.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMockType

@Stability(Stable)
@NotNull
String getMockType()

The type of this mock.

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.

getStateVariables

@Stability(Stable)
@NotNull
String getStateVariables()

Whether or not this mock mode will invoke state handlers.

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.

getTriggers

@Stability(Stable)
@NotNull
String getTriggers()

Whether or not this mock mode needs to be triggered by user-provided code.

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).

builder

@Stability(Stable)
static ContractCaseCoreBehaviour.Builder builder()

Returns:

a ContractCaseCoreBehaviour.Builder of ContractCaseCoreBehaviour