mobile/android/thirdparty/com/squareup/picasso/Downloader.java@6474c204b198 (annotated)
mobile/android/thirdparty/com/squareup/picasso/Downloader.java
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | /* |
| michael@0 | 2 | * Copyright (C) 2013 Square, Inc. |
| michael@0 | 3 | * |
| michael@0 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| michael@0 | 5 | * you may not use this file except in compliance with the License. |
| michael@0 | 6 | * You may obtain a copy of the License at |
| michael@0 | 7 | * |
| michael@0 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| michael@0 | 9 | * |
| michael@0 | 10 | * Unless required by applicable law or agreed to in writing, software |
| michael@0 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| michael@0 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| michael@0 | 13 | * See the License for the specific language governing permissions and |
| michael@0 | 14 | * limitations under the License. |
| michael@0 | 15 | */ |
| michael@0 | 16 | package com.squareup.picasso; |
| michael@0 | 17 | |
| michael@0 | 18 | import android.graphics.Bitmap; |
| michael@0 | 19 | import android.net.Uri; |
| michael@0 | 20 | import java.io.IOException; |
| michael@0 | 21 | import java.io.InputStream; |
| michael@0 | 22 | |
| michael@0 | 23 | /** A mechanism to load images from external resources such as a disk cache and/or the internet. */ |
| michael@0 | 24 | public interface Downloader { |
| michael@0 | 25 | /** |
| michael@0 | 26 | * Download the specified image {@code url} from the internet. |
| michael@0 | 27 | * |
| michael@0 | 28 | * @param uri Remote image URL. |
| michael@0 | 29 | * @param localCacheOnly If {@code true} the URL should only be loaded if available in a local |
| michael@0 | 30 | * disk cache. |
| michael@0 | 31 | * @return {@link Response} containing either a {@link Bitmap} representation of the request or an |
| michael@0 | 32 | * {@link InputStream} for the image data. {@code null} can be returned to indicate a problem |
| michael@0 | 33 | * loading the bitmap. |
| michael@0 | 34 | * @throws IOException if the requested URL cannot successfully be loaded. |
| michael@0 | 35 | */ |
| michael@0 | 36 | Response load(Uri uri, boolean localCacheOnly) throws IOException; |
| michael@0 | 37 | |
| michael@0 | 38 | /** Thrown for non-2XX responses. */ |
| michael@0 | 39 | class ResponseException extends IOException { |
| michael@0 | 40 | public ResponseException(String message) { |
| michael@0 | 41 | super(message); |
| michael@0 | 42 | } |
| michael@0 | 43 | } |
| michael@0 | 44 | |
| michael@0 | 45 | /** Response stream or bitmap and info. */ |
| michael@0 | 46 | class Response { |
| michael@0 | 47 | final InputStream stream; |
| michael@0 | 48 | final Bitmap bitmap; |
| michael@0 | 49 | final boolean cached; |
| michael@0 | 50 | |
| michael@0 | 51 | /** |
| michael@0 | 52 | * Response image and info. |
| michael@0 | 53 | * |
| michael@0 | 54 | * @param bitmap Image. |
| michael@0 | 55 | * @param loadedFromCache {@code true} if the source of the image is from a local disk cache. |
| michael@0 | 56 | */ |
| michael@0 | 57 | public Response(Bitmap bitmap, boolean loadedFromCache) { |
| michael@0 | 58 | if (bitmap == null) { |
| michael@0 | 59 | throw new IllegalArgumentException("Bitmap may not be null."); |
| michael@0 | 60 | } |
| michael@0 | 61 | this.stream = null; |
| michael@0 | 62 | this.bitmap = bitmap; |
| michael@0 | 63 | this.cached = loadedFromCache; |
| michael@0 | 64 | } |
| michael@0 | 65 | |
| michael@0 | 66 | /** |
| michael@0 | 67 | * Response stream and info. |
| michael@0 | 68 | * |
| michael@0 | 69 | * @param stream Image data stream. |
| michael@0 | 70 | * @param loadedFromCache {@code true} if the source of the stream is from a local disk cache. |
| michael@0 | 71 | */ |
| michael@0 | 72 | public Response(InputStream stream, boolean loadedFromCache) { |
| michael@0 | 73 | if (stream == null) { |
| michael@0 | 74 | throw new IllegalArgumentException("Stream may not be null."); |
| michael@0 | 75 | } |
| michael@0 | 76 | this.stream = stream; |
| michael@0 | 77 | this.bitmap = null; |
| michael@0 | 78 | this.cached = loadedFromCache; |
| michael@0 | 79 | } |
| michael@0 | 80 | |
| michael@0 | 81 | /** |
| michael@0 | 82 | * Input stream containing image data. |
| michael@0 | 83 | * <p> |
| michael@0 | 84 | * If this returns {@code null}, image data will be available via {@link #getBitmap()}. |
| michael@0 | 85 | */ |
| michael@0 | 86 | public InputStream getInputStream() { |
| michael@0 | 87 | return stream; |
| michael@0 | 88 | } |
| michael@0 | 89 | |
| michael@0 | 90 | /** |
| michael@0 | 91 | * Bitmap representing the image. |
| michael@0 | 92 | * <p> |
| michael@0 | 93 | * If this returns {@code null}, image data will be available via {@link #getInputStream()}. |
| michael@0 | 94 | */ |
| michael@0 | 95 | public Bitmap getBitmap() { |
| michael@0 | 96 | return bitmap; |
| michael@0 | 97 | } |
| michael@0 | 98 | } |
| michael@0 | 99 | } |
