universum.studios.android.preference

Class SharedPreferencesPolicies

java.lang.Object

universum.studios.android.preference.SharedPreferencesPolicies

public final class SharedPreferencesPolicies
extends Object

Class that declares policies related to the Android SharedPreferences API.

Since:

2.0

Author:

Martin Albedinsky

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SharedPreferencesPolicies.Mode Defines an annotation for determining allowed file creation modes for SharedPreferences file.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PREFERENCES_NAME_SUFFIX Suffix for default name used by the Android for shared preferences.
static int	MODE_APPEND Copied flag from Context.MODE_APPEND.
static int	MODE_PRIVATE Copied flag from Context.MODE_PRIVATE.

Method Summary

Modifier and Type	Method and Description
static String	defaultPreferencesName(Context context) Creates a default name for shared preferences for the specified context that is the same one as created by default by the Android framework.
static String	preferencesName(Context context, String nameSuffix) Creates a name for shared preferences with the given nameSuffix for the specified context.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PREFERENCES_NAME_SUFFIX

public static final String DEFAULT_PREFERENCES_NAME_SUFFIX

Suffix for default name used by the Android for shared preferences.

See Also:

Constant Field Values

MODE_PRIVATE

public static final int MODE_PRIVATE

Copied flag from Context.MODE_PRIVATE.

See Also:

Constant Field Values

MODE_APPEND

public static final int MODE_APPEND

Copied flag from Context.MODE_APPEND.

See Also:

Constant Field Values

Method Detail

defaultPreferencesName

@NonNull
public static String defaultPreferencesName(@NonNull
                                                     Context context)

Creates a default name for shared preferences for the specified context that is the same one as created by default by the Android framework.

Parameters:

context - The context for which to create preferences name.

Returns:

Preferences name that may be used in association with Context.getSharedPreferences(String, int).

See Also:

preferencesName(Context, String), PreferenceManager.getDefaultSharedPreferencesName(Context)

preferencesName

@NonNull
public static String preferencesName(@NonNull
                                              Context context,
                                              @NonNull
                                              String nameSuffix)

Creates a name for shared preferences with the given nameSuffix for the specified context.

Parameters:

context - The context for which to create preferences name.

nameSuffix - Suffix to be added into preferences name.

Returns:

Preferences name that may be used in association with Context.getSharedPreferences(String, int).

See Also:

defaultPreferencesName(Context)