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.

CollectingOutputReceiver

public class CollectingOutputReceiver
extends Object implements IShellOutputReceiver

java.lang.Object
↳	com.android.ddmlib.CollectingOutputReceiver

A IShellOutputReceiver which collects the whole shell output into one String.

Summary

Public constructors
`CollectingOutputReceiver()`
`CollectingOutputReceiver(CountDownLatch commandCompleteLatch)`

Public methods
`void`	`addOutput(byte[] data, int offset, int length)` Called every time some new data is available.
`boolean`	`awaitCompletion(long timeout, TimeUnit unit)`
`void`	`cancel()` Cancels the output collection.
`void`	`flush()` Called at the end of the process execution (unless the process was canceled).
`String`	`getOutput()`
`boolean`	`isCancelled()` Cancel method to stop the execution of the remote shell command.
`boolean`	`isComplete()`

Public constructors

CollectingOutputReceiver

public CollectingOutputReceiver ()

CollectingOutputReceiver

public CollectingOutputReceiver (CountDownLatch commandCompleteLatch)

Parameters
`commandCompleteLatch`	`CountDownLatch`

Public methods

addOutput

public 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.

awaitCompletion

public boolean awaitCompletion (long timeout, 
                TimeUnit unit)

Parameters
`timeout`	`long`
`unit`	`TimeUnit`

Returns
`boolean`

cancel

public void cancel ()

Cancels the output collection.

flush

public 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.

getOutput

public String getOutput ()

Returns
`String`

isCancelled

public boolean isCancelled ()

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

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

isComplete

public boolean isComplete ()

Returns
`boolean`