
public interface DiskCache

An LRU cache of files.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`DiskCache.Snapshot`	A snapshot of the values for an entry. IMPORTANT: You must only readmetadata or data. Mutating either file can corrupt the disk cache. To modify the contents of those files, use openEditor.
`public interface`	`DiskCache.Editor`	Edits the values for an entry. Calling metadata or data marks that file as dirty so it will be persisted to disk if this editor is committed. IMPORTANT: You must only read or modify the contents of metadata or data. Renaming, locking, or other mutating file operations can corrupt the disk cache.
`public final class`	`DiskCache.Builder`

Method Summary

Modifier and Type	Method	Description
`abstract DiskCache.Snapshot`	`openSnapshot(String key)`	Read the entry associated with key.
`abstract DiskCache.Snapshot`	`get(String key)`
`abstract DiskCache.Editor`	`openEditor(String key)`	Write to the entry associated with key.
`abstract DiskCache.Editor`	`edit(String key)`
`abstract Boolean`	`remove(String key)`	Delete the entry referenced by key.
`abstract Unit`	`clear()`	Delete all entries in the disk cache.
`abstract Long`	`getSize()`	The current size of the cache in bytes.
`abstract Long`	`getMaxSize()`	The maximum size of the cache in bytes.
`abstract Path`	`getDirectory()`	The directory where the cache stores its data.
`abstract FileSystem`	`getFileSystem()`	The file system that contains the cache's files.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - openSnapshot
```
@ExperimentalCoilApi() abstract DiskCache.Snapshot openSnapshot(String key)
```
    Read the entry associated with key.
    IMPORTANT: You must call either Snapshot.close or Snapshot.closeAndOpenEditor when finished reading the snapshot. An open snapshot prevents opening a new Editor or deleting the entry on disk.
  - get
```
@Deprecated(message = Renamed to 'openSnapshot'., replaceWith = @ReplaceWith(imports = {}, expression = openSnapshot(key)))@ExperimentalCoilApi() abstract DiskCache.Snapshot get(String key)
```
  - openEditor
```
@ExperimentalCoilApi() abstract DiskCache.Editor openEditor(String key)
```
    Write to the entry associated with key.
    IMPORTANT: You must call one of Editor.commit, Editor.commitAndOpenSnapshot, or Editor.abort to complete the edit. An open editor prevents opening a new Snapshot, opening a new Editor, or deleting the entry on disk.
  - edit
```
@Deprecated(message = Renamed to 'openEditor'., replaceWith = @ReplaceWith(imports = {}, expression = openEditor(key)))@ExperimentalCoilApi() abstract DiskCache.Editor edit(String key)
```
  - remove
```
@ExperimentalCoilApi() abstract Boolean remove(String key)
```
    Delete the entry referenced by key.
  - clear
```
@ExperimentalCoilApi() abstract Unit clear()
```
    Delete all entries in the disk cache.
  - getSize
```
 abstract Long getSize()
```
    The current size of the cache in bytes.
  - getMaxSize
```
 abstract Long getMaxSize()
```
    The maximum size of the cache in bytes.
  - getDirectory
```
 abstract Path getDirectory()
```
    The directory where the cache stores its data.
  - getFileSystem
```
 abstract FileSystem getFileSystem()
```
    The file system that contains the cache's files.

Interface DiskCache

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

openSnapshot

get

openEditor

edit

remove

clear

getSize

getMaxSize

getDirectory

getFileSystem