io.pactfoundation.consumer.dsl

Class LambdaDslObject

io.pactfoundation.consumer.dsl.LambdaDslObject

Direct Known Subclasses:

LambdaDslJsonBody

public class LambdaDslObject

Method Detail

getPactDslObject

public au.com.dius.pact.consumer.dsl.PactDslJsonBody getPactDslObject()

stringValue

public LambdaDslObject stringValue(java.lang.String name,
                                   java.lang.String value)

stringType

public LambdaDslObject stringType(java.lang.String name,
                                  java.lang.String example)

stringType

public LambdaDslObject stringType(java.lang.String name)

stringType

public LambdaDslObject stringType(java.lang.String... names)

stringMatcher

public LambdaDslObject stringMatcher(java.lang.String name,
                                     java.lang.String example)

stringMatcher

public LambdaDslObject stringMatcher(java.lang.String name,
                                     java.lang.String regex,
                                     java.lang.String value)

numberValue

public LambdaDslObject numberValue(java.lang.String name,
                                   java.lang.Number value)

numberType

public LambdaDslObject numberType(java.lang.String name,
                                  java.lang.Number example)

numberType

public LambdaDslObject numberType(java.lang.String... names)

decimalType

public LambdaDslObject decimalType(java.lang.String name,
                                   java.math.BigDecimal value)

decimalType

public LambdaDslObject decimalType(java.lang.String name,
                                   java.lang.Double example)

decimalType

public LambdaDslObject decimalType(java.lang.String... names)

booleanValue

public LambdaDslObject booleanValue(java.lang.String name,
                                    java.lang.Boolean value)

booleanType

public LambdaDslObject booleanType(java.lang.String name,
                                   java.lang.Boolean example)

booleanType

public LambdaDslObject booleanType(java.lang.String... names)

id

public LambdaDslObject id()

id

public LambdaDslObject id(java.lang.String name)

id

public LambdaDslObject id(java.lang.String name,
                          java.lang.Long id)

uuid

public LambdaDslObject uuid(java.lang.String name)

uuid

public LambdaDslObject uuid(java.lang.String name,
                            java.util.UUID id)

date

public LambdaDslObject date()

Attribute named 'date' that must be formatted as an ISO date

date

public LambdaDslObject date(java.lang.String name)

Attribute that must be formatted as an ISO date

Parameters:

name - attribute name

date

public LambdaDslObject date(java.lang.String name,
                            java.lang.String format)

Attribute that must match the provided date format

Parameters:

name - attribute date

format - date format to match

date

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

Attribute that must match the provided date format

Parameters:

name - attribute date

format - date format to match

example - example date to use for generated values

date

public LambdaDslObject date(java.lang.String name,
                            java.lang.String format,
                            java.util.Date example,
                            java.util.TimeZone timeZone)

Attribute that must match the provided date format

Parameters:

name - attribute date

format - date format to match

example - example date to use for generated values

timeZone - time zone used for formatting of example date

date

public LambdaDslObject date(java.lang.String name,
                            java.lang.String format,
                            java.time.ZonedDateTime 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

public LambdaDslObject time()

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

time

public LambdaDslObject time(java.lang.String name)

Attribute that must be an ISO formatted time

Parameters:

name - attribute name

time

public LambdaDslObject time(java.lang.String name,
                            java.lang.String format)

Attribute that must match the provided time format

Parameters:

name - attribute time

format - time format to match

time

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

Attribute that must match the provided time format

Parameters:

name - attribute name

format - time format to match

example - example time to use for generated values

time

public LambdaDslObject time(java.lang.String name,
                            java.lang.String format,
                            java.util.Date example,
                            java.util.TimeZone timeZone)

Attribute that must match the provided time format

Parameters:

name - attribute name

format - time format to match

example - example time to use for generated values

timeZone - time zone used for formatting of example time

time

public LambdaDslObject time(java.lang.String name,
                            java.lang.String format,
                            java.time.ZonedDateTime example)

Attribute that must match the provided time format

Parameters:

name - attribute name

format - time format to match

example - example time to use for generated values

timestamp

public LambdaDslObject timestamp()

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

timestamp

public LambdaDslObject timestamp(java.lang.String name)

Attribute that must be an ISO formatted timestamp

Parameters:

name - attribute name

timestamp

public LambdaDslObject timestamp(java.lang.String name,
                                 java.lang.String format)

Attribute that must match the given timestamp format

Parameters:

name - attribute name

format - timestamp format

timestamp

public LambdaDslObject timestamp(java.lang.String name,
                                 java.lang.String format,
                                 java.util.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

public LambdaDslObject timestamp(java.lang.String name,
                                 java.lang.String format,
                                 java.time.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

public LambdaDslObject timestamp(java.lang.String name,
                                 java.lang.String format,
                                 java.util.Date example,
                                 java.util.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

public LambdaDslObject timestamp(java.lang.String name,
                                 java.lang.String format,
                                 java.time.ZonedDateTime 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

ipV4Address

public LambdaDslObject ipV4Address(java.lang.String name)

Attribute that must be an IP4 address

Parameters:

name - attribute name

and

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

Combine all the matchers using AND

Parameters:

name - Attribute name

value - Attribute example value

rules - Matching rules to apply

Returns:

org.jetbrains.dokka.NodeRenderContent@346430a:

or

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

Combine all the matchers using OR

Parameters:

name - Attribute name

value - Attribute example value

rules - Matching rules to apply

Returns:

org.jetbrains.dokka.NodeRenderContent@70875e23:

array

public LambdaDslObject array(java.lang.String name,
                             java.util.function.Consumer<io.pactfoundation.consumer.dsl.LambdaDslJsonArray> array)

object

public LambdaDslObject object(java.lang.String name,
                              java.util.function.Consumer<io.pactfoundation.consumer.dsl.LambdaDslObject> nestedObject)

eachLike

public LambdaDslObject eachLike(java.lang.String name,
                                java.util.function.Consumer<io.pactfoundation.consumer.dsl.LambdaDslObject> nestedObject)

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

Parameters:

name - field name

eachLike

public LambdaDslObject eachLike(java.lang.String name,
                                int numberExamples,
                                java.util.function.Consumer<io.pactfoundation.consumer.dsl.LambdaDslObject> nestedObject)

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

Parameters:

name - field name

numberExamples - number of examples to generate

eachLike

public LambdaDslObject eachLike(java.lang.String name,
                                au.com.dius.pact.consumer.dsl.PactDslJsonRootValue value)

Attribute that is an array where each item is a primitive that must match the provided value

Parameters:

name - field name

value - Value that each item in the array must match

eachLike

public LambdaDslObject eachLike(java.lang.String name,
                                au.com.dius.pact.consumer.dsl.PactDslJsonRootValue value,
                                int numberExamples)

Attribute that is an array where each item is a primitive that must match the provided value

Parameters:

name - field name

value - Value that each item in the array must match

numberExamples - Number of examples to generate

minArrayLike

public LambdaDslObject minArrayLike(java.lang.String name,
                                    java.lang.Integer size,
                                    java.util.function.Consumer<io.pactfoundation.consumer.dsl.LambdaDslObject> nestedObject)

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

public LambdaDslObject minArrayLike(java.lang.String name,
                                    java.lang.Integer size,
                                    int numberExamples,
                                    java.util.function.Consumer<io.pactfoundation.consumer.dsl.LambdaDslObject> nestedObject)

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

public LambdaDslObject minArrayLike(java.lang.String name,
                                    java.lang.Integer size,
                                    au.com.dius.pact.consumer.dsl.PactDslJsonRootValue value,
                                    int numberExamples)

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

Parameters:

name - field name

size - minimum size of the array

value - Value to use to match each item

numberExamples - number of examples to generate

maxArrayLike

public LambdaDslObject maxArrayLike(java.lang.String name,
                                    java.lang.Integer size,
                                    java.util.function.Consumer<io.pactfoundation.consumer.dsl.LambdaDslObject> nestedObject)

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

public LambdaDslObject maxArrayLike(java.lang.String name,
                                    java.lang.Integer size,
                                    int numberExamples,
                                    java.util.function.Consumer<io.pactfoundation.consumer.dsl.LambdaDslObject> nestedObject)

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

public LambdaDslObject maxArrayLike(java.lang.String name,
                                    java.lang.Integer size,
                                    au.com.dius.pact.consumer.dsl.PactDslJsonRootValue value,
                                    int numberExamples)

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

Parameters:

name - field name

size - maximum size of the array

value - Value to use to match each item

numberExamples - number of examples to generate

minMaxArrayLike

public LambdaDslObject minMaxArrayLike(java.lang.String name,
                                       java.lang.Integer minSize,
                                       java.lang.Integer maxSize,
                                       java.util.function.Consumer<io.pactfoundation.consumer.dsl.LambdaDslObject> nestedObject)

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

Parameters:

name - field name

minSize - minimum size of the array

maxSize - maximum size of the array

minMaxArrayLike

public LambdaDslObject minMaxArrayLike(java.lang.String name,
                                       java.lang.Integer minSize,
                                       java.lang.Integer maxSize,
                                       int numberExamples,
                                       java.util.function.Consumer<io.pactfoundation.consumer.dsl.LambdaDslObject> nestedObject)

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

Parameters:

name - field name

minSize - minimum size of the array

maxSize - maximum size of the array

numberExamples - number of examples to generate

minMaxArrayLike

public LambdaDslObject minMaxArrayLike(java.lang.String name,
                                       java.lang.Integer minSize,
                                       java.lang.Integer maxSize,
                                       au.com.dius.pact.consumer.dsl.PactDslJsonRootValue value,
                                       int numberExamples)

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

Parameters:

name - field name

minSize - minimum size of the array

maxSize - maximum size of the array

value - Value to use to match each item

numberExamples - number of examples to generate

nullValue

public LambdaDslObject nullValue(java.lang.String fieldName)

Sets the field to a null value

Parameters:

fieldName - field name

eachArrayLike

public LambdaDslObject eachArrayLike(java.lang.String name,
                                     java.util.function.Consumer<io.pactfoundation.consumer.dsl.LambdaDslJsonArray> nestedArray)

eachArrayLike

public LambdaDslObject eachArrayLike(java.lang.String name,
                                     int numberExamples,
                                     java.util.function.Consumer<io.pactfoundation.consumer.dsl.LambdaDslJsonArray> nestedArray)

eachArrayWithMaxLike

public LambdaDslObject eachArrayWithMaxLike(java.lang.String name,
                                            java.lang.Integer size,
                                            java.util.function.Consumer<io.pactfoundation.consumer.dsl.LambdaDslJsonArray> nestedArray)

eachArrayWithMaxLike

public LambdaDslObject eachArrayWithMaxLike(java.lang.String name,
                                            int numberExamples,
                                            java.lang.Integer size,
                                            java.util.function.Consumer<io.pactfoundation.consumer.dsl.LambdaDslJsonArray> nestedArray)

eachArrayWithMinLike

public LambdaDslObject eachArrayWithMinLike(java.lang.String name,
                                            java.lang.Integer size,
                                            java.util.function.Consumer<io.pactfoundation.consumer.dsl.LambdaDslJsonArray> nestedArray)

eachArrayWithMinLike

public LambdaDslObject eachArrayWithMinLike(java.lang.String name,
                                            int numberExamples,
                                            java.lang.Integer size,
                                            java.util.function.Consumer<io.pactfoundation.consumer.dsl.LambdaDslJsonArray> nestedArray)

eachArrayWithMinMaxLike

public LambdaDslObject eachArrayWithMinMaxLike(java.lang.String name,
                                               java.lang.Integer minSize,
                                               java.lang.Integer maxSize,
                                               java.util.function.Consumer<io.pactfoundation.consumer.dsl.LambdaDslJsonArray> nestedArray)

eachArrayWithMinMaxLike

public LambdaDslObject eachArrayWithMinMaxLike(java.lang.String name,
                                               java.lang.Integer minSize,
                                               java.lang.Integer maxSize,
                                               int numberExamples,
                                               java.util.function.Consumer<io.pactfoundation.consumer.dsl.LambdaDslJsonArray> nestedArray)

eachKeyMappedToAnArrayLike

public LambdaDslObject eachKeyMappedToAnArrayLike(java.lang.String exampleKey,
                                                  java.util.function.Consumer<io.pactfoundation.consumer.dsl.LambdaDslObject> nestedObject)

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

Parameters:

exampleKey - Example key to use for generating bodies

eachKeyLike

public LambdaDslObject eachKeyLike(java.lang.String exampleKey,
                                   java.util.function.Consumer<io.pactfoundation.consumer.dsl.LambdaDslObject> nestedObject)

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

Parameters:

exampleKey - Example key to use for generating bodies

eachKeyLike

public LambdaDslObject eachKeyLike(java.lang.String exampleKey,
                                   au.com.dius.pact.consumer.dsl.PactDslJsonRootValue value)

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

Parameters:

exampleKey - Example key to use for generating bodies

value - Value to use for matching and generated bodies

dateExpression

public LambdaDslObject dateExpression(java.lang.String name,
                                      java.lang.String expression)

Attribute whose values are generated from the provided expression. Will use an ISO format.

Parameters:

name - Attribute name

expression - Date expression

dateExpression

public LambdaDslObject dateExpression(java.lang.String name,
                                      java.lang.String expression,
                                      java.lang.String format)

Attribute whose values are generated from the provided expression

Parameters:

name - Attribute name

expression - Date expression

format - Date format to use for values

timeExpression

public LambdaDslObject timeExpression(java.lang.String name,
                                      java.lang.String expression)

Attribute whose values are generated from the provided expression. Will use an ISO format.

Parameters:

name - Attribute name

expression - Time expression

timeExpression

public LambdaDslObject timeExpression(java.lang.String name,
                                      java.lang.String expression,
                                      java.lang.String format)

Attribute whose values are generated from the provided expression

Parameters:

name - Attribute name

expression - Time expression

format - Time format to use for values

datetimeExpression

public LambdaDslObject datetimeExpression(java.lang.String name,
                                          java.lang.String expression)

Attribute whose values are generated from the provided expression. Will use an ISO format.

Parameters:

name - Attribute name

expression - Datetime expression

datetimeExpression

public LambdaDslObject datetimeExpression(java.lang.String name,
                                          java.lang.String expression,
                                          java.lang.String format)

Attribute whose values are generated from the provided expression

Parameters:

name - Attribute name

expression - Datetime expression

format - Datetime format to use for values