Class

org.scalatest.exceptions

PropertyCheckFailedException

Related Doc: package exceptions

Permalink

abstract class PropertyCheckFailedException extends TestFailedException

Exception that indicates a property check failed.

Source
PropertyCheckFailedException.scala
Exceptions thrown

NullArgumentException if any parameter is null or Some(null).

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. PropertyCheckFailedException
  2. TestFailedException
  3. ModifiablePayload
  4. PayloadField
  5. ModifiableMessage
  6. StackDepthException
  7. StackDepth
  8. RuntimeException
  9. Exception
  10. Throwable
  11. Serializable
  12. AnyRef
  13. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PropertyCheckFailedException(messageFun: (StackDepthException) ⇒ String, cause: Option[Throwable], failedCodeStackDepthFun: (StackDepthException) ⇒ Int, payload: Option[Any], undecoratedMessage: String, args: List[Any], optionalArgNames: Option[List[String]])

    Permalink

    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.

    payload

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

    undecoratedMessage

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

    args

    the argument values that caused the property check to fail.

    optionalArgNames

    an optional list of string names for the arguments.

    Exceptions thrown

    NullArgumentException if any parameter is null or Some(null).

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def argNames: List[String]

    Permalink

    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.

  5. val args: List[Any]

    Permalink

    the argument values that caused the property check to fail.

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def canEqual(other: Any): Boolean

    Permalink

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

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

    Definition Classes
    TestFailedExceptionStackDepthException
  8. val cause: Option[Throwable]

    Permalink

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

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

    Definition Classes
    StackDepthExceptionStackDepth
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  11. def equals(other: Any): Boolean

    Permalink

    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
    TestFailedExceptionStackDepthException → AnyRef → Any
  12. def failedCodeFileName: Option[String]

    Permalink

    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]

    Permalink

    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]

    Permalink

    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

    Permalink

    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
    StackDepthExceptionStackDepth
  16. val failedCodeStackDepthFun: (StackDepthException) ⇒ Int

    Permalink

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

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

    Definition Classes
    StackDepthException
  17. def fillInStackTrace(): Throwable

    Permalink
    Definition Classes
    Throwable
  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def getCause(): Throwable

    Permalink
    Definition Classes
    Throwable
  20. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  21. def getLocalizedMessage(): String

    Permalink
    Definition Classes
    Throwable
  22. def getMessage(): String

    Permalink

    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]

    Permalink
    Definition Classes
    Throwable
  24. def hashCode(): Int

    Permalink

    Returns a hash code value for this object.

    Returns a hash code value for this object.

    Definition Classes
    TestFailedExceptionStackDepthException → AnyRef → Any
  25. final def initCause(throwable: Throwable): Throwable

    Permalink
    Definition Classes
    StackDepthException → Throwable
  26. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  27. lazy val message: Option[String]

    Permalink

    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
    StackDepthExceptionStackDepth
  28. val messageFun: (StackDepthException) ⇒ Option[String]

    Permalink

    a function that produces an optional detail message for this StackDepthException.

    a function that produces an optional detail message for this StackDepthException.

    Definition Classes
    StackDepthException
  29. def modifyMessage(fun: (Option[String]) ⇒ Option[String]): TestFailedException

    Permalink

    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
    TestFailedExceptionModifiableMessage
  30. def modifyPayload(fun: (Option[Any]) ⇒ Option[Any]): TestFailedException

    Permalink

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

    Definition Classes
    TestFailedExceptionModifiablePayload
  31. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  32. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  33. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  34. val payload: Option[Any]

    Permalink

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

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

    Definition Classes
    TestFailedExceptionPayloadField
  35. def printStackTrace(arg0: PrintWriter): Unit

    Permalink
    Definition Classes
    Throwable
  36. def printStackTrace(arg0: PrintStream): Unit

    Permalink
    Definition Classes
    Throwable
  37. def printStackTrace(): Unit

    Permalink
    Definition Classes
    Throwable
  38. def setStackTrace(arg0: Array[StackTraceElement]): Unit

    Permalink
    Definition Classes
    Throwable
  39. def severedAtStackDepth: TestFailedException

    Permalink

    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
    TestFailedExceptionStackDepth
  40. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  41. def toString(): String

    Permalink
    Definition Classes
    Throwable → AnyRef → Any
  42. val undecoratedMessage: String

    Permalink

    just a short message that has no redundancy with args, labels, etc.

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

  43. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from TestFailedException

Inherited from PayloadField

Inherited from StackDepthException

Inherited from StackDepth

Inherited from RuntimeException

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped