TestCanceled

Event that indicates a test was canceled, i.e., it couldn't run because some precondition was not met.

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

report(TestCanceled(ordinal, userFriendlyName, suiteName, Some(thisSuite.getClass.getName), testName))

The suite class name parameter is optional, because suites in ScalaTest are an abstraction that need not necessarily correspond to one class. Nevertheless, in most cases each suite will correspond to a class, and when it does, the fully qualified name of that class should be reported by passing a Some for suiteClassName. One use for this bit of information is JUnit integration, because the "name" provided to a JUnit org.junit.runner.Description appears to usually include a fully qualified class name by convention.

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
suiteName: a localized name identifying the suite containing the test that was canceled, suitable for presenting to the user
suiteId: a string ID for the suite containing the test that was canceled, intended to be unique across all suites in a run
suiteClassName: an optional fully qualifed Suite class name containing the test that was canceled
testName: the name of the test that was canceled
testText: the text of the test that was canceled (may be the test name, or a suffix of the test name)
recordedEvents: recorded events in the test.
throwable: an optional Throwable that, if a Some, indicates why the test was canceled, or a Throwable created to capture stack trace information about the problem.
duration: an optional amount of time, in milliseconds, that was required to run the test that was canceled
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.
rerunner: an optional String giving the fully qualified name of the class that can be used to rerun the test that has canceled. (If None is passed, the test cannot be rerun.)
payload: an optional object that can be used to pass custom information to the reporter about the TestCanceled 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

Serializable, Product, Equals, ExceptionalEvent, Event, Serializable, Ordered[Event], Comparable[Event], AnyRef, Any

Instance Constructors

new TestCanceled(ordinal: Ordinal, message: String, suiteName: String, suiteId: String, suiteClassName: Option[String], testName: String, testText: String, recordedEvents: IndexedSeq[RecordableEvent], throwable: Option[Throwable] = None, duration: Option[Long] = None, formatter: Option[Formatter] = None, location: Option[Location] = None, rerunner: Option[String] = 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
message
a localized message suitable for presenting to the user
suiteName
a localized name identifying the suite containing the test that was canceled, suitable for presenting to the user
suiteId
a string ID for the suite containing the test that was canceled, intended to be unique across all suites in a run
suiteClassName
an optional fully qualifed Suite class name containing the test that was canceled
testName
the name of the test that was canceled
testText
the text of the test that was canceled (may be the test name, or a suffix of the test name)
recordedEvents
recorded events in the test.
throwable
an optional Throwable that, if a Some, indicates why the test was canceled, or a Throwable created to capture stack trace information about the problem.
duration
an optional amount of time, in milliseconds, that was required to run the test that was canceled
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.
rerunner
an optional String giving the fully qualified name of the class that can be used to rerun the test that has canceled. (If None is passed, the test cannot be rerun.)
payload
an optional object that can be used to pass custom information to the reporter about the TestCanceled 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

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

Definition Classes
Ordered → Comparable
val duration: Option[Long]

an optional amount of time, in milliseconds, that was required to run the test that was canceled
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
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
TestCanceled → Event
final def getClass(): Class[_]

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

Definition Classes
Any
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
TestCanceled → Event
val message: String

a localized message suitable for presenting to the user
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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
TestCanceled → Event
val payload: Option[Any]

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

Definition Classes
TestCanceled → Event
val recordedEvents: IndexedSeq[RecordableEvent]

recorded events in the test.
val rerunner: Option[String]

an optional String giving the fully qualified name of the class that can be used to rerun the test that has canceled.
an optional String giving the fully qualified name of the class that can be used to rerun the test that has canceled. (If None is passed, the test cannot be rerun.)
val suiteClassName: Option[String]

an optional fully qualifed Suite class name containing the test that was canceled
an optional fully qualifed Suite class name containing the test that was canceled
val suiteId: String

a string ID for the suite containing the test that was canceled, intended to be unique across all suites in a run
val suiteName: String

a localized name identifying the suite containing the test that was canceled, suitable for presenting to the user
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val testName: String

the name of the test that was canceled
val testText: String

the text of the test that was canceled (may be the test name, or a suffix of the test name)
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
TestCanceled → Event
val throwable: Option[Throwable]

an optional Throwable that, if a Some, indicates why the test was canceled, or a Throwable created to capture stack trace information about the problem.
an optional Throwable that, if a Some, indicates why the test was canceled, or a Throwable created to capture stack trace information about the problem.
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
TestCanceled → Event
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package events

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def <(that: Event): Boolean

def <=(that: Event): Boolean

final def ==(arg0: Any): Boolean

def >(that: Event): Boolean

def >=(that: Event): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def compare(that: Event): Int

def compareTo(that: Event): Int

val duration: Option[Long]

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

val formatter: Option[Formatter]

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val location: Option[Location]

val message: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val ordinal: Ordinal

val payload: Option[Any]

val recordedEvents: IndexedSeq[RecordableEvent]

val rerunner: Option[String]

val suiteClassName: Option[String]

val suiteId: String

val suiteName: String

final def synchronized[T0](arg0: ⇒ T0): T0

val testName: String

val testText: String

val threadName: String

val throwable: Option[Throwable]

val timeStamp: Long

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ExceptionalEvent

Inherited from Event

Inherited from Serializable

Inherited from Ordered[Event]

Inherited from Comparable[Event]

Inherited from AnyRef

Inherited from Any

Ungrouped