org.scalatest

# 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 `Spec`, 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.)

Linear Supertypes
StackDepthException, StackDepth, RuntimeException, Exception, Throwable, Serializable, AnyRef, Any
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. Hide All
2. Show all

1. TestRegistrationClosedException
2. StackDepthException
3. StackDepth
4. RuntimeException
5. Exception
6. Throwable
7. Serializable
8. AnyRef
9. Any

Visibility

1. Public
2. All

### Instance Constructors

1. #### 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.

2. #### new TestRegistrationClosedException (message: String, failedCodeStackDepthFun: (StackDepthException) ⇒ Int)

   message

     the exception's detail message

### Value Members

1. #### def != (arg0: AnyRef): Boolean

   Attributes
     final
   Definition Classes
     AnyRef

2. #### def != (arg0: Any): Boolean

   Attributes
     final
   Definition Classes
     Any

3. #### def ## (): Int

   Attributes
     final
   Definition Classes
     AnyRef → Any

4. #### def == (arg0: AnyRef): Boolean

   Attributes
     final
   Definition Classes
     AnyRef

5. #### def == (arg0: Any): Boolean

   Attributes
     final
   Definition Classes
     Any

6. #### def asInstanceOf [T0] : T0

   Attributes
     final
   Definition Classes
     Any

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

8. #### 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.

   Definition Classes
     StackDepthException → StackDepth

9. #### def clone (): AnyRef

   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws()

10. #### def eq (arg0: AnyRef): Boolean

    Attributes
      final
    Definition Classes
      AnyRef

11. #### 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

12. #### 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

13. #### 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

14. #### 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

15. #### 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 `StackDepthException`s, 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

16. #### def fillInStackTrace (): Throwable

    Definition Classes
      Throwable

17. #### def finalize (): Unit

    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws()

18. #### def getCause (): Throwable

    Definition Classes
      Throwable

19. #### def getClass (): java.lang.Class[_]

    Attributes
      final
    Definition Classes
      AnyRef

20. #### def getLocalizedMessage (): String

    Definition Classes
      Throwable

21. #### 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

22. #### def getStackTrace (): Array[StackTraceElement]

    Definition Classes
      Throwable

23. #### 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

24. #### def initCause (throwable: Throwable): Throwable

    Attributes
      final
    Definition Classes
      StackDepthException → Throwable

25. #### def isInstanceOf [T0] : Boolean

    Attributes
      final
    Definition Classes
      Any

26. #### val messageFun : (StackDepthException) ⇒ Option[String]

    Definition Classes
      StackDepthException

27. #### def ne (arg0: AnyRef): Boolean

    Attributes
      final
    Definition Classes
      AnyRef

28. #### def notify (): Unit

    Attributes
      final
    Definition Classes
      AnyRef

29. #### def notifyAll (): Unit

    Attributes
      final
    Definition Classes
      AnyRef

30. #### def printStackTrace (arg0: PrintWriter): Unit

    Definition Classes
      Throwable

31. #### def printStackTrace (arg0: PrintStream): Unit

    Definition Classes
      Throwable

32. #### def printStackTrace (): Unit

    Definition Classes
      Throwable

33. #### def setStackTrace (arg0: Array[StackTraceElement]): Unit

    Definition Classes
      Throwable

34. #### 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

35. #### def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
      final
    Definition Classes
      AnyRef

36. #### def toString (): String

    Definition Classes
      Throwable → AnyRef → Any

37. #### def wait (): Unit

    Attributes
      final
    Definition Classes
      AnyRef
    Annotations
      @throws()

38. #### def wait (arg0: Long, arg1: Int): Unit

    Attributes
      final
    Definition Classes
      AnyRef
    Annotations
      @throws()

39. #### def wait (arg0: Long): Unit

    Attributes
      final
    Definition Classes
      AnyRef
    Annotations
      @throws()

### Inherited from StackDepthException

### Inherited from StackDepth

### Inherited from RuntimeException

### Inherited from Exception

### Inherited from Throwable

### Inherited from Serializable

### Inherited from AnyRef

### Inherited from Any