com.box.androidsdk.content.views

Class DefaultAvatarController

java.lang.Object

com.box.androidsdk.content.views.DefaultAvatarController

All Implemented Interfaces:

BoxAvatarView.AvatarController, java.io.Serializable

Direct Known Subclasses:

OfflineAvatarController

public class DefaultAvatarController
extends java.lang.Object
implements BoxAvatarView.AvatarController, java.io.Serializable

This view is used to view avatars.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_MAX_AGE
protected BoxApiUser	mApiUser
protected java.util.HashSet<java.lang.String>	mCleanedDirectories
protected java.util.concurrent.ThreadPoolExecutor	mExecutor
protected BoxSession	mSession
protected java.util.HashSet<java.lang.String>	mUnavailableAvatars

Constructor Summary

Constructors

Constructor and Description
DefaultAvatarController(BoxSession session)

Method Summary

Modifier and Type	Method and Description
protected void	cleanOutOldAvatars(java.io.File directory, int maxLifeInDays) Delete all files for user that is older than maxLifeInDays
BoxFutureTask<BoxDownload>	executeAvatarDownloadRequest(java.lang.String userId, BoxAvatarView avatarView)
protected void	executeTask(BoxFutureTask task)
protected BoxApiUser	getApiUser()
protected java.io.File	getAvatarDir(java.lang.String userId)
java.io.File	getAvatarFile(java.lang.String userId)
protected BoxSession	getSession()

Methods inherited from class java.lang.Object

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

Field Detail

mSession

protected BoxSession mSession

mApiUser

protected transient BoxApiUser mApiUser

mUnavailableAvatars

protected java.util.HashSet<java.lang.String> mUnavailableAvatars

mCleanedDirectories

protected java.util.HashSet<java.lang.String> mCleanedDirectories

mExecutor

protected transient java.util.concurrent.ThreadPoolExecutor mExecutor

DEFAULT_MAX_AGE

protected static final int DEFAULT_MAX_AGE

See Also:

Constant Field Values

Constructor Detail

DefaultAvatarController

public DefaultAvatarController(BoxSession session)

Method Detail

getAvatarDir

protected java.io.File getAvatarDir(java.lang.String userId)

getAvatarFile

public java.io.File getAvatarFile(java.lang.String userId)

Specified by:

getAvatarFile in interface BoxAvatarView.AvatarController

Parameters:

userId - User id that avatar File should correspond to.

Returns:

the File where avatar is stored or should be stored.

getApiUser

protected BoxApiUser getApiUser()

Returns:

a BoxApiUser object used to make requests to the avatar endpoint.

getSession

protected BoxSession getSession()

Returns:

a BoxSession object used to make requests to the avatar endpoint.

cleanOutOldAvatars

protected void cleanOutOldAvatars(java.io.File directory,
                                  int maxLifeInDays)

Delete all files for user that is older than maxLifeInDays

Parameters:

directory - the directory where avatar files are being held.

maxLifeInDays - the number of days avatar files are allowed to live for.

executeAvatarDownloadRequest

public BoxFutureTask<BoxDownload> executeAvatarDownloadRequest(java.lang.String userId,
                                                               BoxAvatarView avatarView)

Specified by:

executeAvatarDownloadRequest in interface BoxAvatarView.AvatarController

Parameters:

userId - User id that avatar File should correspond to.

avatarView - the avatar view to update after download.

Returns:

a future task to monitor the download of the avatar.

executeTask

protected void executeTask(BoxFutureTask task)