org.scalatest.exceptions

TestFailedDueToTimeoutException

class TestFailedDueToTimeoutException extends TestFailedException with TimeoutField

Subclass of TestFailedException representing tests that failed because of a timeout.

This exception is thrown by the failAfter method of trait Timeouts, the eventually method of trait Eventually, and the await methods of trait AsyncAssertions.

Source
TestFailedDueToTimeoutException.scala
Exceptions thrown
NullPointerException

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

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. TestFailedDueToTimeoutException
  2. TimeoutField
  3. TestFailedException
  4. ModifiablePayload
  5. PayloadField
  6. ModifiableMessage
  7. StackDepthException
  8. StackDepth
  9. RuntimeException
  10. Exception
  11. Throwable
  12. Serializable
  13. AnyRef
  14. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

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

    messageFun

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

    cause

    an optional cause, the Throwable that caused this TestFailedDueToTimeoutException 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.

    timeout

    the timeout that expired

    Exceptions thrown
    NullPointerException

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

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. def canEqual(other: Any): Boolean

    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
  8. def clone(): AnyRef

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

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

    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]

    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]

    A string that provides the filename and 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 filename and 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 user-presentable string containing the filename and line number that caused the failed test

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

    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
  14. lazy val failedCodeStackDepth: Int

    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
  15. def fillInStackTrace(): Throwable

    Definition Classes
    Throwable
  16. def finalize(): Unit

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

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

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

    Definition Classes
    Throwable
  20. def getMessage(): String

    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
  21. def getStackTrace(): Array[StackTraceElement]

    Definition Classes
    Throwable
  22. def hashCode(): Int

    Returns a hash code value for this object.

    Returns a hash code value for this object.

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

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

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

    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
  26. def modifyMessage(fun: (Option[String]) ⇒ Option[String]): TestFailedDueToTimeoutException

    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 TestFailedDueToTimeoutException.

    Definition Classes
    TestFailedDueToTimeoutExceptionTestFailedExceptionModifiableMessage
  27. def modifyPayload(fun: (Option[Any]) ⇒ Option[Any]): TestFailedDueToTimeoutException

    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 TestFailedDueToTimeoutException.

    Definition Classes
    TestFailedDueToTimeoutExceptionTestFailedExceptionModifiablePayload
  28. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  31. def printStackTrace(arg0: PrintWriter): Unit

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

    Definition Classes
    Throwable
  33. def printStackTrace(): Unit

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

    Definition Classes
    Throwable
  35. def severedAtStackDepth: TestFailedException

    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
  36. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  37. val timeout: Span

    the timeout that expired

    the timeout that expired

    Definition Classes
    TestFailedDueToTimeoutExceptionTimeoutField
  38. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from TimeoutField

Inherited from TestFailedException

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