com.atakmap.android.preference

Class AtakPreferences

java.lang.Object

com.atakmap.android.preference.AtakPreferences

Direct Known Subclasses:

DrawingPreferences, UnitPreferences

public class AtakPreferences
extends java.lang.Object

ATAK core preferences helper which is used to centralize all of the calls to get the shared preference manager

Field Summary

Fields

Modifier and Type	Field and Description
protected android.content.Context	_context
protected android.content.SharedPreferences	_prefs

Constructor Summary

Constructors

Constructor and Description
AtakPreferences(android.content.Context appContext) Construct an ATAK core preference manager
AtakPreferences(MapView mapView) Construct an ATAK core preference manager

Method Summary

Modifier and Type	Method and Description
boolean	contains(java.lang.String key) Check if a preference exists in the set
boolean	get(java.lang.String key, boolean defVal) Retrieve a boolean value from the preferences.
double	get(java.lang.String key, double defVal) Retrieve a double value from the preferences.
int	get(java.lang.String key, int defVal) Retrieve an int value from the preferences.
long	get(java.lang.String key, long defVal) Retrieve a long value from the preferences.
java.lang.String	get(java.lang.String key, java.lang.String defVal) Retrieve a String value from the preferences.
java.util.Map<java.lang.String,?>	getAll() Get the map of all shared preferences
android.content.SharedPreferences	getSharedPrefs() Get the underlying shared preferences object
java.util.Set<java.lang.String>	getStringSet(java.lang.String key) Retrieve a string set from the preferences
void	registerListener(android.content.SharedPreferences.OnSharedPreferenceChangeListener l) Registers a shared preference listener with the AtakPreferences.
void	remove(java.lang.String key) Remove a preference value from the set
boolean	set(java.lang.String key, java.lang.Object value) Set and apply a preference
void	unregisterListener(android.content.SharedPreferences.OnSharedPreferenceChangeListener l) Unregisters a shared preference listener with the AtakPreferences.

Methods inherited from class java.lang.Object

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

Field Detail

_context

protected final android.content.Context _context

_prefs

protected final android.content.SharedPreferences _prefs

Constructor Detail

AtakPreferences

public AtakPreferences(android.content.Context appContext)

Construct an ATAK core preference manager

Parameters:

appContext - the application contrext used by the preference manager

AtakPreferences

public AtakPreferences(MapView mapView)

Construct an ATAK core preference manager

Parameters:

mapView - the map view in order to get the application contrext used by the preference manager

Method Detail

getSharedPrefs

public android.content.SharedPreferences getSharedPrefs()

Get the underlying shared preferences object

Returns:

Shared preferences

set

public boolean set(java.lang.String key,
                   java.lang.Object value)

Set and apply a preference

Parameters:

key - Preference key

value - Preference value (any type)

Returns:

True if successful, false if failed

remove

public void remove(java.lang.String key)

Remove a preference value from the set

Parameters:

key - Preference key

contains

public boolean contains(java.lang.String key)

Check if a preference exists in the set

Parameters:

key - Preference key

Returns:

True if exists

get

public java.lang.String get(java.lang.String key,
                            java.lang.String defVal)

Retrieve a String value from the preferences.

Parameters:

key - The name of the preference to retrieve.

defVal - Value to return if this preference does not exist.

get

public int get(java.lang.String key,
               int defVal)

Retrieve an int value from the preferences.

Parameters:

key - The name of the preference to retrieve.

defVal - Value to return if this preference does not exist.

get

public long get(java.lang.String key,
                long defVal)

Retrieve a long value from the preferences.

Parameters:

key - The name of the preference to retrieve.

defVal - Value to return if this preference does not exist.

get

public double get(java.lang.String key,
                  double defVal)

Retrieve a double value from the preferences.

Parameters:

key - The name of the preference to retrieve.

defVal - Value to return if this preference does not exist.

get

public boolean get(java.lang.String key,
                   boolean defVal)

Retrieve a boolean value from the preferences.

Parameters:

key - The name of the preference to retrieve.

defVal - Value to return if this preference does not exist.

getStringSet

public java.util.Set<java.lang.String> getStringSet(java.lang.String key)

Retrieve a string set from the preferences

Parameters:

key - Preference key

Returns:

String set or null if not found or wrong preference type

getAll

public java.util.Map<java.lang.String,?> getAll()

Get the map of all shared preferences

Returns:

Shared preferences map

registerListener

public void registerListener(android.content.SharedPreferences.OnSharedPreferenceChangeListener l)

Registers a shared preference listener with the AtakPreferences.

Parameters:

l - the shared preference change listener

unregisterListener

public void unregisterListener(android.content.SharedPreferences.OnSharedPreferenceChangeListener l)

Unregisters a shared preference listener with the AtakPreferences.

Parameters:

l - the shared preference change listener