org.springframework.cloud.contract.spec.internal

Class BodyMatchers

java.lang.Object

org.springframework.cloud.contract.spec.internal.BodyMatchers

Direct Known Subclasses:

ResponseBodyMatchers

public class BodyMatchers
extends Object

Matching strategy of dynamic parts of the body.

Since:

1.0.3

Author:

Marcin Grzejszczak, Olga Maciaszek-Sharma, Tim Ysewyn

Field Summary

Fields

Modifier and Type	Field and Description
protected List<BodyMatcher>	matchers

Constructor Summary

Constructors

Constructor and Description
BodyMatchers()

Method Summary

Modifier and Type	Method and Description
MatchingTypeValue	byDate()
MatchingTypeValue	byEquality()
RegexMatchingTypeValue	byRegex(Pattern regex)
RegexMatchingTypeValue	byRegex(RegexProperty regex)
RegexMatchingTypeValue	byRegex(String regex)
MatchingTypeValue	byTime()
MatchingTypeValue	byTimestamp()
MatchingTypeValue	byType(groovy.lang.Closure consumer) The output part of the contract.
MatchingTypeValue	byType(Consumer<MatchingTypeValueHolder> consumer) The output part of the contract.
boolean	equals(Object o)
int	hashCode()
boolean	hasMatchers()
void	jsonPath(String path, MatchingTypeValue matchingType)
List<BodyMatcher>	jsonPathMatchers() Deprecated. usematchers()
List<BodyMatcher>	matchers()
String	toString()
void	xPath(String xPath, MatchingTypeValue matchingTypeValue) Adds xPath matcher; even though same implementation as in jsonPath(java.lang.String, org.springframework.cloud.contract.spec.internal.MatchingTypeValue), added for logical coherence in xml.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

matchers

protected final List<BodyMatcher> matchers

Constructor Detail

BodyMatchers

public BodyMatchers()

Method Detail

jsonPath

public void jsonPath(String path,
                     MatchingTypeValue matchingType)

xPath

public void xPath(String xPath,
                  MatchingTypeValue matchingTypeValue)

Adds xPath matcher; even though same implementation as in jsonPath(java.lang.String, org.springframework.cloud.contract.spec.internal.MatchingTypeValue), added for logical coherence in xml.

Parameters:

xPath - the xPath used to find the element to match

matchingTypeValue - to match the element found by the xPath against

jsonPathMatchers

@Deprecated
public List<BodyMatcher> jsonPathMatchers()

Deprecated. usematchers()

Returns:

json path matchers

hasMatchers

public boolean hasMatchers()

matchers

public List<BodyMatcher> matchers()

byDate

public MatchingTypeValue byDate()

byTime

public MatchingTypeValue byTime()

byTimestamp

public MatchingTypeValue byTimestamp()

byRegex

public RegexMatchingTypeValue byRegex(String regex)

byRegex

public RegexMatchingTypeValue byRegex(RegexProperty regex)

byRegex

public RegexMatchingTypeValue byRegex(Pattern regex)

byEquality

public MatchingTypeValue byEquality()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

byType

public MatchingTypeValue byType(Consumer<MatchingTypeValueHolder> consumer)

The output part of the contract.

Parameters:

consumer - function to manipulate the output message

Returns:

matching type

byType

public MatchingTypeValue byType(@DelegatesTo(value=MatchingTypeValueHolder.class)
                                groovy.lang.Closure consumer)

The output part of the contract.

Parameters:

consumer - function to manipulate the output message

Returns:

matching type