Package 

Interface Resource


  • 
    public interface Resource<Z>
    
                        

    A resource interface that wraps a particular type so that it can be pooled and reused.

    • Method Summary

      Modifier and Type Method Description
      abstract Class<Z> getResourceClass() Returns the Class of the wrapped resource.
      abstract Z get() Returns an instance of the wrapped resource.
      abstract int getSize() Returns the size in bytes of the wrapped resource to use to determine how much of the memorycache this resource uses.
      abstract 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
    • Method Detail

      • get

        @NonNull() abstract Z get()

        Returns an instance of the wrapped resource.

        Note - This does not have to be the same instance of the wrapped resource class and in factit 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.

      • getSize

         abstract int getSize()

        Returns the size in bytes of the wrapped resource to use to determine how much of the memorycache this resource uses.

      • recycle

         abstract void recycle()

        Cleans up and recycles internal resources.

        It is only safe to call this method if there are no current resource consumers and if thismethod 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 consumerhave 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 duringtransformations or transcoders, the framework will call this method when all consumers havereleased this resource and it has been evicted from the cache.