com.android.ddmlib

Class InstallReceiver

java.lang.Object

com.android.ddmlib.MultiLineReceiver

com.android.ddmlib.InstallReceiver

All Implemented Interfaces:

IShellOutputReceiver

Direct Known Subclasses:

InstallCreateReceiver

public class InstallReceiver
extends MultiLineReceiver

Output receiver for "pm install package.apk" command line.

Use a combination of isSuccessfullyCompleted() and getErrorMessage() to decide if the installation was successful and what was the error.

Constructor Summary

Constructors

Constructor and Description
InstallReceiver()

Method Summary

Modifier and Type	Method and Description
void	done() Terminates the process.
java.lang.String	getErrorCode()
java.lang.String	getErrorMessage() Returns the error message from the installation.
java.lang.String	getSuccessMessage() Returns the success message from the installation.
boolean	isCancelled() Cancel method to stop the execution of the remote shell command.
boolean	isSuccessfullyCompleted() Returns true if the installation was fully successful.
void	processNewLines(java.lang.String[] lines) Called when new lines are being received by the remote process.

Methods inherited from class com.android.ddmlib.MultiLineReceiver

addOutput, flush, setTrimLine

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InstallReceiver

public InstallReceiver()

Method Detail

processNewLines

public void processNewLines(@NonNull
                            java.lang.String[] lines)

Description copied from class: MultiLineReceiver

Called when new lines are being received by the remote process.

It is guaranteed that the lines are complete when they are given to this method.

Specified by:

processNewLines in class MultiLineReceiver

Parameters:

lines - The array containing the new lines.

isCancelled

public boolean isCancelled()

Description copied from interface: IShellOutputReceiver

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

Returns:

true to cancel the execution of the command.

getErrorMessage

public java.lang.String getErrorMessage()

Returns the error message from the installation. Returns null if it was successful or if a timeout occurred.

getSuccessMessage

public java.lang.String getSuccessMessage()

Returns the success message from the installation. Returns null if failure is seen.

getErrorCode

public java.lang.String getErrorCode()

Returns:

The ERROR_CODE part of a message like: "Failure [ERROR_CODE: description]"

isSuccessfullyCompleted

public boolean isSuccessfullyCompleted()

Returns true if the installation was fully successful. If getErrorMessage() returns null and isSuccessfullyCompleted() returns false, a timeout on device side was most likely encountered.

done

public void done()

Description copied from class: MultiLineReceiver

Terminates the process. This is called after the last lines have been through MultiLineReceiver.processNewLines(String[]).

Overrides:

done in class MultiLineReceiver