Android Open Source - NearestRestaurants Preferences

From Project

Back to project page NearestRestaurants.
License

The source code is released under:
Apache License
If you think the Android project NearestRestaurants listed in this page is inappropriate, such as containing malicious code/tools or violating the copyright, please email info at java2s dot com, thanks.
Java Source Code

package com.jiahaoliuliu.nearestrestaurants.session;
//  ww  w.j a  va 2s. c  o  m
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

import android.content.Context;
import android.content.SharedPreferences;
import android.util.Log;
import android.util.SparseArray;
import android.util.SparseBooleanArray;

/**
 * Class utilized to save the user elemental data persistently.
 */
public class Preferences {

  // The id of the booleans
  // Update the method clearUserData when modified
  public enum BooleanId {
    // The default value of the boolean id
    DEFAULT_BOOLEAN_ID;
    
    public static BooleanId toBooleanId(String booleanId) {
      try {
        return valueOf(booleanId);
      } catch (Exception ex) {
        return DEFAULT_BOOLEAN_ID;
      }
    }
  }
  
  // The id of the strings
  // Update the method clearUserData when modified
  public enum StringId {
    LAST_SCREEN,

    // The default value of the string id
    DEFAULT_STRING_ID;
    
    public static StringId toStringId(String stringId) {
      try {
        return valueOf(stringId);
      } catch (Exception ex) {
        return DEFAULT_STRING_ID;
      }
    }
  }

  public enum IntId {
    // The default id
    DEFAULT_INT_ID;
    public static IntId toIntId(String intId) {
      try {
        return valueOf(intId);
      } catch (Exception ex) {
        return DEFAULT_INT_ID;
      }
    }
  }

  public enum DoubleId {
    LAST_USER_POSITION_LATITUDE, LAST_USER_POSITION_LONGITUDE,
    
    // The default id
    DEFAULT_DOUBLE_ID;
    
    public static DoubleId toDoubleId(String doubleId) {
      try {
        return valueOf(doubleId);
      } catch (Exception ex) {
        return DEFAULT_DOUBLE_ID;
      }
    }
  }
  
  // The id of the long
  // It is used mainly to store the date
  public enum LongId {
    // The default value of the boolean id
    DEFAULT_LONG_ID;
    
    public static LongId toLongId(String longId) {
      try {
        return valueOf(longId);
      } catch (Exception ex) {
        return DEFAULT_LONG_ID;
      }
    }
    
  }
  
  // The id of the list Strings
  // Update the method clearUserData when modified
  public enum ListStringId {
    // The default value of the list string id
    DEFAULT_LIST_STRING_ID;
    public static ListStringId toListStringId(String listStringId) {
      try {
        return valueOf(listStringId);
      } catch (Exception ex) {
        return DEFAULT_LIST_STRING_ID;
      }
    }
  }

  public enum HashMapIntegerId {
    DEFAULT_HASH_MAP_INTEGER_ID;
    
    public static HashMapIntegerId toHashMahIntegerId(String hashMapIntegerId) {
      try {
        return valueOf(hashMapIntegerId);
      } catch (Exception ex) {
        return DEFAULT_HASH_MAP_INTEGER_ID;
      }
    }
  }

  public enum HashMapListStringId {
    DEFAULT_HASH_MAP_LIST_STRING_ID;
    
    public static HashMapListStringId toHashMapListStringId(String hashMapListStringId) {
      try {
        return valueOf(hashMapListStringId);
      } catch (Exception ex) {
        return DEFAULT_HASH_MAP_LIST_STRING_ID;
      }
    }
  }

    /**
     * The tag utilized for the log.
     */
    private static final String LOG_TAG = Preferences.class.getSimpleName();

    /**
     * The name of the file utilized to store the data.
     */
    private static final String FILE_NAME_USER_DATA = "NearestRestaurants.Preferences.userData";

    //The default values
    private static final boolean DEFAULT_BOOLEAN = false;
    private static final String DEFAULT_STRING = null;
    
    // It doesn't matter what value has been set, it will never be used
    private static final Integer DEFAULT_INT = -1;

    // It doesn't matter what value has been set, it will never be used
    // Because the double is saved as long.
    private static final Double DEFAULT_DOUBLE = null;

    // It doesn't matter what value has been set, it will never be used.
    private static final Long DEFAULT_LONG = Long.valueOf(-1);

    // The default data for static set
    private static final HashSet<String> DEFAULT_HASH_SET = new HashSet<String>();

    private static final List<String> DEFAULT_LIST_STRING = new ArrayList<String>();
    
    private static final String SEPARATOR = "_";

    /**
     * The context passed by any Android's component.
     */
    private final Context context;

    /**
     * The shared preferences to save/restore the data.
     */
    private final SharedPreferences sharedPreferencesUserData;

    /**
     * The editor to save the data.
     */
    private final SharedPreferences.Editor editorUserData;

    /**
     * The main constructor.
     * @param context The context passed by any Android's component.
     */
    Preferences(Context context) {
        this.context = context;
        
        // The user shared preferences
        sharedPreferencesUserData = context.getSharedPreferences(FILE_NAME_USER_DATA, Context.MODE_PRIVATE);
        editorUserData = sharedPreferencesUserData.edit();
    }

    //=========================================== public methods ==============================
    // Boolean
    /**
     * Get the data from shared preference
     * @param booleanId The id of the data to get
     * @return          The data if it has been saved
     *                  false otherwise
     */
    public boolean getBoolean(BooleanId booleanId) {
      boolean bool = sharedPreferencesUserData.getBoolean(booleanId.toString(), DEFAULT_BOOLEAN);
      return bool;
      
    }
    
    public void setBoolean(BooleanId booleanId, boolean bool) {
      // The data will be set if it is not the default one
      if (booleanId != BooleanId.DEFAULT_BOOLEAN_ID) {
        editorUserData.putBoolean(booleanId.toString(), bool);
        editorUserData.commit();
      }
    }

    public void removeBoolean(BooleanId booleanId) {
      if (booleanId != BooleanId.DEFAULT_BOOLEAN_ID) {
        if (sharedPreferencesUserData.contains(booleanId.toString())) {
          editorUserData.remove(booleanId.toString());
          editorUserData.commit();
        }
      }
    }

    // String
    public String getString(StringId stringId) {
      String string = sharedPreferencesUserData.getString(stringId.toString(), DEFAULT_STRING);
      return string;
      
    }
    
    public void setString(StringId stringId, String string) {
      // The data will be set if the id is not the default one
      if (stringId != StringId.DEFAULT_STRING_ID) {
        editorUserData.putString(stringId.toString(), string);
        editorUserData.commit();
      }
    }

    public void removeString(StringId stringId) {
      if (stringId != StringId.DEFAULT_STRING_ID) {
        if (sharedPreferencesUserData.contains(stringId.toString())) {
          editorUserData.remove(stringId.toString());
          editorUserData.commit();
        }
      }
    }

    // Integer
    /**
     * Get the data in the shared preferences. If it is not set, return null
     * @param intId The id of the data saved
     * @return      The data if it has been saved
     *              null otherwise
     */
    public Integer getInt(IntId intId) {
      if (sharedPreferencesUserData.contains(intId.toString())) {
        return sharedPreferencesUserData.getInt(intId.toString(), DEFAULT_INT); 
      } else {
        return null;
      }
    }

    public void setInt(IntId intId, Integer integer) {
      // The data will be set if the id is not the default one
      if (intId != IntId.DEFAULT_INT_ID) {
        editorUserData.putInt(intId.toString(), integer);
        editorUserData.commit();
      }
    }

    public void removeInt(IntId intId) {
      if (intId != IntId.DEFAULT_INT_ID) {
        if (sharedPreferencesUserData.contains(intId.toString())) {
          editorUserData.remove(intId.toString());
          editorUserData.commit();
        }
      }
    }

    // Double
    /**
     * Get the data in the shared preferences. If it is not set, return null
     * @param doubleId The id of the data saved
     * @return      The data if it has been saved
     *              null otherwise
     */
    public Double getDouble(DoubleId doubleId) {
      if (sharedPreferencesUserData.contains(doubleId.toString())) {
        return
          Double.longBitsToDouble(
              sharedPreferencesUserData.getLong(doubleId.toString(),
              DEFAULT_LONG));
      } else {
        return DEFAULT_DOUBLE;
      }
    }

    public void setDouble(DoubleId doubleId, Double doubleData) {
      // The data will be set if the id is not the default one
      if (doubleId != DoubleId.DEFAULT_DOUBLE_ID) {
        editorUserData.putLong(doubleId.toString(), Double.doubleToRawLongBits(doubleData));
        editorUserData.commit();
      }
    }

    public void removeDouble(DoubleId doubleId) {
      if (doubleId != DoubleId.DEFAULT_DOUBLE_ID) {
        if (sharedPreferencesUserData.contains(doubleId.toString())) {
          editorUserData.remove(doubleId.toString());
          editorUserData.commit();
        }
      }
    }

    // Long
    /**
     * Get the data saved in the shared preferences.
     * @param longId The id of the data saved
     * @return       The data if it has been set
     *               null otherwise
     */
    public Long getLong(LongId longId) {
      if (sharedPreferencesUserData.contains(longId.toString())) {
        return sharedPreferencesUserData.getLong(longId.toString(), DEFAULT_LONG);
      } else {
        return null;
      }
    }
    
    public void setLong(LongId longId, Long longData) {
      // The data will be set if it is not the default one
      if (longId != LongId.DEFAULT_LONG_ID) {
        editorUserData.putLong(longId.toString(), longData);
        editorUserData.commit();
      }
    }

    public void removeLong(LongId longId) {
      if (longId != LongId.DEFAULT_LONG_ID) {
        if (sharedPreferencesUserData.contains(longId.toString())) {
          editorUserData.remove(longId.toString());
          editorUserData.commit();
        }
      }
    }

    /**
     * Remove all the content of the shared preferences
     */
    public void clearAll() {
      editorUserData.clear();
      editorUserData.commit();
    }
}
Java Source Code List
