com.github.tashoyan.httpspy

Interface TestPlanBuilder

All Known Implementing Classes:

AbstractSequencePlanBuilder, AbstractStubPlanBuilder, AbstractTestPlanBuilder

@NotThreadSafe
public interface TestPlanBuilder

Builder for test plans.

Implementations provide ways to build plans for different kind of tests with HTTP Spy.

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.

Method Summary

Modifier and Type	Method and Description
TestPlan	build() Builds new test plan.
void	expect(RequestExpectationBuilder requestExpectationBuilder) Expect a request.
RequestExpectationBuilder	request() Returns new request expectation builder that user will populate when specifying his expectations.
ResponseBuilder	response() Returns new response builder that user will populate when describing a response on the actual request.

Method Detail

expect

void expect(RequestExpectationBuilder requestExpectationBuilder)

Expect a request.

The method adds new request expectation as specified by the argument. Also the method adds the response for the actual request.

Parameters:

requestExpectationBuilder - Request expectation builder.

Throws:

NullPointerException - requestExpectationBuilder is null.

request

RequestExpectationBuilder request()

Returns new request expectation builder that user will populate when specifying 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 populate when describing a response on the actual request.

Returns:

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

build

TestPlan build()

Builds new test plan.

Returns:

New test plan. Never returns null.