Android SharedPreferences Tutorial and Example

In this Android tutorial we are going to see how to use Android SharedPreferences class to store and retrieve application specific persistent data.

Android SharedPreferences Tutorial

Android SharedPreferences allows us to store private primitive application data in the form of key-value pair.
Android stores shared preference settings as XML file in shared_prefs folder under DATA /data/[application package] directory. The DATA folder can be obtained by calling Environment.getDataDirectory() (usually it is /data).
SharedPreferences is application specific, i.e.) the data is lost when you perform one of the options,
- once you uninstall the application
- once you clear application data (through Settings)

How to get SharedPreferences instance?

To use shared preferences, you can use one of the following methods,

Method 1:

Use SharedPreferences getSharedPreferences (String name, int mode) . This method gets shared preferences from a specified file.

public static final String PREFS_NAME = "AOP_PREFS";
SharedPreferences  settings = getSharedPreferences(PREFS_NAME, Context.MODE_PRIVATE);

1 2	public static final String PREFS_NAME = "AOP_PREFS" ; SharedPreferences settings = getSharedPreferences ( PREFS_NAME , Context . MODE_PRIVATE ) ;

Where,

PREFS_NAME is the name of the file.
Context.MODE_PRIVATE is the operating mode.

Other modes are,

Operating Mode	Constant value	Description
MODE_PRIVATE	0	File creation mode: the default mode, where the created file can only be accessed by the calling application.
MODE_WORLD_READABLE	1	This constant was deprecated in API level 17. Creating world-readable files is very dangerous, and likely to cause security holes in applications.
MODE_WORLD_WRITEABLE	2	This constant was deprecated in API level 17. Creating world-writable files is very dangerous, and likely to cause security holes in applications.
MODE_MULTI_PROCESS	4	This method will check for modification of preferences even if the sharedpreference instance has already been loaded
MODE_APPEND	32768	This will append the new preferences with the already exisiting preferences
MODE_ENABLE_WRITE_AHEAD_LOGGING	8	Database open flag. When it is set , it would enable write ahead logging by default

Method 2:

SharedPreferences  settings = PreferenceManager.getDefaultSharedPreferences(context)

1	SharedPreferences settings = PreferenceManager . getDefaultSharedPreferences ( context )

Gets a SharedPreferences instance that points to the default file that is used by the preference framework in the given context. Here the file is stored as

DATA /data/[application package name]/shared_prefs/[application package name]_preferences.xml

Store Data in SharedPreferences

To save a value in SharedPreferences, you can use SharedPreferences.Editor class.
Steps:

Get SharedPreferences instance using one of the methods explained above.
Get SharedPreferences.Editor instance by calling edit() method in SharedPreferences instance.
Store values by calling one of the putXXXX() methods.
Commit the editor object.

...
public static final String PREFS_NAME = "AOP_PREFS";
public static final String PREFS_KEY = "AOP_PREFS_String";
...
public void save(Context context, String text) {
	SharedPreferences settings;
	Editor editor;
	settings = context.getSharedPreferences(PREFS_NAME, Context.MODE_PRIVATE); //1
	editor = settings.edit(); //2

	editor.putString(PREFS_KEY, text); //3
	editor.commit(); //4
}

. . .

public static final String PREFS_NAME = "AOP_PREFS" ;

public static final String PREFS_KEY = "AOP_PREFS_String" ;

. . .

public void save ( Context context , String text ) {

SharedPreferences settings ;

Editor editor ;

settings = context . getSharedPreferences ( PREFS_NAME , Context . MODE_PRIVATE ) ; //1

editor = settings . edit ( ) ; //2

editor . putString ( PREFS_KEY , text ) ; //3

editor . commit ( ) ; //4

}

Only primitive data types can be stored in SharedPreferences. Other methods are,

Retrieve Data from SharedPreferences

To get a value from shared preferences, you can use the SharedPreferences class’ getXXXX methods without the Editor object.
Steps:

Get SharedPreferences instance using one of the methods explained above.
Call one of the getXXXX() methods using SharedPreferences instance.

...
public static final String PREFS_NAME = "AOP_PREFS";
public static final String PREFS_KEY = "AOP_PREFS_String";
...
public String getValue(Context context) {
	SharedPreferences settings;
	String text;
settings = context.getSharedPreferences(PREFS_NAME, Context.MODE_PRIVATE); //1
	text = settings.getString(PREFS_KEY, null); //2
	return text;
}

. . .

public static final String PREFS_NAME = "AOP_PREFS" ;

public static final String PREFS_KEY = "AOP_PREFS_String" ;

. . .

public String getValue ( Context context ) {

SharedPreferences settings ;

String text ;

settings = context . getSharedPreferences ( PREFS_NAME , Context . MODE_PRIVATE ) ; //1

text = settings . getString ( PREFS_KEY , null ) ; //2

return text ;

}

Clear SharedPreferences Data

To remove all values from preferences use editor.clear() method as shown below.

...
public static final String PREFS_NAME = "AOP_PREFS";
public static final String PREFS_KEY = "AOP_PREFS_String";
...

public void clearSharedPreference(Context context) {
	SharedPreferences settings;
	Editor editor;

	settings = context.getSharedPreferences(PREFS_NAME, Context.MODE_PRIVATE);
	editor = settings.edit();

	editor.clear();
	editor.commit();
}

. . .

public static final String PREFS_NAME = "AOP_PREFS" ;

public static final String PREFS_KEY = "AOP_PREFS_String" ;

. . .

public void clearSharedPreference ( Context context ) {

SharedPreferences settings ;

Editor editor ;

settings = context . getSharedPreferences ( PREFS_NAME , Context . MODE_PRIVATE ) ;

editor = settings . edit ( ) ;

editor . clear ( ) ;

editor . commit ( ) ;

}

To remove a specific key-value pair use editor.remove(KEY) method as shown below.

...
public static final String PREFS_NAME = "AOP_PREFS";
public static final String PREFS_KEY = "AOP_PREFS_String";
...

public void removeValue(Context context) {
	SharedPreferences settings;
	Editor editor;
	settings = context.getSharedPreferences(PREFS_NAME, Context.MODE_PRIVATE);
	editor = settings.edit();

	editor.remove(PREFS_KEY);
	editor.commit();
}

. . .

public static final String PREFS_NAME = "AOP_PREFS" ;

public static final String PREFS_KEY = "AOP_PREFS_String" ;

. . .

public void removeValue ( Context context ) {

SharedPreferences settings ;

Editor editor ;

settings = context . getSharedPreferences ( PREFS_NAME , Context . MODE_PRIVATE ) ;

editor = settings . edit ( ) ;

editor . remove ( PREFS_KEY ) ;

editor . commit ( ) ;

}

Android SharedPreferences Example

Project Description

In this Android Example, we will see how to use SharedPreferences to share data from one activity to another.

We create a separate SharedPreference utility class with methods to save, get, clear, remove from SharedPreferences.
We create two activities,
- MainActivity – to save the value entered in EditText.
- SecondActivity – to get the value from SharedPreferences and display it in TextView.

Download “Android SharedPreferences Demo” SharedPreferenceDemo.zip – Downloaded 6347 times – 2 MB

Android Project

Create a new Android project and name it as SharedPreferenceDemo .

Resources

strings.xml

Open res/values/strings.xml and edit to have the content as shown below.

<?xml version="1.0" encoding="utf-8"?>
<resources>

    <string name="app_name">SharedPreferenceDemo</string>
    <string name="action_settings">Settings</string>
    <string name="hint">Enter some text here</string>
    <string name="save">Save</string>
    <string name="go_to_second_activity">Go to Second Activity</string>
    <string name="second_activity">Second Activity</string>
    <string name="saved">Saved in SharedPreferences. Go to second activity.</string>
    <string name="info">After saving, on subsequent launch go to second activity without saving. You will still see the saved data.</string>

</resources>

<? xml version = "1.0" encoding = "utf-8" ?>

< resources >

< string name = "app_name" > SharedPreferenceDemo < / string >

< string name = "action_settings" > Settings < / string >

< string name = "hint" > Enter some text here < / string >

< string name = "save" > Save < / string >

< string name = "go_to_second_activity" > Go to Second Activity < / string >

< string name = "second_activity" > Second Activity < / string >

< string name = "saved" > Saved in SharedPreferences . Go to second activity . < / string >

< string name = "info" > After saving , on subsequent launch go to second activity without saving . You will still see the saved data . < / string >

< / resources >

Layout files

activity_main.xml

This XML layout file (activity_main.xml) defines an EditText and a Button which is ued by MainActivity.java. Open activity_main.xml file in res/layout and copy the following content.

<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:padding="5dp"
    tools:context=".MainActivity" >

    <EditText
        android:id="@+id/etxt_text"
        android:layout_width="fill_parent"
        android:layout_height="wrap_content"
        android:layout_centerHorizontal="true"
        android:hint="@string/hint"
        android:inputType="text" />

    <Button
        android:id="@+id/button_save"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_below="@+id/etxt_text"
        android:layout_marginTop="10dp"
        android:text="@string/save" />

    <Button
        android:id="@+id/button_second_activity"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_below="@+id/etxt_text"
        android:layout_marginTop="10dp"
        android:layout_toRightOf="@+id/button_save"
        android:text="@string/go_to_second_activity" />

    <TextView
        android:id="@+id/txt_info"
        android:layout_width="fill_parent"
        android:layout_height="wrap_content"
        android:layout_below="@+id/button_second_activity"
        android:layout_marginTop="10dp"
        android:hint="@string/info" />

</RelativeLayout>

< RelativeLayout xmlns : android = "http://schemas.android.com/apk/res/android"

xmlns : tools = "http://schemas.android.com/tools"

android : layout_width = "match_parent"

android : layout_height = "match_parent"

android : padding = "5dp"

tools : context = ".MainActivity" >

< EditText

android : id = "@+id/etxt_text"

android : layout_width = "fill_parent"

android : layout_height = "wrap_content"

android : layout_centerHorizontal = "true"

android : hint = "@string/hint"

android : inputType = "text" / >

< Button

android : id = "@+id/button_save"

android : layout_width = "wrap_content"

android : layout_height = "wrap_content"

android : layout_below = "@+id/etxt_text"

android : layout_marginTop = "10dp"

android : text = "@string/save" / >

< Button

android : id = "@+id/button_second_activity"

android : layout_width = "wrap_content"

android : layout_height = "wrap_content"

android : layout_below = "@+id/etxt_text"

android : layout_marginTop = "10dp"

android : layout_toRightOf = "@+id/button_save"

android : text = "@string/go_to_second_activity" / >

< TextView

android : id = "@+id/txt_info"

android : layout_width = "fill_parent"

android : layout_height = "wrap_content"

android : layout_below = "@+id/button_second_activity"

android : layout_marginTop = "10dp"

android : hint = "@string/info" / >

< / RelativeLayout >

activity_second.xml

This XML layout file (activity_second.xml) defines a TextView which is used by SecondActivity.java. Create a new activity_second.xml file in res/layout and copy the following content.

<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:padding="5dp"
    tools:context=".SecondActivity" >

    <TextView
        android:id="@+id/txt_text"
        android:layout_width="fill_parent"
        android:layout_height="wrap_content"
        android:layout_centerHorizontal="true" />

</RelativeLayout>

< RelativeLayout xmlns : android = "http://schemas.android.com/apk/res/android"

xmlns : tools = "http://schemas.android.com/tools"

android : layout_width = "match_parent"

android : layout_height = "match_parent"

android : padding = "5dp"

tools : context = ".SecondActivity" >

< TextView

android : id = "@+id/txt_text"

android : layout_width = "fill_parent"

android : layout_height = "wrap_content"

android : layout_centerHorizontal = "true" / >

< / RelativeLayout >

Source files

SharedPreference class

Create a new class SharedPreference in the package com.androidopentutorials.sharedpreference.utils . This class defines methods to save, get and remove shared preferences values.

package com.androidopentutorials.sharedpreference.utils;

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

public class SharedPreference {

	public static final String PREFS_NAME = "AOP_PREFS";
	public static final String PREFS_KEY = "AOP_PREFS_String";
	
	public SharedPreference() {
		super();
	}

	public void save(Context context, String text) {
		SharedPreferences settings;
		Editor editor;
		
		//settings = PreferenceManager.getDefaultSharedPreferences(context);
		settings = context.getSharedPreferences(PREFS_NAME, Context.MODE_PRIVATE); //1
		editor = settings.edit(); //2

		editor.putString(PREFS_KEY, text); //3

		editor.commit(); //4
	}

	public String getValue(Context context) {
		SharedPreferences settings;
		String text;

		//settings = PreferenceManager.getDefaultSharedPreferences(context);
		settings = context.getSharedPreferences(PREFS_NAME, Context.MODE_PRIVATE);
		text = settings.getString(PREFS_KEY, null);
		return text;
	}
	
	public void clearSharedPreference(Context context) {
		SharedPreferences settings;
		Editor editor;

		//settings = PreferenceManager.getDefaultSharedPreferences(context);
		settings = context.getSharedPreferences(PREFS_NAME, Context.MODE_PRIVATE);
		editor = settings.edit();

		editor.clear();
		editor.commit();
	}

	public void removeValue(Context context) {
		SharedPreferences settings;
		Editor editor;

		settings = context.getSharedPreferences(PREFS_NAME, Context.MODE_PRIVATE);
		editor = settings.edit();

		editor.remove(PREFS_KEY);
		editor.commit();
	}	
}

package com . androidopentutorials . sharedpreference . utils ;

import android . content . Context ;

import android . content . SharedPreferences ;

import android . content . SharedPreferences . Editor ;

import android . preference . PreferenceManager ;

public class SharedPreference {

public static final String PREFS_NAME = "AOP_PREFS" ;

public static final String PREFS_KEY = "AOP_PREFS_String" ;

public SharedPreference ( ) {

super ( ) ;

}

public void save ( Context context , String text ) {

SharedPreferences settings ;

Editor editor ;

//settings = PreferenceManager.getDefaultSharedPreferences(context);

settings = context . getSharedPreferences ( PREFS_NAME , Context . MODE_PRIVATE ) ; //1

editor = settings . edit ( ) ; //2

editor . putString ( PREFS_KEY , text ) ; //3

editor . commit ( ) ; //4

}

public String getValue ( Context context ) {

SharedPreferences settings ;

String text ;

//settings = PreferenceManager.getDefaultSharedPreferences(context);

settings = context . getSharedPreferences ( PREFS_NAME , Context . MODE_PRIVATE ) ;

text = settings . getString ( PREFS_KEY , null ) ;

return text ;

}

public void clearSharedPreference ( Context context ) {

SharedPreferences settings ;

Editor editor ;

//settings = PreferenceManager.getDefaultSharedPreferences(context);

settings = context . getSharedPreferences ( PREFS_NAME , Context . MODE_PRIVATE ) ;

editor = settings . edit ( ) ;

editor . clear ( ) ;

editor . commit ( ) ;

}

public void removeValue ( Context context ) {

SharedPreferences settings ;

Editor editor ;

settings = context . getSharedPreferences ( PREFS_NAME , Context . MODE_PRIVATE ) ;

editor = settings . edit ( ) ;

editor . remove ( PREFS_KEY ) ;

editor . commit ( ) ;

}

MainActivity class

Open MainActivity.java class and copy the following code. This class gets value from EditText, stores it in SharedPreferences and starts the second activity.

package com.androidopentutorials.sharedpreference;

import android.app.Activity;
import android.content.Context;
import android.content.Intent;
import android.os.Bundle;
import android.view.Menu;
import android.view.View;
import android.view.View.OnClickListener;
import android.view.inputmethod.InputMethodManager;
import android.widget.Button;
import android.widget.EditText;
import android.widget.Toast;

import com.androidopentutorials.sharedpreference.utils.SharedPreference;

public class MainActivity extends Activity {

	// UI References
	private EditText textEtxt;
	private Button saveButton;
	private Button activity2Button;

	private String text;

	private SharedPreference sharedPreference;

	Activity context = this;

	@Override
	protected void onCreate(Bundle savedInstanceState) {
		super.onCreate(savedInstanceState);
		setContentView(R.layout.activity_main);

		sharedPreference = new SharedPreference();

		findViewsById();

		saveButton.setOnClickListener(new OnClickListener() {

			@Override
			public void onClick(View v) {
				text = textEtxt.getText().toString();

				// Hides the soft keyboard
				InputMethodManager imm = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
				imm.hideSoftInputFromWindow(textEtxt.getWindowToken(), 0);

				// Save the text in SharedPreference
				sharedPreference.save(context, text);
				Toast.makeText(context,
						getResources().getString(R.string.saved),
						Toast.LENGTH_LONG).show();
			}
		});

		activity2Button.setOnClickListener(new OnClickListener() {

			@Override
			public void onClick(View v) {
				Intent intent = new Intent(context, SecondActivity.class);
				// Start next activity
				startActivity(intent);
			}
		});
	}

	private void findViewsById() {
		textEtxt = (EditText) findViewById(R.id.etxt_text);
		saveButton = (Button) findViewById(R.id.button_save);
		activity2Button = (Button) findViewById(R.id.button_second_activity);
	}

	@Override
	public boolean onCreateOptionsMenu(Menu menu) {
		getMenuInflater().inflate(R.menu.main, menu);
		return true;
	}
}

package com . androidopentutorials . sharedpreference ;

import android . app . Activity ;

import android . content . Context ;

import android . content . Intent ;

import android . os . Bundle ;

import android . view . Menu ;

import android . view . View ;

import android . view . View . OnClickListener ;

import android . view . inputmethod . InputMethodManager ;

import android . widget . Button ;

import android . widget . EditText ;

import android . widget . Toast ;

import com . androidopentutorials . sharedpreference . utils . SharedPreference ;

public class MainActivity extends Activity {

// UI References

private EditText textEtxt ;

private Button saveButton ;

private Button activity2Button ;

private String text ;

private SharedPreference sharedPreference ;

Activity context = this ;

@ Override

protected void onCreate ( Bundle savedInstanceState ) {

super . onCreate ( savedInstanceState ) ;

setContentView ( R . layout . activity_main ) ;

sharedPreference = new SharedPreference ( ) ;

findViewsById ( ) ;

saveButton . setOnClickListener ( new OnClickListener ( ) {

@ Override

public void onClick ( View v ) {

text = textEtxt . getText ( ) . toString ( ) ;

// Hides the soft keyboard

InputMethodManager imm = ( InputMethodManager ) getSystemService ( Context . INPUT_METHOD_SERVICE ) ;

imm . hideSoftInputFromWindow ( textEtxt . getWindowToken ( ) , 0 ) ;

// Save the text in SharedPreference

sharedPreference . save ( context , text ) ;

Toast . makeText ( context ,

getResources ( ) . getString ( R . string . saved ) ,

Toast . LENGTH_LONG ) . show ( ) ;

}

} ) ;

activity2Button . setOnClickListener ( new OnClickListener ( ) {

@ Override

public void onClick ( View v ) {

Intent intent = new Intent ( context , SecondActivity . class ) ;

// Start next activity

startActivity ( intent ) ;

}

} ) ;

}

private void findViewsById ( ) {

textEtxt = ( EditText ) findViewById ( R . id . etxt_text ) ;

saveButton = ( Button ) findViewById ( R . id . button_save ) ;

activity2Button = ( Button ) findViewById ( R . id . button_second_activity ) ;

}

@ Override

public boolean onCreateOptionsMenu ( Menu menu ) {

getMenuInflater ( ) . inflate ( R . menu . main , menu ) ;

return true ;

}

SecondActivity class

Create a new SecondActivity.java class and copy the following code. This class gets the value from SharedPreferences and displays it in TextView.

package com.androidopentutorials.sharedpreference;

import android.app.Activity;
import android.os.Bundle;
import android.widget.TextView;
import com.actionbarsherlock.app.SherlockActivity;
import com.actionbarsherlock.view.Menu;
import com.androidopentutorials.sharedpreference.utils.SharedPreference;

public class SecondActivity extends SherlockActivity {

	// UI References
	private TextView textTxt;
	
	private String text;
	
	private SharedPreference sharedPreference;

	Activity context = this;
	
	@Override
	protected void onCreate(Bundle savedInstanceState) {
		super.onCreate(savedInstanceState);
		setContentView(R.layout.activity_second);
				
		sharedPreference = new SharedPreference();

		findViewsById();
		
		//Retrieve a value from SharedPreference
		text = sharedPreference.getValue(context);
		textTxt.setText(text);
		
	}

	private void findViewsById() {
		textTxt = (TextView) findViewById(R.id.txt_text);
	}

	@Override
	public boolean onCreateOptionsMenu(Menu menu) {
		getSupportMenuInflater().inflate(R.menu.main, menu);
		return true;
	}
}

package com . androidopentutorials . sharedpreference ;

import android . app . Activity ;

import android . os . Bundle ;

import android . widget . TextView ;

import com . actionbarsherlock . app . SherlockActivity ;

import com . actionbarsherlock . view . Menu ;

import com . androidopentutorials . sharedpreference . utils . SharedPreference ;

public class SecondActivity extends SherlockActivity {

// UI References

private TextView textTxt ;

private String text ;

private SharedPreference sharedPreference ;

Activity context = this ;

@ Override

protected void onCreate ( Bundle savedInstanceState ) {

super . onCreate ( savedInstanceState ) ;

setContentView ( R . layout . activity_second ) ;

sharedPreference = new SharedPreference ( ) ;

findViewsById ( ) ;

//Retrieve a value from SharedPreference

text = sharedPreference . getValue ( context ) ;

textTxt . setText ( text ) ;

}

private void findViewsById ( ) {

textTxt = ( TextView ) findViewById ( R . id . txt_text ) ;

}

@ Override

public boolean onCreateOptionsMenu ( Menu menu ) {

getSupportMenuInflater ( ) . inflate ( R . menu . main , menu ) ;

return true ;

}

Output

MainActivity

When we go directly to second activity, no value is displayed as we have not yet stored the value in shared preference. Once the submit button is pressed, the value is saved in shared preference. Now this value will be shown on subsequent app launches by directly going to the second activity.

SecondActivity

Storing Java objects in SharedPreferences

Android SharedPreferences allows you to store only primitive values or set of strings (java.util.Set ). To store custom Java objects (object, arrays or lists) in SharedPreferences you can use one of the following methods,

Generate toString() method in your class and save the object as String by calling toString()
- This method is not useful when you want to retrieve the value and construct the object from String.
Using external library such as GSon or Jackson to convert Java object to/from JSON (JavaScript Object Notation) . After converting to JSON object, you can store it as string in SharedPreferences. Gson has methods,
- toJson() – Convert Java object to JSON format
- fromJson() – Convert JSON into Java object

To use Gson

Download Gson JAR from http://code.google.com/p/google-gson/
Add this JAR to libs folder of your android project and configure build path.

Store custom Java object in SharedPreferences using Gson

...
public static final String PREFS_NAME = "PRODUCT_APP";
public static final String FAVORITES = "Product_Favorite";
...
public void saveFavorites(Context context, List<Product> favorites) {
	SharedPreferences settings;
	Editor editor;

	settings = context.getSharedPreferences(PREFS_NAME,
				Context.MODE_PRIVATE);
	editor = settings.edit();

	Gson gson = new Gson();
	String jsonFavorites = gson.toJson(favorites);

	editor.putString(FAVORITES, jsonFavorites);
	editor.commit();
}

. . .

public static final String PREFS_NAME = "PRODUCT_APP" ;

public static final String FAVORITES = "Product_Favorite" ;

. . .

public void saveFavorites ( Context context , List < Product > favorites ) {

SharedPreferences settings ;

Editor editor ;

settings = context . getSharedPreferences ( PREFS_NAME ,

Context . MODE_PRIVATE ) ;

editor = settings . edit ( ) ;

Gson gson = new Gson ( ) ;

String jsonFavorites = gson . toJson ( favorites ) ;

editor . putString ( FAVORITES , jsonFavorites ) ;

editor . commit ( ) ;

}

Retrieve custom Java object from SharedPreferences using Gson

...
public static final String PREFS_NAME = "PRODUCT_APP";
public static final String FAVORITES = "Product_Favorite";
...
public ArrayList<Product> getFavorites(Context context) {
	SharedPreferences settings;
	List<Product> favorites;

	settings = context.getSharedPreferences(PREFS_NAME,
			Context.MODE_PRIVATE);

	if (settings.contains(FAVORITES)) {
		String jsonFavorites = settings.getString(FAVORITES, null);
		Gson gson = new Gson();
		Product[] favoriteItems = gson.fromJson(jsonFavorites,
				Product[].class);

		favorites = Arrays.asList(favoriteItems);
		favorites = new ArrayList<Product>(favorites);
	} else
		return null;
	return (ArrayList<Product>) favorites;
}

. . .

public static final String PREFS_NAME = "PRODUCT_APP" ;

public static final String FAVORITES = "Product_Favorite" ;

. . .

public ArrayList < Product > getFavorites ( Context context ) {

SharedPreferences settings ;

List < Product > favorites ;

settings = context . getSharedPreferences ( PREFS_NAME ,

Context . MODE_PRIVATE ) ;

if ( settings . contains ( FAVORITES ) ) {

String jsonFavorites = settings . getString ( FAVORITES , null ) ;

Gson gson = new Gson ( ) ;

Product [ ] favoriteItems = gson . fromJson ( jsonFavorites ,

Product [ ] . class ) ;

favorites = Arrays . asList ( favoriteItems ) ;

favorites = new ArrayList < Product > ( favorites ) ;

} else

return null ;

return ( ArrayList < Product > ) favorites ;

}

By using the above method, you can add a custom Java object, array or list to Android SharedPreferences.

Storing JSON object in SharedPreferences

To store JSONObject or JSONArray in SharedPreferences, use the toString() method and store as String in SharedPreferences.

To store JSONObject in SharedPreferences

public void putJson(Context context, JSONObject jsonObject) {
	SharedPreferences settings;
	Editor editor;

	settings = context.getSharedPreferences(PREFS_NAME,
			Context.MODE_PRIVATE);
	editor = settings.edit();

	editor.putString("JSONString", jsonObject.toString());

	editor.commit();
}

public void putJson ( Context context , JSONObject jsonObject ) {

SharedPreferences settings ;

Editor editor ;

settings = context . getSharedPreferences ( PREFS_NAME ,

Context . MODE_PRIVATE ) ;

editor = settings . edit ( ) ;

editor . putString ( "JSONString" , jsonObject . toString ( ) ) ;

editor . commit ( ) ;

}

To get JSONObject from SharedPreferences

public ArrayList<Product> getJson(Context context, String category) {
	SharedPreferences settings;
	String json;
	JSONArray jPdtArray;
	Product product = null;
	ArrayList<Product> products = null;

	settings = context.getSharedPreferences(PREFS_NAME,
			Context.MODE_PRIVATE);
	json = settings.getString("JSONString", null);

	JSONObject jsonObj = null;
		try {
			if (json != null) {
				jsonObj = new JSONObject(json);
				jPdtArray = jsonObj.optJSONArray(category);
				if (jPdtArray != null) {
					products = new ArrayList<Product>();
					for (int i = 0; i < jPdtArray.length(); i++) {
						product = new Product();
						JSONObject pdtObj = jPdtArray
								.getJSONObject(i);
						product.setName(pdtObj.getString("name"));
						product.setId(pdtObj
								.getInt("id"));
						products.add(product);
					}
				}
			}
		} catch (JSONException e) {
		}
		return products;
	}

public ArrayList < Product > getJson ( Context context , String category ) {

SharedPreferences settings ;

String json ;

JSONArray jPdtArray ;

Product product = null ;

ArrayList < Product > products = null ;

settings = context . getSharedPreferences ( PREFS_NAME ,

Context . MODE_PRIVATE ) ;

json = settings . getString ( "JSONString" , null ) ;

JSONObject jsonObj = null ;

try {

if ( json != null ) {

jsonObj = new JSONObject ( json ) ;

jPdtArray = jsonObj . optJSONArray ( category ) ;

if ( jPdtArray != null ) {

products = new ArrayList < Product > ( ) ;

for ( int i = 0 ; i < jPdtArray . length ( ) ; i ++ ) {

product = new Product ( ) ;

JSONObject pdtObj = jPdtArray

. getJSONObject ( i ) ;

product . setName ( pdtObj . getString ( "name" ) ) ;

product . setId ( pdtObj

. getInt ( "id" ) ) ;

products . add ( product ) ;

}

} catch ( JSONException e ) {

}

return products ;

}

About The Author

nithya

Pingback: Custom Navigation Drawer doesn’t show Fragment | Vent News
AlinaB

can u help ? http://stackoverflow.com/questions/32363261/update-a-listview-using-sharedpreference
User X

It looks pretty good but I’m still stuck on my error, trying to get an instance from getSharedPreferences because I don’t want to use the default one :/
Android

very thnkful to you …

but in my database just once pass the name just for first time only next time no name get from preferences…!!!!!
Pingback: Multi-Language support and SpinnerPreference – Part II | C-dev Technologies Inc.
Pingback: Android SharedPreferences Tutorial and Example | Android Open Tutorials – AndroidDev
2tu

There Fit Library can do this

Save model as SharedPreferences(private static complex field not support)

https://github.com/2tu/fit
Ankit Palli

Tutorial is really cool….
Thank you for such a good work done by Android Open Tutorials.

http://www.ankitpalli.com/2017/04/what-is-sharedpreferences-and-how-to.html
Ankit Palli

Tutorial is really cool…. ..
Thank you for such a good work done by Android Open Tutorials.
Hope you keep your work…

http://www.ankitpalli.com/2017/04/what-is-sharedpreferences-and-how-to.html

M	T	W	T	F	S	S
« Mar
		1	2	3	4	5
6	7	8	9	10	11	12
13	14	15	16	17	18	19
20	21	22	23	24	25	26
27	28	29	30	31

Android SharedPreferences Tutorial

How to get SharedPreferences instance?

Method 1:

Method 2:

Store Data in SharedPreferences

Retrieve Data from SharedPreferences

Clear SharedPreferences Data

Android SharedPreferences Example

Project Description

Android Project

Resources

strings.xml

Layout files

activity_main.xml

activity_second.xml

Source files

SharedPreference class

MainActivity class

SecondActivity class

Output

MainActivity

SecondActivity

Storing Java objects in SharedPreferences

To use Gson

Store custom Java object in SharedPreferences using Gson

Retrieve custom Java object from SharedPreferences using Gson

Storing JSON object in SharedPreferences

To store JSONObject in SharedPreferences

To get JSONObject from SharedPreferences

About The Author

nithya

Related Posts