Packages

c

org.scalatest.exceptions

TestRegistrationClosedException

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

Source
TestRegistrationClosedException.scala
Exceptions thrown

NullArgumentException if either message or failedCodeStackDepthFun is null

Linear Supertypes
StackDepthException, StackDepth, RuntimeException, Exception, Throwable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TestRegistrationClosedException
  2. StackDepthException
  3. StackDepth
  4. RuntimeException
  5. Exception
  6. Throwable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TestRegistrationClosedException(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.

    message

    the exception's detail message

    failedCodeStackDepthFun

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

    Exceptions thrown

    NullArgumentException if message or failedCodeStackDepthFun is null

  2. new TestRegistrationClosedException(message: String, failedCodeStackDepth: Int)

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

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

    message

    the exception's detail message

    failedCodeStackDepth

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

    Exceptions thrown

    NullArgumentException if message is null

  3. new TestRegistrationClosedException(message: String, pos: Position)

    Constructs a TestRegistrationClosedException with a message and a source position.

    Constructs a TestRegistrationClosedException with a message and a source position.

    message

    the exception's detail message

    pos

    the source position.

    Exceptions thrown

    NullArgumentException if message or pos is null

  4. new TestRegistrationClosedException(message: String, posOrStackDepthFun: Either[Position, (StackDepthException) ⇒ Int])

    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.

    Exceptions thrown

    NullArgumentException if either message or failedCodeStackDepthFun is null

Value Members

  1. final def addSuppressed(arg0: Throwable): Unit
    Definition Classes
    Throwable
  2. 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
    TestRegistrationClosedException → StackDepthException
  3. val cause: Option[Throwable]
    Definition Classes
    StackDepthException → StackDepth
  4. 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 TestRegistrationClosedException, equality requires equal message, cause, and failedCodeStackDepth fields, as well as equal return values of getStackTrace.

    Definition Classes
    TestRegistrationClosedException → StackDepthException → AnyRef → Any
  5. 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
  6. 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.

    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

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

    returns

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

    Definition Classes
    StackDepthException → StackDepth
  8. 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.

    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

    Definition Classes
    StackDepth
  9. 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
  10. 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
  11. def fillInStackTrace(): Throwable
    Definition Classes
    Throwable
  12. def getCause(): Throwable
    Definition Classes
    Throwable
  13. def getLocalizedMessage(): String
    Definition Classes
    Throwable
  14. 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
  15. def getStackTrace(): Array[StackTraceElement]
    Definition Classes
    Throwable
  16. final def getSuppressed(): Array[Throwable]
    Definition Classes
    Throwable
  17. def hashCode(): Int

    Returns a hash code value for this object.

    Returns a hash code value for this object.

    Definition Classes
    TestRegistrationClosedException → StackDepthException → AnyRef → Any
  18. final def initCause(throwable: Throwable): Throwable
    Definition Classes
    StackDepthException → Throwable
  19. 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
  20. val messageFun: (StackDepthException) ⇒ Option[String]
    Definition Classes
    StackDepthException
  21. val position: Option[Position]
    Definition Classes
    StackDepthException → StackDepth
  22. def printStackTrace(arg0: PrintWriter): Unit
    Definition Classes
    Throwable
  23. def printStackTrace(arg0: PrintStream): Unit
    Definition Classes
    Throwable
  24. def printStackTrace(): Unit
    Definition Classes
    Throwable
  25. def setStackTrace(arg0: Array[StackTraceElement]): Unit
    Definition Classes
    Throwable
  26. def severedAtStackDepth: TestRegistrationClosedException

    Returns an exception of class TestRegistrationClosedException with failedExceptionStackDepth set to 0 and all frames above this stack depth severed off.

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

    Definition Classes
    TestRegistrationClosedException → StackDepth
  27. def toString(): String
    Definition Classes
    Throwable → AnyRef → Any