Packages

  • package root
    Definition Classes
    root
  • package org
    Definition Classes
    root
  • package scalatest

    ScalaTest's main traits, classes, and other members, including members supporting ScalaTest's DSL for the Scala interpreter.

    ScalaTest's main traits, classes, and other members, including members supporting ScalaTest's DSL for the Scala interpreter.

    Definition Classes
    org
  • trait AppendedClues extends AnyRef

    Trait providing an implicit conversion that allows clues to be placed after a block of code.

    Trait providing an implicit conversion that allows clues to be placed after a block of code.

    You can use the withClue construct provided by Assertions, which is extended by every style trait in ScalaTest, to add extra information to reports of failed or canceled tests. The withClue from Assertions places the "clue string" at the front, both in the code and in the resulting message:

    withClue("This is a prepended clue;") {
  1 + 1 should equal (3)
}

    The above expression will yield the failure message:

    This is a prepended clue; 2 did not equal 3

    If you mix in this trait, or import its members via its companion object, you can alternatively place the clue string at the end, like this:

    { 1 + 1 should equal (3) } withClue "now the clue comes after"

    The above expression will yield the failure message:

    2 did not equal 3 now the clue comes after

    If no space is already present, either at the beginning of the clue string or at the end of the current message, a space will be placed between the two, unless the clue string starts with one of the punctuation characters: comma (,), period (.), or semicolon (;). For example, the failure message in the above example includes an extra space inserted between 3 and now.

    By contrast this code, which has a clue string starting with comma:

    { 1 + 1 should equal (3) } withClue ", now the clue comes after"

    Will yield a failure message with no extra inserted space:

    2 did not equal 3, now the clue comes after

    The withClue method will only append the clue string to the detail message of exception types that mix in the ModifiableMessage trait. See the documentation for ModifiableMessage for more information.

    Note: the reason this functionality is not provided by Assertions directly, like the prepended withClue construct, is because appended clues require an implicit conversion. ScalaTest only gives you one implicit conversion by default in any test class to minimize the potential for conflicts with other implicit conversions you may be using. All other implicit conversions, including the one provided by this trait, you must explicitly invite into your code through inheritance or an import.

    Definition Classes
    scalatest
  • Clueful

class Clueful[T] extends AnyRef

Class that provides a withClue method that appends clue strings to any ModifiableMessage exception thrown by the passed by-name parameter.

Source
AppendedClues.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Clueful
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Clueful(fun: ⇒ T)

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. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. def withClue(clue: Any): T

    Executes the block of code passed as the constructor parameter to this Clueful, and, if it completes abruptly with a ModifiableMessage exception, appends the "clue" string passed to this method to the end of the detail message of that thrown exception, then rethrows it.

    Executes the block of code passed as the constructor parameter to this Clueful, and, if it completes abruptly with a ModifiableMessage exception, appends the "clue" string passed to this method to the end of the detail message of that thrown exception, then rethrows it. If clue does not begin in a white space character or one of the punctuation characters: comma (,), period (.), or semicolon (;), one space will be added between it and the existing detail message (unless the detail message is not defined).

    This method allows you to add more information about what went wrong that will be reported when a test fails or cancels. For example, this code:

    { 1 + 1 should equal (3) } withClue ", not even for very large values of 1"

    Would yield a TestFailed exception whose message would be:

    2 did not equal 3, not even for very large values of 1

    Exceptions thrown

    NullArgumentException if the passed clue is null

Inherited from AnyRef

Inherited from Any

Ungrouped