Packages

c

org.scalatestplus.junit

JUnitTestFailedError

class JUnitTestFailedError extends AssertionFailedError with StackDepth with ModifiableMessage[JUnitTestFailedError] with PayloadField with ModifiablePayload[JUnitTestFailedError]

Exception that indicates a test failed.

The purpose of this exception is to encapsulate the same stack depth information provided by TestFailedException, which is used when running with ScalaTest, but be reported as a failure not an error when running with JUnit. The stack depth information indicates which line of test code failed, so that when running with ScalaTest information can be presented to the user that makes it quick to find the failing line of test code. (In other words, when running with ScalaTest the user need not scan through the stack trace to find the correct filename and line number of the failing test.)

JUnit distinguishes between failures and errors. If a test fails because of a failed assertion, that is considered a failure in JUnit. If a test fails for any other reason, either the test code or the application being tested threw an unexpected exception, that is considered an error in JUnit. This class differs from TestFailedException in that it extends junit.framework.AssertionFailedError. Instances of this class are thrown by the assertions provided by AssertionsForJUnit.

The way JUnit 3 (JUnit 3.8 and earlier releases) decided whether an exception represented a failure or error is that only thrown junit.framework.AssertionFailedErrors were considered failures. Any other exception type was considered an error. The exception type thrown by the JUnit 3 assertion methods declared in junit.framework.Assert (such as assertEquals, assertTrue, and fail) was, therefore, AssertionFailedError. In JUnit 4, AssertionFailedError was made to extend java.lang.AssertionError, and the distinction between failures and errors was essentially dropped. However, some tools that integrate with JUnit carry on this distinction, so even if you are using JUnit 4 you may want to use AssertionsForJUnit.

Source
JUnitTestFailedError.scala
Exceptions thrown

NullArgumentException if either message or cause is null, or Some(null).

Linear Supertypes
ModifiablePayload[JUnitTestFailedError], PayloadField, ModifiableMessage[JUnitTestFailedError], StackDepth, AssertionFailedError, AssertionError, Error, Throwable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JUnitTestFailedError
  2. ModifiablePayload
  3. PayloadField
  4. ModifiableMessage
  5. StackDepth
  6. AssertionFailedError
  7. AssertionError
  8. Error
  9. Throwable
  10. Serializable
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

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

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

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

    message

    A detail message for this JUnitTestFailedError.

    cause

    the cause, the Throwable that caused this JUnitTestFailedError to be thrown.

    failedCodeStackDepth

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

    Exceptions thrown

    NullArgumentException if either message or cause is null.

  2. new JUnitTestFailedError(cause: Throwable, failedCodeStackDepth: Int)

    Create a JUnitTestFailedError with the specified stack depth and cause.

    Create a JUnitTestFailedError 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 JUnitTestFailedError to be thrown.

    failedCodeStackDepth

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

    Exceptions thrown

    NullArgumentException if cause is null.

  3. new JUnitTestFailedError(message: String, failedCodeStackDepth: Int)

    Create a JUnitTestFailedError with a specified stack depth and detail message.

    Create a JUnitTestFailedError with a specified stack depth and detail message.

    message

    A detail message for this JUnitTestFailedError.

    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.

  4. new JUnitTestFailedError(failedCodeStackDepth: Int)

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

    Create a JUnitTestFailedError 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 JUnitTestFailedError(message: Option[String], cause: Option[Throwable], failedCodeStackDepth: Int, payload: Option[Any])
  6. new JUnitTestFailedError(message: Option[String], cause: Option[Throwable], pos: Position, payload: Option[Any])
  7. new JUnitTestFailedError(message: Option[String], cause: Option[Throwable], posOrStackDepth: Either[Position, Int], payload: Option[Any])

    message

    an optional detail message for this TestFailedException.

    cause

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

    payload

    an optional payload, which ScalaTest will include in a resulting JUnitTestFailedError event

    Exceptions thrown

    NullArgumentException if either message or cause is null, or Some(null).

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def addSuppressed(arg0: Throwable): Unit
    Definition Classes
    Throwable
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def canEqual(other: Any): Boolean

    Indicates whether this object can be equal to the passed object.

  7. 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
    JUnitTestFailedError → StackDepth
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. 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 JUnitTestFailedError, equality requires equal message, cause, and failedCodeStackDepth fields, as well as equal return values of getStackTrace.

    Definition Classes
    JUnitTestFailedError → AnyRef → Any
  11. 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
  12. 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
  13. 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
    JUnitTestFailedError → StackDepth
  14. 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
  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
    JUnitTestFailedError → StackDepth
  17. def fillInStackTrace(): Throwable
    Definition Classes
    Throwable
  18. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def getCause(): Throwable
    Definition Classes
    Throwable
  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def getLocalizedMessage(): String
    Definition Classes
    Throwable
  22. def getMessage(): String
    Definition Classes
    Throwable
  23. def getStackTrace(): Array[StackTraceElement]
    Definition Classes
    Throwable
  24. final def getSuppressed(): Array[Throwable]
    Definition Classes
    Throwable
  25. def hashCode(): Int

    Returns a hash code value for this object.

    Returns a hash code value for this object.

    Definition Classes
    JUnitTestFailedError → AnyRef → Any
  26. final def initCause(throwable: Throwable): Throwable
    Definition Classes
    JUnitTestFailedError → Throwable
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. val message: Option[String]

    An optional detail message for this StackDepth exception.

    An optional detail message for this StackDepth exception.

    Definition Classes
    JUnitTestFailedError → StackDepth
  29. def modifyMessage(fun: (Option[String]) ⇒ Option[String]): JUnitTestFailedError

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

    Definition Classes
    JUnitTestFailedError → ModifiableMessage
  30. def modifyPayload(fun: (Option[Any]) ⇒ Option[Any]): JUnitTestFailedError

    Returns an instance of this exception's class, identical to this exception, except with the payload option replaced with the result of passing the current payload option to the passed function, fun.

    Returns an instance of this exception's class, identical to this exception, except with the payload option replaced with the result of passing the current payload option to the passed function, fun.

    fun

    A function that, given the current optional payload, will produce the modified optional payload for the result instance of JUnitTestFailedError.

    Definition Classes
    JUnitTestFailedError → ModifiablePayload
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. val payload: Option[Any]

    The optional payload.

    The optional payload.

    Definition Classes
    JUnitTestFailedError → PayloadField
  35. val posOrStackDepth: Either[Position, Int]
  36. 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.

    Definition Classes
    JUnitTestFailedError → StackDepth
  37. def printStackTrace(arg0: PrintWriter): Unit
    Definition Classes
    Throwable
  38. def printStackTrace(arg0: PrintStream): Unit
    Definition Classes
    Throwable
  39. def printStackTrace(): Unit
    Definition Classes
    Throwable
  40. def setStackTrace(arg0: Array[StackTraceElement]): Unit
    Definition Classes
    Throwable
  41. def severedAtStackDepth: JUnitTestFailedError

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

    Returns an exception of class JUnitTestFailedError 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
    JUnitTestFailedError → StackDepth
  42. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  43. def toString(): String
    Definition Classes
    Throwable → AnyRef → Any
  44. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from ModifiablePayload[JUnitTestFailedError]

Inherited from PayloadField

Inherited from ModifiableMessage[JUnitTestFailedError]

Inherited from StackDepth

Inherited from AssertionFailedError

Inherited from AssertionError

Inherited from Error

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped