Home | History | Annotate | Download | only in compat
      1 /*
      2  * Copyright (C) 2015 The Android Open Source Project
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  *      http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License
     15  */
     16 
     17 package com.android.contacts.common.compat;
     18 
     19 import android.os.Build.VERSION;
     20 
     21 /**
     22  * Class used to override the current sdk version to test specific branches of compatibility
     23  * logic. When such branching occurs, use {@link #getSdkVersion(int)} rather than explicitly
     24  * calling {@link VERSION#SDK_INT}. This allows the sdk version to be forced to a specific value.
     25  */
     26 public class SdkVersionOverride {
     27 
     28     /**
     29      * Flag used to determine if override sdk versions are returned.
     30      */
     31     private static final boolean ALLOW_OVERRIDE_VERSION = false;
     32 
     33     private SdkVersionOverride() {}
     34 
     35     /**
     36      * Gets the sdk version
     37      *
     38      * @param overrideVersion the version to attempt using
     39      * @return overrideVersion if the {@link #ALLOW_OVERRIDE_VERSION} flag is set to {@code true},
     40      * otherwise the current version
     41      */
     42     public static int getSdkVersion(int overrideVersion) {
     43         return ALLOW_OVERRIDE_VERSION ? overrideVersion : VERSION.SDK_INT;
     44     }
     45 }
     46