io.realm.android

Class SharedPrefsUserStore

java.lang.Object

io.realm.android.SharedPrefsUserStore

All Implemented Interfaces:

UserStore

public class SharedPrefsUserStore
extends Object
implements UserStore

A User Store backed by a SharedPreferences file.

Field Summary

Fields inherited from interface io.realm.UserStore

CURRENT_USER_KEY

Constructor Summary

Constructors

Constructor and Description
SharedPrefsUserStore(Context context)

Method Summary

Modifier and Type	Method and Description
Collection<SyncUser>	allUsers() Returns a collection of all users saved in the User store.
void	clear() Removes all saved users.
SyncUser	get(String key) Retrieves the SyncUser with the given key.
SyncUser	put(String key, SyncUser user) Saves a SyncUser object under the given key.
SyncUser	remove(String key) Removes the user with the given key from the store.

Methods inherited from class java.lang.Object

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

Constructor Detail

SharedPrefsUserStore

public SharedPrefsUserStore(Context context)

Method Detail

put

public SyncUser put(String key,
                    SyncUser user)

Saves a SyncUser object under the given key. If another user already exists, it will be replaced.

Specified by:

put in interface UserStore

Parameters:

key - key used to store the User.

user - SyncUser object to store.

Returns:

The previous user saved with this key or null if no user was replaced.

get

public SyncUser get(String key)

Retrieves the SyncUser with the given key.

Specified by:

get in interface UserStore

Parameters:

key - SyncUser saved under the given key or null if no user exists for that key.

remove

public SyncUser remove(String key)

Removes the user with the given key from the store.

Specified by:

remove in interface UserStore

Parameters:

key - key for the user to remove.

Returns:

SyncUser that was removed or null if no user matched the key.

allUsers

public Collection<SyncUser> allUsers()

Returns a collection of all users saved in the User store.

Specified by:

allUsers in interface UserStore

Returns:

Collection of all users. If no users exist, an empty collection is returned.

clear

public void clear()

Removes all saved users.

Specified by:

clear in interface UserStore