Package org.springframework.cloud.contract.spec.internal

Enum MatchingType

java.lang.Object

java.lang.Enum<MatchingType>

org.springframework.cloud.contract.spec.internal.MatchingType

All Implemented Interfaces:

Serializable, Comparable<MatchingType>, java.lang.constant.Constable

public enum MatchingType
extends Enum<MatchingType>

Represents the type of matching the should be done against the body of the request or response.

Since:

1.0.3

Author:

Marcin Grzejszczak, Tim Ysewyn, Olga Maciaszek-Sharma

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMMAND	The user can provide custom command to execute.
DATE	Special version of regex for date check.
EQUALITY	Verification by equality.
NULL	Verification if the value for the given path is null.
REGEX	Verification if the value for the given path matches the provided regex.
TIME	Special version of regex for time check.
TIMESTAMP	Special version of regex for timestamp check.
TYPE	Verification by type - is the type received in a body for the given path is of the same type.

Method Summary

Modifier and Type	Method	Description
static boolean	regexRelated(MatchingType type)
static MatchingType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MatchingType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EQUALITY

public static final MatchingType EQUALITY

Verification by equality.

TYPE

public static final MatchingType TYPE

Verification by type - is the type received in a body for the given path is of the same type. If it's a collection you can verify number of occurrences.

DATE

public static final MatchingType DATE

Special version of regex for date check.

TIME

public static final MatchingType TIME

Special version of regex for time check.

TIMESTAMP

public static final MatchingType TIMESTAMP

Special version of regex for timestamp check.

REGEX

public static final MatchingType REGEX

Verification if the value for the given path matches the provided regex.

COMMAND

public static final MatchingType COMMAND

The user can provide custom command to execute.

NULL

public static final MatchingType NULL

Verification if the value for the given path is null.

Method Details

values

public static MatchingType[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MatchingType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

regexRelated

public static boolean regexRelated(MatchingType type)