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

HEXADECIMAL

public static java.lang.String HEXADECIMAL

See Also:

Constant Field Values

IP_ADDRESS

public static java.lang.String IP_ADDRESS

See Also:

Constant Field Values

UUID_REGEX

public static java.lang.String UUID_REGEX

See Also:

Constant Field Values

DATE_2000

public static long DATE_2000

See Also:

Constant Field Values

parent

protected DslPart parent

rootPath

protected java.lang.String rootPath

rootName

protected java.lang.String rootName

matchers

protected au.com.dius.pact.core.model.matchingrules.Category matchers

generators

protected au.com.dius.pact.core.model.generators.Generators generators

closed

protected boolean closed

Constructor Detail

DslPart

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

DslPart

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

Method Detail

putObject

protected void putObject(DslPart object)

putArray

protected void putArray(DslPart object)

getBody

public java.lang.Object getBody()

array

public PactDslJsonArray array(java.lang.String name)

Field which is an array

Parameters:

name - field name

array

public PactDslJsonArray array()

Element as an array

closeArray

public DslPart closeArray()

Close of the previous array element

arrayLike

public PactDslJsonBody arrayLike(java.lang.String name)

Array field where each element must match the following object

Parameters:

name - field name

arrayLike

public PactDslJsonBody arrayLike()

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

eachLike

public PactDslJsonBody eachLike(java.lang.String name)

Array field where each element must match the following object

Parameters:

name - field name

eachLike

public PactDslJsonBody eachLike()

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

eachLike

public PactDslJsonBody eachLike(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

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

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

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

Parameters:

name - field name

size - minimum size

minArrayLike

public PactDslJsonBody minArrayLike(java.lang.Integer size)

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

Parameters:

size - minimum size

minArrayLike

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

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

Parameters:

name - field name

size - minimum size

numberExamples - number of examples to generate

minArrayLike

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

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

Parameters:

size - minimum size

numberExamples - number of examples to generate

maxArrayLike

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

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

Parameters:

name - field name

size - maximum size

maxArrayLike

public PactDslJsonBody maxArrayLike(java.lang.Integer size)

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

Parameters:

size - minimum size

maxArrayLike

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

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

Parameters:

name - field name

size - maximum size

numberExamples - number of examples to generate

maxArrayLike

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

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

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)

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

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

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

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

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

numberExamples - number of examples to generate

minMaxArrayLike

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

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

numberExamples - number of examples to generate

eachArrayLike

public PactDslJsonArray eachArrayLike(java.lang.String name)

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

Parameters:

name - field name

eachArrayLike

public PactDslJsonArray eachArrayLike()

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

eachArrayLike

public PactDslJsonArray eachArrayLike(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

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

public PactDslJsonArray eachArrayWithMaxLike(java.lang.String name,
                                             java.lang.Integer 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

public PactDslJsonArray eachArrayWithMaxLike(java.lang.Integer 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

public PactDslJsonArray eachArrayWithMaxLike(java.lang.String name,
                                             int numberExamples,
                                             java.lang.Integer 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

public PactDslJsonArray eachArrayWithMaxLike(int numberExamples,
                                             java.lang.Integer 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

public PactDslJsonArray eachArrayWithMinLike(java.lang.String name,
                                             java.lang.Integer 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

public PactDslJsonArray eachArrayWithMinLike(java.lang.Integer 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

public PactDslJsonArray eachArrayWithMinLike(java.lang.String name,
                                             int numberExamples,
                                             java.lang.Integer 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

public PactDslJsonArray eachArrayWithMinLike(int numberExamples,
                                             java.lang.Integer 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

public PactDslJsonArray eachArrayWithMinMaxLike(java.lang.String name,
                                                java.lang.Integer minSize,
                                                java.lang.Integer 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

public PactDslJsonArray eachArrayWithMinMaxLike(java.lang.Integer minSize,
                                                java.lang.Integer 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

public PactDslJsonArray eachArrayWithMinMaxLike(java.lang.String name,
                                                int numberExamples,
                                                java.lang.Integer minSize,
                                                java.lang.Integer 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

public PactDslJsonArray eachArrayWithMinMaxLike(int numberExamples,
                                                java.lang.Integer minSize,
                                                java.lang.Integer 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

public PactDslJsonBody object(java.lang.String name)

Object field

Parameters:

name - field name

object

public PactDslJsonBody object()

Object element

closeObject

public DslPart closeObject()

Close off the previous object

Returns:

org.jetbrains.dokka.NodeRenderContent@45a3a008:

getMatchers

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

setMatchers

public void setMatchers(au.com.dius.pact.core.model.matchingrules.Category matchers)

regexp

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

matchTimestamp

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

matchDate

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

matchTime

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

matchMin

protected au.com.dius.pact.core.model.matchingrules.MinTypeMatcher matchMin(java.lang.Integer min)

matchMax

protected au.com.dius.pact.core.model.matchingrules.MaxTypeMatcher matchMax(java.lang.Integer max)

matchMinMax

protected au.com.dius.pact.core.model.matchingrules.MinMaxTypeMatcher matchMinMax(java.lang.Integer minSize,
                                                                                  java.lang.Integer maxSize)

includesMatcher

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

asBody

public PactDslJsonBody asBody()

asArray

public PactDslJsonArray asArray()

close

public DslPart close()

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

Returns:

org.jetbrains.dokka.NodeRenderContent@6b46774e: The root object of the object graph

getGenerators

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

setGenerators

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

getParent

public DslPart getParent()

Returns the parent of this part (object or array)

Returns:

org.jetbrains.dokka.NodeRenderContent@6266c5d4: parent, or null if it is the root