com.github.restdriver.clientdriver

Class ClientDriverExpectation

java.lang.Object

com.github.restdriver.clientdriver.ClientDriverExpectation

public class ClientDriverExpectation
extends Object

An expectation made within the client driver.

Constructor Summary

Constructors

Constructor and Description
ClientDriverExpectation(ClientDriverRequestResponsePair pair) Creates a new expectation instance.

Method Summary

Modifier and Type	Method and Description
ClientDriverExpectation	anyTimes() Indicate that this expectation should be matched any number of times.
ClientDriverRequestResponsePair	getPair() Gets the request/response pair this expectation covers.
String	getStatusString() Gets a string giving the status of the expectation.
boolean	isSatisfied() Determine whether this expectation has been satisfied.
void	match(HttpRealRequest realRequest) Indicate that this expectation has been matched.
boolean	shouldMatchAnyTimes() Whether this expectation should match any number of times.
ClientDriverExpectation	times(int times) Indicate that this expectation should be matched a given number of times.
ClientDriverExpectation	whenMatched(MatchedRequestHandler matchedRequestHandler) When a call is matched call a handler

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientDriverExpectation

public ClientDriverExpectation(ClientDriverRequestResponsePair pair)

Creates a new expectation instance.

Parameters:

pair - The request/response pair the expectation covers.

Method Detail

getPair

public final ClientDriverRequestResponsePair getPair()

Gets the request/response pair this expectation covers.

Returns:

The request/response pair

times

public final ClientDriverExpectation times(int times)

Indicate that this expectation should be matched a given number of times.

Parameters:

times - The number of times this expectation should be matched

Returns:

the newly-created expectation

anyTimes

public final ClientDriverExpectation anyTimes()

Indicate that this expectation should be matched any number of times.

Returns:

the newly-created expectation

match

public final void match(HttpRealRequest realRequest)

Indicate that this expectation has been matched.

Parameters:

realRequest - the request we're matching against

isSatisfied

public final boolean isSatisfied()

Determine whether this expectation has been satisfied.

Returns:

True if the expectation has been matched as many times as it should have

shouldMatchAnyTimes

public final boolean shouldMatchAnyTimes()

Whether this expectation should match any number of times.

Returns:

True if the expectation should match any number of times

getStatusString

public final String getStatusString()

Gets a string giving the status of the expectation.

Returns:

The status string

whenMatched

public ClientDriverExpectation whenMatched(MatchedRequestHandler matchedRequestHandler)

When a call is matched call a handler

Parameters:

matchedRequestHandler - called when the request is matched

Returns:

The expectation