com.bonzaiengine.io

Class Cache

java.lang.Object

com.bonzaiengine.io.Cache

public final class Cache
extends java.lang.Object

Local data cache with versioning support and data server duplication support (server sharing the same data).

See Also:

CACHE_NAME_PROPERTY, CACHE_BASE_PROPERTY, CACHE_CLEAR_PROPERTY, CACHE_EXPIRACY_PROPERTY

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Cache.AsyncStream Asynchroneous stream that will be download in the cache.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CACHE_BASE_PROPERTY System property used to have multiple server data, and to cut down the cache hierarchy depth.
static java.lang.String	CACHE_CLEAR_PROPERTY System property used for clearing the cache at creation.
static java.lang.String	CACHE_EXPIRACY_PROPERTY System property used to enable data versioning (allow to invalid cache if data was updated on the server).
static java.lang.String	CACHE_NAME_PROPERTY System property used to define the cache dir name.
static java.lang.String	CACHE_NUMRETRY_PROPERTY System property used for specifying the maximum number of retry request.
static java.lang.String	CACHE_NUMTHREADS_PROPERTY System property used for specifying the maximum number of internal thread to use for downloading data in the cache.

Method Summary

Modifier and Type	Method and Description
void	clear()
static Cache	get()
Cache.AsyncStream	get(Stream stream)
long	getNumBytesDownloaded()
long	getNumBytesToDownload()
int	getQueueSize()
boolean	isCacheExpiracy()
boolean	isQueueEmpty()
boolean	isWorking()
boolean	queue(Cache.AsyncStream asyncStream)
Cache.AsyncStream	queue(Stream stream)
Finder.FinderCallback	setFinderCallback(Finder.FinderCallback finderCallback)

Methods inherited from class java.lang.Object

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

Field Detail

CACHE_NAME_PROPERTY

public static final java.lang.String CACHE_NAME_PROPERTY

System property used to define the cache dir name.
By default: bonzaiengine_cache

See Also:

Constant Field Values

CACHE_BASE_PROPERTY

public static final java.lang.String CACHE_BASE_PROPERTY

System property used to have multiple server data, and to cut down the cache hierarchy depth.

For example, by settings this property to 'storage', all data downloaded from http://xxx/storage/yyy/file will be stored in the cache in /yyy/file.

See Also:

Constant Field Values

CACHE_CLEAR_PROPERTY

public static final java.lang.String CACHE_CLEAR_PROPERTY

System property used for clearing the cache at creation.
By default: false

See Also:

Constant Field Values

CACHE_NUMTHREADS_PROPERTY

public static final java.lang.String CACHE_NUMTHREADS_PROPERTY

System property used for specifying the maximum number of internal thread to use for downloading data in the cache.
By default: false

See Also:

Constant Field Values

CACHE_NUMRETRY_PROPERTY

public static final java.lang.String CACHE_NUMRETRY_PROPERTY

System property used for specifying the maximum number of retry request.
By default: 1

See Also:

Constant Field Values

CACHE_EXPIRACY_PROPERTY

public static final java.lang.String CACHE_EXPIRACY_PROPERTY

System property used to enable data versioning (allow to invalid cache if data was updated on the server).
By default: true

See Also:

Constant Field Values

Method Detail

get

public static Cache get()

setFinderCallback

public Finder.FinderCallback setFinderCallback(Finder.FinderCallback finderCallback)

Returns:

old Finder.FinderCallback

clear

public final void clear()

isCacheExpiracy

public boolean isCacheExpiracy()

get

public Cache.AsyncStream get(Stream stream)

queue

public Cache.AsyncStream queue(Stream stream)

queue

public boolean queue(Cache.AsyncStream asyncStream)

getQueueSize

public int getQueueSize()

isQueueEmpty

public boolean isQueueEmpty()

isWorking

public boolean isWorking()

getNumBytesDownloaded

public final long getNumBytesDownloaded()

getNumBytesToDownload

public final long getNumBytesToDownload()