com.hannesdorfmann.httpkit.cache

Interface DiskCache<K,V>

All Superinterfaces:

SubCache<K,V>

All Known Implementing Classes:

AllLruDiskCache, LruDiskCache

public interface DiskCache<K,V>
extends SubCache<K,V>

A DiskCache is like the name suggests responsible to write data on the disk. You can assume that writing and reading from DiskCache will be run in an own thread and therefore the operations should be blocking

Author:

Hannes Dorfmann

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)
boolean	isForMimeType(String mimeType) Determines if the the cache implementation can store values of the given mime type
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[] bytes, String mimeType, String charsetEncoding, long expirationTimeStamp, String eTag) Put as raw bytes
void	setParserWriterPool(ParserWriterPool pool) Used to give the disk cache all available ParserWriters to read or write data

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

remove, updateExpirationTimestamp

Method Detail

setParserWriterPool

void setParserWriterPool(ParserWriterPool pool)

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

Parameters:

pool -

get

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

Throws:

Exception

clear

void clear()
           throws IOException

Cleans the cache, by removing all cache entries

Throws:

IOException

put

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

Adds and create a new CacheEntry to the cache.

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

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

Put as raw bytes

Parameters:

key -

bytes -

mimeType -

charsetEncoding -

expirationTimeStamp -

eTag -

Throws:

Exception

isForMimeType

boolean isForMimeType(String mimeType)

Determines if the the cache implementation can store values of the given mime type

Parameters:

mimeType -

Returns: