OpenTracks/MyTracks/src/com/google/android/apps/mytracks/util/PreferencesUtils.java

/*
 * Copyright 2012 Google Inc.
 * 
 * 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.apps.mytracks.util;

import com.google.android.apps.mytracks.Constants;

import android.content.Context;
import android.content.SharedPreferences;
import android.content.SharedPreferences.Editor;

/**
 * Utilities to access preferences stored in {@link SharedPreferences}.
 * 
 * @author Jimmy Shih
 */
public class PreferencesUtils {

  /*
   * Preferences values. The defaults need to match the defaults in the xml
   * files.
   */
  public static final boolean ALLOW_ACCESS_DEFAULT = false;
  public static final int ANNOUNCEMENT_FREQUENCY_DEFAULT = 0;
  public static final int AUTO_RESUME_TRACK_CURRENT_RETRY_DEFAULT = 0;

  public static final int AUTO_RESUME_TRACK_TIMEOUT_ALWAYS = -1;
  public static final int AUTO_RESUME_TRACK_TIMEOUT_DEFAULT = 10;
  public static final int AUTO_RESUME_TRACK_TIMEOUT_NEVER = 0;

  public static final String BLUETOOTH_SENSOR_DEFAULT = "";

  public static final boolean CHART_BY_DISTANCE_DEFAULT = true;
  public static final boolean CHART_SHOW_CADENCE_DEFAULT = true;
  public static final boolean CHART_SHOW_ELEVATION_DEFAULT = true;
  public static final boolean CHART_SHOW_HEART_RATE_DEFAULT = true;
  public static final boolean CHART_SHOW_POWER_DEFAULT = true;
  public static final boolean CHART_SHOW_SPEED_DEFAULT = true;

  public static final String DEFAULT_ACTIVITY_DEFAULT = "";
  public static final boolean DEFAULT_MAP_PUBLIC_DEFAULT = true;
  public static final int FREQUENCY_OFF = 0;
  public static final int MAX_RECORDING_DISTANCE_DEFAULT = 200;
  public static final boolean METRIC_UNITS_DEFAULT = true;
  public static final int MIN_RECORDING_DISTANCE_DEFAULT = 5;

  public static final int MIN_RECORDING_INTERVAL_ADAPT_ACCURACY = -1;
  public static final int MIN_RECORDING_INTERVAL_ADAPT_BATTERY_LIFE = -2;
  public static final int MIN_RECORDING_INTERVAL_DEFAULT = 0;

  public static final int MIN_REQUIRED_ACCURACY_DEFAULT = 200;
  public static final int MIN_REQUIRED_ACCURACY_EXCELLENT = 10;
  public static final int MIN_REQUIRED_ACCURACY_POOR = 5000;

  public static final boolean PICK_EXISTING_MAP_DEFAULT = false;
  public static final long RECORDING_TRACK_ID_DEFAULT = -1L;
  public static final boolean REPORT_SPEED_DEFAULT = true;
  public static final long SELECTED_TRACK_ID_DEFAULT = -1L;
  public static final boolean SEND_TO_DOCS_DEFAULT = true;
  public static final boolean SEND_TO_FUSION_TABLES_DEFAULT = true;
  public static final boolean SEND_TO_MAPS_DEFAULT = true;
  public static final String SHARING_ACCOUNT_DEFAULT = "";
  public static final boolean SHOW_CHECK_UNITS_DIALOG_DEFAULT = true;
  public static final boolean SHOW_WELCOME_DIALOG_DEFAULT = true;
  public static final int SPLIT_FREQUENCY_DEFAULT = 0;

  public static final boolean STATS_SHOW_COORDINATE_DEFAULT = false;
  public static final boolean STATS_SHOW_ELEVATION_DEFAULT = false;
  public static final boolean STATS_SHOW_GRADE_DEFAULT = false;
  public static final boolean STATS_USE_TOTAL_TIME_DEFAULT = true;

  public static final int TRACK_COLOR_MODE_MEDIUM_DEFAULT = 15;
  public static final int TRACK_COLOR_MODE_PERCENTAGE_DEFAULT = 25;
  public static final int TRACK_COLOR_MODE_SLOW_DEFAULT = 9;

  private PreferencesUtils() {}

  /**
   * Gets a preference key
   * 
   * @param context the context
   * @param keyId the key id
   */
  public static String getKey(Context context, int keyId) {
    return context.getString(keyId);
  }

  /**
   * Gets a boolean preference value.
   * 
   * @param context the context
   * @param keyId the key id
   * @param defaultValue the default value
   */
  public static boolean getBoolean(Context context, int keyId, boolean defaultValue) {
    SharedPreferences sharedPreferences = context.getSharedPreferences(
        Constants.SETTINGS_NAME, Context.MODE_PRIVATE);
    return sharedPreferences.getBoolean(getKey(context, keyId), defaultValue);
  }

  /**
   * Sets a boolean preference value.
   * 
   * @param context the context
   * @param keyId the key id
   * @param value the value
   */
  public static void setBoolean(Context context, int keyId, boolean value) {
    SharedPreferences sharedPreferences = context.getSharedPreferences(
        Constants.SETTINGS_NAME, Context.MODE_PRIVATE);
    Editor editor = sharedPreferences.edit();
    editor.putBoolean(getKey(context, keyId), value);
    ApiAdapterFactory.getApiAdapter().applyPreferenceChanges(editor);
  }

  /**
   * Gets an integer preference value.
   * 
   * @param context the context
   * @param keyId the key id
   * @param defaultValue the default value
   */
  public static int getInt(Context context, int keyId, int defaultValue) {
    SharedPreferences sharedPreferences = context.getSharedPreferences(
        Constants.SETTINGS_NAME, Context.MODE_PRIVATE);
    return sharedPreferences.getInt(getKey(context, keyId), defaultValue);
  }

  /**
   * Sets an integer preference value.
   * 
   * @param context the context
   * @param keyId the key id
   * @param value the value
   */
  public static void setInt(Context context, int keyId, int value) {
    SharedPreferences sharedPreferences = context.getSharedPreferences(
        Constants.SETTINGS_NAME, Context.MODE_PRIVATE);
    Editor editor = sharedPreferences.edit();
    editor.putInt(getKey(context, keyId), value);
    ApiAdapterFactory.getApiAdapter().applyPreferenceChanges(editor);
  }

  /**
   * Gets a long preference value.
   * 
   * @param context the context
   * @param keyId the key id
   */
  public static long getLong(Context context, int keyId) {
    SharedPreferences sharedPreferences = context.getSharedPreferences(
        Constants.SETTINGS_NAME, Context.MODE_PRIVATE);
    return sharedPreferences.getLong(getKey(context, keyId), -1L);
  }

  /**
   * Sets a long preference value.
   * 
   * @param context the context
   * @param keyId the key id
   * @param value the value
   */
  public static void setLong(Context context, int keyId, long value) {
    SharedPreferences sharedPreferences = context.getSharedPreferences(
        Constants.SETTINGS_NAME, Context.MODE_PRIVATE);
    Editor editor = sharedPreferences.edit();
    editor.putLong(getKey(context, keyId), value);
    ApiAdapterFactory.getApiAdapter().applyPreferenceChanges(editor);
  }
  
  /**
   * Gets a string preference value.
   * 
   * @param context the context
   * @param keyId the key id
   * @param defaultValue default value
   */
  public static String getString(Context context, int keyId, String defaultValue) {
    SharedPreferences sharedPreferences = context.getSharedPreferences(
        Constants.SETTINGS_NAME, Context.MODE_PRIVATE);
    return sharedPreferences.getString(getKey(context, keyId), defaultValue);
  }
  
  /**
   * Sets a string preference value.
   * 
   * @param context the context
   * @param keyId the key id
   * @param value the value
   */
  public static void setString(Context context, int keyId, String value) {
    SharedPreferences sharedPreferences = context.getSharedPreferences(
        Constants.SETTINGS_NAME, Context.MODE_PRIVATE);
    Editor editor = sharedPreferences.edit();
    editor.putString(getKey(context, keyId), value);
    ApiAdapterFactory.getApiAdapter().applyPreferenceChanges(editor);
  }
}