us.johnmeyer.sitetest.core

Class ResultBuilder

java.lang.Object

us.johnmeyer.sitetest.core.ResultBuilder

public final class ResultBuilder
extends Object

Builds a record of information returned by the test. Information must be added prior to reporting the test result.

Field Summary

Fields

Modifier and Type	Field and Description
private Controller	controller Controller for test.
private Boolean	isSuccessful Is the test successful?
private ArrayList<Returns>	returnedStatusList List of statuses.
private String	testLog Log for test.
private Result	testResult Tracks result of test, including whether result has been reported.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ResultBuilder(Controller controllerParam) Constructs builder.

Method Summary

Modifier and Type	Method and Description
ResultBuilder	addLog(String logParam) Add entry to test log.
ResultBuilder	addState(Returns resultParam) Adds a result enumeration tag.
ResultBuilder	addState(Returns resultState, String stateReasonParam) Adds a state and updates the test log with why the state was added.
Result	getTestResult() Returns result of test.
static ResultBuilder	newTestResultBuilder(Controller testParam) Factory creates new ResultBuilder model.
ResultBuilder	setIsSuccessful(boolean isSuccessfulParam) Sets success flag.

Methods inherited from class java.lang.Object

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

Field Detail

isSuccessful

private Boolean isSuccessful

Is the test successful?

controller

private Controller controller

Controller for test. Contains initial state information.

testLog

private String testLog

Log for test.

returnedStatusList

private ArrayList<Returns> returnedStatusList

List of statuses. Statuses are enumeration members.

testResult

private Result testResult

Tracks result of test, including whether result has been reported. If null, result has not been reported.

Constructor Detail

ResultBuilder

private ResultBuilder(Controller controllerParam)

Constructs builder. Sets Controller.

Parameters:

controllerParam - test controller for test being documented.

Method Detail

setIsSuccessful

public ResultBuilder setIsSuccessful(boolean isSuccessfulParam)

Sets success flag. Runs once only.

Parameters:

isSuccessfulParam - set this to true if successful

Returns:

instance of this ResultBuilder for builder-style usage

addLog

public ResultBuilder addLog(String logParam)

Add entry to test log.

Parameters:

logParam - message to add to this test's log

Returns:

instance of this ResultBuilder for builder-style usage

Throws:

IllegalStateException - of result has already been provided.

NullPointerException - if null value is passed in place of message.

addState

public ResultBuilder addState(Returns resultState,
                              String stateReasonParam)

Adds a state and updates the test log with why the state was added. In the reason use verb subject (action taken) + predicate (verb object plus any indirect objects).

Parameters:

resultState - what state is happening

stateReasonParam - why is this state occurring?

Returns:

reference to updated builder instance

addState

public ResultBuilder addState(Returns resultParam)

Adds a result enumeration tag.

Parameters:

resultParam - result of test.

Returns:

reference to updated builder instance

newTestResultBuilder

public static ResultBuilder newTestResultBuilder(Controller testParam)

Factory creates new ResultBuilder model.

Parameters:

testParam - controller for test for which result is being created.

Returns:

result model for building result of test

getTestResult

public Result getTestResult()

Returns result of test. Provided to test after it runs. Note this can be run one time only, to provide return value for run() method in test controller.

Returns:

Immutable result of test.

Throws:

IllegalStateException - if result was already provided, or if test success state or test log are missing.