PropertyCheckFailedException

Instance Constructors

new PropertyCheckFailedException(messageFun: (StackDepthException) ⇒ String, cause: Option[Throwable], failedCodeStackDepthFun: (StackDepthException) ⇒ Int, payload: Option[Any], undecoratedMessage: String, args: List[Any], optionalArgNames: Option[List[String]])

messageFun
a function that returns a detail message (not optional) for this PropertyCheckFailedException.
cause
an optional cause, the Throwable that caused this PropertyCheckFailedException 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.
payload
an optional payload, which ScalaTest will include in a resulting TestFailed event
undecoratedMessage
just a short message that has no redundancy with args, labels, etc. The regular "message" has everything in it.
args
the argument values that caused the property check to fail.
optionalArgNames
an optional list of string names for the arguments.

Exceptions thrown
NullArgumentException if any parameter is null or Some(null).

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
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.
val args: List[Any]

the argument values that caused the property check to fail.
final def asInstanceOf[T0]: T0

Definition Classes
Any
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
TestFailedException → StackDepthException
val cause: Option[Throwable]

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

Definition Classes
StackDepthException → StackDepth
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(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.

Definition Classes
TestFailedException → StackDepthException → AnyRef → Any
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

Definition Classes
StackDepth
def failedCodeFileNameAndLineNumberString: 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

Definition Classes
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

Definition Classes
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.

Definition Classes
StackDepthException → StackDepth
val failedCodeStackDepthFun: (StackDepthException) ⇒ Int

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.

Definition Classes
StackDepthException
def fillInStackTrace(): Throwable

Definition Classes
Throwable
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def getCause(): Throwable

Definition Classes
Throwable
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getLocalizedMessage(): String

Definition Classes
Throwable
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
def getStackTrace(): Array[StackTraceElement]

Definition Classes
Throwable
def hashCode(): Int

Returns a hash code value for this object.
Returns a hash code value for this object.

Definition Classes
TestFailedException → StackDepthException → AnyRef → Any
final def initCause(throwable: Throwable): Throwable

Definition Classes
StackDepthException → Throwable
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
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.

Definition Classes
StackDepthException → StackDepth
val messageFun: (StackDepthException) ⇒ Option[String]

a function that produces an optional detail message for this StackDepthException.
a function that produces an optional detail message for this StackDepthException.

Definition Classes
StackDepthException
def modifyMessage(fun: (Option[String]) ⇒ Option[String]): TestFailedException

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

Definition Classes
TestFailedException → ModifiableMessage
def modifyPayload(fun: (Option[Any]) ⇒ Option[Any]): 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.
fun
A function that, given the current optional payload, will produce the modified optional payload for the result instance of TestFailedException.

Definition Classes
TestFailedException → ModifiablePayload
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val payload: Option[Any]

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

Definition Classes
TestFailedException → PayloadField
def printStackTrace(arg0: PrintWriter): Unit

Definition Classes
Throwable
def printStackTrace(arg0: PrintStream): Unit

Definition Classes
Throwable
def printStackTrace(): Unit

Definition Classes
Throwable
def setStackTrace(arg0: Array[StackTraceElement]): Unit

Definition Classes
Throwable
def severedAtStackDepth: TestFailedException

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

Definition Classes
TestFailedException → StackDepth
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Throwable → AnyRef → Any
val undecoratedMessage: String

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.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package exceptions

abstract class PropertyCheckFailedException extends TestFailedException

Instance Constructors

new PropertyCheckFailedException(messageFun: (StackDepthException) ⇒ String, cause: Option[Throwable], failedCodeStackDepthFun: (StackDepthException) ⇒ Int, payload: Option[Any], undecoratedMessage: String, args: List[Any], optionalArgNames: Option[List[String]])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def argNames: List[String]

val args: List[Any]

final def asInstanceOf[T0]: T0

def canEqual(other: Any): Boolean

val cause: Option[Throwable]

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(other: Any): Boolean

def failedCodeFileName: Option[String]

def failedCodeFileNameAndLineNumberString: Option[String]

def failedCodeLineNumber: Option[Int]

lazy val failedCodeStackDepth: Int

val failedCodeStackDepthFun: (StackDepthException) ⇒ Int

def fillInStackTrace(): Throwable

def finalize(): Unit

def getCause(): Throwable

final def getClass(): Class[_]

def getLocalizedMessage(): String

def getMessage(): String

def getStackTrace(): Array[StackTraceElement]

def hashCode(): Int

final def initCause(throwable: Throwable): Throwable

final def isInstanceOf[T0]: Boolean

lazy val message: Option[String]

val messageFun: (StackDepthException) ⇒ Option[String]

def modifyMessage(fun: (Option[String]) ⇒ Option[String]): TestFailedException

def modifyPayload(fun: (Option[Any]) ⇒ Option[Any]): TestFailedException

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val payload: Option[Any]

def printStackTrace(arg0: PrintWriter): Unit

def printStackTrace(arg0: PrintStream): Unit

def printStackTrace(): Unit

def setStackTrace(arg0: Array[StackTraceElement]): Unit

def severedAtStackDepth: TestFailedException

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

val undecoratedMessage: String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from TestFailedException

Inherited from ModifiablePayload[TestFailedException]

Inherited from PayloadField

Inherited from ModifiableMessage[TestFailedException]

Inherited from StackDepthException

Inherited from StackDepth

Inherited from RuntimeException

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped