|
ScalaTest 1.1
|
|
org/scalatest/events/InfoProvided.scala]
case final
class
InfoProvided(val ordinal : Ordinal, val message : java.lang.String, val nameInfo : scala.Option[NameInfo], val aboutAPendingTest : scala.Option[Boolean], val throwable : scala.Option[java.lang.Throwable], val formatter : scala.Option[Formatter], val payload : scala.Option[Any], val threadName : java.lang.String, val timeStamp : Long)
extends Event with scala.ProductEvent.
To create instances of this class you may
use one of the factory methods provided in its companion object. For example, given a
report function named report, you could fire a InfoProvided event like this:
report(InfoProvided(ordinal, message, Some(NameInfo(suiteName, Some(thisSuite.getClass.getName), Some(testName)))))
An InfoProvided event may be fired from anywhere. In this respect InfoProvided is different
from the other events, for which it is defined whether they are fired in the context of a suite or test.
If fired in the context of a test, the InfoProvided event should include a NameInfo in which
testName is defined. If fired in the context of a suite, but not a test, the InfoProvided event
should include a NameInfo in which testName is not defined. If fired within the context
of neither a suite nor a test, the nameInfo of the InfoProvided event (an Option[NameInfo]) should be None.
ordinal - an Ordinal that can be used to place this event in order in the context of other events reported during the same runmessage - a localized message suitable for presenting to the usernameInfo - an optional NameInfo that if defined, provides names for the suite and optionally the test in the context of which the information was providedaboutAPendingTest - indicates whether the information being provided via this event is about a pending testthrowable - an optional Throwableformatter - an optional formatter that provides extra information that can be used by reporters in determining how to present this event to the userpayload - an optional object that can be used to pass custom information to the reporter about the InfoProvided eventthreadName - a name for the Thread about whose activity this event was reportedtimeStamp - 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| Method Summary | |
override def
|
equals
(arg0 : Any) : Boolean
This method is used to compare the receiver object (
this)
with the argument object (arg0) for equivalence. |
override def
|
hashCode
: Int
Returns a hash code value for the object.
|
override def
|
productArity : Int |
override def
|
productElement (arg0 : Int) : Any |
override def
|
productPrefix : java.lang.String |
override def
|
toString
: java.lang.String
Returns a string representation of the object.
|
| Methods inherited from Event | |
| compare |
| Methods inherited from scala.Ordered | |
| scala.Ordered.<, scala.Ordered.>, scala.Ordered.<=, scala.Ordered.>=, scala.Ordered.compareTo |
| Methods inherited from AnyRef | |
| getClass, clone, notify, notifyAll, wait, wait, wait, finalize, ==, !=, eq, ne, synchronized |
| Methods inherited from Any | |
| ==, !=, isInstanceOf, asInstanceOf |
| Method Details |
override
def
hashCode : Int
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash
codes (o1.hashCode.equals(o2.hashCode)) yet not be
equal (o1.equals(o2) returns false). A
degenerate implementation could always return 0.
However, it is required that if two objects are equal
(o1.equals(o2) returns true) that they
have identical hash codes
(o1.hashCode.equals(o2.hashCode)). Therefore, when
overriding this method, be sure to verify that the behavior is
consistent with the equals method.
override
def
toString : java.lang.String
The default representation is platform dependent.
this)
with the argument object (arg0) for equivalence.
The default implementations of this method is an equivalence relation:
x of type Any,
x.equals(x) should return true.x and y of type
Any, x.equals(y) should return true if and only
if y.equals(x) returns true.x, y, and z of type AnyRef
if x.equals(y) returns true and
y.equals(z) returns
true, then x.equals(z) should return true.
If you override this method, you should verify that
your implementation remains an equivalence relation.
Additionally, when overriding this method it is often necessary to
override hashCode to ensure that objects that are
"equal" (o1.equals(o2) returns true)
hash to the same Int
(o1.hashCode.equals(o2.hashCode)).
arg0 - the object to compare against this object for equality.true if the receiver object is equivalent to the argument; false otherwise. override
def
productPrefix : java.lang.String
override
def
productArity : Int
|
ScalaTest 1.1
|
|