Packages

c

org.scalatest.events

MarkupProvided

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 Ordinal that 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 NameInfo that if defined, provides names for the suite and optionally the test in the context of which the information was provided

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 MarkupProvided 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
RecordableEvent, Event, Serializable, Serializable, Product, Equals, Ordered[Event], Comparable[Event], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MarkupProvided
  2. RecordableEvent
  3. Event
  4. Serializable
  5. Serializable
  6. Product
  7. Equals
  8. Ordered
  9. Comparable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. 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 Ordinal that 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 NameInfo that if defined, provides names for the suite and optionally the test in the context of which the information was provided

    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 MarkupProvided 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def <(that: Event): Boolean
    Definition Classes
    Ordered
  4. def <=(that: Event): Boolean
    Definition Classes
    Ordered
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def >(that: Event): Boolean
    Definition Classes
    Ordered
  7. def >=(that: Event): Boolean
    Definition Classes
    Ordered
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  10. 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
  11. def compareTo(that: Event): Int
    Definition Classes
    Ordered → Comparable
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. val formatter: Option[Formatter]
    Definition Classes
    MarkupProvided → Event
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. val location: Option[Location]
    Definition Classes
    MarkupProvided → Event
  18. val nameInfo: Option[NameInfo]
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. val ordinal: Ordinal
    Definition Classes
    MarkupProvided → Event
  23. val payload: Option[Any]
    Definition Classes
    MarkupProvided → Event
  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. val text: String
  26. val threadName: String
    Definition Classes
    MarkupProvided → Event
  27. val timeStamp: Long
    Definition Classes
    MarkupProvided → Event
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from RecordableEvent

Inherited from Event

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Ordered[Event]

Inherited from Comparable[Event]

Inherited from AnyRef

Inherited from Any

Ungrouped