public class

ResultForwarder

extends Object
implements ITestInvocationListener
java.lang.Object
   ↳ com.android.tradefed.result.ResultForwarder

Class Overview

A ITestInvocationListener that forwards invocation results to a list of other listeners.

Summary

Public Constructors
ResultForwarder(List<ITestInvocationListener> listeners)
Create a ResultForwarder.
ResultForwarder(ITestInvocationListener... listeners)
Alternate variable arg constructor for ResultForwarder.
Protected Constructors
ResultForwarder()
Create a ResultForwarder with deferred listener setting.
Public Methods
TestSummary getSummary()
Allows the InvocationListener to return a summary.
void invocationEnded(long elapsedTime)
Reports that the invocation has terminated, whether successfully or due to some error condition.
void invocationFailed(Throwable cause)
Reports an incomplete invocation due to some error condition.
void invocationStarted(IBuildInfo buildInfo)
Reports the start of the test invocation.
void testEnded(TestIdentifier test, Map<String, String> testMetrics)
void testFailed(ITestRunListener.TestFailure status, TestIdentifier test, String trace)
void testLog(String dataName, LogDataType dataType, InputStreamSource dataStream)
Provides the associated log or debug data from the test invocation.
void testRunEnded(long elapsedTime, Map<String, String> runMetrics)
void testRunFailed(String errorMessage)
void testRunStarted(String runName, int testCount)
void testRunStopped(long elapsedTime)
void testStarted(TestIdentifier test)
Protected Methods
void setListeners(ITestInvocationListener... listeners)
Set the listeners after construction.
void setListeners(List<ITestInvocationListener> listeners)
Set the listeners after construction.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.android.ddmlib.testrunner.ITestRunListener
From interface com.android.tradefed.result.ITestInvocationListener

Public Constructors

public ResultForwarder (List<ITestInvocationListener> listeners)

Create a ResultForwarder.

Parameters
listeners the real ITestInvocationListeners to forward results to

public ResultForwarder (ITestInvocationListener... listeners)

Alternate variable arg constructor for ResultForwarder.

Parameters
listeners the real ITestInvocationListeners to forward results to

Protected Constructors

protected ResultForwarder ()

Create a ResultForwarder with deferred listener setting. Intended only for use by subclasses.

Public Methods

public TestSummary getSummary ()

Allows the InvocationListener to return a summary.

Returns

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 the elapsed time of the invocation in ms

public void invocationFailed (Throwable cause)

Reports an incomplete invocation due to some error condition.

Will be automatically called by the TradeFederation framework.

Parameters
cause the Throwable cause of the failure

public void invocationStarted (IBuildInfo buildInfo)

Reports the start of the test invocation.

Will be automatically called by the TradeFederation framework.

Parameters
buildInfo information about the build being tested

public void testEnded (TestIdentifier test, Map<String, String> testMetrics)

public void testFailed (ITestRunListener.TestFailure status, TestIdentifier test, String trace)

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

Provides the associated log or debug data from the test invocation.

Must be called before invocationFailed(Throwable) or invocationEnded(long)

The TradeFederation framework will automatically call this method, providing the host log and if applicable, the device logcat.

Parameters
dataName 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 the LogDataType of the data
dataStream the InputStreamSource of the data. Implementers should call createInputStream to start reading the data, and ensure to close the resulting InputStream when complete. Callers should ensure the source of the data remains present and accessible until the testLog method completes.

public void testRunEnded (long elapsedTime, Map<String, String> runMetrics)

public void testRunFailed (String errorMessage)

public void testRunStarted (String runName, int testCount)

public void testRunStopped (long elapsedTime)

public void testStarted (TestIdentifier test)

Protected Methods

protected void setListeners (ITestInvocationListener... listeners)

Set the listeners after construction. Intended only for use by subclasses.

Parameters
listeners the real ITestInvocationListeners to forward results to

protected void setListeners (List<ITestInvocationListener> listeners)

Set the listeners after construction. Intended only for use by subclasses.

Parameters
listeners the real ITestInvocationListeners to forward results to