Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jakewharton/disklrucache

Java implementation of a Disk-based LRU cache which specifically targets Android compatibility.
https://github.com/jakewharton/disklrucache

Last synced: about 1 month ago
JSON representation

Java implementation of a Disk-based LRU cache which specifically targets Android compatibility.

Host: GitHub
URL: https://github.com/jakewharton/disklrucache
Owner: JakeWharton
License: apache-2.0
Archived: true
Created: 2012-01-05T00:36:34.000Z (almost 13 years ago)
Default Branch: master
Last Pushed: 2020-03-02T13:54:37.000Z (over 4 years ago)
Last Synced: 2024-09-26T03:03:07.111Z (about 1 month ago)
Language: Java
Homepage: http://jakewharton.github.io/DiskLruCache
Size: 406 KB
Stars: 5,790
Watchers: 262
Forks: 1,176
Open Issues: 23
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt

Awesome Lists containing this project

README

Disk LRU Cache
==============

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 between `0` and `Integer.MAX_VALUE` bytes 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` 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 then
`edit` 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.

Every `edit` call must be matched by a call to `Editor.commit` or
`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` to read a snapshot of an entry. The read will observe the
value at the time that `get` 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 `IOException` and responding
appropriately.

*Note: This implementation specifically targets Android compatibility.*

Download
========

Download [the latest .jar][jar] or grab via Maven:
```xml

com.jakewharton
disklrucache
2.0.2

```
or Gradle:
```groovy
compile 'com.jakewharton:disklrucache:2.0.2'
```

Snapshots of the development version are available in [Sonatype's `snapshots` repository][snap].

If you would like to compile your own version, the library can be built by
running `mvn clean verify`. The output JAR will be in the `target/` directory.
*(Note: this requires Maven be installed)*

License
=======

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

[jar]: https://search.maven.org/remote_content?g=com.jakewharton&a=disklrucache&v=LATEST
[snap]: https://oss.sonatype.org/content/repositories/snapshots/