universum.studios.android.preference

Class PreferencesManager.Builder

java.lang.Object

universum.studios.android.preference.SimpleSharedPreferencesFacade.Builder<PreferencesManager.Builder>

universum.studios.android.preference.PreferencesManager.Builder

Enclosing class:

PreferencesManager

public static class PreferencesManager.Builder
extends SimpleSharedPreferencesFacade.Builder<PreferencesManager.Builder>

Builder that may be used to creates new instances of PreferencesManager with a desired configuration.

Required parameters

• none

Author:

Martin Albedinsky

Constructor Summary

Constructors

Constructor and Description
Builder(android.content.Context context) Creates a new Builder with the specified context.

Method Summary

Modifier and Type	Method and Description
PreferencesManager	build() Builds a new instance of PreferencesManager with the configuration specified for this builder.
PreferencesManager.Builder	preferencesFileMode(int fileMode) Specifies a file mode for shared preferences that is used to create default preferences instance in case when there is no explicit instance of preferences specified for this builder via SimpleSharedPreferencesFacade.Builder.preferences(SharedPreferences).
PreferencesManager.Builder	preferencesName(String name) Specifies a name for shared preferences that is used to create default preferences instance in case when there is no explicit instance of preferences specified for this builder via SimpleSharedPreferencesFacade.Builder.preferences(SharedPreferences).

Methods inherited from class universum.studios.android.preference.SimpleSharedPreferencesFacade.Builder

preferences

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(android.content.Context context)

Creates a new Builder with the specified context.

Parameters:

context - The context that is used to create default preferences instance for this builder if there is no explicit instance of preferences specified.

Method Detail

preferencesName

public PreferencesManager.Builder preferencesName(String name)

Specifies a name for shared preferences that is used to create default preferences instance in case when there is no explicit instance of preferences specified for this builder via SimpleSharedPreferencesFacade.Builder.preferences(SharedPreferences).

Also the specified name may be used later in order to identify preferences instance via PreferencesManager.getPreferencesName().

Parameters:

name - The desired name for preferences. May be null in order to use default name for preferences.

Returns:

This builder to allow methods chaining.

See Also:

SharedPreferencesPolicy.defaultPreferencesName(Context)

preferencesFileMode

public PreferencesManager.Builder preferencesFileMode(int fileMode)

Specifies a file mode for shared preferences that is used to create default preferences instance in case when there is no explicit instance of preferences specified for this builder via SimpleSharedPreferencesFacade.Builder.preferences(SharedPreferences).

Also the specified mode may be used later in order to identify preferences file mode via PreferencesManager.getPreferencesFileMode().

Parameters:

fileMode - The desired file mode for preferences. Should be one of modes defined by @SharedPreferencesPolicy.FileMode annotation.

Returns:

This builder to allow methods chaining.

build

public PreferencesManager build()

Builds a new instance of PreferencesManager with the configuration specified for this builder.

Overrides:

build in class SimpleSharedPreferencesFacade.Builder<PreferencesManager.Builder>

Returns:

Instance of preferences manager ready to be used.

Throws:

IllegalArgumentException - If some of the required parameters is missing.