Starting March 27, 2025, we recommend using android-latest-release instead of aosp-main to build and contribute to AOSP. For more information, see Changes to AOSP.

ResultAndLogForwarder

public class ResultAndLogForwarder
extends ResultForwarder implements ILogSaverListener

java.lang.Object
↳	com.android.tradefed.result.ResultForwarder
	↳	com.android.tradefed.result.ResultAndLogForwarder

Known direct subclasses

GranularRetriableTestWrapper.StartEndCollector, ModuleResultsAndMetricsForwarder

GranularRetriableTestWrapper.StartEndCollector	Class helper to catch missing run start and end.
ModuleResultsAndMetricsForwarder	An Extension of `ResultAndLogForwarder` that adds extra module related metrics to the test results.

Forwarder for results and logs events.

Summary

Public constructors
`ResultAndLogForwarder(ITestInvocationListener... listeners)`
`ResultAndLogForwarder( listeners)` Ctor

Public methods
`void`	`invocationEnded(long elapsedTime)` Reports that the invocation has terminated, whether successfully or due to some error condition.
`void`	`invocationStarted(IInvocationContext context)` Reports the start of the test invocation.
`void`	`logAssociation(String dataName, LogFile logFile)` In some cases, log must be strongly associated with a test cases, but the opportunity to do so on the direct `testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)` callback is not possible.
`void`	`setLogSaver(ILogSaver logSaver)` Set the `ILogSaver` to allow the implementor to save files.
`void`	`testLogSaved(String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)` Called when the test log is saved.

Public constructors

ResultAndLogForwarder

public ResultAndLogForwarder (ITestInvocationListener... listeners)

Parameters
`listeners`	`ITestInvocationListener`

ResultAndLogForwarder

public ResultAndLogForwarder ( listeners)

Ctor

Parameters
`listeners`

Public methods

invocationEnded

public void invocationEnded (long elapsedTime)

Reports that the invocation has terminated, whether successfully or due to some error condition.

Will be automatically called by the TradeFederation framework.

Parameters
`elapsedTime`	`long`: the elapsed time of the invocation in ms

invocationStarted

public void invocationStarted (IInvocationContext context)

Reports the start of the test invocation.

Will be automatically called by the TradeFederation framework. Reporters need to override this method to support multiple devices reporting.

Parameters
`context`	`IInvocationContext`: information about the invocation

logAssociation

public void logAssociation (String dataName, 
                LogFile logFile)

In some cases, log must be strongly associated with a test cases, but the opportunity to do so on the direct testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) callback is not possible. Thus, this callback allows to provide a strong association explicitly.

Parameters
`dataName`	`String`: The name of the data
`logFile`	`LogFile`: the `LogFile` that was logged before and should be associated with the test case.

setLogSaver

public void setLogSaver (ILogSaver logSaver)

Set the ILogSaver to allow the implementor to save files.

Parameters
`logSaver`	`ILogSaver`: the `ILogSaver`

testLogSaved

public void testLogSaved (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream, 
                LogFile logFile)

Called when the test log is saved.

Should be used in place of ITestInvocationListener.testLog(String, LogDataType, InputStreamSource).

Parameters
`dataName`	`String`: a `String` descriptive name of the data. e.g. "device_logcat". Note dataName may not be unique per invocation. ie implementers must be able to handle multiple calls with same dataName
`dataType`	`LogDataType`: the `LogDataType` of the data
`dataStream`	`InputStreamSource`: the `InputStreamSource` of the data. Implementers should call createInputStream to start reading the data, and ensure to close the resulting InputStream when complete.
`logFile`	`LogFile`: the `LogFile` containing the meta data of the saved file.