to top
Android APIs
public class

Instrumentation

extends Object
java.lang.Object
   ↳ android.app.Instrumentation
Known Direct Subclasses

Class Overview

Base class for implementing application instrumentation code. When running with instrumentation turned on, this class will be instantiated for you before any of the application code, allowing you to monitor all of the interaction the system has with the application. An Instrumentation implementation is described to the system through an AndroidManifest.xml's <instrumentation> tag.

Summary

Nested Classes
class Instrumentation.ActivityMonitor Information about a particular kind of Intent that is being monitored. 
class Instrumentation.ActivityResult Description of a Activity execution result to return to the original activity. 
Constants
String REPORT_KEY_IDENTIFIER If included in the status or final bundle sent to an IInstrumentationWatcher, this key identifies the class that is writing the report.
String REPORT_KEY_STREAMRESULT If included in the status or final bundle sent to an IInstrumentationWatcher, this key identifies a string which can simply be printed to the output stream.
Public Constructors
Instrumentation()
Public Methods
Instrumentation.ActivityMonitor addMonitor(IntentFilter filter, Instrumentation.ActivityResult result, boolean block)
A convenience wrapper for addMonitor(ActivityMonitor) that creates an intent filter matching Instrumentation.ActivityMonitor for you and returns it.
void addMonitor(Instrumentation.ActivityMonitor monitor)
Add a new Instrumentation.ActivityMonitor that will be checked whenever an activity is started.
Instrumentation.ActivityMonitor addMonitor(String cls, Instrumentation.ActivityResult result, boolean block)
A convenience wrapper for addMonitor(ActivityMonitor) that creates a class matching Instrumentation.ActivityMonitor for you and returns it.
void callActivityOnCreate(Activity activity, Bundle icicle)
Perform calling of an activity's onCreate(Bundle) method.
void callActivityOnDestroy(Activity activity)
void callActivityOnNewIntent(Activity activity, Intent intent)
Perform calling of an activity's onNewIntent(Intent) method.
void callActivityOnPause(Activity activity)
Perform calling of an activity's onPause() method.
void callActivityOnPostCreate(Activity activity, Bundle icicle)
Perform calling of an activity's onPostCreate(Bundle) method.
void callActivityOnRestart(Activity activity)
Perform calling of an activity's onRestart() method.
void callActivityOnRestoreInstanceState(Activity activity, Bundle savedInstanceState)
Perform calling of an activity's onRestoreInstanceState(Bundle) method.
void callActivityOnResume(Activity activity)
Perform calling of an activity's onResume() method.
void callActivityOnSaveInstanceState(Activity activity, Bundle outState)
Perform calling of an activity's onSaveInstanceState(Bundle) method.
void callActivityOnStart(Activity activity)
Perform calling of an activity's onStart() method.
void callActivityOnStop(Activity activity)
Perform calling of an activity's onStop() method.
void callActivityOnUserLeaving(Activity activity)
Perform calling of an activity's onUserLeaveHint() method.
void callApplicationOnCreate(Application app)
Perform calling of the application's onCreate() method.
boolean checkMonitorHit(Instrumentation.ActivityMonitor monitor, int minHits)
Test whether an existing Instrumentation.ActivityMonitor has been hit.
void endPerformanceSnapshot()
void finish(int resultCode, Bundle results)
Terminate instrumentation of the application.
Bundle getAllocCounts()
Returns a bundle with the current results from the allocation counting.
Bundle getBinderCounts()
Returns a bundle with the counts for various binder counts for this process.
ComponentName getComponentName()
Returns complete component name of this instrumentation.
Context getContext()
Return the Context of this instrumentation's package.
Context getTargetContext()
Return a Context for the target application being instrumented.
UiAutomation getUiAutomation()
Gets the UiAutomation instance.
boolean invokeContextMenuAction(Activity targetActivity, int id, int flag)
Show the context menu for the currently focused view and executes a particular context menu item.
boolean invokeMenuActionSync(Activity targetActivity, int id, int flag)
Execute a particular menu item.
boolean isProfiling()
Check whether this instrumentation was started with profiling enabled.
Activity newActivity(ClassLoader cl, String className, Intent intent)
Perform instantiation of the process's Activity object.
Activity newActivity(Class<?> clazz, Context context, IBinder token, Application application, Intent intent, ActivityInfo info, CharSequence title, Activity parent, String id, Object lastNonConfigurationInstance)
Perform instantiation of an Activity object.
Application newApplication(ClassLoader cl, String className, Context context)
Perform instantiation of the process's Application object.
static Application newApplication(Class<?> clazz, Context context)
Perform instantiation of the process's Application object.
void onCreate(Bundle arguments)
Called when the instrumentation is starting, before any application code has been loaded.
void onDestroy()
Called when the instrumented application is stopping, after all of the normal application cleanup has occurred.
boolean onException(Object obj, Throwable e)
This is called whenever the system captures an unhandled exception that was thrown by the application.
void onStart()
Method where the instrumentation thread enters execution.
void removeMonitor(Instrumentation.ActivityMonitor monitor)
void runOnMainSync(Runnable runner)
Execute a call on the application's main thread, blocking until it is complete.
void sendCharacterSync(int keyCode)
Higher-level method for sending both the down and up key events for a particular character key code.
void sendKeyDownUpSync(int key)
Sends an up and down key event sync to the currently focused window.
void sendKeySync(KeyEvent event)
Send a key event to the currently focused window/view and wait for it to be processed.
void sendPointerSync(MotionEvent event)
Dispatch a pointer event.
void sendStatus(int resultCode, Bundle results)
Provide a status report about the application.
void sendStringSync(String text)
Sends the key events corresponding to the text to the app being instrumented.
void sendTrackballEventSync(MotionEvent event)
Dispatch a trackball event.
void setAutomaticPerformanceSnapshots()
void setInTouchMode(boolean inTouch)
Force the global system in or out of touch mode.
void start()
Create and start a new thread in which to run instrumentation.
Activity startActivitySync(Intent intent)
Start a new activity and wait for it to begin running before returning.
void startAllocCounting()
void startPerformanceSnapshot()
void startProfiling()
This method will start profiling if isProfiling() returns true.
void stopAllocCounting()
void stopProfiling()
Stops profiling if isProfiling() returns true.
void waitForIdle(Runnable recipient)
Schedule a callback for when the application's main thread goes idle (has no more events to process).
void waitForIdleSync()
Synchronously wait for the application to be idle.
Activity waitForMonitor(Instrumentation.ActivityMonitor monitor)
Wait for an existing Instrumentation.ActivityMonitor to be hit.
Activity waitForMonitorWithTimeout(Instrumentation.ActivityMonitor monitor, long timeOut)
Wait for an existing Instrumentation.ActivityMonitor to be hit till the timeout expires.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String REPORT_KEY_IDENTIFIER

Added in API level 1

If included in the status or final bundle sent to an IInstrumentationWatcher, this key identifies the class that is writing the report. This can be used to provide more structured logging or reporting capabilities in the IInstrumentationWatcher.

Constant Value: "id"

public static final String REPORT_KEY_STREAMRESULT

Added in API level 1

If included in the status or final bundle sent to an IInstrumentationWatcher, this key identifies a string which can simply be printed to the output stream. Using these streams provides a "pretty printer" version of the status & final packets. Any bundles including this key should also include the complete set of raw key/value pairs, so that the instrumentation can also be launched, and results collected, by an automated system.

Constant Value: "stream"

Public Constructors

public Instrumentation ()

Added in API level 1

Public Methods

public Instrumentation.ActivityMonitor addMonitor (IntentFilter filter, Instrumentation.ActivityResult result, boolean block)

Added in API level 1

A convenience wrapper for addMonitor(ActivityMonitor) that creates an intent filter matching Instrumentation.ActivityMonitor for you and returns it.

Parameters
filter The set of intents this monitor is responsible for.
result A canned result to return if the monitor is hit; can be null.
block Controls whether the monitor should block the activity start (returning its canned result) or let the call proceed.
Returns
  • The newly created and added activity monitor.

public void addMonitor (Instrumentation.ActivityMonitor monitor)

Added in API level 1

Add a new Instrumentation.ActivityMonitor that will be checked whenever an activity is started. The monitor is added after any existing ones; the monitor will be hit only if none of the existing monitors can themselves handle the Intent.

Parameters
monitor The new ActivityMonitor to see.

public Instrumentation.ActivityMonitor addMonitor (String cls, Instrumentation.ActivityResult result, boolean block)

Added in API level 1

A convenience wrapper for addMonitor(ActivityMonitor) that creates a class matching Instrumentation.ActivityMonitor for you and returns it.

Parameters
cls The activity class this monitor is responsible for.
result A canned result to return if the monitor is hit; can be null.
block Controls whether the monitor should block the activity start (returning its canned result) or let the call proceed.
Returns
  • The newly created and added activity monitor.

public void callActivityOnCreate (Activity activity, Bundle icicle)

Added in API level 1

Perform calling of an activity's onCreate(Bundle) method. The default implementation simply calls through to that method.

Parameters
activity The activity being created.
icicle The previously frozen state (or null) to pass through to onCreate().

public void callActivityOnDestroy (Activity activity)

Added in API level 1

public void callActivityOnNewIntent (Activity activity, Intent intent)

Added in API level 1

Perform calling of an activity's onNewIntent(Intent) method. The default implementation simply calls through to that method.

Parameters
activity The activity receiving a new Intent.
intent The new intent being received.

public void callActivityOnPause (Activity activity)

Added in API level 1

Perform calling of an activity's onPause() method. The default implementation simply calls through to that method.

Parameters
activity The activity being paused.

public void callActivityOnPostCreate (Activity activity, Bundle icicle)

Added in API level 1

Perform calling of an activity's onPostCreate(Bundle) method. The default implementation simply calls through to that method.

Parameters
activity The activity being created.
icicle The previously frozen state (or null) to pass through to onPostCreate().

public void callActivityOnRestart (Activity activity)

Added in API level 1

Perform calling of an activity's onRestart() method. The default implementation simply calls through to that method.

Parameters
activity The activity being restarted.

public void callActivityOnRestoreInstanceState (Activity activity, Bundle savedInstanceState)

Added in API level 1

Perform calling of an activity's onRestoreInstanceState(Bundle) method. The default implementation simply calls through to that method.

Parameters
activity The activity being restored.
savedInstanceState The previously saved state being restored.

public void callActivityOnResume (Activity activity)

Added in API level 1

Perform calling of an activity's onResume() method. The default implementation simply calls through to that method.

Parameters
activity The activity being resumed.

public void callActivityOnSaveInstanceState (Activity activity, Bundle outState)

Added in API level 1

Perform calling of an activity's onSaveInstanceState(Bundle) method. The default implementation simply calls through to that method.

Parameters
activity The activity being saved.
outState The bundle to pass to the call.

public void callActivityOnStart (Activity activity)

Added in API level 1

Perform calling of an activity's onStart() method. The default implementation simply calls through to that method.

Parameters
activity The activity being started.

public void callActivityOnStop (Activity activity)

Added in API level 1

Perform calling of an activity's onStop() method. The default implementation simply calls through to that method.

Parameters
activity The activity being stopped.

public void callActivityOnUserLeaving (Activity activity)

Added in API level 3

Perform calling of an activity's onUserLeaveHint() method. The default implementation simply calls through to that method.

Parameters
activity The activity being notified that the user has navigated away

public void callApplicationOnCreate (Application app)

Added in API level 1

Perform calling of the application's onCreate() method. The default implementation simply calls through to that method.

Note: This method will be called immediately after onCreate(Bundle). Often instrumentation tests start their test thread in onCreate(); you need to be careful of races between these. (Well between it and everything else, but let's start here.)

Parameters
app The application being created.

public boolean checkMonitorHit (Instrumentation.ActivityMonitor monitor, int minHits)

Added in API level 1

Test whether an existing Instrumentation.ActivityMonitor has been hit. If the monitor has been hit at least minHits times, then it will be removed from the activity monitor list and true returned. Otherwise it is left as-is and false is returned.

Parameters
monitor The ActivityMonitor to check.
minHits The minimum number of hits required.
Returns
  • True if the hit count has been reached, else false.

public void endPerformanceSnapshot ()

Added in API level 1

public void finish (int resultCode, Bundle results)

Added in API level 1

Terminate instrumentation of the application. This will cause the application process to exit, removing this instrumentation from the next time the application is started.

Parameters
resultCode Overall success/failure of instrumentation.
results Any results to send back to the code that started the instrumentation.

public Bundle getAllocCounts ()

Added in API level 1

Returns a bundle with the current results from the allocation counting.

public Bundle getBinderCounts ()

Added in API level 1

Returns a bundle with the counts for various binder counts for this process. Currently the only two that are reported are the number of send and the number of received transactions.

public ComponentName getComponentName ()

Added in API level 1

Returns complete component name of this instrumentation.

Returns
  • Returns the complete component name for this instrumentation.

public Context getContext ()

Added in API level 1

Return the Context of this instrumentation's package. Note that this is often different than the Context of the application being instrumentated, since the instrumentation code often lives is a different package than that of the application it is running against. See getTargetContext() to retrieve a Context for the target application.

Returns
  • The instrumentation's package context.

public Context getTargetContext ()

Added in API level 1

Return a Context for the target application being instrumented. Note that this is often different than the Context of the instrumentation code, since the instrumentation code often lives is a different package than that of the application it is running against. See getContext() to retrieve a Context for the instrumentation code.

Returns
  • A Context in the target application.
See Also

public UiAutomation getUiAutomation ()

Added in API level 18

Gets the UiAutomation instance.

Note: The APIs exposed via the returned UiAutomation work across application boundaries while the APIs exposed by the instrumentation do not. For example, sendPointerSync(MotionEvent) will not allow you to inject the event in an app different from the instrumentation target, while injectInputEvent(android.view.InputEvent, boolean) will work regardless of the current application.

A typical test case should be using either the UiAutomation or Instrumentation APIs. Using both APIs at the same time is not a mistake by itself but a client has to be aware of the APIs limitations.

Returns
  • The UI automation instance.
See Also

public boolean invokeContextMenuAction (Activity targetActivity, int id, int flag)

Added in API level 1

Show the context menu for the currently focused view and executes a particular context menu item.

Parameters
targetActivity The activity in question.
id The identifier associated with the context menu item.
flag Additional flags, if any.
Returns
  • Whether the invocation was successful (for example, it could be false if item is disabled).

public boolean invokeMenuActionSync (Activity targetActivity, int id, int flag)

Added in API level 1

Execute a particular menu item.

Parameters
targetActivity The activity in question.
id The identifier associated with the menu item.
flag Additional flags, if any.
Returns
  • Whether the invocation was successful (for example, it could be false if item is disabled).

public boolean isProfiling ()

Added in API level 1

Check whether this instrumentation was started with profiling enabled.

Returns
  • Returns true if profiling was enabled when starting, else false.

public Activity newActivity (ClassLoader cl, String className, Intent intent)

Added in API level 1

Perform instantiation of the process's Activity object. The default implementation provides the normal system behavior.

Parameters
cl The ClassLoader with which to instantiate the object.
className The name of the class implementing the Activity object.
intent The Intent object that specified the activity class being instantiated.
Returns
  • The newly instantiated Activity object.

public Activity newActivity (Class<?> clazz, Context context, IBinder token, Application application, Intent intent, ActivityInfo info, CharSequence title, Activity parent, String id, Object lastNonConfigurationInstance)

Added in API level 1

Perform instantiation of an Activity object. This method is intended for use with unit tests, such as android.test.ActivityUnitTestCase. The activity will be useable locally but will be missing some of the linkages necessary for use within the sytem.

Parameters
clazz The Class of the desired Activity
context The base context for the activity to use
token The token for this activity to communicate with
application The application object (if any)
intent The intent that started this Activity
info ActivityInfo from the manifest
title The title, typically retrieved from the ActivityInfo record
parent The parent Activity (if any)
id The embedded Id (if any)
lastNonConfigurationInstance Arbitrary object that will be available via Activity.getLastNonConfigurationInstance().
Returns
  • Returns the instantiated activity
Throws
InstantiationException
IllegalAccessException
InstantiationException

public Application newApplication (ClassLoader cl, String className, Context context)

Added in API level 1

Perform instantiation of the process's Application object. The default implementation provides the normal system behavior.

Parameters
cl The ClassLoader with which to instantiate the object.
className The name of the class implementing the Application object.
context The context to initialize the application with
Returns
  • The newly instantiated Application object.

public static Application newApplication (Class<?> clazz, Context context)

Added in API level 1

Perform instantiation of the process's Application object. The default implementation provides the normal system behavior.

Parameters
clazz The class used to create an Application object from.
context The context to initialize the application with
Returns
  • The newly instantiated Application object.

public void onCreate (Bundle arguments)

Added in API level 1

Called when the instrumentation is starting, before any application code has been loaded. Usually this will be implemented to simply call start() to begin the instrumentation thread, which will then continue execution in onStart().

If you do not need your own thread -- that is you are writing your instrumentation to be completely asynchronous (returning to the event loop so that the application can run), you can simply begin your instrumentation here, for example call startActivity(Intent) to begin the appropriate first activity of the application.

Parameters
arguments Any additional arguments that were supplied when the instrumentation was started.

public void onDestroy ()

Added in API level 1

Called when the instrumented application is stopping, after all of the normal application cleanup has occurred.

public boolean onException (Object obj, Throwable e)

Added in API level 1

This is called whenever the system captures an unhandled exception that was thrown by the application. The default implementation simply returns false, allowing normal system handling of the exception to take place.

Parameters
obj The client object that generated the exception. May be an Application, Activity, BroadcastReceiver, Service, or null.
e The exception that was thrown.
Returns
  • To allow normal system exception process to occur, return false. If true is returned, the system will proceed as if the exception didn't happen.

public void onStart ()

Added in API level 1

Method where the instrumentation thread enters execution. This allows you to run your instrumentation code in a separate thread than the application, so that it can perform blocking operation such as sendKeySync(KeyEvent) or startActivitySync(Intent).

You will typically want to call finish() when this function is done, to end your instrumentation.

public void removeMonitor (Instrumentation.ActivityMonitor monitor)

Added in API level 1
Parameters
monitor The monitor to remove.

public void runOnMainSync (Runnable runner)

Added in API level 1

Execute a call on the application's main thread, blocking until it is complete. Useful for doing things that are not thread-safe, such as looking at or modifying the view hierarchy.

Parameters
runner The code to run on the main thread.

public void sendCharacterSync (int keyCode)

Added in API level 1

Higher-level method for sending both the down and up key events for a particular character key code. Equivalent to creating both KeyEvent objects by hand and calling sendKeySync(KeyEvent). The event appears as if it came from keyboard 0, the built in one.

Parameters
keyCode The key code of the character to send.

public void sendKeyDownUpSync (int key)

Added in API level 1

Sends an up and down key event sync to the currently focused window.

Parameters
key The integer keycode for the event.

public void sendKeySync (KeyEvent event)

Added in API level 1

Send a key event to the currently focused window/view and wait for it to be processed. Finished at some point after the recipient has returned from its event processing, though it may not have completely finished reacting from the event -- for example, if it needs to update its display as a result, it may still be in the process of doing that.

Parameters
event The event to send to the current focus.

public void sendPointerSync (MotionEvent event)

Added in API level 1

Dispatch a pointer event. Finished at some point after the recipient has returned from its event processing, though it may not have completely finished reacting from the event -- for example, if it needs to update its display as a result, it may still be in the process of doing that.

Parameters
event A motion event describing the pointer action. (As noted in obtain(long, long, int, float, float, int), be sure to use uptimeMillis() as the timebase.

public void sendStatus (int resultCode, Bundle results)

Added in API level 1

Provide a status report about the application.

Parameters
resultCode Current success/failure of instrumentation.
results Any results to send back to the code that started the instrumentation.

public void sendStringSync (String text)

Added in API level 1

Sends the key events corresponding to the text to the app being instrumented.

Parameters
text The text to be sent.

public void sendTrackballEventSync (MotionEvent event)

Added in API level 1

Dispatch a trackball event. Finished at some point after the recipient has returned from its event processing, though it may not have completely finished reacting from the event -- for example, if it needs to update its display as a result, it may still be in the process of doing that.

Parameters
event A motion event describing the trackball action. (As noted in obtain(long, long, int, float, float, int), be sure to use uptimeMillis() as the timebase.

public void setAutomaticPerformanceSnapshots ()

Added in API level 1

public void setInTouchMode (boolean inTouch)

Added in API level 1

Force the global system in or out of touch mode. This can be used if your instrumentation relies on the UI being in one more or the other when it starts.

Parameters
inTouch Set to true to be in touch mode, false to be in focus mode.

public void start ()

Added in API level 1

Create and start a new thread in which to run instrumentation. This new thread will call to onStart() where you can implement the instrumentation.

public Activity startActivitySync (Intent intent)

Added in API level 1

Start a new activity and wait for it to begin running before returning. In addition to being synchronous, this method as some semantic differences from the standard startActivity(Intent) call: the activity component is resolved before talking with the activity manager (its class name is specified in the Intent that this method ultimately starts), and it does not allow you to start activities that run in a different process. In addition, if the given Intent resolves to multiple activities, instead of displaying a dialog for the user to select an activity, an exception will be thrown.

The function returns as soon as the activity goes idle following the call to its onCreate(Bundle). Generally this means it has gone through the full initialization including onResume() and drawn and displayed its initial window.

Parameters
intent Description of the activity to start.

public void startAllocCounting ()

Added in API level 1

public void startPerformanceSnapshot ()

Added in API level 1

public void startProfiling ()

Added in API level 1

This method will start profiling if isProfiling() returns true. You should only call this method if you set the handleProfiling attribute in the manifest file for this Instrumentation to true.

public void stopAllocCounting ()

Added in API level 1

public void stopProfiling ()

Added in API level 1

Stops profiling if isProfiling() returns true.

public void waitForIdle (Runnable recipient)

Added in API level 1

Schedule a callback for when the application's main thread goes idle (has no more events to process).

Parameters
recipient Called the next time the thread's message queue is idle.

public void waitForIdleSync ()

Added in API level 1

Synchronously wait for the application to be idle. Can not be called from the main application thread -- use start() to execute instrumentation in its own thread.

public Activity waitForMonitor (Instrumentation.ActivityMonitor monitor)

Added in API level 1

Wait for an existing Instrumentation.ActivityMonitor to be hit. Once the monitor has been hit, it is removed from the activity monitor list and the first created Activity object that matched it is returned.

Parameters
monitor The ActivityMonitor to wait for.
Returns
  • The Activity object that matched the monitor.

public Activity waitForMonitorWithTimeout (Instrumentation.ActivityMonitor monitor, long timeOut)

Added in API level 1

Wait for an existing Instrumentation.ActivityMonitor to be hit till the timeout expires. Once the monitor has been hit, it is removed from the activity monitor list and the first created Activity object that matched it is returned. If the timeout expires, a null object is returned.

Parameters
monitor The ActivityMonitor to wait for.
timeOut The timeout value in secs.
Returns
  • The Activity object that matched the monitor.