com.pddstudio.preferences.encrypted

类 EncryptedPreferences

java.lang.Object

com.pddstudio.preferences.encrypted.EncryptedPreferences

public final class EncryptedPreferences
extends java.lang.Object

An AES-256 encrypted SharedPreferences class, to read and write encrypted preferences.

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	EncryptedPreferences.Builder Class for configuring a new EncryptedPreferences instance.
class	EncryptedPreferences.EncryptedEditor Class used for modifying values in a EncryptedPreferences object.
static interface	EncryptedPreferences.OnSharedPreferenceChangeListener Interface definition for a callback to be invoked when a shared preference is changed.
class	EncryptedPreferences.Utils A class for several utility methods.

方法概要

限定符和类型	方法和说明
boolean	contains(java.lang.String key) Checks whether the preferences contains a preference.
EncryptedPreferences.EncryptedEditor	edit() Get the Editor for these preferences, through which you can make modifications to the data in the preferences and atomically commit those changes back to the SharedPreferences object.
void	forceDeleteExistingPreferences() Deletes all existing preference entries stored in its underlying SharedPreferences instance.
java.util.Set<java.lang.String>	getAllKeys() Retrieve a Set of all currently stored keys.
java.util.Set<java.lang.String>	getAllKeys(boolean decrypt) Retrieve a Set of all currently stored keys.
boolean	getBoolean(java.lang.String key, boolean defaultValue) Retrieve a boolean value from the preferences
float	getFloat(java.lang.String key, float defaultValue) Retrieve a float value from the preferences
static EncryptedPreferences	getInstance(android.content.Context context) 已过时。 Due to security reasons it's recommended to use EncryptedPreferences.Builder for instance creation instead.
int	getInt(java.lang.String key, int defaultValue) Retrieve an int value from the preferences.
long	getLong(java.lang.String key, long defaultValue) Retrieve a long value from the preferences.
static EncryptedPreferences	getSingletonInstance() Retrieve the configured EncryptedPreferences instance.
java.lang.String	getString(java.lang.String key, java.lang.String defaultValue) Retrieve a String value from the preferences
EncryptedPreferences.Utils	getUtils() Get the EncryptedPreferences.Utils instance for this EncryptedPreferences configuration.
void	importSharedPreferences(android.content.SharedPreferences sharedPreferences, boolean override) Allows you to import your unencrypted SharedPreferences.
void	importSharedPreferences(android.content.SharedPreferences sharedPreferences, boolean override, boolean removeAfter) Allows you to import your unencrypted SharedPreferences.
void	registerOnSharedPreferenceChangeListener(EncryptedPreferences.OnSharedPreferenceChangeListener listener) Registers a callback to be invoked when a change happens to a preference.
void	unregisterOnSharedPreferenceChangeListener(EncryptedPreferences.OnSharedPreferenceChangeListener listener) Unregisters a previous callback.

从类继承的方法 java.lang.Object

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

方法详细资料

getInstance

@Deprecated
public static EncryptedPreferences getInstance(android.content.Context context)

已过时。 Due to security reasons it's recommended to use EncryptedPreferences.Builder for instance creation instead.

Retrieve an EncryptedPreferences instance with all default settings.

参数:

context -

返回:

default EncryptedPreferences

getSingletonInstance

public static EncryptedPreferences getSingletonInstance()

Retrieve the configured EncryptedPreferences instance. Make sure to call EncryptedPreferences.Builder.withSaveAsSingleton(boolean) to initialize the singleton, otherwise a RuntimeException will be thrown.

返回:

The configured EncryptedPreferences instance.

getInt

public int getInt(java.lang.String key,
                  int defaultValue)

Retrieve an int value from the preferences.

参数:

key - - The name of the preference to retrieve

defaultValue - - Value to return if this preference does not exist

返回:

int - Returns the preference value if it exists, or defValue. Throws ClassCastException if there is a preference with this name that is not an int.

getLong

public long getLong(java.lang.String key,
                    long defaultValue)

Retrieve a long value from the preferences.

参数:

key - - The name of the preference to retrieve

defaultValue - - Value to return if this preference does not exist

返回:

long - Returns the preference value if it exists, or defValue. Throws ClassCastException if there is a preference with this name that is not a long

getBoolean

public boolean getBoolean(java.lang.String key,
                          boolean defaultValue)

Retrieve a boolean value from the preferences

参数:

key - - The name of the preference to retrieve

defaultValue - - Value to return if this preference does not exist

返回:

- Returns the preference value if it exists, or defValue. Throws ClassCastException if there is a preference with this name that is not a boolean

getFloat

public float getFloat(java.lang.String key,
                      float defaultValue)

Retrieve a float value from the preferences

参数:

key - - The name of the preference to retrieve

defaultValue - - Value to return if this preference does not exist

返回:

float - Returns the preference value if it exists, or defValue. Throws ClassCastException if there is a preference with this name that is not a float

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.String defaultValue)

Retrieve a String value from the preferences

参数:

key - - The name of the preference to retrieve

defaultValue - - Value to return if this preference does not exist

返回:

String - Returns the preference value if it exists, or defValue. Throws ClassCastException if there is a preference with this name that is not a String

getAllKeys

public java.util.Set<java.lang.String> getAllKeys(boolean decrypt)

Retrieve a Set of all currently stored keys.

参数:

decrypt - - Whether to decrypt stored keys before returning them or not.

返回:

Set - Set with all stored keys.

getAllKeys

public java.util.Set<java.lang.String> getAllKeys()

Retrieve a Set of all currently stored keys.

返回:

Set - Set with all stored keys.

contains

public boolean contains(java.lang.String key)

Checks whether the preferences contains a preference.

参数:

key - - The name of the preference to check

返回:

Returns true if the preference exists in the preferences, otherwise false.

edit

public EncryptedPreferences.EncryptedEditor edit()

Get the Editor for these preferences, through which you can make modifications to the data in the preferences and atomically commit those changes back to the SharedPreferences object.

返回:

EncryptedPreferences.EncryptedEditor

getUtils

public EncryptedPreferences.Utils getUtils()

Get the EncryptedPreferences.Utils instance for this EncryptedPreferences configuration.

返回:

The EncryptedPreferences.Utils instance for this EncryptedPreferences configuration.

importSharedPreferences

public void importSharedPreferences(android.content.SharedPreferences sharedPreferences,
                                    boolean override)

Allows you to import your unencrypted SharedPreferences. This will immediately encrypt all your values without modifying them.

参数:

sharedPreferences - - The unencrypted SharedPreferences instance

override - - Whether to override existing keys (and their values) or not

importSharedPreferences

public void importSharedPreferences(android.content.SharedPreferences sharedPreferences,
                                    boolean override,
                                    boolean removeAfter)

Allows you to import your unencrypted SharedPreferences. This will immediately encrypt all your values without modifying them.

参数:

sharedPreferences - - The unencrypted SharedPreferences instance

override - - Whether to override existing keys (and their values) or not

removeAfter - - Whether to remove the old unencrypted entries after encrypting or not

forceDeleteExistingPreferences

public void forceDeleteExistingPreferences()

Deletes all existing preference entries stored in its underlying SharedPreferences instance. This should be used with caution as because EncryptedPreferences won't respect non-encrypted values during deletion. The operation is completely key-based, therefore no encryption key is required. Removed values cannot be restored!

另请参阅:

SharedPreferences#getAll()}

registerOnSharedPreferenceChangeListener

public void registerOnSharedPreferenceChangeListener(EncryptedPreferences.OnSharedPreferenceChangeListener listener)

Registers a callback to be invoked when a change happens to a preference.

参数:

listener - The callback that will run.

另请参阅:

unregisterOnSharedPreferenceChangeListener(OnSharedPreferenceChangeListener)

unregisterOnSharedPreferenceChangeListener

public void unregisterOnSharedPreferenceChangeListener(EncryptedPreferences.OnSharedPreferenceChangeListener listener)

Unregisters a previous callback.

参数:

listener - The callback that should be unregistered.

另请参阅:

registerOnSharedPreferenceChangeListener(com.pddstudio.preferences.encrypted.EncryptedPreferences.OnSharedPreferenceChangeListener)