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.

Abstract Value Members

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

defclone(): AnyRef

final defeq(arg0: AnyRef): Boolean

Definition Classes

AnyRef

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

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

deffailedCodeFileNameAndLineNumberString: 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

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

lazy valfailedCodeStackDepth: 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.

final definitCause(throwable: Throwable): Throwable

final defisInstanceOf[T0]: Boolean

Definition Classes

Any

lazy valmessage: 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.