org.scalatest.events

AlertProvided

final case class AlertProvided(ordinal: Ordinal, message: String, nameInfo: Option[NameInfo], throwable: Option[Throwable] = scala.None, formatter: Option[Formatter] = scala.None, location: Option[Location] = scala.None, payload: Option[Any] = scala.None, threadName: String = ..., timeStamp: Long = new java.util.Date().getTime()) extends Event with NotificationEvent with Product with Serializable

Event used to provide alert notifications.

To create instances of this class you may use the factory method. For example, given a report function named report, you could fire an AlertProvided event like this:

report(AlertProvided(ordinal, message, Some(NameInfo(suiteName, suiteId, Some(thisSuite.getClass.getName), Some(testName)))))

AlertProvided differs from InfoProvided in that unlike InfoProvided, AlertProvided isn't a RecordableEvent. If fired becase of an alert call from a test, for example, the AlertProvided will immediately be sent to the reporters rather than being stored and sent in the recordedEvents field of the test completion event. Thus, AlertProvided enables "status notifications" to be provided while tests are happening. The difference between AlertProvided and NoteProvided, which is also a "status notification" fired immediately during tests, is that AlertProvided is intended for warnings, where as NoteProvided is just for information. As an illustration, AlertProvided messages are displayed in yellow, NoteProvided in green, in the stdout, stderr, and file reporters.

An AlertProvided event may be fired from anywhere. In this respect AlertProvided is different from events for which it is defined whether they are fired in the context of a suite or test. If fired in the context of a test, the AlertProvided event should include a NameInfo in which testName is defined. If fired in the context of a suite, but not a test, the AlertProvided event should include a NameInfo in which testName is not defined. If fired within the context of neither a suite nor a test, the nameInfo of the AlertProvided event (an Option[NameInfo]) should be None.

ordinal

an Ordinal that can be used to place this event in order in the context of other events reported during the same run

message

a localized message suitable for presenting to the user

nameInfo

an optional NameInfo that if defined, provides names for the suite and optionally the test in the context of which the information was provided

throwable

an optional Throwable

formatter

an optional Formatter that provides extra information that can be used by reporters in determining how to present this event to the user

location

An optional Location that provides information indicating where in the source code an event originated.

payload

an optional object that can be used to pass custom information to the reporter about the AlertProvided event

threadName

a name for the Thread about whose activity this event was reported

timeStamp

a Long indicating the time this event was reported, expressed in terms of the number of milliseconds since the standard base time known as "the epoch": January 1, 1970, 00:00:00 GMT

Source
Event.scala
Linear Supertypes
Serializable, Product, Equals, NotificationEvent, Event, Serializable, Ordered[Event], Comparable[Event], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AlertProvided
  2. Serializable
  3. Product
  4. Equals
  5. NotificationEvent
  6. Event
  7. Serializable
  8. Ordered
  9. Comparable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AlertProvided(ordinal: Ordinal, message: String, nameInfo: Option[NameInfo], throwable: Option[Throwable] = scala.None, formatter: Option[Formatter] = scala.None, location: Option[Location] = scala.None, payload: Option[Any] = scala.None, threadName: String = ..., timeStamp: Long = new java.util.Date().getTime())

    ordinal

    an Ordinal that can be used to place this event in order in the context of other events reported during the same run

    message

    a localized message suitable for presenting to the user

    nameInfo

    an optional NameInfo that if defined, provides names for the suite and optionally the test in the context of which the information was provided

    throwable

    an optional Throwable

    formatter

    an optional Formatter that provides extra information that can be used by reporters in determining how to present this event to the user

    location

    An optional Location that provides information indicating where in the source code an event originated.

    payload

    an optional object that can be used to pass custom information to the reporter about the AlertProvided event

    threadName

    a name for the Thread about whose activity this event was reported

    timeStamp

    a Long indicating the time this event was reported, expressed in terms of the number of milliseconds since the standard base time known as "the epoch": January 1, 1970, 00:00:00 GMT

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def <(that: Event): Boolean

    Definition Classes
    Ordered
  5. def <=(that: Event): Boolean

    Definition Classes
    Ordered
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. def >(that: Event): Boolean

    Definition Classes
    Ordered
  9. def >=(that: Event): Boolean

    Definition Classes
    Ordered
  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  12. def compare(that: Event): Int

    Comparing this event with the event passed as that.

    Comparing this event with the event passed as that. Returns x, where x < 0 iff this < that, x == 0 iff this == that, x > 0 iff this > that.

    that

    the event to compare to this event

    Definition Classes
    Event → Ordered
  13. def compareTo(that: Event): Int

    Definition Classes
    Ordered → Comparable
  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  16. val formatter: Option[Formatter]

    an optional Formatter that provides extra information that can be used by reporters in determining how to present this event to the user

    an optional Formatter that provides extra information that can be used by reporters in determining how to present this event to the user

    Definition Classes
    AlertProvidedEvent
  17. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  19. val location: Option[Location]

    An optional Location that provides information indicating where in the source code an event originated.

    An optional Location that provides information indicating where in the source code an event originated.

    Definition Classes
    AlertProvidedEvent
  20. val message: String

    a localized message suitable for presenting to the user

  21. val nameInfo: Option[NameInfo]

    an optional NameInfo that if defined, provides names for the suite and optionally the test in the context of which the information was provided

    an optional NameInfo that if defined, provides names for the suite and optionally the test in the context of which the information was provided

  22. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  25. val ordinal: Ordinal

    an Ordinal that can be used to place this event in order in the context of other events reported during the same run

    an Ordinal that can be used to place this event in order in the context of other events reported during the same run

    Definition Classes
    AlertProvidedEvent
  26. val payload: Option[Any]

    an optional object that can be used to pass custom information to the reporter about the AlertProvided event

    an optional object that can be used to pass custom information to the reporter about the AlertProvided event

    Definition Classes
    AlertProvidedEvent
  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  28. val threadName: String

    a name for the Thread about whose activity this event was reported

    a name for the Thread about whose activity this event was reported

    Definition Classes
    AlertProvidedEvent
  29. val throwable: Option[Throwable]

    an optional Throwable

  30. val timeStamp: Long

    a Long indicating the time this event was reported, expressed in terms of the number of milliseconds since the standard base time known as "the epoch": January 1, 1970, 00:00:00 GMT

    a Long indicating the time this event was reported, expressed in terms of the number of milliseconds since the standard base time known as "the epoch": January 1, 1970, 00:00:00 GMT

    Definition Classes
    AlertProvidedEvent
  31. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from NotificationEvent

Inherited from Event

Inherited from Serializable

Inherited from Ordered[Event]

Inherited from Comparable[Event]

Inherited from AnyRef

Inherited from Any

Ungrouped