Summary: Methods | Inherited Methods | [Expand All]

InstrumentationRegistry

This package is part of the Android support library which is no longer maintained. The support library has been superseded by AndroidX which is part of Jetpack. We recommend using the AndroidX libraries in all new projects. You should also consider migrating existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library class mappings.

public final class InstrumentationRegistry
extends Object

java.lang.Object
↳	android.support.test.InstrumentationRegistry

---

An exposed registry instance that holds a reference to the instrumentation running in the process and its arguments. Also provides an easy way for callers to get a hold of instrumentation, application context and instrumentation arguments Bundle.

Summary

Public methods
static Bundle	getArguments() Returns a copy of instrumentation arguments Bundle.
static Context	getContext() Return the Context of this instrumentation's package.
static Instrumentation	getInstrumentation() Returns the instrumentation currently running.
static Context	getTargetContext() Return a Context for the target application being instrumented.
static void	registerInstance(Instrumentation instrumentation, Bundle arguments) Records/exposes the instrumentation currently running and stores a copy of the instrumentation arguments Bundle in the registry.

Inherited methods
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()

Public methods

getArguments

Bundle getArguments ()

Returns a copy of instrumentation arguments Bundle. Use this to get a Bundle containing the command line arguments passed to Instrumentation into your test.

This Bundle is not guaranteed to be present under all instrumentations.

Returns
Bundle	Bundle the arguments for this instrumentation.

Throws
IllegalStateException	if no argument Bundle has been registered.

getContext

Context getContext ()

Return the Context of this instrumentation's package. Use this to get a Context representing getContext() into your test.

Returns
Context

getInstrumentation

Instrumentation getInstrumentation ()

Returns the instrumentation currently running. Use this to get an Instrumentation into your test.

Returns
Instrumentation

Throws
IllegalStateException	if instrumentation hasn't been registered

getTargetContext

Context getTargetContext ()

Return a Context for the target application being instrumented. Use this to get a Context representing getTargetContext() into your test.

Returns
Context

registerInstance

void registerInstance (Instrumentation instrumentation, 
                Bundle arguments)

Records/exposes the instrumentation currently running and stores a copy of the instrumentation arguments Bundle in the registry.

This is a global registry - so be aware of the impact of calling this method!

Parameters
instrumentation	Instrumentation: the instrumentation currently running.
arguments	Bundle: the arguments for this application. Null deregisters any existing arguments.

• Classes

  • InstrumentationRegistry