Android Open Source - open311-android Preferences

• Back to Development/api  ↑

From Project

Back to project page open311-android.

License

The source code is released under:

GNU General Public License

Java Source Code

/**
 * A static helper class for interacting with SharedPreferences
 * /*from  w  w  w. j a va  2 s.  c  om*/
 * This class should handle all interactions with SharedPreferences
 *
 * @copyright 2012 City of Bloomington, Indiana
 * @license http://www.gnu.org/licenses/gpl.txt GNU/GPL, see LICENSE.txt
 * @author Cliff Ingham <inghamn@bloomington.in.gov>
 */
package gov.in.bloomington.georeporter.models;

import gov.in.bloomington.georeporter.R;
import gov.in.bloomington.georeporter.util.Util;
import gov.in.bloomington.georeporter.util.json.JSONArray;
import gov.in.bloomington.georeporter.util.json.JSONException;
import gov.in.bloomington.georeporter.util.json.JSONObject;

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

public class Preferences {
  private static final String SETTINGS       = "settings";
  private static final String PERSONAL_INFO  = "personal_info";
  private static final String CUSTOM_SERVERS = "custom_servers";
  
  private static final String APP_STATE      = "app_state";
  private static final String CURRENT_SERVER = "current_server";
  
  private static SharedPreferences mSettings = null;
  private static SharedPreferences mState    = null;
  
  private static void loadSettings(Context c) {
    if (mSettings == null) {
      mSettings = c.getSharedPreferences(SETTINGS, Context.MODE_PRIVATE);
    }
  }
  
  private static void loadState(Context c) {
    if (mState == null) {
      mState = c.getSharedPreferences(APP_STATE, Context.MODE_PRIVATE);
    }
  }
  
  /**
   * Returns the personal_info fields stored in settings
   * 
   * This should always return a valid JSONObject.
   * The JSONObject may be empty, but it needs to be 
   * ready for the user to start filling out the fields.
   * 
   * @param c
   * @return JSONObject
   */
  public static JSONObject getPersonalInfo(Context c) {
    Preferences.loadSettings(c);
    try {
      return new JSONObject(mSettings.getString(PERSONAL_INFO, "{}"));
    } catch (JSONException e) {
      return null;
    }
  }
  
    /**
     * Writes the personal info fields to disk
     * 
     * @param personal_info
     * @param c
     */
  public static void setPersonalInfo(JSONObject personal_info, Context c) {
        Preferences.loadSettings(c);
        
        SharedPreferences.Editor editor = mSettings.edit();
        editor.putString(PERSONAL_INFO, personal_info.toString());
        editor.commit();
    }
  
  /**
   * Returns any custom server definitions stored in settings
   * 
   * Users can add additional servers to the settings.
   * These additional server definitions will be stored as JSON
   * strings in settings.
   * 
   * @param c
   * @return JSONArray
   */
  public static JSONArray getCustomServers(Context c) {
      Preferences.loadSettings(c);
      try {
            return new JSONArray(mSettings.getString(CUSTOM_SERVERS, "[]"));
        }
        catch (JSONException e) {
            return null;
        }
  }
  
  /**
   * Writes custom servers back to disk
   * 
   * @param custom_servers
   * @param c
   */
  public static void setCustomServers(JSONArray custom_servers, Context c) {
      Preferences.loadSettings(c);
      
      SharedPreferences.Editor editor = mSettings.edit();
      editor.putString(CUSTOM_SERVERS, custom_servers.toString());
      editor.commit();
  }
    
  /**
   * Returns the current_server stored in app_state
   * 
   * This may return null, meaning there is no current_server chosen.
   * 
   * Server definitions will change over time, and we always want to use
   * the latest defintion of each server. Check for the server by name
   * and fully reload the JSON each time.
   * 
   * @param context
   * @return JSONObject
   */
  public static JSONObject getCurrentServer(Context context) {
    Preferences.loadState(context);
      String serverName = mState.getString(CURRENT_SERVER, "");
      if (serverName != null) {
            JSONObject s = null;
            
            try {
                JSONArray available_servers = new JSONArray(Util.file_get_contents(context, R.raw.available_servers));
                s = findServerByName(available_servers, serverName);
                if (s != null) return s;
            }
            catch (JSONException e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
            }
          
          s = findServerByName(getCustomServers(context), serverName);
          if (s != null) return s;
      }
    return null;
  }
  
  /**
   * Loops through a JSONArray and returns the match, based on the name
   * 
   * @param servers
   * @param name
   * @return JSONObject
   */
  private static JSONObject findServerByName(JSONArray servers, String name) {
      int len = servers.length();
        JSONObject s;
      for (int i=0; i<len; i++) {
            try {
                s = servers.getJSONObject(i);
                if (s.getString(Open311.NAME).equals(name)) {
                    return s;
                }
            }
            catch (JSONException e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
            }
      }
      return null;
  }
  
  /**
   * Saves the name of the current server back into Preferences.app_state
   * 
   * Passing null for the server will unset the current_server
   * 
   * We save only the name, because we want to reload the full JSON from
   * available_servers each time.  The endpoint definition may change over
   * time, and we always want to use the most up to date version.
   * 
   * @param server
   * @param c
   * void
   */
  public static void setCurrentServer(JSONObject server, Context c) {
    Preferences.loadState(c);
    
    SharedPreferences.Editor editor = mState.edit();
    if (server != null) {
      try {
                editor.putString(CURRENT_SERVER, server.getString(Open311.NAME));
            } catch (JSONException e) {
                editor.remove(CURRENT_SERVER);
                e.printStackTrace();
            }
    }
    else {
      editor.remove(CURRENT_SERVER);
    }
    editor.commit();
  }
}

Java Source Code List

• Back to Development/api  ↑