Merge branch 'master' of https://github.com/nostra13/Android-Universal-Image-Loader

Author: nostra13

README.md

@@ -15,29 +15,71 @@
  *******************************************************************************/
 package com.nostra13.universalimageloader.cache.disc;
 
+import android.graphics.Bitmap;
+import com.nostra13.universalimageloader.utils.IoUtils;
+
 import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
 
 /**
- * Interface for disc cache
+ * Interface for disk cache
  *
  * @author Sergey Tarasevich (nostra13[at]gmail[dot]com)
  * @since 1.0.0
  */
 public interface DiscCacheAware {
+
+	/**
+	 * Returns root directory of disk cache
+	 *
+	 * @return Root directory of disk cache
+	 */
+	File getDirectory();
+
+	/**
+	 * Returns file of cached image
+	 *
+	 * @param imageUri Original image URI
+	 * @return File of cached image or <b>null</b> if image wasn't cached
+	 */
+	File get(String imageUri);
+
+	/**
+	 * Saves image stream in disk cache.
+	 *
+	 * @param imageUri    Original image URI
+	 * @param imageStream Input stream of image
+	 * @param listener    Listener for saving progress, can be ignored if you don't use
+	 *                    {@linkplain com.nostra13.universalimageloader.core.listener.ImageLoadingProgressListener
+	 *                    progress listener} in ImageLoader calls
+	 * @return <b>true</b> - if image was saved successfully; <b>false</b> - if image wasn't saved in disk cache.
+	 * @throws IOException
+	 */
+	boolean save(String imageUri, InputStream imageStream, IoUtils.CopyListener listener) throws IOException;
+
 	/**
-	 * This method must not to save file on file system in fact. It is called after image was cached in cache directory
-	 * and it was decoded to bitmap in memory. Such order is required to prevent possible deletion of file after it was
-	 * cached on disc and before it was tried to decode to bitmap.
+	 * Saves image bitmap in disk cache.
+	 *
+	 * @param imageUri Original image URI
+	 * @param bitmap   Image bitmap
+	 * @return <b>true</b> - if bitmap was saved successfully; <b>false</b> - if bitmap wasn't saved in disk cache.
+	 * @throws IOException
 	 */
-	void put(String key, File file);
+	boolean save(String imageUri, Bitmap bitmap) throws IOException;
 
 	/**
-	 * Returns {@linkplain File file object} appropriate incoming key.<br />
-	 * <b>NOTE:</b> Must <b>not to return</b> a null. Method must return specific {@linkplain File file object} for
-	 * incoming key whether file exists or not.
+	 * Removes image file associated with incoming URI
+	 *
+	 * @param imageUri Image URI
+	 * @return <b>true</b> - if image file is deleted successfully; <b>false</b> - if image file doesn't exist for
+	 * incoming URI or image file can't be deleted.
 	 */
-	File get(String key);
+	boolean remove(String imageUri);
+
+	/** Closes disk cache, releases resources. */
+	void close();
 
-	/** Clears cache directory */
+	/** Clears disk cache. */
 	void clear();
 }