universum.studios.android.officium.account

Class UserAccount

java.lang.Object

universum.studios.android.officium.account.UserAccount

public class UserAccount
extends Object

Class representing a simple holder for user data used when creating Accounts via UserAccountManager. Each instance of UserAccount must be created with name and password that are essential for creation of instance of Account.

There can be specified also additional data for each user account instance either via putData(String, String) or setDataBundle(Bundle) including authentication tokens via putAuthToken(String, String).

Note, that getAuthTokenTypes() method should always return array of token types that are specific for a particular type of UserAccount implementation. This array is used by UserAccountManager to iterate types Map (getAuthTokens()) and obtain all token data from it and store it for the associated Account via AccountManager.setAuthToken(Account, String, String).

Author:

Martin Albedinsky

Field Summary

Fields

Modifier and Type	Field and Description
protected static String[]	AUTH_TOKEN_TYPES Array specifying set of default authentication token types.
protected String	mName Name specified for this user account.
protected String	mPassword Password specified for this user account.
static String	TOKEN_TYPE_O_AUTH Type key for the OAuth token.

Constructor Summary

Constructors

Constructor and Description
UserAccount(String name) Same as UserAccount(String, String) with null password.
UserAccount(String name, String password) Creates a new instance of UserAccount with the specified name and password.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
String	getAuthToken(String tokenType) Returns the authentication token specified for this user account for the requested tokenType.
protected Map<String,String>	getAuthTokens() Returns the map with authentication tokens specified for this user account mapped to theirs types.
protected String[]	getAuthTokenTypes() Returns the types of authentication tokens specific for this user account.
String	getData(String key) Returns the data value contained within data bundle of this user account under the specified key.
Bundle	getDataBundle() Returns the data bundle of this user account
String	getName() Returns the name specified for this user account.
String	getOAuthToken() Same as getAuthToken(String) with TOKEN_TYPE_O_AUTH as tokenType.
String	getPassword() Returns the password specified for this user account.
boolean	hasAuthToken(String tokenType) Checks whether there is authentication token specified for this user account for the specified tokenType.
boolean	hasData(String key) Checks whether this account has data with the specified key associated.
int	hashCode()
void	putAuthToken(String tokenType, String token) Puts the given token into authentication tokens of this user account under the specified tokenType as key.
void	putData(String key, String data) Puts the given data into data bundle of this user account under the specified key.
void	putOAuthToken(String authToken) Same as putAuthToken(String, String) with TOKEN_TYPE_O_AUTH as tokenType.
void	removeData(String key) Removes the data specified for this account for the specified key.
void	setDataBundle(Bundle dataBundle) Sets a data bundle for this user account.
void	setPassword(String password) Sets a new password for this account.

Methods inherited from class java.lang.Object

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

Field Detail

TOKEN_TYPE_O_AUTH

public static final String TOKEN_TYPE_O_AUTH

Type key for the OAuth token.

See Also:

putAuthToken(String, String), Constant Field Values

AUTH_TOKEN_TYPES

protected static final String[] AUTH_TOKEN_TYPES

Array specifying set of default authentication token types.

Contains single TOKEN_TYPE_O_AUTH key.

mName

protected final String mName

Name specified for this user account.

mPassword

protected String mPassword

Password specified for this user account.

Constructor Detail

UserAccount

public UserAccount(@NonNull
                   String name)

Same as UserAccount(String, String) with null password.

Parameters:

name - The desired name for the new account.

UserAccount

public UserAccount(@NonNull
                   String name,
                   @Nullable
                   String password)

Creates a new instance of UserAccount with the specified name and password.

Parameters:

name - The desired name for the new account.

password - The desired password for the new account. May be null.

Method Detail

getName

@NonNull
public final String getName()

Returns the name specified for this user account.

Returns:

This account's name.

See Also:

UserAccount(String), UserAccount(String, String)

setPassword

public final void setPassword(@Nullable
                              String password)

Sets a new password for this account.

Parameters:

password - The desired new password. May be null to clear the current one.

See Also:

UserAccount(String, String), getPassword()

getPassword

@Nullable
public final String getPassword()

Returns the password specified for this user account.

Returns:

This account's password. May be null.

See Also:

setPassword(String)

putData

public void putData(@NonNull
                    String key,
                    @Nullable
                    String data)

Puts the given data into data bundle of this user account under the specified key.

Parameters:

key - The key under which to map the given data value.

data - The desired data to put into bundle.

See Also:

getData(String), getDataBundle()

hasData

public boolean hasData(@NonNull
                       String key)

Checks whether this account has data with the specified key associated.

Parameters:

key - The key of the desired data to check.

Returns:

True if this account has data with the key, false otherwise.

See Also:

putData(String, String)

getData

@Nullable
public String getData(@NonNull
                                 String key)

Returns the data value contained within data bundle of this user account under the specified key.

Parameters:

key - The key for which to obtain the desired data.

Returns:

Data value for the specified key or null if there is no such value mapped for that key.

See Also:

putData(String, String), hasData(String), getDataBundle()

removeData

public void removeData(@NonNull
                       String key)

Removes the data specified for this account for the specified key.

Parameters:

key - The key for which to remove the desired data.

See Also:

putData(String, String), hasData(String)

setDataBundle

public void setDataBundle(@Nullable
                          Bundle dataBundle)

Sets a data bundle for this user account.

Parameters:

dataBundle - The desired bundle with user data. May be null to clear the current bundle.

See Also:

putData(String, String), getData(String)

getDataBundle

@Nullable
public Bundle getDataBundle()

Returns the data bundle of this user account

Returns:

Bundle with user data either specified via setDataBundle(Bundle) or separately via putData(String, String) or null if there is no data bundle available.

See Also:

setDataBundle(Bundle), getData(String)

putOAuthToken

public void putOAuthToken(@Nullable
                          String authToken)

Same as putAuthToken(String, String) with TOKEN_TYPE_O_AUTH as tokenType.

Parameters:

authToken - The desired OAuth token. May be null to clear the previous one.

putAuthToken

public void putAuthToken(@Nullable
                         String tokenType,
                         @Nullable
                         String token)

Puts the given token into authentication tokens of this user account under the specified tokenType as key.

Parameters:

tokenType - The desired type of the given token.

token - The desired authentication token. May be null to clear the previous one.

See Also:

getAuthToken(String), getAuthTokens()

hasAuthToken

public boolean hasAuthToken(@Nullable
                            String tokenType)

Checks whether there is authentication token specified for this user account for the specified tokenType.

Parameters:

tokenType - Type of the desired token to check if it is specified for this account.

Returns:

True if putAuthToken(String, String) has been called with the tokenType, false otherwise.

getOAuthToken

@Nullable
public String getOAuthToken()

Same as getAuthToken(String) with TOKEN_TYPE_O_AUTH as tokenType.

getAuthToken

@Nullable
public String getAuthToken(@Nullable
                                      String tokenType)

Returns the authentication token specified for this user account for the requested tokenType.

Parameters:

tokenType - Type of the desired token to obtain.

Returns:

Auth token for the requested token type or null if there is no token specified for that type.

getAuthTokenTypes

@Nullable
protected String[] getAuthTokenTypes()

Returns the types of authentication tokens specific for this user account.

Returns:

For this account specific authentication token types.

getAuthTokens

@Nullable
protected Map<String,String> getAuthTokens()

Returns the map with authentication tokens specified for this user account mapped to theirs types.

Returns:

This account's authentication tokens or null if there are no tokens specified yet.

See Also:

putAuthToken(String, String), getAuthToken(String)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object