org.specs2.specification

Example

Related Docs: object Example | package specification

case class Example extends Fragment with Executable with Isolable with Product with Serializable

A Example is:

- a description: some text, with possibly some markdown 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. Example
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Isolable
  7. Executable
  8. Fragment
  9. AnyRef
  10. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

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

  6. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. val desc: FormattedString

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

    Definition Classes
    AnyRef
  9. def equals(a: Any): Boolean

    Definition Classes
    Example → Equals → AnyRef → Any
  10. def execute: Result

    returns

    a Result

    Definition Classes
    ExampleExecutable
  11. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. def formatWith(formatted: FormattedString): Example

    replace the current formatted string with another one

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

    Definition Classes
    AnyRef → Any
  14. def global: Example

    this fragment can not be executed in a separate specification

  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  16. val isolable: Boolean

    Definition Classes
    ExampleIsolable
  17. val location: Location

    Definition Classes
    ExampleFragment
  18. def map(f: (Result) ⇒ Result): Example

    modify the result to return

    modify the result to return

    Definition Classes
    ExampleExecutable
  19. 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
    ExampleFragment
  20. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  24. def toString(): String

    Definition Classes
    Example → AnyRef → Any
  25. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

Ungrouped