final case class NameInfo(suiteName: String, suiteId: String, suiteClassName: Option[String], testName: Option[String]) extends Product with Serializable
Class that holds information about names for the information events InfoProvided
, MarkupProvided
,
ScopeOpened
, ScopeClosed
, ScopePending
, AlertProvided
and NoteProvided
.
An information event may be fired from anywhere. In this respect these events are 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, an information event 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
and suiteId
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, in 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.
- suiteName
an optional name of the suite about which an information event was fired
- suiteId
an optional string ID for the suite about which an information event was fired, intended to be unique across all suites in a run
- suiteClassName
an optional fully qualifed
Suite
class name about which the information was provided- testName
an optional test name information
- Source
- NameInfo.scala
- Alphabetic
- By Inheritance
- NameInfo
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
NameInfo(suiteName: String, suiteId: String, suiteClassName: Option[String], testName: Option[String])
- suiteName
an optional name of the suite about which an information event was fired
- suiteId
an optional string ID for the suite about which an information event was fired, intended to be unique across all suites in a run
- suiteClassName
an optional fully qualifed
Suite
class name about which the information was provided- testName
an optional test name information
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- val suiteClassName: Option[String]
- val suiteId: String
- val suiteName: String
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- val testName: Option[String]
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )