final case class MarkupProvided(ordinal: Ordinal, text: String, nameInfo: Option[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 RecordableEvent with Product with Serializable
Event used to provide markup text for document-style reports.
To create instances of this class you may
use the factory method. For example, given a report function named report, you could fire a MarkupProvided event like this:
report(MarkupProvided(ordinal, text, Some(NameInfo(suiteName, suiteId, Some(thisSuite.getClass.getName), Some(testName)))))
A MarkupProvided event may be fired from anywhere. In this respect MarkupProvided 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 MarkupProvided event should include a NameInfo in which
testName is defined. If fired in the context of a suite, but not a test, the MarkupProvided 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 MarkupProvided event (an Option[NameInfo]) should be None.
- ordinal
an
Ordinalthat can be used to place this event in order in the context of other events reported during the same run- text
a snippet of markup text (in Markdown format)
- nameInfo
an optional
NameInfothat if defined, provides names for the suite and optionally the test in the context of which the information was provided- 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.- payload
an optional object that can be used to pass custom information to the reporter about the
MarkupProvidedevent- threadName
a name for the
Threadabout whose activity this event was reported- 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
- Source
- Event.scala
- Alphabetic
- By Inheritance
- MarkupProvided
- RecordableEvent
- Event
- Serializable
- Product
- Equals
- Ordered
- Comparable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new MarkupProvided(ordinal: Ordinal, text: String, nameInfo: Option[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
Ordinalthat can be used to place this event in order in the context of other events reported during the same run- text
a snippet of markup text (in Markdown format)
- nameInfo
an optional
NameInfothat if defined, provides names for the suite and optionally the test in the context of which the information was provided- 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.- payload
an optional object that can be used to pass custom information to the reporter about the
MarkupProvidedevent- threadName
a name for the
Threadabout whose activity this event was reported- 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
- 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() @HotSpotIntrinsicCandidate()
- def compare(that: Event): Int
Comparing
thisevent with the event passed asthat.Comparing
thisevent 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
- val formatter: Option[Formatter]
An optional
Formatterthat provides extra information that can be used by reporters in determining how to present this event to the user.An optional
Formatterthat provides extra information that can be used by reporters in determining how to present this event to the user.- Definition Classes
- MarkupProvided → Event
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val location: Option[Location]
An optional
Locationthat provides information indicating where in the source code an event originated.An optional
Locationthat 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
- MarkupProvided → Event
- val nameInfo: Option[NameInfo]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val ordinal: Ordinal
An
Ordinalthat can be used to place this event in order in the context of other events reported during the same run.An
Ordinalthat can be used to place this event in order in the context of other events reported during the same run.- Definition Classes
- MarkupProvided → 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
- MarkupProvided → Event
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val text: String
- val threadName: String
A name for the
Threadabout whose activity this event was reported.A name for the
Threadabout whose activity this event was reported.- Definition Classes
- MarkupProvided → Event
- val timeStamp: Long
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.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.- Definition Classes
- MarkupProvided → Event
- 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()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated