ScalaTest 1.0
org.scalatest.events

object SuiteStarting
[source: org/scalatest/events/SuiteStarting.scala]
object SuiteStarting
extends AnyRef
Companion object for the SuiteStarting event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on SuiteStarting objects.

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

Author
Bill Venners
Method Summary
def apply (ordinal : Ordinal, suiteName : java.lang.String, suiteClassName : scala.Option[java.lang.String], formatter : scala.Option[Formatter], rerunner : scala.Option[Rerunner]) : SuiteStarting
Constructs a new SuiteStarting 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, suiteName : java.lang.String, suiteClassName : scala.Option[java.lang.String]) : SuiteStarting
Constructs a new SuiteStarting 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, suiteName : java.lang.String, suiteClassName : scala.Option[java.lang.String], formatter : scala.Option[Formatter]) : SuiteStarting
Constructs a new SuiteStarting 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.
def apply (ordinal : Ordinal, suiteName : java.lang.String, suiteClassName : scala.Option[java.lang.String], formatter : scala.Option[Formatter], rerunner : scala.Option[Rerunner], payload : scala.Option[Any]) : SuiteStarting
Constructs a new SuiteStarting event with the passed parameters, passing the current thread's 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, suiteName : java.lang.String, suiteClassName : scala.Option[java.lang.String], formatter : scala.Option[Formatter], rerunner : scala.Option[Rerunner], payload : scala.Option[Any]) : SuiteStarting
Constructs a new SuiteStarting 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
suiteName - a localized name identifying the suite that is starting, which should include the suite name, suitable for presenting to the user
suiteClassName - an optional fully qualifed Suite class name of the suite that is starting
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 is starting (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 SuiteStarting event
Throws
NullPointerException - if any of the passed values are null
Returns
a new SuiteStarting instance initialized with the passed and default values
def apply(ordinal : Ordinal, suiteName : java.lang.String, suiteClassName : scala.Option[java.lang.String], formatter : scala.Option[Formatter], rerunner : scala.Option[Rerunner]) : SuiteStarting
Constructs a new SuiteStarting 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
suiteName - a localized name identifying the suite that is starting, which should include the suite name, suitable for presenting to the user
suiteClassName - an optional fully qualifed Suite class name of the suite that is starting
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 is starting (if None is passed, the suite cannot be rerun)
Throws
NullPointerException - if any of the passed values are null
Returns
a new SuiteStarting instance initialized with the passed and default values
def apply(ordinal : Ordinal, suiteName : java.lang.String, suiteClassName : scala.Option[java.lang.String], formatter : scala.Option[Formatter]) : SuiteStarting
Constructs a new SuiteStarting 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
suiteName - a localized name identifying the suite that is starting, which should include the suite name, suitable for presenting to the user
suiteClassName - an optional fully qualifed Suite class name of the suite that is starting
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 SuiteStarting instance initialized with the passed and default values
def apply(ordinal : Ordinal, suiteName : java.lang.String, suiteClassName : scala.Option[java.lang.String]) : SuiteStarting
Constructs a new SuiteStarting 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
suiteName - a localized name identifying the suite that is starting, which should include the suite name, suitable for presenting to the user
suiteClassName - an optional fully qualifed Suite class name of the suite that is starting
Throws
NullPointerException - if any of the passed values are null
Returns
a new SuiteStarting instance initialized with the passed and default values
Copyright (C) 2001-2009 Artima, Inc. All rights reserved.
ScalaTest 1.0