org.scalatest.events.InfoProvided

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, Some(thisSuite.getClass.getName), Some(testName)))))

An InfoProvided event may be fired from anywhere. In this respect InfoProvided is different from the other 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.

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
aboutAPendingTest: indicates whether the information being provided via this event is about a pending test
aboutACanceledTest: indicates whether the information being provided via this event is about a canceled test
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 InfoProvided 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

Attributes: final

Linear Supertypes

Serializable, Product, Equals, Event, Serializable, Ordered[Event], Comparable[Event], AnyRef, Any

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

InfoProvided
Serializable
Product
Equals
Event
Serializable
Ordered
Comparable
AnyRef
Any

Visibility

Public
All

Instance Constructors

new InfoProvided (ordinal: Ordinal, message: String, nameInfo: Option[NameInfo], aboutAPendingTest: Option[Boolean], aboutACanceledTest: Option[Boolean], throwable: Option[Throwable], formatter: Option[Formatter], location: Option[Location], payload: Option[Any], threadName: String, timeStamp: Long)

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
aboutAPendingTest
indicates whether the information being provided via this event is about a pending test
aboutACanceledTest
indicates whether the information being provided via this event is about a canceled test
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 InfoProvided 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

def != (arg0: AnyRef): Boolean

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

Attributes
final
Definition Classes
Any
def ## (): Int

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

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

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

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

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

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

Definition Classes
Ordered
val aboutACanceledTest : Option[Boolean]

indicates whether the information being provided via this event is about a canceled test
val aboutAPendingTest : Option[Boolean]

indicates whether the information being provided via this event is about a pending test
def asInstanceOf [T0] : T0

Attributes
final
Definition Classes
Any
def canEqual (arg0: Any): Boolean

Definition Classes
InfoProvided → Equals
def clone (): AnyRef

Attributes
protected[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
def eq (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def equals (arg0: Any): Boolean

Definition Classes
InfoProvided → Equals → AnyRef → Any
def finalize (): Unit

Attributes
protected[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
InfoProvided → Event
def getClass (): java.lang.Class[_]

Attributes
final
Definition Classes
AnyRef
def hashCode (): Int

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

Attributes
final
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
InfoProvided → 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
def ne (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def notify (): Unit

Attributes
final
Definition Classes
AnyRef
def notifyAll (): Unit

Attributes
final
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
InfoProvided → Event
val payload : Option[Any]

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

Definition Classes
InfoProvided → Event
def productArity : Int

Definition Classes
InfoProvided → Product
def productElement (arg0: Int): Any

Definition Classes
InfoProvided → Product
def productIterator : Iterator[Any]

Definition Classes
Product
def productPrefix : String

Definition Classes
InfoProvided → Product
def synchronized [T0] (arg0: ⇒ T0): T0

Attributes
final
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
InfoProvided → 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
InfoProvided → Event
def toString (): String

Definition Classes
InfoProvided → AnyRef → Any
def toXml : Elem

Definition Classes
InfoProvided → Event
def wait (): Unit

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

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

Attributes
final
Definition Classes
AnyRef
Annotations
@throws()
def productElements : Iterator[Any]

Definition Classes
Product
Annotations
@deprecated
Deprecated
use productIterator instead

InfoProvided

Instance Constructors

Value Members

def != (arg0: AnyRef): Boolean

def != (arg0: Any): Boolean

def ## (): Int

def < (that: Event): Boolean

def <= (that: Event): Boolean

def == (arg0: AnyRef): Boolean

def == (arg0: Any): Boolean

def > (that: Event): Boolean

def >= (that: Event): Boolean

val aboutACanceledTest : Option[Boolean]

val aboutAPendingTest : Option[Boolean]

def asInstanceOf [T0] : T0

def canEqual (arg0: Any): Boolean

def clone (): AnyRef

def compare (that: Event): Int

def compareTo (that: Event): Int

def eq (arg0: AnyRef): Boolean

def equals (arg0: Any): Boolean

def finalize (): Unit

val formatter : Option[Formatter]

def getClass (): java.lang.Class[_]

def hashCode (): Int

def isInstanceOf [T0] : Boolean

val location : Option[Location]

val message : String

val nameInfo : Option[NameInfo]

def ne (arg0: AnyRef): Boolean

def notify (): Unit

def notifyAll (): Unit

val ordinal : Ordinal

val payload : Option[Any]

def productArity : Int

def productElement (arg0: Int): Any

def productIterator : Iterator[Any]

def productPrefix : String

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

val threadName : String

val throwable : Option[Throwable]

val timeStamp : Long

def toString (): String

def toXml : Elem

def wait (): Unit

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

def wait (arg0: Long): Unit

def productElements : Iterator[Any]

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Event

Inherited from Serializable

Inherited from Ordered[Event]

Inherited from Comparable[Event]

Inherited from AnyRef

Inherited from Any