Package net.jadler.matchers

Class ParameterRequestMatcher

java.lang.Object

org.hamcrest.BaseMatcher<Request>

net.jadler.matchers.RequestMatcher<List<String>>

net.jadler.matchers.ParameterRequestMatcher

All Implemented Interfaces:

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

public class ParameterRequestMatcher
extends RequestMatcher<List<String>>

A RequestMatcher used for matching a request parameter.

Field Summary

Fields inherited from class net.jadler.matchers.RequestMatcher

pred

Constructor Summary

Constructors

Constructor	Description
ParameterRequestMatcher(org.hamcrest.Matcher<? super List<String>> pred, String paramName)	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 ParameterRequestMatcher	requestParameter(String paramName, org.hamcrest.Matcher<? super List<String>> pred)	Factory method to create new instance of this matcher.
protected List<String>	retrieveValue(Request req)	Retrieves a parameter (defined in ParameterRequestMatcher(org.hamcrest.Matcher, java.lang.String)) 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

ParameterRequestMatcher

public ParameterRequestMatcher(org.hamcrest.Matcher<? super List<String>> pred,
                               String paramName)

Protected constructor useful only when subtyping. For creating instances of this class use requestParameter(java.lang.String, org.hamcrest.Matcher) instead.

Parameters:

pred - a predicate to be applied on the given request parameter

paramName - name of a request parameter (case sensitive)

Method Detail

requestParameter

public static ParameterRequestMatcher requestParameter(String paramName,
                                                       org.hamcrest.Matcher<? super List<String>> pred)

Factory method to create new instance of this matcher.

Parameters:

paramName - name of a request parameter

pred - a predicate to be applied on the request parameter

Returns:

new instance of this matcher

retrieveValue

protected List<String> retrieveValue(Request req)

Retrieves a parameter (defined in ParameterRequestMatcher(org.hamcrest.Matcher, java.lang.String)) of the given request. The values are percent-encoded.

Specified by:

retrieveValue in class RequestMatcher<List<String>>

Parameters:

req - request to retrieve the parameter from

Returns:

the request parameter as a list of values or null if there is no such a parameter in the request

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<List<String>>

Returns:

matcher description