Package net.jadler.matchers

Class QueryStringRequestMatcher

java.lang.Object

org.hamcrest.BaseMatcher<Request>

net.jadler.matchers.RequestMatcher<String>

net.jadler.matchers.QueryStringRequestMatcher

All Implemented Interfaces:

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

public class QueryStringRequestMatcher
extends RequestMatcher<String>

A RequestMatcher used for matching the request query string.

Field Summary

Fields inherited from class net.jadler.matchers.RequestMatcher

pred

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	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 QueryStringRequestMatcher	requestQueryString(org.hamcrest.Matcher<? super String> pred)	Factory method to create new instance of this matcher.
String	retrieveValue(Request req)	Retrieves the query string value 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_, isNotNull, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryStringRequestMatcher

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

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

Parameters:

pred - a predicate to be applied on the query string

Method Detail

requestQueryString

public static QueryStringRequestMatcher requestQueryString(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 query string

Returns:

new instance of this matcher

retrieveValue

public String retrieveValue(Request req)

Retrieves the query string value of the given request. The value is percent-encoded.

Specified by:

retrieveValue in class RequestMatcher<String>

Parameters:

req - request to retrieve the query string from

Returns:

query string value:

• null for requests without a query string part (no ? character)
• an empty string for request with an empty query string part (? is present but there is no actual query string value)
• query string value (without the leading ? character) for requests with a query string part

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