Enum LooperMode.Mode

All Implemented Interfaces:
Serializable, Comparable<LooperMode.Mode>, java.lang.constant.Constable
Enclosing class:

public static enum LooperMode.Mode extends Enum<LooperMode.Mode>
Specifies the different supported Looper modes.
  • Enum Constant Details

    • LEGACY

      @Deprecated public static final LooperMode.Mode LEGACY
      use LooperMode.PAUSED
      Robolectric's default threading model prior to 4.4.

      Tasks posted to Loopers are managed via a Scheduler. Scheduler behavior can be controlled via setIdleState(IdleState), with a default of UNPAUSED.

      There is only a single Looper thread - with tests and all posted Looper tasks executing on that thread.

      ShadowLooper APIs can also be used to control posted tasks, but most of those APIs just serve as a facade to Scheduler APIs.

      There are multiple problems with this mode. Some of the major ones are:

      1. The default UNPAUSED state will execute tasks posted to a Looper inline synchronously. This differs from real Android behaviour, and can cause issues with code that expects/enforces that posted tasks execute in the correct order, such as RecyclerViews.
      2. The Scheduler list of Runnables can get out of sync with the Looper's MessageQueue, causing deadlocks or other race conditions.
      3. Each Scheduler keeps its own time value, which can get out of sync.
      4. Background Looper tasks execute in the main thread, causing errors for code that enforces that it runs on a non-main Looper thread.
    • PAUSED

      public static final LooperMode.Mode PAUSED
      A mode that more accurately models real Android's Looper behavior.

      Conceptually LooperMode.PAUSED is similar to the LEGACY Scheduler.IdleState.PAUSED in the following ways:

      • Tests run on the main looper thread
      • Tasks posted to the main Looper are not executed automatically, and must be explicitly executed via ShadowLooper APIs like ShadowLooper.idle(). This guarantees execution order correctness
      • SystemClock time is frozen, and can be manually advanced via Robolectric APIs.
      However, it has the following improvements: A subset of the Scheduler APIs for the 'foreground' scheduler are currently supported in this mode as well, although it is recommended to switch to use ShadowLooper APIs directly.

      To use:

      • Apply the LooperMode(PAUSED) annotation to your test package/class/method (or remove a LooperMode(LEGACY) annotation)
      • Convert any background Scheduler for controlling Loopers to shadowOf(looper)
      • Convert any RoboExecutorService usages to PausedExecutorService or InlineExecutorService
      • Run your tests. If you see an test failures like 'Main looper has queued unexecuted runnables.', you may need to insert shadowOf(getMainLooper()).idle() calls to your test to drain the main Looper.

      public static final LooperMode.Mode INSTRUMENTATION_TEST
      A mode that simulates an android instrumentation test threading model, which has a separate test thread distinct from the main looper thread.

      Otherwise it is quite similar to PAUSED mode. The clock time is still fixed, and you can use shadowLooper methods to pause, unpause, and wait for any looper to be idle.

      It is recommended to use this mode in tests that mostly use androidx.test APIs, which will support being called directly on the main thread or on the test thread. Most org.robolectric APIs that interact with the android UI (e.g. ActivityController) will raise an exception if called off the main thread.

  • Method Details

    • values

      public static LooperMode.Mode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static LooperMode.Mode valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      name - the name of the enum constant to be returned.
      the enum constant with the specified name
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null