public class

AppSearchEnvironmentFactory

extends java.lang.Object

 java.lang.Object

↳androidx.appsearch.app.AppSearchEnvironmentFactory

Gradle dependencies

compile group: 'androidx.appsearch', name: 'appsearch', version: '1.1.0-alpha05'

  • groupId: androidx.appsearch
  • artifactId: appsearch
  • version: 1.1.0-alpha05

Artifact androidx.appsearch:appsearch:1.1.0-alpha05 it located at Google repository (https://maven.google.com/)

Overview

This is a factory class for implementations needed based on the environment.

Summary

Methods
public static AppSearchEnvironmentgetEnvironmentInstance()

Returns the singleton instance of AppSearchEnvironment.

public static voidsetEnvironmentInstanceForTest(AppSearchEnvironment appSearchEnvironment)

Sets an instance of AppSearchEnvironment.

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

Methods

public static AppSearchEnvironment getEnvironmentInstance()

Returns the singleton instance of AppSearchEnvironment.

public static void setEnvironmentInstanceForTest(AppSearchEnvironment appSearchEnvironment)

Sets an instance of AppSearchEnvironment. for testing.

Source

/*
 * Copyright 2024 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.
 */
// @exportToFramework:skipFile()
package androidx.appsearch.app;

import androidx.annotation.NonNull;
import androidx.annotation.RestrictTo;
import androidx.annotation.VisibleForTesting;

/**
 * This is a factory class for implementations needed based on the environment.
 *
 * @exportToFramework:hide
 */
@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
public class AppSearchEnvironmentFactory {
    private static volatile AppSearchEnvironment sAppSearchEnvironment;

    /** Returns the singleton instance of {@link AppSearchEnvironment}. */
    @NonNull
    public static AppSearchEnvironment getEnvironmentInstance() {
        AppSearchEnvironment localRef = sAppSearchEnvironment;
        if (localRef == null) {
            synchronized (AppSearchEnvironmentFactory.class) {
                localRef = sAppSearchEnvironment;
                if (localRef == null) {
                    sAppSearchEnvironment = localRef =
                            new JetpackAppSearchEnvironment();
                }
            }
        }
        return localRef;
    }

    /** Sets an instance of {@link AppSearchEnvironment}. for testing.*/
    @VisibleForTesting
    public static void setEnvironmentInstanceForTest(
            @NonNull AppSearchEnvironment appSearchEnvironment) {
        synchronized (AppSearchEnvironmentFactory.class) {
            sAppSearchEnvironment = appSearchEnvironment;
        }
    }

    private AppSearchEnvironmentFactory() {
    }
}