PropertyCheckFailedException
Related Doc:
package exceptions
Constructs a PropertyCheckFailedException with given error message function, optional cause, stack depth function,
optional payload, undecorated message, arguments values and optional argument names.
Constructs a PropertyCheckFailedException with given error message function, optional cause, stack depth function,
optional payload, undecorated message, arguments values and optional argument names.
a function that returns a detail message (not optional) for this PropertyCheckFailedException
an optional cause, the Throwable that caused this PropertyCheckFailedException to be thrown.
a function that returns the depth in the stack trace of this exception at which the line of test code that failed resides
an optional payload, which ScalaTest will include in a resulting TestFailed event
just a short message that has no redundancy with args, labels, etc. The regular "message" has everything in it.
the argument values that caused the property check to fail.
an optional list of string names for the arguments.
a function that returns a detail message (not optional) for this PropertyCheckFailedException.
an optional cause, the Throwable that caused this PropertyCheckFailedException to be thrown.
either a source position or a function that returns the depth in the stack trace of this exception at which the line of test code that failed resides.
an optional payload, which ScalaTest will include in a resulting TestFailed event
just a short message that has no redundancy with args, labels, etc. The regular "message" has everything in it.
the argument values that caused the property check to fail.
an optional list of string names for the arguments.
NullArgumentException if any parameter is null or Some(null).
A list of names for the arguments that caused the property check to fail.
A list of names for the arguments that caused the property check to fail.
If the optionalArgNames class parameter is defined, this method returns
the List[String] contained in the Some. Otherwise, it returns
a list that gives "arg0" for the zeroeth argument, "arg1" for the
first argument, "arg2" for the second argument, and so on.
the argument values that caused the property check to fail.
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 TestFailedException, 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 of the failing line.
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.
a user-presentable string containing the filename and line number that caused the failed test
A string that provides the full pathname of the source file containing the line of code that failed, suitable for presenting to a user.
A string that provides the full pathname of the source file containing the line of code that failed, suitable for presenting to a user.
a string containing the full pathname of the source file containing the line of code that caused this exception
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.
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 user-presentable string containing the absolute 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 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.
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 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.
a function that produces an optional detail message for this StackDepthException.
a function that produces an optional detail message for this StackDepthException.
Returns an instance of this exception's class, identical to this exception,
except with the detail message option string replaced with the result of passing
the current detail message to the passed function, fun.
Returns an instance of this exception's class, identical to this exception,
except with the detail message option string replaced with the result of passing
the current detail message to the passed function, fun.
A function that, given the current optional detail message, will produce
the modified optional detail message for the result instance of TestFailedException.
Returns an instance of this exception's class, identical to this exception,
except with the payload option replaced with the result of passing
the current payload option to the passed function, fun.
Returns an instance of this exception's class, identical to this exception,
except with the payload option replaced with the result of passing
the current payload option to the passed function, fun.
A function that, given the current optional payload, will produce
the modified optional payload for the result instance of TestFailedException.
an optional payload, which ScalaTest will include in a resulting TestFailed event
an optional payload, which ScalaTest will include in a resulting TestFailed event
An optional source position describing the line of test code that caused this exception.
An optional source position describing the line of test code that caused this exception.
Returns an exception of class TestFailedException with failedExceptionStackDepth set to 0 and
all frames above this stack depth severed off.
Returns an exception of class TestFailedException 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.)
just a short message that has no redundancy with args, labels, etc.
just a short message that has no redundancy with args, labels, etc. The regular "message" has everything in it.
Exception that indicates a property check failed.
NullArgumentExceptionif any parameter isnullorSome(null).