au.com.dius.pact.consumer.dsl

Class DslPart

java.lang.Object

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

Direct Known Subclasses:

PactDslJsonArray, PactDslJsonBody, PactDslJsonRootValue, PactDslRootValue

public abstract class DslPart
extends java.lang.Object

Abstract base class to support Object and Array JSON DSL builders

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closed
static long	DATE_2000
protected au.com.dius.pact.core.model.generators.Generators	generators
static java.lang.String	HEXADECIMAL
static java.lang.String	IP_ADDRESS
protected au.com.dius.pact.core.model.matchingrules.Category	matchers
protected DslPart	parent
protected java.lang.String	rootName
protected java.lang.String	rootPath
static java.lang.String	UUID_REGEX

Constructor Summary

Constructors

Constructor and Description
DslPart(DslPart parent, java.lang.String rootPath, java.lang.String rootName)
DslPart(java.lang.String rootPath, java.lang.String rootName)

Method Summary

Modifier and Type	Method and Description
abstract PactDslJsonArray	array() Element as an array
abstract PactDslJsonArray	array(java.lang.String name) Field which is an array
PactDslJsonArray	asArray()
PactDslJsonBody	asBody()
abstract DslPart	close() This closes off the object graph build from the DSL in case any close[Object|Array] methods have not been called.
abstract DslPart	closeArray() Close of the previous array element
abstract DslPart	closeObject() Close off the previous object
abstract PactDslJsonArray	eachArrayLike() Array element where each element of the array is an array and must match the following object
abstract PactDslJsonArray	eachArrayLike(int numberExamples) Array element where each element of the array is an array and must match the following object
abstract PactDslJsonArray	eachArrayLike(java.lang.String name) Array field where each element is an array and must match the following object
abstract PactDslJsonArray	eachArrayLike(java.lang.String name, int numberExamples) Array field where each element is an array and must match the following object
abstract PactDslJsonArray	eachArrayWithMaxLike(java.lang.Integer size) Array element where each element of the array is an array and must match the following object
abstract 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
abstract PactDslJsonArray	eachArrayWithMaxLike(java.lang.String name, java.lang.Integer size) Array field where each element is an array and must match the following object
abstract 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
abstract PactDslJsonArray	eachArrayWithMinLike(java.lang.Integer size) Array element where each element of the array is an array and must match the following object
abstract 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
abstract PactDslJsonArray	eachArrayWithMinLike(java.lang.String name, java.lang.Integer size) Array field where each element is an array and must match the following object
abstract 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
abstract 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
abstract 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
abstract 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
abstract 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
abstract PactDslJsonBody	eachLike() Array element where each element of the array must match the following object
abstract PactDslJsonArray	eachLike(DslPart object) Array element where each element of the array must match the provided object
abstract PactDslJsonBody	eachLike(int numberExamples) Array element where each element of the array must match the following object
abstract PactDslJsonBody	eachLike(java.lang.String name) Array field where each element must match the following object
abstract PactDslJsonBody	eachLike(java.lang.String name, DslPart object) Array field where each element must match the following object
abstract PactDslJsonBody	eachLike(java.lang.String name, int numberExamples) Array field where each element must match the following object
abstract java.lang.Object	getBody()
au.com.dius.pact.core.model.generators.Generators	getGenerators()
au.com.dius.pact.core.model.matchingrules.Category	getMatchers()
DslPart	getParent() Returns the parent of this part (object or array)
protected au.com.dius.pact.core.model.matchingrules.IncludeMatcher	includesMatcher(java.lang.Object value)
protected au.com.dius.pact.core.model.matchingrules.DateMatcher	matchDate(java.lang.String format)
protected au.com.dius.pact.core.model.matchingrules.MaxTypeMatcher	matchMax(java.lang.Integer max)
protected au.com.dius.pact.core.model.matchingrules.MinTypeMatcher	matchMin(java.lang.Integer min)
protected au.com.dius.pact.core.model.matchingrules.MinMaxTypeMatcher	matchMinMax(java.lang.Integer minSize, java.lang.Integer maxSize)
protected au.com.dius.pact.core.model.matchingrules.TimeMatcher	matchTime(java.lang.String format)
protected au.com.dius.pact.core.model.matchingrules.TimestampMatcher	matchTimestamp(java.lang.String format)
abstract PactDslJsonBody	maxArrayLike(java.lang.Integer size) Array element with a maximum size and each element of the array must match the following object
abstract PactDslJsonArray	maxArrayLike(java.lang.Integer size, DslPart object) Array element with a maximum size and each element of the array must match the provided object
abstract PactDslJsonBody	maxArrayLike(java.lang.Integer size, int numberExamples) Array element with a maximum size and each element of the array must match the following object
abstract PactDslJsonBody	maxArrayLike(java.lang.String name, java.lang.Integer size) Array field with a maximum size and each element must match the following object
abstract PactDslJsonBody	maxArrayLike(java.lang.String name, java.lang.Integer size, DslPart object) Array field with a maximum size and each element must match the provided object
abstract PactDslJsonBody	maxArrayLike(java.lang.String name, java.lang.Integer size, int numberExamples) Array field with a maximum size and each element must match the following object
abstract PactDslJsonBody	minArrayLike(java.lang.Integer size) Array element with a minumum size and each element of the array must match the following object
abstract PactDslJsonArray	minArrayLike(java.lang.Integer size, DslPart object) Array element with a minumum size and each element of the array must match the provided object
abstract PactDslJsonBody	minArrayLike(java.lang.Integer size, int numberExamples) Array element with a minumum size and each element of the array must match the following object
abstract PactDslJsonBody	minArrayLike(java.lang.String name, java.lang.Integer size) Array field with a minumum size and each element must match the following object
abstract PactDslJsonBody	minArrayLike(java.lang.String name, java.lang.Integer size, DslPart object) Array field with a minumum size and each element must match the provided object
abstract PactDslJsonBody	minArrayLike(java.lang.String name, java.lang.Integer size, int numberExamples) Array field with a minumum size and each element must match the following object
abstract 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 following object
abstract PactDslJsonArray	minMaxArrayLike(java.lang.Integer minSize, java.lang.Integer maxSize, DslPart object) Array element with a minimum and maximum size and each element of the array must match the provided object
abstract 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 following object
abstract 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 following object
abstract PactDslJsonBody	minMaxArrayLike(java.lang.String name, java.lang.Integer minSize, java.lang.Integer maxSize, DslPart object) Array field with a minimum and maximum size and each element must match the provided object
abstract 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 following object
abstract PactDslJsonBody	object() Object element
abstract PactDslJsonBody	object(java.lang.String name) Object field
protected abstract void	putArray(DslPart object)
protected abstract void	putObject(DslPart object)
protected au.com.dius.pact.core.model.matchingrules.RegexMatcher	regexp(java.lang.String regex)
void	setGenerators(au.com.dius.pact.core.model.generators.Generators generators)
void	setMatchers(au.com.dius.pact.core.model.matchingrules.Category matchers)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HEXADECIMAL

public static final java.lang.String HEXADECIMAL

See Also:

Constant Field Values

IP_ADDRESS

public static final java.lang.String IP_ADDRESS

See Also:

Constant Field Values

UUID_REGEX

public static final java.lang.String UUID_REGEX

See Also:

Constant Field Values

DATE_2000

public static final long DATE_2000

See Also:

Constant Field Values

parent

protected final DslPart parent

rootPath

protected final java.lang.String rootPath

rootName

protected final 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 abstract void putObject(DslPart object)

putArray

protected abstract void putArray(DslPart object)

getBody

public abstract java.lang.Object getBody()

array

public abstract PactDslJsonArray array(java.lang.String name)

Field which is an array

Parameters:

name - field name

array

public abstract PactDslJsonArray array()

Element as an array

closeArray

public abstract DslPart closeArray()

Close of the previous array element

eachLike

public abstract PactDslJsonBody eachLike(java.lang.String name)

Array field where each element must match the following object

Parameters:

name - field name

eachLike

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

Array field where each element must match the following object

Parameters:

name - field name

eachLike

public abstract PactDslJsonBody eachLike()

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

eachLike

public abstract PactDslJsonArray eachLike(DslPart object)

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

eachLike

public abstract 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 abstract 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 abstract PactDslJsonBody minArrayLike(java.lang.String name,
                                             java.lang.Integer size)

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

Parameters:

name - field name

size - minimum size

minArrayLike

public abstract PactDslJsonBody minArrayLike(java.lang.Integer size)

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

Parameters:

size - minimum size

minArrayLike

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

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

Parameters:

name - field name

size - minimum size

minArrayLike

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

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

Parameters:

size - minimum size

minArrayLike

public abstract PactDslJsonBody minArrayLike(java.lang.String name,
                                             java.lang.Integer 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

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

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

Parameters:

size - minimum size

numberExamples - number of examples to generate

maxArrayLike

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

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

Parameters:

name - field name

size - maximum size

maxArrayLike

public abstract PactDslJsonBody maxArrayLike(java.lang.Integer size)

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

Parameters:

size - minimum size

maxArrayLike

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

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

Parameters:

name - field name

size - maximum size

maxArrayLike

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

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

Parameters:

size - minimum size

maxArrayLike

public abstract PactDslJsonBody maxArrayLike(java.lang.String name,
                                             java.lang.Integer 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

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

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

Parameters:

size - minimum size

numberExamples - number of examples to generate

minMaxArrayLike

public abstract 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 following object

Parameters:

name - field name

minSize - minimum size

maxSize - maximum size

minMaxArrayLike

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

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 abstract 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 following object

Parameters:

minSize - minimum size

maxSize - maximum size

minMaxArrayLike

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

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 abstract 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 following object

Parameters:

name - field name

minSize - minimum size

maxSize - maximum size

numberExamples - number of examples to generate

minMaxArrayLike

public abstract 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 following object

Parameters:

minSize - minimum size

maxSize - maximum size

numberExamples - number of examples to generate

eachArrayLike

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

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

eachArrayLike

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract PactDslJsonBody object(java.lang.String name)

Object field

Parameters:

name - field name

object

public abstract PactDslJsonBody object()

Object element

closeObject

public abstract DslPart closeObject()

Close off the previous object

Returns:

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 abstract DslPart close()

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

Returns:

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:

parent, or null if it is the root