com.nostra13.universalimageloader.core.download.ImageDownloader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of universal-image-loader Show documentation

There is a newer version: 1.9.5

Show newest version

/*******************************************************************************
 * Copyright 2011-2013 Sergey Tarasevich
 *
 * 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.
 *******************************************************************************/
package com.nostra13.universalimageloader.core.download;

import java.io.IOException;
import java.io.InputStream;
import java.net.URI;

import com.nostra13.universalimageloader.core.DisplayImageOptions;

/**
 * Provides retrieving of {@link InputStream} of image by URI.

 * Implementations have to be thread-safe.
 * 
 * @author Sergey Tarasevich (nostra13[at]gmail[dot]com)
 * @since 1.4.0
 */
public interface ImageDownloader {

	/// Supported URI schemes(protocols)
	/** {@value} */
	String SCHEME_HTTP = "http";
	/** {@value} */
	String SCHEME_HTTPS = "https";
	/** {@value} */
	String SCHEME_FILE = "file";
	/** {@value} */
	String SCHEME_CONTENT = "content";
	/** {@value} */
	String SCHEME_ASSETS = "assets";
	/** {@value} */
	String SCHEME_DRAWABLE = "drawable";

	/**
	 * Retrieves {@link InputStream} of image by URI.
	 * 
	 * @param imageUri Image URI
	 * @param extra Auxiliary object which was passed to {@link DisplayImageOptions.Builder#extraForDownloader(Object)
	 *            DisplayImageOptions.extraForDownloader(Object)}; can be null
	 * @return {@link InputStream} of image
	 * @throws IOException if some I/O error occurs during getting image stream
	 * @throws UnsupportedOperationException if image URI has unsupported scheme(protocol)
	 */
	InputStream getStream(URI imageUri, Object extra) throws IOException;
}