TestCaseStartedEvent
class TestCaseStartedEvent : TestPlatformEvent
| kotlin.Any | ||
| ↳ | androidx.test.services.events.platform.TestPlatformEvent | |
| ↳ | androidx.test.services.events.platform.TestCaseStartedEvent | |
Represents the start of an individual test case. One TestCaseStartedEvent should always be emitted for each individual test case in a test run. However, there are a couple of test statuses that do not require an explicit TestCaseStartedEvent.
- androidx.test.services.events.TestStatus.Status.IGNORED: The test was never started and will not be run.
- androidx.test.services.events.TestStatus.Status.CANCELLED: The test was supposed to run, but this client encountered a state that required it to exit before the test could run.
| See also | |
|---|---|
TestCaseFinishedEvent |
to indicate the end of a test case |
TestCaseErrorEvent |
for reporting various errors encountered during a test run. |
Summary
Public constructors |
|---|
TestCaseStartedEvent(source: Parcel!)Creates a |
TestCaseStartedEvent(testCase: TestCaseInfo, timeStamp: TimeStamp)Creates a |
Public functions |
|
|---|---|
TestPlatformEvent.EventType! |
The |
Unit |
writeToParcel(parcel: Parcel!, i: Int) |
Public properties |
|
|---|---|
TestCaseInfo |
The test case that started. |
TimeStamp |
The time this test case started. |
Inherited Constants |
||
|---|---|---|
|
Inherited functions |
||||
|---|---|---|---|---|
|
||||
Public constructors
TestCaseStartedEvent
TestCaseStartedEvent(source: Parcel!)
Creates a TestCaseStartedEvent from an Parcel.
| Parameters | |
|---|---|
source: Parcel! |
|
TestCaseStartedEvent
TestCaseStartedEvent(testCase: TestCaseInfo, timeStamp: TimeStamp)
Creates a TestCaseStartedEvent.
| Parameters | |
|---|---|
testCase: TestCaseInfo |
the test case that started. |
timeStamp: TimeStamp |
the time the test case began. |
Public functions
instanceType
fun instanceType(): TestPlatformEvent.EventType!
The ITestPlatformEvent#send(TestPlatformEvent) service method receives an instance of the TestPlatformEvent base class, so the CREATOR factory in this class is being used to create the event instances, not the CREATOR of one of its derived instances.
Therefore the createFromParcel method first needs to read a String containing the EventType enum value of the correct derived type to instantiate. Derived classes should override this method to return the applicable event type.
Also note that this means only this base class provides a CREATOR, since the derived classes don't need one.
| Returns | |
|---|---|
TestPlatformEvent.EventType! |
the EventType of the final derived event class that extends this base class |