com.hannesdorfmann.httpkit.cache

Class LruDiskCache<K,V>

java.lang.Object

com.hannesdorfmann.httpkit.cache.LruDiskCache<K,V>

All Implemented Interfaces:

DiskCache<K,V>, SubCache<K,V>

Direct Known Subclasses:

AllLruDiskCache

public abstract class LruDiskCache<K,V>
extends Object
implements DiskCache<K,V>

Created by Hannes Dorfmann on 25.03.14.

Constructor Summary

Constructors

Constructor and Description
LruDiskCache(File directory, int appVersion, long maxSize)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Cleans the cache, by removing all cache entries
CacheEntry<V>	get(K key, Class<?> targetClass, int collectionType)
void	put(K key, V value, String mimeType, String charsetEncoding, long expirationTimeStamp, String eTag) Adds and create a new CacheEntry to the cache.
void	putRaw(K key, byte[] value, String mimeType, String charsetEncoding, long expirationTimeStamp, String eTag) Put as raw bytes
void	remove(K key) Removes the Entry
void	setParserWriterPool(ParserWriterPool pool) Used to give the disk cache all available ParserWriters to read or write data
void	updateExpirationTimestamp(K key, long expirationTimestamp) Will be called to update an expiration timestamp.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hannesdorfmann.httpkit.cache.DiskCache

isForMimeType

Constructor Detail

LruDiskCache

public LruDiskCache(File directory,
            int appVersion,
            long maxSize)
             throws IOException

Throws:

IOException

Method Detail

setParserWriterPool

public void setParserWriterPool(ParserWriterPool pool)

Description copied from interface: DiskCache

Used to give the disk cache all available ParserWriters to read or write data

Specified by:

setParserWriterPool in interface DiskCache<K,V>

put

public void put(K key,
       V value,
       String mimeType,
       String charsetEncoding,
       long expirationTimeStamp,
       String eTag)
         throws Exception

Description copied from interface: DiskCache

Adds and create a new CacheEntry to the cache.

Specified by:

put in interface DiskCache<K,V>

Parameters:

key - The key

value - The Value for the given key

mimeType - The mime type of the value. This is important to find the correct parser for the stored cache value

charsetEncoding - The charset like, UTF-8 etc. that i used, to encode the string content (is useless for binary data)

expirationTimeStamp - The expiration value

eTag - The ETag

Throws:

Exception

putRaw

public void putRaw(K key,
          byte[] value,
          String mimeType,
          String charsetEncoding,
          long expirationTimeStamp,
          String eTag)
            throws Exception

Description copied from interface: DiskCache

Put as raw bytes

Specified by:

putRaw in interface DiskCache<K,V>

Throws:

Exception

remove

public void remove(K key)
            throws IOException

Description copied from interface: SubCache

Removes the Entry

Specified by:

remove in interface SubCache<K,V>

Throws:

IOException

clear

public void clear()
           throws IOException

Description copied from interface: DiskCache

Cleans the cache, by removing all cache entries

Specified by:

clear in interface DiskCache<K,V>

Throws:

IOException

get

public CacheEntry<V> get(K key,
                Class<?> targetClass,
                int collectionType)
                  throws Exception

Specified by:

get in interface DiskCache<K,V>

Throws:

Exception

updateExpirationTimestamp

public void updateExpirationTimestamp(K key,
                             long expirationTimestamp)

Description copied from interface: SubCache

Will be called to update an expiration timestamp. Should not throw an exception, because we assume that expiration timestamp will always be extended to a date longer in the future. Therefore on failing the old expiration will not be renewed and the cache entry will expire. Hence in worst case retrieving the value from server will be needed. That's acceptable.

Specified by:

updateExpirationTimestamp in interface SubCache<K,V>