InfoProvided

final case class InfoProvided(ordinal: Ordinal, message: String, nameInfo: Option[NameInfo], throwable: Option[Throwable], formatter: Option[Formatter], location: Option[Location], payload: Option[Any], threadName: String, timeStamp: Long) extends RecordableEvent

Event used to provide information that is not appropriate to report via any other Event.

To create instances of this class you may use the factory method provided in its companion object. For example, given a report function named report, you could fire a InfoProvided event like this:

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

An InfoProvided event may be fired from anywhere. In this respect InfoProvided 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 InfoProvided event should include a NameInfo in which testName is defined. If fired in the context of a suite, but not a test, the InfoProvided 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 InfoProvided event (an Option[NameInfo]) should be None.

Value parameters:
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.

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

ordinal

an Ordinal that 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 InfoProvided event

threadName

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

throwable

an optional Throwable

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

class Event
trait Serializable
trait Product
trait Equals
trait Ordered[Event]
trait Comparable[Event]
class Object
trait Matchable
class Any

Value members

Inherited methods

def <(that: Event): Boolean
Inherited from:
Ordered
def <=(that: Event): Boolean
Inherited from:
Ordered
def >(that: Event): Boolean
Inherited from:
Ordered
def >=(that: Event): Boolean
Inherited from:
Ordered
def compare(that: Event): Int

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
def compareTo(that: Event): Int
Inherited from:
Ordered
def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product