org.forgerock.cuppa.model

Class TestBuilder

java.lang.Object

org.forgerock.cuppa.model.TestBuilder

public final class TestBuilder
extends java.lang.Object

A mutable builder that constructs Test instances.

Constructor Summary

Constructors

Constructor and Description
TestBuilder()

Method Summary

Modifier and Type	Method and Description
Test	build() Constructs a Test using the values set on this builder.
TestBuilder	setBehaviour(Behaviour behaviour) Sets the behaviour, which controls how the test behaves.
TestBuilder	setDescription(java.lang.String description) Sets the description of the test.
TestBuilder	setFunction(java.util.Optional<TestFunction> function) Sets the body of the test.
TestBuilder	setOptions(Options options) Sets the options applied to the test.
TestBuilder	setTestClass(java.lang.Class<?> testClass) Sets the class that the test was defined in.

Methods inherited from class java.lang.Object

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

Constructor Detail

TestBuilder

public TestBuilder()

Method Detail

setBehaviour

public TestBuilder setBehaviour(Behaviour behaviour)

Sets the behaviour, which controls how the test behaves.

Parameters:

behaviour - The behaviour.

Returns:

this TestBuilder.

setTestClass

public TestBuilder setTestClass(java.lang.Class<?> testClass)

Sets the class that the test was defined in.

Parameters:

testClass - The class.

Returns:

this TestBuilder.

setDescription

public TestBuilder setDescription(java.lang.String description)

Sets the description of the test.

Parameters:

description - The description.

Returns:

this TestBuilder.

setFunction

public TestBuilder setFunction(java.util.Optional<TestFunction> function)

Sets the body of the test. If the Optional is empty the test is classified as pending.

Parameters:

function - The function.

Returns:

this TestBuilder.

setOptions

public TestBuilder setOptions(Options options)

Sets the options applied to the test.

Parameters:

options - The options.

Returns:

this TestBuilder.

build

public Test build()

Constructs a Test using the values set on this builder.

Returns:

A new Test.