org.scalatest.events

MarkupProvided

case class MarkupProvided (ordinal: Ordinal, text: String, nameInfo: Option[NameInfo], formatter: Option[Formatter], location: Option[Location], payload: Option[Any], threadName: String, timeStamp: Long) 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 provided in its companion object. For example, given a report function named report, you could fire a MarkupProvided event like this:

report(MarkupProvided(ordinal, text, Some(NameInfo(suiteName, 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

Attributes
final
Linear Supertypes
Serializable, Product, Equals, RecordableEvent, Event, Serializable, Ordered[Event], Comparable[Event], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. MarkupProvided
  2. Serializable
  3. Product
  4. Equals
  5. RecordableEvent
  6. Event
  7. Serializable
  8. Ordered
  9. Comparable
  10. AnyRef
  11. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MarkupProvided (ordinal: Ordinal, text: String, nameInfo: Option[NameInfo], 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

    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. def != (arg0: AnyRef): Boolean

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

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

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

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

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

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

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

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

    Definition Classes
    Ordered
  10. def asInstanceOf [T0] : T0

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

    Definition Classes
    MarkupProvided → Equals
  12. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  13. 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
  14. def compareTo (that: Event): Int

    Definition Classes
    Ordered → Comparable
  15. def eq (arg0: AnyRef): Boolean

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

    Definition Classes
    MarkupProvided → Equals → AnyRef → Any
  17. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  18. 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
    MarkupProvidedEvent
  19. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef
  20. def hashCode (): Int

    Definition Classes
    MarkupProvided → AnyRef → Any
  21. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any
  22. 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
    MarkupProvidedEvent
  23. 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

  24. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  25. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  26. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  27. 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
    MarkupProvidedEvent
  28. val payload : Option[Any]

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

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

    Definition Classes
    MarkupProvidedEvent
  29. def productArity : Int

    Definition Classes
    MarkupProvided → Product
  30. def productElement (arg0: Int): Any

    Definition Classes
    MarkupProvided → Product
  31. def productIterator : Iterator[Any]

    Definition Classes
    Product
  32. def productPrefix : String

    Definition Classes
    MarkupProvided → Product
  33. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  34. val text : String

    a snippet of markup text (in Markdown format)

  35. 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
    MarkupProvidedEvent
  36. 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
    MarkupProvidedEvent
  37. def toString (): String

    Definition Classes
    MarkupProvided → AnyRef → Any
  38. def wait (): Unit

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

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

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

    Definition Classes
    Product
    Annotations
    @deprecated
    Deprecated

    use productIterator instead

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from RecordableEvent

Inherited from Event

Inherited from Serializable

Inherited from Ordered[Event]

Inherited from Comparable[Event]

Inherited from AnyRef

Inherited from Any