Class DiskLruCache
- java.lang.Object
-
- com.zing.zalo.zbrowser.cache.DiskLruCache
-
- All Implemented Interfaces:
Closeable,AutoCloseable
public final class DiskLruCache extends Object implements Closeable
A cache that uses a bounded amount of space on a filesystem. Each cache entry has a string key and a fixed number of values. Each key must match the regex [a-z0-9_-]{1,120}. Values are byte sequences, accessible as streams or files. Each value must be between0andInteger.MAX_VALUEbytes in length.The cache stores its data in a directory on the filesystem. This directory must be exclusive to the cache; the cache may delete or overwrite files from its directory. It is an error for multiple processes to use the same cache directory at the same time.
This cache limits the number of bytes that it will store on the filesystem. When the number of stored bytes exceeds the limit, the cache will remove entries in the background until the limit is satisfied. The limit is not strict: the cache may temporarily exceed it while waiting for files to be deleted. The limit does not include filesystem overhead or the cache journal so space-sensitive applications should set a conservative limit.
Clients call
edit(java.lang.String)to create or update the values of an entry. An entry may have only one editor at one time; if a value is not available to be edited thenedit(java.lang.String)will return null.- When an entry is being created it is necessary to supply a full set of values; the empty value should be used as a placeholder if necessary.
- When an entry is being edited, it is not necessary to supply data for every value; values default to their previous value.
edit(java.lang.String)call must be matched by a call toDiskLruCache.Editor.commit()orDiskLruCache.Editor.abort(). Committing is atomic: a read observes the full set of values as they were before or after the commit, but never a mix of values.Clients call
get(java.lang.String)to read a snapshot of an entry. The read will observe the value at the time thatget(java.lang.String)was called. Updates and removals after the call do not impact ongoing reads.This class is tolerant of some I/O errors. If files are missing from the filesystem, the corresponding entries will be dropped from the cache. If an error occurs while writing a cache value, the edit will fail silently. Callers should handle other problems by catching
IOExceptionand responding appropriately.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description classDiskLruCache.EditorEdits the values for an entry.classDiskLruCache.SnapshotA snapshot of the values for an entry.static classDiskLruCache.UtilJunk drawer of utility methods.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclear()Deletes all of its stored values.This will delete all files in the cache directory including files that weren't created by the cache.voidclose()Closes this cache.voiddelete()Closes the cache and deletes all of its stored values.DiskLruCache.Editoredit(String key)Returns an editor for the entry namedkey, or null if another edit is in progress.voidflush()Force buffered operations to the filesystem.DiskLruCache.Snapshotget(String key)Returns a snapshot of the entry namedkey, or null if it doesn't exist is not currently readable.FilegetDirectory()Returns the directory where this cache stores its data.longgetMaxSize()Returns the maximum number of bytes that this cache should use to store its data.booleanisClosed()Returns true if this cache has been closed.booleanisGzip()static DiskLruCacheopen(File directory, int appVersion, int valueCount, long maxSize, Map<Integer,DiskLruCache> mapKeyToCache, boolean gzip)Opens the cache indirectory, creating a cache if none exists there.booleanremove(String key)Drops the entry forkeyif it exists and can be removed.voidsetMaxSize(long maxSize)Changes the maximum number of bytes the cache can store and queues a job to trim the existing store, if necessary.longsize()Returns the number of bytes currently being used to store the values in this cache.
-
-
-
Method Detail
-
open
public static DiskLruCache open(File directory, int appVersion, int valueCount, long maxSize, Map<Integer,DiskLruCache> mapKeyToCache, boolean gzip) throws IOException
Opens the cache indirectory, creating a cache if none exists there.- Parameters:
directory- a writable directoryvalueCount- the number of values per cache entry. Must be positive.maxSize- the maximum number of bytes this cache should use to store- Returns:
- DiskLruCache instance
- Throws:
IOException- if reading or writing the cache directory fails
-
isGzip
public boolean isGzip()
-
get
public DiskLruCache.Snapshot get(String key) throws IOException
Returns a snapshot of the entry namedkey, or null if it doesn't exist is not currently readable. If a value is returned, it is moved to the head of the LRU queue.- Throws:
IOException
-
edit
public DiskLruCache.Editor edit(String key) throws IOException
Returns an editor for the entry namedkey, or null if another edit is in progress.- Throws:
IOException
-
getDirectory
public File getDirectory()
Returns the directory where this cache stores its data.
-
getMaxSize
public long getMaxSize()
Returns the maximum number of bytes that this cache should use to store its data.
-
setMaxSize
public void setMaxSize(long maxSize)
Changes the maximum number of bytes the cache can store and queues a job to trim the existing store, if necessary.
-
size
public long size()
Returns the number of bytes currently being used to store the values in this cache. This may be greater than the max size if a background deletion is pending.
-
remove
public boolean remove(String key) throws IOException
Drops the entry forkeyif it exists and can be removed. Entries actively being edited cannot be removed.- Returns:
- true if an entry was removed.
- Throws:
IOException
-
isClosed
public boolean isClosed()
Returns true if this cache has been closed.
-
flush
public void flush() throws IOExceptionForce buffered operations to the filesystem.- Throws:
IOException
-
close
public void close() throws IOExceptionCloses this cache. Stored values will remain on the filesystem.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Throws:
IOException
-
delete
public void delete() throws IOExceptionCloses the cache and deletes all of its stored values. This will delete all files in the cache directory including files that weren't created by the cache.- Throws:
IOException
-
clear
public void clear() throws IOExceptionDeletes all of its stored values.This will delete all files in the cache directory including files that weren't created by the cache. Make the cache empty as newly created- Throws:
IOException
-
-