main/java/com/google/android/setupcompat/util/BuildCompatUtils.java

/*
 * Copyright (C) 2021 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 com.google.android.setupcompat.util;

import android.os.Build;
import androidx.annotation.ChecksSdkIntAtLeast;

/**
 * An util class to check whether the current OS version is higher or equal to sdk version of
 * device.
 */
public final class BuildCompatUtils {

  /**
   * Implementation of BuildCompat.isAtLeastR() suitable for use in Setup
   *
   * @return Whether the current OS version is higher or equal to R.
   */
  @ChecksSdkIntAtLeast(api = Build.VERSION_CODES.R)
  public static boolean isAtLeastR() {
    return Build.VERSION.SDK_INT >= Build.VERSION_CODES.R;
  }

  /**
   * Implementation of BuildCompat.isAtLeastS() suitable for use in Setup
   *
   * @return Whether the current OS version is higher or equal to S.
   */
  @ChecksSdkIntAtLeast(api = Build.VERSION_CODES.S)
  public static boolean isAtLeastS() {
    return Build.VERSION.SDK_INT >= Build.VERSION_CODES.S;
  }

  /**
   * Implementation of BuildCompat.isAtLeastT() suitable for use in Setup
   *
   * @return Whether the current OS version is higher or equal to T.
   */
  @ChecksSdkIntAtLeast(api = Build.VERSION_CODES.TIRAMISU)
  public static boolean isAtLeastT() {
    return Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU;
  }

  /**
   * Implementation of BuildCompat.isAtLeast*() suitable for use in Setup
   *
   * <p>BuildCompat.isAtLeast*() can be changed by Android Release team, and once that is changed it
   * may take weeks for that to propagate to stable/prerelease/experimental SDKs in Google3. Also it
   * can be different in all these channels. This can cause random issues, especially with sidecars
   * (i.e., the code running on R may not know that it runs on R).
   *
   * <p>This still should try using BuildCompat.isAtLeastR() as source of truth, but also checking
   * for VERSION_SDK_INT and VERSION.CODENAME in case when BuildCompat implementation returned
   * false. Note that both checks should be >= and not = to make sure that when Android version
   * increases (i.e., from R to S), this does not stop working.
   *
   * <p>Supported configurations:
   *
   * <ul>
   *   <li>For current Android release: while new API is not finalized yet (CODENAME =
   *       "UpsideDownCake", SDK_INT = 33)
   *   <li>For current Android release: when new API is finalized (CODENAME = "REL", SDK_INT = 34)
   *   <li>For next Android release (CODENAME = "VanillaIceCream", SDK_INT = 35+)
   * </ul>
   *
   * <p>Note that Build.VERSION_CODES.T cannot be used here until final SDK is available in all
   * channels, because it is equal to Build.VERSION_CODES.CUR_DEVELOPMENT before API finalization.
   *
   * @return Whether the current OS version is higher or equal to U.
   */
  public static boolean isAtLeastU() {
    return (Build.VERSION.CODENAME.equals("REL") && Build.VERSION.SDK_INT >= 34)
        || isAtLeastPreReleaseCodename("UpsideDownCake");
  }

  private static boolean isAtLeastPreReleaseCodename(String codename) {
    // Special case "REL", which means the build is not a pre-release build.
    if (Build.VERSION.CODENAME.equals("REL")) {
      return false;
    }

    // Otherwise lexically compare them. Return true if the build codename is equal to or
    // greater than the requested codename.
    return Build.VERSION.CODENAME.compareTo(codename) >= 0;
  }

  private BuildCompatUtils() {}
}