Class BitmapResource

  • All Implemented Interfaces:
    Initializable, Resource<android.graphics.Bitmap>

    public class BitmapResource
    extends java.lang.Object
    implements Resource<android.graphics.Bitmap>, Initializable
    A resource wrapping a Bitmap object.
    • Constructor Summary

      Constructors 
      Constructor Description
      BitmapResource​(android.graphics.Bitmap bitmap, BitmapPool bitmapPool)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      android.graphics.Bitmap get()
      Returns an instance of the wrapped resource.
      java.lang.Class<android.graphics.Bitmap> getResourceClass()
      Returns the Class of the wrapped resource.
      int getSize()
      Returns the size in bytes of the wrapped resource to use to determine how much of the memory cache this resource uses.
      void initialize()
      Called on a background thread so the Resource can do some eager initialization.
      static BitmapResource obtain​(android.graphics.Bitmap bitmap, BitmapPool bitmapPool)
      Returns a new BitmapResource wrapping the given Bitmap if the Bitmap is non-null or null if the given Bitmap is null.
      void recycle()
      Cleans up and recycles internal resources.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • BitmapResource

        public BitmapResource​(@NonNull
                              android.graphics.Bitmap bitmap,
                              @NonNull
                              BitmapPool bitmapPool)
    • Method Detail

      • obtain

        @Nullable
        public static BitmapResource obtain​(@Nullable
                                            android.graphics.Bitmap bitmap,
                                            @NonNull
                                            BitmapPool bitmapPool)
        Returns a new BitmapResource wrapping the given Bitmap if the Bitmap is non-null or null if the given Bitmap is null.
        Parameters:
        bitmap - A Bitmap.
        bitmapPool - A non-null BitmapPool.
      • getResourceClass

        @NonNull
        public java.lang.Class<android.graphics.Bitmap> getResourceClass()
        Description copied from interface: Resource
        Returns the Class of the wrapped resource.
        Specified by:
        getResourceClass in interface Resource<android.graphics.Bitmap>
      • get

        @NonNull
        public android.graphics.Bitmap get()
        Description copied from interface: Resource
        Returns an instance of the wrapped resource.

        Note - This does not have to be the same instance of the wrapped resource class and in fact it is often appropriate to return a new instance for each call. For example, Drawables should only be used by a single View at a time so each call to this method for Resources that wrap Drawables should always return a new Drawable.

        Specified by:
        get in interface Resource<android.graphics.Bitmap>
      • getSize

        public int getSize()
        Description copied from interface: Resource
        Returns the size in bytes of the wrapped resource to use to determine how much of the memory cache this resource uses.
        Specified by:
        getSize in interface Resource<android.graphics.Bitmap>
      • recycle

        public void recycle()
        Description copied from interface: Resource
        Cleans up and recycles internal resources.

        It is only safe to call this method if there are no current resource consumers and if this method has not yet been called. Typically this occurs at one of two times:

        • During a resource load when the resource is transformed or transcoded before any consumer have ever had access to this resource
        • After all consumers have released this resource and it has been evicted from the cache
        For most users of this class, the only time this method should ever be called is during transformations or transcoders, the framework will call this method when all consumers have released this resource and it has been evicted from the cache.
        Specified by:
        recycle in interface Resource<android.graphics.Bitmap>
      • initialize

        public void initialize()
        Description copied from interface: Initializable
        Called on a background thread so the Resource can do some eager initialization.
        Specified by:
        initialize in interface Initializable