Packages

case class Example(loc: Location, id: Identifier, givens: Seq[GivenClause] = Seq.empty[GivenClause], whens: Seq[WhenClause] = Seq.empty[WhenClause], thens: Seq[ThenClause] = Seq.empty[ThenClause], buts: Seq[ButClause] = Seq.empty[ButClause], brief: Option[LiteralString] = Option.empty[LiteralString], description: Option[Description] = Option.empty[Description]) extends ProcessorDefinition with Product with Serializable

A Gherkin example. Examples have names, id, and a sequence of each of the four kinds of Gherkin clauses: GivenClause, WhenClause, ThenClause, ButClause

loc

The location of the start of the example

id

The name of the example

givens

The list of Given/And statements

whens

The list of When/And statements

thens

The list of Then/And statements

buts

The List of But/And statements

brief

A brief description (one sentence) for use in documentation

description

An optional description of the example

See also

The Gherkin Reference

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Example
  2. Serializable
  3. Product
  4. Equals
  5. ProcessorDefinition
  6. Definition
  7. BrieflyDescribedValue
  8. DescribedValue
  9. RiddlValue
  10. RiddlNode
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Example(loc: Location, id: Identifier, givens: Seq[GivenClause] = Seq.empty[GivenClause], whens: Seq[WhenClause] = Seq.empty[WhenClause], thens: Seq[ThenClause] = Seq.empty[ThenClause], buts: Seq[ButClause] = Seq.empty[ButClause], brief: Option[LiteralString] = Option.empty[LiteralString], description: Option[Description] = Option.empty[Description])

    loc

    The location of the start of the example

    id

    The name of the example

    givens

    The list of Given/And statements

    whens

    The list of When/And statements

    thens

    The list of Then/And statements

    buts

    The List of But/And statements

    brief

    A brief description (one sentence) for use in documentation

    description

    An optional description of the example

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val brief: Option[LiteralString]
    Definition Classes
    ExampleBrieflyDescribedValue
  6. val buts: Seq[ButClause]
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  8. val description: Option[Description]
    Definition Classes
    ExampleDescribedValue
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def format: String
    Definition Classes
    RiddlNode
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. val givens: Seq[GivenClause]
  13. val id: Identifier
    Definition Classes
    ExampleDefinition
  14. def identify: String
    Definition Classes
    Definition
  15. def identifyWithLoc: String
    Definition Classes
    Definition
  16. def isContainer: Boolean
    Definition Classes
    RiddlValue
  17. def isEmpty: Boolean
    Definition Classes
    ExampleRiddlNode
  18. def isImplicit: Boolean
    Definition Classes
    ExampleDefinition
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def kind: String
    Definition Classes
    Definition
  21. def kindId: String
    Definition Classes
    Definition
  22. val loc: Location
    Definition Classes
    ExampleRiddlValue
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def nonEmpty: Boolean
    Definition Classes
    RiddlNode
    Annotations
    @deprecatedOverriding()
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  27. def productElementNames: Iterator[String]
    Definition Classes
    Product
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. val thens: Seq[ThenClause]
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. val whens: Seq[WhenClause]

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ProcessorDefinition

Inherited from Definition

Inherited from BrieflyDescribedValue

Inherited from DescribedValue

Inherited from RiddlValue

Inherited from RiddlNode

Inherited from AnyRef

Inherited from Any

Ungrouped