scalatestCoreDottyJS
API
Generated with
scalatestCoreDottyJS/org.scalatest/org.scalatest.exceptions/TestRegistrationClosedException

TestRegistrationClosedException

org.scalatest.exceptions.TestRegistrationClosedException
class TestRegistrationClosedException(message: String, posOrStackDepthFun: Either[Position, StackDepthException => Int]) extends StackDepthException

Exception that indicates an action that is only allowed during a suite's test registration phase, such as registering a test to run or ignore, was attempted after registration had already closed.

In suites that register tests as functions, such as FunSuite and FunSpec, tests are normally registered during construction. Although it is not the usual approach, tests can also be registered after construction by invoking methods that register tests on the already constructed suite so long as run has not been invoked on that suite. As soon as run is invoked for the first time, registration of tests is "closed," meaning that any further attempts to register a test will fail (and result in an instance of this exception class being thrown). This can happen, for example, if an attempt is made to nest tests, such as in a FunSuite:

test("this test is fine") {
 test("but this nested test is not allowed") {
 }
}

This exception encapsulates information about the stack depth at which the line of code that made this attempt resides, so that information can be presented to the user that makes it quick to find the problem 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 offending code.)

Value parameters

message

the exception's detail message

posOrStackDepthFun

either a source position or a function that return the depth in the stack trace of this exception at which the line of code that attempted to register the test after registration had been closed.

Attributes

Throws
NullArgumentException

if either message or failedCodeStackDepthFun is null

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

Members list

Value members

Constructors

def this(message: String, pos: Position)

Constructs a TestRegistrationClosedException with a message and a source position.

Constructs a TestRegistrationClosedException with a message and a source position.

Value parameters

message

the exception's detail message

pos

the source position.

Attributes

Throws
NullArgumentException

if message or pos is null

def this(message: String, failedCodeStackDepth: Int)

Constructs a TestRegistrationClosedException with a message and a pre-determined and failedCodeStackDepth. (This was the primary constructor form prior to ScalaTest 1.5.)

Constructs a TestRegistrationClosedException with a message and a pre-determined and failedCodeStackDepth. (This was the primary constructor form prior to ScalaTest 1.5.)

Value parameters

failedCodeStackDepth

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

message

the exception's detail message

Attributes

Throws
NullArgumentException

if message is null

def this(message: String, failedCodeStackDepthFun: StackDepthException => Int)

Constructs a TestRegistrationClosedException with a message and a pre-determined and failedCodeStackDepthFun.

Constructs a TestRegistrationClosedException with a message and a pre-determined and failedCodeStackDepthFun.

Value parameters

failedCodeStackDepthFun

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

message

the exception's detail message

Attributes

Throws
NullArgumentException

if message or failedCodeStackDepthFun is null

Concrete methods

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.

Attributes

Definition Classes
override def equals(other: Any): Boolean

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

Attributes

Definition Classes
override def hashCode: Int

Returns a hash code value for this object.

Returns a hash code value for this object.

Attributes

Definition Classes
def severedAtStackDepth: TestRegistrationClosedException

Returns an exception of class TestRegistrationClosedException 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 TestRegistrationClosedException 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 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
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
StackDepthException -> Throwable
Inherited from:
StackDepthException
def getStackTrace(): Array[StackTraceElement]

Attributes

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

Attributes

Inherited from:
Throwable
final override def initCause(throwable: Throwable): Throwable

Attributes

Definition Classes
StackDepthException -> Throwable
Inherited from:
StackDepthException
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 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

Inherited 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

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

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

Inherited from:
StackDepthException
val messageFun: StackDepthException => Option[String]

Attributes

Inherited from:
StackDepthException
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 from:
StackDepthException
Generated with