au.com.dius.pact.consumer.dsl

Class DslPart

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

Direct Known Subclasses:

PactDslJsonArray, PactDslJsonBody, PactDslJsonRootValue, PactDslRootValue

public class DslPart

Abstract base class to support Object and Array JSON DSL builders

Field Detail

DATE_2000

public static long DATE_2000

See Also:

Constant Field Values

Companion

public static au.com.dius.pact.consumer.dsl.DslPart.Companion Companion

Constructor Detail

DslPart

public DslPart(@Nullable
               DslPart parent,
               @NotNull
               java.lang.String rootPath,
               @NotNull
               java.lang.String rootName)

DslPart

public DslPart(@NotNull
               java.lang.String rootPath,
               @NotNull
               java.lang.String rootName)

Method Detail

getParent

@Nullable
public DslPart getParent()

Returns the parent of this part (object or array)

Returns:

parent, or null if it is the root

getRootPath

@NotNull
public java.lang.String getRootPath()

getRootName

@NotNull
public java.lang.String getRootName()

getMatchers

@NotNull
public au.com.dius.pact.core.model.matchingrules.Category getMatchers()

setMatchers

public void setMatchers(@NotNull
                        au.com.dius.pact.core.model.matchingrules.Category p)

getGenerators

@NotNull
public au.com.dius.pact.core.model.generators.Generators getGenerators()

setGenerators

public void setGenerators(@NotNull
                          au.com.dius.pact.core.model.generators.Generators p)

getClosed

protected boolean getClosed()

setClosed

protected void setClosed(boolean p)

putObjectPrivate

public void putObjectPrivate(@NotNull
                             DslPart obj)

putArrayPrivate

public void putArrayPrivate(@NotNull
                            DslPart obj)

getBody

@NotNull
public au.com.dius.pact.core.support.json.JsonValue getBody()

setBody

public void setBody(@NotNull
                    au.com.dius.pact.core.support.json.JsonValue p)

array

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

Field which is an array

Parameters:

name - field name

array

@NotNull
public PactDslJsonArray array()

Element as an array

closeArray

@Nullable
public DslPart closeArray()

Close of the previous array element

eachLike

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

Array field where each element must match the following object

Parameters:

name - field name

eachLike

@NotNull
public PactDslJsonBody eachLike(@NotNull
                                         java.lang.String name,
                                         @NotNull
                                         DslPart obj)

Array field where each element must match the following object

Parameters:

name - field name

eachLike

@NotNull
public PactDslJsonBody eachLike()

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

eachLike

@NotNull
public PactDslJsonArray eachLike(@NotNull
                                          DslPart obj)

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

eachLike

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

Array field where each element must match the following object

Parameters:

name - field name

numberExamples - number of examples to generate

eachLike

@NotNull
public PactDslJsonBody eachLike(int numberExamples)

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

Parameters:

numberExamples - number of examples to generate

minArrayLike

@NotNull
public PactDslJsonBody minArrayLike(@NotNull
                                             java.lang.String name,
                                             int size)

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

Parameters:

name - field name

size - minimum size

minArrayLike

@NotNull
public PactDslJsonBody minArrayLike(int size)

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

Parameters:

size - minimum size

minArrayLike

@NotNull
public PactDslJsonBody minArrayLike(@NotNull
                                             java.lang.String name,
                                             int size,
                                             @NotNull
                                             DslPart obj)

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

Parameters:

name - field name

size - minimum size

minArrayLike

@NotNull
public PactDslJsonArray minArrayLike(int size,
                                              @NotNull
                                              DslPart obj)

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

Parameters:

size - minimum size

minArrayLike

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

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

Parameters:

name - field name

size - minimum size

numberExamples - number of examples to generate

minArrayLike

@NotNull
public PactDslJsonBody minArrayLike(int size,
                                             int numberExamples)

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

Parameters:

size - minimum size

numberExamples - number of examples to generate

maxArrayLike

@NotNull
public PactDslJsonBody maxArrayLike(@NotNull
                                             java.lang.String name,
                                             int size)

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

Parameters:

name - field name

size - maximum size

maxArrayLike

@NotNull
public PactDslJsonBody maxArrayLike(int size)

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

Parameters:

size - maximum size

maxArrayLike

@NotNull
public PactDslJsonBody maxArrayLike(@NotNull
                                             java.lang.String name,
                                             int size,
                                             @NotNull
                                             DslPart obj)

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

Parameters:

name - field name

size - maximum size

maxArrayLike

@NotNull
public PactDslJsonArray maxArrayLike(int size,
                                              @NotNull
                                              DslPart obj)

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

Parameters:

size - minimum size

maxArrayLike

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

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

Parameters:

name - field name

size - maximum size

numberExamples - number of examples to generate

maxArrayLike

@NotNull
public PactDslJsonBody maxArrayLike(int size,
                                             int numberExamples)

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

Parameters:

size - maximum size

numberExamples - number of examples to generate

minMaxArrayLike

@NotNull
public PactDslJsonBody minMaxArrayLike(@NotNull
                                                java.lang.String name,
                                                int minSize,
                                                int maxSize)

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

Parameters:

name - field name

minSize - minimum size

maxSize - maximum size

minMaxArrayLike

@NotNull
public PactDslJsonBody minMaxArrayLike(@NotNull
                                                java.lang.String name,
                                                int minSize,
                                                int maxSize,
                                                @NotNull
                                                DslPart obj)

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

Parameters:

name - field name

minSize - minimum size

maxSize - maximum size

minMaxArrayLike

@NotNull
public PactDslJsonBody minMaxArrayLike(int minSize,
                                                int maxSize)

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

Parameters:

minSize - minimum size

maxSize - maximum size

minMaxArrayLike

@NotNull
public PactDslJsonArray minMaxArrayLike(int minSize,
                                                 int maxSize,
                                                 @NotNull
                                                 DslPart obj)

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

Parameters:

minSize - minimum size

maxSize - maximum size

minMaxArrayLike

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

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

Parameters:

name - field name

minSize - minimum size

maxSize - maximum size

numberExamples - number of examples to generate

minMaxArrayLike

@NotNull
public PactDslJsonBody minMaxArrayLike(int minSize,
                                                int maxSize,
                                                int numberExamples)

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

Parameters:

minSize - minimum size

maxSize - maximum size

numberExamples - number of examples to generate

eachArrayLike

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

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

Parameters:

name - field name

eachArrayLike

@NotNull
public PactDslJsonArray eachArrayLike()

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

eachArrayLike

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

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

Parameters:

name - field name

numberExamples - number of examples to generate

eachArrayLike

@NotNull
public PactDslJsonArray eachArrayLike(int numberExamples)

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

Parameters:

numberExamples - number of examples to generate

eachArrayWithMaxLike

@NotNull
public PactDslJsonArray eachArrayWithMaxLike(@NotNull
                                                      java.lang.String name,
                                                      int size)

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

Parameters:

name - field name

size - Maximum size of the outer array

eachArrayWithMaxLike

@NotNull
public PactDslJsonArray eachArrayWithMaxLike(int size)

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

Parameters:

size - Maximum size of the outer array

eachArrayWithMaxLike

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

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

Parameters:

name - field name

numberExamples - number of examples to generate

size - Maximum size of the outer array

eachArrayWithMaxLike

@NotNull
public PactDslJsonArray eachArrayWithMaxLike(int numberExamples,
                                                      int size)

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

Parameters:

numberExamples - number of examples to generate

size - Maximum size of the outer array

eachArrayWithMinLike

@NotNull
public PactDslJsonArray eachArrayWithMinLike(@NotNull
                                                      java.lang.String name,
                                                      int size)

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

Parameters:

name - field name

size - Minimum size of the outer array

eachArrayWithMinLike

@NotNull
public PactDslJsonArray eachArrayWithMinLike(int size)

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

Parameters:

size - Minimum size of the outer array

eachArrayWithMinLike

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

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

Parameters:

name - field name

numberExamples - number of examples to generate

size - Minimum size of the outer array

eachArrayWithMinLike

@NotNull
public PactDslJsonArray eachArrayWithMinLike(int numberExamples,
                                                      int size)

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

Parameters:

numberExamples - number of examples to generate

size - Minimum size of the outer array

eachArrayWithMinMaxLike

@NotNull
public PactDslJsonArray eachArrayWithMinMaxLike(@NotNull
                                                         java.lang.String name,
                                                         int minSize,
                                                         int maxSize)

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

Parameters:

name - field name

minSize - minimum size

maxSize - maximum size

eachArrayWithMinMaxLike

@NotNull
public PactDslJsonArray eachArrayWithMinMaxLike(int minSize,
                                                         int maxSize)

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

Parameters:

minSize - minimum size

maxSize - maximum size

eachArrayWithMinMaxLike

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

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

Parameters:

name - field name

numberExamples - number of examples to generate

minSize - minimum size

maxSize - maximum size

eachArrayWithMinMaxLike

@NotNull
public PactDslJsonArray eachArrayWithMinMaxLike(int numberExamples,
                                                         int minSize,
                                                         int maxSize)

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

Parameters:

numberExamples - number of examples to generate

minSize - minimum size

maxSize - maximum size

object

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

Object field

Parameters:

name - field name

object

@NotNull
public PactDslJsonBody object()

Object element

closeObject

@Nullable
public DslPart closeObject()

Close off the previous object

Returns:

regexp

@NotNull
protected au.com.dius.pact.core.model.matchingrules.RegexMatcher regexp(@NotNull
                                                                                 java.lang.String regex)

matchTimestamp

@NotNull
protected au.com.dius.pact.core.model.matchingrules.TimestampMatcher matchTimestamp(@NotNull
                                                                                             java.lang.String format)

matchDate

@NotNull
protected au.com.dius.pact.core.model.matchingrules.DateMatcher matchDate(@NotNull
                                                                                   java.lang.String format)

matchTime

@NotNull
protected au.com.dius.pact.core.model.matchingrules.TimeMatcher matchTime(@NotNull
                                                                                   java.lang.String format)

matchMin

@NotNull
protected au.com.dius.pact.core.model.matchingrules.MinTypeMatcher matchMin(int min)

matchMax

@NotNull
protected au.com.dius.pact.core.model.matchingrules.MaxTypeMatcher matchMax(int max)

matchMinMax

@NotNull
protected au.com.dius.pact.core.model.matchingrules.MinMaxTypeMatcher matchMinMax(int minSize,
                                                                                           int maxSize)

includesMatcher

@NotNull
protected au.com.dius.pact.core.model.matchingrules.IncludeMatcher includesMatcher(@NotNull
                                                                                            java.lang.Object value)

asBody

@NotNull
public PactDslJsonBody asBody()

asArray

@NotNull
public PactDslJsonArray asArray()

close

@Nullable
public DslPart close()

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

Returns:

The root object of the object graph

See Also:

Object|Array

matchUrl

@NotNull
public DslPart matchUrl(@NotNull
                                 java.lang.String name,
                                 @Nullable
                                 java.lang.String basePath,
                                 @NotNull
                                 java.lang.Object... pathFragments)

Matches a URL that is composed of a base path and a sequence of path expressions

Parameters:

name - Attribute name

basePath - The base path for the URL (like "http://localhost:8080/") which will be excluded from the matching

pathFragments - Series of path fragments to match on. These can be strings or regular expressions.

matchUrl

@NotNull
public DslPart matchUrl(@Nullable
                                 java.lang.String basePath,
                                 @NotNull
                                 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.

matchUrl2

@NotNull
public DslPart matchUrl2(@NotNull
                                  java.lang.String name,
                                  @NotNull
                                  java.lang.Object... pathFragments)

Matches a URL that is composed of a base path and a sequence of path expressions. Base path from the mock server will be used.

Parameters:

name - Attribute name

pathFragments - Series of path fragments to match on. These can be strings or regular expressions.

matchUrl2

@NotNull
public DslPart matchUrl2(@NotNull
                                  java.lang.Object... pathFragments)

Matches a URL that is composed of a base path and a sequence of path expressions. Base path from the mock server

• will be used.

Parameters:

pathFragments - Series of path fragments to match on. These can be strings or regular expressions.

regex

@JvmStatic
 @NotNull
public static au.com.dius.pact.core.model.matchingrules.RegexMatcher regex(@NotNull
                                                                                                java.lang.String regex,
                                                                                                @NotNull
                                                                                                java.lang.String example)

Returns a regular expression matcher

Parameters:

regex - Regex to match with

example - Example value to use

Returns:

regex

@JvmStatic
 @NotNull
public static au.com.dius.pact.core.model.matchingrules.RegexMatcher regex(@NotNull
                                                                                                java.lang.String regex)

Returns a regular expression matcher. Will generate random examples from the regex.

Parameters:

regex - Regex to match with

Returns: