com.danikula.videocache

Class HttpProxyCacheServer.Builder

java.lang.Object

com.danikula.videocache.HttpProxyCacheServer.Builder

Enclosing class:

HttpProxyCacheServer

public static final class HttpProxyCacheServer.Builder
extends java.lang.Object

Builder for HttpProxyCacheServer.

Constructor Summary

Constructors

Constructor and Description
Builder(android.content.Context context)

Method Summary

Modifier and Type	Method and Description
HttpProxyCacheServer	build() Builds new instance of HttpProxyCacheServer.
HttpProxyCacheServer.Builder	cacheDirectory(java.io.File file) Overrides default cache folder to be used for caching files.
HttpProxyCacheServer.Builder	diskUsage(DiskUsage diskUsage) Set custom DiskUsage logic for handling when to keep or clean cache.
HttpProxyCacheServer.Builder	fileNameGenerator(FileNameGenerator fileNameGenerator) Overrides default cache file name generator Md5FileNameGenerator .
HttpProxyCacheServer.Builder	headerInjector(HeaderInjector headerInjector) Add headers along the request to the server
HttpProxyCacheServer.Builder	maxCacheFilesCount(int count) Sets max cache files count.
HttpProxyCacheServer.Builder	maxCacheSize(long maxSize) Sets max cache size in bytes.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(android.content.Context context)

Method Detail

cacheDirectory

public HttpProxyCacheServer.Builder cacheDirectory(java.io.File file)

Overrides default cache folder to be used for caching files.

By default AndroidVideoCache uses '/Android/data/[app_package_name]/cache/video-cache/' if card is mounted and app has appropriate permission or 'video-cache' subdirectory in default application's cache directory otherwise.

Note directory must be used only for AndroidVideoCache files.

Parameters:

file - a cache directory, can't be null.

Returns:

a builder.

fileNameGenerator

public HttpProxyCacheServer.Builder fileNameGenerator(FileNameGenerator fileNameGenerator)

Overrides default cache file name generator Md5FileNameGenerator .

Parameters:

fileNameGenerator - a new file name generator.

Returns:

a builder.

maxCacheSize

public HttpProxyCacheServer.Builder maxCacheSize(long maxSize)

Sets max cache size in bytes.

All files that exceeds limit will be deleted using LRU strategy. Default value is 512 Mb.

Note this method overrides result of calling maxCacheFilesCount(int)

Parameters:

maxSize - max cache size in bytes.

Returns:

a builder.

maxCacheFilesCount

public HttpProxyCacheServer.Builder maxCacheFilesCount(int count)

Sets max cache files count. All files that exceeds limit will be deleted using LRU strategy. Note this method overrides result of calling maxCacheSize(long)

Parameters:

count - max cache files count.

Returns:

a builder.

diskUsage

public HttpProxyCacheServer.Builder diskUsage(DiskUsage diskUsage)

Set custom DiskUsage logic for handling when to keep or clean cache.

Parameters:

diskUsage - a disk usage strategy, cant be null.

Returns:

a builder.

headerInjector

public HttpProxyCacheServer.Builder headerInjector(HeaderInjector headerInjector)

Add headers along the request to the server

Parameters:

headerInjector - to inject header base on url

Returns:

a builder

build

public HttpProxyCacheServer build()

Builds new instance of HttpProxyCacheServer.

Returns:

proxy cache. Only single instance should be used across whole app.