scalatestCoreDotty
API
Generated with
scalatestCoreDotty/org.scalatest/org.scalatest.exceptions/StackDepthException

StackDepthException

org.scalatest.exceptions.StackDepthException
abstract class StackDepthException(val messageFun: StackDepthException => Option[String], val cause: Option[Throwable], posOrStackDepthFun: Either[Position, StackDepthException => Int]) extends RuntimeException, StackDepth

Exception class that encapsulates information about the stack depth at which the line of code that failed resides, so that information can be presented to the user that makes it quick to find the failing line of code. (In other words, the user need not scan through the stack trace to find the correct filename and line number of the problem code.) Having a stack depth is more useful in a testing environment in which test failures are implemented as thrown exceptions, as is the case in ScalaTest's built-in suite traits.

Value parameters

cause

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

messageFun

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

posOrStackDepthFun

either a source position or a function that produces the depth in the stack trace of this exception at which the line of test code that failed resides.

Attributes

Throws
NullArgumentException

if either messageFun, cause or failedCodeStackDepthFun is null, or Some(null).

Graph
Supertypes
trait StackDepth
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
Show all

Members list

Value members

Constructors

def this(message: Option[String], cause: Option[Throwable], position: Position)

Constructs a StackDepthException with an optional pre-determined message, optional cause, and a source position.

Constructs a StackDepthException with an optional pre-determined message, optional cause, and a source position.

Value parameters

cause

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

message

an optional detail message for this StackDepthException.

position

a source position. .

Attributes

def this(messageFun: StackDepthException => Option[String], cause: Option[Throwable], failedCodeStackDepthFun: StackDepthException => Int)

Constructs a StackDepthException with message function, optional cause, and a failedCodeStackDepth function.

Constructs a StackDepthException with message function, optional cause, and a failedCodeStackDepth function.

Value parameters

cause

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

failedCodeStackDepthFun

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

messageFun

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

Attributes

def this(message: Option[String], cause: Option[Throwable], failedCodeStackDepthFun: StackDepthException => Int)

Constructs a StackDepthException with an optional pre-determined message, optional cause, and a failedCodeStackDepth function.

Constructs a StackDepthException with an optional pre-determined message, optional cause, and a failedCodeStackDepth function.

Value parameters

cause

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

failedCodeStackDepthFun

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

message

an optional detail message for this StackDepthException.

Attributes

Throws
NullArgumentException

if either message or cause is null or Some(null), or failedCodeStackDepthFun is null.

def this(message: Option[String], cause: Option[Throwable], failedCodeStackDepth: Int)

Constructs a StackDepthException with an optional pre-determined message, optional cause, and and failedCodeStackDepth. (This was the primary constructor form prior to ScalaTest 1.5.)

Constructs a StackDepthException with an optional pre-determined message, optional cause, and and failedCodeStackDepth. (This was the primary constructor form prior to ScalaTest 1.5.)

Value parameters

cause

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

failedCodeStackDepth

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

message

an optional detail message for this StackDepthException.

Attributes

Throws
NullArgumentException

if either message of cause is null, or Some(null).

Concrete methods

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.

Attributes

override def equals(other: Any): Boolean

Indicates whether this object is equal to the passed object. If the passed object is a StackDepthException, 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 StackDepthException, equality requires equal message, cause, and failedCodeStackDepth fields, as well as equal return values of getStackTrace.

Attributes

Definition Classes
Any
override def getMessage: String

Returns the detail message string of this StackDepthException.

Returns the detail message string of this StackDepthException.

Attributes

Returns

the detail message string of this StackDepthException instance (which may be null).

Definition Classes
Throwable
override def hashCode: Int

Returns a hash code value for this object.

Returns a hash code value for this object.

Attributes

Definition Classes
Any
final override def initCause(throwable: Throwable): Throwable

Attributes

Definition Classes
Throwable

Inherited methods

final def addSuppressed(x$0: Throwable): Unit

Attributes

Inherited from:
Throwable
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.

Attributes

Returns

a string containing the filename that caused the failed test

Inherited from:
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 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.

Attributes

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.

Attributes

Returns

a string containing the line number that caused the failed test

Inherited from:
StackDepth
def fillInStackTrace(): Throwable

Attributes

Inherited from:
Throwable
def getCause(): Throwable

Attributes

Inherited from:
Throwable
def getLocalizedMessage(): String

Attributes

Inherited from:
Throwable
def getStackTrace(): Array[StackTraceElement]

Attributes

Inherited from:
Throwable
final def getSuppressed(): Array[Throwable]

Attributes

Inherited from:
Throwable
def printStackTrace(x$0: PrintWriter): Unit

Attributes

Inherited from:
Throwable
def printStackTrace(x$0: PrintStream): Unit

Attributes

Inherited from:
Throwable
def printStackTrace(): Unit

Attributes

Inherited from:
Throwable
def setStackTrace(x$0: Array[StackTraceElement]): Unit

Attributes

Inherited from:
Throwable
def severedAtStackDepth: Throwable & StackDepth

Returns an exception of the same class 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 the same class 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.)

Attributes

Inherited from:
StackDepth
def toString(): String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Inherited from:
Throwable

Concrete fields

val cause: Option[Throwable]

An optional cause, the Throwable that caused this StackDepth exception to be thrown.

An optional cause, the Throwable that caused this StackDepth exception to be thrown.

Attributes

lazy val failedCodeFilePathname: Option[String]

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.

Attributes

Returns

a string containing the full pathname of the source file containing the line of code that caused this exception

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.

Attributes

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.

Attributes

val messageFun: StackDepthException => Option[String]
val position: Option[Position]

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.

Attributes

Inherited fields

lazy val failedCodeFilePathnameAndLineNumberString: Option[String]

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.

Attributes

Returns

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

Inherited from:
StackDepth
Generated with