|
1 /* |
|
2 * Copyright (C) 2013 Square, Inc. |
|
3 * |
|
4 * Licensed under the Apache License, Version 2.0 (the "License"); |
|
5 * you may not use this file except in compliance with the License. |
|
6 * You may obtain a copy of the License at |
|
7 * |
|
8 * http://www.apache.org/licenses/LICENSE-2.0 |
|
9 * |
|
10 * Unless required by applicable law or agreed to in writing, software |
|
11 * distributed under the License is distributed on an "AS IS" BASIS, |
|
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|
13 * See the License for the specific language governing permissions and |
|
14 * limitations under the License. |
|
15 */ |
|
16 package com.squareup.picasso; |
|
17 |
|
18 import android.graphics.Bitmap; |
|
19 |
|
20 /** |
|
21 * A memory cache for storing the most recently used images. |
|
22 * <p/> |
|
23 * <em>Note:</em> The {@link Cache} is accessed by multiple threads. You must ensure |
|
24 * your {@link Cache} implementation is thread safe when {@link Cache#get(String)} or {@link |
|
25 * Cache#set(String, android.graphics.Bitmap)} is called. |
|
26 */ |
|
27 public interface Cache { |
|
28 /** Retrieve an image for the specified {@code key} or {@code null}. */ |
|
29 Bitmap get(String key); |
|
30 |
|
31 /** Store an image in the cache for the specified {@code key}. */ |
|
32 void set(String key, Bitmap bitmap); |
|
33 |
|
34 /** Returns the current size of the cache in bytes. */ |
|
35 int size(); |
|
36 |
|
37 /** Returns the maximum size in bytes that the cache can hold. */ |
|
38 int maxSize(); |
|
39 |
|
40 /** Clears the cache. */ |
|
41 void clear(); |
|
42 |
|
43 /** A cache which does not store any values. */ |
|
44 Cache NONE = new Cache() { |
|
45 @Override public Bitmap get(String key) { |
|
46 return null; |
|
47 } |
|
48 |
|
49 @Override public void set(String key, Bitmap bitmap) { |
|
50 // Ignore. |
|
51 } |
|
52 |
|
53 @Override public int size() { |
|
54 return 0; |
|
55 } |
|
56 |
|
57 @Override public int maxSize() { |
|
58 return 0; |
|
59 } |
|
60 |
|
61 @Override public void clear() { |
|
62 } |
|
63 }; |
|
64 } |