Class that holds information about names for an InfoProvided
event.
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
.
If either suiteClassName
or testName
is defined, then suiteName
must be defined.
The suite class name parameter is optional even if a suite name is provided by passing a Some
as suiteName
,
because suites in ScalaTest are an abstraction that
need not necessarily correspond to one class. Nevertheless, it most cases each suite will correspond
to a class, and when it does, the fully qualified name of that class should be reported by passing a
Some
for suiteClassName
. One use for this bit of information is JUnit integration,
because the "name" provided to a JUnit org.junit.runner.Description
appears to usually include
a fully qualified class name by convention.
an optional name of the suite about which the information was provided
an optional fully qualifed Suite
class name about which the information was provided
an optional name of the test about which the information was provided
an optional name of the suite about which the information was provided
an optional fully qualifed Suite
class name about which the information was provided
an optional name of the test about which the information was provided
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.
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.
use productIterator instead
an optional fully qualifed Suite
class name about which the information was provided
an optional fully qualifed Suite
class name about which the information was provided
an optional name of the suite about which the information was provided
an optional name of the suite about which the information was provided
an optional name of the test about which the information was provided
an optional name of the test about which the information was provided
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.
Class that holds information about names for an
InfoProvided
event.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
.If either
suiteClassName
ortestName
is defined, thensuiteName
must be defined. The suite class name parameter is optional even if a suite name is provided by passing aSome
assuiteName
, because suites in ScalaTest are an abstraction that need not necessarily correspond to one class. Nevertheless, it most cases each suite will correspond to a class, and when it does, the fully qualified name of that class should be reported by passing aSome
forsuiteClassName
. One use for this bit of information is JUnit integration, because the "name" provided to a JUnitorg.junit.runner.Description
appears to usually include a fully qualified class name by convention.