Constructs a TestRegistrationClosedException
with a message
and a pre-determined
and failedCodeStackDepth
.
Constructs a TestRegistrationClosedException
with a message
and a pre-determined
and failedCodeStackDepth
. (This was the primary constructor form prior to ScalaTest 1.5.)
the exception's detail message
the depth in the stack trace of this exception at which the line of test code that failed resides.
if message
is null
the exception's detail message
if either message
or failedCodeStackDepthFun
is null
Indicates whether this object can be equal to the passed object.
Indicates whether this object can be equal to the passed object.
An optional cause, the Throwable
that caused this StackDepth
exception to be thrown.
An optional cause, the Throwable
that caused this StackDepth
exception 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 TestRegistrationClosedException
, equality requires equal message
,
cause
, and failedCodeStackDepth
fields, as well as equal
return values of getStackTrace
.
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.
a string containing the filename that caused the failed test
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
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.
a string containing the 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.
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.
Returns the detail message string of this StackDepthException
.
Returns the detail message string of this StackDepthException
.
the detail message string of this StackDepthException
instance (which may be null
).
Returns a hash code value for this object.
Returns a hash code value for this object.
Returns an exception of class TestRegistrationClosedException
with failedExceptionStackDepth
set to 0 and
all frames above this stack depth severed off.
Returns an exception of class TestRegistrationClosedException
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.)
Exception that indicates an action that is only allowed during a suite's test registration phase, such as registering a test to run or ignore, was attempted after registration had already closed.
In suites that register tests as functions, such as
FunSuite
andFunSpec
, tests are normally registered during construction. Although it is not the usual approach, tests can also be registered after construction by invoking methods that register tests on the already constructed suite so long asrun
has not been invoked on that suite. As soon asrun
is invoked for the first time, registration of tests is "closed," meaning that any further attempts to register a test will fail (and result in an instance of this exception class being thrown). This can happen, for example, if an attempt is made to nest tests, such as in aFunSuite
:This exception encapsulates information about the stack depth at which the line of code that made this attempt resides, so that information can be presented to the user that makes it quick to find the problem 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 offending code.)
if either
message
orfailedCodeStackDepthFun
isnull