au.com.dius.pact.consumer.dsl

Class PactDslJsonRootValue

java.lang.Object

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

au.com.dius.pact.consumer.dsl.PactDslJsonRootValue

public class PactDslJsonRootValue
extends DslPart

Field Summary

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

closed, DATE_2000, generators, HEXADECIMAL, IP_ADDRESS, matchers, parent, rootName, rootPath, UUID_REGEX

Constructor Summary

Constructors

Constructor and Description
PactDslJsonRootValue()

Method Summary

Modifier and Type	Method and Description
static PactDslJsonRootValue	and(java.lang.Object example, au.com.dius.pact.core.model.matchingrules.MatchingRule... rules) Combine all the matchers using AND
PactDslJsonArray	array() Deprecated. Use PactDslJsonArray for arrays
PactDslJsonArray	array(java.lang.String name) Deprecated. Use PactDslJsonArray for arrays
static PactDslJsonRootValue	booleanType() Value that must be a boolean
static PactDslJsonRootValue	booleanType(java.lang.Boolean example) Value that must be a boolean
DslPart	close() This closes off the object graph build from the DSL in case any close[Object|Array] methods have not been called.
DslPart	closeArray() Deprecated. Use PactDslJsonArray for arrays
DslPart	closeObject() Deprecated. Use PactDslJsonBody for objects
static PactDslJsonRootValue	date() Value that must be formatted as an ISO date
static PactDslJsonRootValue	date(java.lang.String format) Value that must match the provided date format
static PactDslJsonRootValue	date(java.lang.String format, java.util.Date example) Value that must match the provided date format
static PactDslJsonRootValue	dateExpression(java.lang.String expression) Date value generated from an expression.
static PactDslJsonRootValue	dateExpression(java.lang.String expression, java.lang.String format) Date value generated from an expression.
static PactDslJsonRootValue	datetimeExpression(java.lang.String expression) Datetime value generated from an expression.
static PactDslJsonRootValue	datetimeExpression(java.lang.String expression, java.lang.String format) Datetime value generated from an expression.
static PactDslJsonRootValue	decimalType() Value that must be a decimal value
static PactDslJsonRootValue	decimalType(java.math.BigDecimal number) Value that must be a decimalType value
static PactDslJsonRootValue	decimalType(java.lang.Double number) Value that must be a decimalType value
PactDslJsonArray	eachArrayLike() Deprecated. Use PactDslJsonArray for arrays
PactDslJsonArray	eachArrayLike(int numberExamples) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonArray	eachArrayLike(java.lang.String name) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonArray	eachArrayLike(java.lang.String name, int numberExamples) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonArray	eachArrayWithMaxLike(java.lang.Integer size) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonArray	eachArrayWithMaxLike(int numberExamples, java.lang.Integer size) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonArray	eachArrayWithMaxLike(java.lang.String name, java.lang.Integer size) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonArray	eachArrayWithMaxLike(java.lang.String name, int numberExamples, java.lang.Integer size) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonArray	eachArrayWithMinLike(java.lang.Integer size) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonArray	eachArrayWithMinLike(int numberExamples, java.lang.Integer size) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonArray	eachArrayWithMinLike(java.lang.String name, java.lang.Integer size) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonArray	eachArrayWithMinLike(java.lang.String name, int numberExamples, java.lang.Integer size) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonArray	eachArrayWithMinMaxLike(java.lang.Integer minSize, java.lang.Integer maxSize) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonArray	eachArrayWithMinMaxLike(int numberExamples, java.lang.Integer minSize, java.lang.Integer maxSize) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonArray	eachArrayWithMinMaxLike(java.lang.String name, java.lang.Integer minSize, java.lang.Integer maxSize) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonArray	eachArrayWithMinMaxLike(java.lang.String name, int numberExamples, java.lang.Integer minSize, java.lang.Integer maxSize) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonBody	eachLike() Deprecated. Use PactDslJsonArray for arrays
PactDslJsonArray	eachLike(DslPart object) Deprecated.
PactDslJsonBody	eachLike(int numberExamples) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonBody	eachLike(java.lang.String name) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonBody	eachLike(java.lang.String name, DslPart object) Deprecated.
PactDslJsonBody	eachLike(java.lang.String name, int numberExamples) Deprecated. Use PactDslJsonArray for arrays
java.lang.Object	getBody()
static PactDslJsonRootValue	hexValue() Value that must be encoded as a hexadecimal value
static PactDslJsonRootValue	hexValue(java.lang.String hexValue) Value that must be encoded as a hexadecimal value
static PactDslJsonRootValue	id() Value that must be a numeric identifier
static PactDslJsonRootValue	id(java.lang.Long id) Value that must be a numeric identifier
static PactDslJsonRootValue	integerType() Value that must be an integer
static PactDslJsonRootValue	integerType(java.lang.Integer number) Value that must be an integer
static PactDslJsonRootValue	integerType(java.lang.Long number) Value that must be an integer
static PactDslJsonRootValue	ipAddress() Value that must be an IP4 address
boolean	isEncodeJson() If the value should be encoded to be safe as JSON
PactDslJsonRootValue	matchUrl(java.lang.String basePath, java.lang.Object... pathFragments) Matches a URL that is composed of a base path and a sequence of path expressions
PactDslJsonBody	maxArrayLike(java.lang.Integer size) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonArray	maxArrayLike(java.lang.Integer size, DslPart object) Deprecated.
PactDslJsonBody	maxArrayLike(java.lang.Integer size, int numberExamples) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonBody	maxArrayLike(java.lang.String name, java.lang.Integer size) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonBody	maxArrayLike(java.lang.String name, java.lang.Integer size, DslPart object) Deprecated.
PactDslJsonBody	maxArrayLike(java.lang.String name, java.lang.Integer size, int numberExamples) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonBody	minArrayLike(java.lang.Integer size) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonArray	minArrayLike(java.lang.Integer size, DslPart object) Deprecated.
PactDslJsonBody	minArrayLike(java.lang.Integer size, int numberExamples) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonBody	minArrayLike(java.lang.String name, java.lang.Integer size) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonBody	minArrayLike(java.lang.String name, java.lang.Integer size, DslPart object) Deprecated.
PactDslJsonBody	minArrayLike(java.lang.String name, java.lang.Integer size, int numberExamples) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonBody	minMaxArrayLike(java.lang.Integer minSize, java.lang.Integer maxSize) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonArray	minMaxArrayLike(java.lang.Integer minSize, java.lang.Integer maxSize, DslPart object) Deprecated.
PactDslJsonBody	minMaxArrayLike(java.lang.Integer minSize, java.lang.Integer maxSize, int numberExamples) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonBody	minMaxArrayLike(java.lang.String name, java.lang.Integer minSize, java.lang.Integer maxSize) Deprecated. Use PactDslJsonArray for arrays
PactDslJsonBody	minMaxArrayLike(java.lang.String name, java.lang.Integer minSize, java.lang.Integer maxSize, DslPart object) Deprecated.
PactDslJsonBody	minMaxArrayLike(java.lang.String name, java.lang.Integer minSize, java.lang.Integer maxSize, int numberExamples) Deprecated. Use PactDslJsonArray for arrays
static PactDslJsonRootValue	numberType() Value that can be any number
static PactDslJsonRootValue	numberType(java.lang.Number number) Value that can be any number
PactDslJsonBody	object() Deprecated. Use PactDslJsonBody for objects
PactDslJsonBody	object(java.lang.String name) Deprecated. Use PactDslJsonBody for objects
static PactDslJsonRootValue	or(java.lang.Object example, au.com.dius.pact.core.model.matchingrules.MatchingRule... rules) Combine all the matchers using OR
protected void	putArray(DslPart object)
protected void	putObject(DslPart object)
void	setEncodeJson(boolean encodeJson) If the value should be encoded to be safe as JSON
void	setMatcher(au.com.dius.pact.core.model.matchingrules.MatchingRule matcher)
void	setValue(java.lang.Object value)
static PactDslJsonRootValue	stringMatcher(java.lang.String regex) Deprecated. Use the version that takes an example value
static PactDslJsonRootValue	stringMatcher(java.lang.String regex, java.lang.String value) Value that must match the regular expression
static PactDslJsonRootValue	stringType() Value that can be any string
static PactDslJsonRootValue	stringType(java.lang.String example) Value that can be any string
static PactDslJsonRootValue	time() Value that must be an ISO formatted time
static PactDslJsonRootValue	time(java.lang.String format) Value that must match the given time format
static PactDslJsonRootValue	time(java.lang.String format, java.util.Date example) Value that must match the given time format
static PactDslJsonRootValue	timeExpression(java.lang.String expression) Time value generated from an expression.
static PactDslJsonRootValue	timeExpression(java.lang.String expression, java.lang.String format) Time value generated from an expression.
static PactDslJsonRootValue	timestamp() Value that must be an ISO formatted timestamp
static PactDslJsonRootValue	timestamp(java.lang.String format) Value that must match the given timestamp format
static PactDslJsonRootValue	timestamp(java.lang.String format, java.util.Date example) Value that must match the given timestamp format
static PactDslJsonRootValue	uuid() Value that must be encoded as an UUID
static PactDslJsonRootValue	uuid(java.lang.String uuid) Value that must be encoded as an UUID
static PactDslJsonRootValue	uuid(java.util.UUID uuid) Value that must be encoded as an UUID
static PactDslJsonRootValue	valueFromProviderState(java.lang.String expression, java.lang.Object example) Adds a value that will have it's value injected from the provider state

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

asArray, asBody, getGenerators, getMatchers, getParent, includesMatcher, matchDate, matchMax, matchMin, matchMinMax, matchTime, matchTimestamp, regexp, setGenerators, setMatchers

Methods inherited from class java.lang.Object

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

Constructor Detail

PactDslJsonRootValue

public PactDslJsonRootValue()

Method Detail

putObject

protected void putObject(DslPart object)

Specified by:

putObject in class DslPart

putArray

protected void putArray(DslPart object)

Specified by:

putArray in class DslPart

getBody

public java.lang.Object getBody()

Specified by:

getBody in class DslPart

isEncodeJson

public boolean isEncodeJson()

If the value should be encoded to be safe as JSON

setEncodeJson

public void setEncodeJson(boolean encodeJson)

If the value should be encoded to be safe as JSON

array

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

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

Field which is an array

Specified by:

array in class DslPart

Parameters:

name - field name

array

@Deprecated
public PactDslJsonArray array()

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

Element as an array

Specified by:

array in class DslPart

closeArray

@Deprecated
public DslPart closeArray()

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

Close of the previous array element

Specified by:

closeArray in class DslPart

eachLike

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

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

Array field where each element must match the following object

Specified by:

eachLike in class DslPart

Parameters:

name - field name

eachLike

@Deprecated
public PactDslJsonBody eachLike(java.lang.String name,
                                            DslPart object)

Deprecated.

Description copied from class: DslPart

Array field where each element must match the following object

Specified by:

eachLike in class DslPart

Parameters:

name - field name

eachLike

@Deprecated
public PactDslJsonBody eachLike(int numberExamples)

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

eachLike in class DslPart

Parameters:

numberExamples - number of examples to generate

eachLike

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

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

Array field where each element must match the following object

Specified by:

eachLike in class DslPart

Parameters:

name - field name

numberExamples - number of examples to generate

eachLike

@Deprecated
public PactDslJsonBody eachLike()

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

eachLike in class DslPart

eachLike

@Deprecated
public PactDslJsonArray eachLike(DslPart object)

Deprecated.

Description copied from class: DslPart

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

Specified by:

eachLike in class DslPart

minArrayLike

@Deprecated
public PactDslJsonBody minArrayLike(java.lang.String name,
                                                java.lang.Integer size)

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

minArrayLike in class DslPart

Parameters:

name - field name

size - minimum size

minArrayLike

@Deprecated
public PactDslJsonBody minArrayLike(java.lang.Integer size)

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

minArrayLike in class DslPart

Parameters:

size - minimum size

minArrayLike

@Deprecated
public PactDslJsonBody minArrayLike(java.lang.String name,
                                                java.lang.Integer size,
                                                DslPart object)

Deprecated.

Description copied from class: DslPart

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

Specified by:

minArrayLike in class DslPart

Parameters:

name - field name

size - minimum size

minArrayLike

@Deprecated
public PactDslJsonArray minArrayLike(java.lang.Integer size,
                                                 DslPart object)

Deprecated.

Description copied from class: DslPart

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

Specified by:

minArrayLike in class DslPart

Parameters:

size - minimum size

minArrayLike

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

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

minArrayLike in class DslPart

Parameters:

name - field name

size - minimum size

numberExamples - number of examples to generate

minArrayLike

@Deprecated
public PactDslJsonBody minArrayLike(java.lang.Integer size,
                                                int numberExamples)

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

minArrayLike in class DslPart

Parameters:

size - minimum size

numberExamples - number of examples to generate

maxArrayLike

@Deprecated
public PactDslJsonBody maxArrayLike(java.lang.String name,
                                                java.lang.Integer size)

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

maxArrayLike in class DslPart

Parameters:

name - field name

size - maximum size

maxArrayLike

@Deprecated
public PactDslJsonBody maxArrayLike(java.lang.Integer size)

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

maxArrayLike in class DslPart

Parameters:

size - minimum size

maxArrayLike

@Deprecated
public PactDslJsonBody maxArrayLike(java.lang.String name,
                                                java.lang.Integer size,
                                                DslPart object)

Deprecated.

Description copied from class: DslPart

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

Specified by:

maxArrayLike in class DslPart

Parameters:

name - field name

size - maximum size

maxArrayLike

@Deprecated
public PactDslJsonArray maxArrayLike(java.lang.Integer size,
                                                 DslPart object)

Deprecated.

Description copied from class: DslPart

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

Specified by:

maxArrayLike in class DslPart

Parameters:

size - minimum size

maxArrayLike

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

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

maxArrayLike in class DslPart

Parameters:

name - field name

size - maximum size

numberExamples - number of examples to generate

maxArrayLike

@Deprecated
public PactDslJsonBody maxArrayLike(java.lang.Integer size,
                                                int numberExamples)

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

maxArrayLike in class DslPart

Parameters:

size - minimum size

numberExamples - number of examples to generate

minMaxArrayLike

@Deprecated
public PactDslJsonBody minMaxArrayLike(java.lang.String name,
                                                   java.lang.Integer minSize,
                                                   java.lang.Integer maxSize)

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

minMaxArrayLike in class DslPart

Parameters:

name - field name

minSize - minimum size

maxSize - maximum size

minMaxArrayLike

@Deprecated
public PactDslJsonBody minMaxArrayLike(java.lang.String name,
                                                   java.lang.Integer minSize,
                                                   java.lang.Integer maxSize,
                                                   DslPart object)

Deprecated.

Description copied from class: DslPart

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

Specified by:

minMaxArrayLike in class DslPart

Parameters:

name - field name

minSize - minimum size

maxSize - maximum size

minMaxArrayLike

@Deprecated
public PactDslJsonBody minMaxArrayLike(java.lang.Integer minSize,
                                                   java.lang.Integer maxSize)

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

minMaxArrayLike in class DslPart

Parameters:

minSize - minimum size

maxSize - maximum size

minMaxArrayLike

@Deprecated
public PactDslJsonArray minMaxArrayLike(java.lang.Integer minSize,
                                                    java.lang.Integer maxSize,
                                                    DslPart object)

Deprecated.

Description copied from class: DslPart

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

Specified by:

minMaxArrayLike in class DslPart

Parameters:

minSize - minimum size

maxSize - maximum size

minMaxArrayLike

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

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

minMaxArrayLike in class DslPart

Parameters:

name - field name

minSize - minimum size

maxSize - maximum size

numberExamples - number of examples to generate

minMaxArrayLike

@Deprecated
public PactDslJsonBody minMaxArrayLike(java.lang.Integer minSize,
                                                   java.lang.Integer maxSize,
                                                   int numberExamples)

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

minMaxArrayLike in class DslPart

Parameters:

minSize - minimum size

maxSize - maximum size

numberExamples - number of examples to generate

object

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

Deprecated. Use PactDslJsonBody for objects

Description copied from class: DslPart

Object field

Specified by:

object in class DslPart

Parameters:

name - field name

object

@Deprecated
public PactDslJsonBody object()

Deprecated. Use PactDslJsonBody for objects

Description copied from class: DslPart

Object element

Specified by:

object in class DslPart

closeObject

@Deprecated
public DslPart closeObject()

Deprecated. Use PactDslJsonBody for objects

Description copied from class: DslPart

Close off the previous object

Specified by:

closeObject in class DslPart

Returns:

close

public DslPart close()

Description copied from class: DslPart

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

Specified by:

close in class DslPart

Returns:

The root object of the object graph

stringType

public static PactDslJsonRootValue stringType()

Value that can be any string

stringType

public static PactDslJsonRootValue stringType(java.lang.String example)

Value that can be any string

Parameters:

example - example value to use for generated bodies

numberType

public static PactDslJsonRootValue numberType()

Value that can be any number

numberType

public static PactDslJsonRootValue numberType(java.lang.Number number)

Value that can be any number

Parameters:

number - example number to use for generated bodies

integerType

public static PactDslJsonRootValue integerType()

Value that must be an integer

integerType

public static PactDslJsonRootValue integerType(java.lang.Long number)

Value that must be an integer

Parameters:

number - example integer value to use for generated bodies

integerType

public static PactDslJsonRootValue integerType(java.lang.Integer number)

Value that must be an integer

Parameters:

number - example integer value to use for generated bodies

decimalType

public static PactDslJsonRootValue decimalType()

Value that must be a decimal value

decimalType

public static PactDslJsonRootValue decimalType(java.math.BigDecimal number)

Value that must be a decimalType value

Parameters:

number - example decimalType value

decimalType

public static PactDslJsonRootValue decimalType(java.lang.Double number)

Value that must be a decimalType value

Parameters:

number - example decimalType value

booleanType

public static PactDslJsonRootValue booleanType()

Value that must be a boolean

booleanType

public static PactDslJsonRootValue booleanType(java.lang.Boolean example)

Value that must be a boolean

Parameters:

example - example boolean to use for generated bodies

stringMatcher

public static PactDslJsonRootValue stringMatcher(java.lang.String regex,
                                                 java.lang.String value)

Value that must match the regular expression

Parameters:

regex - regular expression

value - example value to use for generated bodies

stringMatcher

@Deprecated
public static PactDslJsonRootValue stringMatcher(java.lang.String regex)

Deprecated. Use the version that takes an example value

Value that must match the regular expression

Parameters:

regex - regular expression

timestamp

public static PactDslJsonRootValue timestamp()

Value that must be an ISO formatted timestamp

timestamp

public static PactDslJsonRootValue timestamp(java.lang.String format)

Value that must match the given timestamp format

Parameters:

format - timestamp format

timestamp

public static PactDslJsonRootValue timestamp(java.lang.String format,
                                             java.util.Date example)

Value that must match the given timestamp format

Parameters:

format - timestamp format

example - example date and time to use for generated bodies

date

public static PactDslJsonRootValue date()

Value that must be formatted as an ISO date

date

public static PactDslJsonRootValue date(java.lang.String format)

Value that must match the provided date format

Parameters:

format - date format to match

date

public static PactDslJsonRootValue date(java.lang.String format,
                                        java.util.Date example)

Value that must match the provided date format

Parameters:

format - date format to match

example - example date to use for generated values

time

public static PactDslJsonRootValue time()

Value that must be an ISO formatted time

time

public static PactDslJsonRootValue time(java.lang.String format)

Value that must match the given time format

Parameters:

format - time format to match

time

public static PactDslJsonRootValue time(java.lang.String format,
                                        java.util.Date example)

Value that must match the given time format

Parameters:

format - time format to match

example - example time to use for generated bodies

ipAddress

public static PactDslJsonRootValue ipAddress()

Value that must be an IP4 address

id

public static PactDslJsonRootValue id()

Value that must be a numeric identifier

id

public static PactDslJsonRootValue id(java.lang.Long id)

Value that must be a numeric identifier

Parameters:

id - example id to use for generated bodies

hexValue

public static PactDslJsonRootValue hexValue()

Value that must be encoded as a hexadecimal value

hexValue

public static PactDslJsonRootValue hexValue(java.lang.String hexValue)

Value that must be encoded as a hexadecimal value

Parameters:

hexValue - example value to use for generated bodies

uuid

public static PactDslJsonRootValue uuid()

Value that must be encoded as an UUID

uuid

public static PactDslJsonRootValue uuid(java.util.UUID uuid)

Value that must be encoded as an UUID

Parameters:

uuid - example UUID to use for generated bodies

uuid

public static PactDslJsonRootValue uuid(java.lang.String uuid)

Value that must be encoded as an UUID

Parameters:

uuid - example UUID to use for generated bodies

setValue

public void setValue(java.lang.Object value)

setMatcher

public void setMatcher(au.com.dius.pact.core.model.matchingrules.MatchingRule matcher)

eachArrayLike

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

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

eachArrayLike in class DslPart

Parameters:

name - field name

eachArrayLike

@Deprecated
public PactDslJsonArray eachArrayLike(int numberExamples)

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

eachArrayLike in class DslPart

Parameters:

numberExamples - number of examples to generate

eachArrayWithMaxLike

@Deprecated
public PactDslJsonArray eachArrayWithMaxLike(java.lang.String name,
                                                         java.lang.Integer size)

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

eachArrayWithMaxLike in class DslPart

Parameters:

name - field name

size - Maximum size of the outer array

eachArrayWithMaxLike

@Deprecated
public PactDslJsonArray eachArrayWithMaxLike(java.lang.Integer size)

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

eachArrayWithMaxLike in class DslPart

Parameters:

size - Maximum size of the outer array

eachArrayWithMaxLike

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

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

eachArrayWithMaxLike in class DslPart

Parameters:

name - field name

numberExamples - number of examples to generate

size - Maximum size of the outer array

eachArrayWithMaxLike

@Deprecated
public PactDslJsonArray eachArrayWithMaxLike(int numberExamples,
                                                         java.lang.Integer size)

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

eachArrayWithMaxLike in class DslPart

Parameters:

numberExamples - number of examples to generate

size - Maximum size of the outer array

eachArrayWithMinLike

@Deprecated
public PactDslJsonArray eachArrayWithMinLike(java.lang.String name,
                                                         java.lang.Integer size)

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

eachArrayWithMinLike in class DslPart

Parameters:

name - field name

size - Minimum size of the outer array

eachArrayWithMinLike

@Deprecated
public PactDslJsonArray eachArrayWithMinLike(java.lang.Integer size)

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

eachArrayWithMinLike in class DslPart

Parameters:

size - Minimum size of the outer array

eachArrayWithMinLike

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

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

eachArrayWithMinLike in class DslPart

Parameters:

name - field name

numberExamples - number of examples to generate

size - Minimum size of the outer array

eachArrayWithMinLike

@Deprecated
public PactDslJsonArray eachArrayWithMinLike(int numberExamples,
                                                         java.lang.Integer size)

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

eachArrayWithMinLike in class DslPart

Parameters:

numberExamples - number of examples to generate

size - Minimum size of the outer array

eachArrayWithMinMaxLike

@Deprecated
public PactDslJsonArray eachArrayWithMinMaxLike(java.lang.String name,
                                                            java.lang.Integer minSize,
                                                            java.lang.Integer maxSize)

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

eachArrayWithMinMaxLike in class DslPart

Parameters:

name - field name

minSize - minimum size

maxSize - maximum size

eachArrayWithMinMaxLike

@Deprecated
public PactDslJsonArray eachArrayWithMinMaxLike(java.lang.Integer minSize,
                                                            java.lang.Integer maxSize)

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

eachArrayWithMinMaxLike in class DslPart

Parameters:

minSize - minimum size

maxSize - maximum size

eachArrayWithMinMaxLike

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

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

eachArrayWithMinMaxLike in class DslPart

Parameters:

name - field name

numberExamples - number of examples to generate

minSize - minimum size

maxSize - maximum size

eachArrayWithMinMaxLike

@Deprecated
public PactDslJsonArray eachArrayWithMinMaxLike(int numberExamples,
                                                            java.lang.Integer minSize,
                                                            java.lang.Integer maxSize)

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

eachArrayWithMinMaxLike in class DslPart

Parameters:

numberExamples - number of examples to generate

minSize - minimum size

maxSize - maximum size

eachArrayLike

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

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

eachArrayLike in class DslPart

Parameters:

name - field name

numberExamples - number of examples to generate

eachArrayLike

@Deprecated
public PactDslJsonArray eachArrayLike()

Deprecated. Use PactDslJsonArray for arrays

Description copied from class: DslPart

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

Specified by:

eachArrayLike in class DslPart

and

public static PactDslJsonRootValue and(java.lang.Object example,
                                       au.com.dius.pact.core.model.matchingrules.MatchingRule... rules)

Combine all the matchers using AND

Parameters:

example - Attribute example value

rules - Matching rules to apply

or

public static PactDslJsonRootValue or(java.lang.Object example,
                                      au.com.dius.pact.core.model.matchingrules.MatchingRule... rules)

Combine all the matchers using OR

Parameters:

example - Attribute name

rules - Matching rules to apply

matchUrl

public PactDslJsonRootValue matchUrl(java.lang.String basePath,
                                     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.

valueFromProviderState

public static PactDslJsonRootValue valueFromProviderState(java.lang.String expression,
                                                          java.lang.Object example)

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

Parameters:

expression - Expression to be evaluated from the provider state

example - Example value to be used in the consumer test

dateExpression

public static PactDslJsonRootValue dateExpression(java.lang.String expression)

Date value generated from an expression. The date will be formatted as an ISO date.

Parameters:

expression - Date expression

dateExpression

public static PactDslJsonRootValue dateExpression(java.lang.String expression,
                                                  java.lang.String format)

Date value generated from an expression.

Parameters:

expression - Date expression

format - Date format to use

timeExpression

public static PactDslJsonRootValue timeExpression(java.lang.String expression)

Time value generated from an expression. The time will be formatted as an ISO time.

Parameters:

expression - Date expression

timeExpression

public static PactDslJsonRootValue timeExpression(java.lang.String expression,
                                                  java.lang.String format)

Time value generated from an expression.

Parameters:

expression - Time expression

format - Time format to use

datetimeExpression

public static PactDslJsonRootValue datetimeExpression(java.lang.String expression)

Datetime value generated from an expression. The datetime will be formatted as an ISO datetime.

Parameters:

expression - Datetime expression

datetimeExpression

public static PactDslJsonRootValue datetimeExpression(java.lang.String expression,
                                                      java.lang.String format)

Datetime value generated from an expression.

Parameters:

expression - Datetime expression

format - Datetime format to use