Package net.jadler.matchers

Class RequestMatcher<T>

java.lang.Object

org.hamcrest.BaseMatcher<Request>

net.jadler.matchers.RequestMatcher<T>

Type Parameters:

T - type of the value retrieved from the given request to be matched

All Implemented Interfaces:

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

Direct Known Subclasses:

BodyRequestMatcher, HeaderRequestMatcher, MethodRequestMatcher, ParameterRequestMatcher, PathRequestMatcher, QueryStringRequestMatcher, RawBodyRequestMatcher

public abstract class RequestMatcher<T>
extends org.hamcrest.BaseMatcher<Request>

Convenient base class for all Jadler request matchers.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.hamcrest.Matcher<? super T>	pred

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RequestMatcher(org.hamcrest.Matcher<? super T> pred)

Method Summary

Modifier and Type	Method	Description
void	describeMismatch(Object item, org.hamcrest.Description description)
void	describeTo(org.hamcrest.Description description)
boolean	matches(Object o)	Checks whether the given Request object matches this matcher.
protected abstract String	provideDescription()	Provides a description of this matcher in form of a string consisting of "noun verb", where noun describes the value retrieved using retrieveValue(net.jadler.Request) and verb is usually a correct form of to be.
protected abstract T	retrieveValue(Request req)	Reads a value of the given request object (the value can be anything retrievable from the request object: method, header, body,...).

Methods inherited from class org.hamcrest.BaseMatcher

_dont_implement_Matcher___instead_extend_BaseMatcher_, isNotNull, toString

Methods inherited from class java.lang.Object

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

Field Detail

pred

protected final org.hamcrest.Matcher<? super T> pred

Constructor Detail

RequestMatcher

protected RequestMatcher(org.hamcrest.Matcher<? super T> pred)

Parameters:

pred - predicate to be applied on the value retrieved from the given request (cannot be null)

Method Detail

describeMismatch

public void describeMismatch(Object item,
                             org.hamcrest.Description description)

Specified by:

describeMismatch in interface org.hamcrest.Matcher<T>

Overrides:

describeMismatch in class org.hamcrest.BaseMatcher<Request>

describeTo

public void describeTo(org.hamcrest.Description description)

matches

public boolean matches(Object o)

Checks whether the given Request object matches this matcher.

Parameters:

o - Request object to be matched by this matcher. If this param is not of type Request this method will always return false.

Returns:

true if the value retrieved using retrieveValue(net.jadler.Request) from the given Request object matches the predicate registered by the RequestMatcher(org.hamcrest.Matcher), otherwise false.

retrieveValue

protected abstract T retrieveValue(Request req)
                            throws Exception

Reads a value of the given request object (the value can be anything retrievable from the request object: method, header, body,...).

Parameters:

req - request object to read a value from

Returns:

a value retrieved from the given request object.

Throws:

Exception - when something goes wrong. This exception will be handler correctly by Jadler.

provideDescription

protected abstract String provideDescription()

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

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

Returns:

matcher description