org.scalatest.events

object SuiteAborted

[source: org/scalatest/events/SuiteAborted.scala]

object SuiteAborted
extends AnyRef
Companion object for the SuiteAborted event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on SuiteAborted objects.

All factory methods throw NullPointerException if any of the passed values are null.

Author
Bill Venners
Method Summary
def apply (ordinal : Ordinal, message : java.lang.String, suiteName : java.lang.String, suiteClassName : scala.Option[java.lang.String], throwable : scala.Option[java.lang.Throwable], duration : scala.Option[Long], formatter : scala.Option[Formatter], rerunner : scala.Option[Rerunner], payload : scala.Option[Any]) : SuiteAborted
Constructs a new SuiteAborted event with the passed parameters, passing the current thread's name as threadname and the current time as timeStamp.
def apply (ordinal : Ordinal, message : java.lang.String, suiteName : java.lang.String, suiteClassName : scala.Option[java.lang.String], throwable : scala.Option[java.lang.Throwable]) : SuiteAborted
Constructs a new SuiteAborted event with the passed parameters, passing None for duration, None for formatter, None as the rerunner, None as the payload, the current threads name as threadname, and the current time as timeStamp.
def apply (ordinal : Ordinal, message : java.lang.String, suiteName : java.lang.String, suiteClassName : scala.Option[java.lang.String], throwable : scala.Option[java.lang.Throwable], duration : scala.Option[Long], formatter : scala.Option[Formatter], rerunner : scala.Option[Rerunner]) : SuiteAborted
Constructs a new SuiteAborted event with the passed parameters, passing None as the payload, the current threads name as threadname, and the current time as timeStamp.
def apply (ordinal : Ordinal, message : java.lang.String, suiteName : java.lang.String, suiteClassName : scala.Option[java.lang.String], throwable : scala.Option[java.lang.Throwable], duration : scala.Option[Long]) : SuiteAborted
Constructs a new SuiteAborted event with the passed parameters, passing None for formatter, None as the rerunner, None as the payload, the current threads name as threadname, and the current time as timeStamp.
def apply (ordinal : Ordinal, message : java.lang.String, suiteName : java.lang.String, suiteClassName : scala.Option[java.lang.String], throwable : scala.Option[java.lang.Throwable], duration : scala.Option[Long], formatter : scala.Option[Formatter]) : SuiteAborted
Constructs a new SuiteAborted event with the passed parameters, passing None as the rerunner, None as the payload, the current threads name as threadname, and the current time as timeStamp.
Methods inherited from AnyRef
getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize, ==, !=, eq, ne, synchronized
Methods inherited from Any
==, !=, isInstanceOf, asInstanceOf
Method Details
def apply(ordinal : Ordinal, message : java.lang.String, suiteName : java.lang.String, suiteClassName : scala.Option[java.lang.String], throwable : scala.Option[java.lang.Throwable], duration : scala.Option[Long], formatter : scala.Option[Formatter], rerunner : scala.Option[Rerunner], payload : scala.Option[Any]) : SuiteAborted
Constructs a new SuiteAborted event with the passed parameters, passing the current thread's name as threadname and the current time as timeStamp.
Parameters
ordinal - an Ordinal that can be used to place this event in order in the context of other events reported during the same run
name - a localized name identifying the suite that has aborted, which should include the suite name, suitable for presenting to the user
message - a localized message suitable for presenting to the user
suiteName - the name of the suite containing the suite that has aborted
suiteClassName - an optional fully qualifed Suite class name containing the suite that has aborted
throwable - an optional Throwable that, if a Some, indicates why the suite has aborted, or a Throwable created to capture stack trace information about the problem.
duration - an optional amount of time, in milliseconds, that was required to execute the suite that has aborted
formatter - an optional formatter that provides extra information that can be used by reporters in determining how to present this event to the user
rerunner - an optional Rerunner that can be used to rerun the suite that has aborted (if None is passed, the suite cannot be rerun)
payload - an optional object that can be used to pass custom information to the reporter about the SuiteAborted event
Throws
NullPointerException - if any of the passed values are null
Returns
a new SuiteAborted instance initialized with the passed and default values

def apply(ordinal : Ordinal, message : java.lang.String, suiteName : java.lang.String, suiteClassName : scala.Option[java.lang.String], throwable : scala.Option[java.lang.Throwable], duration : scala.Option[Long], formatter : scala.Option[Formatter], rerunner : scala.Option[Rerunner]) : SuiteAborted
Constructs a new SuiteAborted event with the passed parameters, passing None as the payload, the current threads name as threadname, and the current time as timeStamp.
Parameters
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 - the name of the suite containing the suite that has aborted
suiteClassName - an optional fully qualifed Suite class name containing the suite that has aborted
throwable - an optional Throwable that, if a Some, indicates why the suite has aborted, or a Throwable created to capture stack trace information about the problem.
duration - an optional amount of time, in milliseconds, that was required to execute the suite that has aborted
formatter - an optional formatter that provides extra information that can be used by reporters in determining how to present this event to the user
rerunner - an optional Rerunner that can be used to rerun the suite that has aborted (if None is passed, the suite cannot be rerun)
Throws
NullPointerException - if any of the passed values are null
Returns
a new SuiteAborted instance initialized with the passed and default values

def apply(ordinal : Ordinal, message : java.lang.String, suiteName : java.lang.String, suiteClassName : scala.Option[java.lang.String], throwable : scala.Option[java.lang.Throwable], duration : scala.Option[Long], formatter : scala.Option[Formatter]) : SuiteAborted
Constructs a new SuiteAborted event with the passed parameters, passing None as the rerunner, None as the payload, the current threads name as threadname, and the current time as timeStamp.
Parameters
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
throwable - an optional Throwable that, if a Some, indicates why the suite has aborted, or a Throwable created to capture stack trace information about the problem.
duration - an optional amount of time, in milliseconds, that was required to execute the suite that has aborted
suiteName - the name of the suite containing the suite that has aborted
suiteClassName - an optional fully qualifed Suite class name containing the suite that has aborted
formatter - an optional formatter that provides extra information that can be used by reporters in determining how to present this event to the user
Throws
NullPointerException - if any of the passed values are null
Returns
a new SuiteAborted instance initialized with the passed and default values

def apply(ordinal : Ordinal, message : java.lang.String, suiteName : java.lang.String, suiteClassName : scala.Option[java.lang.String], throwable : scala.Option[java.lang.Throwable], duration : scala.Option[Long]) : SuiteAborted
Constructs a new SuiteAborted event with the passed parameters, passing None for formatter, None as the rerunner, None as the payload, the current threads name as threadname, and the current time as timeStamp.
Parameters
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 - the name of the suite containing the suite that has aborted
suiteClassName - an optional fully qualifed Suite class name containing the suite that has aborted
throwable - an optional Throwable that, if a Some, indicates why the suite has aborted, or a Throwable created to capture stack trace information about the problem.
duration - an optional amount of time, in milliseconds, that was required to execute the suite that has aborted
Throws
NullPointerException - if any of the passed values are null
Returns
a new SuiteAborted instance initialized with the passed and default values

def apply(ordinal : Ordinal, message : java.lang.String, suiteName : java.lang.String, suiteClassName : scala.Option[java.lang.String], throwable : scala.Option[java.lang.Throwable]) : SuiteAborted
Constructs a new SuiteAborted event with the passed parameters, passing None for duration, None for formatter, None as the rerunner, None as the payload, the current threads name as threadname, and the current time as timeStamp.
Parameters
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 - the name of the suite containing the suite that has aborted
suiteClassName - an optional fully qualifed Suite class name containing the suite that has aborted
throwable - an optional Throwable that, if a Some, indicates why the suite has aborted, or a Throwable created to capture stack trace information about the problem.
Throws
NullPointerException - if any of the passed values are null
Returns
a new SuiteAborted instance initialized with the passed and default values


Copyright (C) 2001-2009 Artima, Inc. All rights reserved.