org.scalatest

# TestFailedException

#### class TestFailedException extends StackDepthException with ModifiableMessage[TestFailedException]

Exception that indicates a test failed. The purpose of this exception is to encapsulate information about the stack depth at which the line of test code that failed resides, so that information can be presented to the user that makes it quick to find the failing line of test code. (In other words, the user need not scan through the stack trace to find the correct filename and line number of the failing test.)

linear super types: ModifiableMessage[TestFailedException], StackDepthException, StackDepth, RuntimeException, Exception, Throwable, Serializable, AnyRef, Any
known subclasses: PropertyCheckFailedException, TableDrivenPropertyCheckFailedException, GeneratorDrivenPropertyCheckFailedException, PropertyTestFailedException
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. Hide All
2. Show all

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

Visibility

1. Public
2. All

Impl.

1. Concrete
2. Abstract

### Instance constructors

1. #### new TestFailedException (message: String, cause: Throwable, failedCodeStackDepth: Int)

   Create a `TestFailedException` with the specified stack depth, detail message, and cause.

   Create a `TestFailedException` with the specified stack depth, detail message, and cause.

   Note that the detail message associated with cause isnot automatically incorporated in this throwable's detail message.

   message

     A detail message for this `TestFailedException`.

   cause

     the cause, the `Throwable` that caused this `TestFailedException` to be thrown.

   failedCodeStackDepth

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

2. #### new TestFailedException (cause: Throwable, failedCodeStackDepth: Int)

   Create a `TestFailedException` with the specified stack depth and cause.

   Create a `TestFailedException` with the specified stack depth and cause. The`message` field of this exception object will be initialized to`if (cause.getMessage == null) "" else cause.getMessage`.

   cause

     the cause, the `Throwable` that caused this `TestFailedException` to be thrown.

   failedCodeStackDepth

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

3. #### new TestFailedException (message: String, failedCodeStackDepth: Int)

   Create a `TestFailedException` with a specified stack depth and detail message.

   Create a `TestFailedException` with a specified stack depth and detail message.

   message

     A detail message for this `TestFailedException`.

   failedCodeStackDepth

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

4. #### new TestFailedException (failedCodeStackDepth: Int)

   Create a `TestFailedException` with specified stack depth and no detail message or cause.

   Create a `TestFailedException` with specified stack depth and no detail message or cause.

   failedCodeStackDepth

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

5. #### new TestFailedException (message: Option[String], cause: Option[Throwable], failedCodeStackDepth: Int)

   Constructs a `TestFailedException` with pre-determined `message` and `failedCodeStackDepth`.

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

   message

     an optional detail message for this `StackDepthException`.

   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.

6. #### new TestFailedException (messageFun: (StackDepthException) ⇒ Option[String], cause: Option[Throwable], failedCodeStackDepthFun: (StackDepthException) ⇒ Int)

   messageFun

     a function that produces an optional detail message for this `TestFailedException`.

   cause

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

   failedCodeStackDepthFun

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

### Value Members

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

   attributes: final
   definition classes: AnyRef

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

   `o != arg0` is the same as `!(o == (arg0))`.

   `o != arg0` is the same as `!(o == (arg0))`.

   arg0

     the object to compare against this object for dis-equality.

   returns

     `false` if the receiver object is equivalent to the argument; `true` otherwise.

   attributes: final
   definition classes: Any

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

   attributes: final
   definition classes: AnyRef → Any

4. #### def $asInstanceOf [T0] () : T0

   attributes: final
   definition classes: AnyRef

5. #### def $isInstanceOf [T0] () : Boolean

   attributes: final
   definition classes: AnyRef

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

   `o == arg0` is the same as `if (o eq null) arg0 eq null else o.equals(arg0)`.

   `o == arg0` is the same as `if (o eq null) arg0 eq null else o.equals(arg0)`.

   arg0

     the object to compare against this object for equality.

   returns

     `true` if the receiver object is equivalent to the argument; `false` otherwise.

   attributes: final
   definition classes: AnyRef

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

   `o == arg0` is the same as `o.equals(arg0)`.

   `o == arg0` is the same as `o.equals(arg0)`.

   arg0

     the object to compare against this object for equality.

   returns

     `true` if the receiver object is equivalent to the argument; `false` otherwise.

   attributes: final
   definition classes: Any

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

   This method is used to cast the receiver object to be of type `T0`.

   This method is used to cast the receiver object to be of type `T0`.

   Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression`1.asInstanceOf[String]` will throw a `ClassCastException` at runtime, while the expression`List(1).asInstanceOf[List[String]]` will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

   returns

     the receiver object.

   attributes: final
   definition classes: Any

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

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

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the `clone` method is platform dependent.

    returns

      a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef

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

    This method is used to test whether the argument (`arg0`) is a reference to the receiver object (`this`).

    This method is used to test whether the argument (`arg0`) is a reference to the receiver object (`this`).

    The `eq` method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of `AnyRef`: * It is reflexive: for any non-null instance `x` of type `AnyRef`, `x.eq(x)` returns `true`. * It is symmetric: for any non-null instances `x` and `y` of type `AnyRef`, `x.eq(y)` returns `true` if and only if `y.eq(x)` returns `true`. * It is transitive: for any non-null instances `x`, `y`, and `z` of type `AnyRef` if `x.eq(y)` returns `true` and `y.eq(z)` returns `true`, then `x.eq(z)` returns `true`.

    Additionally, the `eq` method has three other properties. * It is consistent: for any non-null instances `x` and `y` of type `AnyRef`, multiple invocations of `x.eq(y)` consistently returns `true` or consistently returns `false`. * For any non-null instance `x` of type `AnyRef`, `x.eq(null)` and `null.eq(x)` returns `false`. * `null.eq(null)` returns `true`.

    When overriding the `equals` or `hashCode` methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (`o1 eq o2`), they should be equal to each other (`o1 == o2`) and they should hash to the same value (`o1.hashCode == o2.hashCode`).

    arg0

      the object to compare against this object for reference equality.

    returns

      `true` if the argument is a reference to the receiver object; `false` otherwise.

    attributes: final
    definition classes: AnyRef

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

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

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

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

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

    definition classes: StackDepthException → StackDepth

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

    definition classes: Throwable

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

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the `finalize` method are invoked, as well as the interaction between `finalize`and non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef

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

    definition classes: Throwable

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

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

      a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef

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

    definition classes: Throwable

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

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

    definition classes: Throwable

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

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

    attributes: final
    definition classes: StackDepthException → Throwable

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

    This method is used to test whether the dynamic type of the receiver object is `T0`.

    This method is used to test whether the dynamic type of the receiver object is `T0`.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression`1.isInstanceOf[String]` will return `false`, while the expression `List(1).isInstanceOf[List[String]]` will return `true`. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

      `true` if the receiver object is an instance of erasure of type `T0`; `false` otherwise.

    attributes: final
    definition classes: Any

27. #### lazy val message : Option[String]

    An optional detail message for this `StackDepth` exception.

    An optional detail message for this `StackDepth` exception.

    definition classes: StackDepthException → StackDepth

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

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

    `o.ne(arg0)` is the same as `!(o.eq(arg0))`.

    `o.ne(arg0)` is the same as `!(o.eq(arg0))`.

    arg0

      the object to compare against this object for reference dis-equality.

    returns

      `false` if the argument is not a reference to the receiver object; `true` otherwise.

    attributes: final
    definition classes: AnyRef

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

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef

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

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef

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

    definition classes: Throwable

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

    definition classes: Throwable

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

    definition classes: Throwable

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

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

      a string representation of the object.

    definition classes: Throwable → AnyRef → Any

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

    attributes: final
    definition classes: AnyRef

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

    attributes: final
    definition classes: AnyRef

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

    attributes: final
    definition classes: AnyRef

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