au.com.dius.pact.consumer.dsl

Class FormPostBuilder

au.com.dius.pact.consumer.dsl.FormPostBuilder

All Implemented Interfaces:

BodyBuilder

public class FormPostBuilder
implements BodyBuilder

Builder for constructing application/x-www-form-urlencoded bodies

Field Detail

ROOT

@NotNull
public static java.lang.String ROOT

See Also:

Constant Field Values

Companion

public static au.com.dius.pact.consumer.dsl.FormPostBuilder.Companion Companion

Constructor Detail

FormPostBuilder

public FormPostBuilder(@NotNull
                       java.util.Map<java.lang.String,java.util.List> body,
                       @NotNull
                       au.com.dius.pact.core.model.ContentType contentType,
                       @NotNull
                       au.com.dius.pact.core.model.matchingrules.Category matchers,
                       @NotNull
                       au.com.dius.pact.core.model.generators.Generators generators)

Builder for constructing application/x-www-form-urlencoded bodies

FormPostBuilder

public FormPostBuilder()

Builder for constructing application/x-www-form-urlencoded bodies

FormPostBuilder

public FormPostBuilder(@NotNull
                       au.com.dius.pact.core.model.ContentType contentType)

Method Detail

stringValue

@NotNull
public FormPostBuilder stringValue(@NotNull
                                            java.lang.String name,
                                            @NotNull
                                            java.lang.String value)

Attribute that must be have the specified value

Parameters:

name - attribute name

value - string value

stringValue

@NotNull
public FormPostBuilder stringValue(@NotNull
                                            java.lang.String name,
                                            @NotNull
                                            java.lang.String... values)

Attribute that must be have the specified values

Parameters:

name - attribute name

values - string values

stringMatcher

@NotNull
public FormPostBuilder stringMatcher(@NotNull
                                              java.lang.String name,
                                              @NotNull
                                              java.lang.String regex,
                                              @NotNull
                                              java.lang.String value)

Attribute that must match the regular expression

Parameters:

name - attribute name

regex - regular expression

value - example value to use for generated bodies

stringMatcher

@NotNull
public FormPostBuilder stringMatcher(@NotNull
                                              java.lang.String name,
                                              @NotNull
                                              java.lang.String regex,
                                              @NotNull
                                              java.lang.String... values)

Attribute that must match the regular expression

Parameters:

name - attribute name

regex - regular expression

values - example values to use for generated bodies

stringMatcher

@NotNull
public FormPostBuilder stringMatcher(@NotNull
                                              java.lang.String name,
                                              @NotNull
                                              java.lang.String regex)

Attribute that must match the regular expression

Parameters:

name - attribute name

regex - regular expression

datetime

@NotNull
public FormPostBuilder datetime(@NotNull
                                         java.lang.String name)

Attribute that must be an ISO formatted datetime

Parameters:

name -

datetime

@NotNull
public FormPostBuilder datetime(@NotNull
                                         java.lang.String name,
                                         @NotNull
                                         java.lang.String format)

Attribute that must match the given datetime format

Parameters:

name - attribute name

format - datetime format

datetime

@NotNull
public FormPostBuilder datetime(@NotNull
                                         java.lang.String name,
                                         @NotNull
                                         java.lang.String format,
                                         @NotNull
                                         java.util.Date example)

Attribute that must match the given datetime format

Parameters:

name - attribute name

format - datetime format

example - example date and time to use for generated bodies

datetime

@NotNull
public FormPostBuilder datetime(@NotNull
                                         java.lang.String name,
                                         @NotNull
                                         java.lang.String format,
                                         @NotNull
                                         java.util.Date example,
                                         @NotNull
                                         java.util.TimeZone timeZone)

Attribute that must match the given datetime format

Parameters:

name - attribute name

format - datetime format

example - example date and time to use for generated bodies

timeZone - time zone used for formatting of example date and time

datetime

@NotNull
public FormPostBuilder datetime(@NotNull
                                         java.lang.String name,
                                         @NotNull
                                         java.lang.String format,
                                         @NotNull
                                         java.time.Instant example)

Attribute that must match the given datetime format

Parameters:

name - attribute name

format - datetime format

example - example date and time to use for generated bodies

datetime

@NotNull
public FormPostBuilder datetime(@NotNull
                                         java.lang.String name,
                                         @NotNull
                                         java.lang.String format,
                                         @NotNull
                                         java.time.Instant example,
                                         @NotNull
                                         java.util.TimeZone timeZone)

Attribute that must match the given datetime format

Parameters:

name - attribute name

format - timestamp format

example - example date and time to use for generated bodies

timeZone - time zone used for formatting of example date and time

date

@NotNull
public FormPostBuilder date(@NotNull
                                     java.lang.String name)

Attribute that must be formatted as an ISO date

Parameters:

name - attribute name

date

@NotNull
public FormPostBuilder date(@NotNull
                                     java.lang.String name,
                                     @NotNull
                                     java.lang.String format)

Attribute that must match the provided date format

Parameters:

name - attribute date

format - date format to match

date

@NotNull
public FormPostBuilder date(@NotNull
                                     java.lang.String name,
                                     @NotNull
                                     java.lang.String format,
                                     @NotNull
                                     java.util.Date example)

Attribute that must match the provided date format

Parameters:

name - attribute date

format - date format to match

example - example date to use for generated values

date

@NotNull
public FormPostBuilder date(@NotNull
                                     java.lang.String name,
                                     @NotNull
                                     java.lang.String format,
                                     @NotNull
                                     java.util.Date example,
                                     @NotNull
                                     java.util.TimeZone timeZone)

Attribute that must match the provided date format

Parameters:

name - attribute date

format - date format to match

example - example date to use for generated values

timeZone - time zone used for formatting of example date

time

@NotNull
public FormPostBuilder time(@NotNull
                                     java.lang.String name)

Attribute that must be an ISO formatted time

Parameters:

name - attribute name

time

@NotNull
public FormPostBuilder time(@NotNull
                                     java.lang.String name,
                                     @NotNull
                                     java.lang.String format)

Attribute that must match the given time format

Parameters:

name - attribute name

format - time format to match

time

@NotNull
public FormPostBuilder time(@NotNull
                                     java.lang.String name,
                                     @NotNull
                                     java.lang.String format,
                                     @NotNull
                                     java.util.Date example)

Attribute that must match the given time format

Parameters:

name - attribute name

format - time format to match

example - example time to use for generated bodies

time

@NotNull
public FormPostBuilder time(@NotNull
                                     java.lang.String name,
                                     @NotNull
                                     java.lang.String format,
                                     @NotNull
                                     java.util.Date example,
                                     @NotNull
                                     java.util.TimeZone timeZone)

Attribute that must match the given time format

Parameters:

name - attribute name

format - time format to match

example - example time to use for generated bodies

timeZone - time zone used for formatting of example time

hexValue

@NotNull
public FormPostBuilder hexValue(@NotNull
                                         java.lang.String name)

Attribute that must be encoded as a hexadecimal value

Parameters:

name - attribute name

hexValue

@NotNull
public FormPostBuilder hexValue(@NotNull
                                         java.lang.String name,
                                         @NotNull
                                         java.lang.String hexValue)

Attribute that must be encoded as a hexadecimal value

Parameters:

name - attribute name

hexValue - example value to use for generated bodies

uuid

@NotNull
public FormPostBuilder uuid(@NotNull
                                     java.lang.String name)

Attribute that must be encoded as an UUID

Parameters:

name - attribute name

uuid

@NotNull
public FormPostBuilder uuid(@NotNull
                                     java.lang.String name,
                                     @NotNull
                                     java.util.UUID uuid)

Attribute that must be encoded as an UUID

Parameters:

name - attribute name

uuid - example UUID to use for generated bodies

uuid

@NotNull
public FormPostBuilder uuid(@NotNull
                                     java.lang.String name,
                                     @NotNull
                                     java.lang.String uuid)

Attribute that must be encoded as an UUID

Parameters:

name - attribute name

uuid - example UUID to use for generated bodies

includesString

@NotNull
public FormPostBuilder includesString(@NotNull
                                               java.lang.String name,
                                               @NotNull
                                               java.lang.String value)

Attribute that must include the provided string value

Parameters:

name - attribute name

value - Value that must be included

parameterFromProviderState

@NotNull
public FormPostBuilder parameterFromProviderState(@NotNull
                                                           java.lang.String name,
                                                           @NotNull
                                                           java.lang.String expression,
                                                           @NotNull
                                                           java.lang.String example)

Adds an attribute that will have it's value injected from the provider state

Parameters:

name - Attribute name

expression - Expression to be evaluated from the provider state

example - Example value to be used in the consumer test

dateExpression

@NotNull
public FormPostBuilder dateExpression(@NotNull
                                               java.lang.String name,
                                               @NotNull
                                               java.lang.String expression)

Adds a date attribute formatted as an ISO date with the value generated by the date expression

Parameters:

name - Attribute name

expression - Date expression to use to generate the values

dateExpression

@NotNull
public FormPostBuilder dateExpression(@NotNull
                                               java.lang.String name,
                                               @NotNull
                                               java.lang.String expression,
                                               @NotNull
                                               java.lang.String format)

Adds a date attribute with the value generated by the date expression

Parameters:

name - Attribute name

expression - Date expression to use to generate the values

format - Date format to use

timeExpression

@NotNull
public FormPostBuilder timeExpression(@NotNull
                                               java.lang.String name,
                                               @NotNull
                                               java.lang.String expression)

Adds a time attribute formatted as an ISO time with the value generated by the time expression

Parameters:

name - Attribute name

expression - Time expression to use to generate the values

timeExpression

@NotNull
public FormPostBuilder timeExpression(@NotNull
                                               java.lang.String name,
                                               @NotNull
                                               java.lang.String expression,
                                               @NotNull
                                               java.lang.String format)

Adds a time attribute with the value generated by the time expression

Parameters:

name - Attribute name

expression - Time expression to use to generate the values

format - Time format to use

datetimeExpression

@NotNull
public FormPostBuilder datetimeExpression(@NotNull
                                                   java.lang.String name,
                                                   @NotNull
                                                   java.lang.String expression)

Adds a datetime attribute formatted as an ISO datetime with the value generated by the expression

Parameters:

name - Attribute name

expression - Datetime expression to use to generate the values

datetimeExpression

@NotNull
public FormPostBuilder datetimeExpression(@NotNull
                                                   java.lang.String name,
                                                   @NotNull
                                                   java.lang.String expression,
                                                   @NotNull
                                                   java.lang.String format)

Adds a datetime attribute with the value generated by the expression

Parameters:

name - Attribute name

expression - Datetime expression to use to generate the values

format - Datetime format to use

getMatchers

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

getGenerators

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

getContentType

@NotNull
public au.com.dius.pact.core.model.ContentType getContentType()

buildBody

@NotNull
public kotlin.Array[] buildBody()

getBody

@NotNull
public java.util.Map<java.lang.String,java.util.List> getBody()