universum.studios.android.preference

Interface SharedPreferencesProvider

All Known Implementing Classes:

PreferencesManager

public interface SharedPreferencesProvider

Interface for simple provider which provides access to SharedPreferences for specified name and mode. Instance of the corresponding shared preferences may be obtained via getSharedPreferences().

Since:

2.0

Author:

Martin Albedinsky

Method Summary

Modifier and Type	Method and Description
android.content.SharedPreferences	getSharedPreferences() Returns the instance of SharedPreferences provided by this provider.
int	getSharedPreferencesMode() Returns the mode for preferences file specified for this provider.
String	getSharedPreferencesName() Returns the name for preferences file specified for this provider.
void	setSharedPreferencesMode(int mode) Sets a mode for preferences file that is used by this provider to access instance of SharedPreferences via Context.getSharedPreferences(String, int).
void	setSharedPreferencesName(String name) Sets a name for preferences file that is used by this provider to access instance of SharedPreferences via Context.getSharedPreferences(String, int).

Method Detail

setSharedPreferencesName

void setSharedPreferencesName(@Nullable
                              String name)

Sets a name for preferences file that is used by this provider to access instance of SharedPreferences via Context.getSharedPreferences(String, int).

Parameters:

name - The desired preferences name. May be null if this host should use default name provide by the framework.

See Also:

getSharedPreferencesName(), setSharedPreferencesMode(int), getSharedPreferences()

getSharedPreferencesName

@NonNull
String getSharedPreferencesName()

Returns the name for preferences file specified for this provider.

Default value: PreferenceManager#getDefaultSharedPreferencesName(Context)

Returns:

Preferences name. If no name has been specified a default one will be returned.

See Also:

setSharedPreferencesName(String), getSharedPreferencesMode(), getSharedPreferences()

setSharedPreferencesMode

void setSharedPreferencesMode(int mode)

Sets a mode for preferences file that is used by this provider to access instance of SharedPreferences via Context.getSharedPreferences(String, int).

Parameters:

mode - The desired preferences mode.

See Also:

getSharedPreferencesMode(), setSharedPreferencesName(String), getSharedPreferences()

getSharedPreferencesMode

int getSharedPreferencesMode()

Returns the mode for preferences file specified for this provider.

Default value: MODE_PRIVATE

Returns:

Preferences mode. If no mode has been specified a default one will be returned.

See Also:

setSharedPreferencesMode(int), getSharedPreferencesName(), getSharedPreferences()

getSharedPreferences

@NonNull
android.content.SharedPreferences getSharedPreferences()

Returns the instance of SharedPreferences provided by this provider.

Returns:

The associated shared preferences.

See Also:

setSharedPreferencesName(String), setSharedPreferencesMode(int)