TableDrivenPropertyCheckFailedException

class TableDrivenPropertyCheckFailedException(messageFun: StackDepthException => String, cause: Option[Throwable], posOrStackDepthFun: Either[Position, StackDepthException => Int], payload: Option[Any], undecoratedMessage: String, args: List[Any], namesOfArgs: List[String], val row: Int) extends PropertyCheckFailedException

Exception that indicates a table-driven property check failed.

For an introduction to using tables, see the documentation for trait TableDrivenPropertyChecks.

Value parameters:
args

the argument values

cause

an optional cause, the Throwable that caused this TableDrivenPropertyCheckFailedException to be thrown.

messageFun

a function that returns a detail message, not optional) for this TableDrivenPropertyCheckFailedException.

namesOfArgs

a list of string names for the arguments

payload

an optional payload, which ScalaTest will include in a resulting TestFailed event

posOrStackDepthFun

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.

row

the index of the table row that failed the property check, causing this exception to be thrown

undecoratedMessage

just a short message that has no redundancy with args, labels, etc. The regular "message" has everything in it

Throws:
NullArgumentException

if any parameter is null or Some(null).

class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any

Value members

Constructors

def this(messageFun: StackDepthException => String, cause: Option[Throwable], pos: Position, payload: Option[Any], undecoratedMessage: String, args: List[Any], namesOfArgs: List[String], row: Int)

Constructs a TableDrivenPropertyCheckFailedException with given error message function, optional cause, source position, optional payload, undecorated message, argument values and names, and index of the failing row.

Constructs a TableDrivenPropertyCheckFailedException with given error message function, optional cause, source position, optional payload, undecorated message, argument values and names, and index of the failing row.

Value parameters:
args

the argument values

cause

an optional cause, the Throwable that caused this TableDrivenPropertyCheckFailedException to be thrown.

messageFun

a function that returns a detail message, not optional) for this TableDrivenPropertyCheckFailedException.

namesOfArgs

a list of string names for the arguments

payload

an optional payload, which ScalaTest will include in a resulting TestFailed event

pos

a source position

row

the index of the table row that failed the property check, causing this exception to be thrown

undecoratedMessage

just a short message that has no redundancy with args, labels, etc. The regular "message" has everything in it

def this(messageFun: StackDepthException => String, cause: Option[Throwable], failedCodeStackDepthFun: StackDepthException => Int, payload: Option[Any], undecoratedMessage: String, args: List[Any], namesOfArgs: List[String], row: Int)

Constructs a TableDrivenPropertyCheckFailedException with given error message function, optional cause, source position, optional payload, undecorated message, argument values and names, and index of the failing row.

Constructs a TableDrivenPropertyCheckFailedException with given error message function, optional cause, source position, optional payload, undecorated message, argument values and names, and index of the failing row.

Value parameters:
args

the argument values

cause

an optional cause, the Throwable that caused this TableDrivenPropertyCheckFailedException to be thrown.

failedCodeStackDepthFun

a function that returns the depth in the stack trace of this exception at which the line of test code that failed resides.

messageFun

a function that returns a detail message, not optional) for this TableDrivenPropertyCheckFailedException.

namesOfArgs

a list of string names for the arguments

payload

an optional payload, which ScalaTest will include in a resulting TestFailed event

row

the index of the table row that failed the property check, causing this exception to be thrown

undecoratedMessage

just a short message that has no redundancy with args, labels, etc. The regular "message" has everything in it

Concrete methods

override def modifyMessage(fun: Option[String] => Option[String]): TableDrivenPropertyCheckFailedException

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.

Value parameters:
fun

A function that, given the current optional detail message, will produce the modified optional detail message for the result instance of TestFailedDueToTimeoutException.

Definition Classes
override def modifyPayload(fun: Option[Any] => Option[Any]): TableDrivenPropertyCheckFailedException

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.

Value parameters:
fun

A function that, given the current optional payload, will produce the modified optional payload for the result instance of TableDrivenPropertyCheckFailedException.

Definition Classes

Inherited methods

final def addSuppressed(x$0: Throwable): Unit
Inherited from:
Throwable
def argNames: List[String]

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.

Inherited from:
PropertyCheckFailedException
override def canEqual(other: Any): Boolean

Indicates whether this object can be equal to the passed object.

Indicates whether this object can be equal to the passed object.

Definition Classes
Inherited from:
TestFailedException
override def equals(other: Any): Boolean

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.

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.

Definition Classes
Inherited from:
TestFailedException
def failedCodeFileName: Option[String]

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
def failedCodeLineNumber: Option[Int]

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
def fillInStackTrace(): Throwable
Inherited from:
Throwable
def getCause(): Throwable
Inherited from:
Throwable
def getLocalizedMessage(): String
Inherited from:
Throwable
override def getMessage: String

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 be null).

Definition Classes
StackDepthException -> Throwable
Inherited from:
StackDepthException
def getStackTrace(): Array[StackTraceElement]
Inherited from:
Throwable
final def getSuppressed(): Array[Throwable]
Inherited from:
Throwable
override def hashCode: Int

Returns a hash code value for this object.

Returns a hash code value for this object.

Definition Classes
Inherited from:
TestFailedException
final override def initCause(throwable: Throwable): Throwable
Definition Classes
StackDepthException -> Throwable
Inherited from:
StackDepthException
def printStackTrace(x$0: PrintWriter): Unit
Inherited from:
Throwable
def printStackTrace(x$0: PrintStream): Unit
Inherited from:
Throwable
def printStackTrace(): Unit
Inherited from:
Throwable
def setStackTrace(x$0: Array[StackTraceElement]): Unit
Inherited from:
Throwable

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.)

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.)

Inherited from:
TestFailedException
def toString(): String
Inherited from:
Throwable

Concrete fields

val row: Int

Inherited fields

val analysis: IndexedSeq[String]
Inherited from:
TestFailedException
lazy val failedCodeFilePathname: Option[String]
Inherited from:
StackDepthException

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
lazy val failedCodeStackDepth: Int

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.

Inherited from:
StackDepthException
lazy val message: Option[String]

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.

Inherited from:
StackDepthException
val position: Option[Position]
Inherited from:
StackDepthException