
public class PactDslJsonBody
extends DslPart

DSL to define a JSON Object

Field Summary

Fields
Modifier and Type	Field	Description
`private JsonValue`	`body`
`private final DslPart`	`parent`
`private final String`	`rootPath`
`private final String`	`rootName`
`private MatchingRuleCategory`	`matchers`
`private Generators`	`generators`

Constructor Summary

Constructors
Constructor	Description
`PactDslJsonBody()`	Constructs a new body as a root
`PactDslJsonBody(String rootPath, String rootName, DslPart parent)`	Constructs a new body as a child
`PactDslJsonBody(String rootPath, String rootName, DslPart parent, PactDslJsonBody body)`	Constructs a new body as a child as a copy of an existing one

Method Summary

Modifier and Type	Method	Description
`String`	`toString()`
`Unit`	`putObjectPrivate(DslPart obj)`
`Unit`	`putArrayPrivate(DslPart obj)`
`final PactDslJsonBody`	`stringValue(String name, String value)`	Attribute that must be the specified value
`final PactDslJsonBody`	`numberValue(String name, Number value)`	Attribute that must be the specified number
`final PactDslJsonBody`	`booleanValue(String name, Boolean value)`	Attribute that must be the specified boolean
`PactDslJsonBody`	`like(String name, Object example)`	Attribute that must be the same type as the example
`final PactDslJsonBody`	`stringType(String name)`	Attribute that can be any string
`final PactDslJsonBody`	`stringType(Array<out String> names)`	Attributes that can be any string
`final PactDslJsonBody`	`stringType(String name, String example)`	Attribute that can be any string
`final PactDslJsonBody`	`numberType(String name)`	Attribute that can be any number
`final PactDslJsonBody`	`numberType(Array<out String> names)`	Attributes that can be any number
`final PactDslJsonBody`	`numberType(String name, Number number)`	Attribute that can be any number
`final PactDslJsonBody`	`integerType(String name)`	Attribute that must be an integer
`final PactDslJsonBody`	`integerType(Array<out String> names)`	Attributes that must be an integer
`final PactDslJsonBody`	`integerType(String name, Long number)`	Attribute that must be an integer
`final PactDslJsonBody`	`integerType(String name, Integer number)`	Attribute that must be an integer
`final PactDslJsonBody`	`decimalType(String name)`	Attribute that must be a decimal value
`final PactDslJsonBody`	`decimalType(Array<out String> names)`	Attributes that must be a decimal values
`final PactDslJsonBody`	`decimalType(String name, BigDecimal number)`	Attribute that must be a decimalType value
`final PactDslJsonBody`	`decimalType(String name, Double number)`	Attribute that must be a decimalType value
`final PactDslJsonBody`	`booleanType(Array<out String> names)`	Attributes that must be a boolean
`final PactDslJsonBody`	`booleanType(String name, Boolean example)`	Attribute that must be a boolean
`final PactDslJsonBody`	`stringMatcher(String name, String regex, String value)`	Attribute that must match the regular expression
`final PactDslJsonBody`	`stringMatcher(String name, String regex)`	Attribute that must match the regular expression
`final PactDslJsonBody`	`timestamp()`	Attribute named 'timestamp' that must be an ISO formatted timestamp
`final PactDslJsonBody`	`timestamp(String name)`	Attribute that must be an ISO formatted timestamp
`final PactDslJsonBody`	`timestamp(String name, String format)`	Attribute that must match the given datetime format
`final PactDslJsonBody`	`timestamp(String name, String format, Date example)`	Attribute that must match the given timestamp format
`final PactDslJsonBody`	`timestamp(String name, String format, Date example, TimeZone timeZone)`	Attribute that must match the given timestamp format
`final PactDslJsonBody`	`timestamp(String name, String format, Instant example)`	Attribute that must match the given timestamp format
`final PactDslJsonBody`	`timestamp(String name, String format, Instant example, TimeZone timeZone)`	Attribute that must match the given timestamp format
`final PactDslJsonBody`	`datetime(String name)`	Attribute that must be an ISO formatted datetime
`final PactDslJsonBody`	`datetime(String name, String format)`	Attribute that must match the given datetime format
`final PactDslJsonBody`	`datetime(String name, String format, Date example, TimeZone timeZone)`	Attribute that must match the given datetime format
`final PactDslJsonBody`	`datetime(String name, String format, Instant example, TimeZone timeZone)`	Attribute that must match the given datetime format
`final PactDslJsonBody`	`date(String name)`	Attribute that must be formatted as an ISO date
`final PactDslJsonBody`	`date(String name, String format)`	Attribute that must match the provided date format
`final PactDslJsonBody`	`date(String name, String format, Date example, TimeZone timeZone)`	Attribute that must match the provided date format
`final PactDslJsonBody`	`localDate(String name, String format, LocalDate example)`	Attribute that must match the provided date format
`final PactDslJsonBody`	`time(String name)`	Attribute named 'time' that must be an ISO formatted time
`final PactDslJsonBody`	`time(String name, String format)`	Attribute that must match the given time format
`final PactDslJsonBody`	`time(String name, String format, Date example, TimeZone timeZone)`	Attribute that must match the given time format
`final PactDslJsonBody`	`ipAddress(String name)`	Attribute that must be an IP4 address
`PactDslJsonBody`	`object(String name)`	Attribute that is a JSON object
`PactDslJsonBody`	`object()`	Object element
`final PactDslJsonBody`	`object(String name, DslPart value)`	Attribute that is a JSON object defined from a DSL part
`DslPart`	`closeObject()`	Closes the current JSON object
`DslPart`	`close()`	This closes off the object graph build from the DSL in case any closeObject\|Array methods have not been called.
`PactDslJsonArray`	`array(String name)`	Attribute that is an array
`PactDslJsonArray`	`array()`	Element as an array
`PactDslJsonArray`	`unorderedArray(String name)`	Array field where order is ignored
`PactDslJsonArray`	`unorderedArray()`	Array element where order is ignored
`PactDslJsonArray`	`unorderedMinArray(String name, Integer size)`	Array field of min size where order is ignored
`PactDslJsonArray`	`unorderedMinArray(Integer size)`	Array element of min size where order is ignored
`PactDslJsonArray`	`unorderedMaxArray(String name, Integer size)`	Array field of max size where order is ignored
`PactDslJsonArray`	`unorderedMaxArray(Integer size)`	Array element of max size where order is ignored
`PactDslJsonArray`	`unorderedMinMaxArray(String name, Integer minSize, Integer maxSize)`	Array field of min and max size where order is ignored
`PactDslJsonArray`	`unorderedMinMaxArray(Integer minSize, Integer maxSize)`	Array element of min and max size where order is ignored
`DslPart`	`closeArray()`	Closes the current array
`PactDslJsonBody`	`eachLike(String name)`	Attribute that is an array where each item must match the following example
`PactDslJsonBody`	`eachLike(String name, DslPart obj)`	Array field where each element must match the following object
`PactDslJsonBody`	`eachLike()`	Array element where each element of the array must match the following object
`PactDslJsonArray`	`eachLike(DslPart obj)`	Array element where each element of the array must match the provided object
`PactDslJsonBody`	`eachLike(String name, Integer numberExamples)`	Attribute that is an array where each item must match the following example
`PactDslJsonBody`	`eachLike(Integer numberExamples)`	Array element where each element of the array must match the following object
`final PactDslJsonBody`	`eachLike(String name, PactDslJsonRootValue value, Integer numberExamples)`	Attribute that is an array of values that are not objects where each item must match the following example
`PactDslJsonBody`	`minArrayLike(String name, Integer size)`	Attribute that is an array with a minimum size where each item must match the following example
`PactDslJsonBody`	`minArrayLike(Integer size)`	Array element with a minimum size and each element of the array must match the following object
`PactDslJsonBody`	`minArrayLike(String name, Integer size, DslPart obj)`	Array field with a minimum size and each element must match the provided object
`PactDslJsonArray`	`minArrayLike(Integer size, DslPart obj)`	Array element with a minumum size and each element of the array must match the provided object
`PactDslJsonBody`	`minArrayLike(String name, Integer size, Integer numberExamples)`	Attribute that is an array with a minimum size where each item must match the following example
`PactDslJsonBody`	`minArrayLike(Integer size, Integer numberExamples)`	Array element with a minimum size and each element of the array must match the following object
`final PactDslJsonBody`	`minArrayLike(String name, Integer size, PactDslJsonRootValue value, Integer numberExamples)`	Attribute that is an array of values with a minimum size that are not objects where each item must match the following example
`PactDslJsonBody`	`maxArrayLike(String name, Integer size)`	Attribute that is an array with a maximum size where each item must match the following example
`PactDslJsonBody`	`maxArrayLike(Integer size)`	Array element with a maximum size and each element of the array must match the following object
`PactDslJsonBody`	`maxArrayLike(String name, Integer size, DslPart obj)`	Array field with a maximum size and each element must match the provided object
`PactDslJsonArray`	`maxArrayLike(Integer size, DslPart obj)`	Array element with a maximum size and each element of the array must match the provided object
`PactDslJsonBody`	`maxArrayLike(String name, Integer size, Integer numberExamples)`	Attribute that is an array with a maximum size where each item must match the following example
`PactDslJsonBody`	`maxArrayLike(Integer size, Integer numberExamples)`	Array element with a maximum size and each element of the array must match the following object
`final PactDslJsonBody`	`maxArrayLike(String name, Integer size, PactDslJsonRootValue value, Integer numberExamples)`	Attribute that is an array of values with a maximum size that are not objects where each item must match the following example
`final PactDslJsonBody`	`id(String name)`	Attribute named 'id' that must be a numeric identifier
`final PactDslJsonBody`	`id(String name, Long id)`	Attribute that must be a numeric identifier
`final PactDslJsonBody`	`hexValue(String name)`	Attribute that must be encoded as a hexadecimal value
`final PactDslJsonBody`	`hexValue(String name, String hexValue)`	Attribute that must be encoded as a hexadecimal value
`final PactDslJsonBody`	`uuid(String name)`	Attribute that must be encoded as an UUID
`final PactDslJsonBody`	`uuid(String name, UUID uuid)`	Attribute that must be encoded as an UUID
`final PactDslJsonBody`	`uuid(String name, String uuid)`	Attribute that must be encoded as an UUID
`final PactDslJsonBody`	`nullValue(String fieldName)`	Sets the field to a null value
`PactDslJsonArray`	`eachArrayLike(String name)`	Array field where each element is an array and must match the following object
`PactDslJsonArray`	`eachArrayLike()`	Array element where each element of the array is an array and must match the following object
`PactDslJsonArray`	`eachArrayLike(String name, Integer numberExamples)`	Array field where each element is an array and must match the following object
`PactDslJsonArray`	`eachArrayLike(Integer numberExamples)`	Array element where each element of the array is an array and must match the following object
`PactDslJsonArray`	`eachArrayWithMaxLike(String name, Integer size)`	Array field where each element is an array and must match the following object
`PactDslJsonArray`	`eachArrayWithMaxLike(Integer size)`	Array element where each element of the array is an array and must match the following object
`PactDslJsonArray`	`eachArrayWithMaxLike(String name, Integer numberExamples, Integer size)`	Array field where each element is an array and must match the following object
`PactDslJsonArray`	`eachArrayWithMaxLike(Integer numberExamples, Integer size)`	Array element where each element of the array is an array and must match the following object
`PactDslJsonArray`	`eachArrayWithMinLike(String name, Integer size)`	Array field where each element is an array and must match the following object
`PactDslJsonArray`	`eachArrayWithMinLike(Integer size)`	Array element where each element of the array is an array and must match the following object
`PactDslJsonArray`	`eachArrayWithMinLike(String name, Integer numberExamples, Integer size)`	Array field where each element is an array and must match the following object
`PactDslJsonArray`	`eachArrayWithMinLike(Integer numberExamples, Integer size)`	Array element where each element of the array is an array and must match the following object
`final PactDslJsonBody`	`eachKeyMappedToAnArrayLike(String exampleKey)`	Accepts any key, and each key is mapped to a list of items that must match the following object definition
`final PactDslJsonBody`	`eachKeyLike(String exampleKey)`	Accepts any key, and each key is mapped to a map that must match the following object definition
`final PactDslJsonBody`	`eachKeyLike(String exampleKey, PactDslJsonRootValue value)`	Accepts any key, and each key is mapped to a map that must match the provided object definition
`final PactDslJsonBody`	`includesStr(String name, String value)`	Attribute that must include the provided string value
`final PactDslJsonBody`	`equalTo(String name, Object value)`	Attribute that must be equal to the provided value.
`final PactDslJsonBody`	`and(String name, Object value, Array<out MatchingRule> rules)`	Combine all the matchers using AND
`final PactDslJsonBody`	`or(String name, Object value, Array<out MatchingRule> rules)`	Combine all the matchers using OR
`PactDslJsonBody`	`matchUrl(String name, String basePath, Array<out Object> pathFragments)`	Matches a URL that is composed of a base path and a sequence of path expressions
`DslPart`	`matchUrl(String basePath, Array<out Object> pathFragments)`	Matches a URL that is composed of a base path and a sequence of path expressions
`PactDslJsonBody`	`matchUrl2(String name, Array<out Object> pathFragments)`	Matches a URL that is composed of a base path and a sequence of path expressions.
`DslPart`	`matchUrl2(Array<out Object> pathFragments)`	Matches a URL that is composed of a base path and a sequence of path expressions.
`PactDslJsonBody`	`minMaxArrayLike(String name, Integer minSize, Integer maxSize)`	Array field with a minimum and maximum size and each element must match the following object
`PactDslJsonBody`	`minMaxArrayLike(String name, Integer minSize, Integer maxSize, DslPart obj)`	Array field with a minimum and maximum size and each element must match the provided object
`PactDslJsonBody`	`minMaxArrayLike(Integer minSize, Integer maxSize)`	Array element with a minimum and maximum size and each element of the array must match the following object
`PactDslJsonArray`	`minMaxArrayLike(Integer minSize, Integer maxSize, DslPart obj)`	Array element with a minimum and maximum size and each element of the array must match the provided object
`PactDslJsonBody`	`minMaxArrayLike(String name, Integer minSize, Integer maxSize, Integer numberExamples)`	Array field with a minimum and maximum size and each element must match the following object
`PactDslJsonBody`	`minMaxArrayLike(Integer minSize, Integer maxSize, Integer numberExamples)`	Array element with a minimum and maximum size and each element of the array must match the following object
`final PactDslJsonBody`	`minMaxArrayLike(String name, Integer minSize, Integer maxSize, PactDslJsonRootValue value, Integer 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
`PactDslJsonArray`	`eachArrayWithMinMaxLike(String name, Integer minSize, Integer maxSize)`	Array field where each element is an array and must match the following object
`PactDslJsonArray`	`eachArrayWithMinMaxLike(Integer minSize, Integer maxSize)`	Array element where each element of the array is an array and must match the following object
`PactDslJsonArray`	`eachArrayWithMinMaxLike(String name, Integer numberExamples, Integer minSize, Integer maxSize)`	Array field where each element is an array and must match the following object
`PactDslJsonArray`	`eachArrayWithMinMaxLike(Integer numberExamples, Integer minSize, Integer maxSize)`	Array element where each element of the array is an array and must match the following object
`final PactDslJsonBody`	`valueFromProviderState(String name, String expression, Object example)`	Adds an attribute that will have it's value injected from the provider state
`final PactDslJsonBody`	`dateExpression(String name, String expression, String format)`	Adds a date attribute with the value generated by the date expression
`final PactDslJsonBody`	`timeExpression(String name, String expression, String format)`	Adds a time attribute with the value generated by the time expression
`final PactDslJsonBody`	`datetimeExpression(String name, String expression, String format)`	Adds a datetime attribute with the value generated by the expression
`DslPart`	`arrayContaining(String name)`	Matches the items in an array against a number of variants.
`JsonValue`	`getBody()`
`final DslPart`	`getParent()`	Returns the parent of this part (object or array)
`final String`	`getRootPath()`
`final String`	`getRootName()`
`final MatchingRuleCategory`	`getMatchers()`
`final Generators`	`getGenerators()`
`Unit`	`setBody(JsonValue body)`
`final Unit`	`setMatchers(MatchingRuleCategory matchers)`
`final Unit`	`setGenerators(Generators generators)`

Methods inherited from class au.com.dius.pact.consumer.dsl.PactDslJsonBody
asArray, asBody
Methods inherited from class au.com.dius.pact.consumer.dsl.DslPart
equals, hashCode
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PactDslJsonBody
```
PactDslJsonBody()
```
    Constructs a new body as a root
  - PactDslJsonBody
```
PactDslJsonBody(String rootPath, String rootName, 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
```
PactDslJsonBody(String rootPath, String rootName, DslPart parent, 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
  - toString
```
 String toString()
```
  - putObjectPrivate
```
 Unit putObjectPrivate(DslPart obj)
```
  - putArrayPrivate
```
 Unit putArrayPrivate(DslPart obj)
```
  - stringValue
```
 final PactDslJsonBody stringValue(String name, String value)
```
    Attribute that must be the specified value
    
    Parameters:
    
    name - attribute name
    
    value - string value
  - numberValue
```
 final PactDslJsonBody numberValue(String name, Number value)
```
    Attribute that must be the specified number
    
    Parameters:
    
    name - attribute name
    
    value - number value
  - booleanValue
```
 final PactDslJsonBody booleanValue(String name, Boolean value)
```
    Attribute that must be the specified boolean
    
    Parameters:
    
    name - attribute name
    
    value - boolean value
  - like
```
 PactDslJsonBody like(String name, Object example)
```
    Attribute that must be the same type as the example
    
    Parameters:
    
    name - attribute name
  - stringType
```
 final PactDslJsonBody stringType(String name)
```
    Attribute that can be any string
    
    Parameters:
    
    name - attribute name
  - stringType
```
 final PactDslJsonBody stringType(Array<out String> names)
```
    Attributes that can be any string
    
    Parameters:
    
    names - attribute names
  - stringType
```
 final PactDslJsonBody stringType(String name, String example)
```
    Attribute that can be any string
    
    Parameters:
    
    name - attribute name
    
    example - example value to use for generated bodies
  - numberType
```
 final PactDslJsonBody numberType(String name)
```
    Attribute that can be any number
    
    Parameters:
    
    name - attribute name
  - numberType
```
 final PactDslJsonBody numberType(Array<out String> names)
```
    Attributes that can be any number
    
    Parameters:
    
    names - attribute names
  - numberType
```
 final PactDslJsonBody numberType(String name, Number number)
```
    Attribute that can be any number
    
    Parameters:
    
    name - attribute name
    
    number - example number to use for generated bodies
  - integerType
```
 final PactDslJsonBody integerType(String name)
```
    Attribute that must be an integer
    
    Parameters:
    
    name - attribute name
  - integerType
```
 final PactDslJsonBody integerType(Array<out String> names)
```
    Attributes that must be an integer
    
    Parameters:
    
    names - attribute names
  - integerType
```
 final PactDslJsonBody integerType(String name, Long number)
```
    Attribute that must be an integer
    
    Parameters:
    
    name - attribute name
    
    number - example integer value to use for generated bodies
  - integerType
```
 final PactDslJsonBody integerType(String name, Integer number)
```
    Attribute that must be an integer
    
    Parameters:
    
    name - attribute name
    
    number - example integer value to use for generated bodies
  - decimalType
```
 final PactDslJsonBody decimalType(String name)
```
    Attribute that must be a decimal value
    
    Parameters:
    
    name - attribute name
  - decimalType
```
 final PactDslJsonBody decimalType(Array<out String> names)
```
    Attributes that must be a decimal values
    
    Parameters:
    
    names - attribute names
  - decimalType
```
 final PactDslJsonBody decimalType(String name, BigDecimal number)
```
    Attribute that must be a decimalType value
    
    Parameters:
    
    name - attribute name
    
    number - example decimalType value
  - decimalType
```
 final PactDslJsonBody decimalType(String name, Double number)
```
    Attribute that must be a decimalType value
    
    Parameters:
    
    name - attribute name
    
    number - example decimalType value
  - booleanType
```
 final PactDslJsonBody booleanType(Array<out String> names)
```
    Attributes that must be a boolean
    
    Parameters:
    
    names - attribute names
  - booleanType
```
@JvmOverloads() final PactDslJsonBody booleanType(String name, Boolean example)
```
    Attribute that must be a boolean
    
    Parameters:
    
    name - attribute name
    
    example - example boolean to use for generated bodies
  - stringMatcher
```
 final PactDslJsonBody stringMatcher(String name, String regex, 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
```
 final PactDslJsonBody stringMatcher(String name, String regex)
```
    Attribute that must match the regular expression
    
    Parameters:
    
    name - attribute name
    
    regex - regular expression
  - timestamp
```
@Deprecated(message = "Use datetime instead") final PactDslJsonBody timestamp()
```
    Attribute named 'timestamp' that must be an ISO formatted timestamp
  - timestamp
```
@Deprecated(message = "Use datetime instead") final PactDslJsonBody timestamp(String name)
```
    Attribute that must be an ISO formatted timestamp
  - timestamp
```
@Deprecated(message = "use datetime instead") final PactDslJsonBody timestamp(String name, String format)
```
    Attribute that must match the given datetime format
    
    Parameters:
    
    name - attribute name
    
    format - timestamp format
  - timestamp
```
@Deprecated(message = "use datetime instead") final PactDslJsonBody timestamp(String name, String format, Date example)
```
    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(message = "use datetime instead") final PactDslJsonBody timestamp(String name, String format, Date example, TimeZone timeZone)
```
    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(message = "use datetime instead") final PactDslJsonBody timestamp(String name, String format, Instant example)
```
    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(message = "use datetime instead") final PactDslJsonBody timestamp(String name, String format, Instant example, TimeZone timeZone)
```
    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
```
 final PactDslJsonBody datetime(String name)
```
    Attribute that must be an ISO formatted datetime
  - datetime
```
 final PactDslJsonBody datetime(String name, String format)
```
    Attribute that must match the given datetime format
    
    Parameters:
    
    name - attribute name
    
    format - datetime format
  - datetime
```
@JvmOverloads() final PactDslJsonBody datetime(String name, String format, Date example, 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() final PactDslJsonBody datetime(String name, String format, Instant example, 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
  - date
```
@JvmOverloads() final PactDslJsonBody date(String name)
```
    Attribute that must be formatted as an ISO date
    
    Parameters:
    
    name - attribute name
  - date
```
 final PactDslJsonBody date(String name, String format)
```
    Attribute that must match the provided date format
    
    Parameters:
    
    name - attribute date
    
    format - date format to match
  - date
```
@JvmOverloads() final PactDslJsonBody date(String name, String format, Date example, 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
  - localDate
```
 final PactDslJsonBody localDate(String name, String format, LocalDate 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() final PactDslJsonBody time(String name)
```
    Attribute named 'time' that must be an ISO formatted time
  - time
```
 final PactDslJsonBody time(String name, String format)
```
    Attribute that must match the given time format
    
    Parameters:
    
    name - attribute name
    
    format - time format to match
  - time
```
@JvmOverloads() final PactDslJsonBody time(String name, String format, Date example, 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
  - ipAddress
```
 final PactDslJsonBody ipAddress(String name)
```
    Attribute that must be an IP4 address
    
    Parameters:
    
    name - attribute name
  - object
```
 PactDslJsonBody object(String name)
```
    Attribute that is a JSON object
    
    Parameters:
    
    name - field name
  - object
```
 PactDslJsonBody object()
```
    Object element
  - object
```
 final PactDslJsonBody object(String name, 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
```
 DslPart closeObject()
```
    Closes the current JSON object
  - close
```
 DslPart close()
```
    This closes off the object graph build from the DSL in case any closeObject|Array methods have not been called.
  - array
```
 PactDslJsonArray array(String name)
```
    Attribute that is an array
    
    Parameters:
    
    name - field name
  - array
```
 PactDslJsonArray array()
```
    Element as an array
  - unorderedArray
```
 PactDslJsonArray unorderedArray(String name)
```
    Array field where order is ignored
    
    Parameters:
    
    name - field name
  - unorderedArray
```
 PactDslJsonArray unorderedArray()
```
    Array element where order is ignored
  - unorderedMinArray
```
 PactDslJsonArray unorderedMinArray(String name, Integer size)
```
    Array field of min size where order is ignored
    
    Parameters:
    
    name - field name
    
    size - minimum size
  - unorderedMinArray
```
 PactDslJsonArray unorderedMinArray(Integer size)
```
    Array element of min size where order is ignored
    
    Parameters:
    
    size - minimum size
  - unorderedMaxArray
```
 PactDslJsonArray unorderedMaxArray(String name, Integer size)
```
    Array field of max size where order is ignored
    
    Parameters:
    
    name - field name
    
    size - maximum size
  - unorderedMaxArray
```
 PactDslJsonArray unorderedMaxArray(Integer size)
```
    Array element of max size where order is ignored
    
    Parameters:
    
    size - maximum size
  - unorderedMinMaxArray
```
 PactDslJsonArray unorderedMinMaxArray(String name, Integer minSize, Integer maxSize)
```
    Array field of min and max size where order is ignored
    
    Parameters:
    
    name - field name
    
    minSize - minimum size
    
    maxSize - maximum size
  - unorderedMinMaxArray
```
 PactDslJsonArray unorderedMinMaxArray(Integer minSize, Integer maxSize)
```
    Array element of min and max size where order is ignored
    
    Parameters:
    
    minSize - minimum size
    
    maxSize - maximum size
  - closeArray
```
 DslPart closeArray()
```
    Closes the current array
  - eachLike
```
 PactDslJsonBody eachLike(String name)
```
    Attribute that is an array where each item must match the following example
    
    Parameters:
    
    name - field name
  - eachLike
```
 PactDslJsonBody eachLike(String name, DslPart obj)
```
    Array field where each element must match the following object
    
    Parameters:
    
    name - field name
  - eachLike
```
 PactDslJsonBody eachLike()
```
    Array element where each element of the array must match the following object
  - eachLike
```
 PactDslJsonArray eachLike(DslPart obj)
```
    Array element where each element of the array must match the provided object
  - eachLike
```
 PactDslJsonBody eachLike(String name, Integer 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
```
 PactDslJsonBody eachLike(Integer numberExamples)
```
    Array element where each element of the array must match the following object
    
    Parameters:
    
    numberExamples - number of examples to generate
  - eachLike
```
@JvmOverloads() final PactDslJsonBody eachLike(String name, PactDslJsonRootValue value, Integer 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
  - minArrayLike
```
 PactDslJsonBody minArrayLike(String name, Integer 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
```
 PactDslJsonBody minArrayLike(Integer size)
```
    Array element with a minimum size and each element of the array must match the following object
    
    Parameters:
    
    size - minimum size
  - minArrayLike
```
 PactDslJsonBody minArrayLike(String name, Integer size, DslPart obj)
```
    Array field with a minimum size and each element must match the provided object
    
    Parameters:
    
    name - field name
    
    size - minimum size
  - minArrayLike
```
 PactDslJsonArray minArrayLike(Integer size, DslPart obj)
```
    Array element with a minumum size and each element of the array must match the provided object
    
    Parameters:
    
    size - minimum size
  - minArrayLike
```
 PactDslJsonBody minArrayLike(String name, Integer size, Integer 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
```
 PactDslJsonBody minArrayLike(Integer size, Integer 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() final PactDslJsonBody minArrayLike(String name, Integer size, PactDslJsonRootValue value, Integer 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
  - maxArrayLike
```
 PactDslJsonBody maxArrayLike(String name, Integer 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
```
 PactDslJsonBody maxArrayLike(Integer size)
```
    Array element with a maximum size and each element of the array must match the following object
    
    Parameters:
    
    size - maximum size
  - maxArrayLike
```
 PactDslJsonBody maxArrayLike(String name, Integer size, DslPart obj)
```
    Array field with a maximum size and each element must match the provided object
    
    Parameters:
    
    name - field name
    
    size - maximum size
  - maxArrayLike
```
 PactDslJsonArray maxArrayLike(Integer size, DslPart obj)
```
    Array element with a maximum size and each element of the array must match the provided object
    
    Parameters:
    
    size - minimum size
  - maxArrayLike
```
 PactDslJsonBody maxArrayLike(String name, Integer size, Integer 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
```
 PactDslJsonBody maxArrayLike(Integer size, Integer 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() final PactDslJsonBody maxArrayLike(String name, Integer size, PactDslJsonRootValue value, Integer 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
  - id
```
@JvmOverloads() final PactDslJsonBody id(String name)
```
    Attribute named 'id' that must be a numeric identifier
  - id
```
 final PactDslJsonBody id(String name, Long id)
```
    Attribute that must be a numeric identifier
    
    Parameters:
    
    name - attribute name
    
    id - example id to use for generated bodies
  - hexValue
```
 final PactDslJsonBody hexValue(String name)
```
    Attribute that must be encoded as a hexadecimal value
    
    Parameters:
    
    name - attribute name
  - hexValue
```
 final PactDslJsonBody hexValue(String name, String hexValue)
```
    Attribute that must be encoded as a hexadecimal value
    
    Parameters:
    
    name - attribute name
    
    hexValue - example value to use for generated bodies
  - uuid
```
 final PactDslJsonBody uuid(String name)
```
    Attribute that must be encoded as an UUID
    
    Parameters:
    
    name - attribute name
  - uuid
```
 final PactDslJsonBody uuid(String name, UUID uuid)
```
    Attribute that must be encoded as an UUID
    
    Parameters:
    
    name - attribute name
    
    uuid - example UUID to use for generated bodies
  - uuid
```
 final PactDslJsonBody uuid(String name, String uuid)
```
    Attribute that must be encoded as an UUID
    
    Parameters:
    
    name - attribute name
    
    uuid - example UUID to use for generated bodies
  - nullValue
```
 final PactDslJsonBody nullValue(String fieldName)
```
    Sets the field to a null value
    
    Parameters:
    
    fieldName - field name
  - eachArrayLike
```
 PactDslJsonArray eachArrayLike(String name)
```
    Array field where each element is an array and must match the following object
    
    Parameters:
    
    name - field name
  - eachArrayLike
```
 PactDslJsonArray eachArrayLike()
```
    Array element where each element of the array is an array and must match the following object
  - eachArrayLike
```
 PactDslJsonArray eachArrayLike(String name, Integer 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
```
 PactDslJsonArray eachArrayLike(Integer 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
```
 PactDslJsonArray eachArrayWithMaxLike(String name, Integer 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
```
 PactDslJsonArray eachArrayWithMaxLike(Integer 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
```
 PactDslJsonArray eachArrayWithMaxLike(String name, Integer numberExamples, Integer 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
```
 PactDslJsonArray eachArrayWithMaxLike(Integer numberExamples, Integer 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
```
 PactDslJsonArray eachArrayWithMinLike(String name, Integer 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
```
 PactDslJsonArray eachArrayWithMinLike(Integer 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
```
 PactDslJsonArray eachArrayWithMinLike(String name, Integer numberExamples, Integer 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
```
 PactDslJsonArray eachArrayWithMinLike(Integer numberExamples, Integer 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
```
 final PactDslJsonBody eachKeyMappedToAnArrayLike(String exampleKey)
```
    Accepts any key, and each key is mapped to a list of items that must match the following object definition
    
    Parameters:
    
    exampleKey - Example key to use for generating bodies
  - eachKeyLike
```
 final PactDslJsonBody eachKeyLike(String exampleKey)
```
    Accepts any key, and each key is mapped to a map that must match the following object definition
    
    Parameters:
    
    exampleKey - Example key to use for generating bodies
  - eachKeyLike
```
 final PactDslJsonBody eachKeyLike(String exampleKey, PactDslJsonRootValue value)
```
    Accepts any key, and each key is mapped to a map that must match the provided object definition
    
    Parameters:
    
    exampleKey - Example key to use for generating bodies
    
    value - Value to use for matching and generated bodies
  - includesStr
```
 final PactDslJsonBody includesStr(String name, String value)
```
    Attribute that must include the provided string value
    
    Parameters:
    
    name - attribute name
    
    value - Value that must be included
  - equalTo
```
 final PactDslJsonBody equalTo(String name, Object value)
```
    Attribute that must be equal to the provided value.
    
    Parameters:
    
    name - attribute name
    
    value - Value that will be used for comparisons
  - and
```
 final PactDslJsonBody and(String name, Object value, Array<out MatchingRule> rules)
```
    Combine all the matchers using AND
    
    Parameters:
    
    name - Attribute name
    
    value - Attribute example value
    
    rules - Matching rules to apply
  - or
```
 final PactDslJsonBody or(String name, Object value, Array<out MatchingRule> rules)
```
    Combine all the matchers using OR
    
    Parameters:
    
    name - Attribute name
    
    value - Attribute example value
    
    rules - Matching rules to apply
  - matchUrl
```
 PactDslJsonBody matchUrl(String name, String basePath, Array<out 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.
  - matchUrl
```
 DslPart matchUrl(String basePath, Array<out 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.
  - matchUrl2
```
 PactDslJsonBody matchUrl2(String name, Array<out 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.
  - matchUrl2
```
 DslPart matchUrl2(Array<out 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.
  - minMaxArrayLike
```
 PactDslJsonBody minMaxArrayLike(String name, Integer minSize, Integer 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
```
 PactDslJsonBody minMaxArrayLike(String name, Integer minSize, Integer maxSize, 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
```
 PactDslJsonBody minMaxArrayLike(Integer minSize, Integer 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
```
 PactDslJsonArray minMaxArrayLike(Integer minSize, Integer maxSize, 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
```
 PactDslJsonBody minMaxArrayLike(String name, Integer minSize, Integer maxSize, Integer 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
```
 PactDslJsonBody minMaxArrayLike(Integer minSize, Integer maxSize, Integer 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
  - minMaxArrayLike
```
 final PactDslJsonBody minMaxArrayLike(String name, Integer minSize, Integer maxSize, PactDslJsonRootValue value, Integer 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
  - eachArrayWithMinMaxLike
```
 PactDslJsonArray eachArrayWithMinMaxLike(String name, Integer minSize, Integer 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
```
 PactDslJsonArray eachArrayWithMinMaxLike(Integer minSize, Integer 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
```
 PactDslJsonArray eachArrayWithMinMaxLike(String name, Integer numberExamples, Integer minSize, Integer 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
```
 PactDslJsonArray eachArrayWithMinMaxLike(Integer numberExamples, Integer minSize, Integer 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
  - valueFromProviderState
```
 final PactDslJsonBody valueFromProviderState(String name, String expression, 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() final PactDslJsonBody dateExpression(String name, String expression, 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
  - timeExpression
```
@JvmOverloads() final PactDslJsonBody timeExpression(String name, String expression, 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
  - datetimeExpression
```
@JvmOverloads() final PactDslJsonBody datetimeExpression(String name, String expression, 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
  - arrayContaining
```
 DslPart arrayContaining(String name)
```
    Matches the items in an array against a number of variants. Matching is successful if each variant occurs once in the array. Variants may be objects containing matching rules.
    
    Parameters:
    
    name - Attribute name
  - getBody
```
 JsonValue getBody()
```
  - getParent
```
 final DslPart getParent()
```
    Returns the parent of this part (object or array)
  - getRootPath
```
 final String getRootPath()
```
  - getRootName
```
 final String getRootName()
```
  - getMatchers
```
 final MatchingRuleCategory getMatchers()
```
  - getGenerators
```
 final Generators getGenerators()
```
  - setBody
```
 Unit setBody(JsonValue body)
```
  - setMatchers
```
 final Unit setMatchers(MatchingRuleCategory matchers)
```
  - setGenerators
```
 final Unit setGenerators(Generators generators)
```

Class PactDslJsonBody

Field Summary

Constructor Summary

Method Summary

Methods inherited from class au.com.dius.pact.consumer.dsl.PactDslJsonBody

Methods inherited from class au.com.dius.pact.consumer.dsl.DslPart

Methods inherited from class java.lang.Object

Constructor Detail

PactDslJsonBody

PactDslJsonBody

PactDslJsonBody

Method Detail

toString

putObjectPrivate

putArrayPrivate

stringValue

numberValue

booleanValue

like

stringType

stringType

stringType

numberType

numberType

numberType

integerType

integerType

integerType

integerType

decimalType

decimalType

decimalType

decimalType

booleanType

booleanType

stringMatcher

stringMatcher

timestamp

timestamp

timestamp

timestamp

timestamp

timestamp

timestamp

datetime

datetime

datetime

datetime

date

date

date

localDate

time

time

time

ipAddress

object

object

object

closeObject

close

array

array

unorderedArray

unorderedArray

unorderedMinArray

unorderedMinArray

unorderedMaxArray

unorderedMaxArray

unorderedMinMaxArray

unorderedMinMaxArray

closeArray

eachLike

eachLike

eachLike

eachLike

eachLike

eachLike

eachLike

minArrayLike