net.zer0bandwidth.android.lib.content

Class PreferencePortal

java.lang.Object

net.zer0bandwidth.android.lib.content.PreferencePortal

public class PreferencePortal
extends java.lang.Object

An instance of this class acts as a portal to the app's shared preferences. It provides some convenience wrappers for some of the more commonly-used methods of SharedPreferences; most notably:

• Getter methods that substitute sane defaults, so you don't have to keep supplying them yourself.
• Quick methods for writing preference values to a SharedPreferences.Editor; these methods can then be chained with apply() or commit() (though the latter may draw the ire of Lint without a @SuppressLint( "CommitPrefEdits" ) annotation.
• A set of methods for marshalling integer-value preferences as strings in the app's preferences. This is a workaround for occasional wonky behavior of native integer-value preferences in Android.
• (since 0.2.1) A set of methods for marshalling Boolean-value preferences as strings in the app's preferences.

An app may choose to extend this class to further provide easy methods for getting and setting specific preferences.

Note that this class is basically syntactic sugar; an app can easily do all these things itself, instead. This author accepts no responsibility for any taunting or other lack of respect for using this class to clean up what would otherwise be a pretty tedious coding task. However, in the case of stringified integer values, the class does provide static versions of those methods, for those who don't want to lean heavily on the whole class.

Since:

zer0bandwidth-net/android 0.0.4 (#14)

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_BOOLEAN The default value for Boolean preferences.
static int	DEFAULT_INT_NOT_SET A default value for integer fields, which indicates "not set".
static int	DEFAULT_INT_ZERO The usual default value for integer fields.
static java.lang.String	DEFAULT_STRING The default value for string fields.
static java.lang.String	LOG_TAG
protected android.content.Context	m_ctx The context in which preferences are managed.
protected android.content.SharedPreferences	m_prefs A persistent reference to the app's preferences.
protected int	m_zDefaultInteger

Constructor Summary

Constructors

Constructor and Description
PreferencePortal(android.content.Context ctx)

Method Summary

Modifier and Type	Method and Description
boolean	getBoolean(int resKey)
boolean	getBoolean(int resKey, boolean bDefault)
boolean	getBoolean(java.lang.String sKey)
boolean	getBoolean(java.lang.String sKey, boolean bDefault)
int	getInt(int resKey)
int	getInt(int resKey, int zDefault)
int	getInt(java.lang.String sKey)
int	getInt(java.lang.String sKey, int zDefault)
long	getLong(int resKey)
long	getLong(int resKey, long zDefault)
long	getLong(java.lang.String sKey)
long	getLong(java.lang.String sKey, long zDefault)
android.content.SharedPreferences	getPrefs() Accesses the SharedPreferences instance used by this class.
java.lang.String	getString(int resKey)
java.lang.String	getString(int resKey, java.lang.String sDefault)
java.lang.String	getString(java.lang.String sKey)
java.lang.String	getString(java.lang.String sKey, java.lang.String sDefault)
boolean	getStringifiedBoolean(int resKey) Fetches a Boolean preference that was stored as a string, using DEFAULT_BOOLEAN as the default if the preference is not set.
boolean	getStringifiedBoolean(int resKey, boolean bDefault) Fetches a Boolean preference that was stored as a string.
static boolean	getStringifiedBoolean(android.content.SharedPreferences prefs, java.lang.String sKey, boolean bDefault) Get the value of a Boolean preference that was stored as a string.
boolean	getStringifiedBoolean(java.lang.String sKey) Fetches a Boolean preference that was stored as a string, using DEFAULT_BOOLEAN as the default if the preference is not set.
boolean	getStringifiedBoolean(java.lang.String sKey, boolean bDefault) Fetches a Boolean preference that was stored as a string.
int	getStringifiedInt(int resKey)
int	getStringifiedInt(int resKey, int zDefault)
static int	getStringifiedInt(android.content.SharedPreferences prefs, java.lang.String sKey, int zDefault) Get the value of an integer preference that is stored as a string.
int	getStringifiedInt(java.lang.String sKey)
int	getStringifiedInt(java.lang.String sKey, int zDefault)
long	getStringifiedLong(int resKey)
long	getStringifiedLong(int resKey, long zDefault)
static long	getStringifiedLong(android.content.SharedPreferences prefs, java.lang.String sKey, long zDefault) Get the value of a long-integer preference that is stored as a string.
long	getStringifiedLong(java.lang.String sKey)
long	getStringifiedLong(java.lang.String sKey, long zDefault)
android.content.SharedPreferences.Editor	putBoolean(int resKey, boolean b)
android.content.SharedPreferences.Editor	putBoolean(java.lang.String sKey, boolean b)
android.content.SharedPreferences.Editor	putInt(int resKey, int z)
android.content.SharedPreferences.Editor	putInt(java.lang.String sKey, int z)
android.content.SharedPreferences.Editor	putLong(int resKey, long z)
android.content.SharedPreferences.Editor	putLong(java.lang.String sKey, long z)
android.content.SharedPreferences.Editor	putString(int resKey, java.lang.String s)
android.content.SharedPreferences.Editor	putString(java.lang.String sKey, java.lang.String s)
android.content.SharedPreferences.Editor	putStringifiedBoolean(int resKey, boolean b) Edit the value of a Boolean preference that is stored as a string.
static android.content.SharedPreferences.Editor	putStringifiedBoolean(android.content.SharedPreferences prefs, java.lang.String sKey, boolean b) Edit the value of a Boolean preference that is stored as a string.
android.content.SharedPreferences.Editor	putStringifiedBoolean(java.lang.String sKey, boolean b) Edit the value of a Boolean preference that is stored as a string.
android.content.SharedPreferences.Editor	putStringifiedInt(int resKey, int z)
static android.content.SharedPreferences.Editor	putStringifiedInt(android.content.SharedPreferences prefs, java.lang.String sKey, int z) Edit the value of an integer preference that is stored as a string.
android.content.SharedPreferences.Editor	putStringifiedInt(java.lang.String sKey, int z)
android.content.SharedPreferences.Editor	putStringifiedLong(int resKey, long z)
static android.content.SharedPreferences.Editor	putStringifiedLong(android.content.SharedPreferences prefs, java.lang.String sKey, long z) Edit the value of a long-integer preference that is stored as a string.
android.content.SharedPreferences.Editor	putStringifiedLong(java.lang.String sKey, long z)
PreferencePortal	useIntegerDefaultValue(int zDefault) Specifies the value that should be used as the integer default.

Methods inherited from class java.lang.Object

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

Field Detail

LOG_TAG

public static final java.lang.String LOG_TAG

DEFAULT_BOOLEAN

public static final boolean DEFAULT_BOOLEAN

The default value for Boolean preferences. (false)

See Also:

Constant Field Values

DEFAULT_INT_NOT_SET

public static final int DEFAULT_INT_NOT_SET

A default value for integer fields, which indicates "not set". (-1). Assign this default when your integer preference is intended to be unsigned, but knowing that the value has not been set at all is valuable.

See Also:

Constant Field Values

DEFAULT_INT_ZERO

public static final int DEFAULT_INT_ZERO

The usual default value for integer fields. (0) The class will choose this default value on its own, but it may be reconfigured with useIntegerDefaultValue(int).

See Also:

Constant Field Values

DEFAULT_STRING

public static final java.lang.String DEFAULT_STRING

The default value for string fields. (null

m_zDefaultInteger

protected int m_zDefaultInteger

m_ctx

protected android.content.Context m_ctx

The context in which preferences are managed.

m_prefs

protected android.content.SharedPreferences m_prefs

A persistent reference to the app's preferences.

Constructor Detail

PreferencePortal

public PreferencePortal(android.content.Context ctx)

Method Detail

getStringifiedBoolean

public static boolean getStringifiedBoolean(android.content.SharedPreferences prefs,
                                            java.lang.String sKey,
                                            boolean bDefault)

Get the value of a Boolean preference that was stored as a string.

Parameters:

prefs - the app's preferences

sKey - the preference key

bDefault - the default value, if not set

Returns:

the Boolean value of the preference

Since:

zer0bandwidth-net/android 0.2.1 (#55)

putStringifiedBoolean

public static android.content.SharedPreferences.Editor putStringifiedBoolean(android.content.SharedPreferences prefs,
                                                                             java.lang.String sKey,
                                                                             boolean b)

Edit the value of a Boolean preference that is stored as a string. This method should be chained with either the apply() or commit() method of the preference editor to complete the change.

Parameters:

prefs - the app's preferences

sKey - the preference key

b - the value to write

Returns:

a preference editor which would be chained with either apply() or commit()

Since:

zer0bandwidth-net/android 0.2.1 (#55)

getStringifiedInt

public static int getStringifiedInt(android.content.SharedPreferences prefs,
                                    java.lang.String sKey,
                                    int zDefault)
                             throws java.lang.NumberFormatException

Get the value of an integer preference that is stored as a string.

Parameters:

prefs - the app's preferences

sKey - the preference key

zDefault - the default value, if not set

Returns:

the integer value of the preference

Throws:

java.lang.NumberFormatException - if the preference's value can't be parsed

putStringifiedInt

public static android.content.SharedPreferences.Editor putStringifiedInt(android.content.SharedPreferences prefs,
                                                                         java.lang.String sKey,
                                                                         int z)

Edit the value of an integer preference that is stored as a string. This method should be chained with either the apply() or commit() method of the preference editor to complete the change.

Parameters:

prefs - the app's preferences

sKey - the preference key

z - the value to write

Returns:

a preference editor which would be chained with either apply() or commit()

getStringifiedLong

public static long getStringifiedLong(android.content.SharedPreferences prefs,
                                      java.lang.String sKey,
                                      long zDefault)
                               throws java.lang.NumberFormatException

Get the value of a long-integer preference that is stored as a string.

Parameters:

prefs - the app's preferences

sKey - the preference key

zDefault - the default value, if not set

Returns:

the long-integer value of the preference

Throws:

java.lang.NumberFormatException - if the preference's value can't be parsed

putStringifiedLong

public static android.content.SharedPreferences.Editor putStringifiedLong(android.content.SharedPreferences prefs,
                                                                          java.lang.String sKey,
                                                                          long z)

Edit the value of a long-integer preference that is stored as a string. This method should be chained with either the apply or commit() method of the preference editor to complete the change.

Parameters:

prefs - the app's preferences

sKey - the preference key

z - the value to write

Returns:

a preference editor which would be chained with either apply() or commit()

getPrefs

public android.content.SharedPreferences getPrefs()

Accesses the SharedPreferences instance used by this class.

Returns:

the app's preferences

useIntegerDefaultValue

public PreferencePortal useIntegerDefaultValue(int zDefault)

Specifies the value that should be used as the integer default.

Parameters:

zDefault - a value to be used as the default for all integers

Returns:

(fluid)

See Also:

DEFAULT_INT_ZERO, DEFAULT_INT_NOT_SET

getBoolean

public boolean getBoolean(java.lang.String sKey,
                          boolean bDefault)

getBoolean

public boolean getBoolean(java.lang.String sKey)

getBoolean

public boolean getBoolean(int resKey,
                          boolean bDefault)

getBoolean

public boolean getBoolean(int resKey)

getStringifiedBoolean

public boolean getStringifiedBoolean(java.lang.String sKey,
                                     boolean bDefault)

Fetches a Boolean preference that was stored as a string.

Parameters:

sKey - the preference key

bDefault - a default if not set

Returns:

the preference value

Since:

zer0bandwidth-net/android 0.2.1

getStringifiedBoolean

public boolean getStringifiedBoolean(java.lang.String sKey)

Fetches a Boolean preference that was stored as a string, using DEFAULT_BOOLEAN as the default if the preference is not set.

Parameters:

sKey - the preference key

Returns:

the preference value

Since:

zer0bandwidth-net/android 0.2.1

getStringifiedBoolean

public boolean getStringifiedBoolean(int resKey,
                                     boolean bDefault)

Fetches a Boolean preference that was stored as a string.

Parameters:

resKey - the ID of a string resource whose value is the preference key

bDefault - a default if not set

Returns:

the preference value

Since:

zer0bandwidth-net/android 0.2.1

getStringifiedBoolean

public boolean getStringifiedBoolean(int resKey)

Fetches a Boolean preference that was stored as a string, using DEFAULT_BOOLEAN as the default if the preference is not set.

Parameters:

resKey - the ID of a string resource whose value is the preference key

Returns:

the preference value

Since:

zer0bandwidth-net/android 0.2.1

getInt

public int getInt(java.lang.String sKey,
                  int zDefault)

getInt

public int getInt(java.lang.String sKey)

getInt

public int getInt(int resKey,
                  int zDefault)

getInt

public int getInt(int resKey)

getStringifiedInt

public int getStringifiedInt(java.lang.String sKey,
                             int zDefault)
                      throws java.lang.NumberFormatException

Throws:

java.lang.NumberFormatException

getStringifiedInt

public int getStringifiedInt(java.lang.String sKey)

getStringifiedInt

public int getStringifiedInt(int resKey,
                             int zDefault)

getStringifiedInt

public int getStringifiedInt(int resKey)

getLong

public long getLong(java.lang.String sKey,
                    long zDefault)

getLong

public long getLong(java.lang.String sKey)

getLong

public long getLong(int resKey,
                    long zDefault)

getLong

public long getLong(int resKey)

getStringifiedLong

public long getStringifiedLong(java.lang.String sKey,
                               long zDefault)
                        throws java.lang.NumberFormatException

Throws:

java.lang.NumberFormatException

getStringifiedLong

public long getStringifiedLong(java.lang.String sKey)
                        throws java.lang.NumberFormatException

Throws:

java.lang.NumberFormatException

getStringifiedLong

public long getStringifiedLong(int resKey,
                               long zDefault)
                        throws java.lang.NumberFormatException

Throws:

java.lang.NumberFormatException

getStringifiedLong

public long getStringifiedLong(int resKey)
                        throws java.lang.NumberFormatException

Throws:

java.lang.NumberFormatException

getString

public java.lang.String getString(java.lang.String sKey,
                                  java.lang.String sDefault)

getString

public java.lang.String getString(java.lang.String sKey)

getString

public java.lang.String getString(int resKey,
                                  java.lang.String sDefault)

getString

public java.lang.String getString(int resKey)

putBoolean

public android.content.SharedPreferences.Editor putBoolean(java.lang.String sKey,
                                                           boolean b)

putBoolean

public android.content.SharedPreferences.Editor putBoolean(int resKey,
                                                           boolean b)

putStringifiedBoolean

public android.content.SharedPreferences.Editor putStringifiedBoolean(java.lang.String sKey,
                                                                      boolean b)

Edit the value of a Boolean preference that is stored as a string. This method should be chained with either the apply() or commit() method of the preference editor to complete the change.

Parameters:

sKey - the preference key

b - the value to write

Returns:

a preference editor which would be chained with either apply() or commit()

Since:

zer0bandwidth-net/android 0.2.1 (#55)

putStringifiedBoolean

public android.content.SharedPreferences.Editor putStringifiedBoolean(int resKey,
                                                                      boolean b)

Edit the value of a Boolean preference that is stored as a string. This method should be chained with either the apply() or commit() method of the preference editor to complete the change.

Parameters:

resKey - the ID of a string resource whose value is the preference key

b - the value to write

Returns:

a preference editor which would be chained with either apply() or commit()

Since:

zer0bandwidth-net/android 0.2.1 (#55)

putInt

public android.content.SharedPreferences.Editor putInt(java.lang.String sKey,
                                                       int z)

putInt

public android.content.SharedPreferences.Editor putInt(int resKey,
                                                       int z)

putStringifiedInt

public android.content.SharedPreferences.Editor putStringifiedInt(java.lang.String sKey,
                                                                  int z)

putStringifiedInt

public android.content.SharedPreferences.Editor putStringifiedInt(int resKey,
                                                                  int z)

putLong

public android.content.SharedPreferences.Editor putLong(java.lang.String sKey,
                                                        long z)

putLong

public android.content.SharedPreferences.Editor putLong(int resKey,
                                                        long z)

putStringifiedLong

public android.content.SharedPreferences.Editor putStringifiedLong(java.lang.String sKey,
                                                                   long z)

putStringifiedLong

public android.content.SharedPreferences.Editor putStringifiedLong(int resKey,
                                                                   long z)

putString

public android.content.SharedPreferences.Editor putString(java.lang.String sKey,
                                                          java.lang.String s)

putString

public android.content.SharedPreferences.Editor putString(int resKey,
                                                          java.lang.String s)