Builder3

Value Members

1. final def !=(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef

2. final def !=(arg0: Any): Boolean

   Definition Classes

   Any

3. final def ##(): Int

   Definition Classes

   AnyRef → Any

4. final def ==(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef

5. final def ==(arg0: Any): Boolean

   Definition Classes

   Any

6. final def asInstanceOf[T0]: T0

   Definition Classes

   Any

7. def assertion(a: CodeHolder[(P1, P2, P3, ROrException[R]) ⇒ Boolean], comment: String = ""): RealScenarioBuilder

   An assertion is an extra test to be run.

   An assertion is an extra test to be run. The assertions must be true for the scenario when the engine has been built. The function you pass in to it takes the parameters and the result of the engine, and returns a boolean

   Definition Classes

   ScenarioBuilder

8. def because(b: CodeHolder[(P1, P2, P3) ⇒ Boolean], comment: String = ""): RealScenarioBuilder

   Set the 'because' of the 'last thing to be mentioned' to be this value.

   Set the 'because' of the 'last thing to be mentioned' to be this value. i.e. the builder/usecase/scenario. Throws CannotDefineBecauseTwiceException if expected already set. If you haven't set a code, then this will also act as the code

   Definition Classes

   ScenarioBuilder

9. def build: Engine3[P1, P2, P3, FullR]

   Definition Classes

   ABuilder3

10. def buildTarget: AnyRef

    Definition Classes

    ScenarioBuilder

11. val builderData: BuilderFactory3.ScenarioBuilderData

    Definition Classes

    Builder3 → ScenarioBuilder

12. def childEngine(engineTitle: String, description: String = null): RealScenarioBuilder

    Definition Classes

    ScenarioBuilder

13. def clone(): AnyRef

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws()

14. def code(c: BuilderFactory3.Code, comment: String = ""): RealScenarioBuilder

    This is optional, as it defaults to returning 'expected'.

    This is optional, as it defaults to returning 'expected'. The code is the code that you would use to generate the expected.

    The TennisScorer is a good example of where this is needed :

         scenario(2, 3).expected("thirty, forty").code((l: Int, r: Int) => s"${lookup(l)}, ${lookup(r)}").
    

    Although in this case 'thirty forty' is the expected, we want to calculate the value so that it can be generalised for other inputs

    Definition Classes

    ScenarioBuilder

15. def configuration[K](cfg: (P1, P2, P3) ⇒ Unit): RealScenarioBuilder

    This method is used if you are action on mutable parameters.

    This method is used if you are action on mutable parameters. The cgnFn is called to setup the parameters prior to them being used in the because clause

    The cfgFn is only used while building the engine. An example use would be when the parameter is a mutable object like a Swing JTextArea. The cfgFn would setup the textarea to have the correct values

    Definition Classes

    ScenarioBuilder

16. def copy(builderData: BuilderFactory3.ScenarioBuilderData): Builder3

    You should probably not call this explicitly.

    You should probably not call this explicitly. This makes a copy of the builder with new data. The builder is an immutable object, so this is how data is actually 'changed' when you call methods like description

    Definition Classes

    Builder3 → ScenarioBuilder

17. def copy(depth: Int = builderData.depth, title: Option[String] = builderData.title, description: Option[String] = builderData.description, children: ReportableList = builderData.children, foldFn: Option[(FullR, R) ⇒ FullR] = builderData.folder, initialFoldValue: () ⇒ FullR = builderData.initialFoldValue, optCode: Option[BuilderFactory3.Code] = builderData.optCode, expected: Option[ROrException[R]] = builderData.expected, priority: Option[Int] = builderData.priority, references: Set[Reference] = builderData.references, documents: List[Document] = builderData.documents, paramDetails: List[ParamDetail] = builderData.paramDetails): RealScenarioBuilder

    Attributes

    protected

    Definition Classes

    ScenarioBuilder

18. def description(description: String): RealScenarioBuilder

    Set the description of the 'last thing to be mentioned' i.

    Set the description of the 'last thing to be mentioned' i.e. the builder/usecase/scenario. Throws CannotDefineDescriptionTwiceException if title already set. The description is used when creating reports

    Definition Classes

    ScenarioBuilder

19. def document(documents: Document*): RealScenarioBuilder

    This adds the documents you specify to the documents that the builder 'knows about'.

    This adds the documents you specify to the documents that the builder 'knows about'. Currently the documents are only used by references.

    Definition Classes

    ScenarioBuilder

20. final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

21. def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

22. def expectException[E <: Throwable](e: E, comment: String = ""): RealScenarioBuilder

    Set the 'expected' of the 'last thing to be mentioned' to be an exception.

    Set the 'expected' of the 'last thing to be mentioned' to be an exception. i.e. the builder/usecase/scenario. Throws CannotDefineExpectedTwiceException if expected already set. Note that the engine will currently only check the type of the message, not the message itself, and that you must have a 'code' to throw the exception

    Definition Classes

    ScenarioBuilder

23. def expected(e: R): RealScenarioBuilder

    Set the 'expected' of the 'last thing to be mentioned' to be this value.

    Set the 'expected' of the 'last thing to be mentioned' to be this value. i.e. the builder/usecase/scenario. Throws CannotDefineExpectedTwiceException if expected already set. If you haven't set a code, then this will also act as the code

    Definition Classes

    ScenarioBuilder

24. def finalize(): Unit

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws()

25. def findDocument(documentName: String): Document

    Attributes

    protected

    Definition Classes

    ScenarioBuilder

26. def getBuildTarget(depth: Int, node: AnyRef): AnyRef

    Attributes

    protected

    Definition Classes

    ScenarioBuilder

27. final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

28. def getParent: Option[AnyRef]

    Attributes

    protected

    Definition Classes

    ScenarioBuilder

29. def getParentAt(depth: Int, parent: AnyRef): AnyRef

    Attributes

    protected

    Definition Classes

    ScenarioBuilder

30. def hashCode(): Int

    Definition Classes

    AnyRef → Any

31. final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

32. final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

33. def newScenario(scenarioTitle: String, scenarioDescription: String, params: List[Any]): RealScenarioBuilder

    Attributes

    protected

    Definition Classes

    ScenarioBuilder

34. final def notify(): Unit

    Definition Classes

    AnyRef

35. final def notifyAll(): Unit

    Definition Classes

    AnyRef

36. def param(parser: Function1[String, _], name: String = ..., testValue: String = null): RealScenarioBuilder

    This is only used when using the 'live' website option.

    This is only used when using the 'live' website option. It turns a string into a parameter, and gives the parameter a 'nice' name on the website

    Definition Classes

    ScenarioBuilder

37. def priority(priority: Int): RealScenarioBuilder

    Set the 'priority' of the 'last thing to be mentioned' to be this value.

    Set the 'priority' of the 'last thing to be mentioned' to be this value. i.e. the builder/usecase/scenario. This determines the 'rule ordering' of the scenarios. If you don't like the produced decision tree, you can increase /decrease the priority of a scenario with the because clause you want to move

    Definition Classes

    ScenarioBuilder

38. def reference(ref: String, document: Option[Document] = None): RealScenarioBuilder

    Adds a reference to the 'last thing to be mentioned'.

    Adds a reference to the 'last thing to be mentioned'. This is just the 'ref' string, without a document

    Definition Classes

    ScenarioBuilder

39. def reference(ref: String, document: Document): RealScenarioBuilder

    Adds a reference to the 'last thing to be mentioned'.

    Adds a reference to the 'last thing to be mentioned'. References are currently just used in the reports.

    Definition Classes

    ScenarioBuilder

40. def reference(ref: String, documentName: String): RealScenarioBuilder

    Adds a reference to the 'last thing to be mentioned'.

    Adds a reference to the 'last thing to be mentioned'. References are currently just used in the reports. If the documentName isn't in the list of doucments, this will throw a CannotFindDocumentException

    Definition Classes

    ScenarioBuilder

41. def scenario(p1: P1, p2: P2, p3: P3, title: String = null, description: String = null): RealScenarioBuilder

    Definition Classes

    ABuilder3

42. def set[X](x: X, bFn: (BuilderFactory3.ScenarioBuilder, X) ⇒ BuilderFactory3.ScenarioBuilder, ceFn: (BuilderFactory3.ChildEngineDescription, X) ⇒ BuilderFactory3.ChildEngineDescription, uFn: (BuilderFactory3.UseCaseDescription, X) ⇒ BuilderFactory3.UseCaseDescription, sFn: (BuilderFactory3.Scenario, X) ⇒ BuilderFactory3.Scenario, checkFn: (BuilderFactory3.BuilderNode, X) ⇒ Unit = (b: BuilderNode, x: X) => {}): RealScenarioBuilder

    Attributes

    protected

    Definition Classes

    ScenarioBuilder

43. def setWithDepth[Node, X](depth: Int, node: Node, x: X, bFn: (BuilderFactory3.ScenarioBuilder, X) ⇒ BuilderFactory3.ScenarioBuilder, ceFn: (BuilderFactory3.ChildEngineDescription, X) ⇒ BuilderFactory3.ChildEngineDescription, uFn: (BuilderFactory3.UseCaseDescription, X) ⇒ BuilderFactory3.UseCaseDescription, sFn: (BuilderFactory3.Scenario, X) ⇒ BuilderFactory3.Scenario, checkFn: (BuilderFactory3.BuilderNode, X) ⇒ Unit = (b: BuilderNode, x: X) => {}): Node

    Attributes

    protected

    Definition Classes

    ScenarioBuilder

44. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes

    AnyRef

45. def thisAsBuilder: Builder3

    Attributes

    protected

    Definition Classes

    Builder3 → ScenarioBuilder

46. def title(title: String): RealScenarioBuilder

    Set the title of the 'last thing to be mentioned' i.

    Set the title of the 'last thing to be mentioned' i.e. the builder/usecase/scenario. Throws CannotDefineTitleTwiceException if title already set. The title is used when creating reports

    Definition Classes

    ScenarioBuilder

47. def toString(): String

    Definition Classes

    AnyRef → Any

48. def useCase(useCaseTitle: String, useCaseDescription: String): RealScenarioBuilder

    Starts the definition of a new case.

    Starts the definition of a new case. A use case can be thought of as a list of scenarios

    Definition Classes

    ScenarioBuilder

49. def useCase(useCaseTitle: String): RealScenarioBuilder

    Starts the definition of a new case.

    Starts the definition of a new case. A use case can be thought of as a list of scenarios

    Definition Classes

    ScenarioBuilder

50. final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws()

51. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws()

52. final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws()

53. def withUseCase(useCaseTitle: String, useCaseDescription: Option[String]): RealScenarioBuilder

    Attributes

    protected

    Definition Classes

    ScenarioBuilder