Package io.contract_testing.contractcase.definitions.matchers.convenience

Class WithExample

  • All Implemented Interfaces:
    software.amazon.jsii.JsiiSerializable
    @Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-08-20T01:46:20.842Z")
@Stability(Stable)
public class WithExample
extends CascadingContextMatcher
    Adds an example to the provided matcher.

    Useful when you have a complicated set of constraints and ContractCase can't figure out what the best example should be.

    Note that providing any example will override examples provided further down the tree.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

        software.amazon.jsii.JsiiObject.InitializationMode

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        WithExample​(Object matcher, Object example)
      Adds an example to the provided matcher.
      protected WithExample​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)  
      protected WithExample​(software.amazon.jsii.JsiiObjectRef objRef)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Object toJSON()
      For non-TypeScript implementations (see AnyMatcher.toJSON).

      • Methods inherited from class software.amazon.jsii.JsiiObject

        jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

      • Methods inherited from interface software.amazon.jsii.JsiiSerializable

        $jsii$toJson

    • Constructor Detail

      • WithExample

        protected WithExample​(software.amazon.jsii.JsiiObjectRef objRef)

      • WithExample

        protected WithExample​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

      • WithExample

        @Stability(Stable)
public WithExample​(@NotNull
                   Object matcher,
                   @NotNull
                   Object example)
        Adds an example to the provided matcher.

        Useful when you have a complicated set of matchers.convenience.And constraints and ContractCase can't figure out what the best example should be. Note that providing any example will override examples provided further down the tree.

        Parameters:
        matcher -
        • Any matcher to add an example to.
        This parameter is required.
        example -
        • The example to use when stripping the matchers.
        This parameter is required.

    • Method Detail

      • toJSON

        @Stability(Stable)
@NotNull
public Object toJSON()
        For non-TypeScript implementations (see AnyMatcher.toJSON).
        Overrides:
        toJSON in class CascadingContextMatcher
        Returns:
        An object in the matcher format described {@link https://case.contract-testing.io/docs/reference/plugin-framework in the Extending ContractCase documentation}