Preferences (Neo Visionaries Android Base Package 1.12 API)

java.lang.Object
- com.neovisionaries.android.util.TypedProperties
- - com.neovisionaries.android.util.Preferences

```
public class Preferences
extends TypedProperties
```
Wrapper over SharedPreferences.
As getXxx() and setXxx() methods accept Enum<?> as key as well as String, a code snippet like below
```
 private static final String KEY_AAA = "AAA";
 private static final String KEY_BBB = "BBB";

 SharedPreferences preferences = ...

 String aaa = preferences.getString(KEY_AAA, null);
 String bbb = preferences.getString(KEY_BBB, null);
 
```
can be written like below.
```
 enum Key
 {
     AAA,
     BBB
     ;
 }

 Preferences preferences = ...

 String aaa = preferences.getString(Key.AAA);
 String bbb = preferences.getString(Key.BBB);
 
```
setXxx(key, value) methods are equivalent to edit().putXxx(key, value).commit().

App.getInstance().getPreferences() returns a Preferences instance that is supposed to be used as application-wide preferences.
Author:

Takahiko Kawasaki

Constructor Summary

Constructors
Constructor and Description
`Preferences(android.content.Context context, String name)` Equivalent to `this(context, name, Context.MODE_PRIVATE)`.
`Preferences(android.content.Context context, String name, int mode)` Constructor with parameters to get SharedPreferences.
`Preferences(android.content.SharedPreferences prefs)` Constructor with a wrapped `SharedPreferences`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Equivalent to `edit().clear().commit()` on the internal SharedPreferences instance.
`boolean`	`contains(String key)` Equivalent to `contains(key)` on the internal SharedPreferences instance.
`boolean`	`getBoolean(String key, boolean defaultValue)` Equivalent to `getBoolean(key, defaultValue)` on the internal SharedPreferences instance.
`double`	`getDouble(String key, double defaultValue)` Get the value of the property identified by the key as double.
`float`	`getFloat(String key, float defaultValue)` Equivalent to `getFloat(key, defaultValue)` on the internal SharedPreferences instance.
`int`	`getInt(String key, int defaultValue)` Equivalent to `getInt(key, defaultValue)` on the internal SharedPreferences instance.
`long`	`getLong(String key, long defaultValue)` Equivalent to `getLong(key, defaultValue)` on the internal SharedPreferences instance.
`String`	`getString(String key, String defaultValue)` Equivalent to `getString(key, defaultValue)` on the internal SharedPreferences instance.
`void`	`remove(String key)` Equivalent to `edit().remove(key).commit()` on the internal SharedPreferences instance.
`void`	`setBoolean(String key, boolean value)` Equivalent to `edit().putBoolean(key, value).commit()` on the internal SharedPreferences instance.
`void`	`setDouble(String key, double value)` Set the value to the property identified by the key.
`void`	`setFloat(String key, float value)` Equivalent to `edit().putFloat(key, value).commit()` on the internal SharedPreferences instance.
`void`	`setInt(String key, int value)` Equivalent to `edit().putInt(key, value).commit()` on the internal SharedPreferences instance.
`void`	`setLong(String key, long value)` Equivalent to `edit().putLong(key, value).commit()` on the internal SharedPreferences instance.
`void`	`setString(String key, String value)` Equivalent to `edit().putString(key, value).commit()` on the internal SharedPreferences instance.

Methods inherited from class com.neovisionaries.android.util.TypedProperties
contains, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getBoolean, getBoolean, getBoolean, getDouble, getDouble, getDouble, getEnum, getEnum, getEnum, getEnum, getEnum, getEnum, getFloat, getFloat, getFloat, getInt, getInt, getInt, getLong, getLong, getLong, getString, getString, getString, remove, set, set, set, set, set, set, set, set, set, set, set, set, set, set, setBoolean, setDouble, setEnum, setEnum, setFloat, setInt, setLong, setString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Preferences
```
public Preferences(android.content.Context context,
                   String name)
```
    Equivalent to this(context, name, Context.MODE_PRIVATE).
  - Preferences
```
public Preferences(android.content.Context context,
                   String name,
                   int mode)
```
    Constructor with parameters to get SharedPreferences.
    
    Parameters:
    
    context -
    
    name - Preference name. This argument is given as the first argument to Context.getSharedPreferences(String, int).
    
    mode - Operating mode. This argument is given as the second argument to Context.getSharedPreferences(String, int).
  - Preferences
```
public Preferences(android.content.SharedPreferences prefs)
```
    Constructor with a wrapped SharedPreferences.
    
    Parameters:
    
    prefs - An SharedPreferences to be wrapped.
    
    Since:
    
    1.11
- Method Detail
  - contains
```
public boolean contains(String key)
```
    Equivalent to contains(key) on the internal SharedPreferences instance.
    
    Specified by:
    
    contains in class TypedProperties
    
    Since:
    
    1.6
  - getBoolean
```
public boolean getBoolean(String key,
                          boolean defaultValue)
```
    Equivalent to getBoolean(key, defaultValue) on the internal SharedPreferences instance. If the given key is null, defaultValue is returned.
    
    Specified by:
    
    getBoolean in class TypedProperties
  - getFloat
```
public float getFloat(String key,
                      float defaultValue)
```
    Equivalent to getFloat(key, defaultValue) on the internal SharedPreferences instance. If the given key is null, defaultValue is returned.
    
    Specified by:
    
    getFloat in class TypedProperties
  - getDouble
```
public double getDouble(String key,
                        double defaultValue)
```
    Description copied from class: TypedProperties
    
    Get the value of the property identified by the key as double. If key is null or there is no property for the key, defaultValue is returned.
    
    Specified by:
    
    getDouble in class TypedProperties
  - getInt
```
public int getInt(String key,
                  int defaultValue)
```
    Equivalent to getInt(key, defaultValue) on the internal SharedPreferences instance. If the given key is null, defaultValue is returned.
    
    Specified by:
    
    getInt in class TypedProperties
  - getLong
```
public long getLong(String key,
                    long defaultValue)
```
    Equivalent to getLong(key, defaultValue) on the internal SharedPreferences instance. If the given key is null, defaultValue is returned.
    
    Specified by:
    
    getLong in class TypedProperties
  - getString
```
public String getString(String key,
                        String defaultValue)
```
    Equivalent to getString(key, defaultValue) on the internal SharedPreferences instance. If the given key is null, defaultValue is returned.
    
    Specified by:
    
    getString in class TypedProperties
  - setBoolean
```
public void setBoolean(String key,
                       boolean value)
```
    Equivalent to edit().putBoolean(key, value).commit() on the internal SharedPreferences instance. If the given key is null, nothing is done.
    
    Specified by:
    
    setBoolean in class TypedProperties
  - setFloat
```
public void setFloat(String key,
                     float value)
```
    Equivalent to edit().putFloat(key, value).commit() on the internal SharedPreferences instance. If the given key is null, nothing is done.
    
    Specified by:
    
    setFloat in class TypedProperties
  - setDouble
```
public void setDouble(String key,
                      double value)
```
    Description copied from class: TypedProperties
    
    Set the value to the property identified by the key. If key is null, nothing is done.
    
    Specified by:
    
    setDouble in class TypedProperties
  - setInt
```
public void setInt(String key,
                   int value)
```
    Equivalent to edit().putInt(key, value).commit() on the internal SharedPreferences instance. If the given key is null, nothing is done.
    
    Specified by:
    
    setInt in class TypedProperties
  - setLong
```
public void setLong(String key,
                    long value)
```
    Equivalent to edit().putLong(key, value).commit() on the internal SharedPreferences instance. If the given key is null, nothing is done.
    
    Specified by:
    
    setLong in class TypedProperties
  - setString
```
public void setString(String key,
                      String value)
```
    Equivalent to edit().putString(key, value).commit() on the internal SharedPreferences instance. If the given key is null, nothing is done.
    
    Specified by:
    
    setString in class TypedProperties
  - remove
```
public void remove(String key)
```
    Equivalent to edit().remove(key).commit() on the internal SharedPreferences instance. If the given key is null, nothing is done.
    
    Specified by:
    
    remove in class TypedProperties
  - clear
```
public void clear()
```
    Equivalent to edit().clear().commit() on the internal SharedPreferences instance.
    
    Specified by:
    
    clear in class TypedProperties

Class Preferences

Constructor Summary

Method Summary

Methods inherited from class com.neovisionaries.android.util.TypedProperties

Methods inherited from class java.lang.Object

Constructor Detail

Preferences

Preferences

Preferences

Method Detail

contains

getBoolean

getFloat

getDouble

getInt

getLong

getString

setBoolean

setFloat

setDouble

setInt

setLong

setString

remove

clear