jodd.cache

Class FileCache

java.lang.Object

jodd.cache.FileCache

Direct Known Subclasses:

FileLFUCache, FileLRUCache

public abstract class FileCache
extends java.lang.Object

Base in-memory files cache.

Field Summary

Fields

Modifier and Type	Field and Description
protected Cache<java.io.File,byte[]>	cache
protected int	maxFileSize
protected int	maxSize
protected long	timeout
protected int	usedSize

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileCache(int maxSize, int maxFileSize, long timeout) Creates new File LFU cache.

Method Summary

Modifier and Type	Method and Description
int	cachedFilesCount() Returns number of cached files.
long	cacheTimeout() Returns timeout.
void	clear() Clears the cache.
protected abstract Cache<java.io.File,byte[]>	createCache() Creates new cache instance for files content.
protected jodd.cache.AbstractCacheMap.CacheObject<java.io.File,byte[]>	createFileCacheObject(java.io.File fileKey, byte[] object, long timeout) Creates CacheObject that updates last access time based on files last modification.
byte[]	getFileBytes(java.io.File file) Returns cached file bytes.
int	maxFileSize() Returns maximum allowed file size that can be added to the cache.
int	maxSize() Returns max cache size in bytes.
int	usedSize() Returns actually used size in bytes.

Methods inherited from class java.lang.Object

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

Field Detail

cache

protected final Cache<java.io.File,byte[]> cache

maxSize

protected final int maxSize

maxFileSize

protected final int maxFileSize

timeout

protected final long timeout

usedSize

protected int usedSize

Constructor Detail

FileCache

protected FileCache(int maxSize,
                    int maxFileSize,
                    long timeout)

Creates new File LFU cache.

Parameters:

maxSize - total cache size in bytes

maxFileSize - max available file size in bytes, may be 0

timeout - timeout, may be 0

Method Detail

createCache

protected abstract Cache<java.io.File,byte[]> createCache()

Creates new cache instance for files content.

createFileCacheObject

protected jodd.cache.AbstractCacheMap.CacheObject<java.io.File,byte[]> createFileCacheObject(java.io.File fileKey,
                                                                                             byte[] object,
                                                                                             long timeout)

Creates CacheObject that updates last access time based on files last modification.

maxSize

public int maxSize()

Returns max cache size in bytes.

usedSize

public int usedSize()

Returns actually used size in bytes.

maxFileSize

public int maxFileSize()

Returns maximum allowed file size that can be added to the cache. Files larger than this value will be not added, even if there is enough room.

cachedFilesCount

public int cachedFilesCount()

Returns number of cached files.

cacheTimeout

public long cacheTimeout()

Returns timeout.

clear

public void clear()

Clears the cache.

getFileBytes

public byte[] getFileBytes(java.io.File file)
                    throws java.io.IOException

Returns cached file bytes. If file is not cached it will be read and put in the cache (if all the rules are satisfied).

Throws:

java.io.IOException