Package net.jadler.matchers

Class PathRequestMatcher

java.lang.Object

org.hamcrest.BaseMatcher<Request>

net.jadler.matchers.RequestMatcher<String>

net.jadler.matchers.PathRequestMatcher

All Implemented Interfaces:

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

public class PathRequestMatcher
extends RequestMatcher<String>

A RequestMatcher used for matching the request path.

Field Summary

Fields inherited from class net.jadler.matchers.RequestMatcher

pred

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PathRequestMatcher(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 PathRequestMatcher	requestPath(org.hamcrest.Matcher<? super String> pred)	Factory method to create new instance of this matcher.
String	retrieveValue(Request req)	Retrieves the path 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

PathRequestMatcher

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

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

Parameters:

pred - a predicate to be applied on the request path

Method Detail

requestPath

public static PathRequestMatcher requestPath(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 path

Returns:

new instance of this matcher

retrieveValue

public String retrieveValue(Request req)

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

Specified by:

retrieveValue in class RequestMatcher<String>

Parameters:

req - request to retrieve the path from

Returns:

request path (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