au.com.dius.pact.consumer.dsl

Class PactDslJsonArray

DslPart

au.com.dius.pact.consumer.dsl.PactDslJsonArray

public class PactDslJsonArray
extends DslPart

DSL to define a JSON array

Constructor Detail

PactDslJsonArray

public PactDslJsonArray()

Construct a root level array

PactDslJsonArray

public PactDslJsonArray(java.lang.String rootPath,
                        java.lang.String rootName,
                        DslPart parent)

Construct an array as a child

Parameters:

rootPath - Path to the child array

rootName - Name to associate the child as

parent - Parent to attach the child to

PactDslJsonArray

public PactDslJsonArray(java.lang.String rootPath,
                        java.lang.String rootName,
                        DslPart parent,
                        PactDslJsonArray array)

Construct an array as a child copied from an existing array

Parameters:

rootPath - Path to the child array

rootName - Name to associate the child as

parent - Parent to attach the child to

array - Array to copy

PactDslJsonArray

public PactDslJsonArray(java.lang.String rootPath,
                        java.lang.String rootName,
                        DslPart parent,
                        boolean wildCard)

Construct a array as a child

Parameters:

rootPath - Path to the child array

rootName - Name to associate the child as

parent - Parent to attach the child to

wildCard - If it should be matched as a wild card

Method Detail

closeArray

public DslPart closeArray()

Closes the current array

eachLike

public PactDslJsonBody eachLike(java.lang.String name)

eachLike

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

eachLike

public PactDslJsonBody eachLike()

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

eachLike

public PactDslJsonBody eachLike(int numberExamples)

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

Parameters:

numberExamples - Number of examples to generate

minArrayLike

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

minArrayLike

public PactDslJsonBody minArrayLike(java.lang.Integer size)

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

Parameters:

size - minimum size of the array

minArrayLike

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

minArrayLike

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

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

Parameters:

size - minimum size of the array

numberExamples - number of examples to generate

maxArrayLike

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

maxArrayLike

public PactDslJsonBody maxArrayLike(java.lang.Integer size)

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

Parameters:

size - maximum size of the array

maxArrayLike

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

maxArrayLike

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

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

Parameters:

size - maximum size of the array

numberExamples - number of examples to generate

putObject

protected void putObject(DslPart object)

putArray

protected void putArray(DslPart object)

getBody

public java.lang.Object getBody()

stringValue

public PactDslJsonArray stringValue(java.lang.String value)

Element that must be the specified value

Parameters:

value - string value

string

public PactDslJsonArray string(java.lang.String value)

Element that must be the specified value

Parameters:

value - string value

numberValue

public PactDslJsonArray numberValue(java.lang.Number value)

number

public PactDslJsonArray number(java.lang.Number value)

Element that must be the specified value

Parameters:

value - number value

booleanValue

public PactDslJsonArray booleanValue(java.lang.Boolean value)

Element that must be the specified value

Parameters:

value - boolean value

stringType

public PactDslJsonArray stringType()

Element that can be any string

stringType

public PactDslJsonArray stringType(java.lang.String example)

Element that can be any string

Parameters:

example - example value to use for generated bodies

numberType

public PactDslJsonArray numberType()

Element that can be any number

numberType

public PactDslJsonArray numberType(java.lang.Number number)

Element that can be any number

Parameters:

number - example number to use for generated bodies

integerType

public PactDslJsonArray integerType()

Element that must be an integer

integerType

public PactDslJsonArray integerType(java.lang.Long number)

Element that must be an integer

Parameters:

number - example integer value to use for generated bodies

decimalType

public PactDslJsonArray decimalType()

Element that must be a decimal value

decimalType

public PactDslJsonArray decimalType(java.math.BigDecimal number)

Element that must be a decimalType value

Parameters:

number - example decimalType value

decimalType

public PactDslJsonArray decimalType(java.lang.Double number)

Attribute that must be a decimalType value

Parameters:

number - example decimalType value

booleanType

public PactDslJsonArray booleanType()

Element that must be a boolean

booleanType

public PactDslJsonArray booleanType(java.lang.Boolean example)

Element that must be a boolean

Parameters:

example - example boolean to use for generated bodies

stringMatcher

public PactDslJsonArray stringMatcher(java.lang.String regex,
                                      java.lang.String value)

Element that must match the regular expression

Parameters:

regex - regular expression

value - example value to use for generated bodies

timestamp

public PactDslJsonArray timestamp()

Element that must be an ISO formatted timestamp

timestamp

public PactDslJsonArray timestamp(java.lang.String format)

Element that must match the given timestamp format

Parameters:

format - timestamp format

timestamp

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

Element that must match the given timestamp format

Parameters:

format - timestamp format

example - example date and time to use for generated bodies

timestamp

public PactDslJsonArray timestamp(java.lang.String format,
                                  java.time.Instant example)

Element that must match the given timestamp format

Parameters:

format - timestamp format

example - example date and time to use for generated bodies

date

public PactDslJsonArray date()

Element that must be formatted as an ISO date

date

public PactDslJsonArray date(java.lang.String format)

Element that must match the provided date format

Parameters:

format - date format to match

date

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

Element that must match the provided date format

Parameters:

format - date format to match

example - example date to use for generated values

time

public PactDslJsonArray time()

Element that must be an ISO formatted time

time

public PactDslJsonArray time(java.lang.String format)

Element that must match the given time format

Parameters:

format - time format to match

time

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

Element that must match the given time format

Parameters:

format - time format to match

example - example time to use for generated bodies

ipAddress

public PactDslJsonArray ipAddress()

Element that must be an IP4 address

object

public PactDslJsonBody object(java.lang.String name)

object

public PactDslJsonBody object()

Element that is a JSON object

closeObject

public DslPart closeObject()

close

public DslPart close()

array

public PactDslJsonArray array(java.lang.String name)

array

public PactDslJsonArray array()

Element that is a JSON array

id

public PactDslJsonArray id()

Element that must be a numeric identifier

id

public PactDslJsonArray id(java.lang.Long id)

Element that must be a numeric identifier

Parameters:

id - example id to use for generated bodies

hexValue

public PactDslJsonArray hexValue()

Element that must be encoded as a hexadecimal value

hexValue

public PactDslJsonArray hexValue(java.lang.String hexValue)

Element that must be encoded as a hexadecimal value

Parameters:

hexValue - example value to use for generated bodies

uuid

public PactDslJsonArray uuid()

Element that must be encoded as an UUID

uuid

public PactDslJsonArray uuid(java.lang.String uuid)

Element that must be encoded as an UUID

Parameters:

uuid - example UUID to use for generated bodies

template

public PactDslJsonArray template(DslPart template)

Adds the template object to the array

Parameters:

template - template object

template

public PactDslJsonArray template(DslPart template,
                                 int occurrences)

Adds a number of template objects to the array

Parameters:

template - template object

occurrences - number to add

toString

public java.lang.String toString()

arrayEachLike

public static PactDslJsonBody arrayEachLike()

Array where each item must match the following example

arrayEachLike

public static PactDslJsonBody arrayEachLike(java.lang.Integer numberExamples)

Array where each item must match the following example

Parameters:

numberExamples - Number of examples to generate

arrayEachLike

public static PactDslJsonArray arrayEachLike(PactDslJsonRootValue rootValue)

Root level array where each item must match the provided matcher

arrayEachLike

public static PactDslJsonArray arrayEachLike(java.lang.Integer numberExamples,
                                             PactDslJsonRootValue value)

Root level array where each item must match the provided matcher

Parameters:

numberExamples - Number of examples to generate

arrayMinLike

public static PactDslJsonBody arrayMinLike(int minSize)

Array with a minimum size where each item must match the following example

Parameters:

minSize - minimum size

arrayMinLike

public static PactDslJsonBody arrayMinLike(int minSize,
                                           int numberExamples)

Array with a minimum size where each item must match the following example

Parameters:

minSize - minimum size

numberExamples - Number of examples to generate

arrayMinLike

public static PactDslJsonArray arrayMinLike(int minSize,
                                            PactDslJsonRootValue value)

Root level array with minimum size where each item must match the provided matcher

Parameters:

minSize - minimum size

arrayMinLike

public static PactDslJsonArray arrayMinLike(int minSize,
                                            int numberExamples,
                                            PactDslJsonRootValue value)

Root level array with minimum size where each item must match the provided matcher

Parameters:

minSize - minimum size

numberExamples - Number of examples to generate

arrayMaxLike

public static PactDslJsonBody arrayMaxLike(int maxSize)

Array with a maximum size where each item must match the following example

Parameters:

maxSize - maximum size

arrayMaxLike

public static PactDslJsonBody arrayMaxLike(int maxSize,
                                           int numberExamples)

Array with a maximum size where each item must match the following example

Parameters:

maxSize - maximum size

numberExamples - Number of examples to generate

arrayMaxLike

public static PactDslJsonArray arrayMaxLike(int maxSize,
                                            PactDslJsonRootValue value)

Root level array with maximum size where each item must match the provided matcher

Parameters:

maxSize - maximum size

arrayMaxLike

public static PactDslJsonArray arrayMaxLike(int maxSize,
                                            int numberExamples,
                                            PactDslJsonRootValue value)

Root level array with maximum size where each item must match the provided matcher

Parameters:

maxSize - maximum size

numberExamples - Number of examples to generate

arrayMinMaxLike

public static PactDslJsonBody arrayMinMaxLike(int minSize,
                                              int maxSize)

Array with a minimum and maximum size where each item must match the following example

Parameters:

minSize - minimum size

maxSize - maximum size

arrayMinMaxLike

public static PactDslJsonBody arrayMinMaxLike(int minSize,
                                              int maxSize,
                                              int numberExamples)

Array with a minimum and maximum size where each item must match the following example

Parameters:

minSize - minimum size

maxSize - maximum size

numberExamples - Number of examples to generate

arrayMinMaxLike

public static PactDslJsonArray arrayMinMaxLike(int minSize,
                                               int maxSize,
                                               PactDslJsonRootValue value)

Root level array with minimum and maximum size where each item must match the provided matcher

Parameters:

minSize - minimum size

maxSize - maximum size

arrayMinMaxLike

public static PactDslJsonArray arrayMinMaxLike(int minSize,
                                               int maxSize,
                                               int numberExamples,
                                               PactDslJsonRootValue value)

Root level array with minimum and maximum size where each item must match the provided matcher

Parameters:

minSize - minimum size

maxSize - maximum size

numberExamples - Number of examples to generate

nullValue

public PactDslJsonArray nullValue()

Adds a null value to the list

getNumberExamples

public int getNumberExamples()

Returns the number of example elements to generate for sample bodies

setNumberExamples

public void setNumberExamples(int numberExamples)

Sets the number of example elements to generate for sample bodies

eachArrayLike

public PactDslJsonArray eachArrayLike(java.lang.String name)

eachArrayLike

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

eachArrayLike

public PactDslJsonArray eachArrayLike()

eachArrayLike

public PactDslJsonArray eachArrayLike(int numberExamples)

eachArrayWithMaxLike

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

eachArrayWithMaxLike

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

eachArrayWithMaxLike

public PactDslJsonArray eachArrayWithMaxLike(java.lang.Integer size)

eachArrayWithMaxLike

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

eachArrayWithMinLike

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

eachArrayWithMinLike

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

eachArrayWithMinLike

public PactDslJsonArray eachArrayWithMinLike(java.lang.Integer size)

eachArrayWithMinLike

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

eachLike

public PactDslJsonArray eachLike(PactDslJsonRootValue value)

Array of values that are not objects where each item must match the provided example

Parameters:

value - Value to use to match each item

eachLike

public PactDslJsonArray eachLike(PactDslJsonRootValue value,
                                 int numberExamples)

Array of values that are not objects where each item must match the provided example

Parameters:

value - Value to use to match each item

numberExamples - number of examples to generate

minArrayLike

public PactDslJsonArray minArrayLike(java.lang.Integer size,
                                     PactDslJsonRootValue value)

Array of values with a minimum size that are not objects where each item must match the provided example

Parameters:

size - minimum size of the array

value - Value to use to match each item

minArrayLike

public PactDslJsonArray minArrayLike(java.lang.Integer size,
                                     PactDslJsonRootValue value,
                                     int numberExamples)

Array of values with a minimum size that are not objects where each item must match the provided example

Parameters:

size - minimum size of the array

value - Value to use to match each item

numberExamples - number of examples to generate

maxArrayLike

public PactDslJsonArray maxArrayLike(java.lang.Integer size,
                                     PactDslJsonRootValue value)

Array of values with a maximum size that are not objects where each item must match the provided example

Parameters:

size - maximum size of the array

value - Value to use to match each item

maxArrayLike

public PactDslJsonArray maxArrayLike(java.lang.Integer size,
                                     PactDslJsonRootValue value,
                                     int numberExamples)

Array of values with a maximum size that are not objects where each item must match the provided example

Parameters:

size - maximum size of the array

value - Value to use to match each item

numberExamples - number of examples to generate

includesStr

public PactDslJsonArray includesStr(java.lang.String value)

List item that must include the provided string

Parameters:

value - Value that must be included

equalsTo

public PactDslJsonArray equalsTo(java.lang.Object value)

Attribute that must be equal to the provided value.

Parameters:

value - Value that will be used for comparisons

and

public PactDslJsonArray and(java.lang.Object value,
                            au.com.dius.pact.core.model.matchingrules.MatchingRule... rules)

Combine all the matchers using AND

Parameters:

value - Attribute example value

rules - Matching rules to apply

or

public PactDslJsonArray or(java.lang.Object value,
                           au.com.dius.pact.core.model.matchingrules.MatchingRule... rules)

Combine all the matchers using OR

Parameters:

value - Attribute example value

rules - Matching rules to apply

matchUrl

public PactDslJsonArray 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.

minMaxArrayLike

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

minMaxArrayLike

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

minMaxArrayLike

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

minMaxArrayLike

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

eachArrayWithMinMaxLike

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

eachArrayWithMinMaxLike

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

eachArrayWithMinMaxLike

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

eachArrayWithMinMaxLike

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

valueFromProviderState

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

Adds an element 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 PactDslJsonArray dateExpression(java.lang.String expression)

Adds a date value formatted as an ISO date with the value generated by the date expression

Parameters:

expression - Date expression to use to generate the values

dateExpression

public PactDslJsonArray dateExpression(java.lang.String expression,
                                       java.lang.String format)

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

Parameters:

expression - Date expression to use to generate the values

format - Date format to use

timeExpression

public PactDslJsonArray timeExpression(java.lang.String expression)

Adds a time value formatted as an ISO time with the value generated by the time expression

Parameters:

expression - Time expression to use to generate the values

timeExpression

public PactDslJsonArray timeExpression(java.lang.String expression,
                                       java.lang.String format)

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

Parameters:

expression - Time expression to use to generate the values

format - Time format to use

datetimeExpression

public PactDslJsonArray datetimeExpression(java.lang.String expression)

Adds a datetime value formatted as an ISO datetime with the value generated by the expression

Parameters:

expression - Datetime expression to use to generate the values

datetimeExpression

public PactDslJsonArray datetimeExpression(java.lang.String expression,
                                           java.lang.String format)

Adds a datetime value with the value generated by the expression

Parameters:

expression - Datetime expression to use to generate the values

format - Datetime format to use