org.aoju.bus.http.cache

Class DiskLruCache

java.lang.Object

org.aoju.bus.http.cache.DiskLruCache

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public final class DiskLruCache
extends Object
implements Closeable, Flushable

使用文件系统上有限空间的缓存。每个缓存条目都有一个字符串键和固定数量的值 每个键必须匹配regex [a-z0-9_-]{1,64}。值是字节序列，可以作为流或文件访问 每个值必须在0和Integer之间。MAX_VALUE字节的长度

Since:

JDK 1.8+

Version:

5.5.9

Author:

Kimi Liu

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DiskLruCache.Editor
class	DiskLruCache.Snapshot 快照信息

Method Summary

Modifier and Type	Method and Description
void	close()
static DiskLruCache	create(FileSystem fileSystem, File directory, int appVersion, int valueCount, long maxSize) 创建一个驻留在directory中的缓存。此缓存在第一次访问时惰性初始化，如果它不存在，将创建它.
void	delete() 关闭缓存并删除其所有存储值。这将删除缓存目录中的所有文件，包括没有由缓存创建的文件
DiskLruCache.Editor	edit(String key) 返回名为key的条目的编辑器，如果另一个编辑正在进行，则返回null
void	evictAll() 从缓存中删除所有存储值,飞行中的编辑将正常完成，但不会存储它们的值
void	flush()
DiskLruCache.Snapshot	get(String key) 返回名为key的条目的快照，如果条目不存在，则返回null， 否则当前无法读取。如果返回一个值，它将被移动到LRU队列的头部
File	getDirectory()
long	getMaxSize()
void	initialize()
boolean	isClosed()
boolean	remove(String key) 如果key存在并且可以删除，则删除它。如果当前正在编辑 key的条目，那么编辑将正常完成，但是它的值不会被存储
void	setMaxSize(long maxSize) 更改缓存可以存储的最大字节数，并在必要时对作业进行排队，以修剪现有存储
long	size()
Iterator<DiskLruCache.Snapshot>	snapshots() 返回缓存当前项的迭代器。这个迭代器不会抛出ConcurrentModificationException， 调用者必须DiskLruCache.Snapshot.close()每个由Iterator.next()返回的快照 如果做不到这一点，就会泄漏打开的文件,返回的迭代器支持 Iterator.remove().

Methods inherited from class java.lang.Object

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

Method Detail

create

public static DiskLruCache create(FileSystem fileSystem,
                                  File directory,
                                  int appVersion,
                                  int valueCount,
                                  long maxSize)

创建一个驻留在directory中的缓存。此缓存在第一次访问时惰性初始化，如果它不存在，将创建它.

Parameters:

fileSystem - 读写文件

directory - 一个可写目录

appVersion - 版本信息

valueCount - 每个缓存条目的值数目.

maxSize - 此缓存应用于存储的最大字节数

Returns:

the disk cache

initialize

public void initialize()
                throws IOException

Throws:

IOException

get

public DiskLruCache.Snapshot get(String key)
                          throws IOException

返回名为key的条目的快照，如果条目不存在，则返回null， 否则当前无法读取。如果返回一个值，它将被移动到LRU队列的头部

Parameters:

key - 缓存key

Returns:

the 快照信息

Throws:

IOException - 异常

edit

public DiskLruCache.Editor edit(String key)
                         throws IOException

返回名为key的条目的编辑器，如果另一个编辑正在进行，则返回null

Parameters:

key - 文件key

Returns:

编辑器

Throws:

IOException - 异常

getDirectory

public File getDirectory()

getMaxSize

public long getMaxSize()

setMaxSize

public void setMaxSize(long maxSize)

更改缓存可以存储的最大字节数，并在必要时对作业进行排队，以修剪现有存储

Parameters:

maxSize - 最大值

size

public long size()
          throws IOException

Throws:

IOException

remove

public boolean remove(String key)
               throws IOException

如果key存在并且可以删除，则删除它。如果当前正在编辑 key的条目，那么编辑将正常完成，但是它的值不会被存储

Parameters:

key - 缓存key

Returns:

如果一个条目被删除，则为真

Throws:

IOException - 异常

isClosed

public boolean isClosed()

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

delete

public void delete()
            throws IOException

关闭缓存并删除其所有存储值。这将删除缓存目录中的所有文件，包括没有由缓存创建的文件

Throws:

IOException - 异常

evictAll

public void evictAll()
              throws IOException

从缓存中删除所有存储值,飞行中的编辑将正常完成，但不会存储它们的值

Throws:

IOException - 异常

snapshots

public Iterator<DiskLruCache.Snapshot> snapshots()
                                          throws IOException

返回缓存当前项的迭代器。这个迭代器不会抛出ConcurrentModificationException， 调用者必须DiskLruCache.Snapshot.close()每个由Iterator.next()返回的快照 如果做不到这一点，就会泄漏打开的文件,返回的迭代器支持 Iterator.remove().

Returns:

返回迭代器

Throws:

IOException - 异常