NotAllowedException
Exception that indicates something was attempted in test code that is not allowed.
For example, in a FeatureSpec
, it is not allowed to nest a feature
clause inside another feature
clause. If this is attempted, the construction
of that suite will fail with a NotAllowedException
.
- Value parameters:
- cause
an optional cause
- message
a string that explains the problem
- posOrStackDepthFun
either a source position or 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.
- Throws:
- NullArgumentException
if either
message
orfailedCodeStackDepthFun
isnull
Value members
Constructors
Constructs a NotAllowedException
with given error message, optional cause and source position.
Constructs a NotAllowedException
with given error message, optional cause and source position.
- Value parameters:
- cause
the optional cause
- message
the exception's detail message
- pos
the source position
Constructs a NotAllowedException
with given error message and source position.
Constructs a NotAllowedException
with given error message and source position.
- Value parameters:
- message
the exception's detail message
- pos
the source position
Constructs a NotAllowedException
with pre-determined message
and
failedCodeStackDepth
. (This was the primary constructor form prior to ScalaTest 1.5.)
Constructs a NotAllowedException
with pre-determined message
and
failedCodeStackDepth
. (This was the primary constructor form prior to ScalaTest 1.5.)
- Value parameters:
- failedCodeStackDepth
the depth in the stack trace of this exception at which the line of code that attempted something not allowed resides.
- message
the exception's detail message
- Throws:
- NullArgumentException
if
message
isnull
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.
- Value parameters:
- failedCodeStackDepthFun
a function that return the depth in the stack trace of this exception at which the line of code that attempted
- message
the exception's detail message
- Throws:
- NullArgumentException
if
message
isnull
Concrete methods
Indicates whether this object can be equal to the passed object.
Indicates whether this object can be equal to the passed object.
- Definition Classes
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
.
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
.
- Definition Classes
- StackDepthException -> Any
Returns a hash code value for this object.
Returns a hash code value for this object.
- Definition Classes
- StackDepthException -> Any
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.)
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.)
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 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
- StackDepthException -> Throwable
- Inherited from:
- StackDepthException
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
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.
- Inherited from:
- StackDepthException