Class

org.scalatest.events

ScopePending

Related Doc: package events

Permalink

final case class ScopePending(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 is pending.

To create instances of this class you may use the factory method. For example, given a report function named report, you could fire a ScopePending event like this:

report(ScopePending(ordinal, message, Some(NameInfo(suiteName, Some(thisSuite.getClass.getName), Some(testName)))))

A ScopePending event is fired from within suites, and not tests. The ScopePending 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 ScopePending 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
Event, Serializable, Serializable, Product, Equals, Ordered[Event], Comparable[Event], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScopePending
  2. Event
  3. Serializable
  4. Serializable
  5. Product
  6. Equals
  7. Ordered
  8. Comparable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ScopePending(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)

    Permalink

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def <(that: Event): Boolean

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

    Permalink
    Definition Classes
    Ordered
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def >(that: Event): Boolean

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

    Permalink
    Definition Classes
    Ordered
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def compare(that: Event): Int

    Permalink

    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

    Permalink
    Definition Classes
    Ordered → Comparable
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. val formatter: Option[Formatter]

    Permalink

    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
    ScopePendingEvent
  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  17. val location: Option[Location]

    Permalink

    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
    ScopePendingEvent
  18. val message: String

    Permalink

    a localized message suitable for presenting to the user

  19. val nameInfo: NameInfo

    Permalink

    a NameInfo that provides names for the suite and optionally the test in the context of which the scope was closed

    a NameInfo that provides names for the suite and optionally the test in the context of which the scope was closed

  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. val ordinal: Ordinal

    Permalink

    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
    ScopePendingEvent
  24. val payload: Option[Any]

    Permalink

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

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

    Definition Classes
    ScopePendingEvent
  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  26. val threadName: String

    Permalink

    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
    ScopePendingEvent
  27. val timeStamp: Long

    Permalink

    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
    ScopePendingEvent
  28. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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