SimplePreferences

java.lang.Object
- stanford.androidlib.SimplePreferences

public final class SimplePreferences
extends Object

A utility class for getting and setting preferences.

 SimplePreferences.with(this).setSharedPreference("username", "Billy Bob");

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(String name)` Returns true if this activity contains a preference with the given name.
`boolean`	`containsShared(String filename, String name)` Returns true if this activity contains a shared preference with the given name in the given shared preference filename.
`<T> T`	`get(String name, T defaultValue)` Returns the preference with the given name and value from the app's global preferences.
`boolean`	`getBoolean(String name)` Returns the preference with the given name and value from the app's global preferences.
`boolean`	`getBoolean(String name, boolean defaultValue)` Returns the preference with the given name and value from the app's global preferences.
`double`	`getDouble(String name)` Returns the preference with the given name and value from the app's global preferences.
`double`	`getDouble(String name, double defaultValue)` Returns the preference with the given name and value from the app's global preferences.
`int`	`getInt(String name)` Returns the preference with the given name and value from the app's global preferences.
`int`	`getInt(String name, int defaultValue)` Returns the preference with the given name and value from the app's global preferences.
`long`	`getLong(String name)` Returns the preference with the given name and value from the app's global preferences.
`long`	`getLong(String name, long defaultValue)` Returns the preference with the given name and value from the app's global preferences.
`<T> T`	`getShared(String filename, String name, T defaultValue)` Returns the shared preference with the given name and value from the given shared preference filename.
`boolean`	`getSharedBoolean(String filename, String name)` Returns the shared preference with the given name and value from the given shared preference filename.
`boolean`	`getSharedBoolean(String filename, String name, boolean defaultValue)` Returns the shared preference with the given name and value from the given shared preference filename.
`double`	`getSharedDouble(String filename, String name)` Returns the shared preference with the given name and value from the given shared preference filename.
`double`	`getSharedDouble(String filename, String name, double defaultValue)` Returns the shared preference with the given name and value from the given shared preference filename.
`int`	`getSharedInt(String filename, String name)` Returns the shared preference with the given name and value from the given shared preference filename.
`int`	`getSharedInt(String filename, String name, int defaultValue)` Returns the shared preference with the given name and value from the given shared preference filename.
`long`	`getSharedLong(String filename, String name)` Returns the shared preference with the given name and value from the given shared preference filename.
`long`	`getSharedLong(String filename, String name, long defaultValue)` Returns the shared preference with the given name and value from the given shared preference filename.
`String`	`getSharedString(String filename, String name)` Returns the shared preference with the given name and value from the given shared preference filename.
`String`	`getSharedString(String filename, String name, String defaultValue)` Returns the shared preference with the given name and value from the given shared preference filename.
`Set<String>`	`getSharedStringSet(String filename, String name)` Returns the shared preference with the given name and value from the app's global preferences.
`Set<String>`	`getSharedStringSet(String filename, String name, Set<String> defaultValue)` Returns the shared preference with the given name and value from the app's global preferences.
`String`	`getString(String name)` Returns the preference with the given name and value from the app's global preferences.
`String`	`getString(String name, String defaultValue)` Returns the preference with the given name and value from the app's global preferences.
`Set<String>`	`getStringSet(String name)` Returns the preference with the given name and value from the app's global preferences.
`Set<String>`	`getStringSet(String name, Set<String> defaultValue)` Returns the preference with the given name and value from the app's global preferences.
`boolean`	`has(String name)` Returns true if this activity contains a preference with the given name.
`boolean`	`hasShared(String filename, String name)` Returns true if this activity contains a shared preference with the given name in the given shared preference filename.
`SimplePreferences`	`set(String name, boolean value)` Sets a preference with the given name and value into the app's global preferences.
`SimplePreferences`	`set(String name, double value)` Sets a preference with the given name and value into the app's global preferences.
`SimplePreferences`	`set(String name, int value)` Sets a preference with the given name and value into the app's global preferences.
`SimplePreferences`	`set(String name, Iterable<String> value)` Sets a preference with the given name and value into the app's global preferences.
`SimplePreferences`	`set(String name, long value)` Sets a preference with the given name and value into the app's global preferences.
`SimplePreferences`	`set(String name, Set<String> value)` Sets a preference with the given name and value into the app's global preferences.
`SimplePreferences`	`set(String name, String value)` Sets a preference with the given name and value into the app's global preferences.
`SimplePreferences`	`setShared(String filename, String name, boolean value)` Sets a shared preference with the given name and value into the given shared preference filename.
`SimplePreferences`	`setShared(String filename, String name, double value)` Sets a shared preference with the given name and value into the given shared preference filename.
`SimplePreferences`	`setShared(String filename, String name, int value)` Sets a shared preference with the given name and value into the given shared preference filename.
`SimplePreferences`	`setShared(String filename, String name, Iterable<String> value)` Sets a shared preference with the given name and value into the given shared preference filename.
`SimplePreferences`	`setShared(String filename, String name, long value)` Sets a shared preference with the given name and value into the given shared preference filename.
`SimplePreferences`	`setShared(String filename, String name, Set<String> value)` Sets a shared preference with the given name and value into the given shared preference filename.
`SimplePreferences`	`setShared(String filename, String name, String value)` Sets a shared preference with the given name and value into the given shared preference filename.
`static SimplePreferences`	`with(Activity context)` Returns a singleton SimplePreferences instance bound to the given context.
`static SimplePreferences`	`with(Context context)` Returns a singleton SimplePreferences instance bound to the given context.
`static SimplePreferences`	`with(View context)` Returns a singleton SimplePreferences instance bound to the given view's context.

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

- Method Detail
  - with
```
public static SimplePreferences with(Activity context)
```
    Returns a singleton SimplePreferences instance bound to the given context.
  - with
```
public static SimplePreferences with(Context context)
```
    Returns a singleton SimplePreferences instance bound to the given context. The context must be an Activity, or an IllegalArgumentException will be thrown.
  - with
```
public static SimplePreferences with(View context)
```
    Returns a singleton SimplePreferences instance bound to the given view's context.
  - contains
```
public boolean contains(String name)
```
    Returns true if this activity contains a preference with the given name. Equivalent to has(name).
  - containsShared
```
public boolean containsShared(String filename,
                              String name)
```
    Returns true if this activity contains a shared preference with the given name in the given shared preference filename. Equivalent to hasShared(filename, name).
  - getBoolean
```
public boolean getBoolean(String name)
```
    Returns the preference with the given name and value from the app's global preferences. If there is no such shared preference, returns false.
  - getBoolean
```
public boolean getBoolean(String name,
                          boolean defaultValue)
```
    Returns the preference with the given name and value from the app's global preferences. If there is no such shared preference, returns the given default value.
  - getDouble
```
public double getDouble(String name)
```
    Returns the preference with the given name and value from the app's global preferences. If there is no such shared preference, returns 0.0.
  - getDouble
```
public double getDouble(String name,
                        double defaultValue)
```
    Returns the preference with the given name and value from the app's global preferences. If there is no such shared preference, returns the given default value.
  - getInt
```
public int getInt(String name)
```
    Returns the preference with the given name and value from the app's global preferences. If there is no such shared preference, returns 0.
  - getInt
```
public int getInt(String name,
                  int defaultValue)
```
    Returns the preference with the given name and value from the app's global preferences. If there is no such shared preference, returns the given default value.
  - getLong
```
public long getLong(String name)
```
    Returns the preference with the given name and value from the app's global preferences. If there is no such shared preference, returns 0.
  - getLong
```
public long getLong(String name,
                    long defaultValue)
```
    Returns the preference with the given name and value from the app's global preferences. If there is no such shared preference, returns the given default value.
  - getString
```
public String getString(String name)
```
    Returns the preference with the given name and value from the app's global preferences. If there is no such shared preference, returns an empty string.
  - getString
```
public String getString(String name,
                        String defaultValue)
```
    Returns the preference with the given name and value from the app's global preferences. If there is no such shared preference, returns the given default value.
  - getStringSet
```
public Set<String> getStringSet(String name)
```
    Returns the preference with the given name and value from the app's global preferences. If there is no such shared preference, returns an empty set.
  - getStringSet
```
public Set<String> getStringSet(String name,
                                Set<String> defaultValue)
```
    Returns the preference with the given name and value from the app's global preferences. If there is no such shared preference, returns the given default value.
  - get
```
public <T> T get(String name,
                 T defaultValue)
```
    Returns the preference with the given name and value from the app's global preferences. If there is no such shared preference, returns the given default value.
  - getSharedBoolean
```
public boolean getSharedBoolean(String filename,
                                String name)
```
    Returns the shared preference with the given name and value from the given shared preference filename. If there is no such shared preference, returns false.
  - getSharedBoolean
```
public boolean getSharedBoolean(String filename,
                                String name,
                                boolean defaultValue)
```
    Returns the shared preference with the given name and value from the given shared preference filename. If there is no such shared preference, returns the given default value.
  - getSharedDouble
```
public double getSharedDouble(String filename,
                              String name)
```
    Returns the shared preference with the given name and value from the given shared preference filename. If there is no such shared preference, returns 0.0.
  - getSharedDouble
```
public double getSharedDouble(String filename,
                              String name,
                              double defaultValue)
```
    Returns the shared preference with the given name and value from the given shared preference filename. If there is no such shared preference, returns the given default value.
  - getSharedInt
```
public int getSharedInt(String filename,
                        String name)
```
    Returns the shared preference with the given name and value from the given shared preference filename. If there is no such shared preference, returns 0.
  - getSharedInt
```
public int getSharedInt(String filename,
                        String name,
                        int defaultValue)
```
    Returns the shared preference with the given name and value from the given shared preference filename. If there is no such shared preference, returns the given default value.
  - getSharedLong
```
public long getSharedLong(String filename,
                          String name)
```
    Returns the shared preference with the given name and value from the given shared preference filename. If there is no such shared preference, returns 0.
  - getSharedLong
```
public long getSharedLong(String filename,
                          String name,
                          long defaultValue)
```
    Returns the shared preference with the given name and value from the given shared preference filename. If there is no such shared preference, returns the given default value.
  - getSharedString
```
public String getSharedString(String filename,
                              String name)
```
    Returns the shared preference with the given name and value from the given shared preference filename. If there is no such shared preference, returns an empty string.
  - getSharedString
```
public String getSharedString(String filename,
                              String name,
                              String defaultValue)
```
    Returns the shared preference with the given name and value from the given shared preference filename. If there is no such shared preference, returns the given default value.
  - getSharedStringSet
```
public Set<String> getSharedStringSet(String filename,
                                      String name)
```
    Returns the shared preference with the given name and value from the app's global preferences. If there is no such shared preference, returns an empty set.
  - getSharedStringSet
```
public Set<String> getSharedStringSet(String filename,
                                      String name,
                                      Set<String> defaultValue)
```
    Returns the shared preference with the given name and value from the app's global preferences. If there is no such shared preference, returns the given default value.
  - getShared
```
public <T> T getShared(String filename,
                       String name,
                       T defaultValue)
```
    Returns the shared preference with the given name and value from the given shared preference filename. If there is no such shared preference, returns the given default value.
  - has
```
public boolean has(String name)
```
    Returns true if this activity contains a preference with the given name. Equivalent to contains(name).
  - hasShared
```
public boolean hasShared(String filename,
                         String name)
```
    Returns true if this activity contains a shared preference with the given name in the given shared preference filename. Equivalent to containsShared(filename, name).
  - set
```
public SimplePreferences set(String name,
                             boolean value)
```
    Sets a preference with the given name and value into the app's global preferences.
  - set
```
public SimplePreferences set(String name,
                             double value)
```
    Sets a preference with the given name and value into the app's global preferences.
  - set
```
public SimplePreferences set(String name,
                             int value)
```
    Sets a preference with the given name and value into the app's global preferences.
  - set
```
public SimplePreferences set(String name,
                             long value)
```
    Sets a preference with the given name and value into the app's global preferences.
  - set
```
public SimplePreferences set(String name,
                             String value)
```
    Sets a preference with the given name and value into the app's global preferences.
  - set
```
public SimplePreferences set(String name,
                             Iterable<String> value)
```
    Sets a preference with the given name and value into the app's global preferences.
  - set
```
public SimplePreferences set(String name,
                             Set<String> value)
```
    Sets a preference with the given name and value into the app's global preferences.
  - setShared
```
public SimplePreferences setShared(String filename,
                                   String name,
                                   boolean value)
```
    Sets a shared preference with the given name and value into the given shared preference filename.
  - setShared
```
public SimplePreferences setShared(String filename,
                                   String name,
                                   double value)
```
    Sets a shared preference with the given name and value into the given shared preference filename.
  - setShared
```
public SimplePreferences setShared(String filename,
                                   String name,
                                   int value)
```
    Sets a shared preference with the given name and value into the given shared preference filename.
  - setShared
```
public SimplePreferences setShared(String filename,
                                   String name,
                                   long value)
```
    Sets a shared preference with the given name and value into the given shared preference filename.
  - setShared
```
public SimplePreferences setShared(String filename,
                                   String name,
                                   String value)
```
    Sets a shared preference with the given name and value into the given shared preference filename.
  - setShared
```
public SimplePreferences setShared(String filename,
                                   String name,
                                   Iterable<String> value)
```
    Sets a shared preference with the given name and value into the given shared preference filename.
  - setShared
```
public SimplePreferences setShared(String filename,
                                   String name,
                                   Set<String> value)
```
    Sets a shared preference with the given name and value into the given shared preference filename.

Class SimplePreferences

Method Summary

Methods inherited from class java.lang.Object

Method Detail

with

with

with

contains

containsShared

getBoolean

getBoolean

getDouble

getDouble

getInt

getInt

getLong

getLong

getString

getString

getStringSet

getStringSet

get

getSharedBoolean

getSharedBoolean

getSharedDouble

getSharedDouble

getSharedInt

getSharedInt

getSharedLong

getSharedLong

getSharedString

getSharedString

getSharedStringSet

getSharedStringSet

getShared

has

hasShared

set

set

set

set

set

set

set

setShared

setShared

setShared

setShared

setShared

setShared

setShared