com.github.tashoyan.httpspy

Interface RequestExpectationListBuilder

All Known Implementing Classes:

AbstractRequestExpectationListBuilder

@NotThreadSafe
public interface RequestExpectationListBuilder

Builder that constructs a list of request expectations.

HTTP Spy server uses the builder to construct request expectations. User supplies an instance of the builder to method HttpSpy.expectRequests(com.github.tashoyan.httpspy.RequestExpectationListBuilder). One instance can be used to construct multiple request expectations.

Concurrency notes. Builder instances are used in a single thread that prepares requests expectations - typically main thread. Implementations are not required to be thread safe.

See Also:

HttpSpy.expectRequests(com.github.tashoyan.httpspy.RequestExpectationListBuilder)

Method Summary

Modifier and Type	Method and Description
void	build() Builds the list of request expectations.
void	expect(RequestExpectationBuilder requestExpectationBuilder) Adds a request expectation to this list.
List<RequestExpectation>	getRequestExpectations() Gets the list of request expectations.
List<HttpResponse>	getResponses() Gets the list of responses on actual requests.
RequestExpectationBuilder	request() Returns new request expectation builder that user will use to specify his expectations.
ResponseBuilder	response() Returns new response builder that user will use to describe a response on the actual request.

Method Detail

getRequestExpectations

List<RequestExpectation> getRequestExpectations()

Gets the list of request expectations.

Returns:

The list of request expectations. Never returns null, if unset returns empty list.

getResponses

List<HttpResponse> getResponses()

Gets the list of responses on actual requests.

Returns:

The list of responses. Never returns null, if unset returns empty list.

build

void build()

Builds the list of request expectations.

User has to implement this method in order to provide his expectations.

expect

void expect(RequestExpectationBuilder requestExpectationBuilder)

Adds a request expectation to this list.

Parameters:

requestExpectationBuilder - Request expectation builder.

Throws:

NullPointerException - requestExpectationBuilder is null.

request

RequestExpectationBuilder request()

Returns new request expectation builder that user will use to specify his expectations.

Returns:

New request expectation builder. Never returns null, new object provides default expectations.

response

ResponseBuilder response()

Returns new response builder that user will use to describe a response on the actual request.

Returns:

New response builder. Never returns null, new object provides default response values.