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.

IShellOutputReceiver

public interface IShellOutputReceiver

com.android.ddmlib.IShellOutputReceiver

Known indirect subclasses

CollectingByteOutputReceiver, CollectingOutputReceiver, GTestListTestParser, GTestResultParser, IInstrumentationResultParser, InstallCreateReceiver, InstallReceiver, InstrumentationProtoResultParser, InstrumentationResultParser, LargeOutputReceiver, ListInstrumentationParser, MultiLineReceiver, MultiReceiver, NativeBenchmarkTestParser, NativeStressTestParser, NullOutputReceiver, PythonUnitTestResultParser, RustBenchmarkResultParser, RustTestResultParser

CollectingByteOutputReceiver	A `IShellOutputReceiver` which collects the whole shell output into a `byte[]`.
CollectingOutputReceiver	A `IShellOutputReceiver` which collects the whole shell output into one `String`.
GTestListTestParser	A result parser for gtest dry run mode with "--gtest_list_tests" parameter.
GTestResultParser	Parses the 'raw output mode' results of native tests using GTest that run from shell, and informs a ITestInvocationListener of the results.
IInstrumentationResultParser	Interface for parsing the results of an instrumentation test run from shell.
InstallCreateReceiver	Output receiver for "pm install-create" command line.
InstallReceiver	Output receiver for "pm install package.apk" command line.
InstrumentationProtoResultParser	Parses the 'protoStd output mode' results of an instrumentation test run from shell and informs a ITestRunListener of the results.
InstrumentationResultParser	Parses the 'raw output mode' results of an instrumentation test run from shell and informs a ITestRunListener of the results.
LargeOutputReceiver	A class designed to help run long running commands collect output.
ListInstrumentationParser	A `IShellOutputReceiver` that parses the output of a 'pm list instrumentation' query
MultiLineReceiver	Base implementation of `IShellOutputReceiver`, that takes the raw data coming from the socket, and convert it into `String` objects.
MultiReceiver	Base implementation of `IShellOutputReceiver`, that takes multiple instances of `IShellOutputReceiver` and broadcast the received data to all of them.
NativeBenchmarkTestParser	A `IShellOutputReceiver` that parses the benchmark test data output, collecting metrics on average time per operation.
NativeStressTestParser	A `IShellOutputReceiver` that parses the stress test data output, collecting metrics on number of iterations complete and average time per iteration.
NullOutputReceiver	Implementation of `IShellOutputReceiver` that does nothing.
PythonUnitTestResultParser	Interprets the output of tests run with Python's unittest framework and translates it into calls on a series of `ITestInvocationListener`s.
RustBenchmarkResultParser	Interprets the output of tests run with Criterion benchmarking framework and translates it into calls on a series of `ITestInvocationListener`s.
RustTestResultParser	Interprets the output of tests run with Rust's unittest framework and translates it into calls on a series of `ITestInvocationListener`s.

Classes which implement this interface provide methods that deal with out from a remote shell command on a device/emulator.

Summary

Public methods
`abstract void`	`addOutput(byte[] data, int offset, int length)` Called every time some new data is available.
`abstract void`	`flush()` Called at the end of the process execution (unless the process was canceled).
`abstract boolean`	`isCancelled()` Cancel method to stop the execution of the remote shell command.

Public methods

addOutput

public abstract void addOutput (byte[] data, 
                int offset, 
                int length)

Called every time some new data is available.

Parameters
`data`	`byte`: The new data.
`offset`	`int`: The offset at which the new data starts.
`length`	`int`: The length of the new data.

flush

public abstract void flush ()

Called at the end of the process execution (unless the process was canceled). This allows the receiver to terminate and flush whatever data was not yet processed.

isCancelled

public abstract boolean isCancelled ()

Cancel method to stop the execution of the remote shell command.

Returns
`boolean`	true to cancel the execution of the command.