Add getSource() to CacheableBitmapDrawable

Chris Banes · Chris Banes · commit 4b94da8946ca · 2013-08-02T13:50:43.000+01:00
diff --git a/library/src/uk/co/senab/bitmapcache/BitmapLruCache.java b/library/src/uk/co/senab/bitmapcache/BitmapLruCache.java
@@ -269,11 +269,9 @@ public CacheableBitmapDrawable getFromDiskCache(final String url,
             try {
                 final String key = transformUrlForDiskCacheKey(url);
                 // Try and decode bitmap
-                Bitmap bitmap = decodeBitmap(new SnapshotInputStreamProvider(key), decodeOpts);
+                result = decodeBitmap(new SnapshotInputStreamProvider(key), url, decodeOpts);
 
-                if (null != bitmap) {
-                    result = new CacheableBitmapDrawable(url, mResources, bitmap,
-                            mRecyclePolicy);
+                if (null != result) {
                     if (null != mMemoryCache) {
                         mMemoryCache.put(result);
                     }
@@ -362,7 +360,7 @@ public CacheableBitmapDrawable put(final String url, final Bitmap bitmap,
             Bitmap.CompressFormat compressFormat, int compressQuality) {
 
         CacheableBitmapDrawable d = new CacheableBitmapDrawable(url, mResources, bitmap,
-                mRecyclePolicy);
+                mRecyclePolicy, CacheableBitmapDrawable.SOURCE_UNKNOWN);
 
         if (null != mMemoryCache) {
             mMemoryCache.put(d);
@@ -448,11 +446,9 @@ public CacheableBitmapDrawable put(final String url, final InputStream inputStre
 
         if (null != tmpFile) {
             // Try and decode File
-            Bitmap bitmap = decodeBitmap(new FileInputStreamProvider(tmpFile), decodeOpts);
-
-            if (null != bitmap) {
-                d = new CacheableBitmapDrawable(url, mResources, bitmap, mRecyclePolicy);
+            d = decodeBitmap(new FileInputStreamProvider(tmpFile), url, decodeOpts);
 
+            if (d != null) {
                 if (null != mMemoryCache) {
                     d.setCached(true);
                     mMemoryCache.put(d.getUrl(), d);
@@ -553,9 +549,12 @@ private void scheduleDiskCacheFlush() {
                         TimeUnit.SECONDS);
     }
 
-    private Bitmap decodeBitmap(InputStreamProvider ip, BitmapFactory.Options opts) {
+    private CacheableBitmapDrawable decodeBitmap(InputStreamProvider ip, String url,
+            BitmapFactory.Options opts) {
+
         Bitmap bm = null;
         InputStream is = null;
+        int source = CacheableBitmapDrawable.SOURCE_NEW;
 
         try {
             if (mRecyclePolicy.canInBitmap()) {
@@ -566,7 +565,10 @@ private Bitmap decodeBitmap(InputStreamProvider ip, BitmapFactory.Options opts)
 
                 if (opts.inSampleSize <= 1) {
                     opts.inSampleSize = 1;
-                    addInBitmapOptions(ip, opts);
+
+                    if (addInBitmapOptions(ip, opts)) {
+                        source = CacheableBitmapDrawable.SOURCE_INBITMAP;
+                    }
                 }
             }
 
@@ -579,10 +581,14 @@ private Bitmap decodeBitmap(InputStreamProvider ip, BitmapFactory.Options opts)
         } finally {
             IoUtils.closeStream(is);
         }
-        return bm;
+
+        if (bm != null) {
+            return new CacheableBitmapDrawable(url, mResources, bm, mRecyclePolicy, source);
+        }
+        return null;
     }
 
-    private void addInBitmapOptions(InputStreamProvider ip, BitmapFactory.Options opts) {
+    private boolean addInBitmapOptions(InputStreamProvider ip, BitmapFactory.Options opts) {
         // Create InputStream for decoding the bounds
         final InputStream is = ip.getInputStream();
         // Decode the bounds so we know what size Bitmap to look for
@@ -602,7 +608,10 @@ private void addInBitmapOptions(InputStreamProvider ip, BitmapFactory.Options op
                 Log.i(Constants.LOG_TAG, "Using inBitmap");
             }
             SDK11.addInBitmapOption(opts, reusableBm);
+            return true;
         }
+
+        return false;
     }
 
     /**
diff --git a/library/src/uk/co/senab/bitmapcache/CacheableBitmapDrawable.java b/library/src/uk/co/senab/bitmapcache/CacheableBitmapDrawable.java
@@ -26,6 +26,10 @@
 
 public class CacheableBitmapDrawable extends BitmapDrawable {
 
+    public static final int SOURCE_UNKNOWN = -1;
+    public static final int SOURCE_NEW = 0;
+    public static final int SOURCE_INBITMAP = 1;
+
     static final String LOG_TAG = "CacheableBitmapDrawable";
 
     // URL Associated with this Bitmap
@@ -53,15 +57,18 @@ public class CacheableBitmapDrawable extends BitmapDrawable {
 
     private final int mMemorySize;
 
+    private final int mSource;
+
     CacheableBitmapDrawable(String url, Resources resources, Bitmap bitmap,
-            BitmapLruCache.RecyclePolicy recyclePolicy) {
+            BitmapLruCache.RecyclePolicy recyclePolicy, int source) {
         super(resources, bitmap);
 
         mMemorySize = null != bitmap ? (bitmap.getRowBytes() * bitmap.getHeight()) : 0;
         mUrl = url;
         mRecyclePolicy = recyclePolicy;
         mDisplayingCount = 0;
         mCacheCount = 0;
+        mSource = source;
     }
 
     @Override
@@ -94,6 +101,14 @@ public String getUrl() {
         return mUrl;
     }
 
+    /**
+     * @return One of {@link #SOURCE_NEW}, {@link #SOURCE_INBITMAP} or {@link #SOURCE_UNKNOWN}
+     * depending on how this Bitmap was created.
+     */
+    public int getSource() {
+        return mSource;
+    }
+
     /**
      * Returns true when this wrapper has a bitmap and the bitmap has not been recycled.
      *
diff --git a/sample/res/values/colors.xml b/sample/res/values/colors.xml
@@ -3,5 +3,6 @@
 
     <color name="translucent_red">#CCff4444</color>
     <color name="translucent_green">#CC99cc00</color>
+    <color name="translucent_blue">#CC33B5E5</color>
 
 </resources>
diff --git a/sample/src/uk/co/senab/bitmapcache/samples/NetworkedCacheableImageView.java b/sample/src/uk/co/senab/bitmapcache/samples/NetworkedCacheableImageView.java
@@ -46,6 +46,10 @@
  */
 public class NetworkedCacheableImageView extends CacheableImageView {
 
+    public interface OnImageLoadedListener {
+        void onImageLoaded(CacheableBitmapDrawable result);
+    }
+
     /**
      * This task simply fetches an Bitmap from the specified URL and wraps it in a wrapper. This
      * implementation is NOT 'best practice' or production ready code.
@@ -56,13 +60,15 @@ private static class ImageUrlAsyncTask
         private final BitmapLruCache mCache;
 
         private final WeakReference<ImageView> mImageViewRef;
+        private final OnImageLoadedListener mListener;
 
         private final BitmapFactory.Options mDecodeOpts;
 
         ImageUrlAsyncTask(ImageView imageView, BitmapLruCache cache,
-                BitmapFactory.Options decodeOpts) {
+                BitmapFactory.Options decodeOpts, OnImageLoadedListener listener) {
             mCache = cache;
             mImageViewRef = new WeakReference<ImageView>(imageView);
+            mListener = listener;
             mDecodeOpts = decodeOpts;
         }
 
@@ -109,6 +115,10 @@ protected void onPostExecute(CacheableBitmapDrawable result) {
             if (null != iv) {
                 iv.setImageDrawable(result);
             }
+
+            if (null != mListener) {
+                mListener.onImageLoaded(result);
+            }
         }
     }
 
@@ -128,7 +138,7 @@ public NetworkedCacheableImageView(Context context, AttributeSet attrs) {
      * @param fullSize - Whether the image should be kept at the original size
      * @return true if the bitmap was found in the cache
      */
-    public boolean loadImage(String url, final boolean fullSize) {
+    public boolean loadImage(String url, final boolean fullSize, OnImageLoadedListener listener) {
         // First check whether there's already a task running, if so cancel it
         if (null != mCurrentTask) {
             mCurrentTask.cancel(true);
@@ -154,7 +164,7 @@ public boolean loadImage(String url, final boolean fullSize) {
                 //decodeOpts.inSampleSize = 2;
             }
 
-            mCurrentTask = new ImageUrlAsyncTask(this, mCache, decodeOpts);
+            mCurrentTask = new ImageUrlAsyncTask(this, mCache, decodeOpts, listener);
 
             try {
                 if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB) {
diff --git a/sample/src/uk/co/senab/bitmapcache/samples/PugListAdapter.java b/sample/src/uk/co/senab/bitmapcache/samples/PugListAdapter.java
@@ -22,8 +22,11 @@
 import android.widget.BaseAdapter;
 import android.widget.TextView;
 
+import java.lang.ref.WeakReference;
 import java.util.ArrayList;
 
+import uk.co.senab.bitmapcache.CacheableBitmapDrawable;
+
 public class PugListAdapter extends BaseAdapter {
 
     private final ArrayList<String> mPugUrls;
@@ -61,17 +64,53 @@ public View getView(int position, View convertView, ViewGroup parent) {
                 .findViewById(R.id.nciv_pug);
         TextView status = (TextView) convertView.findViewById(R.id.tv_status);
 
-        final boolean fromCache = imageView.loadImage(mPugUrls.get(position), false);
+        final boolean fromCache = imageView
+                .loadImage(mPugUrls.get(position), false, new UpdateTextViewListener(status));
 
         if (fromCache) {
             status.setText("From Memory Cache");
             status.setBackgroundColor(mContext.getResources().getColor(R.color.translucent_green));
         } else {
-            status.setText("From Disk/Network");
-            status.setBackgroundColor(mContext.getResources().getColor(R.color.translucent_red));
+            status.setText("Loading...");
+            status.setBackgroundDrawable(null);
         }
 
         return convertView;
     }
 
+    static class UpdateTextViewListener
+            implements NetworkedCacheableImageView.OnImageLoadedListener {
+        private final WeakReference<TextView> mTextViewRef;
+
+        public UpdateTextViewListener(TextView tv) {
+            mTextViewRef = new WeakReference<TextView>(tv);
+        }
+
+        @Override
+        public void onImageLoaded(CacheableBitmapDrawable result) {
+            final TextView tv = mTextViewRef.get();
+            if (tv == null) {
+                return;
+            }
+
+            if (result == null) {
+                tv.setText("Failed");
+                tv.setBackgroundDrawable(null);
+                return;
+            }
+
+            switch (result.getSource()) {
+                case CacheableBitmapDrawable.SOURCE_UNKNOWN:
+                case CacheableBitmapDrawable.SOURCE_NEW:
+                    tv.setText("From Disk/Network");
+                    tv.setBackgroundColor(tv.getResources().getColor(R.color.translucent_red));
+                    break;
+                case CacheableBitmapDrawable.SOURCE_INBITMAP:
+                    tv.setText("Reused Bitmap");
+                    tv.setBackgroundColor(tv.getResources().getColor(R.color.translucent_blue));
+                    break;
+            }
+        }
+    }
+
 }
diff --git a/sample/src/uk/co/senab/bitmapcache/samples/PugPagerAdapter.java b/sample/src/uk/co/senab/bitmapcache/samples/PugPagerAdapter.java
@@ -45,7 +45,7 @@ public View instantiateItem(ViewGroup container, int position) {
         NetworkedCacheableImageView imageView = new NetworkedCacheableImageView(mContext, null);
 
         String pugUrl = mPugUrls.get(position);
-        imageView.loadImage(pugUrl, true);
+        imageView.loadImage(pugUrl, true, null);
 
         imageView.setScaleType(ScaleType.FIT_CENTER);
         container.addView(imageView, LayoutParams.MATCH_PARENT, LayoutParams.MATCH_PARENT);
