net.jadler.matchers

Class BodyRequestMatcher

java.lang.Object

org.hamcrest.BaseMatcher<Request>

net.jadler.matchers.RequestMatcher<String>

net.jadler.matchers.BodyRequestMatcher

All Implemented Interfaces:

org.hamcrest.Matcher<Request>, org.hamcrest.SelfDescribing

public class BodyRequestMatcher
extends RequestMatcher<String>

A RequestMatcher used for matching the request body as a string.

Field Summary

Fields inherited from class net.jadler.matchers.RequestMatcher

pred

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BodyRequestMatcher(org.hamcrest.Matcher<? super String> pred) Protected constructor useful only when subtyping.

Method Summary

Modifier and Type	Method and Description
protected String	provideDescription() Provides a description of this matcher in form of a string consisting of "noun verb", where noun describes the value retrieved using RequestMatcher.retrieveValue(net.jadler.Request) and verb is usually a correct form of to be.
static BodyRequestMatcher	requestBody(org.hamcrest.Matcher<? super String> pred) Factory method to create new instance of this matcher.
protected String	retrieveValue(Request req) Retrieves the body of the given request

Methods inherited from class net.jadler.matchers.RequestMatcher

describeMismatch, describeTo, matches

Methods inherited from class org.hamcrest.BaseMatcher

_dont_implement_Matcher___instead_extend_BaseMatcher_, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BodyRequestMatcher

protected BodyRequestMatcher(org.hamcrest.Matcher<? super String> pred)

Protected constructor useful only when subtyping. For creating instances of this class use requestBody(org.hamcrest.Matcher) instead.

Parameters:

pred - a predicate to be applied on the request body

Method Detail

retrieveValue

protected String retrieveValue(Request req)

Retrieves the body of the given request

Specified by:

retrieveValue in class RequestMatcher<String>

Parameters:

req - request to retrieve the body from

Returns:

request body as a string (never returns null)

provideDescription

protected String provideDescription()

Provides a description of this matcher in form of a string consisting of "noun verb", where noun describes the value retrieved using RequestMatcher.retrieveValue(net.jadler.Request) and verb is usually a correct form of to be.

If the RequestMatcher.retrieveValue(net.jadler.Request) provided a request method, this method would return method is string for example.

Specified by:

provideDescription in class RequestMatcher<String>

Returns:

matcher description

requestBody

public static BodyRequestMatcher requestBody(org.hamcrest.Matcher<? super String> pred)

Factory method to create new instance of this matcher.

Parameters:

pred - a predicate to be applied on the request body

Returns:

new instance of this matcher