au.com.dius.pact.consumer.dsl

Class PactDslJsonBody

au.com.dius.pact.consumer.dsl.DslPart

au.com.dius.pact.consumer.dsl.PactDslJsonBody

public class PactDslJsonBody
extends DslPart

DSL to define a JSON Object

Constructor Detail

PactDslJsonBody

public PactDslJsonBody()

Constructs a new body as a root

PactDslJsonBody

public PactDslJsonBody(@NotNull
                       java.lang.String rootPath,
                       @NotNull
                       java.lang.String rootName,
                       @Nullable
                       DslPart parent)

Constructs a new body as a child

Parameters:

rootPath - Path to prefix to this child

rootName - Name to associate this object as in the parent

parent - Parent to attach to

PactDslJsonBody

public PactDslJsonBody(@NotNull
                       java.lang.String rootPath,
                       @NotNull
                       java.lang.String rootName,
                       @Nullable
                       DslPart parent,
                       @NotNull
                       PactDslJsonBody body)

Constructs a new body as a child as a copy of an existing one

Parameters:

rootPath - Path to prefix to this child

rootName - Name to associate this object as in the parent

parent - Parent to attach to

body - Body to copy values from

Method Detail

getBody

@NotNull
public au.com.dius.pact.core.support.json.JsonValue getBody()

setBody

public void setBody(@NotNull
                    au.com.dius.pact.core.support.json.JsonValue p)

toString

@NotNull
public java.lang.String toString()

putObjectPrivate

public void putObjectPrivate(@NotNull
                             DslPart obj)

putArrayPrivate

public void putArrayPrivate(@NotNull
                            DslPart obj)

stringValue

@NotNull
public PactDslJsonBody stringValue(@NotNull
                                            java.lang.String name,
                                            @Nullable
                                            java.lang.String value)

Attribute that must be the specified value

Parameters:

name - attribute name

value - string value

numberValue

@NotNull
public PactDslJsonBody numberValue(@NotNull
                                            java.lang.String name,
                                            @NotNull
                                            java.lang.Number value)

Attribute that must be the specified number

Parameters:

name - attribute name

value - number value

booleanValue

@NotNull
public PactDslJsonBody booleanValue(@NotNull
                                             java.lang.String name,
                                             boolean value)

Attribute that must be the specified boolean

Parameters:

name - attribute name

value - boolean value

like

@NotNull
public PactDslJsonBody like(@NotNull
                                     java.lang.String name,
                                     @NotNull
                                     java.lang.Object... examples)

Attribute that must be the same type as the example

Parameters:

name - attribute name

stringType

@NotNull
public PactDslJsonBody stringType(@NotNull
                                           java.lang.String name)

Attribute that can be any string

Parameters:

name - attribute name

stringType

@NotNull
public PactDslJsonBody stringType(@NotNull
                                           java.lang.String... names)

Attributes that can be any string

Parameters:

names - attribute names

stringType

@NotNull
public PactDslJsonBody stringType(@NotNull
                                           java.lang.String name,
                                           @NotNull
                                           java.lang.String example)

Attribute that can be any string

Parameters:

name - attribute name

example - example value to use for generated bodies

numberType

@NotNull
public PactDslJsonBody numberType(@NotNull
                                           java.lang.String name)

Attribute that can be any number

Parameters:

name - attribute name

numberType

@NotNull
public PactDslJsonBody numberType(@NotNull
                                           java.lang.String... names)

Attributes that can be any number

Parameters:

names - attribute names

numberType

@NotNull
public PactDslJsonBody numberType(@NotNull
                                           java.lang.String name,
                                           @NotNull
                                           java.lang.Number number)

Attribute that can be any number

Parameters:

name - attribute name

number - example number to use for generated bodies

integerType

@NotNull
public PactDslJsonBody integerType(@NotNull
                                            java.lang.String name)

Attribute that must be an integer

Parameters:

name - attribute name

integerType

@NotNull
public PactDslJsonBody integerType(@NotNull
                                            java.lang.String... names)

Attributes that must be an integer

Parameters:

names - attribute names

integerType

@NotNull
public PactDslJsonBody integerType(@NotNull
                                            java.lang.String name,
                                            long number)

Attribute that must be an integer

Parameters:

name - attribute name

number - example integer value to use for generated bodies

integerType

@NotNull
public PactDslJsonBody integerType(@NotNull
                                            java.lang.String name,
                                            int number)

Attribute that must be an integer

Parameters:

name - attribute name

number - example integer value to use for generated bodies

decimalType

@NotNull
public PactDslJsonBody decimalType(@NotNull
                                            java.lang.String name)

Attribute that must be a decimal value

Parameters:

name - attribute name

decimalType

@NotNull
public PactDslJsonBody decimalType(@NotNull
                                            java.lang.String... names)

Attributes that must be a decimal values

Parameters:

names - attribute names

decimalType

@NotNull
public PactDslJsonBody decimalType(@NotNull
                                            java.lang.String name,
                                            @NotNull
                                            java.math.BigDecimal number)

Attribute that must be a decimalType value

Parameters:

name - attribute name

number - example decimalType value

decimalType

@NotNull
public PactDslJsonBody decimalType(@NotNull
                                            java.lang.String name,
                                            double number)

Attribute that must be a decimalType value

Parameters:

name - attribute name

number - example decimalType value

booleanType

@NotNull
public PactDslJsonBody booleanType(@NotNull
                                            java.lang.String... names)

Attributes that must be a boolean

Parameters:

names - attribute names

booleanType

@JvmOverloads
 @NotNull
public PactDslJsonBody booleanType(@NotNull
                                                           java.lang.String name,
                                                           boolean example)

Attribute that must be a boolean

Parameters:

name - attribute name

example - example boolean to use for generated bodies

booleanType

@JvmOverloads
 @NotNull
public PactDslJsonBody booleanType(@NotNull
                                                           java.lang.String name)

Attribute that must be a boolean

Parameters:

name - attribute name

stringMatcher

@NotNull
public PactDslJsonBody stringMatcher(@NotNull
                                              java.lang.String name,
                                              @NotNull
                                              java.lang.String regex,
                                              @NotNull
                                              java.lang.String value)

Attribute that must match the regular expression

Parameters:

name - attribute name

regex - regular expression

value - example value to use for generated bodies

stringMatcher

@NotNull
public PactDslJsonBody stringMatcher(@NotNull
                                              java.lang.String name,
                                              @NotNull
                                              java.lang.String regex)

Attribute that must match the regular expression

Parameters:

name - attribute name

regex - regular expression

timestamp

@Deprecated
 @NotNull
public PactDslJsonBody timestamp()

Deprecated.

Attribute named 'timestamp' that must be an ISO formatted timestamp

timestamp

@Deprecated
 @NotNull
public PactDslJsonBody timestamp(@NotNull
                                                       java.lang.String name)

Deprecated.

Attribute that must be an ISO formatted timestamp

Parameters:

name -

timestamp

@Deprecated
 @NotNull
public PactDslJsonBody timestamp(@NotNull
                                                       java.lang.String name,
                                                       @NotNull
                                                       java.lang.String format)

Deprecated.

Attribute that must match the given datetime format

Parameters:

name - attribute name

format - timestamp format

timestamp

@Deprecated
 @NotNull
public PactDslJsonBody timestamp(@NotNull
                                                       java.lang.String name,
                                                       @NotNull
                                                       java.lang.String format,
                                                       @NotNull
                                                       java.util.Date example)

Deprecated.

Attribute that must match the given timestamp format

Parameters:

name - attribute name

format - timestamp format

example - example date and time to use for generated bodies

timestamp

@Deprecated
 @NotNull
public PactDslJsonBody timestamp(@NotNull
                                                       java.lang.String name,
                                                       @NotNull
                                                       java.lang.String format,
                                                       @NotNull
                                                       java.util.Date example,
                                                       @NotNull
                                                       java.util.TimeZone timeZone)

Deprecated.

Attribute that must match the given timestamp format

Parameters:

name - attribute name

format - timestamp format

example - example date and time to use for generated bodies

timeZone - time zone used for formatting of example date and time

timestamp

@Deprecated
 @NotNull
public PactDslJsonBody timestamp(@NotNull
                                                       java.lang.String name,
                                                       @NotNull
                                                       java.lang.String format,
                                                       @NotNull
                                                       java.time.Instant example)

Deprecated.

Attribute that must match the given timestamp format

Parameters:

name - attribute name

format - timestamp format

example - example date and time to use for generated bodies

timestamp

@Deprecated
 @NotNull
public PactDslJsonBody timestamp(@NotNull
                                                       java.lang.String name,
                                                       @NotNull
                                                       java.lang.String format,
                                                       @NotNull
                                                       java.time.Instant example,
                                                       @NotNull
                                                       java.util.TimeZone timeZone)

Deprecated.

Attribute that must match the given timestamp format

Parameters:

name - attribute name

format - timestamp format

example - example date and time to use for generated bodies

timeZone - time zone used for formatting of example date and time

datetime

@NotNull
public PactDslJsonBody datetime(@NotNull
                                         java.lang.String name)

Attribute that must be an ISO formatted datetime

Parameters:

name -

datetime

@NotNull
public PactDslJsonBody datetime(@NotNull
                                         java.lang.String name,
                                         @NotNull
                                         java.lang.String format)

Attribute that must match the given datetime format

Parameters:

name - attribute name

format - datetime format

datetime

@JvmOverloads
 @NotNull
public PactDslJsonBody datetime(@NotNull
                                                        java.lang.String name,
                                                        @NotNull
                                                        java.lang.String format,
                                                        @NotNull
                                                        java.util.Date example,
                                                        @NotNull
                                                        java.util.TimeZone timeZone)

Attribute that must match the given datetime format

Parameters:

name - attribute name

format - datetime format

example - example date and time to use for generated bodies

timeZone - time zone used for formatting of example date and time

datetime

@JvmOverloads
 @NotNull
public PactDslJsonBody datetime(@NotNull
                                                        java.lang.String name,
                                                        @NotNull
                                                        java.lang.String format,
                                                        @NotNull
                                                        java.util.Date example)

Attribute that must match the given datetime format

Parameters:

name - attribute name

format - datetime format

example - example date and time to use for generated bodies

datetime

@JvmOverloads
 @NotNull
public PactDslJsonBody datetime(@NotNull
                                                        java.lang.String name,
                                                        @NotNull
                                                        java.lang.String format,
                                                        @NotNull
                                                        java.time.Instant example,
                                                        @NotNull
                                                        java.util.TimeZone timeZone)

Attribute that must match the given datetime format

Parameters:

name - attribute name

format - timestamp format

example - example date and time to use for generated bodies

timeZone - time zone used for formatting of example date and time

datetime

@JvmOverloads
 @NotNull
public PactDslJsonBody datetime(@NotNull
                                                        java.lang.String name,
                                                        @NotNull
                                                        java.lang.String format,
                                                        @NotNull
                                                        java.time.Instant example)

Attribute that must match the given datetime format

Parameters:

name - attribute name

format - timestamp format

example - example date and time to use for generated bodies

date

@JvmOverloads
 @NotNull
public PactDslJsonBody date(@NotNull
                                                    java.lang.String name)

Attribute that must be formatted as an ISO date

Parameters:

name - attribute name

date

@JvmOverloads
 @NotNull
public PactDslJsonBody date()

Attribute that must be formatted as an ISO date

date

@NotNull
public PactDslJsonBody date(@NotNull
                                     java.lang.String name,
                                     @NotNull
                                     java.lang.String format)

Attribute that must match the provided date format

Parameters:

name - attribute date

format - date format to match

date

@JvmOverloads
 @NotNull
public PactDslJsonBody date(@NotNull
                                                    java.lang.String name,
                                                    @NotNull
                                                    java.lang.String format,
                                                    @NotNull
                                                    java.util.Date example,
                                                    @NotNull
                                                    java.util.TimeZone timeZone)

Attribute that must match the provided date format

Parameters:

name - attribute date

format - date format to match

example - example date to use for generated values

timeZone - time zone used for formatting of example date

date

@JvmOverloads
 @NotNull
public PactDslJsonBody date(@NotNull
                                                    java.lang.String name,
                                                    @NotNull
                                                    java.lang.String format,
                                                    @NotNull
                                                    java.util.Date example)

Attribute that must match the provided date format

Parameters:

name - attribute date

format - date format to match

example - example date to use for generated values

time

@JvmOverloads
 @NotNull
public PactDslJsonBody time(@NotNull
                                                    java.lang.String name)

Attribute named 'time' that must be an ISO formatted time

time

@JvmOverloads
 @NotNull
public PactDslJsonBody time()

Attribute named 'time' that must be an ISO formatted time

time

@NotNull
public PactDslJsonBody time(@NotNull
                                     java.lang.String name,
                                     @NotNull
                                     java.lang.String format)

Attribute that must match the given time format

Parameters:

name - attribute name

format - time format to match

time

@JvmOverloads
 @NotNull
public PactDslJsonBody time(@NotNull
                                                    java.lang.String name,
                                                    @NotNull
                                                    java.lang.String format,
                                                    @NotNull
                                                    java.util.Date example,
                                                    @NotNull
                                                    java.util.TimeZone timeZone)

Attribute that must match the given time format

Parameters:

name - attribute name

format - time format to match

example - example time to use for generated bodies

timeZone - time zone used for formatting of example time

time

@JvmOverloads
 @NotNull
public PactDslJsonBody time(@NotNull
                                                    java.lang.String name,
                                                    @NotNull
                                                    java.lang.String format,
                                                    @NotNull
                                                    java.util.Date example)

Attribute that must match the given time format

Parameters:

name - attribute name

format - time format to match

example - example time to use for generated bodies

ipAddress

@NotNull
public PactDslJsonBody ipAddress(@NotNull
                                          java.lang.String name)

Attribute that must be an IP4 address

Parameters:

name - attribute name

object

@NotNull
public PactDslJsonBody object(@NotNull
                                       java.lang.String name)

Attribute that is a JSON object

Parameters:

name - field name

object

@NotNull
public PactDslJsonBody object()

Object element

object

@NotNull
public PactDslJsonBody object(@NotNull
                                       java.lang.String name,
                                       @NotNull
                                       DslPart value)

Attribute that is a JSON object defined from a DSL part

Parameters:

name - field name

value - DSL Part to set the value as

closeObject

@Nullable
public DslPart closeObject()

Closes the current JSON object

close

@Nullable
public DslPart close()

This closes off the object graph build from the DSL in case any closeObject|Array methods have not been called.

Returns:

The root object of the object graph

See Also:

Object|Array

array

@NotNull
public PactDslJsonArray array(@NotNull
                                       java.lang.String name)

Attribute that is an array

Parameters:

name - field name

array

@NotNull
public PactDslJsonArray array()

Element as an array

closeArray

@Nullable
public DslPart closeArray()

Closes the current array

eachLike

@NotNull
public PactDslJsonBody eachLike(@NotNull
                                         java.lang.String name)

Attribute that is an array where each item must match the following example

Parameters:

name - field name

eachLike

@NotNull
public PactDslJsonBody eachLike(@NotNull
                                         java.lang.String name,
                                         @NotNull
                                         DslPart obj)

Array field where each element must match the following object

Parameters:

name - field name

eachLike

@NotNull
public PactDslJsonBody eachLike()

Array element where each element of the array must match the following object

eachLike

@NotNull
public PactDslJsonArray eachLike(@NotNull
                                          DslPart obj)

Array element where each element of the array must match the provided object

eachLike

@NotNull
public PactDslJsonBody eachLike(@NotNull
                                         java.lang.String name,
                                         int numberExamples)

Attribute that is an array where each item must match the following example

Parameters:

name - field name

numberExamples - number of examples to generate

eachLike

@NotNull
public PactDslJsonBody eachLike(int numberExamples)

Array element where each element of the array must match the following object

Parameters:

numberExamples - number of examples to generate

eachLike

@JvmOverloads
 @NotNull
public PactDslJsonBody eachLike(@NotNull
                                                        java.lang.String name,
                                                        @NotNull
                                                        PactDslJsonRootValue value,
                                                        int numberExamples)

Attribute that is an array of values that are not objects where each item must match the following example

Parameters:

name - field name

value - Value to use to match each item

numberExamples - number of examples to generate

eachLike

@JvmOverloads
 @NotNull
public PactDslJsonBody eachLike(@NotNull
                                                        java.lang.String name,
                                                        @NotNull
                                                        PactDslJsonRootValue value)

Attribute that is an array of values that are not objects where each item must match the following example

Parameters:

name - field name

value - Value to use to match each item

minArrayLike

@NotNull
public PactDslJsonBody minArrayLike(@NotNull
                                             java.lang.String name,
                                             int size)

Attribute that is an array with a minimum size where each item must match the following example

Parameters:

name - field name

size - minimum size of the array

minArrayLike

@NotNull
public PactDslJsonBody minArrayLike(int size)

Array element with a minimum size and each element of the array must match the following object

Parameters:

size - minimum size

minArrayLike

@NotNull
public PactDslJsonBody minArrayLike(@NotNull
                                             java.lang.String name,
                                             int size,
                                             @NotNull
                                             DslPart obj)

Array field with a minimum size and each element must match the provided object

Parameters:

name - field name

size - minimum size

minArrayLike

@NotNull
public PactDslJsonArray minArrayLike(int size,
                                              @NotNull
                                              DslPart obj)

Array element with a minumum size and each element of the array must match the provided object

Parameters:

size - minimum size

minArrayLike

@NotNull
public PactDslJsonBody minArrayLike(@NotNull
                                             java.lang.String name,
                                             int size,
                                             int numberExamples)

Attribute that is an array with a minimum size where each item must match the following example

Parameters:

name - field name

size - minimum size of the array

numberExamples - number of examples to generate

minArrayLike

@NotNull
public PactDslJsonBody minArrayLike(int size,
                                             int numberExamples)

Array element with a minimum size and each element of the array must match the following object

Parameters:

size - minimum size

numberExamples - number of examples to generate

minArrayLike

@JvmOverloads
 @NotNull
public PactDslJsonBody minArrayLike(@NotNull
                                                            java.lang.String name,
                                                            int size,
                                                            @NotNull
                                                            PactDslJsonRootValue value,
                                                            int numberExamples)

Attribute that is an array of values with a minimum size that are not objects where each item must match the following example

Parameters:

name - field name

size - minimum size of the array

value - Value to use to match each item

numberExamples - number of examples to generate

minArrayLike

@JvmOverloads
 @NotNull
public PactDslJsonBody minArrayLike(@NotNull
                                                            java.lang.String name,
                                                            int size,
                                                            @NotNull
                                                            PactDslJsonRootValue value)

Attribute that is an array of values with a minimum size that are not objects where each item must match the following example

Parameters:

name - field name

size - minimum size of the array

value - Value to use to match each item

maxArrayLike

@NotNull
public PactDslJsonBody maxArrayLike(@NotNull
                                             java.lang.String name,
                                             int size)

Attribute that is an array with a maximum size where each item must match the following example

Parameters:

name - field name

size - maximum size of the array

maxArrayLike

@NotNull
public PactDslJsonBody maxArrayLike(int size)

Array element with a maximum size and each element of the array must match the following object

Parameters:

size - maximum size

maxArrayLike

@NotNull
public PactDslJsonBody maxArrayLike(@NotNull
                                             java.lang.String name,
                                             int size,
                                             @NotNull
                                             DslPart obj)

Array field with a maximum size and each element must match the provided object

Parameters:

name - field name

size - maximum size

maxArrayLike

@NotNull
public PactDslJsonArray maxArrayLike(int size,
                                              @NotNull
                                              DslPart obj)

Array element with a maximum size and each element of the array must match the provided object

Parameters:

size - minimum size

maxArrayLike

@NotNull
public PactDslJsonBody maxArrayLike(@NotNull
                                             java.lang.String name,
                                             int size,
                                             int numberExamples)

Attribute that is an array with a maximum size where each item must match the following example

Parameters:

name - field name

size - maximum size of the array

numberExamples - number of examples to generate

maxArrayLike

@NotNull
public PactDslJsonBody maxArrayLike(int size,
                                             int numberExamples)

Array element with a maximum size and each element of the array must match the following object

Parameters:

size - maximum size

numberExamples - number of examples to generate

maxArrayLike

@JvmOverloads
 @NotNull
public PactDslJsonBody maxArrayLike(@NotNull
                                                            java.lang.String name,
                                                            int size,
                                                            @NotNull
                                                            PactDslJsonRootValue value,
                                                            int numberExamples)

Attribute that is an array of values with a maximum size that are not objects where each item must match the following example

Parameters:

name - field name

size - maximum size of the array

value - Value to use to match each item

numberExamples - number of examples to generate

maxArrayLike

@JvmOverloads
 @NotNull
public PactDslJsonBody maxArrayLike(@NotNull
                                                            java.lang.String name,
                                                            int size,
                                                            @NotNull
                                                            PactDslJsonRootValue value)

Attribute that is an array of values with a maximum size that are not objects where each item must match the following example

Parameters:

name - field name

size - maximum size of the array

value - Value to use to match each item

id

@JvmOverloads
 @NotNull
public PactDslJsonBody id(@NotNull
                                                  java.lang.String name)

Attribute named 'id' that must be a numeric identifier

id

@JvmOverloads
 @NotNull
public PactDslJsonBody id()

Attribute named 'id' that must be a numeric identifier

id

@NotNull
public PactDslJsonBody id(@NotNull
                                   java.lang.String name,
                                   long id)

Attribute that must be a numeric identifier

Parameters:

name - attribute name

id - example id to use for generated bodies

hexValue

@NotNull
public PactDslJsonBody hexValue(@NotNull
                                         java.lang.String name)

Attribute that must be encoded as a hexadecimal value

Parameters:

name - attribute name

hexValue

@NotNull
public PactDslJsonBody hexValue(@NotNull
                                         java.lang.String name,
                                         @NotNull
                                         java.lang.String hexValue)

Attribute that must be encoded as a hexadecimal value

Parameters:

name - attribute name

hexValue - example value to use for generated bodies

uuid

@NotNull
public PactDslJsonBody uuid(@NotNull
                                     java.lang.String name)

Attribute that must be encoded as an UUID

Parameters:

name - attribute name

uuid

@NotNull
public PactDslJsonBody uuid(@NotNull
                                     java.lang.String name,
                                     @NotNull
                                     java.util.UUID uuid)

Attribute that must be encoded as an UUID

Parameters:

name - attribute name

uuid - example UUID to use for generated bodies

uuid

@NotNull
public PactDslJsonBody uuid(@NotNull
                                     java.lang.String name,
                                     @NotNull
                                     java.lang.String uuid)

Attribute that must be encoded as an UUID

Parameters:

name - attribute name

uuid - example UUID to use for generated bodies

nullValue

@NotNull
public PactDslJsonBody nullValue(@NotNull
                                          java.lang.String fieldName)

Sets the field to a null value

Parameters:

fieldName - field name

eachArrayLike

@NotNull
public PactDslJsonArray eachArrayLike(@NotNull
                                               java.lang.String name)

Array field where each element is an array and must match the following object

Parameters:

name - field name

eachArrayLike

@NotNull
public PactDslJsonArray eachArrayLike()

Array element where each element of the array is an array and must match the following object

eachArrayLike

@NotNull
public PactDslJsonArray eachArrayLike(@NotNull
                                               java.lang.String name,
                                               int numberExamples)

Array field where each element is an array and must match the following object

Parameters:

name - field name

numberExamples - number of examples to generate

eachArrayLike

@NotNull
public PactDslJsonArray eachArrayLike(int numberExamples)

Array element where each element of the array is an array and must match the following object

Parameters:

numberExamples - number of examples to generate

eachArrayWithMaxLike

@NotNull
public PactDslJsonArray eachArrayWithMaxLike(@NotNull
                                                      java.lang.String name,
                                                      int size)

Array field where each element is an array and must match the following object

Parameters:

name - field name

size - Maximum size of the outer array

eachArrayWithMaxLike

@NotNull
public PactDslJsonArray eachArrayWithMaxLike(int size)

Array element where each element of the array is an array and must match the following object

Parameters:

size - Maximum size of the outer array

eachArrayWithMaxLike

@NotNull
public PactDslJsonArray eachArrayWithMaxLike(@NotNull
                                                      java.lang.String name,
                                                      int numberExamples,
                                                      int size)

Array field where each element is an array and must match the following object

Parameters:

name - field name

numberExamples - number of examples to generate

size - Maximum size of the outer array

eachArrayWithMaxLike

@NotNull
public PactDslJsonArray eachArrayWithMaxLike(int numberExamples,
                                                      int size)

Array element where each element of the array is an array and must match the following object

Parameters:

numberExamples - number of examples to generate

size - Maximum size of the outer array

eachArrayWithMinLike

@NotNull
public PactDslJsonArray eachArrayWithMinLike(@NotNull
                                                      java.lang.String name,
                                                      int size)

Array field where each element is an array and must match the following object

Parameters:

name - field name

size - Minimum size of the outer array

eachArrayWithMinLike

@NotNull
public PactDslJsonArray eachArrayWithMinLike(int size)

Array element where each element of the array is an array and must match the following object

Parameters:

size - Minimum size of the outer array

eachArrayWithMinLike

@NotNull
public PactDslJsonArray eachArrayWithMinLike(@NotNull
                                                      java.lang.String name,
                                                      int numberExamples,
                                                      int size)

Array field where each element is an array and must match the following object

Parameters:

name - field name

numberExamples - number of examples to generate

size - Minimum size of the outer array

eachArrayWithMinLike

@NotNull
public PactDslJsonArray eachArrayWithMinLike(int numberExamples,
                                                      int size)

Array element where each element of the array is an array and must match the following object

Parameters:

numberExamples - number of examples to generate

size - Minimum size of the outer array

eachKeyMappedToAnArrayLike

@NotNull
public PactDslJsonBody eachKeyMappedToAnArrayLike(@NotNull
                                                           java.lang.String exampleKey)

Accepts any key, and each key is mapped to a list of items that must match the following object definition Note: this needs the Java system property "pact.matching.wildcard" set to value "true" when the pact file is verified.

Parameters:

exampleKey - Example key to use for generating bodies

eachKeyLike

@NotNull
public PactDslJsonBody eachKeyLike(@NotNull
                                            java.lang.String exampleKey)

Accepts any key, and each key is mapped to a map that must match the following object definition Note: this needs the Java system property "pact.matching.wildcard" set to value "true" when the pact file is verified.

Parameters:

exampleKey - Example key to use for generating bodies

eachKeyLike

@NotNull
public PactDslJsonBody eachKeyLike(@NotNull
                                            java.lang.String exampleKey,
                                            @NotNull
                                            PactDslJsonRootValue value)

Accepts any key, and each key is mapped to a map that must match the provided object definition Note: this needs the Java system property "pact.matching.wildcard" set to value "true" when the pact file is verified.

Parameters:

exampleKey - Example key to use for generating bodies

value - Value to use for matching and generated bodies

includesStr

@NotNull
public PactDslJsonBody includesStr(@NotNull
                                            java.lang.String name,
                                            @NotNull
                                            java.lang.String value)

Attribute that must include the provided string value

Parameters:

name - attribute name

value - Value that must be included

equalTo

@NotNull
public PactDslJsonBody equalTo(@NotNull
                                        java.lang.String name,
                                        @Nullable
                                        java.lang.Object value)

Attribute that must be equal to the provided value.

Parameters:

name - attribute name

value - Value that will be used for comparisons

and

@NotNull
public PactDslJsonBody and(@NotNull
                                    java.lang.String name,
                                    @Nullable
                                    java.lang.Object value,
                                    @NotNull
                                    au.com.dius.pact.core.model.matchingrules.MatchingRule... rules)

Combine all the matchers using AND

Parameters:

name - Attribute name

value - Attribute example value

rules - Matching rules to apply

or

@NotNull
public PactDslJsonBody or(@NotNull
                                   java.lang.String name,
                                   @Nullable
                                   java.lang.Object value,
                                   @NotNull
                                   au.com.dius.pact.core.model.matchingrules.MatchingRule... rules)

Combine all the matchers using OR

Parameters:

name - Attribute name

value - Attribute example value

rules - Matching rules to apply

matchUrl

@NotNull
public PactDslJsonBody matchUrl(@NotNull
                                         java.lang.String name,
                                         @Nullable
                                         java.lang.String basePath,
                                         @NotNull
                                         java.lang.Object... pathFragments)

Matches a URL that is composed of a base path and a sequence of path expressions

Parameters:

name - Attribute name

basePath - The base path for the URL (like "http://localhost:8080/") which will be excluded from the matching

pathFragments - Series of path fragments to match on. These can be strings or regular expressions.

matchUrl

@NotNull
public DslPart matchUrl(@Nullable
                                 java.lang.String basePath,
                                 @NotNull
                                 java.lang.Object... pathFragments)

Matches a URL that is composed of a base path and a sequence of path expressions

Parameters:

basePath - The base path for the URL (like "http://localhost:8080/") which will be excluded from the matching

pathFragments - Series of path fragments to match on. These can be strings or regular expressions.

matchUrl2

@NotNull
public PactDslJsonBody matchUrl2(@NotNull
                                          java.lang.String name,
                                          @NotNull
                                          java.lang.Object... pathFragments)

Matches a URL that is composed of a base path and a sequence of path expressions. Base path from the mock server will be used.

Parameters:

name - Attribute name

pathFragments - Series of path fragments to match on. These can be strings or regular expressions.

matchUrl2

@NotNull
public DslPart matchUrl2(@NotNull
                                  java.lang.Object... pathFragments)

Matches a URL that is composed of a base path and a sequence of path expressions. Base path from the mock server

• will be used.

Parameters:

pathFragments - Series of path fragments to match on. These can be strings or regular expressions.

minMaxArrayLike

@NotNull
public PactDslJsonBody minMaxArrayLike(@NotNull
                                                java.lang.String name,
                                                int minSize,
                                                int maxSize)

Array field with a minimum and maximum size and each element must match the following object

Parameters:

name - field name

minSize - minimum size

maxSize - maximum size

minMaxArrayLike

@NotNull
public PactDslJsonBody minMaxArrayLike(@NotNull
                                                java.lang.String name,
                                                int minSize,
                                                int maxSize,
                                                @NotNull
                                                DslPart obj)

Array field with a minimum and maximum size and each element must match the provided object

Parameters:

name - field name

minSize - minimum size

maxSize - maximum size

minMaxArrayLike

@NotNull
public PactDslJsonBody minMaxArrayLike(int minSize,
                                                int maxSize)

Array element with a minimum and maximum size and each element of the array must match the following object

Parameters:

minSize - minimum size

maxSize - maximum size

minMaxArrayLike

@NotNull
public PactDslJsonArray minMaxArrayLike(int minSize,
                                                 int maxSize,
                                                 @NotNull
                                                 DslPart obj)

Array element with a minimum and maximum size and each element of the array must match the provided object

Parameters:

minSize - minimum size

maxSize - maximum size

minMaxArrayLike

@NotNull
public PactDslJsonBody minMaxArrayLike(@NotNull
                                                java.lang.String name,
                                                int minSize,
                                                int maxSize,
                                                int numberExamples)

Array field with a minimum and maximum size and each element must match the following object

Parameters:

name - field name

minSize - minimum size

maxSize - maximum size

numberExamples - number of examples to generate

minMaxArrayLike

@NotNull
public PactDslJsonBody minMaxArrayLike(int minSize,
                                                int maxSize,
                                                int numberExamples)

Array element with a minimum and maximum size and each element of the array must match the following object

Parameters:

minSize - minimum size

maxSize - maximum size

numberExamples - number of examples to generate

eachArrayWithMinMaxLike

@NotNull
public PactDslJsonArray eachArrayWithMinMaxLike(@NotNull
                                                         java.lang.String name,
                                                         int minSize,
                                                         int maxSize)

Array field where each element is an array and must match the following object

Parameters:

name - field name

minSize - minimum size

maxSize - maximum size

eachArrayWithMinMaxLike

@NotNull
public PactDslJsonArray eachArrayWithMinMaxLike(int minSize,
                                                         int maxSize)

Array element where each element of the array is an array and must match the following object

Parameters:

minSize - minimum size

maxSize - maximum size

eachArrayWithMinMaxLike

@NotNull
public PactDslJsonArray eachArrayWithMinMaxLike(@NotNull
                                                         java.lang.String name,
                                                         int numberExamples,
                                                         int minSize,
                                                         int maxSize)

Array field where each element is an array and must match the following object

Parameters:

name - field name

numberExamples - number of examples to generate

minSize - minimum size

maxSize - maximum size

eachArrayWithMinMaxLike

@NotNull
public PactDslJsonArray eachArrayWithMinMaxLike(int numberExamples,
                                                         int minSize,
                                                         int maxSize)

Array element where each element of the array is an array and must match the following object

Parameters:

numberExamples - number of examples to generate

minSize - minimum size

maxSize - maximum size

minMaxArrayLike

@NotNull
public PactDslJsonBody minMaxArrayLike(@NotNull
                                                java.lang.String name,
                                                int minSize,
                                                int maxSize,
                                                @NotNull
                                                PactDslJsonRootValue value,
                                                int numberExamples)

Attribute that is an array of values with a minimum and maximum size that are not objects where each item must match the following example

Parameters:

name - field name

minSize - minimum size

maxSize - maximum size

value - Value to use to match each item

numberExamples - number of examples to generate

valueFromProviderState

@NotNull
public PactDslJsonBody valueFromProviderState(@NotNull
                                                       java.lang.String name,
                                                       @NotNull
                                                       java.lang.String expression,
                                                       @Nullable
                                                       java.lang.Object example)

Adds an attribute that will have it's value injected from the provider state

Parameters:

name - Attribute name

expression - Expression to be evaluated from the provider state

example - Example value to be used in the consumer test

dateExpression

@JvmOverloads
 @NotNull
public PactDslJsonBody dateExpression(@NotNull
                                                              java.lang.String name,
                                                              @NotNull
                                                              java.lang.String expression,
                                                              @NotNull
                                                              java.lang.String format)

Adds a date attribute with the value generated by the date expression

Parameters:

name - Attribute name

expression - Date expression to use to generate the values

format - Date format to use

dateExpression

@JvmOverloads
 @NotNull
public PactDslJsonBody dateExpression(@NotNull
                                                              java.lang.String name,
                                                              @NotNull
                                                              java.lang.String expression)

Adds a date attribute with the value generated by the date expression

Parameters:

name - Attribute name

expression - Date expression to use to generate the values

timeExpression

@JvmOverloads
 @NotNull
public PactDslJsonBody timeExpression(@NotNull
                                                              java.lang.String name,
                                                              @NotNull
                                                              java.lang.String expression,
                                                              @NotNull
                                                              java.lang.String format)

Adds a time attribute with the value generated by the time expression

Parameters:

name - Attribute name

expression - Time expression to use to generate the values

format - Time format to use

timeExpression

@JvmOverloads
 @NotNull
public PactDslJsonBody timeExpression(@NotNull
                                                              java.lang.String name,
                                                              @NotNull
                                                              java.lang.String expression)

Adds a time attribute with the value generated by the time expression

Parameters:

name - Attribute name

expression - Time expression to use to generate the values

datetimeExpression

@JvmOverloads
 @NotNull
public PactDslJsonBody datetimeExpression(@NotNull
                                                                  java.lang.String name,
                                                                  @NotNull
                                                                  java.lang.String expression,
                                                                  @NotNull
                                                                  java.lang.String format)

Adds a datetime attribute with the value generated by the expression

Parameters:

name - Attribute name

expression - Datetime expression to use to generate the values

format - Datetime format to use

datetimeExpression

@JvmOverloads
 @NotNull
public PactDslJsonBody datetimeExpression(@NotNull
                                                                  java.lang.String name,
                                                                  @NotNull
                                                                  java.lang.String expression)

Adds a datetime attribute with the value generated by the expression

Parameters:

name - Attribute name

expression - Datetime expression to use to generate the values