au.com.dius.pact.consumer.dsl

Class PactDslJsonRootValue

DslPart

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

public class PactDslJsonRootValue
extends DslPart

Constructor Detail

PactDslJsonRootValue

public PactDslJsonRootValue()

Method Detail

putObject

protected void putObject(DslPart object)

putArray

protected void putArray(DslPart object)

getBody

public java.lang.Object getBody()

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

public PactDslJsonArray array(java.lang.String name)

Parameters:

name - field name

array

public PactDslJsonArray array()

closeArray

public DslPart closeArray()

eachLike

public PactDslJsonBody eachLike(java.lang.String name)

Parameters:

name - field name

eachLike

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

Deprecated.

eachLike

public PactDslJsonBody eachLike(int numberExamples)

Parameters:

numberExamples - number of examples to generate

eachLike

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

Parameters:

name - field name

numberExamples - number of examples to generate

eachLike

public PactDslJsonBody eachLike()

eachLike

public PactDslJsonArray eachLike(DslPart object)

Deprecated.

minArrayLike

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

Parameters:

name - field name

size - minimum size

minArrayLike

public PactDslJsonBody minArrayLike(java.lang.Integer size)

Parameters:

size - minimum size

minArrayLike

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

Deprecated.

minArrayLike

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

Deprecated.

minArrayLike

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

Parameters:

name - field name

size - minimum size

numberExamples - number of examples to generate

minArrayLike

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

Parameters:

size - minimum size

numberExamples - number of examples to generate

maxArrayLike

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

Parameters:

name - field name

size - maximum size

maxArrayLike

public PactDslJsonBody maxArrayLike(java.lang.Integer size)

Parameters:

size - minimum size

maxArrayLike

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

Deprecated.

maxArrayLike

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

Deprecated.

maxArrayLike

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

Parameters:

name - field name

size - maximum size

numberExamples - number of examples to generate

maxArrayLike

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

Parameters:

size - minimum size

numberExamples - number of examples to generate

minMaxArrayLike

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

Parameters:

name - field name

minSize - minimum size

maxSize - maximum size

minMaxArrayLike

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

Deprecated.

minMaxArrayLike

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

Parameters:

minSize - minimum size

maxSize - maximum size

minMaxArrayLike

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

Deprecated.

minMaxArrayLike

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

Parameters:

name - field name

minSize - minimum size

maxSize - maximum size

numberExamples - number of examples to generate

minMaxArrayLike

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

Parameters:

minSize - minimum size

maxSize - maximum size

numberExamples - number of examples to generate

object

public PactDslJsonBody object(java.lang.String name)

Parameters:

name - field name

object

public PactDslJsonBody object()

closeObject

public DslPart closeObject()

Returns:

org.jetbrains.dokka.NodeRenderContent@b0590cb:

close

public DslPart close()

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

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

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

public PactDslJsonArray eachArrayLike(java.lang.String name)

Parameters:

name - field name

eachArrayLike

public PactDslJsonArray eachArrayLike(int numberExamples)

Parameters:

numberExamples - number of examples to generate

eachArrayWithMaxLike

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

Parameters:

name - field name

size - Maximum size of the outer array

eachArrayWithMaxLike

public PactDslJsonArray eachArrayWithMaxLike(java.lang.Integer size)

Parameters:

size - Maximum size of the outer array

eachArrayWithMaxLike

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

Parameters:

name - field name

numberExamples - number of examples to generate

size - Maximum size of the outer array

eachArrayWithMaxLike

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

Parameters:

numberExamples - number of examples to generate

size - Maximum size of the outer array

eachArrayWithMinLike

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

Parameters:

name - field name

size - Minimum size of the outer array

eachArrayWithMinLike

public PactDslJsonArray eachArrayWithMinLike(java.lang.Integer size)

Parameters:

size - Minimum size of the outer array

eachArrayWithMinLike

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

Parameters:

name - field name

numberExamples - number of examples to generate

size - Minimum size of the outer array

eachArrayWithMinLike

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

Parameters:

numberExamples - number of examples to generate

size - Minimum size of the outer array

eachArrayWithMinMaxLike

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

Parameters:

name - field name

minSize - minimum size

maxSize - maximum size

eachArrayWithMinMaxLike

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

Parameters:

minSize - minimum size

maxSize - maximum size

eachArrayWithMinMaxLike

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

Parameters:

name - field name

numberExamples - number of examples to generate

minSize - minimum size

maxSize - maximum size

eachArrayWithMinMaxLike

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

Parameters:

numberExamples - number of examples to generate

minSize - minimum size

maxSize - maximum size

eachArrayLike

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

Parameters:

name - field name

numberExamples - number of examples to generate

eachArrayLike

public PactDslJsonArray eachArrayLike()

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