Skip to content

Commit 5e24759

Browse files
JakeWhartonJakeWharton
committed
Initial commit.
0 parents  commit 5e24759

File tree

7 files changed

+1583
-0
lines changed

7 files changed

+1583
-0
lines changed

‎.gitignore‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
#Eclipse
2+
.project
3+
.classpath
4+
.settings
5+
.checkstyle
6+
7+
#IntelliJ IDEA
8+
.idea
9+
*.iml
10+
*.ipr
11+
*.iws
12+
13+
#Maven
14+
target
15+
release.properties
16+
pom.xml.*
17+
18+
#OSX
19+
.DS_Store

‎CHANGELOG.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Change Log
2+
==========
3+
4+
Version 1.0.0 *(In Development)*
5+
--------------------------------
6+
7+
Initial version.

‎LICENSE.txt‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.md‎

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
Disk LRU Cache
2+
==============
3+
4+
A cache that uses a bounded amount of space on a filesystem. Each cache entry
5+
has a string key and a fixed number of values. Values are byte sequences,
6+
accessible as streams or files. Each value must be between `0` and
7+
`Integer.MAX_VALUE` bytes in length.
8+
9+
The cache stores its data in a directory on the filesystem. This directory must
10+
be exclusive to the cache; the cache may delete or overwrite files from its
11+
directory. It is an error for multiple processes to use the same cache
12+
directory at the same time.
13+
14+
This cache limits the number of bytes that it will store on the filesystem.
15+
When the number of stored bytes exceeds the limit, the cache will remove
16+
entries in the background until the limit is satisfied. The limit is not
17+
strict: the cache may temporarily exceed it while waiting for files to be
18+
deleted. The limit does not include filesystem overhead or the cache journal so
19+
space-sensitive applications should set a conservative limit.
20+
21+
Clients call `edit` to create or update the values of an entry. An entry may
22+
have only one editor at one time; if a value is not available to be edited then
23+
`edit` will return null.
24+
25+
* When an entry is being **created** it is necessary to supply a full set of
26+
values; the empty value should be used as a placeholder if necessary.
27+
* When an entry is being **edited**, it is not necessary to supply data for
28+
every value; values default to their previous value.
29+
30+
Every `edit` call must be matched by a call to `Editor.commit` or
31+
`Editor.abort`. Committing is atomic: a read observes the full set of values as
32+
they were before or after the commit, but never a mix of values.
33+
34+
Clients call `get` to read a snapshot of an entry. The read will observe the
35+
value at the time that `get` was called. Updates and removals after the call do
36+
not impact ongoing reads.
37+
38+
This class is tolerant of some I/O errors. If files are missing from the
39+
filesystem, the corresponding entries will be dropped from the cache. If an
40+
error occurs while writing a cache value, the edit will fail silently. Callers
41+
should handle other problems by catching `IOException` and responding
42+
appropriately.
43+
44+
*Note: This implementation specifically targets Android compatibility.*
45+
46+
47+
API
48+
---
49+
50+
* `public static DiskLruCache open(File directory, int appVersion, int valueCount, long maxSize)`
51+
52+
Opens the cache in `directory`, creating a cache if none exists there.
53+
54+
Params:
55+
56+
* `directory` - a writable directory
57+
* `appVersion`
58+
* `valueCount` - the number of values per cache entry. Must be positive.
59+
* `maxSize` - the maximum number of bytes this cache should use to store
60+
61+
Throws:
62+
63+
* `IOException` - if reading or writing the cache directory fails
64+
65+
* `public Snapshot get(String key)`
66+
67+
Returns a snapshot of the entry named `key`, or null if it doesn't exist is
68+
not currently readable. If a value is returned, it is moved to the head of
69+
the LRU queue.
70+
71+
Throws:
72+
73+
* `IOException`
74+
75+
* `public Editor edit(String key)`
76+
77+
Returns an editor for the entry named `key`, or `null` if it cannot
78+
currently be edited.
79+
80+
Throws:
81+
82+
* `IOException`
83+
84+
* `public File getDirectory()`
85+
86+
Returns the directory where this cache stores its data.
87+
88+
* `public long maxSize()`
89+
90+
Returns the maximum number of bytes that this cache should use to store its
91+
data.
92+
93+
* `public long size()`
94+
95+
Returns the number of bytes currently being used to store the values in
96+
this cache. This may be greater than the max size if a background deletion
97+
is pending.
98+
99+
* `public boolean remove(String key)`
100+
101+
Drops the entry for {@code key} if it exists and can be removed. Entries
102+
actively being edited cannot be removed.
103+
104+
Returns: `true` if an entry was removed
105+
106+
Throws:
107+
108+
* `IOException`
109+
110+
* `public boolean isClosed()`
111+
112+
Returns `true` if this cache has been closed.
113+
114+
* `public void flush()`
115+
116+
Force buffered operations to the filesystem.
117+
118+
Throws;
119+
120+
* `IOException`
121+
122+
* `public void delete()`
123+
124+
Closes the cache and deletes all of its stored values. This will delete all
125+
files in the cache directory including files that weren't created by the
126+
cache.
127+
128+
Throws:
129+
130+
* `IOException`
131+
132+
133+
134+
Developed By
135+
============
136+
137+
* Jake Wharton - <jakewharton@gmail.com>
138+
139+
140+
141+
License
142+
=======
143+
144+
Copyright 2012 Jake Wharton
145+
Copyright 2011 The Android Open Source Project
146+
147+
Licensed under the Apache License, Version 2.0 (the "License");
148+
you may not use this file except in compliance with the License.
149+
You may obtain a copy of the License at
150+
151+
http://www.apache.org/licenses/LICENSE-2.0
152+
153+
Unless required by applicable law or agreed to in writing, software
154+
distributed under the License is distributed on an "AS IS" BASIS,
155+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
156+
See the License for the specific language governing permissions and
157+
limitations under the License.

0 commit comments

Comments
 (0)