Constructor Detail

• MetadataBuilder

  MetadataBuilder(Map<String, Object> values, MatchingRuleCategory matchers, Map<String, Generator> generators)

Method Detail

• getValues

   final Map<String, Object> getValues()

• getMatchers

   final MatchingRuleCategory getMatchers()

• getGenerators

   final Map<String, Generator> getGenerators()

• add

   final MetadataBuilder add(String key, Object value)

  Add an entry to the metadata

• like

   final MetadataBuilder like(String name, Object example)

  Attribute that must be the same type as the example

  Parameters:

  name - attribute name

• numberType

   final MetadataBuilder numberType(String name, Number number)

  Attribute that can be any number

  Parameters:

  name - attribute name

  number - example number to use for generated messages

• integerType

   final MetadataBuilder integerType(String name, Long number)

  Attribute that must be an integer

  Parameters:

  name - attribute name

  number - example integer value to use for generated messages

• integerType

   final MetadataBuilder integerType(String name, Integer number)

  Attribute that must be an integer

  Parameters:

  name - attribute name

  number - example integer value to use for generated messages

• decimalType

   final MetadataBuilder decimalType(String name, BigDecimal number)

  Attribute that must be a decimalType value

  Parameters:

  name - attribute name

  number - example decimalType value

• decimalType

   final MetadataBuilder decimalType(String name, Double number)

  Attribute that must be a decimalType value

  Parameters:

  name - attribute name

  number - example decimalType value

• booleanType

   final MetadataBuilder booleanType(String name, Boolean example)

  Attribute that must be a boolean

  Parameters:

  name - attribute name

  example - example boolean to use for generated bodies

• matchRegex

   final MetadataBuilder matchRegex(String name, String regex, String value)

  Attribute that must match the regular expression

  Parameters:

  name - attribute name

  regex - regular expression

  value - example value to use for generated bodies

• datetime

   final MetadataBuilder datetime(String name)

  Attribute that must be an ISO formatted datetime

• datetime

   final MetadataBuilder datetime(String name, String format)

  Attribute that must match the given datetime format

  Parameters:

  name - attribute name

  format - datetime format

• datetime

   final MetadataBuilder datetime(String name, String format, 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

   final MetadataBuilder datetime(String name, String format, Date example, 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

   final MetadataBuilder datetime(String name, String format, 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

   final MetadataBuilder datetime(String name, String format, Instant example, 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

   final MetadataBuilder date(String name)

  Attribute that must be formatted as an ISO date

  Parameters:

  name - attribute name

• date

   final MetadataBuilder date(String name, String format)

  Attribute that must match the provided date format

  Parameters:

  name - attribute date

  format - date format to match

• date

   final MetadataBuilder date(String name, String format, 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

   final MetadataBuilder date(String name, String format, Date example, 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

   final MetadataBuilder time(String name)

  Attribute that must be an ISO formatted time

  Parameters:

  name - attribute name

• time

   final MetadataBuilder time(String name, String format)

  Attribute that must match the given time format

  Parameters:

  name - attribute name

  format - time format to match

• time

   final MetadataBuilder time(String name, String format, 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

   final MetadataBuilder time(String name, String format, Date example, 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

• ipAddress

   final MetadataBuilder ipAddress(String name)

  Attribute that must be an IP4 address

  Parameters:

  name - attribute name

• hexValue

   final MetadataBuilder hexValue(String name)

  Attribute that must be encoded as a hexadecimal value

  Parameters:

  name - attribute name

• hexValue

   final MetadataBuilder hexValue(String name, String hexValue)

  Attribute that must be encoded as a hexadecimal value

  Parameters:

  name - attribute name

  hexValue - example value to use for generated bodies

• uuid

   final MetadataBuilder uuid(String name)

  Attribute that must be encoded as an UUID

  Parameters:

  name - attribute name

• uuid

   final MetadataBuilder uuid(String name, UUID uuid)

  Attribute that must be encoded as an UUID

  Parameters:

  name - attribute name

  uuid - example UUID to use for generated bodies

• uuid

   final MetadataBuilder uuid(String name, String uuid)

  Attribute that must be encoded as an UUID

  Parameters:

  name - attribute name

  uuid - example UUID to use for generated bodies

• includesStr

   final MetadataBuilder includesStr(String name, String value)

  Attribute that must include the provided string value

  Parameters:

  name - attribute name

  value - Value that must be included

• matchUrl

   final MetadataBuilder matchUrl(String name, String basePath, Object pathFragments)

  Matches a URL that is composed of a base path and a sequence of path expressions

  Parameters:

  name - Attribute name

  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.

• valueFromProviderState

   final MetadataBuilder valueFromProviderState(String name, String expression, Object 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

   final MetadataBuilder dateExpression(String name, 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

   final MetadataBuilder dateExpression(String name, String expression, 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

   final MetadataBuilder timeExpression(String name, 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

   final MetadataBuilder timeExpression(String name, String expression, 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

   final MetadataBuilder datetimeExpression(String name, 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

   final MetadataBuilder datetimeExpression(String name, String expression, 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