Event used to provide information that is not appropriate to report via any other Event
.
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
.
an Ordinal
that can be used to place this event in order in the context of
other events reported during the same run
a localized message suitable for presenting to the user
an optional NameInfo
that if defined, provides names for the suite and optionally the test
in the context of which the information was provided
indicates whether the information being provided via this event is about a pending test
an optional Throwable
an optional formatter that provides extra information that can be used by reporters in determining how to present this event to the user
an optional object that can be used to pass custom information to the reporter about the InfoProvided
event
a name for the Thread
about whose activity this event was reported
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
an Ordinal
that can be used to place this event in order in the context of
other events reported during the same run
a localized message suitable for presenting to the user
an optional NameInfo
that if defined, provides names for the suite and optionally the test
in the context of which the information was provided
indicates whether the information being provided via this event is about a pending test
an optional Throwable
an optional formatter that provides extra information that can be used by reporters in determining how to present this event to the user
an optional object that can be used to pass custom information to the reporter about the InfoProvided
event
a name for the Thread
about whose activity this event was reported
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
indicates whether the information being provided via this event is about a pending test
indicates whether the information being provided via this event is about a pending test
Comparing this
event with the event passed as that
.
Comparing this
event with the event passed as that
. Returns
x, where x < 0 iff this < that, x == 0 iff this == that, x > 0 iff this > that.
the event to compare to this event
This method is used to compare the receiver object (this
) with the argument object (arg0
) for equivalence.
This method is used to compare the receiver object (this
) with the argument object (arg0
) for equivalence.
The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence
relation]:
* It is reflexive: for any instance x
of type Any
, x.equals(x)
should return true
.
* It is symmetric: for any instances x
and y
of type Any
, x.equals(y)
should return true
if and
only if y.equals(x)
returns true
.
* It is transitive: for any instances 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 scala.Int
(o1.hashCode.equals(o2.hashCode)
).
the object to compare against this object for equality.
true
if the receiver object is equivalent to the argument; false
otherwise.
an optional formatter that provides extra information that can be used by reporters in determining how to present this event to the user
an optional formatter that provides extra information that can be used by reporters in determining how to present this event to the user
Returns a hash code value for the object.
Returns a hash code value for the object.
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.
the hash code value for the object.
a localized message suitable for presenting to the user
a localized message suitable for presenting to the user
an optional NameInfo
that if defined, provides names for the suite and optionally the test
in the context of which the information was provided
an optional NameInfo
that if defined, provides names for the suite and optionally the test
in the context of which the information was provided
an Ordinal
that can be used to place this event in order in the context of
other events reported during the same run
an Ordinal
that can be used to place this event in order in the context of
other events reported during the same run
an optional object that can be used to pass custom information to the reporter about the InfoProvided
event
an optional object that can be used to pass custom information to the reporter about the InfoProvided
event
use productIterator instead
a name for the Thread
about whose activity this event was reported
a name for the Thread
about whose activity this event was reported
an optional Throwable
an optional Throwable
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
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
Returns a string representation of the object.
Returns a string representation of the object.
The default representation is platform dependent.
a string representation of the object.
Event used to provide information that is not appropriate to report via any other
Event
.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 aInfoProvided
event like this:An
InfoProvided
event may be fired from anywhere. In this respectInfoProvided
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, theInfoProvided
event should include aNameInfo
in whichtestName
is defined. If fired in the context of a suite, but not a test, theInfoProvided
event should include aNameInfo
in whichtestName
is not defined. If fired within the context of neither a suite nor a test, thenameInfo
of theInfoProvided
event (anOption[NameInfo]
) should beNone
.