com.box.androidsdk.preview.cache

Class SimplePreviewStorage

java.lang.Object

com.box.androidsdk.preview.cache.SimplePreviewStorage

All Implemented Interfaces:

LRUStorageManagedDirectory.DeleteHandler, PreviewStorage, java.io.Serializable

public class SimplePreviewStorage
extends java.lang.Object
implements PreviewStorage, java.io.Serializable, LRUStorageManagedDirectory.DeleteHandler

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SimplePreviewStorage.NotifyingFileOutputStream

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_CACHE_AGE Max cache age in days - Redefine this constant to change the default policy.
static long	MAX_CACHE_SIZE Max cache size in bytes - Redefine this constant to change the default policy.

Constructor Summary

Constructors

Constructor and Description
SimplePreviewStorage(BoxSession session)
SimplePreviewStorage(BoxSession session, long maxCacheSize, int expirationDays) Default implementation of Serializable PreviewStorage

Method Summary

Methods

Modifier and Type	Method and Description
void	cacheMetadata(BoxFile metadata, java.lang.String tag)
java.io.OutputStream	createPreviewOutputStream(BoxFile boxFile) This stream must be flushed upon successful completion.
java.io.OutputStream	createThumbnailOutputStream(BoxFile boxFile) This stream must be flushed upon successful completion.
java.io.InputStream	getCachedPreview(BoxFile boxFile)
java.io.InputStream	getCachedThumbnail(BoxFile boxFile)
<T extends BoxFile> T	getMetadata(BoxFile fileInfo, java.lang.String tag)
java.io.File	getPreviewFile(BoxFile boxFile)
void	onFileDeleted(java.io.File file, boolean deleteSuccessful)
boolean	shouldDelete(java.io.File file)

Methods inherited from class java.lang.Object

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

Field Detail

MAX_CACHE_SIZE

public static long MAX_CACHE_SIZE

Max cache size in bytes - Redefine this constant to change the default policy.

MAX_CACHE_AGE

public static int MAX_CACHE_AGE

Max cache age in days - Redefine this constant to change the default policy.

Constructor Detail

SimplePreviewStorage

public SimplePreviewStorage(BoxSession session,
                    long maxCacheSize,
                    int expirationDays)

Default implementation of Serializable PreviewStorage

Parameters:

session - - BoxSession from the content sdk after the user is authenticated

maxCacheSize - - Maximum size of the cache in bytes.

expirationDays - - Days beyond which files in cache can be cleared

SimplePreviewStorage

public SimplePreviewStorage(BoxSession session)

Method Detail

shouldDelete

public boolean shouldDelete(java.io.File file)

Specified by:

shouldDelete in interface LRUStorageManagedDirectory.DeleteHandler

Parameters:

file - the file this class is planning to delete.

Returns:

true if the class should delete the file, false otherwise.

onFileDeleted

public void onFileDeleted(java.io.File file,
                 boolean deleteSuccessful)

Specified by:

onFileDeleted in interface LRUStorageManagedDirectory.DeleteHandler

Parameters:

file - the file this class attempted to delete.

deleteSuccessful - true if the file was successfully deleted, false if the delete failed.

getCachedPreview

public java.io.InputStream getCachedPreview(BoxFile boxFile)

Specified by:

getCachedPreview in interface PreviewStorage

getCachedThumbnail

public java.io.InputStream getCachedThumbnail(BoxFile boxFile)

Specified by:

getCachedThumbnail in interface PreviewStorage

getPreviewFile

public java.io.File getPreviewFile(BoxFile boxFile)

Specified by:

getPreviewFile in interface PreviewStorage

createThumbnailOutputStream

public java.io.OutputStream createThumbnailOutputStream(BoxFile boxFile)

This stream must be flushed upon successful completion.

Specified by:

createThumbnailOutputStream in interface PreviewStorage

Parameters:

boxFile - the box file to get stream for.

Returns:

an outputstream that writes to a file associated with the given boxFile. Until flushed it cannot be retrieved.

createPreviewOutputStream

public java.io.OutputStream createPreviewOutputStream(BoxFile boxFile)

This stream must be flushed upon successful completion.

Specified by:

createPreviewOutputStream in interface PreviewStorage

Parameters:

boxFile - the box file to get stream for.

Returns:

an outputstream that writes to a file associated with the given boxFile. Until flushed it cannot be retrieved.

cacheMetadata

public void cacheMetadata(BoxFile metadata,
                 java.lang.String tag)

Specified by:

cacheMetadata in interface PreviewStorage

getMetadata

public <T extends BoxFile> T getMetadata(BoxFile fileInfo,
                                java.lang.String tag)

Specified by:

getMetadata in interface PreviewStorage