class PactDslJsonArray extends DslPart
DSL to define a JSON array
- Alphabetic
- By Inheritance
- PactDslJsonArray
- DslPart
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
PactDslJsonArray(rootPath: String, rootName: String, parent: DslPart, wildCard: Boolean)
Construct a array as a child
Construct a array as a child
- rootPath
Path to the child array
- rootName
Name to associate the child as
- parent
Parent to attach the child to
- wildCard
If it should be matched as a wild card
-
new
PactDslJsonArray(rootPath: String, rootName: String, parent: DslPart, array: PactDslJsonArray)
Construct an array as a child copied from an existing array
Construct an array as a child copied from an existing array
- rootPath
Path to the child array
- rootName
Name to associate the child as
- parent
Parent to attach the child to
- array
Array to copy
-
new
PactDslJsonArray(rootPath: String, rootName: String, parent: DslPart)
Construct an array as a child
Construct an array as a child
- rootPath
Path to the child array
- rootName
Name to associate the child as
- parent
Parent to attach the child to
- new PactDslJsonArray()
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
and(value: Any, rules: <repeated...>[MatchingRule]): PactDslJsonArray
Combine all the matchers using AND
Combine all the matchers using AND
- value
Attribute example value
- rules
Matching rules to apply
-
def
array(): PactDslJsonArray
Element that is a JSON array
Element that is a JSON array
- Definition Classes
- PactDslJsonArray → DslPart
-
def
array(name: String): PactDslJsonArray
Field which is an array
-
def
asArray(): PactDslJsonArray
- Definition Classes
- DslPart
-
def
asBody(): PactDslJsonBody
- Definition Classes
- DslPart
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
booleanType(example: Boolean): PactDslJsonArray
Element that must be a boolean
Element that must be a boolean
- example
example boolean to use for generated bodies
-
def
booleanType(): PactDslJsonArray
Element that must be a boolean
-
def
booleanValue(value: Boolean): PactDslJsonArray
Element that must be the specified value
Element that must be the specified value
- value
boolean value
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
close(): DslPart
This closes off the object graph build from the DSL in case any close[Object|Array] methods have not been called.
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
- Definition Classes
- PactDslJsonArray → DslPart
-
def
closeArray(): DslPart
Closes the current array
Closes the current array
- Definition Classes
- PactDslJsonArray → DslPart
-
def
closeObject(): DslPart
Close off the previous object
Close off the previous object
- Definition Classes
- PactDslJsonArray → DslPart
-
def
date(format: String, example: Date): PactDslJsonArray
Element that must match the provided date format
Element that must match the provided date format
- format
date format to match
- example
example date to use for generated values
-
def
date(format: String): PactDslJsonArray
Element that must match the provided date format
Element that must match the provided date format
- format
date format to match
-
def
date(): PactDslJsonArray
Element that must be formatted as an ISO date
-
def
decimalType(number: Double): PactDslJsonArray
Attribute that must be a decimalType value
Attribute that must be a decimalType value
- number
example decimalType value
-
def
decimalType(number: BigDecimal): PactDslJsonArray
Element that must be a decimalType value
Element that must be a decimalType value
- number
example decimalType value
-
def
decimalType(): PactDslJsonArray
Element that must be a decimal value
-
def
eachArrayLike(numberExamples: Int): PactDslJsonArray
Array element where each element of the array is an array and must match the following object
Array element where each element of the array is an array and must match the following object
- numberExamples
number of examples to generate
- Definition Classes
- PactDslJsonArray → DslPart
-
def
eachArrayLike(): PactDslJsonArray
Array element where each element of the array is an array and must match the following object
Array element where each element of the array is an array and must match the following object
- Definition Classes
- PactDslJsonArray → DslPart
-
def
eachArrayLike(name: String, numberExamples: Int): PactDslJsonArray
Array field where each element is an array and must match the following object
Array field where each element is an array and must match the following object
- name
field name
- numberExamples
number of examples to generate
- Definition Classes
- PactDslJsonArray → DslPart
-
def
eachArrayLike(name: String): PactDslJsonArray
Array field where each element is an array and must match the following object
Array field where each element is an array and must match the following object
- name
field name
- Definition Classes
- PactDslJsonArray → DslPart
-
def
eachArrayWithMaxLike(numberExamples: Int, size: Integer): PactDslJsonArray
Array element where each element of the array is an array and must match the following object
Array element where each element of the array is an array and must match the following object
- numberExamples
number of examples to generate
- size
Maximum size of the outer array
- Definition Classes
- PactDslJsonArray → DslPart
-
def
eachArrayWithMaxLike(size: Integer): PactDslJsonArray
Array element where each element of the array is an array and must match the following object
Array element where each element of the array is an array and must match the following object
- size
Maximum size of the outer array
- Definition Classes
- PactDslJsonArray → DslPart
-
def
eachArrayWithMaxLike(name: String, numberExamples: Int, size: Integer): PactDslJsonArray
Array field where each element is an array and must match the following object
Array field where each element is an array and must match the following object
- name
field name
- numberExamples
number of examples to generate
- size
Maximum size of the outer array
- Definition Classes
- PactDslJsonArray → DslPart
-
def
eachArrayWithMaxLike(name: String, size: Integer): PactDslJsonArray
Array field where each element is an array and must match the following object
Array field where each element is an array and must match the following object
- name
field name
- size
Maximum size of the outer array
- Definition Classes
- PactDslJsonArray → DslPart
-
def
eachArrayWithMinLike(numberExamples: Int, size: Integer): PactDslJsonArray
Array element where each element of the array is an array and must match the following object
Array element where each element of the array is an array and must match the following object
- numberExamples
number of examples to generate
- size
Minimum size of the outer array
- Definition Classes
- PactDslJsonArray → DslPart
-
def
eachArrayWithMinLike(size: Integer): PactDslJsonArray
Array element where each element of the array is an array and must match the following object
Array element where each element of the array is an array and must match the following object
- size
Minimum size of the outer array
- Definition Classes
- PactDslJsonArray → DslPart
-
def
eachArrayWithMinLike(name: String, numberExamples: Int, size: Integer): PactDslJsonArray
Array field where each element is an array and must match the following object
Array field where each element is an array and must match the following object
- name
field name
- numberExamples
number of examples to generate
- size
Minimum size of the outer array
- Definition Classes
- PactDslJsonArray → DslPart
-
def
eachArrayWithMinLike(name: String, size: Integer): PactDslJsonArray
Array field where each element is an array and must match the following object
Array field where each element is an array and must match the following object
- name
field name
- size
Minimum size of the outer array
- Definition Classes
- PactDslJsonArray → DslPart
-
def
eachArrayWithMinMaxLike(numberExamples: Int, minSize: Integer, maxSize: Integer): PactDslJsonArray
Array element where each element of the array is an array and must match the following object
Array element where each element of the array is an array and must match the following object
- numberExamples
number of examples to generate
- minSize
minimum size
- maxSize
maximum size
- Definition Classes
- PactDslJsonArray → DslPart
-
def
eachArrayWithMinMaxLike(name: String, numberExamples: Int, minSize: Integer, maxSize: Integer): PactDslJsonArray
Array field where each element is an array and must match the following object
Array field where each element is an array and must match the following object
- name
field name
- numberExamples
number of examples to generate
- minSize
minimum size
- maxSize
maximum size
- Definition Classes
- PactDslJsonArray → DslPart
-
def
eachArrayWithMinMaxLike(minSize: Integer, maxSize: Integer): PactDslJsonArray
Array element where each element of the array is an array and must match the following object
Array element where each element of the array is an array and must match the following object
- minSize
minimum size
- maxSize
maximum size
- Definition Classes
- PactDslJsonArray → DslPart
-
def
eachArrayWithMinMaxLike(name: String, minSize: Integer, maxSize: Integer): PactDslJsonArray
Array field where each element is an array and must match the following object
Array field where each element is an array and must match the following object
- name
field name
- minSize
minimum size
- maxSize
maximum size
- Definition Classes
- PactDslJsonArray → DslPart
-
def
eachLike(value: PactDslJsonRootValue, numberExamples: Int): PactDslJsonArray
Array of values that are not objects where each item must match the provided example
Array of values that are not objects where each item must match the provided example
- value
Value to use to match each item
- numberExamples
number of examples to generate
-
def
eachLike(value: PactDslJsonRootValue): PactDslJsonArray
Array of values that are not objects where each item must match the provided example
Array of values that are not objects where each item must match the provided example
- value
Value to use to match each item
-
def
eachLike(numberExamples: Int): PactDslJsonBody
Element that is an array where each item must match the following example
Element that is an array where each item must match the following example
- numberExamples
Number of examples to generate
- Definition Classes
- PactDslJsonArray → DslPart
-
def
eachLike(): PactDslJsonBody
Element that is an array where each item must match the following example
Element that is an array where each item must match the following example
- Definition Classes
- PactDslJsonArray → DslPart
-
def
eachLike(name: String, numberExamples: Int): PactDslJsonBody
Array field where each element must match the following object
Array field where each element must match the following object
- name
field name
- numberExamples
number of examples to generate
- Definition Classes
- PactDslJsonArray → DslPart
-
def
eachLike(name: String): PactDslJsonBody
Array field where each element must match the following object
Array field where each element must match the following object
- name
field name
- Definition Classes
- PactDslJsonArray → DslPart
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
equalsTo(value: Any): PactDslJsonArray
Attribute that must be equal to the provided value.
Attribute that must be equal to the provided value.
- value
Value that will be used for comparisons
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
getBody(): AnyRef
- Definition Classes
- PactDslJsonArray → DslPart
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getGenerators(): Generators
- Definition Classes
- DslPart
-
def
getMatchers(): Category
- Definition Classes
- DslPart
-
def
getNumberExamples(): Int
Returns the number of example elements to generate for sample bodies
-
def
getParent(): DslPart
Returns the parent of this part (object or array)
Returns the parent of this part (object or array)
- returns
parent, or null if it is the root
- Definition Classes
- DslPart
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hexValue(hexValue: String): PactDslJsonArray
Element that must be encoded as a hexadecimal value
Element that must be encoded as a hexadecimal value
- hexValue
example value to use for generated bodies
-
def
hexValue(): PactDslJsonArray
Element that must be encoded as a hexadecimal value
-
def
id(id: Long): PactDslJsonArray
Element that must be a numeric identifier
Element that must be a numeric identifier
- id
example id to use for generated bodies
-
def
id(): PactDslJsonArray
Element that must be a numeric identifier
-
def
includesMatcher(value: Any): IncludeMatcher
- Attributes
- protected[au.com.dius.pact.consumer.dsl]
- Definition Classes
- DslPart
-
def
includesStr(value: String): PactDslJsonArray
List item that must include the provided string
List item that must include the provided string
- value
Value that must be included
-
def
integerType(number: Long): PactDslJsonArray
Element that must be an integer
Element that must be an integer
- number
example integer value to use for generated bodies
-
def
integerType(): PactDslJsonArray
Element that must be an integer
-
def
ipAddress(): PactDslJsonArray
Element that must be an IP4 address
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
matchDate(format: String): DateMatcher
- Attributes
- protected[au.com.dius.pact.consumer.dsl]
- Definition Classes
- DslPart
-
def
matchMax(max: Integer): MaxTypeMatcher
- Attributes
- protected[au.com.dius.pact.consumer.dsl]
- Definition Classes
- DslPart
-
def
matchMin(min: Integer): MinTypeMatcher
- Attributes
- protected[au.com.dius.pact.consumer.dsl]
- Definition Classes
- DslPart
-
def
matchMinMax(minSize: Integer, maxSize: Integer): MinMaxTypeMatcher
- Attributes
- protected[au.com.dius.pact.consumer.dsl]
- Definition Classes
- DslPart
-
def
matchTime(format: String): TimeMatcher
- Attributes
- protected[au.com.dius.pact.consumer.dsl]
- Definition Classes
- DslPart
-
def
matchTimestamp(format: String): TimestampMatcher
- Attributes
- protected[au.com.dius.pact.consumer.dsl]
- Definition Classes
- DslPart
-
def
matchUrl(basePath: String, pathFragments: <repeated...>[AnyRef]): PactDslJsonArray
Matches a URL that is composed of a base path and a sequence of path expressions
Matches a URL that is composed of a base path and a sequence of path expressions
- 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.
-
def
maxArrayLike(size: Integer, value: PactDslJsonRootValue, numberExamples: Int): PactDslJsonArray
Array of values with a maximum size that are not objects where each item must match the provided example
Array of values with a maximum size that are not objects where each item must match the provided example
- size
maximum size of the array
- value
Value to use to match each item
- numberExamples
number of examples to generate
-
def
maxArrayLike(size: Integer, value: PactDslJsonRootValue): PactDslJsonArray
Array of values with a maximum size that are not objects where each item must match the provided example
Array of values with a maximum size that are not objects where each item must match the provided example
- size
maximum size of the array
- value
Value to use to match each item
-
def
maxArrayLike(size: Integer, numberExamples: Int): PactDslJsonBody
Element that is an array with a maximum size where each item must match the following example
Element that is an array with a maximum size where each item must match the following example
- size
maximum size of the array
- numberExamples
number of examples to generate
- Definition Classes
- PactDslJsonArray → DslPart
-
def
maxArrayLike(name: String, size: Integer, numberExamples: Int): PactDslJsonBody
Array field with a maximum size and each element must match the provided object
Array field with a maximum size and each element must match the provided object
- name
field name
- size
maximum size
- numberExamples
number of examples to generate
- Definition Classes
- PactDslJsonArray → DslPart
-
def
maxArrayLike(size: Integer): PactDslJsonBody
Element that is an array with a maximum size where each item must match the following example
Element that is an array with a maximum size where each item must match the following example
- size
maximum size of the array
- Definition Classes
- PactDslJsonArray → DslPart
-
def
maxArrayLike(name: String, size: Integer): PactDslJsonBody
Array field with a maximum size and each element must match the provided object
Array field with a maximum size and each element must match the provided object
- name
field name
- size
maximum size
- Definition Classes
- PactDslJsonArray → DslPart
-
def
minArrayLike(size: Integer, value: PactDslJsonRootValue, numberExamples: Int): PactDslJsonArray
Array of values with a minimum size that are not objects where each item must match the provided example
Array of values with a minimum size that are not objects where each item must match the provided example
- size
minimum size of the array
- value
Value to use to match each item
- numberExamples
number of examples to generate
-
def
minArrayLike(size: Integer, value: PactDslJsonRootValue): PactDslJsonArray
Array of values with a minimum size that are not objects where each item must match the provided example
Array of values with a minimum size that are not objects where each item must match the provided example
- size
minimum size of the array
- value
Value to use to match each item
-
def
minArrayLike(size: Integer, numberExamples: Int): PactDslJsonBody
Element that is an array with a minimum size where each item must match the following example
Element that is an array with a minimum size where each item must match the following example
- size
minimum size of the array
- numberExamples
number of examples to generate
- Definition Classes
- PactDslJsonArray → DslPart
-
def
minArrayLike(name: String, size: Integer, numberExamples: Int): PactDslJsonBody
Array field with a minumum size and each element must match the provided object
Array field with a minumum size and each element must match the provided object
- name
field name
- size
minimum size
- numberExamples
number of examples to generate
- Definition Classes
- PactDslJsonArray → DslPart
-
def
minArrayLike(size: Integer): PactDslJsonBody
Element that is an array with a minimum size where each item must match the following example
Element that is an array with a minimum size where each item must match the following example
- size
minimum size of the array
- Definition Classes
- PactDslJsonArray → DslPart
-
def
minArrayLike(name: String, size: Integer): PactDslJsonBody
Array field with a minumum size and each element must match the provided object
Array field with a minumum size and each element must match the provided object
- name
field name
- size
minimum size
- Definition Classes
- PactDslJsonArray → DslPart
-
def
minMaxArrayLike(minSize: Integer, maxSize: Integer, numberExamples: Int): PactDslJsonBody
Array element with a minimum and maximum size and each element of the array must match the provided object
Array element with a minimum and maximum size and each element of the array must match the provided object
- minSize
minimum size
- maxSize
maximum size
- numberExamples
number of examples to generate
- Definition Classes
- PactDslJsonArray → DslPart
-
def
minMaxArrayLike(name: String, minSize: Integer, maxSize: Integer, numberExamples: Int): PactDslJsonBody
Array field with a minimum and maximum size and each element must match the provided object
Array field with a minimum and maximum size and each element must match the provided object
- name
field name
- minSize
minimum size
- maxSize
maximum size
- numberExamples
number of examples to generate
- Definition Classes
- PactDslJsonArray → DslPart
-
def
minMaxArrayLike(minSize: Integer, maxSize: Integer): PactDslJsonBody
Array element with a minimum and maximum size and each element of the array must match the provided object
Array element with a minimum and maximum size and each element of the array must match the provided object
- minSize
minimum size
- maxSize
maximum size
- Definition Classes
- PactDslJsonArray → DslPart
-
def
minMaxArrayLike(name: String, minSize: Integer, maxSize: Integer): PactDslJsonBody
Array field with a minimum and maximum size and each element must match the provided object
Array field with a minimum and maximum size and each element must match the provided object
- name
field name
- minSize
minimum size
- maxSize
maximum size
- Definition Classes
- PactDslJsonArray → DslPart
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
nullValue(): PactDslJsonArray
Adds a null value to the list
-
def
number(value: Number): PactDslJsonArray
Element that must be the specified value
Element that must be the specified value
- value
number value
-
def
numberType(number: Number): PactDslJsonArray
Element that can be any number
Element that can be any number
- number
example number to use for generated bodies
-
def
numberType(): PactDslJsonArray
Element that can be any number
- def numberValue(value: Number): PactDslJsonArray
-
def
object(): PactDslJsonBody
Element that is a JSON object
Element that is a JSON object
- Definition Classes
- PactDslJsonArray → DslPart
-
def
object(name: String): PactDslJsonBody
Object field
-
def
or(value: Any, rules: <repeated...>[MatchingRule]): PactDslJsonArray
Combine all the matchers using OR
Combine all the matchers using OR
- value
Attribute example value
- rules
Matching rules to apply
-
def
putArray(object: DslPart): Unit
- Attributes
- protected[au.com.dius.pact.consumer.dsl]
- Definition Classes
- PactDslJsonArray → DslPart
-
def
putObject(object: DslPart): Unit
- Attributes
- protected[au.com.dius.pact.consumer.dsl]
- Definition Classes
- PactDslJsonArray → DslPart
-
def
regexp(regex: String): RegexMatcher
- Attributes
- protected[au.com.dius.pact.consumer.dsl]
- Definition Classes
- DslPart
-
def
setGenerators(generators: Generators): Unit
- Definition Classes
- DslPart
-
def
setMatchers(matchers: Category): Unit
- Definition Classes
- DslPart
-
def
setNumberExamples(numberExamples: Int): Unit
Sets the number of example elements to generate for sample bodies
-
def
string(value: String): PactDslJsonArray
Element that must be the specified value
Element that must be the specified value
- value
string value
-
def
stringMatcher(regex: String, value: String): PactDslJsonArray
Element that must match the regular expression
Element that must match the regular expression
- regex
regular expression
- value
example value to use for generated bodies
-
def
stringType(example: String): PactDslJsonArray
Element that can be any string
Element that can be any string
- example
example value to use for generated bodies
-
def
stringType(): PactDslJsonArray
Element that can be any string
-
def
stringValue(value: String): PactDslJsonArray
Element that must be the specified value
Element that must be the specified value
- value
string value
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
template(template: DslPart, occurrences: Int): PactDslJsonArray
Adds a number of template objects to the array
Adds a number of template objects to the array
- template
template object
- occurrences
number to add
-
def
template(template: DslPart): PactDslJsonArray
Adds the template object to the array
Adds the template object to the array
- template
template object
-
def
time(format: String, example: Date): PactDslJsonArray
Element that must match the given time format
Element that must match the given time format
- format
time format to match
- example
example time to use for generated bodies
-
def
time(format: String): PactDslJsonArray
Element that must match the given time format
Element that must match the given time format
- format
time format to match
-
def
time(): PactDslJsonArray
Element that must be an ISO formatted time
-
def
timestamp(format: String, example: Date): PactDslJsonArray
Element that must match the given timestamp format
Element that must match the given timestamp format
- format
timestamp format
- example
example date and time to use for generated bodies
-
def
timestamp(format: String): PactDslJsonArray
Element that must match the given timestamp format
Element that must match the given timestamp format
- format
timestamp format
-
def
timestamp(): PactDslJsonArray
Element that must be an ISO formatted timestamp
-
def
toString(): String
- Definition Classes
- PactDslJsonArray → AnyRef → Any
-
def
uuid(uuid: String): PactDslJsonArray
Element that must be encoded as an UUID
Element that must be encoded as an UUID
- uuid
example UUID to use for generated bodies
-
def
uuid(): PactDslJsonArray
Element that must be encoded as an UUID
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
Deprecated Value Members
-
def
arrayLike(): PactDslJsonBody
Element that is an array where each item must match the following example
Element that is an array where each item must match the following example
- Definition Classes
- PactDslJsonArray → DslPart
- Deprecated
use eachLike
-
def
arrayLike(name: String): PactDslJsonBody
Array field where each element must match the following object
Array field where each element must match the following object
- name
field name
- Definition Classes
- PactDslJsonArray → DslPart
- Deprecated
Use eachLike instead
-
def
guid(uuid: String): PactDslJsonArray
Element that must be encoded as a GUID
Element that must be encoded as a GUID
- uuid
example UUID to use for generated bodies
- Deprecated
use uuid instead
-
def
guid(): PactDslJsonArray
Element that must be encoded as a GUID
Element that must be encoded as a GUID
- Deprecated
use uuid instead
-
def
realType(number: Double): PactDslJsonArray
Element that must be a real value
Element that must be a real value
- number
example real value
- Deprecated
Use decimalType instead
-
def
realType(): PactDslJsonArray
Element that must be a real value
Element that must be a real value
- Deprecated
Use decimalType instead
-
def
stringMatcher(regex: String): PactDslJsonArray
Element that must match the regular expression
Element that must match the regular expression
- regex
regular expression
- Deprecated
Use the version that takes an example value