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(android.content.Context context)

Method Summary

Modifier and Type	Method and Description
Collection<User>	allUsers() Returns a collection of all users saved in the User store.
User	get(String key) Retrieves the User with the given key.
User	put(String key, User user) Saves a User object under the given key.
User	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(android.content.Context context)

Method Detail

put

public User put(String key,
                User user)

Saves a User 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 - User object to store.

Returns:

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

get

public User get(String key)

Retrieves the User with the given key.

Specified by:

get in interface UserStore

Parameters:

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

remove

public User 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:

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

allUsers

public Collection<User> 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.