org.scalatest.prop

# TableDrivenPropertyCheckFailedException

#### class TableDrivenPropertyCheckFailedException extends PropertyCheckFailedException

Exception that indicates a table-driven property check failed.

For an introduction to using tables, see the documentation for trait TableDrivenPropertyChecks.

Linear Supertypes
PropertyCheckFailedException, TestFailedException, ModifiableMessage[TestFailedException], StackDepthException, StackDepth, RuntimeException, Exception, Throwable, Serializable, AnyRef, Any
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. Hide All
2. Show all

1. TableDrivenPropertyCheckFailedException
2. PropertyCheckFailedException
3. TestFailedException
4. ModifiableMessage
5. StackDepthException
6. StackDepth
7. RuntimeException
8. Exception
9. Throwable
10. Serializable
11. AnyRef
12. Any

Visibility

1. Public
2. All

### Instance Constructors

1. #### new TableDrivenPropertyCheckFailedException (messageFun: (StackDepthException) ⇒ String, cause: Option[Throwable], failedCodeStackDepthFun: (StackDepthException) ⇒ Int, undecoratedMessage: String, args: List[Any], namesOfArgs: List[String], row: Int)

   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.

   undecoratedMessage

     just a short message that has no redundancy with args, labels, etc. The regular "message" has everything in it

   args

     the argument values

   namesOfArgs

     a list of string names for the arguments

   row

     the index of the table row that failed the property check, causing this exception to be thrown

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

   Definition Classes
     PropertyCheckFailedException

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

   Attributes
     final
   Definition Classes
     Any

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

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 `TestFailedException`, equality requires equal `message`, `cause`, and `failedCodeStackDepth` fields, as well as equal return values of `getStackTrace`.

    Definition Classes
      TestFailedException → 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
      TestFailedException → 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. #### 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 `StackDepthException`s, 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

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

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

    Attributes
      final
    Definition Classes
      AnyRef

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

    Attributes
      final
    Definition Classes
      AnyRef

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

    Attributes
      final
    Definition Classes
      AnyRef

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

    Definition Classes
      Throwable

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

    Definition Classes
      Throwable

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

    Definition Classes
      Throwable

34. #### val row : Int

    the index of the table row that failed the property check, causing this exception to be thrown

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

    Definition Classes
      Throwable

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

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

    Attributes
      final
    Definition Classes
      AnyRef

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

    Definition Classes
      Throwable → AnyRef → Any

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

    Attributes
      final
    Definition Classes
      AnyRef
    Annotations
      @throws()

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

    Attributes
      final
    Definition Classes
      AnyRef
    Annotations
      @throws()

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

    Attributes
      final
    Definition Classes
      AnyRef
    Annotations
      @throws()

### Inherited from PropertyCheckFailedException

### Inherited from TestFailedException

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