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.
- Value parameters:
- cause
an optional cause, the
Throwable
that caused thisStackDepthException
to be thrown.- messageFun
a function that produces an optional detail message for this
StackDepthException
.- posOrStackDepthFun
either 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.
- Throws:
- NullArgumentException
if either
messageFun
,cause
orfailedCodeStackDepthFun
isnull
, orSome(null)
.
Value members
Constructors
Constructs a StackDepthException
with an optional pre-determined message
, optional cause, and
a source position.
Constructs a StackDepthException
with an optional pre-determined message
, optional cause, and
a source position.
- Value parameters:
- cause
an optional cause, the
Throwable
that caused thisStackDepthException
to be thrown.- message
an optional detail message for this
StackDepthException
.- position
a source position. .
Constructs a StackDepthException
with message function, optional cause, and
a failedCodeStackDepth
function.
Constructs a StackDepthException
with message function, optional cause, and
a failedCodeStackDepth
function.
- Value parameters:
- cause
an optional cause, the
Throwable
that caused thisStackDepthException
to be thrown.- failedCodeStackDepthFun
a function that return the depth in the stack trace of this exception at which the line of test code that failed resides. .
- messageFun
a function that produces an optional detail message for this
StackDepthException
.
Constructs a StackDepthException
with an optional pre-determined message
, optional cause, and
a failedCodeStackDepth
function.
Constructs a StackDepthException
with an optional pre-determined message
, optional cause, and
a failedCodeStackDepth
function.
- Value parameters:
- cause
an optional cause, the
Throwable
that caused thisStackDepthException
to be thrown.- failedCodeStackDepthFun
a function that return the depth in the stack trace of this exception at which the line of test code that failed resides.
- message
an optional detail message for this
StackDepthException
.
- Throws:
- NullArgumentException
if either
message
orcause
isnull
orSome(null)
, orfailedCodeStackDepthFun
isnull
.
Constructs a StackDepthException
with an optional pre-determined message
,
optional cause
, and and failedCodeStackDepth
. (This was
the primary constructor form prior to ScalaTest 1.5.)
Constructs a StackDepthException
with an optional pre-determined message
,
optional cause
, and and failedCodeStackDepth
. (This was
the primary constructor form prior to ScalaTest 1.5.)
- Value parameters:
- cause
an optional cause, the
Throwable
that caused thisStackDepthException
to be thrown.- failedCodeStackDepth
the depth in the stack trace of this exception at which the line of test code that failed resides.
- message
an optional detail message for this
StackDepthException
.
- Throws:
- NullArgumentException
if either
message
ofcause
isnull
, orSome(null)
.
Concrete methods
Indicates whether this object can be equal to the passed object.
Indicates whether this object can be 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
.
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
- Any
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 benull
).- Definition Classes
- Throwable
Inherited methods
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
- Inherited from:
- StackDepth
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.
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
- Inherited from:
- StackDepth
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
- Inherited from:
- StackDepth
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.)
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.)
- Inherited from:
- StackDepth
Concrete fields
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 StackDepthException
s, 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.
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 StackDepthException
s, 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.
Inherited fields
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.
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
- Inherited from:
- StackDepth