au.com.dius.pact.consumer.dsl

Class PactDslRootValue.Companion

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

Enclosing class:

PactDslRootValue

public static class PactDslRootValue.Companion

Method Detail

stringType

@JvmStatic
 @NotNull
public PactDslRootValue stringType()

Value that can be any string

stringType

@JvmStatic
 @NotNull
public PactDslRootValue 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 PactDslRootValue numberType()

Value that can be any number

numberType

@JvmStatic
 @NotNull
public PactDslRootValue 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 PactDslRootValue integerType()

Value that must be an integer

integerType

@JvmStatic
 @NotNull
public PactDslRootValue integerType(long number)

Value that must be an integer

Parameters:

number - example integer value to use for generated bodies

integerType

@JvmStatic
 @NotNull
public PactDslRootValue integerType(int number)

Value that must be an integer

Parameters:

number - example integer value to use for generated bodies

decimalType

@JvmStatic
 @NotNull
public PactDslRootValue decimalType()

Value that must be a decimal value

decimalType

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

Value that must be a decimalType value

Parameters:

number - example decimalType value

decimalType

@JvmStatic
 @NotNull
public PactDslRootValue decimalType(double number)

Value that must be a decimalType value

Parameters:

number - example decimalType value

booleanType

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

Value that must be a boolean

Parameters:

example - example boolean to use for generated bodies

booleanType

@JvmOverloads
 @JvmStatic
 @NotNull
public PactDslRootValue booleanType()

Value that must be a boolean

stringMatcher

@JvmStatic
 @NotNull
public PactDslRootValue 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

timestamp

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

Value that must match the given timestamp format

Parameters:

format - timestamp format

timestamp

@JvmOverloads
 @JvmStatic
 @NotNull
public PactDslRootValue timestamp()

Value that must match the given timestamp format

timestamp

@JvmStatic
 @NotNull
public PactDslRootValue timestamp(@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 PactDslRootValue 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 PactDslRootValue date()

Value that must match the provided date format

date

@JvmStatic
 @NotNull
public PactDslRootValue 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 PactDslRootValue 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 PactDslRootValue time()

Value that must match the given time format

time

@JvmStatic
 @NotNull
public PactDslRootValue 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 PactDslRootValue ipAddress()

Value that must be an IP4 address

id

@JvmStatic
 @NotNull
public PactDslRootValue id()

Value that must be a numeric identifier

id

@JvmStatic
 @NotNull
public PactDslRootValue id(long id)

Value that must be a numeric identifier

Parameters:

id - example id to use for generated bodies

hexValue

@JvmStatic
 @NotNull
public PactDslRootValue hexValue()

Value that must be encoded as a hexadecimal value

hexValue

@JvmStatic
 @NotNull
public PactDslRootValue 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 PactDslRootValue uuid()

Value that must be encoded as an UUID

uuid

@JvmStatic
 @NotNull
public PactDslRootValue 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 PactDslRootValue 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 PactDslRootValue 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 PactDslRootValue 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 PactDslRootValue 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