org.scalatest.events

object RunCompleted

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

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

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

Author
Bill Venners
Method Summary
def apply (ordinal : Ordinal, duration : scala.Option[Long], summary : scala.Option[Summary]) : RunCompleted
Constructs a new RunCompleted 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, duration : scala.Option[Long], summary : scala.Option[Summary], formatter : scala.Option[Formatter], payload : scala.Option[Any]) : RunCompleted
Constructs a new RunCompleted event with the passed parameters, passing the current thread's name as threadname and the current time as timeStamp.
def apply (ordinal : Ordinal) : RunCompleted
Constructs a new RunCompleted event with the passed parameters, passing None for duration, None for summary, None for formatter, None as the payload, the current threads name as threadname, and the current time as timeStamp.
def apply (ordinal : Ordinal, duration : scala.Option[Long], summary : scala.Option[Summary], formatter : scala.Option[Formatter]) : RunCompleted
Constructs a new RunCompleted 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, duration : scala.Option[Long]) : RunCompleted
Constructs a new RunCompleted event with the passed parameters, passing None for summary, None for formatter, 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, duration : scala.Option[Long], summary : scala.Option[Summary], formatter : scala.Option[Formatter], payload : scala.Option[Any]) : RunCompleted
Constructs a new RunCompleted 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
duration - an optional amount of time, in milliseconds, that was required by the run that has completed
summary - an optional summary of the number of tests that were reported as succeeded, failed, ignored, and pending
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 RunCompleted event
Throws
NullPointerException - if any of the passed values are null
Returns
a new RunCompleted instance initialized with the passed and default values

def apply(ordinal : Ordinal, duration : scala.Option[Long], summary : scala.Option[Summary], formatter : scala.Option[Formatter]) : RunCompleted
Constructs a new RunCompleted 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
duration - an optional amount of time, in milliseconds, that was required by the run that has completed
summary - an optional summary of the number of tests that were reported as succeeded, failed, ignored, and pending
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 RunCompleted instance initialized with the passed and default values

def apply(ordinal : Ordinal, duration : scala.Option[Long], summary : scala.Option[Summary]) : RunCompleted
Constructs a new RunCompleted 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
duration - an optional amount of time, in milliseconds, that was required by the run that has completed
summary - an optional summary of the number of tests that were reported as succeeded, failed, ignored, and pending
Throws
NullPointerException - if any of the passed values are null
Returns
a new RunCompleted instance initialized with the passed and default values

def apply(ordinal : Ordinal, duration : scala.Option[Long]) : RunCompleted
Constructs a new RunCompleted event with the passed parameters, passing None for summary, 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
duration - an optional amount of time, in milliseconds, that was required by the run that has completed
Throws
NullPointerException - if any of the passed values are null
Returns
a new RunCompleted instance initialized with the passed and default values

def apply(ordinal : Ordinal) : RunCompleted
Constructs a new RunCompleted event with the passed parameters, passing None for duration, None for summary, 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
Throws
NullPointerException - if any of the passed values are null
Returns
a new RunCompleted instance initialized with the passed and default values


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