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.

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

Instance Constructors

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

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

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

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

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

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

Definition Classes
Ordered
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
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
def compareTo(that: Event): Int

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

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
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
AlertProvided → Event
final def getClass(): Class[_]

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

Definition Classes
Any
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
AlertProvided → Event
val message: String

a localized message suitable for presenting to the user
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
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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
AlertProvided → Event
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
AlertProvided → Event
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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
AlertProvided → Event
val throwable: Option[Throwable]

an optional Throwable
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
AlertProvided → Event
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws()

Instance Constructors

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

def <(that: Event): Boolean

def <=(that: Event): Boolean

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

def >(that: Event): Boolean

def >=(that: Event): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def compare(that: Event): Int

def compareTo(that: Event): Int

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

val formatter: Option[Formatter]

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val location: Option[Location]

val message: String

val nameInfo: Option[NameInfo]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val ordinal: Ordinal

val payload: Option[Any]

final def synchronized[T0](arg0: ⇒ T0): T0

val threadName: String

val throwable: Option[Throwable]

val timeStamp: Long

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

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