InstrumentationRegistry

public final class InstrumentationRegistry
extends Object

java.lang.Object
   ↳ androidx.test.platform.app.InstrumentationRegistry


An exposed registry instance that holds a reference to the instrumentation running in the process and its arguments.

Instrumentation and InstrumentationRegistry are low level APIs, typically used by higher level test frameworks. It is generally not recommended for direct use by most tests.

Summary

Public methods

static Bundle getArguments()

Returns a copy of instrumentation arguments Bundle.

static Instrumentation getInstrumentation()

Returns the instrumentation currently running.

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

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.

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

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.