Packages

t

org.scalatest.exceptions

PayloadField

trait PayloadField extends AnyRef

Trait implemented by exception types that carry an optional payload.

Many ScalaTest events include an optional "payload" field that can be used to pass information to a custom reporter. This trait facilitates such customization, by allowing test code to include a payload in an exception (such as TestFailedException). ScalaTest looks for this trait and fires any payloads it finds in the relevant ScalaTest event stimulated by the exception, such as a TestFailed event stimulated by a TestFailedException. (Although in its initial release there is only two subclasses of PayloadField in ScalaTest, TestFailedException and TestCanceledException, in future version of ScalaTest, there could be more)

For an example of how payloads could be used, see the documentation for trait Payloads.

Self Type
PayloadField with Throwable
Source
PayloadField.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
GeneratorDrivenPropertyCheckFailedException, PropertyCheckFailedException, TableDrivenPropertyCheckFailedException, TestCanceledException, TestFailedDueToTimeoutException, TestFailedException, JUnitTestFailedError
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PayloadField
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val payload: Option[Any]

    The optional payload.