UiThreadTestRule

Kotlin |Java

class UiThreadTestRule : TestRule

This rule allows the test method annotated with UiThreadTest to execute on the application's main thread (or UI thread).

Note, methods annotated with Before and After will also be executed on the UI thread.

See also
`UiThreadTest`	if you need to switch in and out of the UI thread within your method.

Summary

Public constructors
`UiThreadTestRule()`

Public functions
`Statement!`	`apply(base: Statement!, description: Description!)`
`Unit`	`runOnUiThread(runnable: Runnable!)` Helper method for running part of a method on the UI thread.

Protected functions
`Boolean`	`shouldRunOnUiThread(description: Description!)`

Public constructors

UiThreadTestRule

UiThreadTestRule()

Public functions

apply

fun apply(base: Statement!, description: Description!): Statement!

runOnUiThread

fun runOnUiThread(runnable: Runnable!): Unit

Helper method for running part of a method on the UI thread.

Note: In most cases it is simpler to annotate the test method with UiThreadTest.

Use this method if you need to switch in and out of the UI thread within your method.

Parameters
`runnable: Runnable!`	runnable containing test code in the `run` method

Throws
`java.lang.Throwable`

See also
`UiThreadTest`

Protected functions

shouldRunOnUiThread

protected fun shouldRunOnUiThread(description: Description!): Boolean

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Last updated 2025-05-15 UTC.

X
Follow @AndroidDev on X
YouTube
Check out Android Developers on YouTube
LinkedIn
Connect with the Android Developers community on LinkedIn