final case class ScopeClosed(ordinal: Ordinal, message: String, nameInfo: NameInfo, formatter: Option[Formatter] = None, location: Option[Location] = None, payload: Option[Any] = None, threadName: String = Thread.currentThread.getName, timeStamp: Long = new Date).getTime) extends Event with Product with Serializable
Event that indicates a scope has been closed.
To create instances of this class you may
use the factory method. For example, given a report function named report
, you could fire a ScopeClosed
event like this:
report(ScopeClosed(ordinal, message, Some(NameInfo(suiteName, suiteId, Some(thisSuite.getClass.getName), Some(testName)))))
A ScopeClosed
event may be fired from within suites or tests.
If fired in the context of a test, the ScopeClosed
event should include a NameInfo
in which
testName
is defined. If fired in the context of a suite, but not a test, the ScopeClosed
event
should include a NameInfo
in which testName
is not defined.
- 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
a
NameInfo
that provides names for the suite and optionally the test in the context of which the scope was closed- 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
ScopeClosed
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
- Alphabetic
- By Inheritance
- ScopeClosed
- Event
- Serializable
- Product
- Equals
- Ordered
- Comparable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ScopeClosed(ordinal: Ordinal, message: String, nameInfo: NameInfo, formatter: Option[Formatter] = None, location: Option[Location] = None, payload: Option[Any] = None, threadName: String = Thread.currentThread.getName, timeStamp: Long = new 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
a
NameInfo
that provides names for the suite and optionally the test in the context of which the scope was closed- 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
ScopeClosed
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: Any): Boolean
- Definition Classes
- AnyRef → 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: Any): Boolean
- Definition Classes
- AnyRef → 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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def compare(that: Event): Int
Comparing
this
event with the event passed asthat
.Comparing
this
event with the event passed asthat
. 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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- 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
- ScopeClosed → Event
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- 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. IDEs can use this information, for example, to allow the user to hop from an event report to the relevant line of source code.- Definition Classes
- ScopeClosed → Event
- val message: String
- val nameInfo: NameInfo
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- 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
- ScopeClosed → Event
- val payload: Option[Any]
An optional object that can be used to pass custom information to the reporter about this event.
An optional object that can be used to pass custom information to the reporter about this event.
- Definition Classes
- ScopeClosed → Event
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- 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
- ScopeClosed → Event
- 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
- ScopeClosed → Event
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()