org.scalatest.events

object RunStarting

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

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

All factory methods throw NullPointerException if any of the passed values are null, and IllegalArgumentException if testCount is less than zero.

Author
Bill Venners
Method Summary
def apply (ordinal : Ordinal, testCount : Int, configMap : scala.collection.immutable.Map[java.lang.String, Any], formatter : scala.Option[Formatter]) : RunStarting
Constructs a new RunStarting 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, testCount : Int, configMap : scala.collection.immutable.Map[java.lang.String, Any]) : RunStarting
Constructs a new RunStarting event with the passed parameters, passing None for formatter, None as the payload, the current threads name as threadname, and the current time as timeStamp.
def apply (ordinal : Ordinal, testCount : Int, configMap : scala.collection.immutable.Map[java.lang.String, Any], formatter : scala.Option[Formatter], payload : scala.Option[Any]) : RunStarting
Constructs a new RunStarting 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, testCount : Int, configMap : scala.collection.immutable.Map[java.lang.String, Any], formatter : scala.Option[Formatter], payload : scala.Option[Any]) : RunStarting
Constructs a new RunStarting 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
testCount - the number of tests expected during this run
configMap - a Map of key-value pairs that can be used by custom Reporters
formatter - an optional formatter that provides extra information that can be used by reporters in determining how to present this event to the user
payload - an optional object that can be used to pass custom information to the reporter about the RunStarting event
Throws
IllegalArgumentException - if testCount is less than zero.
NullPointerException - if any of the passed values are null
Returns
a new RunStarting instance initialized with the passed and default values

def apply(ordinal : Ordinal, testCount : Int, configMap : scala.collection.immutable.Map[java.lang.String, Any], formatter : scala.Option[Formatter]) : RunStarting
Constructs a new RunStarting 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
testCount - the number of tests expected during this run
configMap - a Map of key-value pairs that can be used by custom Reporters
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 RunStarting instance initialized with the passed and default values

def apply(ordinal : Ordinal, testCount : Int, configMap : scala.collection.immutable.Map[java.lang.String, Any]) : RunStarting
Constructs a new RunStarting event with the passed parameters, passing None for formatter, 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
testCount - the number of tests expected during this run
configMap - a Map of key-value pairs that can be used by custom Reporters
Throws
NullPointerException - if any of the passed values are null
Returns
a new RunStarting instance initialized with the passed and default values


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