org.scalatest.events

MarkupProvided

case class MarkupProvided (ordinal: Ordinal, text: String, nameInfo: Option[NameInfo], aboutAPendingTest: Option[Boolean], aboutACanceledTest: Option[Boolean], formatter: Option[Formatter], location: Option[Location], payload: Option[Any], threadName: String, timeStamp: Long) extends Event 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

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

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, 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. Event
  6. Serializable
  7. Ordered
  8. Comparable
  9. AnyRef
  10. Any
Visibility
  1. Public
  2. All

Instance Constructors

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

    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

    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. val aboutACanceledTest : Option[Boolean]

    indicates whether the information being provided via this event is about a canceled test

  11. val aboutAPendingTest : Option[Boolean]

    indicates whether the information being provided via this event is about a pending test

  12. def asInstanceOf [T0] : T0

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

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

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

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

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

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

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

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

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

    Attributes
    final
    Definition Classes
    Any
  24. 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
  25. 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

  26. def ne (arg0: AnyRef): Boolean

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

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

    Attributes
    final
    Definition Classes
    AnyRef
  29. 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
  30. 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
  31. def productArity : Int

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

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

    Definition Classes
    Product
  34. def productPrefix : String

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

    Attributes
    final
    Definition Classes
    AnyRef
  36. val text : String

    a snippet of markup text (in Markdown format)

  37. 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
  38. 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
  39. def toString (): String

    Definition Classes
    MarkupProvided → AnyRef → Any
  40. def toXml : Elem

    Definition Classes
    MarkupProvidedEvent
  41. def wait (): Unit

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

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

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

    Definition Classes
    Product
    Annotations
    @deprecated
    Deprecated

    use productIterator instead

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