org.specs2.specification

Example

case class Example(desc: MarkupString, body: () ⇒ Result) extends Fragment with Executable with Isolable with Product with Serializable

A Example is:

- a description: some text, with possibly some markup annotations for rendering code fragments (used in AutoExamples) - a body: some executable code returning a Result

Self Type
Example
Linear Supertypes
Serializable, Serializable, Product, Equals, Isolable, Executable, Fragment, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Example
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Isolable
  7. Executable
  8. Fragment
  9. AnyRef
  10. Any
Visibility
  1. Public
  2. All

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. val body: () ⇒ Result

  8. def canEqual(arg0: Any): Boolean

    Definition Classes
    Example → Equals

  9. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  10. val desc: MarkupString

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

    Definition Classes
    AnyRef

  12. def equals(a: Any): Boolean

    Definition Classes
    Example → Equals → AnyRef → Any

  13. def execute: Result

    returns

    a Result

    Definition Classes
    Example → Executable

  14. def finalize(): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  15. final def getClass(): java.lang.Class[_]

    Definition Classes
    AnyRef → Any

  16. def global: Example

    this fragment can not be executed in a separate specification

  17. def hashCode(): Int

    Definition Classes
    Example → AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  19. val isolable: Boolean

    Definition Classes
    Example → Isolable

  20. val location: Location

    Definition Classes
    Fragment

  21. def map(f: (Result) ⇒ Result): Example

    modify the result to return

    modify the result to return

    Definition Classes
    Example → Executable

  22. def matches(s: String): Boolean

    match the description of an example with a regular expression.

    match the description of an example with a regular expression.

    If the regexp doesn't compile, it is used literally by quoting it. However this regexp is usually passed as the Arguments.ex value, it is enclosed with '.*' characters, so they are removed and added back before quotation

    Definition Classes
    Example → Fragment

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

    Definition Classes
    AnyRef

  24. final def notify(): Unit

    Definition Classes
    AnyRef

  25. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  26. def productArity: Int

    Definition Classes
    Example → Product

  27. def productElement(arg0: Int): Any

    Definition Classes
    Example → Product

  28. def productIterator: Iterator[Any]

    Definition Classes
    Product

  29. def productPrefix: String

    Definition Classes
    Example → Product

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

    Definition Classes
    AnyRef

  31. def toString(): String

    Definition Classes
    Example → AnyRef → Any

  32. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

Deprecated Value Members

  1. def productElements: Iterator[Any]

    Definition Classes
    Product
    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use productIterator instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Isolable

Inherited from Executable

Inherited from Fragment

Inherited from AnyRef

Inherited from Any