com.pixplicity.easyprefs.library

Class Prefs.Builder

java.lang.Object

com.pixplicity.easyprefs.library.Prefs.Builder

Enclosing class:

Prefs

public static final class Prefs.Builder
extends java.lang.Object

Builder class for the EasyPrefs instance. You only have to call this once in the Application onCreate. And in the rest of the code base you can call Prefs.method name.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
void	build() Initialize the SharedPreference instance to used in the application.
Prefs.Builder	setContext(android.content.Context context) Set the Context used to instantiate the SharedPreferences
Prefs.Builder	setMode(int mode) Set the mode of the SharedPreference instance.
Prefs.Builder	setPrefsName(java.lang.String prefsName) Set the filename of the SharedPreference instance.
Prefs.Builder	setUseDefaultSharedPreference(boolean defaultSharedPreference) Set the default SharedPreference file name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

setPrefsName

public Prefs.Builder setPrefsName(java.lang.String prefsName)

Set the filename of the SharedPreference instance. Usually this is the application's packagename.xml but it can be modified for migration purposes or customization.

Parameters:

prefsName - the filename used for the SharedPreference

Returns:

the Prefs.Builder object.

setContext

public Prefs.Builder setContext(android.content.Context context)

Set the Context used to instantiate the SharedPreferences

Parameters:

context - the application context

Returns:

the Prefs.Builder object.

setMode

public Prefs.Builder setMode(int mode)

Set the mode of the SharedPreference instance.

Parameters:

mode - Operating mode. Use 0 or Context.MODE_PRIVATE for the default operation, Context.MODE_WORLD_READABLE

Returns:

the Prefs.Builder object.

See Also:

Context.getSharedPreferences(java.lang.String, int)

setUseDefaultSharedPreference

public Prefs.Builder setUseDefaultSharedPreference(boolean defaultSharedPreference)

Set the default SharedPreference file name. Often the package name of the application is used, but if the PreferenceActivity or PreferenceFragment is used the system will append that with _preference.

Parameters:

defaultSharedPreference - true if default SharedPreference name should used.

Returns:

the Prefs.Builder object.

build

public void build()

Initialize the SharedPreference instance to used in the application.

Throws:

java.lang.RuntimeException - if Context has not been set.