Construct a NotAllowedException
with pre-determined message
and
a function that returns the depth in the stack trace of this exception at which the line of code that attempted.
Construct a NotAllowedException
with pre-determined message
and
a function that returns the depth in the stack trace of this exception at which the line of code that attempted.
the exception's detail message
a function that return the depth in the stack trace of this exception at which the line of code that attempted
NullArgumentException
if message
is null
Constructs a NotAllowedException
with pre-determined message
and
failedCodeStackDepth
.
Constructs a NotAllowedException
with pre-determined message
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 code that attempted something not allowed resides.
NullArgumentException
if message
is null
a string that explains the problem
an optional cause
a function that return the depth in the stack trace of this exception at which the line of code that attempted something not allowed resides.
NullArgumentException
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 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 NotAllowedException
, 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.
a function that produces the depth in the stack trace of this exception at which the line of test code that failed resides.
a function that produces the depth in the stack trace of this exception at which the line of test code that failed resides.
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.
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.
a function that produces an optional detail message for this StackDepthException
.
a function that produces an optional detail message for this StackDepthException
.
Returns an exception of class NotAllowedException
with failedExceptionStackDepth
set to 0 and
all frames above this stack depth severed off.
Returns an exception of class NotAllowedException
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 something was attempted in test code that is not allowed. For example, in a
FeatureSpec
, it is not allowed to nest afeature
clause inside anotherfeature
clause. If this is attempted, the construction of that suite will fail with aNotAllowedException
.NullArgumentException
if eithermessage
orfailedCodeStackDepthFun
isnull