public final class

ApplicationLifecycleMonitorRegistry

extends java.lang.Object

 java.lang.Object

↳androidx.test.runner.lifecycle.ApplicationLifecycleMonitorRegistry

Gradle dependencies

compile group: 'androidx.test', name: 'monitor', version: '1.6.0-alpha03'

  • groupId: androidx.test
  • artifactId: monitor
  • version: 1.6.0-alpha03

Artifact androidx.test:monitor:1.6.0-alpha03 it located at Google repository (https://maven.google.com/)

Androidx artifact mapping:

androidx.test:monitor com.android.support.test:monitor

Androidx class mapping:

androidx.test.runner.lifecycle.ApplicationLifecycleMonitorRegistry android.support.test.runner.lifecycle.ApplicationLifecycleMonitorRegistry

Overview

An exposed registry instance to make it easy for callers to find the application lifecycle monitor for their application.

Summary

Methods
public static ApplicationLifecycleMonitorgetInstance()

Returns the ActivityLifecycleMonitor.

public static voidregisterInstance(ApplicationLifecycleMonitor monitor)

Stores a lifecycle monitor in the registry.

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods

public static ApplicationLifecycleMonitor getInstance()

Returns the ActivityLifecycleMonitor.

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

Returns:

ActivityLifecycleMonitor the monitor for this application.

public static void registerInstance(ApplicationLifecycleMonitor monitor)

Stores a lifecycle monitor in the registry.

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

Parameters:

monitor: the monitor for this application. Null deregisters any existing monitor.

Source

/*
 * Copyright (C) 2014 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package androidx.test.runner.lifecycle;

import java.util.concurrent.atomic.AtomicReference;

/**
 * An exposed registry instance to make it easy for callers to find the application lifecycle
 * monitor for their application.
 */
public final class ApplicationLifecycleMonitorRegistry {

  private static final AtomicReference<ApplicationLifecycleMonitor> lifecycleMonitor =
      new AtomicReference<ApplicationLifecycleMonitor>(null);

  // singleton - disallow creation
  private ApplicationLifecycleMonitorRegistry() {}

  /**
   * Returns the ActivityLifecycleMonitor.
   *
   * <p>This monitor is not guaranteed to be present under all instrumentations.
   *
   * @return ActivityLifecycleMonitor the monitor for this application.
   * @throws IllegalStateException if no monitor has been registered.
   */
  public static ApplicationLifecycleMonitor getInstance() {
    ApplicationLifecycleMonitor instance = lifecycleMonitor.get();
    if (null == instance) {
      throw new IllegalStateException(
          "No lifecycle monitor registered! Are you running "
              + "under an Instrumentation which registers lifecycle monitors?");
    }
    return instance;
  }

  /**
   * Stores a lifecycle monitor in the registry.
   *
   * <p>This is a global registry - so be aware of the impact of calling this method!
   *
   * @param monitor the monitor for this application. Null deregisters any existing monitor.
   */
  public static void registerInstance(ApplicationLifecycleMonitor monitor) {
    lifecycleMonitor.set(monitor);
  }
}