com.vincentbrison.openlibraries.android.dualcache

Class Builder<T>

java.lang.Object

com.vincentbrison.openlibraries.android.dualcache.Builder<T>

Type Parameters:

T - is the class of object to store in cache.

public class Builder<T>
extends java.lang.Object

Class used to build a cache.

Constructor Summary

Constructors

Constructor and Description
Builder(java.lang.String id, int appVersion) Start the building of the cache.

Method Summary

Modifier and Type	Method and Description
DualCache<T>	build() Builder the cache.
Builder<T>	enableLog() Enabling log from the cache.
Builder<T>	noDisk() Use this if you do not want use the disk cache layer, meaning that only the ram cache layer will be used.
Builder<T>	noRam() The ram cache will not be used, meaning that only the disk cache will be used.
Builder<T>	useReferenceInRam(int maxRamSizeBytes, SizeOf<T> handlerSizeOf) Store directly objects in ram (without serialization/deserialization).
Builder<T>	useSerializerInDisk(int maxDiskSizeBytes, boolean usePrivateFiles, <any> serializer, android.content.Context context) Use custom serialization/deserialization to store and retrieve objects from disk cache.
Builder<T>	useSerializerInDisk(int maxDiskSizeBytes, java.io.File diskCacheFolder, <any> serializer) Use custom serialization/deserialization to store and retrieve object from disk cache.
Builder<T>	useSerializerInRam(int maxRamSizeBytes, <any> serializer) Use Json serialization/deserialization to store and retrieve object from ram cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(java.lang.String id,
               int appVersion)

Start the building of the cache.

Parameters:

id - is the id of the cache (should be unique).

appVersion - is the app version of the app. If data are already stored in disk cache with previous app version, it will be invalidate.

Method Detail

enableLog

public Builder<T> enableLog()

Enabling log from the cache. By default disable.

Returns:

the builder.

build

public DualCache<T> build()

Builder the cache. Exception will be thrown if it can not be created.

Returns:

the cache instance.

useSerializerInRam

public Builder<T> useSerializerInRam(int maxRamSizeBytes,
                                     <any> serializer)

Use Json serialization/deserialization to store and retrieve object from ram cache.

Parameters:

maxRamSizeBytes - is the max amount of ram in bytes which can be used by the ram cache.

serializer - is the cache interface which provide serialization/deserialization methods for the ram cache layer.

Returns:

the builder.

useReferenceInRam

public Builder<T> useReferenceInRam(int maxRamSizeBytes,
                                    SizeOf<T> handlerSizeOf)

Store directly objects in ram (without serialization/deserialization). You have to provide a way to compute the size of an object in ram to be able to used the LRU capacity of the ram cache.

Parameters:

maxRamSizeBytes - is the max amount of ram which can be used by the ram cache.

handlerSizeOf - computes the size of object stored in ram.

Returns:

the builder.

noRam

public Builder<T> noRam()

The ram cache will not be used, meaning that only the disk cache will be used.

Returns:

the builder for the disk cache layer.

useSerializerInDisk

public Builder<T> useSerializerInDisk(int maxDiskSizeBytes,
                                      boolean usePrivateFiles,
                                      <any> serializer,
                                      android.content.Context context)

Use custom serialization/deserialization to store and retrieve objects from disk cache.

Parameters:

maxDiskSizeBytes - is the max size of disk in bytes which an be used by the disk cache layer.

usePrivateFiles - is true if you want to use Context.MODE_PRIVATE with the default disk cache folder.

serializer - provides serialization/deserialization methods for the disk cache layer.

context - is used to access file system.

Returns:

the builder.

useSerializerInDisk

public Builder<T> useSerializerInDisk(int maxDiskSizeBytes,
                                      java.io.File diskCacheFolder,
                                      <any> serializer)

Use custom serialization/deserialization to store and retrieve object from disk cache.

Parameters:

maxDiskSizeBytes - is the max size of disk in bytes which an be used by the disk cache layer.

diskCacheFolder - is the folder where the disk cache will be stored.

serializer - provides serialization/deserialization methods for the disk cache layer.

Returns:

the builder.

noDisk

public Builder<T> noDisk()

Use this if you do not want use the disk cache layer, meaning that only the ram cache layer will be used.

Returns:

the builder.