Class

org.scalatest.exceptions

TestFailedException

Related Doc: package exceptions

Permalink

class TestFailedException extends StackDepthException with ModifiableMessage[TestFailedException] with PayloadField with ModifiablePayload[TestFailedException]

Exception that indicates a test failed.

One purpose of this exception is to encapsulate information about the stack depth at which the line of test code that failed resides, so that information can be presented to the user that makes it quick to find the failing line of test code. (In other words, the user need not scan through the stack trace to find the correct filename and line number of the failing test.)

Another purpose of this exception is to encapsulate a payload, an object to be included in a TestFailed event as its payload, so it can be consumed by a custom reporter that understands the payload. For example, tests could take a screen shot image of a GUI when a test fails, and include that as a payload. A custom reporter could listen for such payloads and display the screen shots to the user.

Source
TestFailedException.scala
Exceptions thrown

NullArgumentException if either messageFun, cause or failedCodeStackDepthFun is null, or Some(null).

Linear Supertypes
ModifiablePayload[TestFailedException], PayloadField, ModifiableMessage[TestFailedException], StackDepthException, StackDepth, RuntimeException, Exception, Throwable, Serializable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TestFailedException
  2. ModifiablePayload
  3. PayloadField
  4. ModifiableMessage
  5. StackDepthException
  6. StackDepth
  7. RuntimeException
  8. Exception
  9. Throwable
  10. Serializable
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TestFailedException(messageFun: (StackDepthException) ⇒ Option[String], cause: Option[Throwable], failedCodeStackDepthFun: (StackDepthException) ⇒ Int, payload: Option[Any])

    Permalink

    Constructs a TestFailedException with the given error message function, optional cause, stack depth function and optional payload.

    Constructs a TestFailedException with the given error message function, optional cause, stack depth function and optional payload.

    messageFun

    a function that return an optional detail message for this TestFailedException.

    cause

    an optional cause, the Throwable that caused this TestFailedException to be thrown.

    failedCodeStackDepthFun

    a function that produces the depth in the stack trace of this exception at which the line of test code that failed resides.

    payload

    an optional payload, which ScalaTest will include in a resulting TestFailedException event

  2. new TestFailedException(message: String, cause: Throwable, failedCodeStackDepth: Int)

    Permalink

    Create a TestFailedException with the specified stack depth, detail message, and cause.

    Create a TestFailedException with the specified stack depth, detail message, and cause.

    Note that the detail message associated with cause is not automatically incorporated in this throwable's detail message.

    message

    A detail message for this TestFailedException.

    cause

    the cause, the Throwable that caused this TestFailedException to be thrown.

    failedCodeStackDepth

    the depth in the stack trace of this exception at which the line of test code that failed resides.

    Exceptions thrown

    NullArgumentException if either message or cause is null.

  3. new TestFailedException(cause: Throwable, failedCodeStackDepth: Int)

    Permalink

    Create a TestFailedException with the specified stack depth and cause.

    Create a TestFailedException with the specified stack depth and cause. The message field of this exception object will be initialized to if (cause.getMessage == null) "" else cause.getMessage.

    cause

    the cause, the Throwable that caused this TestFailedException to be thrown.

    failedCodeStackDepth

    the depth in the stack trace of this exception at which the line of test code that failed resides.

    Exceptions thrown

    NullArgumentException if cause is null.

  4. new TestFailedException(message: String, failedCodeStackDepth: Int)

    Permalink

    Create a TestFailedException with a specified stack depth and detail message.

    Create a TestFailedException with a specified stack depth and detail message.

    message

    A detail message for this TestFailedException.

    failedCodeStackDepth

    the depth in the stack trace of this exception at which the line of test code that failed resides.

    Exceptions thrown

    NullArgumentException if message is null.

  5. new TestFailedException(failedCodeStackDepth: Int)

    Permalink

    Create a TestFailedException with specified stack depth and no detail message or cause.

    Create a TestFailedException with specified stack depth and no detail message or cause.

    failedCodeStackDepth

    the depth in the stack trace of this exception at which the line of test code that failed resides.

  6. new TestFailedException(message: Option[String], cause: Option[Throwable], failedCodeStackDepth: Int)

    Permalink

    Constructs a TestFailedException with pre-determined message and failedCodeStackDepth.

    Constructs a TestFailedException with pre-determined message and failedCodeStackDepth. (This was the primary constructor form prior to ScalaTest 1.5.)

    message

    an optional detail message for this TestFailedException.

    cause

    an optional cause, the Throwable that caused this TestFailedException to be thrown.

    failedCodeStackDepth

    the depth in the stack trace of this exception at which the line of test code that failed resides.

    Exceptions thrown

    NullArgumentException if either message of cause is null, or Some(null).

  7. new TestFailedException(messageFun: (StackDepthException) ⇒ Option[String], cause: Option[Throwable], failedCodeStackDepthFun: (StackDepthException) ⇒ Int)

    Permalink

    Constructs a TestFailedException with pre-determined message and failedCodeStackDepth.

    Constructs a TestFailedException with pre-determined message and failedCodeStackDepth. (This was the primary constructor form from ScalaTest 1.5 to 1.8.)

    messageFun

    a function that produces an optional detail message for this TestFailedException.

    cause

    an optional cause, the Throwable that caused this TestFailedException to be thrown.

    failedCodeStackDepthFun

    a function that produces the depth in the stack trace of this exception at which the line of test code that failed resides.

    Exceptions thrown

    NullArgumentException if either message of cause is null, or Some(null).

  8. new TestFailedException(messageFun: (StackDepthException) ⇒ Option[String], cause: Option[Throwable], pos: Position)

    Permalink

    Constructs a TestFailedException with the given error message function, optional cause and source position.

    Constructs a TestFailedException with the given error message function, optional cause and source position.

    messageFun

    a function that return an optional detail message for this TestFailedException.

    cause

    an optional cause, the Throwable that caused this TestFailedException to be thrown.

    pos

    a source position

  9. new TestFailedException(messageFun: (StackDepthException) ⇒ Option[String], cause: Option[Throwable], pos: Position, payload: Option[Any])

    Permalink

    Constructs a TestFailedException with the given error message function, optional cause, source position and optional payload.

    Constructs a TestFailedException with the given error message function, optional cause, source position and optional payload.

    messageFun

    a function that return an optional detail message for this TestFailedException.

    cause

    an optional cause, the Throwable that caused this TestFailedException to be thrown.

    pos

    a source position

    payload

    an optional payload, which ScalaTest will include in a resulting TestFailedException event

  10. new TestFailedException(messageFun: (StackDepthException) ⇒ Option[String], cause: Option[Throwable], posOrStackDepthFun: Either[Position, (StackDepthException) ⇒ Int], payload: Option[Any])

    Permalink

    messageFun

    a function that produces an optional detail message for this TestFailedException.

    cause

    an optional cause, the Throwable that caused this TestFailedException to be thrown.

    posOrStackDepthFun

    a source position or a function that produces the depth in the stack trace of this exception at which the line of test code that failed resides.

    payload

    an optional payload, which ScalaTest will include in a resulting TestFailed event

    Exceptions thrown

    NullArgumentException if either messageFun, cause or failedCodeStackDepthFun is null, or Some(null).

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def addSuppressed(arg0: Throwable): Unit

    Permalink
    Definition Classes
    Throwable
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def canEqual(other: Any): Boolean

    Permalink

    Indicates whether this object can be equal to the passed object.

    Indicates whether this object can be equal to the passed object.

    Definition Classes
    TestFailedExceptionStackDepthException
  7. val cause: Option[Throwable]

    Permalink

    an optional cause, the Throwable that caused this StackDepthException to be thrown.

    an optional cause, the Throwable that caused this StackDepthException to be thrown.

    Definition Classes
    StackDepthExceptionStackDepth
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def equals(other: Any): Boolean

    Permalink

    Indicates whether this object is equal to the passed object.

    Indicates whether this object is equal to the passed object. If the passed object is a TestFailedException, equality requires equal message, cause, and failedCodeStackDepth fields, as well as equal return values of getStackTrace.

    Definition Classes
    TestFailedExceptionStackDepthException → AnyRef → Any
  11. def failedCodeFileName: Option[String]

    Permalink

    A string that provides the filename of the line of code that failed, suitable for presenting to a user, which is taken from this exception's StackTraceElement at the depth specified by failedCodeStackDepth.

    A string that provides the filename of the line of code that failed, suitable for presenting to a user, which is taken from this exception's StackTraceElement at the depth specified by failedCodeStackDepth.

    This is a def instead of a val because exceptions are mutable: their stack trace can be changed after the exception is created. This is done, for example, by the SeveredStackTraces trait.

    returns

    a string containing the filename that caused the failed test

    Definition Classes
    StackDepth
  12. def failedCodeFileNameAndLineNumberString: Option[String]

    Permalink

    A string that provides the filename and line number of the line of code that failed, suitable for presenting to a user of the failing line.

    A string that provides the filename and line number of the line of code that failed, suitable for presenting to a user of the failing line. It calls failedCodeFileName and failedCodeLineNumber to get the failing filename and line number.

    failedCodeFileName and failedCodeLineNumber will fall back to exception stack trace when Position is not avaiable, this is the reason it is a def instead of a val, because exceptions are mutable: their stack trace can be changed after the exception is created. This is done, for example, by the SeveredStackTraces trait.

    returns

    a user-presentable string containing the filename and line number that caused the failed test

    Definition Classes
    StackDepth
  13. lazy val failedCodeFilePathname: Option[String]

    Permalink

    A string that provides the full pathname of the source file containing the line of code that failed, suitable for presenting to a user.

    A string that provides the full pathname of the source file containing the line of code that failed, suitable for presenting to a user.

    returns

    a string containing the full pathname of the source file containing the line of code that caused this exception

    Definition Classes
    StackDepthExceptionStackDepth
  14. lazy val failedCodeFilePathnameAndLineNumberString: Option[String]

    Permalink

    A string that provides the absolute filename and line number of the line of code that failed, suitable for presenting to a user of the failing line.

    A string that provides the absolute filename and line number of the line of code that failed, suitable for presenting to a user of the failing line. It calls failedCodeFilePathname and failedCodeLineNumber to get the failing absolute filename and line number.

    returns

    a user-presentable string containing the absolute filename and line number that caused the failed test

    Definition Classes
    StackDepth
  15. def failedCodeLineNumber: Option[Int]

    Permalink

    A string that provides the line number of the line of code that failed, suitable for presenting to a user, which is taken from this exception's StackTraceElement at the depth specified by failedCodeStackDepth.

    A string that provides the line number of the line of code that failed, suitable for presenting to a user, which is taken from this exception's StackTraceElement at the depth specified by failedCodeStackDepth.

    This is a def instead of a val because exceptions are mutable: their stack trace can be changed after the exception is created. This is done, for example, by the SeveredStackTraces trait.

    returns

    a string containing the line number that caused the failed test

    Definition Classes
    StackDepth
  16. lazy val failedCodeStackDepth: Int

    Permalink

    The depth in the stack trace of this exception at which the line of test code that failed resides.

    The depth in the stack trace of this exception at which the line of test code that failed resides.

    One reason this is lazy is to delay any searching of the stack trace until it is actually needed. It will usually be needed, but not always. For example, exceptions thrown during a shrink phase of a failed property will often be StackDepthExceptions, but whose failedCodeStackDepth will never be used. Another reason is to remove the need to create a different exception before creating this one just for the purpose of searching through its stack trace for the proper stack depth. Still one more reason is to allow the message to contain information about the stack depth, such as the failed file name and line number.

    Definition Classes
    StackDepthExceptionStackDepth
  17. def fillInStackTrace(): Throwable

    Permalink
    Definition Classes
    Throwable
  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def getCause(): Throwable

    Permalink
    Definition Classes
    Throwable
  20. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  21. def getLocalizedMessage(): String

    Permalink
    Definition Classes
    Throwable
  22. def getMessage(): String

    Permalink

    Returns the detail message string of this StackDepthException.

    Returns the detail message string of this StackDepthException.

    returns

    the detail message string of this StackDepthException instance (which may be null).

    Definition Classes
    StackDepthException → Throwable
  23. def getStackTrace(): Array[StackTraceElement]

    Permalink
    Definition Classes
    Throwable
  24. final def getSuppressed(): Array[Throwable]

    Permalink
    Definition Classes
    Throwable
  25. def hashCode(): Int

    Permalink

    Returns a hash code value for this object.

    Returns a hash code value for this object.

    Definition Classes
    TestFailedExceptionStackDepthException → AnyRef → Any
  26. final def initCause(throwable: Throwable): Throwable

    Permalink
    Definition Classes
    StackDepthException → Throwable
  27. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  28. lazy val message: Option[String]

    Permalink

    An optional detail message for this StackDepth exception.

    An optional detail message for this StackDepth exception.

    One reason this is lazy is to delay any searching of the stack trace until it is actually needed. It will usually be needed, but not always. For example, exceptions thrown during a shrink phase of a failed property will often be StackDepthExceptions, but whose message will never be used. Another related reason is to remove the need to create a different exception before creating this one just for the purpose of searching through its stack trace for the proper stack depth. Still one more reason is to allow the message to contain information about the stack depth, such as the failed file name and line number.

    Definition Classes
    StackDepthExceptionStackDepth
  29. val messageFun: (StackDepthException) ⇒ Option[String]

    Permalink

    a function that produces an optional detail message for this StackDepthException.

    a function that produces an optional detail message for this StackDepthException.

    Definition Classes
    StackDepthException
  30. def modifyMessage(fun: (Option[String]) ⇒ Option[String]): TestFailedException

    Permalink

    Returns an instance of this exception's class, identical to this exception, except with the detail message option string replaced with the result of passing the current detail message to the passed function, fun.

    Returns an instance of this exception's class, identical to this exception, except with the detail message option string replaced with the result of passing the current detail message to the passed function, fun.

    fun

    A function that, given the current optional detail message, will produce the modified optional detail message for the result instance of TestFailedException.

    Definition Classes
    TestFailedExceptionModifiableMessage
  31. def modifyPayload(fun: (Option[Any]) ⇒ Option[Any]): TestFailedException

    Permalink

    Returns an instance of this exception's class, identical to this exception, except with the payload option replaced with the result of passing the current payload option to the passed function, fun.

    Returns an instance of this exception's class, identical to this exception, except with the payload option replaced with the result of passing the current payload option to the passed function, fun.

    fun

    A function that, given the current optional payload, will produce the modified optional payload for the result instance of TestFailedException.

    Definition Classes
    TestFailedExceptionModifiablePayload
  32. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  33. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  34. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  35. val payload: Option[Any]

    Permalink

    an optional payload, which ScalaTest will include in a resulting TestFailed event

    an optional payload, which ScalaTest will include in a resulting TestFailed event

    Definition Classes
    TestFailedExceptionPayloadField
  36. val position: Option[Position]

    Permalink

    An optional source position describing the line of test code that caused this exception.

    An optional source position describing the line of test code that caused this exception.

    Definition Classes
    StackDepthExceptionStackDepth
  37. def printStackTrace(arg0: PrintWriter): Unit

    Permalink
    Definition Classes
    Throwable
  38. def printStackTrace(arg0: PrintStream): Unit

    Permalink
    Definition Classes
    Throwable
  39. def printStackTrace(): Unit

    Permalink
    Definition Classes
    Throwable
  40. def setStackTrace(arg0: Array[StackTraceElement]): Unit

    Permalink
    Definition Classes
    Throwable
  41. def severedAtStackDepth: TestFailedException

    Permalink

    Returns an exception of class TestFailedException with failedExceptionStackDepth set to 0 and all frames above this stack depth severed off.

    Returns an exception of class TestFailedException with failedExceptionStackDepth set to 0 and all frames above this stack depth severed off. This can be useful when working with tools (such as IDEs) that do not directly support ScalaTest. (Tools that directly support ScalaTest can use the stack depth information delivered in the StackDepth exceptions.)

    Definition Classes
    TestFailedExceptionStackDepth
  42. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  43. def toString(): String

    Permalink
    Definition Classes
    Throwable → AnyRef → Any
  44. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from PayloadField

Inherited from StackDepthException

Inherited from StackDepth

Inherited from RuntimeException

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped