BaseDeviceMetricCollector

public class BaseDeviceMetricCollector
extends Object implements IMetricCollector

java.lang.Object
↳	com.android.tradefed.device.metric.BaseDeviceMetricCollector

已知的直接子类

BugreportzOnFailureCollector ， DebugHostLogOnFailureCollector ， FilePullerDeviceMetricCollector ， LogcatOnFailureCollector ， ScreenshotOnFailureCollector

BugreportzOnFailureCollector	测试用例失败时收集错误报告。
DebugHostLogOnFailureCollector	当发生测试用例失败时，收集器将收集并记录主机端日志。
FilePullerDeviceMetricCollector	一个`BaseDeviceMetricCollector` ，它侦听来自设备的指标密钥，并将其作为文件从设备中拉出。
LogcatOnFailureCollector	当测试用例失败时，将捕获并记录logcat的收集器。
ScreenshotOnFailureCollector	当测试用例失败时，收集器将捕获并记录屏幕截图。

已知的间接子类

FilePullerLogCollector ， IncidentReportCollector

FilePullerLogCollector	设备端报告的文件的记录器。
IncidentReportCollector	如果进行了配置，则在测试运行结束时提取并处理在设备端报告的事件报告，并在主机端收集事件报告。

IMetricCollector基本实现，它允许在onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData)和ERROR(/#onTestRunEnd(com.android.tradefed.device.metric.DeviceMetricData,Map))上启动和停止收集。

概要

领域
`public static final String`	`TEST_CASE_EXCLUDE_GROUP_OPTION`
`public static final String`	`TEST_CASE_INCLUDE_GROUP_OPTION`

公共建设者
`BaseDeviceMetricCollector ()`

公开方法
`final`	`getBuildInfos ()` 返回调用中可用的构建信息列表。
`final`	`getDevices ()` 返回调用中可用的设备列表。
`File`	`getFileFromTestArtifacts (String fileName)` 从测试工件或模块工件中检索文件，并将其缓存在映射中以供后续调用。
`final ITestInvocationListener`	`getInvocationListener ()` 返回原始`ITestInvocationListener` ，我们在其中转发结果。
`final`	`getRealDevices ()` 从`getDevices()`列表返回所有非存根设备。
`String`	`getRunName ()` 返回触发收集器的测试运行`mRunName`的名称。
`String`	`getTag ()` 返回收集器的标识符`mTag` 。
`ITestInvocationListener`	`init (IInvocationContext context, ITestInvocationListener listener)` 使用当前上下文以及将结果转发到何处来初始化收集器。
`final void`	`invocationEnded (long elapsedTime)`
`final void`	`invocationFailed (FailureDescription failure)`
`final void`	`invocationFailed (Throwable cause)`
`final void`	`invocationStarted (IInvocationContext context)` 调用侦听器进行转发
`final boolean`	`isDisabled ()` 如果禁用了整个对象（跳过设置和拆卸），则返回True。
`void`	`onTestAssumptionFailure ( DeviceMetricData testData, TestDescription test)` 当测试用例失败且假设失败时进行回调。
`void`	`onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics, TestDescription test)` `onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics, TestDescription test)` 测试用例结束时的回调。
`void`	`onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics)` `onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics)` 测试用例结束时的回调。
`void`	`onTestFail ( DeviceMetricData testData, TestDescription test)` 测试用例失败时回调。
`void`	`onTestRunEnd ( DeviceMetricData runData, currentRunMetrics)` `onTestRunEnd ( DeviceMetricData runData, currentRunMetrics)` 测试运行结束时回调。
`void`	`onTestRunStart ( DeviceMetricData runData)` 测试运行开始时的回调。
`void`	`onTestStart ( DeviceMetricData testData)` 测试用例启动时的回调。
`final void`	`setDisable (boolean isDisabled)` 设置是否应禁用对象。
`void`	`setTag (String tag)` 设置收集器的`mTag` 。
`final void`	`testAssumptionFailure (TestDescription test, String trace)`
`final void`	`testAssumptionFailure (TestDescription test, FailureDescription failure)`
`final void`	`testEnded (TestDescription test, long endTime, testMetrics)` `testEnded (TestDescription test, long endTime, testMetrics)`
`final void`	`testEnded (TestDescription test, testMetrics)` `testEnded (TestDescription test, testMetrics)`
`final void`	`testFailed (TestDescription test, FailureDescription failure)`
`final void`	`testFailed (TestDescription test, String trace)`
`final void`	`testIgnored (TestDescription test)`
`final void`	`testLog (String dataName, LogDataType dataType, InputStreamSource dataStream)`
`final void`	`testModuleEnded ()`
`final void`	`testModuleStarted (IInvocationContext moduleContext)`
`final void`	`testRunEnded (long elapsedTime, runMetrics)` `testRunEnded (long elapsedTime, runMetrics)`
`final void`	`testRunFailed (FailureDescription failure)`
`final void`	`testRunFailed (String errorMessage)`
`final void`	`testRunStarted (String runName, int testCount, int attemptNumber)`
`final void`	`testRunStarted (String runName, int testCount)` 测试运行回调
`final void`	`testRunStarted (String runName, int testCount, int attemptNumber, long startTime)`
`final void`	`testRunStopped (long elapsedTime)`
`final void`	`testStarted (TestDescription test, long startTime)`
`final void`	`testStarted (TestDescription test)` 测试用例回调

领域

TEST_CASE_EXCLUDE_GROUP_OPTION

public static final String TEST_CASE_EXCLUDE_GROUP_OPTION

TEST_CASE_INCLUDE_GROUP_OPTION

public static final String TEST_CASE_INCLUDE_GROUP_OPTION

公共建设者

BaseDeviceMetricCollector

public BaseDeviceMetricCollector ()

公开方法

getBuildInfos

public final  getBuildInfos ()

返回调用中可用的构建信息列表。

退货

getDevices

public final  getDevices ()

返回调用中可用的设备列表。

退货

getFileFromTestArtifacts

public File getFileFromTestArtifacts (String fileName)

从测试工件或模块工件中检索文件，并将其缓存在映射中以供后续调用。

参量
`fileName`	`String` ：要在构件中查找的文件的名称。

退货
`File`	来自测试工件或模块工件的文件。如果找不到文件，则返回null。

getInvocationListener

public final ITestInvocationListener getInvocationListener ()

返回原始ITestInvocationListener ，我们在其中转发结果。

退货
`ITestInvocationListener`

getRealDevices

public final  getRealDevices ()

返回getDevices()列表中的所有非存根设备。

退货

getRunName

public String getRunName ()

返回触发收集器的测试运行mRunName的名称。

退货
`String`	mRunName，当前的测试运行名称。

getTag

public String getTag ()

返回收集器的标识符mTag 。

退货
`String`	mTag，收集器的唯一标识符。

在里面

public ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

使用当前上下文以及将结果转发到何处来初始化收集器。每个实例仅被调用一次，并且收集器应更新其内部上下文和侦听器。永远不会在测试运行之前调用Init。

除非您知道自己在做什么，否则不要覆盖。

参量
`context`	`IInvocationContext` ： `IInvocationContext`的调用的`IInvocationContext` 。
`listener`	`ITestInvocationListener` ：将结果`ITestInvocationListener`哪里的`ITestInvocationListener` 。

退货
`ITestInvocationListener`	新的监听器包装了原来的监听器。

调用结束

public final void invocationEnded (long elapsedTime)

参量
`elapsedTime`	`long`

调用失败

public final void invocationFailed (FailureDescription failure)

参量
`failure`	`FailureDescription`

调用失败

public final void invocationFailed (Throwable cause)

参量
`cause`	`Throwable`

调用开始

public final void invocationStarted (IInvocationContext context)

调用侦听器进行转发

参量
`context`	`IInvocationContext`

被禁用

public final boolean isDisabled ()

如果禁用了整个对象（跳过设置和拆卸），则返回True。否则为假。

退货
`boolean`

onTestAssumptionFailure

public void onTestAssumptionFailure (DeviceMetricData testData, 
                TestDescription test)

当测试用例失败且假设失败时进行回调。

参量
`testData`	`DeviceMetricData` ：保存测试用例数据的`DeviceMetricData` 。
`test`	`TestDescription` ： `TestDescription`的测试用例的`TestDescription` 。

onTestEnd

public void onTestEnd (DeviceMetricData testData, 
                 currentTestCaseMetrics, 
                TestDescription test)

测试用例结束时的回调。这应该是清理的时间。

参量
`testData`	`DeviceMetricData` ：保存测试用例数据的`DeviceMetricData` 。与`onTestStart(com.android.tradefed.device.metric.DeviceMetricData)`期间的对象相同。
`currentTestCaseMetrics`	：传递给`ITestLifeCycleReceiver.testEnded(com.android.tradefed.result.TestDescription, Map)`的度量的当前映射。
`test`	`TestDescription` ： `TestDescription`的测试用例的`TestDescription` 。

onTestEnd

public void onTestEnd (DeviceMetricData testData, 
                 currentTestCaseMetrics)

测试用例结束时的回调。这应该是清理的时间。

参量
`testData`	`DeviceMetricData` ：保存测试用例数据的`DeviceMetricData` 。与`onTestStart(com.android.tradefed.device.metric.DeviceMetricData)`期间的对象相同。
`currentTestCaseMetrics`	：传递给`ITestLifeCycleReceiver.testEnded(com.android.tradefed.result.TestDescription, Map)`的度量的当前映射。

onTestFail

public void onTestFail (DeviceMetricData testData, 
                TestDescription test)

测试用例失败时回调。

参量
`testData`	`DeviceMetricData` ：保存测试用例数据的`DeviceMetricData` 。
`test`	`TestDescription` ： `TestDescription`的测试用例的`TestDescription` 。

onTestRunEnd

public void onTestRunEnd (DeviceMetricData runData, 
                 currentRunMetrics)

测试运行结束时回调。这应该是清理的时间。

参量
`runData`	`DeviceMetricData` ：保存运行数据的`DeviceMetricData` 。将与`onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData)`期间的对象相同。
`currentRunMetrics`	：传递给`ITestLifeCycleReceiver.testRunEnded(long, Map)`的度量的当前映射。

onTestRunStart

public void onTestRunStart (DeviceMetricData runData)

开始测试运行时的回调。

参量
`runData`	`DeviceMetricData` ：保存运行数据的`DeviceMetricData` 。

onTestStart

public void onTestStart (DeviceMetricData testData)

测试用例启动时的回调。

参量
`testData`	`DeviceMetricData` ：保存测试用例数据的`DeviceMetricData` 。

setDisable

public final void setDisable (boolean isDisabled)

设置是否应禁用对象。禁用表示应跳过设置和拆卸步骤。可用于使对象在默认构造函数中默认为禁用。

参量
`isDisabled`	`boolean` ：对象应置于的状态。

setTag

public void setTag (String tag)

设置收集器的mTag 。可用于指定收集器的间隔。

参量
`tag`	`String` ：收集器的唯一标识符。

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                String trace)

参量
`test`	`TestDescription`
`trace`	`String`

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

参量
`test`	`TestDescription`
`failure`	`FailureDescription`

testEnded

public final void testEnded (TestDescription test, 
                long endTime, 
                 testMetrics)

参量
`test`	`TestDescription`
`endTime`	`long`
`testMetrics`

testEnded

public final void testEnded (TestDescription test, 
                 testMetrics)

参量
`test`	`TestDescription`
`testMetrics`

测试失败

public final void testFailed (TestDescription test, 
                FailureDescription failure)

参量
`test`	`TestDescription`
`failure`	`FailureDescription`

测试失败

public final void testFailed (TestDescription test, 
                String trace)

参量
`test`	`TestDescription`
`trace`	`String`

testIgnored

public final void testIgnored (TestDescription test)

参量
`test`	`TestDescription`

测试日志

public final void testLog (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream)

参量
`dataName`	`String`
`dataType`	`LogDataType`
`dataStream`	`InputStreamSource`

testModuleEnded

public final void testModuleEnded ()

testModuleStarted

public final void testModuleStarted (IInvocationContext moduleContext)

参量
`moduleContext`	`IInvocationContext`

testRunEnded

public final void testRunEnded (long elapsedTime, 
                 runMetrics)

参量
`elapsedTime`	`long`
`runMetrics`

testRunFailed

public final void testRunFailed (FailureDescription failure)

参量
`failure`	`FailureDescription`

testRunFailed

public final void testRunFailed (String errorMessage)

参量
`errorMessage`	`String`

testRunStarted

public final void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber)

参量
`runName`	`String`
`testCount`	`int`
`attemptNumber`	`int`

testRunStarted

public final void testRunStarted (String runName, 
                int testCount)

测试运行回调

参量
`runName`	`String`
`testCount`	`int`

testRunStarted

public final void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber, 
                long startTime)

参量
`runName`	`String`
`testCount`	`int`
`attemptNumber`	`int`
`startTime`	`long`

testRunStopped

public final void testRunStopped (long elapsedTime)

参量
`elapsedTime`	`long`

testStarted

public final void testStarted (TestDescription test, 
                long startTime)

参量
`test`	`TestDescription`
`startTime`	`long`

testStarted

public final void testStarted (TestDescription test)

测试用例回调

参量
`test`	`TestDescription`