com.github.tashoyan.httpspy

Class AbstractSequencePlanBuilder

java.lang.Object

com.github.tashoyan.httpspy.AbstractTestPlanBuilder<SequencePlan>

com.github.tashoyan.httpspy.AbstractSequencePlanBuilder

All Implemented Interfaces:

TestPlanBuilder

@NotThreadSafe
public abstract class AbstractSequencePlanBuilder
extends AbstractTestPlanBuilder<SequencePlan>

Builder for SequencePlan.

Field Summary

Fields inherited from class com.github.tashoyan.httpspy.AbstractTestPlanBuilder

DEFAULT_REQUESTS_NUMBER

Constructor Summary

Constructors

Constructor and Description
AbstractSequencePlanBuilder()

Method Summary

Modifier and Type	Method and Description
SequencePlan	build() Builds new test plan.
abstract void	compose() Composes the test plan.
void	expect(int times, RequestExpectationBuilder requestExpectationBuilder) Expect the same request multiple times in sequence.
void	expect(RequestExpectationBuilder requestExpectationBuilder) Expect a request.

Methods inherited from class com.github.tashoyan.httpspy.AbstractTestPlanBuilder

equalTo, equalToIgnoreCase, equalToJson, equalToXml, matching, request, response

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSequencePlanBuilder

public AbstractSequencePlanBuilder()

Method Detail

expect

public 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.

The method adds new request expectation as specified by the argument to the end of expectations list. Also the method adds the response for the actual request to the end of responses list.

Parameters:

requestExpectationBuilder - Request expectation builder.

Throws:

NullPointerException - requestExpectationBuilder is null.

expect

public void expect(int times,
                   RequestExpectationBuilder requestExpectationBuilder)

Expect the same request multiple times in sequence.

A convenience method instead of calling expect(RequestExpectationBuilder) multiple times.

Parameters:

times - Number of sequential requests with the same expectation.

requestExpectationBuilder - Request expectation builder.

Throws:

NullPointerException - requestExpectationBuilder is null.

IllegalArgumentException - times is not positive.

build

public SequencePlan build()

Description copied from interface: TestPlanBuilder

Builds new test plan.

Specified by:

build in interface TestPlanBuilder

Specified by:

build in class AbstractTestPlanBuilder<SequencePlan>

Returns:

New test plan. Never returns null.

compose

public abstract void compose()

Composes the test plan.

User has to implement this method when preparing a test plan. User can invoke expect(com.github.tashoyan.httpspy.RequestExpectationBuilder) inside his implementation of this method to specify request expectations.