Package net.jadler.matchers

Class HeaderRequestMatcher

java.lang.Object

org.hamcrest.BaseMatcher<Request>

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

net.jadler.matchers.HeaderRequestMatcher

All Implemented Interfaces:

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

public class HeaderRequestMatcher
extends RequestMatcher<List<String>>

A RequestMatcher used for matching a request header.

Field Summary

Fields inherited from class net.jadler.matchers.RequestMatcher

pred

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HeaderRequestMatcher(org.hamcrest.Matcher<? super List<String>> pred, String headerName)	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 HeaderRequestMatcher	requestHeader(String headerName, org.hamcrest.Matcher<? super List<String>> pred)	Factory method to create new instance of this matcher.
protected List<String>	retrieveValue(Request req)	Retrieves a header (defined in HeaderRequestMatcher(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

HeaderRequestMatcher

protected HeaderRequestMatcher(org.hamcrest.Matcher<? super List<String>> pred,
                               String headerName)

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

Parameters:

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

headerName - name of a request header (case insensitive)

Method Detail

requestHeader

public static HeaderRequestMatcher requestHeader(String headerName,
                                                 org.hamcrest.Matcher<? super List<String>> pred)

Factory method to create new instance of this matcher.

Parameters:

headerName - name of a request header

pred - a predicate to be applied on the request header

Returns:

new instance of this matcher

retrieveValue

protected List<String> retrieveValue(Request req)

Retrieves a header (defined in HeaderRequestMatcher(org.hamcrest.Matcher, java.lang.String)) of the given request.

Specified by:

retrieveValue in class RequestMatcher<List<String>>

Parameters:

req - request to retrieve the header from

Returns:

the request header as a list of values or null if there is no such a header 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