This constructor has been deprecated and will be removed in a future version of ScalaTest.

This constructor has been deprecated and will be removed in a future version of ScalaTest. Please
use the primary constructor instead.

Annotations

@deprecated

Deprecated

Please use the primary constructor instead.

Value Members

final def!=(arg0: AnyRef): Boolean

Definition Classes

AnyRef

final def!=(arg0: Any): Boolean

Definition Classes

Any

final def##(): Int

Definition Classes

AnyRef → Any

final def==(arg0: AnyRef): Boolean

Definition Classes

AnyRef

final def==(arg0: Any): Boolean

Definition Classes

Any

defargNames: 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.

defclone(): AnyRef

final defeq(arg0: AnyRef): Boolean

Definition Classes

AnyRef

defequals(other: Any): Boolean

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.

deffailedCodeFileName: 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.

deffailedCodeFileNameAndLineNumberString: Option[String]

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.

returns

a user-presentable string containing the filename and line number that caused the failed test

deffailedCodeLineNumber: 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.

lazy valfailedCodeStackDepth: 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.

final definitCause(throwable: Throwable): Throwable

final defisInstanceOf[T0]: Boolean

vallabels: List[String]

the labels, if any (see the ScalaCheck user guide for information on labels)

lazy valmessage: 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.

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.

fun

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

defprintStackTrace(): Unit

defsetStackTrace(arg0: Array[StackTraceElement]): Unit

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