au.com.dius.pact.consumer.dsl

Class PactDslJsonRootValue.Companion

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

Enclosing class:

PactDslJsonRootValue

public static class PactDslJsonRootValue.Companion

Method Detail

stringType

@JvmStatic
 @NotNull
public PactDslJsonRootValue stringType()

Value that can be any string

stringType

@JvmStatic
 @NotNull
public PactDslJsonRootValue stringType(@NotNull
                                                            java.lang.String example)

Value that can be any string

Parameters:

example - example value to use for generated bodies

numberType

@JvmStatic
 @NotNull
public PactDslJsonRootValue numberType()

Value that can be any number

numberType

@JvmStatic
 @NotNull
public PactDslJsonRootValue numberType(@NotNull
                                                            java.lang.Number number)

Value that can be any number

Parameters:

number - example number to use for generated bodies

integerType

@JvmStatic
 @NotNull
public PactDslJsonRootValue integerType()

Value that must be an integer

integerType

@JvmStatic
 @NotNull
public PactDslJsonRootValue integerType(long number)

Value that must be an integer

Parameters:

number - example integer value to use for generated bodies

integerType

@JvmStatic
 @NotNull
public PactDslJsonRootValue integerType(int number)

Value that must be an integer

Parameters:

number - example integer value to use for generated bodies

decimalType

@JvmStatic
 @NotNull
public PactDslJsonRootValue decimalType()

Value that must be a decimal value

decimalType

@JvmStatic
 @NotNull
public PactDslJsonRootValue decimalType(@NotNull
                                                             java.math.BigDecimal number)

Value that must be a decimalType value

Parameters:

number - example decimalType value

decimalType

@JvmStatic
 @NotNull
public PactDslJsonRootValue decimalType(double number)

Value that must be a decimalType value

Parameters:

number - example decimalType value

booleanType

@JvmOverloads
 @JvmStatic
 @NotNull
public PactDslJsonRootValue booleanType(boolean example)

Value that must be a boolean

Parameters:

example - example boolean to use for generated bodies

booleanType

@JvmOverloads
 @JvmStatic
 @NotNull
public PactDslJsonRootValue booleanType()

Value that must be a boolean

stringMatcher

@JvmStatic
 @NotNull
public PactDslJsonRootValue stringMatcher(@NotNull
                                                               java.lang.String regex,
                                                               @NotNull
                                                               java.lang.String value)

Value that must match the regular expression

Parameters:

regex - regular expression

value - example value to use for generated bodies

stringMatcher

@Deprecated
 @JvmStatic
 @NotNull
public PactDslJsonRootValue stringMatcher(@NotNull
                                                                            java.lang.String regex)

Deprecated.

Value that must match the regular expression

Parameters:

regex - regular expression

timestamp

@JvmOverloads
 @Deprecated
 @JvmStatic
 @NotNull
public PactDslJsonRootValue timestamp(@NotNull
                                                                                       java.lang.String format)

Deprecated.

Value that must match the given timestamp format

Parameters:

format - timestamp format

timestamp

@JvmOverloads
 @Deprecated
 @JvmStatic
 @NotNull
public PactDslJsonRootValue timestamp()

Deprecated.

Value that must match the given timestamp format

timestamp

@Deprecated
 @JvmStatic
 @NotNull
public PactDslJsonRootValue timestamp(@NotNull
                                                                        java.lang.String format,
                                                                        @NotNull
                                                                        java.util.Date example)

Deprecated.

Value that must match the given timestamp format

Parameters:

format - timestamp format

example - example date and time to use for generated bodies

datetime

@JvmOverloads
 @JvmStatic
 @NotNull
public PactDslJsonRootValue datetime(@NotNull
                                                                         java.lang.String format)

Value that must match the given timestamp format

Parameters:

format - timestamp format

datetime

@JvmOverloads
 @JvmStatic
 @NotNull
public PactDslJsonRootValue datetime()

Value that must match the given timestamp format

datetime

@JvmStatic
 @NotNull
public PactDslJsonRootValue datetime(@NotNull
                                                          java.lang.String format,
                                                          @NotNull
                                                          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

@JvmOverloads
 @JvmStatic
 @NotNull
public PactDslJsonRootValue date(@NotNull
                                                                     java.lang.String format)

Value that must match the provided date format

Parameters:

format - date format to match

date

@JvmOverloads
 @JvmStatic
 @NotNull
public PactDslJsonRootValue date()

Value that must match the provided date format

date

@JvmStatic
 @NotNull
public PactDslJsonRootValue date(@NotNull
                                                      java.lang.String format,
                                                      @NotNull
                                                      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

@JvmOverloads
 @JvmStatic
 @NotNull
public PactDslJsonRootValue time(@NotNull
                                                                     java.lang.String format)

Value that must match the given time format

Parameters:

format - time format to match

time

@JvmOverloads
 @JvmStatic
 @NotNull
public PactDslJsonRootValue time()

Value that must match the given time format

time

@JvmStatic
 @NotNull
public PactDslJsonRootValue time(@NotNull
                                                      java.lang.String format,
                                                      @NotNull
                                                      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

@JvmStatic
 @NotNull
public PactDslJsonRootValue ipAddress()

Value that must be an IP4 address

id

@JvmStatic
 @NotNull
public PactDslJsonRootValue id()

Value that must be a numeric identifier

id

@JvmStatic
 @NotNull
public PactDslJsonRootValue id(long id)

Value that must be a numeric identifier

Parameters:

id - example id to use for generated bodies

hexValue

@JvmStatic
 @NotNull
public PactDslJsonRootValue hexValue()

Value that must be encoded as a hexadecimal value

hexValue

@JvmStatic
 @NotNull
public PactDslJsonRootValue hexValue(@NotNull
                                                          java.lang.String hexValue)

Value that must be encoded as a hexadecimal value

Parameters:

hexValue - example value to use for generated bodies

uuid

@JvmStatic
 @NotNull
public PactDslJsonRootValue uuid()

Value that must be encoded as an UUID

uuid

@JvmStatic
 @NotNull
public PactDslJsonRootValue uuid(@NotNull
                                                      java.util.UUID uuid)

Value that must be encoded as an UUID

Parameters:

uuid - example UUID to use for generated bodies

uuid

@JvmStatic
 @NotNull
public PactDslJsonRootValue uuid(@NotNull
                                                      java.lang.String uuid)

Value that must be encoded as an UUID

Parameters:

uuid - example UUID to use for generated bodies

and

@JvmStatic
 @NotNull
public PactDslJsonRootValue and(@Nullable
                                                     java.lang.Object example,
                                                     @NotNull
                                                     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

@JvmStatic
 @NotNull
public PactDslJsonRootValue or(@Nullable
                                                    java.lang.Object example,
                                                    @NotNull
                                                    au.com.dius.pact.core.model.matchingrules.MatchingRule... rules)

Combine all the matchers using OR

Parameters:

example - Attribute name

rules - Matching rules to apply

valueFromProviderState

@JvmStatic
 @NotNull
public PactDslJsonRootValue valueFromProviderState(@NotNull
                                                                        java.lang.String expression,
                                                                        @Nullable
                                                                        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

@JvmOverloads
 @JvmStatic
 @NotNull
public PactDslJsonRootValue dateExpression(@NotNull
                                                                               java.lang.String expression,
                                                                               @NotNull
                                                                               java.lang.String format)

Date value generated from an expression.

Parameters:

expression - Date expression

format - Date format to use

dateExpression

@JvmOverloads
 @JvmStatic
 @NotNull
public PactDslJsonRootValue dateExpression(@NotNull
                                                                               java.lang.String expression)

Date value generated from an expression.

Parameters:

expression - Date expression

timeExpression

@JvmOverloads
 @JvmStatic
 @NotNull
public PactDslJsonRootValue timeExpression(@NotNull
                                                                               java.lang.String expression,
                                                                               @NotNull
                                                                               java.lang.String format)

Time value generated from an expression.

Parameters:

expression - Time expression

format - Time format to use

timeExpression

@JvmOverloads
 @JvmStatic
 @NotNull
public PactDslJsonRootValue timeExpression(@NotNull
                                                                               java.lang.String expression)

Time value generated from an expression.

Parameters:

expression - Time expression

datetimeExpression

@JvmOverloads
 @JvmStatic
 @NotNull
public PactDslJsonRootValue datetimeExpression(@NotNull
                                                                                   java.lang.String expression,
                                                                                   @NotNull
                                                                                   java.lang.String format)

Datetime value generated from an expression.

Parameters:

expression - Datetime expression

format - Datetime format to use

datetimeExpression

@JvmOverloads
 @JvmStatic
 @NotNull
public PactDslJsonRootValue datetimeExpression(@NotNull
                                                                                   java.lang.String expression)

Datetime value generated from an expression.

Parameters:

expression - Datetime expression