an optional detail message for this StackDepthException
.
an optional cause, the Throwable
that caused this StackDepthException
to be thrown.
the depth in the stack trace of this exception at which the line of test code that failed resides.
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.)
Indicates whether this object can be equal to the passed object.
an optional cause, the Throwable
that caused this StackDepthException
to be thrown.
an optional cause, the Throwable
that caused this StackDepthException
to be thrown.
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
.
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.
a user-presentable string containing the filename and line number that caused the failed test
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.
Returns a hash code value for this object.
Returns a hash code value for this object.
an optional detail message for this StackDepthException
.
an optional detail message for this StackDepthException
.
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.