org.scalatest

StackDepthException

class StackDepthException extends RuntimeException with StackDepth

Exception class that encapsulates information about the stack depth at which the line of code that failed resides, so that information can be presented to the user that makes it quick to find the failing line of code. (In other words, the user need not scan through the stack trace to find the correct filename and line number of the problem code.) Having a stack depth is more useful in a testing environment in which test failures are implemented as thrown exceptions, as is the case in ScalaTest's built-in suite traits.

Attributes
abstract
Linear Supertypes
StackDepth, RuntimeException, Exception, Throwable, Serializable, AnyRef, Any
Known Subclasses
DuplicateTestNameException, NotAllowedException, PropertyTestFailedException, TestFailedException, TestRegistrationClosedException
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. StackDepthException
  2. StackDepth
  3. RuntimeException
  4. Exception
  5. Throwable
  6. Serializable
  7. AnyRef
  8. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StackDepthException (message: Option[String], cause: Option[Throwable], failedCodeStackDepth: Int)

    message

    an optional detail message for this StackDepthException.

    cause

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

    failedCodeStackDepth

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

Abstract Value Members

  1. def severedAtStackDepth : Throwable with StackDepth

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

    Returns an exception of the same class 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.)

    Attributes
    abstract
    Definition Classes
    StackDepth

Concrete Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any

  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  6. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any

  7. def canEqual (other: Any): Boolean

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

  8. val cause : Option[Throwable]

    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
    StackDepthException → StackDepth

  9. def clone (): AnyRef

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

  10. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  11. 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 StackDepthException, equality requires equal message, cause, and failedCodeStackDepth fields, as well as equal return values of getStackTrace.

    Definition Classes
    StackDepthException → AnyRef → Any

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

    Definition Classes
    StackDepthException → StackDepth

  14. def fillInStackTrace (): Throwable

    Definition Classes
    Throwable

  15. def finalize (): Unit

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

  16. def getCause (): Throwable

    Definition Classes
    Throwable

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

    Attributes
    final
    Definition Classes
    AnyRef

  18. def getLocalizedMessage (): String

    Definition Classes
    Throwable

  19. def getMessage (): String

    Definition Classes
    Throwable

  20. def getStackTrace (): Array[StackTraceElement]

    Definition Classes
    Throwable

  21. def hashCode (): Int

    Returns a hash code value for this object.

    Returns a hash code value for this object.

    Definition Classes
    StackDepthException → AnyRef → Any

  22. def initCause (throwable: Throwable): Throwable

    Attributes
    final
    Definition Classes
    StackDepthException → Throwable

  23. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any

  24. val message : Option[String]

    an optional detail message for this StackDepthException.

    an optional detail message for this StackDepthException.

    Definition Classes
    StackDepthException → StackDepth

  25. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  26. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  27. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  28. def printStackTrace (arg0: PrintWriter): Unit

    Definition Classes
    Throwable

  29. def printStackTrace (arg0: PrintStream): Unit

    Definition Classes
    Throwable

  30. def printStackTrace (): Unit

    Definition Classes
    Throwable

  31. def setStackTrace (arg0: Array[StackTraceElement]): Unit

    Definition Classes
    Throwable

  32. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef

  33. def toString (): String

    Definition Classes
    Throwable → AnyRef → Any

  34. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  36. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from StackDepth

Inherited from RuntimeException

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any