AlertProvided
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.
- Value parameters:
- formatter
an optional
Formatterthat provides extra information that can be used by reporters in determining how to present this event to the user- location
An optional
Locationthat provides information indicating where in the source code an event originated.- message
a localized message suitable for presenting to the user
- nameInfo
an optional
NameInfothat if defined, provides names for the suite and optionally the test in the context of which the information was provided- ordinal
an
Ordinalthat can be used to place this event in order in the context of other events reported during the same run- payload
an optional object that can be used to pass custom information to the reporter about the
AlertProvidedevent- threadName
a name for the
Threadabout whose activity this event was reported- throwable
an optional
Throwable- timeStamp
a
Longindicating 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
Inherited methods
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.
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.
- Value parameters:
- return
an integer indicating whether this event is less than, equal to, or greater than the passed event
- that
the event to compare to this event
- Inherited from:
- Event